binary_helpers: Add bv_get_value function.

[libsigrok.git] / src / libsigrok-internal.h

diff --git a/src/libsigrok-internal.h b/src/libsigrok-internal.h
index df149bceee1cea16ca957a728e022f48dcea2a2e..bb2fc6ccd5db8accd73b01ffaa1d3bc74727a966 100644 (file)
--- a/src/libsigrok-internal.h
+++ b/src/libsigrok-internal.h
@@ -172,6 +172,23 @@ static inline uint32_t read_u24le(const uint8_t *p)
        return u;
 }
 
+/**
+ * Read a 24 bits big endian unsigned integer out of memory.
+ * @param x a pointer to the input memory
+ * @return the corresponding unsigned integer
+ */
+static inline uint32_t read_u24be(const uint8_t *p)
+{
+       uint32_t u;
+
+       u = 0;
+       u <<= 8; u |= p[0];
+       u <<= 8; u |= p[1];
+       u <<= 8; u |= p[2];
+
+       return u;
+}
+
 /**
  * Read a 32 bits big endian unsigned integer out of memory.
  * @param x a pointer to the input memory
@@ -2204,11 +2221,13 @@ enum binary_value_type {
        BVT_LE_UINT8 = BVT_UINT8,
 
        BVT_BE_UINT16,
+       BVT_BE_UINT24,
        BVT_BE_UINT32,
        BVT_BE_UINT64,
        BVT_BE_FLOAT,
 
        BVT_LE_UINT16,
+       BVT_LE_UINT24,
        BVT_LE_UINT32,
        BVT_LE_UINT64,
        BVT_LE_FLOAT,
@@ -2221,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
@@ -2230,8 +2250,20 @@ struct binary_value_spec {
  *
  * @return SR_OK on success, SR_ERR_* error code on failure.
  */
+SR_PRIV int bv_get_value_len(float *out, const struct binary_value_spec *spec,
+       const uint8_t *data, size_t length);
+
+/**
+ * Read extract a value from a binary data image, without bound check.
+ *
+ * @param[out] out Pointer to output buffer (conversion result)
+ * @param[in] spec Binary value specification
+ * @param[in] data Pointer to binary input data
+ *
+ * @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,
-       const void *data, size_t length);
+       const uint8_t *data);
 
 /*--- crc.c -----------------------------------------------------------------*/