X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=src%2Fstd.c;h=81f269fa92dc26ee73b9ca90081dc27039d010d9;hp=522606f8fd48b737ea33861a3b8dd46e58f09b40;hb=HEAD;hpb=769561cbe9ff04e02502832cae676fc591716866 diff --git a/src/std.c b/src/std.c index 522606f8..959d0005 100644 --- a/src/std.c +++ b/src/std.c @@ -21,8 +21,6 @@ * @file * * Standard API helper functions. - * - * @internal */ /* Needed for gettimeofday(), at least on FreeBSD. */ @@ -39,6 +37,8 @@ #define LOG_PREFIX "std" +SR_PRIV const uint32_t NO_OPTS[1] = {}; + /** * Standard driver init() callback API helper. * @@ -182,7 +182,6 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi) prefix = (sdi->driver) ? sdi->driver->name : "unknown"; /* Send header packet to the session bus. */ - sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix); packet.type = SR_DF_HEADER; packet.payload = (uint8_t *)&header; header.feed_version = 1; @@ -196,19 +195,7 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi) 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) +static int send_df_without_payload(const struct sr_dev_inst *sdi, uint16_t packet_type) { const char *prefix; int ret; @@ -221,13 +208,11 @@ SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi) prefix = (sdi->driver) ? sdi->driver->name : "unknown"; - sr_dbg("%s: Sending SR_DF_END packet.", prefix); - - packet.type = SR_DF_END; + packet.type = packet_type; packet.payload = NULL; if ((ret = sr_session_send(sdi, &packet)) < 0) { - sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret); + sr_err("%s: Failed to send packet of type %d: %d.", prefix, packet_type, ret); return ret; } @@ -235,10 +220,10 @@ SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi) } /** - * Standard API helper for sending an SR_DF_FRAME_BEGIN packet. + * Standard API helper for sending an SR_DF_END packet. * * This function can be used to simplify most drivers' - * frame handling. + * dev_acquisition_stop() API callback. * * @param[in] sdi The device instance to use. Must not be NULL. * @@ -246,37 +231,47 @@ SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi) * @retval SR_ERR_ARG Invalid argument. * @retval other Other error. */ -SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi) +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_FRAME_BEGIN packet.", prefix); - - packet.type = SR_DF_FRAME_BEGIN; - packet.payload = NULL; + return send_df_without_payload(sdi, SR_DF_END); +} - if ((ret = sr_session_send(sdi, &packet)) < 0) { - sr_err("%s: Failed to send SR_DF_FRAME_BEGIN packet: %d.", prefix, ret); - return ret; - } +/** + * Standard API helper for sending an SR_DF_TRIGGER packet. + * + * This function can be used to simplify most drivers' trigger handling. + * + * @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_trigger(const struct sr_dev_inst *sdi) +{ + return send_df_without_payload(sdi, SR_DF_TRIGGER); +} - return SR_OK; +/** + * Standard API helper for sending an SR_DF_FRAME_BEGIN packet. + * + * This function can be used to simplify most drivers' frame handling. + * + * @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_frame_begin(const struct sr_dev_inst *sdi) +{ + return send_df_without_payload(sdi, SR_DF_FRAME_BEGIN); } /** * Standard API helper for sending an SR_DF_FRAME_END packet. * - * This function can be used to simplify most drivers' - * frame handling. + * This function can be used to simplify most drivers' frame handling. * * @param[in] sdi The device instance to use. Must not be NULL. * @@ -284,33 +279,12 @@ SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi) * @retval SR_ERR_ARG Invalid argument. * @retval other Other error. */ -SR_PRIV int std_session_send_frame_end(const struct sr_dev_inst *sdi) +SR_PRIV int std_session_send_df_frame_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_FRAME_END packet.", prefix); - - packet.type = SR_DF_FRAME_END; - packet.payload = NULL; - - if ((ret = sr_session_send(sdi, &packet)) < 0) { - sr_err("%s: Failed to send SR_DF_FRAME_END packet: %d.", prefix, ret); - return ret; - } - - return SR_OK; + return send_df_without_payload(sdi, SR_DF_FRAME_END); } -#ifdef HAVE_LIBSERIALPORT +#ifdef HAVE_SERIAL_COMM /** * Standard serial driver dev_open() callback API helper. @@ -397,11 +371,6 @@ SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi) return ret; } - if ((ret = sr_dev_close(sdi)) < 0) { - sr_err("%s: Failed to close device: %d.", prefix, ret); - return ret; - } - return std_session_send_df_end(sdi); } @@ -455,11 +424,11 @@ SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver, ret = SR_ERR_BUG; continue; } - if (driver->dev_close) + if (driver->dev_close && sdi->status == SR_ST_ACTIVE) driver->dev_close(sdi); if (sdi->conn) { -#ifdef HAVE_LIBSERIALPORT +#ifdef HAVE_SERIAL_COMM if (sdi->inst_type == SR_INST_SERIAL) sr_serial_dev_inst_free(sdi->conn); #endif @@ -588,7 +557,7 @@ SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data, switch (key) { case SR_CONF_SCAN_OPTIONS: /* Always return scanopts, regardless of sdi or cg. */ - if (!scanopts) + if (!scanopts || scanopts == NO_OPTS) return SR_ERR_ARG; *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, scanopts, scansize, sizeof(uint32_t)); @@ -596,13 +565,13 @@ SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data, case SR_CONF_DEVICE_OPTIONS: if (!sdi) { /* sdi == NULL: return drvopts. */ - if (!drvopts) + if (!drvopts || drvopts == NO_OPTS) return SR_ERR_ARG; *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, drvopts, drvsize, sizeof(uint32_t)); } else if (sdi && !cg) { /* sdi != NULL, cg == NULL: return devopts. */ - if (!devopts) + if (!devopts || devopts == NO_OPTS) return SR_ERR_ARG; *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, devopts, devsize, sizeof(uint32_t)); @@ -629,14 +598,15 @@ SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n) GVariant *rational[2]; GVariantBuilder gvb; - g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); + g_variant_builder_init(&gvb, G_VARIANT_TYPE_TUPLE); for (i = 0; i < n; i++) { rational[0] = g_variant_new_uint64(a[i][0]); rational[1] = g_variant_new_uint64(a[i][1]); /* FIXME: Valgrind reports a memory leak here. */ - g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2)); + g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, + ARRAY_SIZE(rational))); } return g_variant_builder_end(&gvb); @@ -648,14 +618,15 @@ SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned GVariant *rational[2]; GVariantBuilder gvb; - g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); + g_variant_builder_init(&gvb, G_VARIANT_TYPE_TUPLE); for (i = 0; i < n; i++) { rational[0] = g_variant_new_uint64(r[i].p); rational[1] = g_variant_new_uint64(r[i].q); /* FIXME: Valgrind reports a memory leak here. */ - g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2)); + g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, + ARRAY_SIZE(rational))); } return g_variant_builder_end(&gvb); @@ -712,17 +683,23 @@ SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]) SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double min, const double max, const double step) { - double d; + double d, v; GVariant *gvar, *range[2]; GVariantBuilder gvb; g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); - for (d = min; d <= max; d += step) { - range[0] = g_variant_new_double(d); - range[1] = g_variant_new_double(d); + for (d = min; d <= max + step / 2.0; d += step) { + /* + * We will never see exactly 0.0 because of the error we're + * accumulating, so catch the "zero" value and force it to be 0. + */ + v = ((d > (-step / 2.0)) && (d < (step / 2.0))) ? 0 : d; + + range[0] = g_variant_new_double(v); + range[1] = g_variant_new_double(v); - gvar = g_variant_new_tuple(range, 2); + gvar = g_variant_new_tuple(range, ARRAY_SIZE(range)); g_variant_builder_add_value(&gvb, gvar); } @@ -736,7 +713,7 @@ SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high) range[0] = g_variant_new_uint64(low); range[1] = g_variant_new_uint64(high); - return g_variant_new_tuple(range, 2); + return g_variant_new_tuple(range, ARRAY_SIZE(range)); } SR_PRIV GVariant *std_gvar_tuple_double(double low, double high) @@ -746,7 +723,7 @@ SR_PRIV GVariant *std_gvar_tuple_double(double low, double high) range[0] = g_variant_new_double(low); range[1] = g_variant_new_double(high); - return g_variant_new_tuple(range, 2); + return g_variant_new_tuple(range, ARRAY_SIZE(range)); } SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n) @@ -795,7 +772,7 @@ SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n) for (i = 0; i < n; i++) { range[0] = g_variant_new_double(a[i][0]); range[1] = g_variant_new_double(a[i][1]); - gvar = g_variant_new_tuple(range, 2); + gvar = g_variant_new_tuple(range, ARRAY_SIZE(range)); g_variant_builder_add_value(&gvb, gvar); } @@ -936,3 +913,29 @@ SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_grou return -1; } + +SR_PRIV int std_dummy_set_params(struct sr_serial_dev_inst *serial, + int baudrate, int bits, int parity, int stopbits, + int flowcontrol, int rts, int dtr) +{ + (void)serial; + (void)baudrate; + (void)bits; + (void)parity; + (void)stopbits; + (void)flowcontrol; + (void)rts; + (void)dtr; + + return SR_OK; +} + +SR_PRIV int std_dummy_set_handshake(struct sr_serial_dev_inst *serial, + int rts, int dtr) +{ + (void)serial; + (void)rts; + (void)dtr; + + return SR_OK; +}