Improve consitency throughout library/common.h

Replace the contents of MBEDTLS_PUT_UINTx_yz contained inconsitent
but similar/duplicate code to the MBEDTLS_BYTE_x macros. Therefore
the contents of the macros now utilise the byte reading macros.

MBEDTLS_PUT_UINT64_LE's written order was also not consitent with
the other PUT macros, so that was modified.

Documentation comment said LSB instead of MSB and that has also been
resolved.

Signed-off-by: Joe Subbiani <joe.subbiani@arm.com>
This commit is contained in:
Joe Subbiani 2021-07-19 15:29:18 +01:00
parent c54e908656
commit 896f4eeaf7

View file

@ -84,12 +84,12 @@
* integer from. * integer from.
*/ */
#ifndef MBEDTLS_GET_UINT32_BE #ifndef MBEDTLS_GET_UINT32_BE
#define MBEDTLS_GET_UINT32_BE( data , offset ) \ #define MBEDTLS_GET_UINT32_BE( data , offset ) \
( \ ( \
( (uint32_t) ( data )[( offset ) ] << 24 ) \ ( (uint32_t) ( data )[( offset ) ] << 24 ) \
| ( (uint32_t) ( data )[( offset ) + 1] << 16 ) \ | ( (uint32_t) ( data )[( offset ) + 1] << 16 ) \
| ( (uint32_t) ( data )[( offset ) + 2] << 8 ) \ | ( (uint32_t) ( data )[( offset ) + 2] << 8 ) \
| ( (uint32_t) ( data )[( offset ) + 3] ) \ | ( (uint32_t) ( data )[( offset ) + 3] ) \
) )
#endif #endif
@ -103,13 +103,13 @@
* byte of the 32 bits unsigned integer \p n. * byte of the 32 bits unsigned integer \p n.
*/ */
#ifndef MBEDTLS_PUT_UINT32_BE #ifndef MBEDTLS_PUT_UINT32_BE
#define MBEDTLS_PUT_UINT32_BE( n, data, offset ) \ #define MBEDTLS_PUT_UINT32_BE( n, data, offset ) \
do { \ { \
( data )[( offset ) ] = (unsigned char) ( (n) >> 24 ); \ ( data )[( offset ) ] = MBEDTLS_BYTE_3( n ); \
( data )[( offset ) + 1] = (unsigned char) ( (n) >> 16 ); \ ( data )[( offset ) + 1] = MBEDTLS_BYTE_2( n ); \
( data )[( offset ) + 2] = (unsigned char) ( (n) >> 8 ); \ ( data )[( offset ) + 2] = MBEDTLS_BYTE_1( n ); \
( data )[( offset ) + 3] = (unsigned char) ( (n) ); \ ( data )[( offset ) + 3] = MBEDTLS_BYTE_0( n ); \
} while( 0 ) }
#endif #endif
/** /**
@ -122,12 +122,12 @@
* integer from. * integer from.
*/ */
#ifndef MBEDTLS_GET_UINT32_LE #ifndef MBEDTLS_GET_UINT32_LE
#define MBEDTLS_GET_UINT32_LE( data, offset ) \ #define MBEDTLS_GET_UINT32_LE( data, offset ) \
( \ ( \
( (uint32_t) ( data )[( offset ) ] ) \ ( (uint32_t) ( data )[( offset ) ] ) \
| ( (uint32_t) ( data )[( offset ) + 1] << 8 ) \ | ( (uint32_t) ( data )[( offset ) + 1] << 8 ) \
| ( (uint32_t) ( data )[( offset ) + 2] << 16 ) \ | ( (uint32_t) ( data )[( offset ) + 2] << 16 ) \
| ( (uint32_t) ( data )[( offset ) + 3] << 24 ) \ | ( (uint32_t) ( data )[( offset ) + 3] << 24 ) \
) )
#endif #endif
@ -141,13 +141,13 @@
* byte of the 32 bits unsigned integer \p n. * byte of the 32 bits unsigned integer \p n.
*/ */
#ifndef MBEDTLS_PUT_UINT32_LE #ifndef MBEDTLS_PUT_UINT32_LE
#define MBEDTLS_PUT_UINT32_LE( n, data, offset ) \ #define MBEDTLS_PUT_UINT32_LE( n, data, offset ) \
do { \ { \
( data )[( offset ) ] = (unsigned char) ( ( (n) ) & 0xFF ); \ ( data )[( offset ) ] = MBEDTLS_BYTE_0( n ); \
( data )[( offset ) + 1] = (unsigned char) ( ( (n) >> 8 ) & 0xFF ); \ ( data )[( offset ) + 1] = MBEDTLS_BYTE_1( n ); \
( data )[( offset ) + 2] = (unsigned char) ( ( (n) >> 16 ) & 0xFF ); \ ( data )[( offset ) + 2] = MBEDTLS_BYTE_2( n ); \
( data )[( offset ) + 3] = (unsigned char) ( ( (n) >> 24 ) & 0xFF ); \ ( data )[( offset ) + 3] = MBEDTLS_BYTE_3( n ); \
} while( 0 ) }
#endif #endif
/** /**
@ -160,10 +160,10 @@
* integer from. * integer from.
*/ */
#ifndef MBEDTLS_GET_UINT16_LE #ifndef MBEDTLS_GET_UINT16_LE
#define MBEDTLS_GET_UINT16_LE( data, offset ) \ #define MBEDTLS_GET_UINT16_LE( data, offset ) \
( \ ( \
( (uint16_t) ( data )[( offset ) ] ) \ ( (uint16_t) ( data )[( offset ) ] ) \
| ( (uint16_t) ( data )[( offset ) + 1] << 8 ) \ | ( (uint16_t) ( data )[( offset ) + 1] << 8 ) \
) )
#endif #endif
@ -177,16 +177,16 @@
* byte of the 16 bits unsigned integer \p n. * byte of the 16 bits unsigned integer \p n.
*/ */
#ifndef MBEDTLS_PUT_UINT16_LE #ifndef MBEDTLS_PUT_UINT16_LE
#define MBEDTLS_PUT_UINT16_LE( n, data, offset ) \ #define MBEDTLS_PUT_UINT16_LE( n, data, offset ) \
{ \ { \
( data )[( offset ) ] = (unsigned char) ( ( (n) ) & 0xFF ); \ ( data )[( offset ) ] = MBEDTLS_BYTE_0( n ); \
( data )[( offset ) + 1] = (unsigned char) ( ( (n) >> 8 ) & 0xFF ); \ ( data )[( offset ) + 1] = MBEDTLS_BYTE_1( n ); \
} }
#endif #endif
/** /**
* Get the unsigned 16 bits integer corresponding to two bytes in * Get the unsigned 16 bits integer corresponding to two bytes in
* big-endian order (LSB first). * big-endian order (MSB first).
* *
* \param data Base address of the memory to get the two bytes from. * \param data Base address of the memory to get the two bytes from.
* \param offset Offset from \p base of the first and most significant * \param offset Offset from \p base of the first and most significant
@ -194,10 +194,10 @@
* integer from. * integer from.
*/ */
#ifndef MBEDTLS_GET_UINT16_BE #ifndef MBEDTLS_GET_UINT16_BE
#define MBEDTLS_GET_UINT16_BE( data, offset ) \ #define MBEDTLS_GET_UINT16_BE( data, offset ) \
( \ ( \
( (uint16_t) ( data )[( offset ) ] << 8 ) \ ( (uint16_t) ( data )[( offset ) ] << 8 ) \
| ( (uint16_t) ( data )[( offset ) + 1] ) \ | ( (uint16_t) ( data )[( offset ) + 1] ) \
) )
#endif #endif
@ -211,10 +211,10 @@
* byte of the 16 bits unsigned integer \p n. * byte of the 16 bits unsigned integer \p n.
*/ */
#ifndef MBEDTLS_PUT_UINT16_BE #ifndef MBEDTLS_PUT_UINT16_BE
#define MBEDTLS_PUT_UINT16_BE( n, data, offset ) \ #define MBEDTLS_PUT_UINT16_BE( n, data, offset ) \
{ \ { \
( data )[( offset ) ] = (unsigned char) ( ( (n) >> 8 ) & 0xFF ); \ ( data )[( offset ) ] = MBEDTLS_BYTE_1( n ); \
( data )[( offset ) + 1] = (unsigned char) ( ( (n) ) & 0xFF ); \ ( data )[( offset ) + 1] = MBEDTLS_BYTE_0( n ); \
} }
#endif #endif
@ -228,16 +228,16 @@
* integer from. * integer from.
*/ */
#ifndef MBEDTLS_GET_UINT64_BE #ifndef MBEDTLS_GET_UINT64_BE
#define MBEDTLS_GET_UINT64_BE( data, offset ) \ #define MBEDTLS_GET_UINT64_BE( data, offset ) \
( \ ( \
( (uint64_t) ( data )[( offset ) ] << 56 ) \ ( (uint64_t) ( data )[( offset ) ] << 56 ) \
| ( (uint64_t) ( data )[( offset ) + 1] << 48 ) \ | ( (uint64_t) ( data )[( offset ) + 1] << 48 ) \
| ( (uint64_t) ( data )[( offset ) + 2] << 40 ) \ | ( (uint64_t) ( data )[( offset ) + 2] << 40 ) \
| ( (uint64_t) ( data )[( offset ) + 3] << 32 ) \ | ( (uint64_t) ( data )[( offset ) + 3] << 32 ) \
| ( (uint64_t) ( data )[( offset ) + 4] << 24 ) \ | ( (uint64_t) ( data )[( offset ) + 4] << 24 ) \
| ( (uint64_t) ( data )[( offset ) + 5] << 16 ) \ | ( (uint64_t) ( data )[( offset ) + 5] << 16 ) \
| ( (uint64_t) ( data )[( offset ) + 6] << 8 ) \ | ( (uint64_t) ( data )[( offset ) + 6] << 8 ) \
| ( (uint64_t) ( data )[( offset ) + 7] ) \ | ( (uint64_t) ( data )[( offset ) + 7] ) \
) )
#endif #endif
@ -251,16 +251,16 @@
* byte of the 64 bits unsigned integer \p n. * byte of the 64 bits unsigned integer \p n.
*/ */
#ifndef MBEDTLS_PUT_UINT64_BE #ifndef MBEDTLS_PUT_UINT64_BE
#define MBEDTLS_PUT_UINT64_BE( n, data, offset ) \ #define MBEDTLS_PUT_UINT64_BE( n, data, offset ) \
{ \ { \
( data )[( offset ) ] = (unsigned char) ( (n) >> 56 ); \ ( data )[( offset ) ] = MBEDTLS_BYTE_7( n ); \
( data )[( offset ) + 1] = (unsigned char) ( (n) >> 48 ); \ ( data )[( offset ) + 1] = MBEDTLS_BYTE_6( n ); \
( data )[( offset ) + 2] = (unsigned char) ( (n) >> 40 ); \ ( data )[( offset ) + 2] = MBEDTLS_BYTE_5( n ); \
( data )[( offset ) + 3] = (unsigned char) ( (n) >> 32 ); \ ( data )[( offset ) + 3] = MBEDTLS_BYTE_4( n ); \
( data )[( offset ) + 4] = (unsigned char) ( (n) >> 24 ); \ ( data )[( offset ) + 4] = MBEDTLS_BYTE_3( n ); \
( data )[( offset ) + 5] = (unsigned char) ( (n) >> 16 ); \ ( data )[( offset ) + 5] = MBEDTLS_BYTE_2( n ); \
( data )[( offset ) + 6] = (unsigned char) ( (n) >> 8 ); \ ( data )[( offset ) + 6] = MBEDTLS_BYTE_1( n ); \
( data )[( offset ) + 7] = (unsigned char) ( (n) ); \ ( data )[( offset ) + 7] = MBEDTLS_BYTE_0( n ); \
} }
#endif #endif
@ -274,16 +274,16 @@
* integer from. * integer from.
*/ */
#ifndef MBEDTLS_GET_UINT64_LE #ifndef MBEDTLS_GET_UINT64_LE
#define MBEDTLS_GET_UINT64_LE( data, offset ) \ #define MBEDTLS_GET_UINT64_LE( data, offset ) \
( \ ( \
( (uint64_t) ( data )[( offset ) + 7] << 56 ) \ ( (uint64_t) ( data )[( offset ) + 7] << 56 ) \
| ( (uint64_t) ( data )[( offset ) + 6] << 48 ) \ | ( (uint64_t) ( data )[( offset ) + 6] << 48 ) \
| ( (uint64_t) ( data )[( offset ) + 5] << 40 ) \ | ( (uint64_t) ( data )[( offset ) + 5] << 40 ) \
| ( (uint64_t) ( data )[( offset ) + 4] << 32 ) \ | ( (uint64_t) ( data )[( offset ) + 4] << 32 ) \
| ( (uint64_t) ( data )[( offset ) + 3] << 24 ) \ | ( (uint64_t) ( data )[( offset ) + 3] << 24 ) \
| ( (uint64_t) ( data )[( offset ) + 2] << 16 ) \ | ( (uint64_t) ( data )[( offset ) + 2] << 16 ) \
| ( (uint64_t) ( data )[( offset ) + 1] << 8 ) \ | ( (uint64_t) ( data )[( offset ) + 1] << 8 ) \
| ( (uint64_t) ( data )[( offset ) ] ) \ | ( (uint64_t) ( data )[( offset ) ] ) \
) )
#endif #endif
@ -297,16 +297,16 @@
* byte of the 64 bits unsigned integer \p n. * byte of the 64 bits unsigned integer \p n.
*/ */
#ifndef MBEDTLS_PUT_UINT64_LE #ifndef MBEDTLS_PUT_UINT64_LE
#define MBEDTLS_PUT_UINT64_LE( n, data, offset ) \ #define MBEDTLS_PUT_UINT64_LE( n, data, offset ) \
{ \ { \
( data )[( offset ) + 7] = (unsigned char) ( (n) >> 56 ); \ ( data )[( offset ) ] = MBEDTLS_BYTE_0( n ); \
( data )[( offset ) + 6] = (unsigned char) ( (n) >> 48 ); \ ( data )[( offset ) + 1] = MBEDTLS_BYTE_1( n ); \
( data )[( offset ) + 5] = (unsigned char) ( (n) >> 40 ); \ ( data )[( offset ) + 2] = MBEDTLS_BYTE_2( n ); \
( data )[( offset ) + 4] = (unsigned char) ( (n) >> 32 ); \ ( data )[( offset ) + 3] = MBEDTLS_BYTE_3( n ); \
( data )[( offset ) + 3] = (unsigned char) ( (n) >> 24 ); \ ( data )[( offset ) + 4] = MBEDTLS_BYTE_4( n ); \
( data )[( offset ) + 2] = (unsigned char) ( (n) >> 16 ); \ ( data )[( offset ) + 5] = MBEDTLS_BYTE_5( n ); \
( data )[( offset ) + 1] = (unsigned char) ( (n) >> 8 ); \ ( data )[( offset ) + 6] = MBEDTLS_BYTE_6( n ); \
( data )[( offset ) ] = (unsigned char) ( (n) ); \ ( data )[( offset ) + 7] = MBEDTLS_BYTE_7( n ); \
} }
#endif #endif