Gan likun / The prosthetic control

The prosthetic control（MIT）

hal/trng_api.h@0:20e0c61e0684, 2022-06-23 (annotated)

Committer:
ganlikun
Date:
Thu Jun 23 05:23:34 2022 +0000
Revision:
0:20e0c61e0684
01

Who changed what in which revision?

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