From 6382fc9836956352f1570cbb54d9a911f127f2a6 Mon Sep 17 00:00:00 2001
From: Martin Anderseck <martin.anderseck@ni.com>
Date: Tue, 21 Sep 2021 11:52:09 +0200
Subject: chdr: Rename var max_size_bytes to avoid confusion

The variable max_size_bytes has a different name in the source than in
the header and is not self-explanatory in both. Therefore when comparing
against it in the assertion in line 142 one could assume that a number
of bytes needs to be compared with a byte value. Change variable to
`buff_size` in source and header file to avoid confusion and add
documentation.
---
 host/include/uhd/rfnoc/chdr_types.hpp | 44 +++++++++++++++++++++++++----------
 1 file changed, 32 insertions(+), 12 deletions(-)

(limited to 'host/include')

diff --git a/host/include/uhd/rfnoc/chdr_types.hpp b/host/include/uhd/rfnoc/chdr_types.hpp
index fac0331e0..ceeb8d12a 100644
--- a/host/include/uhd/rfnoc/chdr_types.hpp
+++ b/host/include/uhd/rfnoc/chdr_types.hpp
@@ -315,19 +315,24 @@ public: // Functions
     }
 
     //! Deserialize the payload from a uint64_t buffer
+    //! \param buff Buffer to deserialize the payload from
+    //! \param buff_size Number of elements in the buffer
+    //! \param conv_byte_order Byte order converter function (buffer to host endianness)
     void deserialize(const uint64_t* buff,
-        size_t num_elems,
+        size_t buff_size,
         const std::function<uint64_t(uint64_t)>& conv_byte_order);
 
     //! Deserialize the payload from a uint64_t buffer (no conversion function)
+    //! \param buff Buffer to deserialize the payload from
+    //! \param buff_size Number of elements in the buffer
     template <endianness_t endianness>
-    void deserialize(const uint64_t* buff, size_t num_elems)
+    void deserialize(const uint64_t* buff, size_t buff_size)
     {
         auto conv_byte_order = [](uint64_t x) -> uint64_t {
             return (endianness == uhd::ENDIANNESS_BIG) ? uhd::ntohx<uint64_t>(x)
                                                        : uhd::wtohx<uint64_t>(x);
         };
-        deserialize(buff, num_elems, conv_byte_order);
+        deserialize(buff, buff_size, conv_byte_order);
     }
 
     //! Get the serialized size of this payload in 64 bit words
@@ -439,19 +444,24 @@ public: // Functions
     }
 
     //! Deserialize the payload from a uint64_t buffer
+    //! \param buff Buffer to deserialize the payload from
+    //! \param buff_size Number of elements in the buffer
+    //! \param conv_byte_order Byte order converter function (buffer to host endianness)
     void deserialize(const uint64_t* buff,
-        size_t num_elems,
+        size_t buff_size,
         const std::function<uint64_t(uint64_t)>& conv_byte_order);
 
     //! Deserialize the payload from a uint64_t buffer (no conversion function)
+    //! \param buff Buffer to deserialize the payload from
+    //! \param buff_size Number of elements in the buffer
     template <endianness_t endianness>
-    void deserialize(const uint64_t* buff, size_t num_elems)
+    void deserialize(const uint64_t* buff, size_t buff_size)
     {
         auto conv_byte_order = [](uint64_t x) -> uint64_t {
             return (endianness == uhd::ENDIANNESS_BIG) ? uhd::ntohx<uint64_t>(x)
                                                        : uhd::wtohx<uint64_t>(x);
         };
-        deserialize(buff, num_elems, conv_byte_order);
+        deserialize(buff, buff_size, conv_byte_order);
     }
 
     //! Get the serialized size of this payload in 64 bit words
@@ -541,19 +551,24 @@ public: // Functions
     }
 
     //! Deserialize the payload from a uint64_t buffer
+    //! \param buff Buffer to deserialize the payload from
+    //! \param buff_size Number of elements in the buffer
+    //! \param conv_byte_order Byte order converter function (buffer to host endianness)
     void deserialize(const uint64_t* buff,
-        size_t num_elems,
+        size_t buff_size,
         const std::function<uint64_t(uint64_t)>& conv_byte_order);
 
     //! Deserialize the payload from a uint64_t buffer (no conversion function)
+    //! \param buff Buffer to deserialize the payload from
+    //! \param buff_size Number of elements in the buffer
     template <endianness_t endianness>
-    void deserialize(const uint64_t* buff, size_t num_elems)
+    void deserialize(const uint64_t* buff, size_t buff_size)
     {
         auto conv_byte_order = [](uint64_t x) -> uint64_t {
             return (endianness == uhd::ENDIANNESS_BIG) ? uhd::ntohx<uint64_t>(x)
                                                        : uhd::wtohx<uint64_t>(x);
         };
-        deserialize(buff, num_elems, conv_byte_order);
+        deserialize(buff, buff_size, conv_byte_order);
     }
 
     //! Get the serialized size of this payload in 64 bit words
@@ -847,19 +862,24 @@ public:
     }
 
     //! Deserialize the payload from a uint64_t buffer
+    //! \param buff Buffer to deserialize the payload from
+    //! \param buff_size Number of elements in the buffer
+    //! \param conv_byte_order Byte order converter function (buffer to host endianness)
     void deserialize(const uint64_t* buff,
-        size_t num_elems,
+        size_t buff_size,
         const std::function<uint64_t(uint64_t)>& conv_byte_order);
 
     //! Deserialize the payload from a uint64_t buffer (no conversion function)
+    //! \param buff Buffer to deserialize the payload from
+    //! \param buff_size Number of elements in the buffer
     template <endianness_t endianness>
-    void deserialize(const uint64_t* buff, size_t num_elems)
+    void deserialize(const uint64_t* buff, size_t buff_size)
     {
         auto conv_byte_order = [](uint64_t x) -> uint64_t {
             return (endianness == uhd::ENDIANNESS_BIG) ? uhd::ntohx<uint64_t>(x)
                                                        : uhd::wtohx<uint64_t>(x);
         };
-        deserialize(buff, num_elems, conv_byte_order);
+        deserialize(buff, buff_size, conv_byte_order);
     }
 
     //! Get the serialized size of this payload in 64 bit words
-- 
cgit v1.2.3