X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok-internal.h;h=d19f3670426279f4a9bee3ce890345e8be5cf6ea;hb=5483bb8349d361be62ae5197b871afa6c8520c36;hp=28ee268589d0596297ebd2f3fa80bebadc383973;hpb=043e899a5155dcdc353abc20006424973d8e2ed0;p=libsigrok.git

diff --git a/libsigrok-internal.h b/libsigrok-internal.h
index 28ee2685..d19f3670 100644
--- 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