X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=libsigrok-internal.h;h=6073f4bd81a93eccecf73f146521a6e36687c730;hb=9d122af8f0c243278cc5edd79aae234aaa34984d;hp=b9b92ebb27c0f6a60c465a974b19b4a33e1bb7d9;hpb=7faa3e8821735e063e17fcad326c68aae14fe907;p=libsigrok.git

diff --git a/libsigrok-internal.h b/libsigrok-internal.h
index b9b92ebb..6073f4bd 100644
--- 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 -------------------------------------------------------------*/