docs: move x86 documentation into Documentation/arch/
JIRA: https://issues.redhat.com/browse/RHEL-68940
Conflicts:
1) The Documentation/x86/boot.rst file and hunks related to this
file are dropped due to a partial backport of this commit in
RHEL commit a146bb42fb
("docs: move x86 documentation into
Documentation/arch/"). In part
2) The x86/resctrl.rst and x86/topology.rst files are also dropped as
they have been moved earlier by other RHEL commits.
3) Some files are renamed and some are missing.
commit ff61f0791ce969d2db6c9f3b71d74ceec0a2e958
Author: Jonathan Corbet <corbet@lwn.net>
Date: Tue, 14 Mar 2023 17:06:44 -0600
docs: move x86 documentation into Documentation/arch/
Move the x86 documentation under Documentation/arch/ as a way of cleaning
up the top-level directory and making the structure of our docs more
closely match the structure of the source directories it describes.
All in-kernel references to the old paths have been updated.
Acked-by: Dave Hansen <dave.hansen@linux.intel.com>
Cc: linux-arch@vger.kernel.org
Cc: x86@kernel.org
Cc: Borislav Petkov <bp@alien8.de>
Cc: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/lkml/20230315211523.108836-1-corbet@lwn.net/
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Waiman Long <longman@redhat.com>
This commit is contained in:
parent
b1f78107e5
commit
ddbc819170
|
@ -203,7 +203,7 @@ Architecture (MCA)\ [#f3]_.
|
|||
mode).
|
||||
|
||||
.. [#f3] For more details about the Machine Check Architecture (MCA),
|
||||
please read Documentation/x86/x86_64/machinecheck.rst at the Kernel tree.
|
||||
please read Documentation/arch/x86/x86_64/machinecheck.rst at the Kernel tree.
|
||||
|
||||
EDAC - Error Detection And Correction
|
||||
*************************************
|
||||
|
|
|
@ -58,7 +58,7 @@ Because the buffers are potentially shared between Hyper-Threads cross
|
|||
Hyper-Thread attacks are possible.
|
||||
|
||||
Deeper technical information is available in the MDS specific x86
|
||||
architecture section: :ref:`Documentation/x86/mds.rst <mds>`.
|
||||
architecture section: :ref:`Documentation/arch/x86/mds.rst <mds>`.
|
||||
|
||||
|
||||
Attack scenarios
|
||||
|
|
|
@ -63,7 +63,7 @@ attacker needs to begin a TSX transaction and raise an asynchronous abort
|
|||
which in turn potentially leaks data stored in the buffers.
|
||||
|
||||
More detailed technical information is available in the TAA specific x86
|
||||
architecture section: :ref:`Documentation/x86/tsx_async_abort.rst <tsx_async_abort>`.
|
||||
architecture section: :ref:`Documentation/arch/x86/tsx_async_abort.rst <tsx_async_abort>`.
|
||||
|
||||
|
||||
Attack scenarios
|
||||
|
|
|
@ -181,7 +181,7 @@ parameter is applicable::
|
|||
X86-32 X86-32, aka i386 architecture is enabled.
|
||||
X86-64 X86-64 architecture is enabled.
|
||||
More X86-64 boot options can be found in
|
||||
Documentation/x86/x86_64/boot-options.rst.
|
||||
Documentation/arch/x86/x86_64/boot-options.rst.
|
||||
X86 Either 32-bit or 64-bit x86 (same as X86-32+X86-64)
|
||||
X86_UV SGI UV support is enabled.
|
||||
XEN Xen support is enabled
|
||||
|
@ -199,7 +199,7 @@ Do not modify the syntax of boot loader parameters without extreme
|
|||
need or coordination with <Documentation/arch/x86/boot.rst>.
|
||||
|
||||
There are also arch-specific kernel-parameters not documented here.
|
||||
See for example <Documentation/x86/x86_64/boot-options.rst>.
|
||||
See for example <Documentation/arch/x86/x86_64/boot-options.rst>.
|
||||
|
||||
Note that ALL kernel parameters listed below are CASE SENSITIVE, and that
|
||||
a trailing = on the name of any parameter states that that parameter will
|
||||
|
|
|
@ -3153,7 +3153,7 @@
|
|||
|
||||
mce [X86-32] Machine Check Exception
|
||||
|
||||
mce=option [X86-64] See Documentation/x86/x86_64/boot-options.rst
|
||||
mce=option [X86-64] See Documentation/arch/x86/x86_64/boot-options.rst
|
||||
|
||||
md= [HW] RAID subsystems devices and level
|
||||
See Documentation/admin-guide/md.rst.
|
||||
|
@ -4615,7 +4615,7 @@
|
|||
See Documentation/admin-guide/blockdev/paride.rst.
|
||||
|
||||
pirq= [SMP,APIC] Manual mp-table setup
|
||||
See Documentation/x86/i386/IO-APIC.rst.
|
||||
See Documentation/arch/x86/i386/IO-APIC.rst.
|
||||
|
||||
plip= [PPT,NET] Parallel port network link
|
||||
Format: { parport<nr> | timid | 0 }
|
||||
|
@ -5897,7 +5897,7 @@
|
|||
|
||||
serialnumber [BUGS=X86-32]
|
||||
|
||||
sev=option[,option...] [X86-64] See Documentation/x86/x86_64/boot-options.rst
|
||||
sev=option[,option...] [X86-64] See Documentation/arch/x86/x86_64/boot-options.rst
|
||||
|
||||
shapers= [NET]
|
||||
Maximal number of shapers.
|
||||
|
|
|
@ -22,5 +22,5 @@ implementation.
|
|||
s390/index
|
||||
../sh/index
|
||||
../sparc/index
|
||||
../x86/index
|
||||
x86/index
|
||||
../xtensa/index
|
||||
|
|
|
@ -1344,7 +1344,7 @@ follow::
|
|||
In addition to read/modify/write the setup header of the struct
|
||||
boot_params as that of 16-bit boot protocol, the boot loader should
|
||||
also fill the additional fields of the struct boot_params as
|
||||
described in chapter Documentation/x86/zero-page.rst.
|
||||
described in chapter Documentation/arch/x86/zero-page.rst.
|
||||
|
||||
After setting up the struct boot_params, the boot loader can load the
|
||||
32/64-bit kernel in the same way as that of 16-bit boot protocol.
|
||||
|
@ -1380,7 +1380,7 @@ can be calculated as follows::
|
|||
In addition to read/modify/write the setup header of the struct
|
||||
boot_params as that of 16-bit boot protocol, the boot loader should
|
||||
also fill the additional fields of the struct boot_params as described
|
||||
in chapter Documentation/x86/zero-page.rst.
|
||||
in chapter Documentation/arch/x86/zero-page.rst.
|
||||
|
||||
After setting up the struct boot_params, the boot loader can load
|
||||
64-bit kernel in the same way as that of 16-bit boot protocol, but
|
||||
|
|
|
@ -28,7 +28,7 @@ are aligned with platform MTRR setup. If MTRRs are only set up by the platform
|
|||
firmware code though and the OS does not make any specific MTRR mapping
|
||||
requests mtrr_type_lookup() should always return MTRR_TYPE_INVALID.
|
||||
|
||||
For details refer to Documentation/x86/pat.rst.
|
||||
For details refer to Documentation/arch/x86/pat.rst.
|
||||
|
||||
.. tip::
|
||||
On Intel P6 family processors (Pentium Pro, Pentium II and later)
|
|
@ -20,7 +20,7 @@ physical address space. This "ought to be enough for anybody" ©.
|
|||
QEMU 2.9 and later support 5-level paging.
|
||||
|
||||
Virtual memory layout for 5-level paging is described in
|
||||
Documentation/x86/x86_64/mm.rst
|
||||
Documentation/arch/x86/x86_64/mm.rst
|
||||
|
||||
|
||||
Enabling 5-level paging
|
|
@ -9,7 +9,7 @@ only the AMD64 specific ones are listed here.
|
|||
|
||||
Machine check
|
||||
=============
|
||||
Please see Documentation/x86/x86_64/machinecheck.rst for sysfs runtime tunables.
|
||||
Please see Documentation/arch/x86/x86_64/machinecheck.rst for sysfs runtime tunables.
|
||||
|
||||
mce=off
|
||||
Disable machine check
|
||||
|
@ -82,7 +82,7 @@ APICs
|
|||
Don't use the local APIC (alias for i386 compatibility)
|
||||
|
||||
pirq=...
|
||||
See Documentation/x86/i386/IO-APIC.rst
|
||||
See Documentation/arch/x86/i386/IO-APIC.rst
|
||||
|
||||
noapictimer
|
||||
Don't set up the APIC timer
|
|
@ -18,7 +18,7 @@ For more information on the features of cpusets, see
|
|||
Documentation/admin-guide/cgroup-v1/cpusets.rst.
|
||||
There are a number of different configurations you can use for your needs. For
|
||||
more information on the numa=fake command line option and its various ways of
|
||||
configuring fake nodes, see Documentation/x86/x86_64/boot-options.rst.
|
||||
configuring fake nodes, see Documentation/arch/x86/x86_64/boot-options.rst.
|
||||
|
||||
For the purposes of this introduction, we'll assume a very primitive NUMA
|
||||
emulation setup of "numa=fake=4*512,". This will split our system memory into
|
|
@ -410,7 +410,7 @@ ioremap_uc()
|
|||
|
||||
ioremap_uc() behaves like ioremap() except that on the x86 architecture without
|
||||
'PAT' mode, it marks memory as uncached even when the MTRR has designated
|
||||
it as cacheable, see Documentation/x86/pat.rst.
|
||||
it as cacheable, see Documentation/arch/x86/pat.rst.
|
||||
|
||||
Portable drivers should avoid the use of ioremap_uc().
|
||||
|
||||
|
|
|
@ -7658,7 +7658,7 @@ system fingerprint. To prevent userspace from circumventing such restrictions
|
|||
by running an enclave in a VM, KVM prevents access to privileged attributes by
|
||||
default.
|
||||
|
||||
See Documentation/x86/sgx.rst for more details.
|
||||
See Documentation/arch/x86/sgx.rst for more details.
|
||||
|
||||
7.26 KVM_CAP_PPC_RPT_INVALIDATE
|
||||
-------------------------------
|
||||
|
|
12
MAINTAINERS
12
MAINTAINERS
|
@ -1013,7 +1013,7 @@ M: Naveen Krishna Chatradhi <naveenkrishna.chatradhi@amd.com>
|
|||
R: Carlos Bilbao <carlos.bilbao@amd.com>
|
||||
L: platform-driver-x86@vger.kernel.org
|
||||
S: Maintained
|
||||
F: Documentation/x86/amd_hsmp.rst
|
||||
F: Documentation/arch/x86/amd_hsmp.rst
|
||||
F: arch/x86/include/asm/amd_hsmp.h
|
||||
F: arch/x86/include/uapi/asm/amd_hsmp.h
|
||||
F: drivers/platform/x86/amd/hsmp.c
|
||||
|
@ -10029,7 +10029,7 @@ L: tboot-devel@lists.sourceforge.net
|
|||
S: Supported
|
||||
W: http://tboot.sourceforge.net
|
||||
T: hg http://tboot.hg.sourceforge.net:8000/hgroot/tboot/tboot
|
||||
F: Documentation/x86/intel_txt.rst
|
||||
F: Documentation/arch/x86/intel_txt.rst
|
||||
F: arch/x86/kernel/tboot.c
|
||||
F: include/linux/tboot.h
|
||||
|
||||
|
@ -10040,7 +10040,7 @@ L: linux-sgx@vger.kernel.org
|
|||
S: Supported
|
||||
Q: https://patchwork.kernel.org/project/intel-sgx/list/
|
||||
T: git git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip.git x86/sgx
|
||||
F: Documentation/x86/sgx.rst
|
||||
F: Documentation/arch/x86/sgx.rst
|
||||
F: arch/x86/entry/vdso/vsgx.S
|
||||
F: arch/x86/include/asm/sgx.h
|
||||
F: arch/x86/include/uapi/asm/sgx.h
|
||||
|
@ -16437,7 +16437,7 @@ M: Fenghua Yu <fenghua.yu@intel.com>
|
|||
M: Reinette Chatre <reinette.chatre@intel.com>
|
||||
L: linux-kernel@vger.kernel.org
|
||||
S: Supported
|
||||
F: Documentation/x86/resctrl*
|
||||
F: Documentation/arch/x86/resctrl*
|
||||
F: arch/x86/include/asm/resctrl.h
|
||||
F: arch/x86/kernel/cpu/resctrl/
|
||||
F: tools/testing/selftests/resctrl/
|
||||
|
@ -21024,7 +21024,7 @@ L: linux-kernel@vger.kernel.org
|
|||
S: Maintained
|
||||
T: git git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip.git x86/core
|
||||
F: Documentation/devicetree/bindings/x86/
|
||||
F: Documentation/x86/
|
||||
F: Documentation/arch/x86/
|
||||
F: arch/x86/
|
||||
|
||||
X86 ENTRY CODE
|
||||
|
@ -21040,7 +21040,7 @@ M: Borislav Petkov <bp@alien8.de>
|
|||
L: linux-edac@vger.kernel.org
|
||||
S: Maintained
|
||||
F: Documentation/ABI/testing/sysfs-mce
|
||||
F: Documentation/x86/x86_64/machinecheck.rst
|
||||
F: Documentation/arch/x86/x86_64/machinecheck.rst
|
||||
F: arch/x86/kernel/cpu/mce/*
|
||||
|
||||
X86 MICROCODE UPDATE SUPPORT
|
||||
|
|
|
@ -1133,7 +1133,7 @@ config SMP
|
|||
uniprocessor machines. On a uniprocessor machine, the kernel
|
||||
will run faster if you say N here.
|
||||
|
||||
See also <file:Documentation/x86/i386/IO-APIC.rst>,
|
||||
See also <file:Documentation/arch/x86/i386/IO-APIC.rst>,
|
||||
<file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at
|
||||
<http://tldp.org/HOWTO/SMP-HOWTO.html>.
|
||||
|
||||
|
|
|
@ -441,7 +441,7 @@ config SMP
|
|||
Y to "Enhanced Real Time Clock Support", below. The "Advanced Power
|
||||
Management" code will be disabled if you say Y here.
|
||||
|
||||
See also <file:Documentation/x86/i386/IO-APIC.rst>,
|
||||
See also <file:Documentation/arch/x86/i386/IO-APIC.rst>,
|
||||
<file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at
|
||||
<http://www.tldp.org/docs.html#howto>.
|
||||
|
||||
|
@ -1503,7 +1503,7 @@ config X86_5LEVEL
|
|||
A kernel with the option enabled can be booted on machines that
|
||||
support 4- or 5-level paging.
|
||||
|
||||
See Documentation/x86/x86_64/5level-paging.rst for more
|
||||
See Documentation/arch/x86/x86_64/5level-paging.rst for more
|
||||
information.
|
||||
|
||||
Say N if unsure.
|
||||
|
@ -1757,7 +1757,7 @@ config MTRR
|
|||
You can safely say Y even if your machine doesn't have MTRRs, you'll
|
||||
just add about 9 KB to your kernel.
|
||||
|
||||
See <file:Documentation/x86/mtrr.rst> for more information.
|
||||
See <file:Documentation/arch/x86/mtrr.rst> for more information.
|
||||
|
||||
config MTRR_SANITIZER
|
||||
def_bool y
|
||||
|
@ -2506,7 +2506,7 @@ config MITIGATION_PAGE_TABLE_ISOLATION
|
|||
ensuring that the majority of kernel addresses are not mapped
|
||||
into userspace.
|
||||
|
||||
See Documentation/x86/pti.rst for more details.
|
||||
See Documentation/arch/x86/pti.rst for more details.
|
||||
|
||||
config MITIGATION_RETPOLINE
|
||||
bool "Avoid speculative indirect branches in kernel"
|
||||
|
|
|
@ -97,7 +97,7 @@ config IOMMU_DEBUG
|
|||
code. When you use it make sure you have a big enough
|
||||
IOMMU/AGP aperture. Most of the options enabled by this can
|
||||
be set more finegrained using the iommu= command line
|
||||
options. See Documentation/x86/x86_64/boot-options.rst for more
|
||||
options. See Documentation/arch/x86/x86_64/boot-options.rst for more
|
||||
details.
|
||||
|
||||
config IOMMU_LEAK
|
||||
|
|
|
@ -8,7 +8,7 @@
|
|||
*
|
||||
* entry.S contains the system-call and fault low-level handling routines.
|
||||
*
|
||||
* Some of this is documented in Documentation/x86/entry_64.rst
|
||||
* Some of this is documented in Documentation/arch/x86/entry_64.rst
|
||||
*
|
||||
* A note on terminology:
|
||||
* - iret frame: Architecture defined interrupt frame from SS to RIP
|
||||
|
|
|
@ -49,7 +49,7 @@
|
|||
|
||||
#define __START_KERNEL_map _AC(0xffffffff80000000, UL)
|
||||
|
||||
/* See Documentation/x86/x86_64/mm.rst for a description of the memory map. */
|
||||
/* See Documentation/arch/x86/x86_64/mm.rst for a description of the memory map. */
|
||||
|
||||
#define __PHYSICAL_MASK_SHIFT 52
|
||||
|
||||
|
|
|
@ -104,7 +104,7 @@ extern unsigned int ptrs_per_p4d;
|
|||
#define PGDIR_MASK (~(PGDIR_SIZE - 1))
|
||||
|
||||
/*
|
||||
* See Documentation/x86/x86_64/mm.rst for a description of the memory map.
|
||||
* See Documentation/arch/x86/x86_64/mm.rst for a description of the memory map.
|
||||
*
|
||||
* Be very careful vs. KASLR when changing anything here. The KASLR address
|
||||
* range must not overlap with anything except the KASAN shadow area, which
|
||||
|
|
|
@ -15,7 +15,7 @@
|
|||
|
||||
#define EREMOVE_ERROR_MESSAGE \
|
||||
"EREMOVE returned %d (0x%x) and an EPC page was leaked. SGX may become unusable. " \
|
||||
"Refer to Documentation/x86/sgx.rst for more information."
|
||||
"Refer to Documentation/arch/x86/sgx.rst for more information."
|
||||
|
||||
#define SGX_MAX_EPC_SECTIONS 8
|
||||
#define SGX_EEXTEND_BLOCK_SIZE 256
|
||||
|
|
|
@ -109,7 +109,7 @@ void __init pci_iommu_alloc(void)
|
|||
}
|
||||
|
||||
/*
|
||||
* See <Documentation/x86/x86_64/boot-options.rst> for the iommu kernel
|
||||
* See <Documentation/arch/x86/x86_64/boot-options.rst> for the iommu kernel
|
||||
* parameter documentation.
|
||||
*/
|
||||
static __init int iommu_setup(char *p)
|
||||
|
|
|
@ -234,7 +234,7 @@ within_inclusive(unsigned long addr, unsigned long start, unsigned long end)
|
|||
* take full advantage of the limited (s32) immediate addressing range (2G)
|
||||
* of x86_64.
|
||||
*
|
||||
* See Documentation/x86/x86_64/mm.rst for more detail.
|
||||
* See Documentation/arch/x86/x86_64/mm.rst for more detail.
|
||||
*/
|
||||
|
||||
static inline unsigned long highmap_start_pfn(void)
|
||||
|
|
|
@ -943,7 +943,7 @@ void flush_tlb_multi(const struct cpumask *cpumask,
|
|||
}
|
||||
|
||||
/*
|
||||
* See Documentation/x86/tlb.rst for details. We choose 33
|
||||
* See Documentation/arch/x86/tlb.rst for details. We choose 33
|
||||
* because it is large enough to cover the vast majority (at
|
||||
* least 95%) of allocations, and is small enough that we are
|
||||
* confident it will not cause too much overhead. Each single
|
||||
|
|
|
@ -1886,7 +1886,7 @@ EXPORT_SYMBOL_GPL(vhost_dev_ioctl);
|
|||
|
||||
/* TODO: This is really inefficient. We need something like get_user()
|
||||
* (instruction directly accesses the data, with an exception table entry
|
||||
* returning -EFAULT). See Documentation/x86/exception-tables.rst.
|
||||
* returning -EFAULT). See Documentation/arch/x86/exception-tables.rst.
|
||||
*/
|
||||
static int set_bit_to_user(int nr, void __user *addr)
|
||||
{
|
||||
|
|
|
@ -105,7 +105,7 @@ config INTEL_TXT
|
|||
See <https://www.intel.com/technology/security/> for more information
|
||||
about Intel(R) TXT.
|
||||
See <http://tboot.sourceforge.net> for more information about tboot.
|
||||
See Documentation/x86/intel_txt.rst for a description of how to enable
|
||||
See Documentation/arch/x86/intel_txt.rst for a description of how to enable
|
||||
Intel TXT support in a kernel boot.
|
||||
|
||||
If you are unsure as to whether this is required, answer N.
|
||||
|
|
|
@ -20,7 +20,7 @@
|
|||
* Userspace note:
|
||||
* The same principle works for userspace, because 'error' pointers
|
||||
* fall down to the unused hole far from user space, as described
|
||||
* in Documentation/x86/x86_64/mm.rst for x86_64 arch:
|
||||
* in Documentation/arch/x86/x86_64/mm.rst for x86_64 arch:
|
||||
*
|
||||
* 0000000000000000 - 00007fffffffffff (=47 bits) user space, different per mm hole caused by [48:63] sign extension
|
||||
* ffffffffffe00000 - ffffffffffffffff (=2 MB) unused hole
|
||||
|
|
|
@ -181,7 +181,7 @@ b) ORC (Oops Rewind Capability) unwind table generation
|
|||
band. So it doesn't affect runtime performance and it can be
|
||||
reliable even when interrupts or exceptions are involved.
|
||||
|
||||
For more details, see Documentation/x86/orc-unwinder.rst.
|
||||
For more details, see Documentation/arch/x86/orc-unwinder.rst.
|
||||
|
||||
c) Higher live patching compatibility rate
|
||||
|
||||
|
|
Loading…
Reference in New Issue