Mateusz Kowalik / Application

USB Serial application

Fork of USBSerial_HelloWorld by Samuel Mokrani

mbed-dev/hal/trng_api.h@11:b3f2a8bdac4d, 2017-12-16 (annotated)

Committer:
Zaitsev
Date:
Sat Dec 16 10:26:48 2017 +0000
Revision:
11:b3f2a8bdac4d
Parent:
10:41552d038a69 
A copy for D.S;

Who changed what in which revision?

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