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