cc y / mbed

ads1115 only

Fork of mbed by mbed official

hal/trng_api.h@135:fce8a9387ed1, 2017-01-17 (annotated)

Committer:
kaoshen
Date:
Tue Jan 17 23:27:32 2017 +0000
Revision:
135:fce8a9387ed1
Parent:
128:9bcdf88f62b0 
333 ADS1115 ADC1

Who changed what in which revision?

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