Improved doxygen docs.

[libsigrok.git] / libsigrok-internal.h

diff --git a/libsigrok-internal.h b/libsigrok-internal.h
index d48e13f00de7b89612cc2cd56efcecfdd1ee1ea1..d19f3670426279f4a9bee3ce890345e8be5cf6ea 100644 (file)
--- a/libsigrok-internal.h
+++ b/libsigrok-internal.h
@@ -17,6 +17,10 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/** @file
+  * @internal
+  */
+
 #ifndef LIBSIGROK_SIGROK_INTERNAL_H
 #define LIBSIGROK_SIGROK_INTERNAL_H
 
@@ -60,10 +64,11 @@ struct sr_context {
 };
 
 #ifdef HAVE_LIBUSB_1_0
+/** USB device instance */
 struct sr_usb_dev_inst {
-       uint8_t bus;
-       uint8_t address;
-       struct libusb_device_handle *devhdl;
+       uint8_t bus;       /**< USB bus */
+       uint8_t address;   /**< Device address on USB bus */
+       struct libusb_device_handle *devhdl;  /**< libusb device handle */
 };
 #endif
 
@@ -72,11 +77,10 @@ struct sr_usb_dev_inst {
 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
 #define SERIAL_PARITY_ODD  SP_PARITY_ODD
 struct sr_serial_dev_inst {
-       char *port;
-       char *serialcomm;
-       int fd;
+       char *port;             /**< Port name, e.g. '/dev/tty42'. */
+       char *serialcomm;       /**< Comm params for serial_set_paramstr(). */
        int nonblocking;
-       struct sp_port *data;
+       struct sp_port *data;   /**< libserialport port handle */
 };
 #endif
 
@@ -87,7 +91,7 @@ struct sr_usbtmc_dev_inst {
 
 /* Private driver context. */
 struct drv_context {
-       struct sr_context *sr_ctx;
+       struct sr_context *sr_ctx;  /**< sigrok context */
        GSList *instances;
 };
 
@@ -165,8 +169,9 @@ struct sr_session {
         * an async fashion. We need to make sure the session is stopped from
         * within the session thread itself.
         */
-       GMutex stop_mutex;
+       GMutex stop_mutex;  /**< Mutex protecting access to abort_session. */
        gboolean abort_session;
+                       /**< Abort current session. See sr_session_stop(). */
 };
 
 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
@@ -182,7 +187,8 @@ typedef void (*std_dev_clear_t)(void *priv);
 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
                const char *prefix);
 #ifdef HAVE_LIBSERIALPORT
-SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
+SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
+SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
                void *cb_data, dev_close_t dev_close_fn,
                struct sr_serial_dev_inst *serial, const char *prefix);
 #endif
@@ -190,6 +196,7 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
                const char *prefix);
 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
                std_dev_clear_t clear_private);
+SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
 
 /*--- strutil.c -------------------------------------------------------------*/
 
@@ -228,6 +235,9 @@ SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
                                 uint64_t timeout_ms, int baudrate);
 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
                                      const char **serial_options);
+SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
+               int timeout, sr_receive_data_callback_t cb, void *cb_data);
+SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial);
 #endif
 
 /*--- hardware/common/ezusb.c -----------------------------------------------*/
@@ -301,7 +311,9 @@ SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
                int timeout, sr_receive_data_callback_t cb, void *cb_data);
 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi);
 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
-                       const char *command);
+               const char *format, ...);
+SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
+               const char *format, va_list args);
 SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
                        char **scpi_response);
 SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
@@ -334,6 +346,11 @@ SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
                        const char *serialcomm);
 #endif
 
+/*--- hardware/common/scpi_tcp.c --------------------------------------------*/
+
+SR_PRIV struct sr_scpi_dev_inst *scpi_tcp_dev_inst_new(const char *address,
+                       const char *port);
+
 /*--- hardware/common/scpi_usbtmc.c -----------------------------------------*/
 
 SR_PRIV struct sr_scpi_dev_inst *scpi_usbtmc_dev_inst_new(const char *device);