mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/trng_api.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
128:9bcdf88f62b0 
mbed library release version 165

Who changed what in which revision?

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