noselasd/libucore
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add Doxyfile, change docs

Browse Source
This commit is contained in:
Nils O. Selåsdal
2012-11-01 18:58:53 +01:00
parent cef7e3b057
commit 9aa6edf902
7 changed files with 1849 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ucore_pack.h
+32 -32
View File
@@ -17,8 +17,8 @@
/** Serialize a uint16_t to a byte array in little endian format.
* @v The value to serialize
* @r The byte array to place the integer in. Must be at least of size 2.
* @param v The value to serialize
* @param r The byte array to place the integer in. Must be at least of size 2.
*/
static UC_INLINE void uc_pack_16_le(uint16_t v, uint8_t *r)
{
@@ -27,8 +27,8 @@ static UC_INLINE void uc_pack_16_le(uint16_t v, uint8_t *r)
}
/** De-serialize a uint16_t from a byte array in little endian format.
* @r The byte array to containing the integer in. Must be at least of size 2.
* @return The deserialized integer from the byte array.
* @param r The byte array to containing the integer in. Must be at least of size 2.
* @param return The deserialized integer from the byte array.
*/
static UC_INLINE uint16_t uc_unpack_16_le(const uint8_t *r)
{
@@ -43,8 +43,8 @@ static UC_INLINE uint16_t uc_unpack_16_le(const uint8_t *r)
/** Serialize a uint32_t to a 3 byte(24 bits) array in little endian format.
* Only the bottom 24 bits of the uint32_t are used.
*
* @v The value to serialize
* @r The byte array to place the integer in. Must be at least of size 3.
* @param v The value to serialize
* @param r The byte array to place the integer in. Must be at least of size 3.
*/
static UC_INLINE void uc_pack_24_le(uint32_t v, uint8_t *r)
{
@@ -54,8 +54,8 @@ static UC_INLINE void uc_pack_24_le(uint32_t v, uint8_t *r)
}
/** De-serialize a uint32_t from a 3 byte (24 bit) byte array in little endian format.
* @r The byte array to containing the integer in. Must be at least of size 3.
* @return The deserialized integer from the byte array.
* @param r The byte array to containing the integer in. Must be at least of size 3.
* @param return The deserialized integer from the byte array.
*/
static UC_INLINE uint32_t uc_unpack_24_le(const uint8_t *r)
{
@@ -69,8 +69,8 @@ static UC_INLINE uint32_t uc_unpack_24_le(const uint8_t *r)
}
/** Serialize a uint32_t to a byte array in little endian format.
* @v The value to serialize
* @r The byte array to place the integer in. Must be at least of size 4.
* @param v The value to serialize
* @param r The byte array to place the integer in. Must be at least of size 4.
*/
static UC_INLINE void uc_pack_32_le(uint32_t v, uint8_t *r)
{
@@ -81,8 +81,8 @@ static UC_INLINE void uc_pack_32_le(uint32_t v, uint8_t *r)
}
/** De-serialize a uint32_t from a byte array in little endian format.
* @r The byte array to containing the integer in. Must be at least of size 4.
* @return The deserialized integer from the byte array.
* @param r The byte array to containing the integer in. Must be at least of size 4.
* @param return The deserialized integer from the byte array.
*/
static UC_INLINE uint32_t uc_unpack_32_le(const uint8_t *r)
{
@@ -97,8 +97,8 @@ static UC_INLINE uint32_t uc_unpack_32_le(const uint8_t *r)
}
/** Serialize a uint64_t to a byte array in little endian format.
* @v The value to serialize
* @r The byte array to place the integer in. Must be at least of size 8
* @param v The value to serialize
* @param r The byte array to place the integer in. Must be at least of size 8
*/
static UC_INLINE void uc_pack_64_le(uint64_t v, uint8_t *r)
{
@@ -113,8 +113,8 @@ static UC_INLINE void uc_pack_64_le(uint64_t v, uint8_t *r)
}
/** De-serialize a uint64_t from a byte array in little endian format.
* @r The byte array to containing the integer in. Must be at least of size 8.
* @return The deserialized integer from the byte array
* @param r The byte array to containing the integer in. Must be at least of size 8.
* @param return The deserialized integer from the byte array
*/
static UC_INLINE uint64_t uc_unpack_64_le(const uint8_t *r)
{
@@ -133,8 +133,8 @@ static UC_INLINE uint64_t uc_unpack_64_le(const uint8_t *r)
}
/** Serialize a uint16_t to a byte array in big endian format.
* @v The value to serialize
* @r The byte array to place the integer in. Must be at least of size 2.
* @param v The value to serialize
* @param r The byte array to place the integer in. Must be at least of size 2.
*/
static UC_INLINE void uc_pack_16_be(uint32_t v, uint8_t *r)
{
@@ -143,8 +143,8 @@ static UC_INLINE void uc_pack_16_be(uint32_t v, uint8_t *r)
}
/** De-serialize a uint16_t from a byte array in big endian format.
* @r The byte array to containing the integer in. Must be at least of size 2.
* @return The deserialized integer from the byte array
* @param r The byte array to containing the integer in. Must be at least of size 2.
* @param return The deserialized integer from the byte array
*/
static UC_INLINE uint16_t uc_unpack_16_be(const uint8_t *r)
{
@@ -159,8 +159,8 @@ static UC_INLINE uint16_t uc_unpack_16_be(const uint8_t *r)
/** Serialize a uint32_t to a 3 byte(24 bits) array in big endian format.
* Only the bottom 24 bits of the uint32_t are used.
*
* @v The value to serialize
* @r The byte array to place the integer in. Must be at least of size 3.
* @param v The value to serialize
* @param r The byte array to place the integer in. Must be at least of size 3.
*/
static UC_INLINE void uc_pack_24_be(uint32_t v, uint8_t *r)
{
@@ -170,8 +170,8 @@ static UC_INLINE void uc_pack_24_be(uint32_t v, uint8_t *r)
}
/** De-serialize a uint32_t from a 3 byte (24 bit) byte array in big endian format.
* @r The byte array to containing the integer in. Must be at least of size 3.
* @return The deserialized integer from the byte array.
* @param r The byte array to containing the integer in. Must be at least of size 3.
* @param return The deserialized integer from the byte array.
*/
static UC_INLINE uint32_t uc_unpack_24_be(const uint8_t *r)
{
@@ -185,8 +185,8 @@ static UC_INLINE uint32_t uc_unpack_24_be(const uint8_t *r)
}
/** Serialize a uint32_t to a byte array in big endian format.
* @v The value to serialize
* @r The byte array to place the integer in. Must be at least of size 4.
* @param v The value to serialize
* @param r The byte array to place the integer in. Must be at least of size 4.
*/
static UC_INLINE void uc_pack_32_be(uint32_t v, uint8_t *r)
{
@@ -197,8 +197,8 @@ static UC_INLINE void uc_pack_32_be(uint32_t v, uint8_t *r)
}
/** De-serialize a uint32_t from a byte array in big endian format.
* @r The byte array to containing the integer in. Must be at least of size 4.
* @return The deserialized integer from the byte array
* @param r The byte array to containing the integer in. Must be at least of size 4.
* @param return The deserialized integer from the byte array
*/
static UC_INLINE uint32_t uc_unpack_32_be(const uint8_t *r)
{
@@ -213,8 +213,8 @@ static UC_INLINE uint32_t uc_unpack_32_be(const uint8_t *r)
}
/** Serialize a uint16_t to a byte array in big endian format.
* @v The value to serialize
* @r The byte array to place the integer in. Must be at least of size 8
* @param v The value to serialize
* @param r The byte array to place the integer in. Must be at least of size 8
*/
static UC_INLINE void uc_pack_64_be(uint64_t v, uint8_t *r)
{
@@ -229,8 +229,8 @@ static UC_INLINE void uc_pack_64_be(uint64_t v, uint8_t *r)
}
/** De-serialize a uint64_t from a byte array in big endian format.
* @r The byte array to containing the integer in. Must be at least of size 4.
* @return The deserialized integer from the byte array
* @param r The byte array to containing the integer in. Must be at least of size 4.
* @param return The deserialized integer from the byte array
*/
static UC_INLINE uint64_t uc_unpack_64_be(const uint8_t *r)
{