Blame view

Documentation/hw_random.txt 3.75 KB
440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
  ==========================================================
  Linux support for random number generator in i8xx chipsets
  ==========================================================
  
  Introduction
  ============
  
  The hw_random framework is software that makes use of a
  special hardware feature on your CPU or motherboard,
  a Random Number Generator (RNG).  The software has two parts:
  a core providing the /dev/hwrng character device and its
  sysfs support, plus a hardware-specific driver that plugs
  into that core.
  
  To make the most effective use of these mechanisms, you
  should download the support software as well.  Download the
  latest version of the "rng-tools" package from the
  hw_random driver's official Web site:
  
  	http://sourceforge.net/projects/gkernel/
  
  Those tools use /dev/hwrng to fill the kernel entropy pool,
  which is used internally and exported by the /dev/urandom and
  /dev/random special files.
  
  Theory of operation
  ===================
  
  CHARACTER DEVICE.  Using the standard open()
  and read() system calls, you can read random data from
  the hardware RNG device.  This data is NOT CHECKED by any
  fitness tests, and could potentially be bogus (if the
  hardware is faulty or has been tampered with).  Data is only
  output if the hardware "has-data" flag is set, but nevertheless
  a security-conscious person would run fitness tests on the
  data before assuming it is truly random.
  
  The rng-tools package uses such tests in "rngd", and lets you
  run them by hand with a "rngtest" utility.
  
  /dev/hwrng is char device major 10, minor 183.
  
  CLASS DEVICE.  There is a /sys/class/misc/hw_random node with
  two unique attributes, "rng_available" and "rng_current".  The
  "rng_available" attribute lists the hardware-specific drivers
  available, while "rng_current" lists the one which is currently
  connected to /dev/hwrng.  If your system has more than one
  RNG available, you may change the one used by writing a name from
  the list in "rng_available" into "rng_current".
537878d2c   David Brownell   hw_random doc upd...
50
51
  
  ==========================================================================
537878d2c   David Brownell   hw_random doc upd...
52

440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
53
54
55
  Hardware driver for Intel/AMD/VIA Random Number Generators (RNG)
  	- Copyright 2000,2001 Jeff Garzik <jgarzik@pobox.com>
  	- Copyright 2000,2001 Philipp Rumpf <prumpf@mandrakesoft.com>
537878d2c   David Brownell   hw_random doc upd...
56

537878d2c   David Brownell   hw_random doc upd...
57

440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
58
59
  About the Intel RNG hardware, from the firmware hub datasheet
  =============================================================
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
60

440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
61
62
63
64
65
66
67
  The Firmware Hub integrates a Random Number Generator (RNG)
  using thermal noise generated from inherently random quantum
  mechanical properties of silicon. When not generating new random
  bits the RNG circuitry will enter a low power state. Intel will
  provide a binary software driver to give third party software
  access to our RNG for use as a security feature. At this time,
  the RNG is only to be used with a system in an OS-present state.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
68

440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
69
70
  Intel RNG Driver notes
  ======================
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
71

440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
72
73
74
75
76
77
78
79
80
  FIXME: support poll(2)
  
  .. note::
  
  	request_mem_region was removed, for three reasons:
  
  	1) Only one RNG is supported by this driver;
  	2) The location used by the RNG is a fixed location in
  	   MMIO-addressable memory;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
81
  	3) users with properly working BIOS e820 handling will always
440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
82
83
84
85
86
  	   have the region in which the RNG is located reserved, so
  	   request_mem_region calls always fail for proper setups.
  	   However, for people who use mem=XX, BIOS e820 information is
  	   **not** in /proc/iomem, and request_mem_region(RNG_ADDR) can
  	   succeed.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
87

440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
88
89
  Driver details
  ==============
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
90

440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
91
  Based on:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
92
  	Intel 82802AB/82802AC Firmware Hub (FWH) Datasheet
440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
93
  	May 1999 Order Number: 290658-002 R
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
94

440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
95
96
  Intel 82802 Firmware Hub:
  	Random Number Generator
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
97
  	Programmer's Reference Manual
440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
98
  	December 1999 Order Number: 298029-001 R
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
99

440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
100
  Intel 82802 Firmware HUB Random Number Generator Driver
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
101
  	Copyright (c) 2000 Matt Sottek <msottek@quiknet.com>
440e4f6d2   Mauro Carvalho Chehab   hw_random.txt: st...
102
103
  Special thanks to Matt Sottek.  I did the "guts", he
  did the "brains" and all the testing.