Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/hal/trng_api.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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