Julio Merette / LoRaWAN-SX1276-MachineQ-FieldTest

1

Dependencies:   X_NUCLEO_IKS01A1 LoRaWAN-lib SX1276Lib mbed

system/utilities.h@0:42863a11464a, 2016-08-26 (annotated)

Committer:
ubhat
Date:
Fri Aug 26 19:36:35 2016 +0000
Revision:
0:42863a11464a
SX1276 Shield based Applications

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ubhat 0:42863a11464a 1 /*
ubhat 0:42863a11464a 2 / _____) _ | |
ubhat 0:42863a11464a 3 ( (____ _____ ____ _| |_ _____ ____| |__
ubhat 0:42863a11464a 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
ubhat 0:42863a11464a 5 _____) ) ____| | | || |_| ____( (___| | | |
ubhat 0:42863a11464a 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
ubhat 0:42863a11464a 7 (C)2013 Semtech
ubhat 0:42863a11464a 8
ubhat 0:42863a11464a 9 Description: Helper functions implementation
ubhat 0:42863a11464a 10
ubhat 0:42863a11464a 11 License: Revised BSD License, see LICENSE.TXT file include in the project
ubhat 0:42863a11464a 12
ubhat 0:42863a11464a 13 Maintainer: Miguel Luis and Gregory Cristian
ubhat 0:42863a11464a 14 */
ubhat 0:42863a11464a 15 #ifndef __UTILITIES_H__
ubhat 0:42863a11464a 16 #define __UTILITIES_H__
ubhat 0:42863a11464a 17
ubhat 0:42863a11464a 18 /*!
ubhat 0:42863a11464a 19 * \brief Returns the minimum value betwen a and b
ubhat 0:42863a11464a 20 *
ubhat 0:42863a11464a 21 * \param [IN] a 1st value
ubhat 0:42863a11464a 22 * \param [IN] b 2nd value
ubhat 0:42863a11464a 23 * \retval minValue Minimum value
ubhat 0:42863a11464a 24 */
ubhat 0:42863a11464a 25 #define MIN( a, b ) ( ( ( a ) < ( b ) ) ? ( a ) : ( b ) )
ubhat 0:42863a11464a 26
ubhat 0:42863a11464a 27 /*!
ubhat 0:42863a11464a 28 * \brief Returns the maximum value betwen a and b
ubhat 0:42863a11464a 29 *
ubhat 0:42863a11464a 30 * \param [IN] a 1st value
ubhat 0:42863a11464a 31 * \param [IN] b 2nd value
ubhat 0:42863a11464a 32 * \retval maxValue Maximum value
ubhat 0:42863a11464a 33 */
ubhat 0:42863a11464a 34 #define MAX( a, b ) ( ( ( a ) > ( b ) ) ? ( a ) : ( b ) )
ubhat 0:42863a11464a 35
ubhat 0:42863a11464a 36 /*!
ubhat 0:42863a11464a 37 * \brief Returns 2 raised to the power of n
ubhat 0:42863a11464a 38 *
ubhat 0:42863a11464a 39 * \param [IN] n power value
ubhat 0:42863a11464a 40 * \retval result of raising 2 to the power n
ubhat 0:42863a11464a 41 */
ubhat 0:42863a11464a 42 #define POW2( n ) ( 1 << n )
ubhat 0:42863a11464a 43
ubhat 0:42863a11464a 44 /*!
ubhat 0:42863a11464a 45 * \brief Initializes the pseudo ramdom generator initial value
ubhat 0:42863a11464a 46 *
ubhat 0:42863a11464a 47 * \param [IN] seed Pseudo ramdom generator initial value
ubhat 0:42863a11464a 48 */
ubhat 0:42863a11464a 49 void srand1( uint32_t seed );
ubhat 0:42863a11464a 50
ubhat 0:42863a11464a 51 /*!
ubhat 0:42863a11464a 52 * \brief Computes a random number between min and max
ubhat 0:42863a11464a 53 *
ubhat 0:42863a11464a 54 * \param [IN] min range minimum value
ubhat 0:42863a11464a 55 * \param [IN] max range maximum value
ubhat 0:42863a11464a 56 * \retval random random value in range min..max
ubhat 0:42863a11464a 57 */
ubhat 0:42863a11464a 58 int32_t randr( int32_t min, int32_t max );
ubhat 0:42863a11464a 59
ubhat 0:42863a11464a 60 /*!
ubhat 0:42863a11464a 61 * \brief Copies size elements of src array to dst array
ubhat 0:42863a11464a 62 *
ubhat 0:42863a11464a 63 * \remark STM32 Standard memcpy function only works on pointers that are aligned
ubhat 0:42863a11464a 64 *
ubhat 0:42863a11464a 65 * \param [OUT] dst Destination array
ubhat 0:42863a11464a 66 * \param [IN] src Source array
ubhat 0:42863a11464a 67 * \param [IN] size Number of bytes to be copied
ubhat 0:42863a11464a 68 */
ubhat 0:42863a11464a 69 void memcpy1( uint8_t *dst, const uint8_t *src, uint16_t size );
ubhat 0:42863a11464a 70
ubhat 0:42863a11464a 71 /*!
ubhat 0:42863a11464a 72 * \brief Copies size elements of src array to dst array reversing the byte order
ubhat 0:42863a11464a 73 *
ubhat 0:42863a11464a 74 * \param [OUT] dst Destination array
ubhat 0:42863a11464a 75 * \param [IN] src Source array
ubhat 0:42863a11464a 76 * \param [IN] size Number of bytes to be copied
ubhat 0:42863a11464a 77 */
ubhat 0:42863a11464a 78 void memcpyr( uint8_t *dst, const uint8_t *src, uint16_t size );
ubhat 0:42863a11464a 79
ubhat 0:42863a11464a 80 /*!
ubhat 0:42863a11464a 81 * \brief Set size elements of dst array with value
ubhat 0:42863a11464a 82 *
ubhat 0:42863a11464a 83 * \remark STM32 Standard memset function only works on pointers that are aligned
ubhat 0:42863a11464a 84 *
ubhat 0:42863a11464a 85 * \param [OUT] dst Destination array
ubhat 0:42863a11464a 86 * \param [IN] value Default value
ubhat 0:42863a11464a 87 * \param [IN] size Number of bytes to be copied
ubhat 0:42863a11464a 88 */
ubhat 0:42863a11464a 89 void memset1( uint8_t *dst, uint8_t value, uint16_t size );
ubhat 0:42863a11464a 90
ubhat 0:42863a11464a 91 /*!
ubhat 0:42863a11464a 92 * \brief Converts a nibble to an hexadecimal character
ubhat 0:42863a11464a 93 *
ubhat 0:42863a11464a 94 * \param [IN] a Nibble to be converted
ubhat 0:42863a11464a 95 * \retval hexChar Converted hexadecimal character
ubhat 0:42863a11464a 96 */
ubhat 0:42863a11464a 97 int8_t Nibble2HexChar( uint8_t a );
ubhat 0:42863a11464a 98
ubhat 0:42863a11464a 99 #endif // __UTILITIES_H__