X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fmotech-lps-30x%2Fapi.c;h=57befbfd6edf6e9c06e5b2c8bead3e2266a52c84;hb=4d399734b4ec7affb58c5881ea1b8d88eaa57d53;hp=bcbc2954310882e3b184a3fb011b594cbba34f2a;hpb=ca95e90fb37f127b3d58d90a8b40ce1ca85641d2;p=libsigrok.git diff --git a/src/hardware/motech-lps-30x/api.c b/src/hardware/motech-lps-30x/api.c index bcbc2954..57befbfd 100644 --- a/src/hardware/motech-lps-30x/api.c +++ b/src/hardware/motech-lps-30x/api.c @@ -23,26 +23,31 @@ * @internal */ +#include #include -#include #include #include - #include "protocol.h" /* Forward declarations */ SR_PRIV struct sr_dev_driver motech_lps_301_driver_info; SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen); -SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char* fmt, va_list args); -SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char* fmt, ...); -SR_PRIV int lps_cmd_reply(char* reply, struct sr_serial_dev_inst *serial, const char* fmt, ...); -SR_PRIV int lps_query_status(struct sr_dev_inst* sdi); +SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char *fmt, va_list args); +SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char *fmt, ...); +SR_PRIV int lps_cmd_reply(char *reply, struct sr_serial_dev_inst *serial, const char *fmt, ...); +SR_PRIV int lps_query_status(struct sr_dev_inst *sdi); /* Serial communication parameters */ #define SERIALCOMM "2400/8n1/dtr=1/rts=1/flow=0" #define VENDOR_MOTECH "Motech" +/** Driver capabilities generic. */ +static const uint32_t drvopts[] = { + /* Device class */ + SR_CONF_POWER_SUPPLY, +}; + /** Driver scanning options. */ static const uint32_t scanopts[] = { SR_CONF_CONN, @@ -53,27 +58,27 @@ static const uint32_t scanopts[] = { static const uint32_t devopts[] = { /* Device class */ SR_CONF_POWER_SUPPLY, - /* Aquisition modes. */ + /* Acquisition modes. */ SR_CONF_CONTINUOUS, SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET, SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET, /* Device configuration */ - SR_CONF_OUTPUT_CHANNEL_CONFIG | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, + SR_CONF_CHANNEL_CONFIG | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, }; /** Hardware capabilities channel 1, 2. */ static const uint32_t devopts_ch12[] = { - SR_CONF_OUTPUT_VOLTAGE | SR_CONF_GET, - SR_CONF_OUTPUT_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, - SR_CONF_OUTPUT_CURRENT | SR_CONF_GET, - SR_CONF_OUTPUT_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, - SR_CONF_OUTPUT_ENABLED | SR_CONF_GET | SR_CONF_SET, + SR_CONF_VOLTAGE | SR_CONF_GET, + SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, + SR_CONF_CURRENT | SR_CONF_GET, + SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, + SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET, }; /** Hardware capabilities channel 3. (LPS-304/305 only). */ static const uint32_t devopts_ch3[] = { - SR_CONF_OUTPUT_VOLTAGE | SR_CONF_GET, - SR_CONF_OUTPUT_ENABLED | SR_CONF_GET | SR_CONF_SET, + SR_CONF_VOLTAGE | SR_CONF_GET, + SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET, }; static const char *channel_modes[] = { @@ -82,7 +87,7 @@ static const char *channel_modes[] = { "Track2", }; -static struct lps_modelspec models[] = { +static const struct lps_modelspec models[] = { { LPS_UNKNOWN, "Dummy", 0, { @@ -128,14 +133,9 @@ static struct lps_modelspec models[] = { }, }; -static int init_lps301(struct sr_context *sr_ctx) -{ - return std_init(sr_ctx, &motech_lps_301_driver_info, LOG_PREFIX); -} - /** Send command to device with va_list. */ -SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char* fmt, va_list args) +SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char *fmt, va_list args) { int retc; char auxfmt[LINELEN_MAX]; @@ -146,7 +146,8 @@ SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char* fmt, va_l sr_spew("lps_send_va: \"%s\"", buf); - retc = serial_write_blocking(serial, buf, strlen(buf), 0); + retc = serial_write_blocking(serial, buf, strlen(buf), + serial_timeout(serial, strlen(buf))); if (retc < 0) return SR_ERR; @@ -156,7 +157,7 @@ SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char* fmt, va_l /** Send command to device. */ -SR_PRIV int lps_send_req(struct sr_serial_dev_inst *serial, const char* fmt, ...) +SR_PRIV int lps_send_req(struct sr_serial_dev_inst *serial, const char *fmt, ...) { int retc; va_list args; @@ -169,12 +170,12 @@ SR_PRIV int lps_send_req(struct sr_serial_dev_inst *serial, const char* fmt, ... } /** Send command and consume simple OK reply. */ -SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char* fmt, ...) +SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char *fmt, ...) { int retc; va_list args; char buf[LINELEN_MAX]; - char* bufptr; + char *bufptr; int buflen; /* Send command */ @@ -197,14 +198,14 @@ SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char* fmt, ...) } /** Send command and read reply string. - * \param reply Pointer to buffer of size LINELEN_MAX. Will be NUL-terminated. + * @param reply Pointer to buffer of size LINELEN_MAX. Will be NUL-terminated. */ -SR_PRIV int lps_cmd_reply(char* reply, struct sr_serial_dev_inst *serial, const char* fmt, ...) +SR_PRIV int lps_cmd_reply(char *reply, struct sr_serial_dev_inst *serial, const char *fmt, ...) { int retc; va_list args; char buf[LINELEN_MAX]; - char* bufptr; + char *bufptr; int buflen; reply[0] = '\0'; @@ -231,12 +232,12 @@ SR_PRIV int lps_cmd_reply(char* reply, struct sr_serial_dev_inst *serial, const } /** Process integer value returned by STATUS command. */ -SR_PRIV int lps_process_status(struct sr_dev_inst* sdi, int stat) +SR_PRIV int lps_process_status(struct sr_dev_inst *sdi, int stat) { - struct dev_context* devc; + struct dev_context *devc; int tracking_mode; - devc = (struct dev_context*)sdi->priv; + devc = sdi->priv; sr_spew("Status: %d", stat); devc->channel_status[0].cc_mode = (stat & 0x01) != 0; @@ -277,18 +278,19 @@ SR_PRIV int lps_process_status(struct sr_dev_inst* sdi, int stat) } /** Send STATUS commend and process status string. */ -SR_PRIV int lps_query_status(struct sr_dev_inst* sdi) +SR_PRIV int lps_query_status(struct sr_dev_inst *sdi) { char buf[LINELEN_MAX]; - int stat; - struct dev_context* devc; + int stat, ret; + struct dev_context *devc; - devc = (struct dev_context*)sdi->priv; + devc = sdi->priv; devc->req_sent_at = g_get_real_time(); - if (lps_cmd_reply(buf, sdi->conn, "STATUS") < 0) { - sr_err("%s: Failed to read status: %d %s", __func__, errno, strerror(errno)); + if ((ret = lps_cmd_reply(buf, sdi->conn, "STATUS")) < 0) { + sr_err("%s: Failed to read status: %s.", __func__, + sr_strerror(ret)); return SR_ERR; } @@ -309,8 +311,8 @@ static gint64 calc_timeout_ms(gint64 start_us) } /** Read message into buf until "OK" received. - * \retval SR_OK Msg received; buf and buflen contain result, if any except OK. - * \retval SR_ERR Error, including timeout. + * @retval SR_OK Msg received; buf and buflen contain result, if any except OK. + * @retval SR_ERR Error, including timeout. */ SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen) { @@ -374,17 +376,17 @@ static GSList *do_scan(lps_modelid modelid, struct sr_dev_driver *drv, GSList *o struct sr_channel_group *cg; GSList *devices; const char *conn, *serialcomm; - int cnt; - gchar buf[LINELEN_MAX]; + int cnt, ret; + gchar buf[LINELEN_MAX]; gchar channel[10]; - char* verstr; + char *verstr; sdi = NULL; devc = NULL; conn = serialcomm = NULL; devices = NULL; - drvc = drv->priv; + drvc = drv->context; drvc->instances = NULL; sr_spew("scan() called!"); @@ -396,8 +398,7 @@ static GSList *do_scan(lps_modelid modelid, struct sr_dev_driver *drv, GSList *o serialcomm = SERIALCOMM; /* Init serial port. */ - if (!(serial = sr_serial_dev_inst_new(conn, serialcomm))) - return NULL; + serial = sr_serial_dev_inst_new(conn, serialcomm); if (serial_open(serial, SERIAL_RDWR) != SR_OK) goto exit_err; @@ -430,39 +431,39 @@ static GSList *do_scan(lps_modelid modelid, struct sr_dev_driver *drv, GSList *o /* Query version */ verstr = NULL; - if (lps_cmd_reply(buf, serial, "VERSION") == SR_OK) { + if ((ret = lps_cmd_reply(buf, serial, "VERSION")) == SR_OK) { if (strncmp(buf, "Ver-", 4)) { sr_spew("Version string %s not recognized.", buf); goto exit_err; } - g_strstrip(buf); verstr = buf + 4; } - else /* Bug in device FW 1.17: Quering version string fails while output is active. + else /* Bug in device FW 1.17: Querying version string fails while output is active. Therefore just print an error message, but do not exit with error. */ - sr_err("Failed to query for hardware version: %d %s", errno, strerror(errno)); - - sdi = sr_dev_inst_new(SR_ST_INACTIVE, VENDOR_MOTECH, models[modelid].modelstr, verstr); + sr_err("Failed to query for hardware version: %s.", + sr_strerror(ret)); + + sdi = g_malloc0(sizeof(struct sr_dev_inst)); + sdi->status = SR_ST_INACTIVE; + sdi->vendor = g_strdup(VENDOR_MOTECH); + sdi->model = g_strdup(models[modelid].modelstr); + sdi->version = g_strdup(verstr); sdi->driver = drv; sdi->inst_type = SR_INST_SERIAL; sdi->conn = serial; devc = g_malloc0(sizeof(struct dev_context)); + sr_sw_limits_init(&devc->limits); devc->model = &models[modelid]; - devc->limit_samples = 0; - devc->limit_msec = 0; - devc->num_samples = 0; - devc->elapsed_msec = g_timer_new(); sdi->priv = devc; /* Setup channels and channel groups. */ for (cnt = 0; cnt < models[modelid].num_channels; cnt++) { snprintf(channel, sizeof(channel), "CH%d", cnt + 1); - ch = sr_channel_new(cnt, SR_CHANNEL_ANALOG, TRUE, channel); - sdi->channels = g_slist_append(sdi->channels, ch); + ch = sr_channel_new(sdi, cnt, SR_CHANNEL_ANALOG, TRUE, channel); devc->channel_status[cnt].info = g_slist_append(NULL, ch); @@ -495,8 +496,7 @@ exit_err: serial_close(serial); sr_serial_dev_inst_free(serial); } - if (devc) - g_free(devc); + g_free(devc); if (sdi) sr_dev_inst_free(sdi); @@ -504,40 +504,23 @@ exit_err: } /** Scan for LPS-301 device. */ -static GSList *scan_lps301(GSList *options) +static GSList *scan_lps301(struct sr_dev_driver *di, GSList *options) { - return do_scan(LPS_301, &motech_lps_301_driver_info, options); + return do_scan(LPS_301, di, options); } -static GSList *doDevList(struct sr_dev_driver *drv) -{ - return ((struct drv_context *)(drv->priv))->instances; -} - -static GSList *dev_list_lps301(void) -{ - return doDevList(&motech_lps_301_driver_info); -} - -static void dev_clear_private(struct dev_context* devc) +static void dev_clear_private(struct dev_context *devc) { int ch_idx; /* Free channel_status.info (list only, data owned by sdi). */ for (ch_idx = 0; ch_idx < devc->model->num_channels; ch_idx++) g_slist_free(devc->channel_status[ch_idx].info); - - g_timer_destroy(devc->elapsed_msec); } -static int dev_clear_lps301(void) +static int dev_clear_lps301(const struct sr_dev_driver *di) { - return std_dev_clear(&motech_lps_301_driver_info, (std_dev_clear_callback)dev_clear_private); -} - -static int cleanup(void) -{ - return dev_clear_lps301(); + return std_dev_clear(di, (std_dev_clear_callback)dev_clear_private); } static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, @@ -556,12 +539,9 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s /* No channel group: global options. */ switch (key) { case SR_CONF_LIMIT_SAMPLES: - *data = g_variant_new_uint64(devc->limit_samples); - break; case SR_CONF_LIMIT_MSEC: - *data = g_variant_new_uint64(devc->limit_msec); - break; - case SR_CONF_OUTPUT_CHANNEL_CONFIG: + return sr_sw_limits_config_get(&devc->limits, key, data); + case SR_CONF_CHANNEL_CONFIG: *data = g_variant_new_string(channel_modes[devc->tracking_mode]); break; default: @@ -572,19 +552,19 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s ch = cg->channels->data; ch_idx = ch->index; switch (key) { - case SR_CONF_OUTPUT_VOLTAGE: + case SR_CONF_VOLTAGE: *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_last); break; - case SR_CONF_OUTPUT_VOLTAGE_TARGET: + case SR_CONF_VOLTAGE_TARGET: *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_max); break; - case SR_CONF_OUTPUT_CURRENT: + case SR_CONF_CURRENT: *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_last); break; - case SR_CONF_OUTPUT_CURRENT_LIMIT: + case SR_CONF_CURRENT_LIMIT: *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_max); break; - case SR_CONF_OUTPUT_ENABLED: + case SR_CONF_ENABLED: *data = g_variant_new_boolean(devc->channel_status[ch_idx].output_enabled); break; default: @@ -621,24 +601,12 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd /* No channel group: global options. */ switch (key) { case SR_CONF_LIMIT_MSEC: - if (g_variant_get_uint64(data) == 0) { - sr_err("LIMIT_MSEC can't be 0."); - return SR_ERR; - } - devc->limit_msec = g_variant_get_uint64(data); - sr_dbg("Setting time limit to %" PRIu64 "ms.", - devc->limit_msec); - break; case SR_CONF_LIMIT_SAMPLES: - devc->limit_samples = g_variant_get_uint64(data); - sr_dbg("Setting sample limit to %" PRIu64 ".", - devc->limit_samples); - break; - case SR_CONF_OUTPUT_CHANNEL_CONFIG: + return sr_sw_limits_config_set(&devc->limits, key, data); + case SR_CONF_CHANNEL_CONFIG: sval = g_variant_get_string(data, NULL); found = FALSE; - for (idx = 0; idx < (int)ARRAY_SIZE(channel_modes); idx++) - { + for (idx = 0; idx < (int)ARRAY_SIZE(channel_modes); idx++) { if (!strcmp(sval, channel_modes[idx])) { found = TRUE; if (devc->tracking_mode == idx) @@ -650,9 +618,8 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd if (devc->model->modelid <= LPS_303) /* Only first setting possible for smaller models. */ break; } - if (!found) { + if (!found) return SR_ERR_ARG; - } break; default: return SR_ERR_NA; @@ -664,7 +631,7 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd ch_idx = ch->index; switch (key) { - case SR_CONF_OUTPUT_VOLTAGE_TARGET: + case SR_CONF_VOLTAGE_TARGET: dval = g_variant_get_double(data); if (dval < 0 || dval > devc->model->channels[ch_idx].voltage[1]) return SR_ERR_ARG; @@ -685,7 +652,7 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd else return lps_cmd_ok(sdi->conn, "VSET%d %05.3f", ch_idx+1, dval); break; - case SR_CONF_OUTPUT_CURRENT_LIMIT: + case SR_CONF_CURRENT_LIMIT: dval = g_variant_get_double(data); if (dval < 0 || dval > devc->model->channels[ch_idx].current[1]) return SR_ERR_ARG; @@ -694,7 +661,7 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd devc->channel_status[ch_idx].output_current_max = dval; return lps_cmd_ok(sdi->conn, "ISET%d %05.4f", ch_idx+1, dval); break; - case SR_CONF_OUTPUT_ENABLED: + case SR_CONF_ENABLED: bval = g_variant_get_boolean(data); if (bval == devc->channel_status[ch_idx].output_enabled) /* Nothing to do. */ break; @@ -726,29 +693,33 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst * GVariant *gvar; GVariantBuilder gvb; - (void)data; - /* Driver options, no device instance necessary. */ switch (key) { case SR_CONF_SCAN_OPTIONS: *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, - scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t)); + scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t)); + return SR_OK; + case SR_CONF_DEVICE_OPTIONS: + if (sdi) + break; + *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, + drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t)); return SR_OK; default: - if (sdi == NULL) + if (!sdi) return SR_ERR_ARG; - devc = sdi->priv; + break; } /* Device options, independent from channel groups. */ - if (cg == NULL) { + if (!cg) { switch (key) { case SR_CONF_DEVICE_OPTIONS: *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, devopts, ARRAY_SIZE(devopts), sizeof(uint32_t)); return SR_OK; - case SR_CONF_OUTPUT_CHANNEL_CONFIG: + case SR_CONF_CHANNEL_CONFIG: if (devc->model->modelid <= LPS_303) { /* The 1-channel models. */ *data = g_variant_new_strv(channel_modes, 1); @@ -757,7 +728,6 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst * *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes)); } return SR_OK; - break; default: return SR_ERR_NA; } @@ -775,7 +745,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst * *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, devopts_ch3, ARRAY_SIZE(devopts_ch3), sizeof(uint32_t)); break; - case SR_CONF_OUTPUT_VOLTAGE_TARGET: + case SR_CONF_VOLTAGE_TARGET: g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); /* Min, max, step. */ for (i = 0; i < 3; i++) { @@ -784,7 +754,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst * } *data = g_variant_builder_end(&gvb); break; - case SR_CONF_OUTPUT_CURRENT_LIMIT: + case SR_CONF_CURRENT_LIMIT: g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); /* Min, max, step. */ for (i = 0; i < 3; i++) { @@ -800,8 +770,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst * return SR_OK; } -static int dev_acquisition_start(const struct sr_dev_inst *sdi, - void *cb_data) +static int dev_acquisition_start(const struct sr_dev_inst *sdi) { struct dev_context *devc; struct sr_serial_dev_inst *serial; @@ -816,11 +785,9 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, serial = sdi->conn; serial_source_add(sdi->session, serial, G_IO_IN, 50, motech_lps_30x_receive_data, (void *)sdi); - std_session_send_df_header(cb_data, LOG_PREFIX); + std_session_send_df_header(sdi, LOG_PREFIX); - /* Start timer, if required. */ - if (devc->limit_msec) - g_timer_start(devc->elapsed_msec); + sr_sw_limits_acquisition_start(&devc->limits); devc->acq_req = AQ_NONE; /* Do not start polling device here, the read function will do it in 50 ms. */ @@ -828,15 +795,9 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, return SR_OK; } -static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) +static int dev_acquisition_stop(struct sr_dev_inst *sdi) { - struct dev_context *devc; - - /* Stop timer, if required. */ - if (sdi && (devc = sdi->priv) && devc->limit_msec) - g_timer_stop(devc->elapsed_msec); - - return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close, + return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close, sdi->conn, LOG_PREFIX); } @@ -844,10 +805,10 @@ SR_PRIV struct sr_dev_driver motech_lps_301_driver_info = { .name = "motech-lps-301", .longname = "Motech LPS-301", .api_version = 1, - .init = init_lps301, - .cleanup = cleanup, + .init = std_init, + .cleanup = std_cleanup, .scan = scan_lps301, - .dev_list = dev_list_lps301, + .dev_list = std_dev_list, .dev_clear = dev_clear_lps301, .config_get = config_get, .config_set = config_set, @@ -856,5 +817,5 @@ SR_PRIV struct sr_dev_driver motech_lps_301_driver_info = { .dev_close = std_serial_dev_close, .dev_acquisition_start = dev_acquisition_start, .dev_acquisition_stop = dev_acquisition_stop, - .priv = NULL, + .context = NULL, };