linux.git/Documentation/arm/Booting, branch master

docs: arm: convert docs to ReST and rename to *.rst

2019-07-15T12:20:24+00:00

Converts ARM the text files to ReST, preparing them to be an
architecture book.

The conversion is actually:
  - add blank lines and identation in order to identify paragraphs;
  - fix tables markups;
  - add some lists markups;
  - mark literal blocks;
  - adjust title markups.

At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.

Signed-off-by: Mauro Carvalho Chehab 
Reviewed-by Corentin Labbe  # For sun4i-ss

Documentation: Use "while" instead of "whilst"

2018-11-20T16:30:43+00:00

Whilst making an unrelated change to some Documentation, Linus sayeth:

  | Afaik, even in Britain, "whilst" is unusual and considered more
  | formal, and "while" is the common word.
  |
  | [...]
  |
  | Can we just admit that we work with computers, and we don't need to
  | use þe eald Englisc spelling of words that most of the world never
  | uses?

dictionary.com refers to the word as "Chiefly British", which is
probably an undesirable attribute for technical documentation.

Replace all occurrences under Documentation/ with "while".

Cc: David Howells 
Cc: Liam Girdwood 
Cc: Chris Wilson 
Cc: Michael Halcrow 
Cc: Jonathan Corbet 
Reported-by: Linus Torvalds 
Signed-off-by: Will Deacon 
Signed-off-by: Jonathan Corbet

docs: fix locations of several documents that got moved

2016-10-24T10:12:35+00:00

The previous patch renamed several files that are cross-referenced
along the Kernel documentation. Adjust the links to point to
the right places.

Signed-off-by: Mauro Carvalho Chehab

Documentation: arm: Update for DT-only platforms

2015-02-27T21:54:55+00:00

The documentation specified that a machine type is mandatory and made
that assumption in a few places.  However, for DT-only platforms, the
current advice is that no machine type should be registered, so update
accordingly.

Signed-off-by: Gregory Fong 
Signed-off-by: Jonathan Corbet

ARM: 7824/1: update advice on kernel, initramfs and FDT load address.

2013-08-25T16:09:47+00:00

  - Recommend that the kernel be placed under 128MiB, this is required if
    CONFIG_AUTO_ZRELADDR=y and good (or at least not bad) advice even if
    CONFIG_AUTO_ZRELADDR=n.
  - Recommend that a zImage kernel be placed above 32MiB, this avoids the need
    to relocate prior to decompression, which can speed up boot.
  - Add basic info on the requirements when loading a raw (non-zImage) kernel
    which are stricter than the zImage requirements.
  - Recommend that the DTB be placed after the 128MiB boundary, avoiding any
    potential conflict with the kernel decompressor, and within the lowmem
    region.  In practice it could follow the kernel loaded after 32MiB,
    assuming the kernel decompesses to less than 32MiB, but the 128MiB
    recommendation is simple and unambiguous.
  - Add similar recommendation regarding initramfs.

Signed-off-by: Ian Campbell 
Cc: Nicolas Pitre 
Cc: Will Deacon 
Cc: Dave Martin 
Cc: Grant Likely 
Cc: Roy Franz 
Cc: linux-arm-kernel@lists.infradead.org
Signed-off-by: Russell King

ARM: virt: Update documentation for hyp mode entry support

2012-09-19T07:32:51+00:00

Document the possibility of the kernel being entered in HYP mode.

Signed-off-by: Dave Martin 
Signed-off-by: Marc Zyngier

ARM: 6999/1: head, zImage: Always Enter the kernel in ARM state

2011-07-19T11:00:53+00:00

Currently, the documented kernel entry requirements are not
explicit about whether the kernel should be entered in ARM or
Thumb, leading to an ambiguitity about how to enter Thumb-2
kernels.  As a result, the kernel is reliant on the zImage
decompressor to enter the kernel proper in the correct instruction
set state.

This patch changes the boot entry protocol for head.S and Image to
be the same as for zImage: in all cases, the kernel is now entered
in ARM.

Documentation/arm/Booting is updated to reflect this new policy.

A different rule will be needed for Cortex-M class CPUs as and when
support for those lands in mainline, since these CPUs don't support
the ARM instruction set at all: a note is added to the effect that
the kernel must be entered in Thumb on such systems.

Signed-off-by: Dave Martin 
Acked-by: Nicolas Pitre 
Signed-off-by: Russell King

dt: add documentation of ARM dt boot interface

2011-05-23T15:30:20+00:00

v6: typo fixes
v5: clarified that dtb should be aligned on a 64 bit boundary in RAM.
v3: added details to Documentation/arm/Booting

Acked-by: Tony Lindgren 
Acked-by: Nicolas Pitre 
Acked-by: Russell King 
Signed-off-by: Grant Likely

Revert "dt: add documentation of ARM dt boot interface"

2011-02-14T15:13:20+00:00

This reverts commit 9830fcd6f6a4781d8b46d2b35c13b39f30915c63.

The ARM dt support has not been merged yet; this documentation update
was premature.

Signed-off-by: Grant Likely

dt: add documentation of ARM dt boot interface

2011-01-31T20:18:33+00:00

v3: added details to Documentation/arm/Booting

Signed-off-by: Grant Likely