Skip to contentSkip to conversation

random: Document add_hwgenerator_randomness() with other input functions

PATCH New Mark Brown 1 participant 1 message Jul 1, 2020 Random number driver

lore
Share & tools
lore

Mark Brown

author
#0 lore raw

PATCH 1/1 random: Document add_hwgenerator_randomness() with other input functions

The section at the top of random.c which documents the input functions available does not document add_hwgenerator_randomness() which might lead a reader to overlook it. Add a brief note about it.

---
 drivers/char/random.c | 8 ++++++++
 1 file changed, 8 insertions(+)
drivers/char/random.c +8 -0
index 2a41b21623ae..fc822842eb0e 100644
@@ -228,6 +228,14 @@
  * particular randomness source.  They do this by keeping track of the
  * first and second order deltas of the event timings.
  *
+ * There is also an interface for true hardware RNGs:
+ *
+ *	void add_hwgenerator_randomness(const char *buffer, size_t count,
+ *				size_t entropy);
+ *
+ * This will credit entropy as specified by the caller, if the entropy
+ * pool is full it will block until more entropy is needed.
+ *
  * Ensuring unpredictability at system startup
  * ============================================
  *
Signature · 1 line
2.20.1