Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

hal/trng_api.h@3:1198227e6421, 2016-12-16 (annotated)

Committer:
switches
Date:
Fri Dec 16 16:27:57 2016 +0000
Revision:
3:1198227e6421
Parent:
0:5c4d7b2438d3 
Changed ADC scale for MAX32625 platforms to 1.2V full scale to match MAX32630 platforms

Who changed what in which revision?

UserRevisionLine numberNew contents of line
switches 0:5c4d7b2438d3 1
switches 0:5c4d7b2438d3 2 /** \addtogroup hal */
switches 0:5c4d7b2438d3 3 /** @{*/
switches 0:5c4d7b2438d3 4 /* mbed Microcontroller Library
switches 0:5c4d7b2438d3 5 * Copyright (c) 2016 ARM Limited
switches 0:5c4d7b2438d3 6 *
switches 0:5c4d7b2438d3 7 * Licensed under the Apache License, Version 2.0 (the "License");
switches 0:5c4d7b2438d3 8 * you may not use this file except in compliance with the License.
switches 0:5c4d7b2438d3 9 * You may obtain a copy of the License at
switches 0:5c4d7b2438d3 10 *
switches 0:5c4d7b2438d3 11 * http://www.apache.org/licenses/LICENSE-2.0
switches 0:5c4d7b2438d3 12 *
switches 0:5c4d7b2438d3 13 * Unless required by applicable law or agreed to in writing, software
switches 0:5c4d7b2438d3 14 * distributed under the License is distributed on an "AS IS" BASIS,
switches 0:5c4d7b2438d3 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
switches 0:5c4d7b2438d3 16 * See the License for the specific language governing permissions and
switches 0:5c4d7b2438d3 17 * limitations under the License.
switches 0:5c4d7b2438d3 18 */
switches 0:5c4d7b2438d3 19 #ifndef MBED_TRNG_API_H
switches 0:5c4d7b2438d3 20 #define MBED_TRNG_API_H
switches 0:5c4d7b2438d3 21
switches 0:5c4d7b2438d3 22 #include <stddef.h>
switches 0:5c4d7b2438d3 23 #include "device.h"
switches 0:5c4d7b2438d3 24
switches 0:5c4d7b2438d3 25 #if DEVICE_TRNG
switches 0:5c4d7b2438d3 26
switches 0:5c4d7b2438d3 27 /** TRNG HAL structure. trng_s is declared in the target's HAL
switches 0:5c4d7b2438d3 28 */
switches 0:5c4d7b2438d3 29 typedef struct trng_s trng_t;
switches 0:5c4d7b2438d3 30
switches 0:5c4d7b2438d3 31 #ifdef __cplusplus
switches 0:5c4d7b2438d3 32 extern "C" {
switches 0:5c4d7b2438d3 33 #endif
switches 0:5c4d7b2438d3 34
switches 0:5c4d7b2438d3 35 /**
switches 0:5c4d7b2438d3 36 * \defgroup hal_trng TRNG hal functions
switches 0:5c4d7b2438d3 37 * @{
switches 0:5c4d7b2438d3 38 */
switches 0:5c4d7b2438d3 39
switches 0:5c4d7b2438d3 40 /** Initialize the TRNG peripheral
switches 0:5c4d7b2438d3 41 *
switches 0:5c4d7b2438d3 42 * @param obj The TRNG object
switches 0:5c4d7b2438d3 43 */
switches 0:5c4d7b2438d3 44 void trng_init(trng_t *obj);
switches 0:5c4d7b2438d3 45
switches 0:5c4d7b2438d3 46 /** Deinitialize the TRNG peripheral
switches 0:5c4d7b2438d3 47 *
switches 0:5c4d7b2438d3 48 * @param obj The TRNG object
switches 0:5c4d7b2438d3 49 */
switches 0:5c4d7b2438d3 50 void trng_free(trng_t *obj);
switches 0:5c4d7b2438d3 51
switches 0:5c4d7b2438d3 52 /** Get random data from TRNG peripheral
switches 0:5c4d7b2438d3 53 *
switches 0:5c4d7b2438d3 54 * @param obj The TRNG object
switches 0:5c4d7b2438d3 55 * @param output The pointer to an output array
switches 0:5c4d7b2438d3 56 * @param length The size of output data, to avoid buffer overwrite
switches 0:5c4d7b2438d3 57 * @param output_length The length of generated data
switches 0:5c4d7b2438d3 58 * @return 0 success, -1 fail
switches 0:5c4d7b2438d3 59 */
switches 0:5c4d7b2438d3 60 int trng_get_bytes(trng_t *obj, uint8_t *output, size_t length, size_t *output_length);
switches 0:5c4d7b2438d3 61
switches 0:5c4d7b2438d3 62 /**@}*/
switches 0:5c4d7b2438d3 63
switches 0:5c4d7b2438d3 64 #ifdef __cplusplus
switches 0:5c4d7b2438d3 65 }
switches 0:5c4d7b2438d3 66 #endif
switches 0:5c4d7b2438d3 67
switches 0:5c4d7b2438d3 68 #endif
switches 0:5c4d7b2438d3 69
switches 0:5c4d7b2438d3 70 #endif
switches 0:5c4d7b2438d3 71
switches 0:5c4d7b2438d3 72 /** @}*/