]> sigrok.org Git - libsigrok.git/commitdiff
binary_helpers: Rename bv_get_value to reflect it's length checking
authorMathieu Pilato <redacted>
Fri, 31 Mar 2023 08:02:20 +0000 (10:02 +0200)
committerGerhard Sittig <redacted>
Sun, 30 Apr 2023 09:34:07 +0000 (11:34 +0200)
Rename the bv_get_value() routine to bv_get_value_len() to better reflect
that this implementation checks the input data image's length. A version
which doesn't check length will get introduced soon.

[ gsi: use a shorter name than in the initial submission ]

src/binary_helpers.c
src/hardware/rdtech-tc/protocol.c
src/hardware/rdtech-um/protocol.c
src/libsigrok-internal.h

index e8547a01103686260714fc6094f41d64c8a3a57d..72c05ef101a0cbc33e161971d0a32ae95a16441c 100644 (file)
@@ -22,7 +22,7 @@
 #include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
-SR_PRIV int bv_get_value(float *out, const struct binary_value_spec *spec,
+SR_PRIV int bv_get_value_len(float *out, const struct binary_value_spec *spec,
        const uint8_t *data, size_t length)
 {
        float value;
index dc35ca52d096e7e0a5371c0ee92339bf458372a7..99297ba6f8fb75595e1ec94110f2c849ca59fde8 100644 (file)
@@ -265,7 +265,7 @@ static int handle_poll_data(struct sr_dev_inst *sdi)
        std_session_send_df_frame_begin(sdi);
        for (ch_idx = 0; ch_idx < devc->channel_count; ch_idx++) {
                pch = &devc->channels[ch_idx];
-               ret = bv_get_value(&v, &pch->spec, poll_pkt, TC_POLL_LEN);
+               ret = bv_get_value_len(&v, &pch->spec, poll_pkt, TC_POLL_LEN);
                if (ret != SR_OK)
                        break;
                ret = feed_queue_analog_submit(devc->feeds[ch_idx], v, 1);
index 321457c6cc0e77c0e198d7e7fd137f8c25ff38a4..aa32768a6ff022dce664b5a10150cb697d1be0d0 100644 (file)
@@ -211,7 +211,7 @@ static int process_data(struct sr_dev_inst *sdi,
        ret = SR_OK;
        std_session_send_df_frame_begin(sdi);
        for (ch_idx = 0; ch_idx < p->channel_count; ch_idx++) {
-               ret = bv_get_value(&v, &p->channels[ch_idx].spec, data, dlen);
+               ret = bv_get_value_len(&v, &p->channels[ch_idx].spec, data, dlen);
                if (ret != SR_OK)
                        break;
                ret = feed_queue_analog_submit(devc->feeds[ch_idx], v, 1);
index 46865efc0b00dbcceb5751a65ea9af059859654e..b47a8e5d6e0542126d946cdf8ae8ae0a827684f2 100644 (file)
@@ -2240,7 +2240,8 @@ struct binary_value_spec {
 };
 
 /**
- * Read extract a value from a binary data image.
+ * Read extract a value from a binary data image, ensuring no out-of-bounds
+ * read happens.
  *
  * @param[out] out Pointer to output buffer (conversion result)
  * @param[in] spec Binary value specification
@@ -2249,7 +2250,7 @@ struct binary_value_spec {
  *
  * @return SR_OK on success, SR_ERR_* error code on failure.
  */
-SR_PRIV int bv_get_value(float *out, const struct binary_value_spec *spec,
+SR_PRIV int bv_get_value_len(float *out, const struct binary_value_spec *spec,
        const uint8_t *data, size_t length);
 
 /*--- crc.c -----------------------------------------------------------------*/