X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=4484c8dcb8deb531169bb2aa98c168bdddfa4124;hb=04cb915716ecdc1ee26440b4c09bc2f2de183631;hp=a49faa8d595df9c05743adb9ec5fbce6b79898e2;hpb=29a27196a13de2ffd9b671185e4b464b9db9b549;p=libsigrok.git diff --git a/device.c b/device.c index a49faa8d..4484c8dc 100644 --- a/device.c +++ b/device.c @@ -46,7 +46,15 @@ * @{ */ -/** @private */ +/** @private + * Allocate and initialize new struct sr_probe + * @param[in] index \copydoc sr_probe::index + * @param[in] type \copydoc sr_probe::type + * @param[in] enabled \copydoc sr_probe::enabled + * @param[in] name \copydoc sr_probe::name + * + * @return NULL (failure) or new struct sr_probe*. + */ SR_PRIV struct sr_probe *sr_probe_new(int index, int type, gboolean enabled, const char *name) { @@ -73,14 +81,14 @@ SR_PRIV struct sr_probe *sr_probe_new(int index, int type, * removed, and the new name will be saved instead. * * @param sdi The device instance the probe is connected to. - * @param probenum The number of the probe whose name to set. + * @param[in] probenum The number of the probe whose name to set. * Note that the probe numbers start at 0. - * @param name The new name that the specified probe should get. A copy + * @param[in] name The new name that the specified probe should get. A copy * of the string is made. * * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. * - * @since 0.1.0 (but the API changed in 0.2.0) + * @since 0.2.0 */ SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi, int probenum, const char *name) @@ -148,13 +156,13 @@ SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum, * If the specified probe of this device already has a trigger, it will * be silently replaced. * - * @param sdi Must not be NULL. - * @param probenum The probe number, starting from 0. - * @param trigger Trigger string, in the format used by sigrok-cli + * @param[in,out] sdi Pointer to the device instance; must not be NULL. + * @param[in] probenum Number of probe, starting at 0. + * @param[in] trigger Trigger string, in the format used by sigrok-cli * * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. * - * @since 0.1.0 (but the API changed in 0.2.0) + * @since 0.2.0 */ SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, const char *trigger) @@ -189,14 +197,14 @@ SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, * If the device's 'driver' field is NULL (virtual device), this * function will always return FALSE (virtual devices don't have * a hardware capabilities list). - * @param key The option that should be checked for support on the + * @param[in] key The option that should be checked for is supported by the * specified device. * - * @return TRUE if the device has the specified option, FALSE otherwise. - * FALSE is also returned on invalid input parameters or other - * error conditions. + * @retval TRUE Device has the specified option + * @retval FALSE Device does not have the specified option, invalid input + * parameters or other error conditions. * - * @since 0.1.0 (but the API changed in 0.2.0) + * @since 0.2.0 */ SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key) { @@ -208,7 +216,8 @@ SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key) if (!sdi || !sdi->driver || !sdi->driver->config_list) return FALSE; - if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS, &gvar, NULL) != SR_OK) + if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS, + &gvar, NULL, NULL) != SR_OK) return FALSE; ret = FALSE; @@ -224,7 +233,18 @@ SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key) return ret; } -/** @private */ +/** @private + * Allocate and init new device instance struct. + * \param[in] index \copydoc sr_dev_inst::index + * \param[in] status \copydoc sr_dev_inst::status + * \param[in] vendor \copydoc sr_dev_inst::vendor + * \param[in] model \copydoc sr_dev_inst::model + * \param[in] version \copydoc sr_dev_inst::version + * + * \retval NULL Error + * \retval struct sr_dev_inst *. Dynamically allocated, free using + * sr_dev_inst_free(). + */ SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, const char *vendor, const char *model, const char *version) { @@ -243,13 +263,17 @@ SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, sdi->model = model ? g_strdup(model) : NULL; sdi->version = version ? g_strdup(version) : NULL; sdi->probes = NULL; + sdi->probe_groups = NULL; sdi->conn = NULL; sdi->priv = NULL; return sdi; } -/** @private */ +/** @private + * Free device instance struct created by sr_dev_inst(). + * \param sdi struct* to free. + */ SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) { struct sr_probe *probe; @@ -258,10 +282,14 @@ SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) for (l = sdi->probes; l; l = l->next) { probe = l->data; g_free(probe->name); + g_free(probe->trigger); g_free(probe); } + g_slist_free(sdi->probes); + + if (sdi->probe_groups) + g_slist_free(sdi->probe_groups); - g_free(sdi->priv); g_free(sdi->vendor); g_free(sdi->model); g_free(sdi->version); @@ -270,7 +298,15 @@ SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) #ifdef HAVE_LIBUSB_1_0 -/** @private */ +/** @private + * Allocate and init struct for USB device instance. + * \param[in] bus \copydoc sr_usb_dev_inst::bus + * \param[in] address \copydoc sr_usb_dev_inst::address + * \param[in] hdl \copydoc sr_usb_dev_inst::devhdl + * + * \retval NULL Error + * \retval other struct sr_usb_dev_inst * for USB device instance. + */ SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, uint8_t address, struct libusb_device_handle *hdl) { @@ -288,28 +324,31 @@ SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, return udi; } -/** @private */ +/** @private + * Free struct * allocated by sr_usb_dev_inst(). + * \param usb struct* to free. Must not be NULL. + */ SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb) { - (void)usb; - - /* Nothing to do for this device instance type. */ + g_free(usb); } #endif +#ifdef HAVE_LIBSERIALPORT + /** * @private * * Both parameters are copied to newly allocated strings, and freed * automatically by sr_serial_dev_inst_free(). * - * @param pathname OS-specific serial port specification. Examples: + * @param[in] port OS-specific serial port specification. Examples: * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1". - * @param serialcomm A serial communication parameters string, in the form - * of /, for example - * "9600/8n1" or "600/7o2". This is an optional parameter; - * it may be filled in later. + * @param[in] serialcomm A serial communication parameters string, in the form + * of \/\\\, for example + * "9600/8n1" or "600/7o2". This is an optional parameter; + * it may be filled in later. * * @return A pointer to a newly initialized struct sr_serial_dev_inst, * or NULL on error. @@ -332,19 +371,58 @@ SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, serial->port = g_strdup(port); if (serialcomm) serial->serialcomm = g_strdup(serialcomm); - serial->fd = -1; return serial; } -/** @private */ +/** @private + * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst(). + * \param serial struct sr_serial_dev_inst * to free. Must not be NULL. + */ SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) { g_free(serial->port); g_free(serial->serialcomm); g_free(serial); } +#endif + +SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device) +{ + struct sr_usbtmc_dev_inst *usbtmc; + + if (!device) { + sr_err("Device name required."); + return NULL; + } + + if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) { + sr_err("USBTMC device instance malloc failed."); + return NULL; + } + + usbtmc->device = g_strdup(device); + usbtmc->fd = -1; + + return usbtmc; +} +SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc) +{ + g_free(usbtmc->device); + g_free(usbtmc); +} + +/** + * Get the list of devices/instances of the specified driver. + * + * @param driver The driver to use. Must not be NULL. + * + * @return The list of devices/instances of this driver, or NULL upon errors + * or if the list is empty. + * + * @since 0.2.0 + */ SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver) { if (driver && driver->dev_list) @@ -353,6 +431,15 @@ SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver) return NULL; } +/** + * Clear all devices/instances of the specified driver. + * + * @param driver The driver to use. Must not be NULL. + * + * @return SR_OK upon success, a negative error code upon errors. + * + * @since 0.2.0 + */ SR_API int sr_dev_clear(const struct sr_dev_driver *driver) { if (driver && driver->dev_clear) @@ -361,6 +448,15 @@ SR_API int sr_dev_clear(const struct sr_dev_driver *driver) return SR_OK; } +/** + * Open the specified device. + * + * @param sdi Device instance to use. Must not be NULL. + * + * @return SR_OK upon success, a negative error code upon errors. + * + * @since 0.2.0 + */ SR_API int sr_dev_open(struct sr_dev_inst *sdi) { int ret; @@ -373,6 +469,15 @@ SR_API int sr_dev_open(struct sr_dev_inst *sdi) return ret; } +/** + * Close the specified device. + * + * @param sdi Device instance to use. Must not be NULL. + * + * @return SR_OK upon success, a negative error code upon errors. + * + * @since 0.2.0 + */ SR_API int sr_dev_close(struct sr_dev_inst *sdi) { int ret;