Merge pull request #5800 from miri64/at86rf2xx/doc/get_random_operation

at86rf2xx: document operation mode concerns for
This commit is contained in:
Oleg Hahm 2016-09-02 23:41:48 +02:00 committed by GitHub
commit 3e05a90d41

View File

@ -163,10 +163,18 @@ void at86rf2xx_hardware_reset(at86rf2xx_t *dev);
*/
void at86rf2xx_configure_phy(at86rf2xx_t *dev);
#if defined MODULE_AT86RF233 || defined MODULE_AT86RF231
#if defined(MODULE_AT86RF233) || defined(MODULE_AT86RF231) || defined(DOXYGEN)
/**
* @brief Read random data from the RNG
*
* @note According to the data sheet this function only works properly in
* Basic Operation Mode. However, sporadic testing has shown that even
* in Extended Operation Mode this returns random enough data to be
* used as a seed for @ref sys_random if no cryptographically secure
* randomness is required.
* Any further use-case needs to be evaluated, especially if
* crypto-relevant randomness is required.
*
* @param[in] dev device to configure
* @param[out] data buffer to copy the random data to
* @param[in] len number of random bytes to store in data