redonkable
/
remarkable-linux
1
0
Fork 0
Code Releases Activity

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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
zero-colors
Mauro Carvalho Chehab 2017-05-14 13:59:18 -03:00 committed by Jonathan Corbet
parent e45b082d46
commit 440e4f6d29
1 changed files with 78 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
Documentation/hw_random.txt
View File

@ -1,4 +1,9 @@
Introduction: ==========================================================
Linux support for random number generator in i8xx chipsets
==========================================================
Introduction
============
The hw_random framework is software that makes use of a The hw_random framework is software that makes use of a
special hardware feature on your CPU or motherboard, special hardware feature on your CPU or motherboard,
@ -18,7 +23,8 @@ Introduction:
which is used internally and exported by the /dev/urandom and which is used internally and exported by the /dev/urandom and
/dev/random special files. /dev/random special files.
Theory of operation: Theory of operation
===================
CHARACTER DEVICE. Using the standard open() CHARACTER DEVICE. Using the standard open()
and read() system calls, you can read random data from 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) Hardware driver for Intel/AMD/VIA Random Number Generators (RNG)
Copyright 2000,2001 Jeff Garzik <jgarzik@pobox.com> - Copyright 2000,2001 Jeff Garzik <jgarzik@pobox.com>
Copyright 2000,2001 Philipp Rumpf <prumpf@mandrakesoft.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) The Firmware Hub integrates a Random Number Generator (RNG)
using thermal noise generated from inherently random quantum 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, 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. 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) FIXME: support poll(2)
NOTE: request_mem_region was removed, for three reasons: .. note::
1) Only one RNG is supported by this driver, 2) The location
used by the RNG is a fixed location in MMIO-addressable memory, 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;
3) users with properly working BIOS e820 handling will always 3) users with properly working BIOS e820 handling will always
have the region in which the RNG is located reserved, so have the region in which the RNG is located reserved, so
request_mem_region calls always fail for proper setups. request_mem_region calls always fail for proper setups.
However, for people who use mem=XX, BIOS e820 information is 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. succeed.
Driver details: Driver details
==============
Based on: Based on:
Intel 82802AB/82802AC Firmware Hub (FWH) Datasheet Intel 82802AB/82802AC Firmware Hub (FWH) Datasheet
May 1999 Order Number: 290658-002 R 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 Programmer's Reference Manual
December 1999 Order Number: 298029-001 R December 1999 Order Number: 298029-001 R