nvme: Add tertiary number to NVME_VS
[linux-2.6-block.git] / include / linux / hw_random.h
CommitLineData
844dd05f
MB
1/*
2 Hardware Random Number Generator
3
4 Please read Documentation/hw_random.txt for details on use.
5
6 ----------------------------------------------------------
7 This software may be used and distributed according to the terms
8 of the GNU General Public License, incorporated herein by reference.
9
10 */
11
12#ifndef LINUX_HWRANDOM_H_
13#define LINUX_HWRANDOM_H_
844dd05f 14
77584ee5 15#include <linux/completion.h>
844dd05f
MB
16#include <linux/types.h>
17#include <linux/list.h>
3a2c0ba5 18#include <linux/kref.h>
844dd05f
MB
19
20/**
21 * struct hwrng - Hardware Random Number Generator driver
22 * @name: Unique RNG name.
23 * @init: Initialization callback (can be NULL).
24 * @cleanup: Cleanup callback (can be NULL).
25 * @data_present: Callback to determine if data is available
26 * on the RNG. If NULL, it is assumed that
9996508b 27 * there is always data available. *OBSOLETE*
844dd05f
MB
28 * @data_read: Read data from the RNG device.
29 * Returns the number of lower random bytes in "data".
988acec9 30 * Must not be NULL. *OBSOLETE*
9996508b
IM
31 * @read: New API. drivers can fill up to max bytes of data
32 * into the buffer. The buffer is aligned for any type.
844dd05f 33 * @priv: Private data, for use by the RNG driver.
0f734e6e
TD
34 * @quality: Estimation of true entropy in RNG's bitstream
35 * (per mill).
844dd05f
MB
36 */
37struct hwrng {
38 const char *name;
39 int (*init)(struct hwrng *rng);
40 void (*cleanup)(struct hwrng *rng);
984e976f 41 int (*data_present)(struct hwrng *rng, int wait);
844dd05f 42 int (*data_read)(struct hwrng *rng, u32 *data);
9996508b 43 int (*read)(struct hwrng *rng, void *data, size_t max, bool wait);
844dd05f 44 unsigned long priv;
0f734e6e 45 unsigned short quality;
844dd05f
MB
46
47 /* internal. */
48 struct list_head list;
3a2c0ba5 49 struct kref ref;
77584ee5 50 struct completion cleanup_done;
844dd05f
MB
51};
52
4d9b519c
DT
53struct device;
54
844dd05f
MB
55/** Register a new Hardware Random Number Generator driver. */
56extern int hwrng_register(struct hwrng *rng);
4d9b519c 57extern int devm_hwrng_register(struct device *dev, struct hwrng *rng);
844dd05f 58/** Unregister a Hardware Random Number Generator driver. */
b844eba2 59extern void hwrng_unregister(struct hwrng *rng);
4d9b519c 60extern void devm_hwrng_unregister(struct device *dve, struct hwrng *rng);
c84dbf61
TD
61/** Feed random bits into the pool. */
62extern void add_hwgenerator_randomness(const char *buffer, size_t count, size_t entropy);
844dd05f 63
844dd05f 64#endif /* LINUX_HWRANDOM_H_ */