X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fgmc-mh-1x-2x%2Fapi.c;h=00789d45e6c5b2e43c0cfccce895f907889fb765;hb=15f96409dc54fd2ef784c59156daedd9acfa78ed;hp=96621bbfd6636f8f52a76b36dcdca496f19e99bc;hpb=155b680da482cea2381becb73c51cfb838bff31e;p=libsigrok.git diff --git a/src/hardware/gmc-mh-1x-2x/api.c b/src/hardware/gmc-mh-1x-2x/api.c index 96621bbf..00789d45 100644 --- a/src/hardware/gmc-mh-1x-2x/api.c +++ b/src/hardware/gmc-mh-1x-2x/api.c @@ -22,6 +22,7 @@ * @internal */ +#include #include #include "protocol.h" @@ -31,34 +32,30 @@ #define SERIALCOMM_2X "9600/8n1/dtr=1/rts=1/flow=0" #define VENDOR_GMC "Gossen Metrawatt" -SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info; -SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info; - -static const int32_t hwopts[] = { +static const uint32_t scanopts[] = { SR_CONF_CONN, SR_CONF_SERIALCOMM, }; /** Hardware capabilities for Metrahit 1x/2x devices in send mode. */ -static const int32_t hwcaps_sm[] = { +static const uint32_t devopts_sm[] = { SR_CONF_MULTIMETER, SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */ - SR_CONF_LIMIT_SAMPLES, - SR_CONF_LIMIT_MSEC, SR_CONF_CONTINUOUS, + SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET, + SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET, }; /** Hardware capabilities for Metrahit 2x devices in bidirectional Mode. */ -static const int32_t hwcaps_bd[] = { +static const uint32_t devopts_bd[] = { SR_CONF_MULTIMETER, SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */ - SR_CONF_LIMIT_SAMPLES, - SR_CONF_LIMIT_MSEC, SR_CONF_CONTINUOUS, - SR_CONF_POWER_OFF, + SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET, + SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET, + SR_CONF_POWER_OFF | SR_CONF_GET | SR_CONF_SET, }; - /* TODO: * - For the 29S SR_CONF_ENERGYMETER, too. * - SR_CONF_PATTERN_MODE for some 2x devices @@ -66,18 +63,6 @@ static const int32_t hwcaps_bd[] = { * Need to implement device-specific lists. */ -/** Init driver gmc_mh_1x_2x_rs232. */ -static int init_1x_2x_rs232(struct sr_context *sr_ctx) -{ - return std_init(sr_ctx, &gmc_mh_1x_2x_rs232_driver_info, LOG_PREFIX); -} - -/** Init driver gmc_mh_2x_bd232. */ -static int init_2x_bd232(struct sr_context *sr_ctx) -{ - return std_init(sr_ctx, &gmc_mh_2x_bd232_driver_info, LOG_PREFIX); -} - /** * Read single byte from serial port. * @@ -90,7 +75,7 @@ static int read_byte(struct sr_serial_dev_inst *serial, gint64 timeout) int rc = 0; for (;;) { - rc = serial_read(serial, &result, 1); + rc = serial_read_nonblocking(serial, &result, 1); if (rc == 1) { sr_spew("read: 0x%02x/%d", result, result); return result; @@ -116,7 +101,7 @@ static enum model scan_model_sm(struct sr_serial_dev_inst *serial) gint64 timeout_us; model = METRAHIT_NONE; - timeout_us = g_get_monotonic_time() + 1 * 1000 * 1000; + timeout_us = g_get_monotonic_time() + (1 * 1000 * 1000); /* * Try to find message consisting of device code and several @@ -156,13 +141,11 @@ static enum model scan_model_sm(struct sr_serial_dev_inst *serial) * on configuration and measurement mode the intervals can be much larger and * then the detection might not work. */ -static GSList *scan_1x_2x_rs232(GSList *options) +static GSList *scan_1x_2x_rs232(struct sr_dev_driver *di, GSList *options) { struct sr_dev_inst *sdi; - struct drv_context *drvc; struct dev_context *devc; struct sr_config *src; - struct sr_channel *ch; struct sr_serial_dev_inst *serial; GSList *l, *devices; const char *conn, *serialcomm; @@ -170,10 +153,7 @@ static GSList *scan_1x_2x_rs232(GSList *options) gboolean serialcomm_given; devices = NULL; - drvc = (&gmc_mh_1x_2x_rs232_driver_info)->priv; - drvc->instances = NULL; conn = serialcomm = NULL; - model = METRAHIT_NONE; serialcomm_given = FALSE; sr_spew("scan_1x_2x_rs232() called!"); @@ -195,10 +175,9 @@ static GSList *scan_1x_2x_rs232(GSList *options) if (!serialcomm) serialcomm = SERIALCOMM_2X_RS232; - 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 | SERIAL_NONBLOCK) != SR_OK) { + if (serial_open(serial, SERIAL_RDWR) != SR_OK) { sr_serial_dev_inst_free(serial); return NULL; } @@ -223,43 +202,32 @@ static GSList *scan_1x_2x_rs232(GSList *options) if (model != METRAHIT_NONE) { sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(model)); - if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR_GMC, - gmc_model_str(model), NULL))) - return NULL; - if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) { - sr_err("Device context malloc failed."); - return NULL; - } + sdi = g_malloc0(sizeof(struct sr_dev_inst)); + sdi->status = SR_ST_INACTIVE; + sdi->vendor = g_strdup(VENDOR_GMC); + sdi->model = g_strdup(gmc_model_str(model)); + devc = g_malloc0(sizeof(struct dev_context)); + sr_sw_limits_init(&devc->limits); devc->model = model; - devc->limit_samples = 0; - devc->limit_msec = 0; - devc->num_samples = 0; - devc->elapsed_msec = g_timer_new(); devc->settings_ok = FALSE; - sdi->conn = serial; sdi->priv = devc; - sdi->driver = &gmc_mh_1x_2x_rs232_driver_info; - if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1"))) - return NULL; - sdi->channels = g_slist_append(sdi->channels, ch); - drvc->instances = g_slist_append(drvc->instances, sdi); + sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1"); devices = g_slist_append(devices, sdi); } - return devices; + return std_scan_complete(di, devices); } -/** Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt 'BD 232' interface. - * +/** + * Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt + * 'BD 232' interface. */ -static GSList *scan_2x_bd232(GSList *options) +static GSList *scan_2x_bd232(struct sr_dev_driver *di, GSList *options) { struct sr_dev_inst *sdi; - struct drv_context *drvc; struct dev_context *devc; struct sr_config *src; - struct sr_channel *ch; struct sr_serial_dev_inst *serial; GSList *l, *devices; const char *conn, *serialcomm; @@ -271,9 +239,6 @@ static GSList *scan_2x_bd232(GSList *options) conn = serialcomm = NULL; devices = NULL; - drvc = (&gmc_mh_2x_bd232_driver_info)->priv; - drvc->instances = NULL; - sr_spew("scan_2x_bd232() called!"); for (l = options; l; l = l->next) { @@ -292,41 +257,36 @@ static GSList *scan_2x_bd232(GSList *options) if (!serialcomm) serialcomm = SERIALCOMM_2X; - 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 | SERIAL_NONBLOCK) != SR_OK) + if (serial_open(serial, SERIAL_RDWR) != SR_OK) goto exit_err; - if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) { - sr_err("Device context malloc failed."); - goto exit_err; - } - - if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR_GMC, NULL, NULL))) - goto exit_err; + devc = g_malloc0(sizeof(struct dev_context)); + sdi = g_malloc0(sizeof(struct sr_dev_inst)); + sdi->status = SR_ST_INACTIVE; + sdi->vendor = g_strdup(VENDOR_GMC); sdi->priv = devc; /* Send message 03 "Query multimeter version and status" */ sdi->conn = serial; - sdi->priv = devc; if (req_stat14(sdi, TRUE) != SR_OK) goto exit_err; /* Wait for reply from device(s) for up to 2s. */ - timeout_us = g_get_monotonic_time() + 2*1000*1000; + timeout_us = g_get_monotonic_time() + (2 * 1000 * 1000); while (timeout_us > g_get_monotonic_time()) { /* Receive reply (14 bytes) */ devc->buflen = 0; - for (cnt = 0; cnt < 14; cnt++) { + for (cnt = 0; cnt < GMC_REPLY_SIZE; cnt++) { byte = read_byte(serial, timeout_us); if (byte != -1) devc->buf[devc->buflen++] = (byte & MASK_6BITS); } - if (devc->buflen != 14) + if (devc->buflen != GMC_REPLY_SIZE) continue; devc->addr = devc->buf[0]; @@ -335,27 +295,17 @@ static GSList *scan_2x_bd232(GSList *options) if (devc->model != METRAHIT_NONE) { sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(devc->model)); - - devc->elapsed_msec = g_timer_new(); - + sr_sw_limits_init(&devc->limits); sdi->model = g_strdup(gmc_model_str(devc->model)); sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min); sdi->conn = serial; sdi->priv = devc; - sdi->driver = &gmc_mh_2x_bd232_driver_info; - if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1"))) - goto exit_err; - sdi->channels = g_slist_append(sdi->channels, ch); - drvc->instances = g_slist_append(drvc->instances, sdi); + sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1"); devices = g_slist_append(devices, sdi); - - if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) { - sr_err("Device context malloc failed."); - goto exit_err; - } - - if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR_GMC, NULL, NULL))) - goto exit_err; + devc = g_malloc0(sizeof(struct dev_context)); + sdi = g_malloc0(sizeof(struct sr_dev_inst)); + sdi->status = SR_ST_INACTIVE; + sdi->vendor = g_strdup(VENDOR_GMC); } }; @@ -365,34 +315,20 @@ static GSList *scan_2x_bd232(GSList *options) sr_dev_inst_free(sdi); } - return devices; + return std_scan_complete(di, devices); exit_err: sr_info("scan_2x_bd232(): Error!"); if (serial) sr_serial_dev_inst_free(serial); - if (devc) - g_free(devc); + g_free(devc); if (sdi) sr_dev_inst_free(sdi); return NULL; } -/** Driver device list function */ -static GSList *dev_list_1x_2x_rs232(void) -{ - return ((struct drv_context *)(gmc_mh_1x_2x_rs232_driver_info.priv))->instances; -} - -/** Driver device list function */ -static GSList *dev_list_2x_bd232(void) -{ - return ((struct drv_context *)(gmc_mh_2x_bd232_driver_info.priv)) - ->instances; -} - static int dev_close(struct sr_dev_inst *sdi) { struct dev_context *devc; @@ -400,49 +336,30 @@ static int dev_close(struct sr_dev_inst *sdi) std_serial_dev_close(sdi); sdi->status = SR_ST_INACTIVE; - - /* Free dynamically allocated resources. */ - if ((devc = sdi->priv) && devc->elapsed_msec) { - g_timer_destroy(devc->elapsed_msec); - devc->elapsed_msec = NULL; + if ((devc = sdi->priv)) devc->model = METRAHIT_NONE; - } return SR_OK; } -static int cleanup_sm_rs232(void) -{ - return std_dev_clear(&gmc_mh_1x_2x_rs232_driver_info, NULL); -} - -static int cleanup_2x_bd232(void) -{ - return std_dev_clear(&gmc_mh_2x_bd232_driver_info, NULL); -} - -/** Get value of configuration item */ -static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi, - const struct sr_channel_group *cg) +static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, + const struct sr_channel_group *cg) { int ret; struct dev_context *devc; (void)cg; - ret = SR_OK; - - if (!sdi || !(devc = sdi->priv)) + if (!sdi) return SR_ERR_ARG; + devc = sdi->priv; + ret = SR_OK; 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; + return sr_sw_limits_config_get(&devc->limits, key, data); case SR_CONF_POWER_OFF: *data = g_variant_new_boolean(FALSE); break; @@ -453,17 +370,17 @@ static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi, return ret; } -/** Implementation of config_list, auxiliary function for common parts, */ -static int config_list_common(int key, GVariant **data, const struct sr_dev_inst *sdi, - const struct sr_channel_group *cg) +/** Implementation of config_list, auxiliary function for common parts. */ +static int config_list_common(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, + const struct sr_channel_group *cg) { (void)sdi; (void)cg; switch (key) { case SR_CONF_SCAN_OPTIONS: - *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, - hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t)); + *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, + scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t)); break; default: return SR_ERR_NA; @@ -473,13 +390,13 @@ static int config_list_common(int key, GVariant **data, const struct sr_dev_inst } /** Implementation of config_list for Metrahit 1x/2x send mode */ -static int config_list_sm(int key, GVariant **data, const struct sr_dev_inst *sdi, +static int config_list_sm(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) { switch (key) { case SR_CONF_DEVICE_OPTIONS: - *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, - hwcaps_sm, ARRAY_SIZE(hwcaps_sm), sizeof(int32_t)); + *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, + devopts_sm, ARRAY_SIZE(devopts_sm), sizeof(uint32_t)); break; default: return config_list_common(key, data, sdi, cg); @@ -489,13 +406,13 @@ static int config_list_sm(int key, GVariant **data, const struct sr_dev_inst *sd } /** Implementation of config_list for Metrahit 2x bidirectional mode */ -static int config_list_bd(int key, GVariant **data, const struct sr_dev_inst *sdi, +static int config_list_bd(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) { switch (key) { case SR_CONF_DEVICE_OPTIONS: - *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, - hwcaps_bd, ARRAY_SIZE(hwcaps_bd), sizeof(int32_t)); + *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, + devopts_bd, ARRAY_SIZE(devopts_bd), sizeof(uint32_t)); break; default: return config_list_common(key, data, sdi, cg); @@ -504,28 +421,20 @@ static int config_list_bd(int key, GVariant **data, const struct sr_dev_inst *sd return SR_OK; } -static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi, - void *cb_data) +static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi) { struct dev_context *devc; struct sr_serial_dev_inst *serial; - if (!sdi || !cb_data || !(devc = sdi->priv)) - return SR_ERR_BUG; - if (sdi->status != SR_ST_ACTIVE) return SR_ERR_DEV_CLOSED; - devc->cb_data = cb_data; + devc = sdi->priv; devc->settings_ok = FALSE; devc->buflen = 0; - /* Send header packet to the session bus. */ - std_session_send_df_header(cb_data, LOG_PREFIX); - - /* Start timer, if required. */ - if (devc->limit_msec) - g_timer_start(devc->elapsed_msec); + sr_sw_limits_acquisition_start(&devc->limits); + std_session_send_df_header(sdi); /* Poll every 40ms, or whenever some data comes in. */ serial = sdi->conn; @@ -535,28 +444,20 @@ static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi, return SR_OK; } -static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi, - void *cb_data) +static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi) { struct dev_context *devc; struct sr_serial_dev_inst *serial; - if (!sdi || !cb_data || !(devc = sdi->priv)) - return SR_ERR_BUG; - if (sdi->status != SR_ST_ACTIVE) return SR_ERR_DEV_CLOSED; - devc->cb_data = cb_data; + devc = sdi->priv; devc->settings_ok = FALSE; devc->buflen = 0; - /* Send header packet to the session bus. */ - std_session_send_df_header(cb_data, LOG_PREFIX); - - /* Start timer, if required. */ - if (devc->limit_msec) - g_timer_start(devc->elapsed_msec); + sr_sw_limits_acquisition_start(&devc->limits); + std_session_send_df_header(sdi); /* Poll every 40ms, or whenever some data comes in. */ serial = sdi->conn; @@ -567,26 +468,19 @@ static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi, return req_meas14(sdi); } -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, dev_close, - sdi->conn, LOG_PREFIX); + return std_serial_dev_acquisition_stop(sdi, dev_close); } -SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = { +static struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = { .name = "gmc-mh-1x-2x-rs232", .longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface", .api_version = 1, - .init = init_1x_2x_rs232, - .cleanup = cleanup_sm_rs232, + .init = std_init, + .cleanup = std_cleanup, .scan = scan_1x_2x_rs232, - .dev_list = dev_list_1x_2x_rs232, + .dev_list = std_dev_list, .dev_clear = NULL, .config_get = config_get, .config_set = config_set, @@ -595,17 +489,18 @@ SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = { .dev_close = dev_close, .dev_acquisition_start = dev_acquisition_start_1x_2x_rs232, .dev_acquisition_stop = dev_acquisition_stop, - .priv = NULL, + .context = NULL, }; +SR_REGISTER_DEV_DRIVER(gmc_mh_1x_2x_rs232_driver_info); -SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info = { +static struct sr_dev_driver gmc_mh_2x_bd232_driver_info = { .name = "gmc-mh-2x-bd232", .longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface", .api_version = 1, - .init = init_2x_bd232, - .cleanup = cleanup_2x_bd232, + .init = std_init, + .cleanup = std_cleanup, .scan = scan_2x_bd232, - .dev_list = dev_list_2x_bd232, + .dev_list = std_dev_list, .dev_clear = NULL, .config_get = config_get, .config_set = config_set, @@ -614,5 +509,6 @@ SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info = { .dev_close = dev_close, .dev_acquisition_start = dev_acquisition_start_2x_bd232, .dev_acquisition_stop = dev_acquisition_stop, - .priv = NULL, + .context = NULL, }; +SR_REGISTER_DEV_DRIVER(gmc_mh_2x_bd232_driver_info);