Doxygen: Consistently use @ notation everywhere.

[libsigrok.git] / libsigrok-internal.h

diff --git a/libsigrok-internal.h b/libsigrok-internal.h
index 3df28fe2195b0727aa2ee8b9936e02b389076bab..6073f4bd81a93eccecf73f146521a6e36687c730 100644 (file)
--- a/libsigrok-internal.h
+++ b/libsigrok-internal.h
@@ -17,8 +17,12 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef LIBSIGROK_SIGROK_INTERNAL_H
-#define LIBSIGROK_SIGROK_INTERNAL_H
+/** @file
+  * @internal
+  */
+
+#ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
+#define LIBSIGROK_LIBSIGROK_INTERNAL_H
 
 #include <stdarg.h>
 #include <glib.h>
@@ -60,9 +64,13 @@ struct sr_context {
 };
 
 #ifdef HAVE_LIBUSB_1_0
+/** USB device instance */
 struct sr_usb_dev_inst {
+       /** USB bus */
        uint8_t bus;
+       /** Device address on USB bus */
        uint8_t address;
+       /** libusb device handle */
        struct libusb_device_handle *devhdl;
 };
 #endif
@@ -72,10 +80,13 @@ struct sr_usb_dev_inst {
 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
 #define SERIAL_PARITY_ODD  SP_PARITY_ODD
 struct sr_serial_dev_inst {
+       /** Port name, e.g. '/dev/tty42'. */
        char *port;
+       /** Comm params for serial_set_paramstr(). */
        char *serialcomm;
-       int fd;
+       /** Port is non-blocking. */
        int nonblocking;
+       /** libserialport port handle */
        struct sp_port *data;
 };
 #endif
@@ -87,6 +98,7 @@ struct sr_usbtmc_dev_inst {
 
 /* Private driver context. */
 struct drv_context {
+       /** sigrok context */
        struct sr_context *sr_ctx;
        GSList *instances;
 };
@@ -165,7 +177,9 @@ struct sr_session {
         * an async fashion. We need to make sure the session is stopped from
         * within the session thread itself.
         */
+       /** Mutex protecting access to abort_session. */
        GMutex stop_mutex;
+       /** Abort current session. See sr_session_stop(). */
        gboolean abort_session;
 };
 
@@ -182,7 +196,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 +205,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 +244,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 -----------------------------------------------*/
@@ -249,8 +268,6 @@ SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
 
 /*--- hardware/common/scpi.c ------------------------------------------------*/
 
-#ifdef HAVE_LIBSERIALPORT
-
 #define SCPI_CMD_IDN "*IDN?"
 #define SCPI_CMD_OPC "*OPC?"
 
@@ -292,6 +309,7 @@ struct sr_scpi_dev_inst {
        int (*source_remove)(void *priv);
        int (*send)(void *priv, const char *command);
        int (*receive)(void *priv, char **scpi_response);
+       int (*read)(void *priv, char *buf, int maxlen);
        int (*close)(void *priv);
        void (*free)(void *priv);
        void *priv;
@@ -302,9 +320,12 @@ 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);
 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
 
@@ -327,12 +348,21 @@ SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
                        struct sr_scpi_hw_info **scpi_response);
 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
 
-#endif
-
 /*--- hardware/common/scpi_serial.c -----------------------------------------*/
 
+#ifdef HAVE_LIBSERIALPORT
 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);
 
 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/