Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

hal/trng_api.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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