mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_K66F/TOOLCHAIN_IAR/fsl_rnga.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 143:86740a56073b 1 /*
AnnaBridge 143:86740a56073b 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 143:86740a56073b 3 * Copyright 2016-2017 NXP
AnnaBridge 143:86740a56073b 4 *
AnnaBridge 143:86740a56073b 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 143:86740a56073b 6 * are permitted provided that the following conditions are met:
AnnaBridge 143:86740a56073b 7 *
AnnaBridge 143:86740a56073b 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 143:86740a56073b 9 * of conditions and the following disclaimer.
AnnaBridge 143:86740a56073b 10 *
AnnaBridge 143:86740a56073b 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 143:86740a56073b 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 143:86740a56073b 13 * other materials provided with the distribution.
AnnaBridge 143:86740a56073b 14 *
AnnaBridge 143:86740a56073b 15 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 143:86740a56073b 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 143:86740a56073b 17 * software without specific prior written permission.
AnnaBridge 143:86740a56073b 18 *
AnnaBridge 143:86740a56073b 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 143:86740a56073b 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 143:86740a56073b 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 143:86740a56073b 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 143:86740a56073b 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 143:86740a56073b 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 143:86740a56073b 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 143:86740a56073b 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 143:86740a56073b 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 143:86740a56073b 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 143:86740a56073b 29 */
AnnaBridge 143:86740a56073b 30 #ifndef _FSL_RNGA_DRIVER_H_
AnnaBridge 143:86740a56073b 31 #define _FSL_RNGA_DRIVER_H_
AnnaBridge 143:86740a56073b 32
AnnaBridge 143:86740a56073b 33 #include "fsl_common.h"
AnnaBridge 143:86740a56073b 34
AnnaBridge 143:86740a56073b 35 #if defined(FSL_FEATURE_SOC_RNG_COUNT) && FSL_FEATURE_SOC_RNG_COUNT
AnnaBridge 143:86740a56073b 36 /*!
AnnaBridge 143:86740a56073b 37 * @addtogroup rnga
AnnaBridge 143:86740a56073b 38 * @{
AnnaBridge 143:86740a56073b 39 */
AnnaBridge 143:86740a56073b 40
AnnaBridge 143:86740a56073b 41
AnnaBridge 143:86740a56073b 42 /*******************************************************************************
AnnaBridge 143:86740a56073b 43 * Definitions
AnnaBridge 143:86740a56073b 44 *******************************************************************************/
AnnaBridge 143:86740a56073b 45
AnnaBridge 143:86740a56073b 46 /*! @name Driver version */
AnnaBridge 143:86740a56073b 47 /*@{*/
AnnaBridge 143:86740a56073b 48 /*! @brief RNGA driver version 2.0.1. */
AnnaBridge 143:86740a56073b 49 #define FSL_RNGA_DRIVER_VERSION (MAKE_VERSION(2, 0, 1))
AnnaBridge 143:86740a56073b 50 /*@}*/
AnnaBridge 143:86740a56073b 51
AnnaBridge 143:86740a56073b 52 /*! @brief RNGA working mode */
AnnaBridge 143:86740a56073b 53 typedef enum _rnga_mode
AnnaBridge 143:86740a56073b 54 {
AnnaBridge 143:86740a56073b 55 kRNGA_ModeNormal = 0U, /*!< Normal Mode. The ring-oscillator clocks are active; RNGA generates entropy
AnnaBridge 143:86740a56073b 56 (randomness) from the clocks and stores it in shift registers.*/
AnnaBridge 143:86740a56073b 57 kRNGA_ModeSleep = 1U, /*!< Sleep Mode. The ring-oscillator clocks are inactive; RNGA does not generate entropy.*/
AnnaBridge 143:86740a56073b 58 } rnga_mode_t;
AnnaBridge 143:86740a56073b 59
AnnaBridge 143:86740a56073b 60 /*******************************************************************************
AnnaBridge 143:86740a56073b 61 * API
AnnaBridge 143:86740a56073b 62 *******************************************************************************/
AnnaBridge 143:86740a56073b 63
AnnaBridge 143:86740a56073b 64 #if defined(__cplusplus)
AnnaBridge 143:86740a56073b 65 extern "C" {
AnnaBridge 143:86740a56073b 66 #endif
AnnaBridge 143:86740a56073b 67
AnnaBridge 143:86740a56073b 68 /*!
AnnaBridge 143:86740a56073b 69 * @brief Initializes the RNGA.
AnnaBridge 143:86740a56073b 70 *
AnnaBridge 143:86740a56073b 71 * This function initializes the RNGA.
AnnaBridge 143:86740a56073b 72 * When called, the RNGA entropy generation starts immediately.
AnnaBridge 143:86740a56073b 73 *
AnnaBridge 143:86740a56073b 74 * @param base RNGA base address
AnnaBridge 143:86740a56073b 75 */
AnnaBridge 143:86740a56073b 76 void RNGA_Init(RNG_Type *base);
AnnaBridge 143:86740a56073b 77
AnnaBridge 143:86740a56073b 78 /*!
AnnaBridge 143:86740a56073b 79 * @brief Shuts down the RNGA.
AnnaBridge 143:86740a56073b 80 *
AnnaBridge 143:86740a56073b 81 * This function shuts down the RNGA.
AnnaBridge 143:86740a56073b 82 *
AnnaBridge 143:86740a56073b 83 * @param base RNGA base address
AnnaBridge 143:86740a56073b 84 */
AnnaBridge 143:86740a56073b 85 void RNGA_Deinit(RNG_Type *base);
AnnaBridge 143:86740a56073b 86
AnnaBridge 143:86740a56073b 87 /*!
AnnaBridge 143:86740a56073b 88 * @brief Gets random data.
AnnaBridge 143:86740a56073b 89 *
AnnaBridge 143:86740a56073b 90 * This function gets random data from the RNGA.
AnnaBridge 143:86740a56073b 91 *
AnnaBridge 143:86740a56073b 92 * @param base RNGA base address
AnnaBridge 143:86740a56073b 93 * @param data pointer to user buffer to be filled by random data
AnnaBridge 143:86740a56073b 94 * @param data_size size of data in bytes
AnnaBridge 143:86740a56073b 95 * @return RNGA status
AnnaBridge 143:86740a56073b 96 */
AnnaBridge 143:86740a56073b 97 status_t RNGA_GetRandomData(RNG_Type *base, void *data, size_t data_size);
AnnaBridge 143:86740a56073b 98
AnnaBridge 143:86740a56073b 99 /*!
AnnaBridge 143:86740a56073b 100 * @brief Feeds the RNGA module.
AnnaBridge 143:86740a56073b 101 *
AnnaBridge 143:86740a56073b 102 * This function inputs an entropy value that the RNGA uses to seed its
AnnaBridge 143:86740a56073b 103 * pseudo-random algorithm.
AnnaBridge 143:86740a56073b 104 *
AnnaBridge 143:86740a56073b 105 * @param base RNGA base address
AnnaBridge 143:86740a56073b 106 * @param seed input seed value
AnnaBridge 143:86740a56073b 107 */
AnnaBridge 143:86740a56073b 108 void RNGA_Seed(RNG_Type *base, uint32_t seed);
AnnaBridge 143:86740a56073b 109
AnnaBridge 143:86740a56073b 110 /*!
AnnaBridge 143:86740a56073b 111 * @brief Sets the RNGA in normal mode or sleep mode.
AnnaBridge 143:86740a56073b 112 *
AnnaBridge 143:86740a56073b 113 * This function sets the RNGA in sleep mode or normal mode.
AnnaBridge 143:86740a56073b 114 *
AnnaBridge 143:86740a56073b 115 * @param base RNGA base address
AnnaBridge 143:86740a56073b 116 * @param mode normal mode or sleep mode
AnnaBridge 143:86740a56073b 117 */
AnnaBridge 143:86740a56073b 118 void RNGA_SetMode(RNG_Type *base, rnga_mode_t mode);
AnnaBridge 143:86740a56073b 119
AnnaBridge 143:86740a56073b 120 /*!
AnnaBridge 143:86740a56073b 121 * @brief Gets the RNGA working mode.
AnnaBridge 143:86740a56073b 122 *
AnnaBridge 143:86740a56073b 123 * This function gets the RNGA working mode.
AnnaBridge 143:86740a56073b 124 *
AnnaBridge 143:86740a56073b 125 * @param base RNGA base address
AnnaBridge 143:86740a56073b 126 * @return normal mode or sleep mode
AnnaBridge 143:86740a56073b 127 */
AnnaBridge 143:86740a56073b 128 rnga_mode_t RNGA_GetMode(RNG_Type *base);
AnnaBridge 143:86740a56073b 129
AnnaBridge 143:86740a56073b 130 #if defined(__cplusplus)
AnnaBridge 143:86740a56073b 131 }
AnnaBridge 143:86740a56073b 132 #endif
AnnaBridge 143:86740a56073b 133
AnnaBridge 143:86740a56073b 134 /*! @}*/
AnnaBridge 143:86740a56073b 135
AnnaBridge 143:86740a56073b 136 #endif /* FSL_FEATURE_SOC_RNG_COUNT */
AnnaBridge 143:86740a56073b 137 #endif /* _FSL_RNGA_H_*/