Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

hal/trng_api.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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