Commit bd7f01a1 authored by schneider's avatar schneider
Browse files

fix(trng): Clarify documentation with a warning

parent c635986c
......@@ -1935,6 +1935,13 @@ API_ISR(EPIC_INT_RTC_ALARM, epic_isr_rtc_alarm);
* Use :c:func:`epic_csprng_read` for cryptographically safe random
* numbers instead.
*
* .. warning::
*
* The exact behaviour of the TRNG is not well understood. Its
* distribution and other parameters are unknown. Only use this
* function if you really want the unmodified values from the
* hardware TRNG to experiment with it.
*
* :param uint8_t * dest: Destination buffer
* :param size: Number of bytes to read.
* :return: `0` on success or a negative value if an error occured. Possible
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment