X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fstd.c;h=8ce27615e2a7069df2fc3eb9fa8ab618c00b6c3b;hb=4d67b9d9dcfbb26f21b5092b79c10da8544e7df1;hp=fed47febe3598e15468b0e2433b6decbd362fb48;hpb=7aebe22d107df4548700bef900be66971658fcac;p=libsigrok.git
diff --git a/src/std.c b/src/std.c
index fed47feb..8ce27615 100644
--- a/src/std.c
+++ b/src/std.c
@@ -14,54 +14,137 @@
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ * along with this program; if not, see .
*/
-/** @file
- * Standard API helper functions.
- * @internal
- */
+/**
+ * @file
+ *
+ * Standard API helper functions.
+ *
+ * @internal
+ */
+#include
#include
-#include "libsigrok.h"
+#include
#include "libsigrok-internal.h"
+#include "scpi.h"
#define LOG_PREFIX "std"
/**
- * Standard sr_driver_init() API helper.
+ * Standard driver init() callback API helper.
*
* This function can be used to simplify most driver's init() API callback.
*
- * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
- * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
+ * Create a new 'struct drv_context' (drvc), assign sr_ctx to it, and
+ * then assign 'drvc' to the 'struct sr_dev_driver' (di) that is passed.
*
- * @param sr_ctx The libsigrok context to assign.
- * @param di The driver instance to use.
- * @param[in] prefix A driver-specific prefix string used for log messages.
+ * @param[in] di The driver instance to use. Must not be NULL.
+ * @param[in] sr_ctx The libsigrok context to assign. May be NULL.
*
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
- * SR_ERR_MALLOC upon memory allocation errors.
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
*/
-SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
- const char *prefix)
+SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
struct drv_context *drvc;
if (!di) {
- sr_err("%s: Invalid driver, cannot initialize.", prefix);
+ sr_err("%s: Invalid argument.", __func__);
return SR_ERR_ARG;
}
- if (!(drvc = g_try_malloc(sizeof(struct drv_context)))) {
- sr_err("%s: Driver context malloc failed.", prefix);
- return SR_ERR_MALLOC;
- }
-
+ drvc = g_malloc0(sizeof(struct drv_context));
drvc->sr_ctx = sr_ctx;
drvc->instances = NULL;
- di->priv = drvc;
+ di->context = drvc;
+
+ return SR_OK;
+}
+
+/**
+ * Standard driver cleanup() callback API helper.
+ *
+ * This function can be used to simplify most driver's cleanup() API callback.
+ *
+ * Free all device instances by calling sr_dev_clear() and then release any
+ * resources allocated by std_init().
+ *
+ * @param[in] di The driver instance to use. Must not be NULL.
+ *
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Other error.
+ */
+SR_PRIV int std_cleanup(const struct sr_dev_driver *di)
+{
+ int ret;
+
+ if (!di) {
+ sr_err("%s: Invalid argument.", __func__);
+ return SR_ERR_ARG;
+ }
+
+ ret = sr_dev_clear(di);
+ g_free(di->context);
+
+ return ret;
+}
+
+/**
+ * Dummmy driver dev_open() callback API helper.
+ *
+ * @param[in] sdi The device instance to use. May be NULL (unused).
+ *
+ * @retval SR_OK Success.
+ */
+SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi)
+{
+ (void)sdi;
+
+ return SR_OK;
+}
+
+/**
+ * Dummmy driver dev_close() callback API helper.
+ *
+ * @param[in] sdi The device instance to use. May be NULL (unused).
+ *
+ * @retval SR_OK Success.
+ */
+SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi)
+{
+ (void)sdi;
+
+ return SR_OK;
+}
+
+/**
+ * Dummmy driver dev_acquisition_start() callback API helper.
+ *
+ * @param[in] sdi The device instance to use. May be NULL (unused).
+ *
+ * @retval SR_OK Success.
+ */
+SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi)
+{
+ (void)sdi;
+
+ return SR_OK;
+}
+
+/**
+ * Dummmy driver dev_acquisition_stop() callback API helper.
+ *
+ * @param[in] sdi The device instance to use. May be NULL (unused).
+ *
+ * @retval SR_OK Success.
+ */
+SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi)
+{
+ (void)sdi;
return SR_OK;
}
@@ -69,29 +152,28 @@ SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
/**
* Standard API helper for sending an SR_DF_HEADER packet.
*
- * This function can be used to simplify most driver's
+ * This function can be used to simplify most drivers'
* dev_acquisition_start() API callback.
*
- * @param sdi The device instance to use.
- * @param prefix A driver-specific prefix string used for log messages.
- * Must not be NULL. An empty string is allowed.
+ * @param[in] sdi The device instance to use. Must not be NULL.
*
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
- * SR_ERR upon other errors.
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Other error.
*/
-SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
- const char *prefix)
+SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi)
{
+ const char *prefix;
int ret;
struct sr_datafeed_packet packet;
struct sr_datafeed_header header;
- if (!prefix) {
- sr_err("Invalid prefix.");
+ if (!sdi) {
+ sr_err("%s: Invalid argument.", __func__);
return SR_ERR_ARG;
}
- sr_dbg("%s: Starting acquisition.", prefix);
+ prefix = (sdi->driver) ? sdi->driver->name : "unknown";
/* Send header packet to the session bus. */
sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
@@ -101,7 +183,45 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
gettimeofday(&header.starttime, NULL);
if ((ret = sr_session_send(sdi, &packet)) < 0) {
- sr_err("%s: Failed to send header packet: %d.", prefix, ret);
+ sr_err("%s: Failed to send SR_DF_HEADER packet: %d.", prefix, ret);
+ return ret;
+ }
+
+ return SR_OK;
+}
+
+/**
+ * Standard API helper for sending an SR_DF_END packet.
+ *
+ * This function can be used to simplify most drivers'
+ * dev_acquisition_stop() API callback.
+ *
+ * @param[in] sdi The device instance to use. Must not be NULL.
+ *
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Other error.
+ */
+SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi)
+{
+ const char *prefix;
+ int ret;
+ struct sr_datafeed_packet packet;
+
+ if (!sdi) {
+ sr_err("%s: Invalid argument.", __func__);
+ return SR_ERR_ARG;
+ }
+
+ prefix = (sdi->driver) ? sdi->driver->name : "unknown";
+
+ sr_dbg("%s: Sending SR_DF_END packet.", prefix);
+
+ packet.type = SR_DF_END;
+ packet.payload = NULL;
+
+ if ((ret = sr_session_send(sdi, &packet)) < 0) {
+ sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
return ret;
}
@@ -111,121 +231,102 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
#ifdef HAVE_LIBSERIALPORT
/**
- * Standard serial driver dev_open() helper.
+ * Standard serial driver dev_open() callback API helper.
*
* This function can be used to implement the dev_open() driver API
* callback in drivers that use a serial port. The port is opened
* with the SERIAL_RDWR flag.
*
- * If the open succeeded, the status field of the given sdi is set
- * to SR_ST_ACTIVE.
+ * @param[in] sdi The device instance to use. Must not be NULL.
*
* @retval SR_OK Success.
- * @retval SR_ERR Serial port open failed.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Serial port open failed.
*/
SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
{
struct sr_serial_dev_inst *serial;
- serial = sdi->conn;
- if (serial_open(serial, SERIAL_RDWR) != SR_OK)
- return SR_ERR;
+ if (!sdi) {
+ sr_err("%s: Invalid argument.", __func__);
+ return SR_ERR_ARG;
+ }
- sdi->status = SR_ST_ACTIVE;
+ serial = sdi->conn;
- return SR_OK;
+ return serial_open(serial, SERIAL_RDWR);
}
/**
- * Standard serial driver dev_close() helper.
+ * Standard serial driver dev_close() callback API helper.
*
* This function can be used to implement the dev_close() driver API
* callback in drivers that use a serial port.
*
- * After closing the port, the status field of the given sdi is set
- * to SR_ST_INACTIVE.
+ * @param[in] sdi The device instance to use. Must not be NULL.
*
* @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Serial port close failed.
*/
SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
{
struct sr_serial_dev_inst *serial;
- serial = sdi->conn;
- if (serial && sdi->status == SR_ST_ACTIVE) {
- serial_close(serial);
- sdi->status = SR_ST_INACTIVE;
+ if (!sdi) {
+ sr_err("%s: Invalid argument.", __func__);
+ return SR_ERR_ARG;
}
- return SR_OK;
+ serial = sdi->conn;
+
+ return serial_close(serial);
}
/**
- * Standard sr_session_stop() API helper.
+ * Standard serial driver dev_acquisition_stop() callback API helper.
*
- * This function can be used to simplify most (serial port based) driver's
+ * This function can be used to simplify most (serial port based) drivers'
* dev_acquisition_stop() API callback.
*
- * @param sdi The device instance for which acquisition should stop.
- * Must not be NULL.
- * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
- * @param dev_close_fn Function pointer to the driver's dev_close().
- * Must not be NULL.
- * @param serial The serial device instance (struct serial_dev_inst *).
- * Must not be NULL.
- * @param[in] prefix A driver-specific prefix string used for log messages.
- * Must not be NULL. An empty string is allowed.
+ * @param[in] sdi The device instance for which acquisition should stop.
+ * Must not be NULL.
*
* @retval SR_OK Success.
- * @retval SR_ERR_ARG Invalid arguments.
- * @retval SR_ERR_DEV_CLOSED Device is closed.
- * @retval SR_ERR Other errors.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval other Other error.
*/
-SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
- void *cb_data, dev_close_callback dev_close_fn,
- struct sr_serial_dev_inst *serial, const char *prefix)
+SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi)
{
+ struct sr_serial_dev_inst *serial;
+ const char *prefix;
int ret;
- struct sr_datafeed_packet packet;
- if (!prefix) {
- sr_err("Invalid prefix.");
+ if (!sdi) {
+ sr_err("%s: Invalid argument.", __func__);
return SR_ERR_ARG;
}
- if (sdi->status != SR_ST_ACTIVE) {
- sr_err("%s: Device inactive, can't stop acquisition.", prefix);
- return SR_ERR_DEV_CLOSED;
- }
-
- sr_dbg("%s: Stopping acquisition.", prefix);
+ serial = sdi->conn;
+ prefix = sdi->driver->name;
if ((ret = serial_source_remove(sdi->session, serial)) < 0) {
sr_err("%s: Failed to remove source: %d.", prefix, ret);
return ret;
}
- if ((ret = dev_close_fn(sdi)) < 0) {
+ if ((ret = sr_dev_close(sdi)) < 0) {
sr_err("%s: Failed to close device: %d.", prefix, ret);
return ret;
}
- /* Send SR_DF_END packet to the session bus. */
- sr_dbg("%s: Sending SR_DF_END packet.", prefix);
- packet.type = SR_DF_END;
- packet.payload = NULL;
- if ((ret = sr_session_send(cb_data, &packet)) < 0) {
- sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
- return ret;
- }
-
- return SR_OK;
+ return std_session_send_df_end(sdi);
}
#endif
/**
- * Standard driver dev_clear() helper.
+ * Standard driver dev_clear() callback API helper.
*
* Clear driver, this means, close all instances.
*
@@ -236,13 +337,17 @@ SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
* These are freed, but any dynamic allocation within structs stored
* there cannot be freed.
*
- * @param driver The driver which will have its instances released.
- * @param clear_private If not NULL, this points to a function called
- * with sdi->priv as argument. The function can then clear any device
- * instance-specific resources kept there. It must also clear the struct
- * pointed to by sdi->priv.
+ * @param[in] driver The driver which will have its instances released.
+ * Must not be NULL.
+ * @param[in] clear_private If not NULL, this points to a function called
+ * with sdi->priv as argument. The function can then clear
+ * any device instance-specific resources kept there.
+ * It must also clear the struct pointed to by sdi->priv.
*
- * @return SR_OK on success.
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid argument.
+ * @retval SR_ERR_BUG Implementation bug.
+ * @retval other Other error.
*/
SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
std_dev_clear_callback clear_private)
@@ -252,13 +357,17 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
GSList *l;
int ret;
- if (!(drvc = driver->priv))
- /* Driver was never initialized, nothing to do. */
- return SR_OK;
+ if (!driver) {
+ sr_err("%s: Invalid argument.", __func__);
+ return SR_ERR_ARG;
+ }
+
+ drvc = driver->context; /* Caller checked for context != NULL. */
ret = SR_OK;
for (l = drvc->instances; l; l = l->next) {
if (!(sdi = l->data)) {
+ sr_err("%s: Invalid device instance.", __func__);
ret = SR_ERR_BUG;
continue;
}
@@ -276,6 +385,8 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
#endif
if (sdi->inst_type == SR_INST_SCPI)
sr_scpi_free(sdi->conn);
+ if (sdi->inst_type == SR_INST_MODBUS)
+ sr_modbus_free(sdi->conn);
}
if (clear_private)
/* The helper function is responsible for freeing
@@ -292,3 +403,89 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
return ret;
}
+
+/**
+ * Standard driver dev_list() callback API helper.
+ *
+ * This function can be used as the dev_list() callback by most drivers.
+ *
+ * Return the devices contained in the driver context instances list.
+ *
+ * @param[in] di The driver instance to use. Must not be NULL.
+ *
+ * @retval NULL Error, or the list is empty.
+ * @retval other The list of device instances of this driver.
+ */
+SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di)
+{
+ struct drv_context *drvc;
+
+ if (!di) {
+ sr_err("%s: Invalid argument.", __func__);
+ return NULL;
+ }
+
+ drvc = di->context;
+
+ return drvc->instances;
+}
+
+/**
+ * Standard driver scan() callback API helper.
+ *
+ * This function can be used to perform common tasks required by a driver's
+ * scan() callback. It will initialize the driver for each device on the list
+ * and add the devices on the list to the driver's device instance list.
+ * Usually it should be used as the last step in the scan() callback, right
+ * before returning.
+ *
+ * Note: This function can only be used if std_init() has been called
+ * previously by the driver.
+ *
+ * Example:
+ * @code{c}
+ * static GSList *scan(struct sr_dev_driver *di, GSList *options)
+ * {
+ * struct GSList *device;
+ * struct sr_dev_inst *sdi;
+ *
+ * sdi = g_new0(sr_dev_inst, 1);
+ * sdi->vendor = ...;
+ * ...
+ * devices = g_slist_append(devices, sdi);
+ * ...
+ * return std_scan_complete(di, devices);
+ * }
+ * @endcode
+ *
+ * @param[in] di The driver instance to use. Must not be NULL.
+ * @param[in] devices List of newly discovered devices (struct sr_dev_inst).
+ * May be NULL.
+ *
+ * @return The @p devices list.
+ */
+SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices)
+{
+ struct drv_context *drvc;
+ GSList *l;
+
+ if (!di) {
+ sr_err("Invalid driver instance (di), cannot complete scan.");
+ return NULL;
+ }
+
+ drvc = di->context;
+
+ for (l = devices; l; l = l->next) {
+ struct sr_dev_inst *sdi = l->data;
+ if (!sdi) {
+ sr_err("Invalid device instance, cannot complete scan.");
+ return NULL;
+ }
+ sdi->driver = di;
+ }
+
+ drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
+
+ return devices;
+}