#include "libsigrok.h"
#include "libsigrok-internal.h"
-/* Message logging helpers with subsystem-specific prefix string. */
-#define LOG_PREFIX "device: "
-#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
-#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
-#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
-#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
-#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
-#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
+#define LOG_PREFIX "device"
/**
* @file
* @{
*/
-/** @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)
{
* 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.
* 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.
*
* 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.2.0
*/
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)
{
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;
#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)
{
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)
{
g_free(usb);
* 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 <speed>/<data bits><parity><stopbits>, 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 \<speed\>/\<data bits\>\<parity\>\<stopbits\>, 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.
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);
}
#endif
+/** @private */
SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
{
struct sr_usbtmc_dev_inst *usbtmc;
return usbtmc;
}
+/** @private */
SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
{
g_free(usbtmc->device);