Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/hal/trng_api.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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