Greg Steiert / maxim_dev

Dependents:   sensomed

hal/trng_api.h@0:0e018d759a2a, 2016-11-08 (annotated)

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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