Campbell Scientific Australia / Mbed 2 deprecated mDot_Semtech_LoRaWAN_Stack

This code uses Semtech's open source LoRaWAN stack ported to mbed environment.

Dependencies:   mbed LoRaWAN-lib SX1272Lib

system/utilities.h@1:7da3f0db0d82, 2016-06-10 (annotated)

Committer:
Mehrad
Date:
Fri Jun 10 00:01:00 2016 +0000
Revision:
1:7da3f0db0d82
Parent:
0:6155544d38b1 
Initial commit

Who changed what in which revision?

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