BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/hal/trng_api.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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