Gan likun / mbed-dev11

hal/trng_api.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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