EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

hal/trng_api.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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