Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 440e4f6d authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

hw_random.txt: standardize document format 



Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:

- use proper markups for titles;
- adjust section identation;
- use proper markup for notes and fix it to properly show the
  numbered list.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent e45b082d

Documentation/hw_random.txt

+87 −72
Original line number Diff line number Diff line 
Introduction:

==========================================================

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,
@@ -18,7 +23,8 @@ Introduction: 
which is used internally and exported by the /dev/urandom and

/dev/random special files.



Theory of operation:

Theory of operation

===================



CHARACTER DEVICE.  Using the standard open()

and read() system calls, you can read random data from
@@ -44,12 +50,14 @@ Theory of operation: 


==========================================================================





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>

	- Copyright 2000,2001 Jeff Garzik <jgarzik@pobox.com>

	- Copyright 2000,2001 Philipp Rumpf <prumpf@mandrakesoft.com>





About the Intel RNG hardware, from the firmware hub datasheet:

About the Intel RNG hardware, from the firmware hub datasheet

=============================================================



The Firmware Hub integrates a Random Number Generator (RNG)

using thermal noise generated from inherently random quantum
@@ -59,27 +67,34 @@ About the Intel RNG hardware, from the firmware hub datasheet: 
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.



Intel RNG Driver notes:

Intel RNG Driver notes

======================



FIXME: support poll(2)



.. note::



	* FIXME: support poll(2)

	request_mem_region was removed, for three reasons:



	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,

	1) Only one RNG is supported by this driver;

	2) The location used by the RNG is a fixed location in

	   MMIO-addressable memory;

	3) users with properly working BIOS e820 handling will always

	   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

	   **not** in /proc/iomem, and request_mem_region(RNG_ADDR) can

	   succeed.



Driver details:

Driver details

==============



Based on:

	Intel 82802AB/82802AC Firmware Hub (FWH) Datasheet

	May 1999 Order Number: 290658-002 R



	Intel 82802 Firmware Hub: Random Number Generator

Intel 82802 Firmware Hub:

	Random Number Generator

	Programmer's Reference Manual

	December 1999 Order Number: 298029-001 R