Diff: Utilities/utilities.h

Revision:

32:2d0678039a09

Parent:

5:53302861bfea

--- a/Utilities/utilities.h	Mon Dec 10 19:54:23 2018 +0000
+++ b/Utilities/utilities.h	Thu Jan 24 21:57:23 2019 +0000
@@ -114,8 +114,8 @@
 
 /*!
  * \brief  Find First Set
- *         This function identifies the least significant index or position of the
- *         bits set to one in the word
+ *         This function identifies the least significant index or position of
+ *         the bits set to one in the word
  *
  * \param [in]  value  Value to find least significant index
  * \retval bitIndex    Index of least significat bit at one
@@ -144,7 +144,8 @@
 /*!
  * \brief Copies size elements of src array to dst array
  *
- * \remark STM32 Standard memcpy function only works on pointers that are aligned
+ * \remark STM32 Standard memcpy function only works on pointers that are
+ *         aligned
  *
  * \param [OUT] dst  Destination array
  * \param [IN]  src  Source array
@@ -153,7 +154,8 @@
 void memcpy1( uint8_t *dst, const uint8_t *src, uint16_t size );
 
 /*!
- * \brief Copies size elements of src array to dst array reversing the byte order
+ * \brief Copies size elements of src array to dst array reversing the byte
+ *        order
  *
  * \param [OUT] dst  Destination array
  * \param [IN]  src  Source array
@@ -164,7 +166,8 @@
 /*!
  * \brief Set size elements of dst array with value
  *
- * \remark STM32 Standard memset function only works on pointers that are aligned
+ * \remark STM32 Standard memset function only works on pointers that are
+ *         aligned
  *
  * \param [OUT] dst   Destination array
  * \param [IN]  value Default value
@@ -180,7 +183,19 @@
  */
 int8_t Nibble2HexChar( uint8_t a );
 
-uint8_t stringHexToByteArray(const char *hexString, uint8_t *buffer, int8_t bufSize);
+/*!
+ * \brief Converts an array of character hex digits
+ *        into an array of byte-hex
+ *
+ * \param [IN]  hexString Hex string to be converted
+ *        [IN]  buffer    Container to save the conversion
+ *        [IN]  bufSize   Size of the container
+ *
+ * \retval [OUT] uint8_t  Size of the buffer after conversion
+ *
+ * \note   It is assumed that the bufSize won't be larger than 256
+ */
+uint8_t stringHexToByteArray(const char *hexString, uint8_t *buffer, uint8_t bufSize);
 
 #endif // __UTILITIES_H__