BA / Mbed OS BaBoRo1

Erste version der Software für der Prototyp

mbed-os/hal/trng_api.h@4:75df35ef4fb6, 2018-03-30 (annotated)

Committer:
borlanic
Date:
Fri Mar 30 14:07:05 2018 +0000
Revision:
4:75df35ef4fb6
Parent:
0:380207fcb5c1 
commentar

Who changed what in which revision?

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