Amit Gandhi / mbed-dev

test

Fork of mbed-dev by mbed official

targets/TARGET_Maxim/TARGET_MAX32625/mxc/prng.h@150:02e0a0aed4ec, 2016-11-08 (annotated)

Committer:
<>
Date:
Tue Nov 08 17:45:16 2016 +0000
Revision:
150:02e0a0aed4ec
This updates the lib to the mbed lib v129

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 150:02e0a0aed4ec 1 /*******************************************************************************
<> 150:02e0a0aed4ec 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
<> 150:02e0a0aed4ec 3 *
<> 150:02e0a0aed4ec 4 * Permission is hereby granted, free of charge, to any person obtaining a
<> 150:02e0a0aed4ec 5 * copy of this software and associated documentation files (the "Software"),
<> 150:02e0a0aed4ec 6 * to deal in the Software without restriction, including without limitation
<> 150:02e0a0aed4ec 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
<> 150:02e0a0aed4ec 8 * and/or sell copies of the Software, and to permit persons to whom the
<> 150:02e0a0aed4ec 9 * Software is furnished to do so, subject to the following conditions:
<> 150:02e0a0aed4ec 10 *
<> 150:02e0a0aed4ec 11 * The above copyright notice and this permission notice shall be included
<> 150:02e0a0aed4ec 12 * in all copies or substantial portions of the Software.
<> 150:02e0a0aed4ec 13 *
<> 150:02e0a0aed4ec 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
<> 150:02e0a0aed4ec 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
<> 150:02e0a0aed4ec 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
<> 150:02e0a0aed4ec 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
<> 150:02e0a0aed4ec 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
<> 150:02e0a0aed4ec 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
<> 150:02e0a0aed4ec 20 * OTHER DEALINGS IN THE SOFTWARE.
<> 150:02e0a0aed4ec 21 *
<> 150:02e0a0aed4ec 22 * Except as contained in this notice, the name of Maxim Integrated
<> 150:02e0a0aed4ec 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
<> 150:02e0a0aed4ec 24 * Products, Inc. Branding Policy.
<> 150:02e0a0aed4ec 25 *
<> 150:02e0a0aed4ec 26 * The mere transfer of this software does not imply any licenses
<> 150:02e0a0aed4ec 27 * of trade secrets, proprietary technology, copyrights, patents,
<> 150:02e0a0aed4ec 28 * trademarks, maskwork rights, or any other form of intellectual
<> 150:02e0a0aed4ec 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
<> 150:02e0a0aed4ec 30 * ownership rights.
<> 150:02e0a0aed4ec 31 *
<> 150:02e0a0aed4ec 32 * $Date: 2016-03-11 11:46:37 -0600 (Fri, 11 Mar 2016) $
<> 150:02e0a0aed4ec 33 * $Revision: 21839 $
<> 150:02e0a0aed4ec 34 *
<> 150:02e0a0aed4ec 35 ******************************************************************************/
<> 150:02e0a0aed4ec 36
<> 150:02e0a0aed4ec 37 /**
<> 150:02e0a0aed4ec 38 * @file prng.h
<> 150:02e0a0aed4ec 39 * @brief Pseudo-random number generator(PRNG) driver header file.
<> 150:02e0a0aed4ec 40 * @note The PRNG hardware does not produce true random numbers. The output
<> 150:02e0a0aed4ec 41 * should be used as a seed to an approved random-number algorithm, per
<> 150:02e0a0aed4ec 42 * a certifying authority such as NIST or PCI. The approved algorithm
<> 150:02e0a0aed4ec 43 * will output random numbers which are cerfitied for use in encryption
<> 150:02e0a0aed4ec 44 * and authentication algorithms.
<> 150:02e0a0aed4ec 45 */
<> 150:02e0a0aed4ec 46
<> 150:02e0a0aed4ec 47 #ifndef _PRNG_H_
<> 150:02e0a0aed4ec 48 #define _PRNG_H_
<> 150:02e0a0aed4ec 49
<> 150:02e0a0aed4ec 50 /***** Includes *****/
<> 150:02e0a0aed4ec 51 #include "prng_regs.h"
<> 150:02e0a0aed4ec 52
<> 150:02e0a0aed4ec 53 #ifdef __cplusplus
<> 150:02e0a0aed4ec 54 extern "C" {
<> 150:02e0a0aed4ec 55 #endif
<> 150:02e0a0aed4ec 56
<> 150:02e0a0aed4ec 57 /***** Definitions *****/
<> 150:02e0a0aed4ec 58
<> 150:02e0a0aed4ec 59 /***** Globals *****/
<> 150:02e0a0aed4ec 60
<> 150:02e0a0aed4ec 61 /***** Function Prototypes *****/
<> 150:02e0a0aed4ec 62
<> 150:02e0a0aed4ec 63 /**
<> 150:02e0a0aed4ec 64 * @brief Initialize required clocks and enable PRNG module
<> 150:02e0a0aed4ec 65 * @note Function will set divisors to /1 if they are found disabled.
<> 150:02e0a0aed4ec 66 * Otherwise, it will not change the divisor.
<> 150:02e0a0aed4ec 67 */
<> 150:02e0a0aed4ec 68 void PRNG_Init(void);
<> 150:02e0a0aed4ec 69
<> 150:02e0a0aed4ec 70 /**
<> 150:02e0a0aed4ec 71 * @brief Returns ready bit to indicates that the PRNG_GetSeed can be called without
<> 150:02e0a0aed4ec 72 * being held off. Only needs to be called after POR.
<> 150:02e0a0aed4ec 73 *
<> 150:02e0a0aed4ec 74 * @return 0 - PRNG not ready, non-zero = PRNG ready to read
<> 150:02e0a0aed4ec 75 */
<> 150:02e0a0aed4ec 76 __STATIC_INLINE uint16_t PRNG_Ready(void)
<> 150:02e0a0aed4ec 77 {
<> 150:02e0a0aed4ec 78 return (MXC_PRNG->user_entropy & MXC_F_PRNG_USER_ENTROPY_RND_NUM_READY);
<> 150:02e0a0aed4ec 79 }
<> 150:02e0a0aed4ec 80
<> 150:02e0a0aed4ec 81 /**
<> 150:02e0a0aed4ec 82 * @brief Retrieve a seed value from the PRNG
<> 150:02e0a0aed4ec 83 * @note The PRNG hardware does not produce true random numbers. The output
<> 150:02e0a0aed4ec 84 * should be used as a seed to an approved random-number algorithm, per
<> 150:02e0a0aed4ec 85 * a certifying authority such as NIST or PCI. The approved algorithm
<> 150:02e0a0aed4ec 86 * will output random numbers which are cerfitied for use in encryption
<> 150:02e0a0aed4ec 87 * and authentication algorithms.
<> 150:02e0a0aed4ec 88 *
<> 150:02e0a0aed4ec 89 * @return This function returns a 16-bit seed value
<> 150:02e0a0aed4ec 90 */
<> 150:02e0a0aed4ec 91 __STATIC_INLINE uint16_t PRNG_GetSeed(void)
<> 150:02e0a0aed4ec 92 {
<> 150:02e0a0aed4ec 93 return MXC_PRNG->rnd_num;
<> 150:02e0a0aed4ec 94 }
<> 150:02e0a0aed4ec 95
<> 150:02e0a0aed4ec 96 /**
<> 150:02e0a0aed4ec 97 * @brief Add user entropy to the PRNG entropy source
<> 150:02e0a0aed4ec 98 *
<> 150:02e0a0aed4ec 99 * @param entropy This value will be mixed into the PRNG entropy source
<> 150:02e0a0aed4ec 100 */
<> 150:02e0a0aed4ec 101 __STATIC_INLINE void PRNG_AddUserEntropy(uint8_t entropy)
<> 150:02e0a0aed4ec 102 {
<> 150:02e0a0aed4ec 103 MXC_PRNG->user_entropy = (uint32_t)entropy;
<> 150:02e0a0aed4ec 104 }
<> 150:02e0a0aed4ec 105
<> 150:02e0a0aed4ec 106 #ifdef __cplusplus
<> 150:02e0a0aed4ec 107 }
<> 150:02e0a0aed4ec 108 #endif
<> 150:02e0a0aed4ec 109
<> 150:02e0a0aed4ec 110 #endif /* _PRNG_H_ */