Doxygen: Add @file items for the relevant files.

[libsigrok.git] / libsigrok-internal.h

diff --git a/libsigrok-internal.h b/libsigrok-internal.h
index 94ca2bc90a94bd08be177075471795335b6ff344..38647622d825c0167ee3025b376200a95775ac86 100644 (file)
--- a/libsigrok-internal.h
+++ b/libsigrok-internal.h
@@ -27,6 +27,12 @@
 #include <libusb.h>
 #endif
 
+/**
+ * @file
+ *
+ * libsigrok private header file, only to be used internally.
+ */
+
 /*--- Macros ----------------------------------------------------------------*/
 
 #ifndef ARRAY_SIZE
@@ -37,9 +43,20 @@
 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
 #endif
 
+/* Versions < 2.30.0 of glib don't have g_match_info_unref(). */
+#if !GLIB_CHECK_VERSION(2,30,0)
+#define g_match_info_unref g_match_info_free
+#endif
+
 /* Size of a datastore chunk in units */
 #define DATASTORE_CHUNKSIZE (512 * 1024)
 
+struct sr_context {
+#ifdef HAVE_LIBUSB_1_0
+       libusb_context *libusb_ctx;
+#endif
+};
+
 #ifdef HAVE_LIBUSB_1_0
 struct sr_usb_dev_inst {
        uint8_t bus;
@@ -56,17 +73,10 @@ struct sr_serial_dev_inst {
        int fd;
 };
 
-#ifdef HAVE_LIBUSB_1_0
-/* USB-specific instances */
-SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
-               uint8_t address, struct libusb_device_handle *hdl);
-SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
-#endif
-
-/* Serial-specific instances */
-SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(
-                                       const char *port, int fd);
-SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
+/* Private driver context. */
+struct drv_context {
+       GSList *instances;
+};
 
 /*--- log.c -----------------------------------------------------------------*/
 
@@ -77,25 +87,41 @@ SR_PRIV int sr_info(const char *format, ...);
 SR_PRIV int sr_warn(const char *format, ...);
 SR_PRIV int sr_err(const char *format, ...);
 
-/*--- hwdriver.c ------------------------------------------------------------*/
-
-SR_PRIV void sr_hw_cleanup_all(void);
+/*--- device.c --------------------------------------------------------------*/
 
-/*--- session.c -------------------------------------------------------------*/
-
-SR_PRIV int sr_session_send(struct sr_dev *dev,
-                           struct sr_datafeed_packet *packet);
+SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
+               gboolean enabled, const char *name);
 
 /* Generic device instances */
 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
                const char *vendor, const char *model, const char *version);
-SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index);
 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
+#ifdef HAVE_LIBUSB_1_0
+
+/* USB-specific instances */
+SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
+               uint8_t address, struct libusb_device_handle *hdl);
+SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
+#endif
+
+/* Serial-specific instances */
+SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(
+                                       const char *port, int fd);
+SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 
+
+/*--- hwdriver.c ------------------------------------------------------------*/
+
+SR_PRIV void sr_hw_cleanup_all(void);
 SR_PRIV int sr_source_remove(int fd);
 SR_PRIV int sr_source_add(int fd, int events, int timeout,
                          sr_receive_data_callback_t cb, void *cb_data);
 
+/*--- session.c -------------------------------------------------------------*/
+
+SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
+                           struct sr_datafeed_packet *packet);
+
 /*--- hardware/common/serial.c ----------------------------------------------*/
 
 SR_PRIV GSList *list_serial_ports(void);
@@ -108,6 +134,7 @@ SR_PRIV void *serial_backup_params(int fd);
 SR_PRIV void serial_restore_params(int fd, void *backup);
 SR_PRIV int serial_set_params(int fd, int baudrate, int bits, int parity,
                              int stopbits, int flowcontrol);
+SR_PRIV int serial_set_paramstr(int fd, const char *paramstr);
 
 /*--- hardware/common/ezusb.c -----------------------------------------------*/
 
@@ -119,15 +146,4 @@ SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
                                  const char *filename);
 #endif
 
-/*--- hardware/common/misc.c ------------------------------------------------*/
-
-#ifdef HAVE_LIBUSB_1_0
-SR_PRIV int opendev2(int dev_index, struct sr_dev_inst **sdi,
-                    libusb_device *dev, struct libusb_device_descriptor *des,
-                    int *skip, uint16_t vid, uint16_t pid, int interface);
-SR_PRIV int opendev3(struct sr_dev_inst **sdi, libusb_device *dev,
-                    struct libusb_device_descriptor *des,
-                    uint16_t vid, uint16_t pid, int interface);
-#endif
-
 #endif