zephyr/include/random.h
David B. Kinder ac74d8b652 license: Replace Apache boilerplate with SPDX tag
Replace the existing Apache 2.0 boilerplate header with an SPDX tag
throughout the zephyr code tree. This patch was generated via a
script run over the master branch.

Also updated doc/porting/application.rst that had a dependency on
line numbers in a literal include.

Manually updated subsys/logging/sys_log.c that had a malformed
header in the original file.  Also cleanup several cases that already
had a SPDX tag and we either got a duplicate or missed updating.

Jira: ZEP-1457

Change-Id: I6131a1d4ee0e58f5b938300c2d2fc77d2e69572c
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-01-19 03:50:58 +00:00

73 lines
1.3 KiB
C

/**
* @file random.h
*
* @brief Public APIs for the random driver.
*/
/*
* Copyright (c) 2016 ARM Ltd.
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef __RANDOM_H__
#define __RANDOM_H__
/**
* @brief Random Interface
* @defgroup random_interface Random Interface
* @ingroup io_interfaces
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#include <device.h>
/**
* @typedef random_get_entropy_t
* @brief Callback API to get entropy.
*
* See random_get_entropy() for argument description
*/
typedef int (*random_get_entropy_t)(struct device *dev,
uint8_t *buffer,
uint16_t length);
struct random_driver_api {
random_get_entropy_t get_entropy;
};
/**
* @brief Get entropy from the random driver.
*
* Fill a buffer with entropy from the random driver.
*
* @param dev Pointer to the random device.
* @param buffer Buffer to fill with entropy.
* @param length Buffer length.
* @retval 0 on success.
* @retval -ERRNO errno code on error.
*/
static inline int random_get_entropy(struct device *dev,
uint8_t *buffer,
uint16_t length)
{
const struct random_driver_api *api = dev->driver_api;
__ASSERT(api->get_entropy, "Callback pointer should not be NULL");
return api->get_entropy(dev, buffer, length);
}
#ifdef __cplusplus
}
#endif
/**
* @}
*/
#endif /* __RANDOM_H__ */