mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/hal/trng_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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