Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

hal/trng_api.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
mbed-os5 only for TYBLE16

Who changed what in which revision?

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