Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

hal/trng_api.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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