mirror of
https://github.com/torvalds/linux.git
synced 2024-11-22 04:02:20 +00:00
Documentation work keeps chugging along; stuff for 6.6 includes:
- Work from Carlos Bilbao to integrate rustdoc output into the generated
HTML documentation. This took some work to figure out how to do it
without slowing the docs build and without creating people who don't have
Rust installed, but Carlos got there.
- Move the loongarch and mips architecture documentation under
Documentation/arch/.
- Some more maintainer documentation from Jakub
...plus the usual assortment of updates, translations, and fixes.
-----BEGIN PGP SIGNATURE-----
iQFDBAABCAAtFiEEIw+MvkEiF49krdp9F0NaE2wMflgFAmTvqNkPHGNvcmJldEBs
d24ubmV0AAoJEBdDWhNsDH5YgIgH/3drfLtlFtzLqDOzrzDXS8yGnE3pPdxw796b
/ZFzAK16wYKaKevYoIz8bVGGKaE1sEUW0mhlq4KGdfZuxLG8YnWS8URyCW4FDU2E
6qNL+8oJ8LZfID46f9Q8ZgfEz7yF/mhCqPk7MEswYtwbscs2ZTGCTGYB/5BHlBuT
LR+M89uLmHgr8S1o24v30OgiX+VvQFyu0xoxIhbiqUZvBd/XdfX2pgYd9BGzMj5q
C2ZP+V14g36c5pV0EO9TwhCXOF/WVrp7DbjbfWAsqBSLxvpXPydH2q1DUzGeQtP1
exujrBD1O8q3pPdaNA5R+h6cWlHmUZug9mE4BRLp9ErGrozwJsQ=
=C3Uv
-----END PGP SIGNATURE-----
Merge tag 'docs-6.6' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet:
"Documentation work keeps chugging along; this includes:
- Work from Carlos Bilbao to integrate rustdoc output into the
generated HTML documentation. This took some work to figure out how
to do it without slowing the docs build and without creating people
who don't have Rust installed, but Carlos got there
- Move the loongarch and mips architecture documentation under
Documentation/arch/
- Some more maintainer documentation from Jakub
... plus the usual assortment of updates, translations, and fixes"
* tag 'docs-6.6' of git://git.lwn.net/linux: (56 commits)
Docu: genericirq.rst: fix irq-example
input: docs: pxrc: remove reference to phoenix-sim
Documentation: serial-console: Fix literal block marker
docs/mm: remove references to hmm_mirror ops and clean typos
docs/zh_CN: correct regi_chg(),regi_add() to region_chg(),region_add()
Documentation: Fix typos
Documentation/ABI: Fix typos
scripts: kernel-doc: fix macro handling in enums
scripts: kernel-doc: parse DEFINE_DMA_UNMAP_[ADDR|LEN]
Documentation: riscv: Update boot image header since EFI stub is supported
Documentation: riscv: Add early boot document
Documentation: arm: Add bootargs to the table of added DT parameters
docs: kernel-parameters: Refer to the correct bitmap function
doc: update params of memhp_default_state=
docs: Add book to process/kernel-docs.rst
docs: sparse: fix invalid link addresses
docs: vfs: clean up after the iterate() removal
docs: Add a section on surveys to the researcher guidelines
docs: move mips under arch
docs: move loongarch under arch
...
This commit is contained in:
Linus Torvalds
commit
cd99b9eb4b
@ -295,7 +295,7 @@ Description:
|
||||
capable of executing requests targeting different sector ranges
|
||||
in parallel. For instance, single LUN multi-actuator hard-disks
|
||||
will have an independent_access_ranges directory if the device
|
||||
correctly advertizes the sector ranges of its actuators.
|
||||
correctly advertises the sector ranges of its actuators.
|
||||
|
||||
The independent_access_ranges directory contains one directory
|
||||
per access range, with each range described using the sector
|
||||
|
||||
@ -356,7 +356,7 @@ Description:
|
||||
pkeys/<n>: (RO) Displays the contents of the physical
|
||||
key table n = 0..126
|
||||
|
||||
mcgs/: (RO) Muticast group table
|
||||
mcgs/: (RO) Multicast group table
|
||||
|
||||
<m>/gid_idx/0: (RO) Display the GID mapping m = 1..2
|
||||
|
||||
|
||||
@ -2,6 +2,6 @@ What: /sys/bus/wmi/devices/05901221-D566-11D1-B2F0-00A0C9062910[-X]/bmof
|
||||
Date: Jun 2017
|
||||
KernelVersion: 4.13
|
||||
Description:
|
||||
Binary MOF metadata used to decribe the details of available ACPI WMI interfaces.
|
||||
Binary MOF metadata used to describe the details of available ACPI WMI interfaces.
|
||||
|
||||
See Documentation/wmi/devices/wmi-bmof.rst for details.
|
||||
|
||||
@ -95,7 +95,7 @@ What: /sys/kernel/debug/habanalabs/hl<n>/device_release_watchdog_timeo
|
||||
Date: Oct 2022
|
||||
KernelVersion: 6.2
|
||||
Contact: ttayar@habana.ai
|
||||
Description: The watchdog timeout value in seconds for a device relese upon
|
||||
Description: The watchdog timeout value in seconds for a device release upon
|
||||
certain error cases, after which the device is reset.
|
||||
|
||||
What: /sys/kernel/debug/habanalabs/hl<n>/dma_size
|
||||
|
||||
@ -8,7 +8,7 @@ Description:
|
||||
|
||||
== ===================================
|
||||
1 major number
|
||||
2 minor mumber
|
||||
2 minor number
|
||||
3 device name
|
||||
4 reads completed successfully
|
||||
5 reads merged
|
||||
|
||||
@ -21,7 +21,7 @@ What: /sys/bus/coreboot/devices/cbmem-<id>/address
|
||||
Date: August 2022
|
||||
Contact: Jack Rosenthal <jrosenth@chromium.org>
|
||||
Description:
|
||||
This is the pyhsical memory address that the CBMEM entry's data
|
||||
This is the physical memory address that the CBMEM entry's data
|
||||
begins at, in hexadecimal (e.g., ``0x76ffe000``).
|
||||
|
||||
What: /sys/bus/coreboot/devices/cbmem-<id>/size
|
||||
|
||||
@ -31,7 +31,7 @@ Date: November 2014
|
||||
KernelVersion: 3.19
|
||||
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
|
||||
Description: (RW) Used in conjunction with @addr_idx. Specifies the range of
|
||||
addresses to trigger on. Inclusion or exclusion is specificed
|
||||
addresses to trigger on. Inclusion or exclusion is specified
|
||||
in the corresponding access type register.
|
||||
|
||||
What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/addr_single
|
||||
@ -304,19 +304,19 @@ What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtsscr
|
||||
Date: September 2015
|
||||
KernelVersion: 4.4
|
||||
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
|
||||
Description: (RO) Print the content of the ETM Trace Start/Stop Conrol
|
||||
Description: (RO) Print the content of the ETM Trace Start/Stop Control
|
||||
register (0x018). The value is read directly from the HW.
|
||||
|
||||
What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtecr1
|
||||
Date: September 2015
|
||||
KernelVersion: 4.4
|
||||
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
|
||||
Description: (RO) Print the content of the ETM Enable Conrol #1
|
||||
Description: (RO) Print the content of the ETM Enable Control #1
|
||||
register (0x024). The value is read directly from the HW.
|
||||
|
||||
What: /sys/bus/coresight/devices/<memory_map>.[etm|ptm]/mgmt/etmtecr2
|
||||
Date: September 2015
|
||||
KernelVersion: 4.4
|
||||
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
|
||||
Description: (RO) Print the content of the ETM Enable Conrol #2
|
||||
Description: (RO) Print the content of the ETM Enable Control #2
|
||||
register (0x01c). The value is read directly from the HW.
|
||||
|
||||
@ -446,7 +446,7 @@ Date: April 2015
|
||||
KernelVersion: 4.01
|
||||
Contact: Mathieu Poirier <mathieu.poirier@linaro.org>
|
||||
Description: (Read) Returns the maximum size of the data value, data address,
|
||||
VMID, context ID and instuction address in the trace unit
|
||||
VMID, context ID and instruction address in the trace unit
|
||||
(0x1E8). The value is taken directly from the HW.
|
||||
|
||||
What: /sys/bus/coresight/devices/etm<N>/trcidr/trcidr3
|
||||
|
||||
@ -47,7 +47,7 @@ Description: Per-pmu performance monitoring events specific to the running syste
|
||||
If a <term> is specified alone (without an assigned value), it
|
||||
is implied that 0x1 is assigned to that <term>.
|
||||
|
||||
Examples (each of these lines would be in a seperate file):
|
||||
Examples (each of these lines would be in a separate file):
|
||||
|
||||
event=0x2abc
|
||||
event=0x423,inv,cmask=0x3
|
||||
@ -83,7 +83,7 @@ Description: Perf event scaling factors
|
||||
|
||||
A string representing a floating point value expressed in
|
||||
scientific notation to be multiplied by the event count
|
||||
recieved from the kernel to match the unit specified in the
|
||||
received from the kernel to match the unit specified in the
|
||||
<event>.unit file.
|
||||
|
||||
Example:
|
||||
|
||||
@ -5,6 +5,6 @@ Description:
|
||||
Indicates whether or not this SBE device has experienced a
|
||||
timeout; i.e. the SBE did not respond within the time allotted
|
||||
by the driver. A value of 1 indicates that a timeout has
|
||||
ocurred and no transfers have completed since the timeout. A
|
||||
value of 0 indicates that no timeout has ocurred, or if one
|
||||
occurred and no transfers have completed since the timeout. A
|
||||
value of 0 indicates that no timeout has occurred, or if one
|
||||
has, more recent transfers have completed successful.
|
||||
|
||||
@ -8,7 +8,7 @@ Description:
|
||||
NONE no device
|
||||
USB USB device is attached
|
||||
UART UART is attached
|
||||
CHARGER Charger is attaced
|
||||
CHARGER Charger is attached
|
||||
JIG JIG is attached
|
||||
======= ======================
|
||||
|
||||
|
||||
@ -121,7 +121,7 @@ KernelVersion: v4.7
|
||||
Contact: nvdimm@lists.linux.dev
|
||||
Description:
|
||||
(RO) ACPI specification 6.2 section 5.2.25.9, defines an
|
||||
identifier for an NVDIMM, which refelects the id attribute.
|
||||
identifier for an NVDIMM, which reflects the id attribute.
|
||||
|
||||
|
||||
What: /sys/bus/nd/devices/nmemX/nfit/subsystem_vendor
|
||||
|
||||
@ -18,9 +18,11 @@ Description: (RO) Attribute group to describe the magic bits
|
||||
Each attribute under this group defines a bit range of the
|
||||
perf_event_attr.config. Supported attribute is listed
|
||||
below::
|
||||
|
||||
event = "config:0-4" - event ID
|
||||
|
||||
For example::
|
||||
|
||||
ctl_res_cnt = "event=0x1"
|
||||
|
||||
What: /sys/bus/event_source/devices/nmemX/events
|
||||
|
||||
@ -30,7 +30,7 @@ Description:
|
||||
Indicating that contents of the
|
||||
NVDIMM have been scrubbed.
|
||||
* "locked"
|
||||
Indicating that NVDIMM contents cant
|
||||
Indicating that NVDIMM contents can't
|
||||
be modified until next power cycle.
|
||||
|
||||
What: /sys/bus/nd/devices/nmemX/papr/perf_stats
|
||||
|
||||
@ -9,7 +9,7 @@ Description:
|
||||
Controller (UMC).
|
||||
|
||||
The umc bus presents each of the individual
|
||||
capabilties as a device.
|
||||
capabilities as a device.
|
||||
|
||||
What: /sys/bus/umc/devices/.../capability_id
|
||||
Date: July 2008
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
What: /sys/class/
|
||||
Date: Febuary 2006
|
||||
Date: February 2006
|
||||
Contact: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
|
||||
Description:
|
||||
The /sys/class directory will consist of a group of
|
||||
|
||||
@ -42,7 +42,7 @@ What: /sys/class/cxl/<afu>/mmio_size
|
||||
Date: September 2014
|
||||
Contact: linuxppc-dev@lists.ozlabs.org
|
||||
Description: read only
|
||||
Decimal value of the size of the MMIO space that may be mmaped
|
||||
Decimal value of the size of the MMIO space that may be mmapped
|
||||
by userspace.
|
||||
Users: https://github.com/ibm-capi/libcxl
|
||||
|
||||
@ -155,7 +155,7 @@ What: /sys/class/cxl/<afu>m/mmio_size
|
||||
Date: September 2014
|
||||
Contact: linuxppc-dev@lists.ozlabs.org
|
||||
Description: read only
|
||||
Decimal value of the size of the MMIO space that may be mmaped
|
||||
Decimal value of the size of the MMIO space that may be mmapped
|
||||
by userspace. This includes all slave contexts space also.
|
||||
Users: https://github.com/ibm-capi/libcxl
|
||||
|
||||
|
||||
@ -39,7 +39,7 @@ KernelVersion: 2.6.29
|
||||
Contact: linux-mtd@lists.infradead.org
|
||||
Description:
|
||||
Major and minor numbers of the character device corresponding
|
||||
to the read-only variant of thie MTD device (in
|
||||
to the read-only variant of the MTD device (in
|
||||
<major>:<minor> format). In this case <minor> will be odd.
|
||||
|
||||
What: /sys/class/mtd/mtdX/erasesize
|
||||
|
||||
@ -82,7 +82,7 @@ KernelVersion: 2.6.12
|
||||
Contact: netdev@vger.kernel.org
|
||||
Description:
|
||||
Indicates the current physical link state of the interface.
|
||||
Posssible values are:
|
||||
Possible values are:
|
||||
|
||||
== =====================
|
||||
0 physical link is down
|
||||
|
||||
@ -39,7 +39,7 @@ Contact: netdev@vger.kernel.org
|
||||
Description:
|
||||
Mask of the CPU(s) currently enabled to participate into the
|
||||
Transmit Packet Steering packet processing flow for this
|
||||
network device transmit queue. Possible vaules depend on the
|
||||
network device transmit queue. Possible values depend on the
|
||||
number of available CPU(s) in the system.
|
||||
|
||||
What: /sys/class/<iface>/queues/tx-<queue>/xps_rxqs
|
||||
|
||||
@ -22,7 +22,7 @@ Description:
|
||||
Long Life:
|
||||
Customized charge rate for last longer battery life.
|
||||
On Wilco device this mode is pre-configured in the factory
|
||||
through EC's private PID. Swiching to a different mode will
|
||||
through EC's private PID. Switching to a different mode will
|
||||
be denied by Wilco EC when Long Life mode is enabled.
|
||||
|
||||
What: /sys/class/power_supply/wilco-charger/charge_control_start_threshold
|
||||
|
||||
@ -81,7 +81,7 @@ Description: Remote processor coredump configuration
|
||||
collected userspace will directly read from the remote
|
||||
processor's device memory. Extra buffer will not be used to
|
||||
copy the dump. Also recovery process will not proceed until
|
||||
all data is read by usersapce.
|
||||
all data is read by userspace.
|
||||
|
||||
What: /sys/class/remoteproc/.../recovery
|
||||
Date: July 2020
|
||||
|
||||
@ -4,7 +4,7 @@ Description:
|
||||
This is given by thermal zone driver as part of registration.
|
||||
E.g: "acpitz" indicates it's an ACPI thermal device.
|
||||
In order to keep it consistent with hwmon sys attribute; this
|
||||
shouldbe a short, lowercase string, not containing spaces nor
|
||||
should be a short, lowercase string, not containing spaces nor
|
||||
dashes.
|
||||
|
||||
RO, Required
|
||||
|
||||
@ -42,7 +42,7 @@ Date: June 2013
|
||||
KernelVersion: 3.11
|
||||
Contact: Thomas Pugliese <thomas.pugliese@gmail.com>
|
||||
Description:
|
||||
The device notification time slot (DNTS) count and inverval in
|
||||
The device notification time slot (DNTS) count and interval in
|
||||
milliseconds that the WUSB host should use. This controls how
|
||||
often the devices will have the opportunity to send
|
||||
notifications to the host.
|
||||
|
||||
@ -17,4 +17,4 @@ Description:
|
||||
After a successful execution of the bus type's .offline()
|
||||
callback the device cannot be used for any purpose until either
|
||||
it is removed (i.e. device_del() is called for it), or its bus
|
||||
type's .online() is exeucted successfully.
|
||||
type's .online() is executed successfully.
|
||||
|
||||
@ -5,7 +5,7 @@ Description: Write 1 to this file to update the ACHC microcontroller
|
||||
firmware via the EzPort interface. For this the kernel
|
||||
will load "achc.bin" via the firmware API (so usually
|
||||
from /lib/firmware). The write will block until the FW
|
||||
has either been flashed successfully or an error occured.
|
||||
has either been flashed successfully or an error occurred.
|
||||
|
||||
What: /sys/bus/spi/<dev>/reset
|
||||
Date: Jul 2021
|
||||
|
||||
@ -3,7 +3,7 @@ Date: February 2014
|
||||
Contact: Peter De Schrijver <pdeschrijver@nvidia.com>
|
||||
Description: read-only access to the efuses on Tegra20, Tegra30, Tegra114
|
||||
and Tegra124 SoC's from NVIDIA. The efuses contain write once
|
||||
data programmed at the factory. The data is layed out in 32bit
|
||||
data programmed at the factory. The data is laid out in 32bit
|
||||
words in LSB first format. Each bit represents a single value
|
||||
as decoded from the fuse registers. Bits order/assignment
|
||||
exactly matches the HW registers, including any unused bits.
|
||||
|
||||
@ -84,7 +84,7 @@ Description:
|
||||
hotplug events associated with the given class of
|
||||
devices and will allow those devices to be ejected with
|
||||
the help of the _EJ0 control method. Unsetting it
|
||||
effectively disables hotplug for the correspoinding
|
||||
effectively disables hotplug for the corresponding
|
||||
class of devices.
|
||||
======== =======================================================
|
||||
|
||||
|
||||
@ -102,12 +102,12 @@ Description:
|
||||
conn_port
|
||||
|
||||
The conn_hub entry contains a value representing the unique
|
||||
oridinal value of the hub on the other end of the fabric
|
||||
ordinal value of the hub on the other end of the fabric
|
||||
cable plugged into the port. If the port is disconnected,
|
||||
the value returned will be -1.
|
||||
|
||||
The conn_port entry contains a value representing the unique
|
||||
oridinal value of the port on the other end of the fabric cable
|
||||
ordinal value of the port on the other end of the fabric cable
|
||||
plugged into the port. If the port is disconnected, the value
|
||||
returned will be -1.
|
||||
|
||||
|
||||
@ -54,9 +54,9 @@ Description: Controls the in-place-update policy.
|
||||
0x00 DISABLE disable IPU(=default option in LFS mode)
|
||||
0x01 FORCE all the time
|
||||
0x02 SSR if SSR mode is activated
|
||||
0x04 UTIL if FS utilization is over threashold
|
||||
0x04 UTIL if FS utilization is over threshold
|
||||
0x08 SSR_UTIL if SSR mode is activated and FS utilization is over
|
||||
threashold
|
||||
threshold
|
||||
0x10 FSYNC activated in fsync path only for high performance
|
||||
flash storages. IPU will be triggered only if the
|
||||
# of dirty pages over min_fsync_blocks.
|
||||
@ -117,7 +117,7 @@ Date: December 2021
|
||||
Contact: "Konstantin Vyshetsky" <vkon@google.com>
|
||||
Description: Controls the number of discards a thread will issue at a time.
|
||||
Higher number will allow the discard thread to finish its work
|
||||
faster, at the cost of higher latency for incomming I/O.
|
||||
faster, at the cost of higher latency for incoming I/O.
|
||||
|
||||
What: /sys/fs/f2fs/<disk>/min_discard_issue_time
|
||||
Date: December 2021
|
||||
@ -334,7 +334,7 @@ Description: This indicates how many GC can be failed for the pinned
|
||||
state. 2048 trials is set by default.
|
||||
|
||||
What: /sys/fs/f2fs/<disk>/extension_list
|
||||
Date: Feburary 2018
|
||||
Date: February 2018
|
||||
Contact: "Chao Yu" <yuchao0@huawei.com>
|
||||
Description: Used to control configure extension list:
|
||||
- Query: cat /sys/fs/f2fs/<disk>/extension_list
|
||||
|
||||
@ -154,7 +154,7 @@ Description: Writing to and reading from this file sets and gets the action
|
||||
What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/min
|
||||
Date: Mar 2022
|
||||
Contact: SeongJae Park <sj@kernel.org>
|
||||
Description: Writing to and reading from this file sets and gets the mimimum
|
||||
Description: Writing to and reading from this file sets and gets the minimum
|
||||
size of the scheme's target regions in bytes.
|
||||
|
||||
What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/max
|
||||
|
||||
@ -15,7 +15,7 @@ KernelVersion: 3.19
|
||||
Contact: Gabriele Mazzotta <gabriele.mzt@gmail.com>,
|
||||
Pali Rohár <pali@kernel.org>
|
||||
Description:
|
||||
This file allows to specifiy the on/off threshold value,
|
||||
This file allows to specify the on/off threshold value,
|
||||
as reported by the ambient light sensor.
|
||||
|
||||
What: /sys/class/leds/dell::kbd_backlight/start_triggers
|
||||
|
||||
@ -90,7 +90,7 @@ KernelVersion: 5.4
|
||||
Contact: Wu Hao <hao.wu@intel.com>
|
||||
Description: Read-Write. Read this file to get errors detected on FME.
|
||||
Write this file to clear errors logged in fme_errors. Write
|
||||
fials with -EINVAL if input parsing fails or input error code
|
||||
fails with -EINVAL if input parsing fails or input error code
|
||||
doesn't match.
|
||||
|
||||
What: /sys/bus/platform/devices/dfl-fme.0/errors/first_error
|
||||
|
||||
@ -9,7 +9,7 @@ Description:
|
||||
The device name flows down to architecture specific board
|
||||
initialization file from the ATAGS bootloader
|
||||
firmware. The name exposed is read from the user-space
|
||||
dameon and opens the device when install is requested.
|
||||
daemon and opens the device when install is requested.
|
||||
|
||||
What: /sys/devices/platform/kim/baud_rate
|
||||
Date: January 2010
|
||||
|
||||
@ -4,7 +4,7 @@ KernelVersion: 4.10
|
||||
Contact: "Sebastien Guiriec" <sebastien.guiriec@intel.com>
|
||||
Description:
|
||||
LPE Firmware version for SST driver on all atom
|
||||
plaforms (BYT/CHT/Merrifield/BSW).
|
||||
platforms (BYT/CHT/Merrifield/BSW).
|
||||
If the FW has never been loaded it will display::
|
||||
|
||||
"FW not yet loaded"
|
||||
|
||||
@ -59,6 +59,12 @@ PAPEROPT_letter = -D latex_paper_size=letter
|
||||
KERNELDOC = $(srctree)/scripts/kernel-doc
|
||||
KERNELDOC_CONF = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)
|
||||
ALLSPHINXOPTS = $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)
|
||||
ifneq ($(wildcard $(srctree)/.config),)
|
||||
ifeq ($(CONFIG_RUST),y)
|
||||
# Let Sphinx know we will include rustdoc
|
||||
ALLSPHINXOPTS += -t rustdoc
|
||||
endif
|
||||
endif
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
|
||||
@ -95,6 +101,16 @@ htmldocs:
|
||||
@$(srctree)/scripts/sphinx-pre-install --version-check
|
||||
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
|
||||
|
||||
# If Rust support is available and .config exists, add rustdoc generated contents.
|
||||
# If there are any, the errors from this make rustdoc will be displayed but
|
||||
# won't stop the execution of htmldocs
|
||||
|
||||
ifneq ($(wildcard $(srctree)/.config),)
|
||||
ifeq ($(CONFIG_RUST),y)
|
||||
$(Q)$(MAKE) rustdoc || true
|
||||
endif
|
||||
endif
|
||||
|
||||
texinfodocs:
|
||||
@$(srctree)/scripts/sphinx-pre-install --version-check
|
||||
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,texinfo,$(var),texinfo,$(var)))
|
||||
|
||||
@ -178,7 +178,7 @@ Userspace monitor usage example
|
||||
Cgroup2 interface
|
||||
=================
|
||||
|
||||
In a system with a CONFIG_CGROUP=y kernel and the cgroup2 filesystem
|
||||
In a system with a CONFIG_CGROUPS=y kernel and the cgroup2 filesystem
|
||||
mounted, pressure stall information is also tracked for tasks grouped
|
||||
into cgroups. Each subdirectory in the cgroupfs mountpoint contains
|
||||
cpu.pressure, memory.pressure, and io.pressure files; the format is
|
||||
|
||||
@ -62,7 +62,7 @@ Please note that implementation details can be changed.
|
||||
|
||||
At cancel(), simply usage -= PAGE_SIZE.
|
||||
|
||||
Under below explanation, we assume CONFIG_MEM_RES_CTRL_SWAP=y.
|
||||
Under below explanation, we assume CONFIG_SWAP=y.
|
||||
|
||||
4. Anonymous
|
||||
============
|
||||
|
||||
@ -80,7 +80,7 @@ The special case-tolerant group name "all" has a meaning of selecting all CPUs,
|
||||
so that "nohz_full=all" is the equivalent of "nohz_full=0-N".
|
||||
|
||||
The semantics of "N" and "all" is supported on a level of bitmaps and holds for
|
||||
all users of bitmap_parse().
|
||||
all users of bitmap_parselist().
|
||||
|
||||
This document may not be entirely up to date and comprehensive. The command
|
||||
"modinfo -p ${modulename}" shows a current list of all parameters of a loadable
|
||||
@ -89,10 +89,11 @@ reveal their parameters in /sys/module/${modulename}/parameters/. Some of these
|
||||
parameters may be changed at runtime by the command
|
||||
``echo -n ${value} > /sys/module/${modulename}/parameters/${parm}``.
|
||||
|
||||
The parameters listed below are only valid if certain kernel build options were
|
||||
enabled and if respective hardware is present. The text in square brackets at
|
||||
the beginning of each description states the restrictions within which a
|
||||
parameter is applicable::
|
||||
The parameters listed below are only valid if certain kernel build options
|
||||
were enabled and if respective hardware is present. This list should be kept
|
||||
in alphabetical order. The text in square brackets at the beginning
|
||||
of each description states the restrictions within which a parameter
|
||||
is applicable::
|
||||
|
||||
ACPI ACPI support is enabled.
|
||||
AGP AGP (Accelerated Graphics Port) is enabled.
|
||||
@ -127,9 +128,9 @@ parameter is applicable::
|
||||
KGDB Kernel debugger support is enabled.
|
||||
KVM Kernel Virtual Machine support is enabled.
|
||||
LIBATA Libata driver is enabled
|
||||
LP Printer support is enabled.
|
||||
LOONGARCH LoongArch architecture is enabled.
|
||||
LOOP Loopback device support is enabled.
|
||||
LP Printer support is enabled.
|
||||
M68k M68k architecture is enabled.
|
||||
These options have more detailed description inside of
|
||||
Documentation/arch/m68k/kernel-options.rst.
|
||||
@ -139,10 +140,9 @@ parameter is applicable::
|
||||
MSI Message Signaled Interrupts (PCI).
|
||||
MTD MTD (Memory Technology Device) support is enabled.
|
||||
NET Appropriate network support is enabled.
|
||||
NUMA NUMA support is enabled.
|
||||
NFS Appropriate NFS support is enabled.
|
||||
NUMA NUMA support is enabled.
|
||||
OF Devicetree is enabled.
|
||||
PV_OPS A paravirtualized kernel is enabled.
|
||||
PARISC The PA-RISC architecture is enabled.
|
||||
PCI PCI bus support is enabled.
|
||||
PCIE PCI Express support is enabled.
|
||||
@ -151,9 +151,10 @@ parameter is applicable::
|
||||
PPC PowerPC architecture is enabled.
|
||||
PPT Parallel port support is enabled.
|
||||
PS2 Appropriate PS/2 support is enabled.
|
||||
PV_OPS A paravirtualized kernel is enabled.
|
||||
RAM RAM disk support is enabled.
|
||||
RISCV RISCV architecture is enabled.
|
||||
RDT Intel Resource Director Technology.
|
||||
RISCV RISCV architecture is enabled.
|
||||
S390 S390 architecture is enabled.
|
||||
SCSI Appropriate SCSI support is enabled.
|
||||
A lot of drivers have their options described inside
|
||||
@ -164,15 +165,15 @@ parameter is applicable::
|
||||
SH SuperH architecture is enabled.
|
||||
SMP The kernel is an SMP kernel.
|
||||
SPARC Sparc architecture is enabled.
|
||||
SWSUSP Software suspend (hibernation) is enabled.
|
||||
SUSPEND System suspend states are enabled.
|
||||
SWSUSP Software suspend (hibernation) is enabled.
|
||||
TPM TPM drivers are enabled.
|
||||
UMS USB Mass Storage support is enabled.
|
||||
USB USB support is enabled.
|
||||
USBHID USB Human Interface Device support is enabled.
|
||||
V4L Video For Linux support is enabled.
|
||||
VMMIO Driver for memory mapped virtio devices is enabled.
|
||||
VGA The VGA console has been enabled.
|
||||
VMMIO Driver for memory mapped virtio devices is enabled.
|
||||
VT Virtual terminal support is enabled.
|
||||
WDT Watchdog support is enabled.
|
||||
X86-32 X86-32, aka i386 architecture is enabled.
|
||||
@ -186,9 +187,9 @@ parameter is applicable::
|
||||
|
||||
In addition, the following text indicates that the option::
|
||||
|
||||
BOOT Is a boot loader parameter.
|
||||
BUGS= Relates to possible processor bugs on the said processor.
|
||||
KNL Is a kernel start-up parameter.
|
||||
BOOT Is a boot loader parameter.
|
||||
|
||||
Parameters denoted with BOOT are actually interpreted by the boot
|
||||
loader, and have no meaning to the kernel directly.
|
||||
|
||||
@ -418,20 +418,20 @@
|
||||
arm64.nobti [ARM64] Unconditionally disable Branch Target
|
||||
Identification support
|
||||
|
||||
arm64.nopauth [ARM64] Unconditionally disable Pointer Authentication
|
||||
support
|
||||
arm64.nomops [ARM64] Unconditionally disable Memory Copy and Memory
|
||||
Set instructions support
|
||||
|
||||
arm64.nomte [ARM64] Unconditionally disable Memory Tagging Extension
|
||||
support
|
||||
|
||||
arm64.nosve [ARM64] Unconditionally disable Scalable Vector
|
||||
Extension support
|
||||
arm64.nopauth [ARM64] Unconditionally disable Pointer Authentication
|
||||
support
|
||||
|
||||
arm64.nosme [ARM64] Unconditionally disable Scalable Matrix
|
||||
Extension support
|
||||
|
||||
arm64.nomops [ARM64] Unconditionally disable Memory Copy and Memory
|
||||
Set instructions support
|
||||
arm64.nosve [ARM64] Unconditionally disable Scalable Vector
|
||||
Extension support
|
||||
|
||||
ataflop= [HW,M68k]
|
||||
|
||||
@ -2655,7 +2655,7 @@
|
||||
|
||||
kvm-intel.flexpriority=
|
||||
[KVM,Intel] Control KVM's use of FlexPriority feature
|
||||
(TPR shadow). Default is 1 (enabled). Disalbe by KVM if
|
||||
(TPR shadow). Default is 1 (enabled). Disable by KVM if
|
||||
hardware lacks support for it.
|
||||
|
||||
kvm-intel.nested=
|
||||
@ -3140,7 +3140,7 @@
|
||||
[KNL,SH] Allow user to override the default size for
|
||||
per-device physically contiguous DMA buffers.
|
||||
|
||||
memhp_default_state=online/offline
|
||||
memhp_default_state=online/offline/online_kernel/online_movable
|
||||
[KNL] Set the initial state for the memory hotplug
|
||||
onlining policy. If not specified, the default value is
|
||||
set according to the
|
||||
@ -4073,20 +4073,6 @@
|
||||
timeout < 0: reboot immediately
|
||||
Format: <timeout>
|
||||
|
||||
panic_print= Bitmask for printing system info when panic happens.
|
||||
User can chose combination of the following bits:
|
||||
bit 0: print all tasks info
|
||||
bit 1: print system memory info
|
||||
bit 2: print timer info
|
||||
bit 3: print locks info if CONFIG_LOCKDEP is on
|
||||
bit 4: print ftrace buffer
|
||||
bit 5: print all printk messages in buffer
|
||||
bit 6: print all CPUs backtrace (if available in the arch)
|
||||
*Be aware* that this option may print a _lot_ of lines,
|
||||
so there are risks of losing older messages in the log.
|
||||
Use this option carefully, maybe worth to setup a
|
||||
bigger log buffer with "log_buf_len" along with this.
|
||||
|
||||
panic_on_taint= Bitmask for conditionally calling panic() in add_taint()
|
||||
Format: <hex>[,nousertaint]
|
||||
Hexadecimal bitmask representing the set of TAINT flags
|
||||
@ -4103,6 +4089,20 @@
|
||||
panic_on_warn=1 panic() instead of WARN(). Useful to cause kdump
|
||||
on a WARN().
|
||||
|
||||
panic_print= Bitmask for printing system info when panic happens.
|
||||
User can chose combination of the following bits:
|
||||
bit 0: print all tasks info
|
||||
bit 1: print system memory info
|
||||
bit 2: print timer info
|
||||
bit 3: print locks info if CONFIG_LOCKDEP is on
|
||||
bit 4: print ftrace buffer
|
||||
bit 5: print all printk messages in buffer
|
||||
bit 6: print all CPUs backtrace (if available in the arch)
|
||||
*Be aware* that this option may print a _lot_ of lines,
|
||||
so there are risks of losing older messages in the log.
|
||||
Use this option carefully, maybe worth to setup a
|
||||
bigger log buffer with "log_buf_len" along with this.
|
||||
|
||||
parkbd.port= [HW] Parallel port number the keyboard adapter is
|
||||
connected to, default is 0.
|
||||
Format: <parport#>
|
||||
@ -4222,7 +4222,7 @@
|
||||
mode 0, bit 1 is for mode 1, and so on. Mode 0 only
|
||||
allowed by default.
|
||||
|
||||
pause_on_oops=
|
||||
pause_on_oops=<int>
|
||||
Halt all CPUs after the first oops has been printed for
|
||||
the specified number of seconds. This is to be used if
|
||||
your oopses keep scrolling off the screen.
|
||||
|
||||
@ -99,7 +99,7 @@ Root
|
||||
|
||||
The root of the DAMON sysfs interface is ``<sysfs>/kernel/mm/damon/``, and it
|
||||
has one directory named ``admin``. The directory contains the files for
|
||||
privileged user space programs' control of DAMON. User space tools or deamons
|
||||
privileged user space programs' control of DAMON. User space tools or daemons
|
||||
having the root permission could use this directory.
|
||||
|
||||
kdamonds/
|
||||
@ -413,7 +413,7 @@ be used for online analysis or tuning of the schemes.
|
||||
The statistics can be retrieved by reading the files under ``stats`` directory
|
||||
(``nr_tried``, ``sz_tried``, ``nr_applied``, ``sz_applied``, and
|
||||
``qt_exceeds``), respectively. The files are not updated in real time, so you
|
||||
should ask DAMON sysfs interface to updte the content of the files for the
|
||||
should ask DAMON sysfs interface to update the content of the files for the
|
||||
stats by writing a special keyword, ``update_schemes_stats`` to the relevant
|
||||
``kdamonds/<N>/state`` file.
|
||||
|
||||
|
||||
@ -109,7 +109,7 @@ VMA Policy
|
||||
* A task may install a new VMA policy on a sub-range of a
|
||||
previously mmap()ed region. When this happens, Linux splits
|
||||
the existing virtual memory area into 2 or 3 VMAs, each with
|
||||
it's own policy.
|
||||
its own policy.
|
||||
|
||||
* By default, VMA policy applies only to pages allocated after
|
||||
the policy is installed. Any pages already faulted into the
|
||||
|
||||
@ -266,7 +266,7 @@ for which it has a public key. Otherwise, it will also load modules that are
|
||||
unsigned. Any module for which the kernel has a key, but which proves to have
|
||||
a signature mismatch will not be permitted to load.
|
||||
|
||||
Any module that has an unparseable signature will be rejected.
|
||||
Any module that has an unparsable signature will be rejected.
|
||||
|
||||
|
||||
=========================================
|
||||
|
||||
@ -59,7 +59,7 @@ times. In this case, there are the following two rules:
|
||||
the hardware is not available.
|
||||
|
||||
The result might be surprising. For example, the following two command
|
||||
lines have the same result:
|
||||
lines have the same result::
|
||||
|
||||
console=ttyS1,9600 console=tty0 console=tty1
|
||||
console=tty0 console=ttyS1,9600 console=tty1
|
||||
|
||||
@ -192,7 +192,7 @@ When mounting an XFS filesystem, the following options are accepted.
|
||||
are any integer multiple of a valid ``sunit`` value.
|
||||
|
||||
Typically the only time these mount options are necessary if
|
||||
after an underlying RAID device has had it's geometry
|
||||
after an underlying RAID device has had its geometry
|
||||
modified, such as adding a new disk to a RAID5 lun and
|
||||
reshaping it.
|
||||
|
||||
|
||||
@ -141,7 +141,7 @@ ST506 hard drives
|
||||
`*configure` harddrive set to 2). I've got an internal 20MB and a great
|
||||
big external 5.25" FH 64MB drive (who could ever want more :-) ).
|
||||
|
||||
I've just got 240K/s off it (a dd with bs=128k); thats about half of what
|
||||
I've just got 240K/s off it (a dd with bs=128k); that's about half of what
|
||||
RiscOS gets; but it's a heck of a lot better than the 50K/s I was getting
|
||||
last week :-)
|
||||
|
||||
|
||||
@ -78,9 +78,9 @@ IXP4xx provides two methods of accessing PCI memory space:
|
||||
1) A direct mapped window from 0x48000000 to 0x4bffffff (64MB).
|
||||
To access PCI via this space, we simply ioremap() the BAR
|
||||
into the kernel and we can use the standard read[bwl]/write[bwl]
|
||||
macros. This is the preffered method due to speed but it
|
||||
macros. This is the preferred method due to speed but it
|
||||
limits the system to just 64MB of PCI memory. This can be
|
||||
problamatic if using video cards and other memory-heavy devices.
|
||||
problematic if using video cards and other memory-heavy devices.
|
||||
|
||||
2) If > 64MB of memory space is required, the IXP4xx can be
|
||||
configured to use indirect registers to access PCI This allows
|
||||
|
||||
@ -5,7 +5,7 @@ Frequently asked questions about the sunxi clock system
|
||||
This document contains useful bits of information that people tend to ask
|
||||
about the sunxi clock system, as well as accompanying ASCII art when adequate.
|
||||
|
||||
Q: Why is the main 24MHz oscillator gatable? Wouldn't that break the
|
||||
Q: Why is the main 24MHz oscillator gateable? Wouldn't that break the
|
||||
system?
|
||||
|
||||
A: The 24MHz oscillator allows gating to save power. Indeed, if gated
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
Software emulation of deprecated SWP instruction (CONFIG_SWP_EMULATE)
|
||||
---------------------------------------------------------------------
|
||||
|
||||
ARMv6 architecture deprecates use of the SWP/SWPB instructions, and recommeds
|
||||
ARMv6 architecture deprecates use of the SWP/SWPB instructions, and recommends
|
||||
moving to the load-locked/store-conditional instructions LDREX and STREX.
|
||||
|
||||
ARMv7 multiprocessing extensions introduce the ability to disable these
|
||||
|
||||
@ -71,7 +71,7 @@ in <asm/tcm.h>. Using this interface it is possible to:
|
||||
|
||||
- Have the remaining TCM RAM added to a special
|
||||
allocation pool with gen_pool_create() and gen_pool_add()
|
||||
and provice tcm_alloc() and tcm_free() for this
|
||||
and provide tcm_alloc() and tcm_free() for this
|
||||
memory. Such a heap is great for things like saving
|
||||
device state when shutting off device power domains.
|
||||
|
||||
|
||||
@ -50,7 +50,7 @@ The stub populates the FDT /chosen node with (and the kernel scans for) the
|
||||
following parameters:
|
||||
|
||||
========================== ====== ===========================================
|
||||
Name Size Description
|
||||
Name Type Description
|
||||
========================== ====== ===========================================
|
||||
linux,uefi-system-table 64-bit Physical address of the UEFI System Table.
|
||||
|
||||
@ -67,4 +67,6 @@ linux,uefi-mmap-desc-ver 32-bit Version of the mmap descriptor format.
|
||||
|
||||
kaslr-seed 64-bit Entropy used to randomize the kernel image
|
||||
base address location.
|
||||
|
||||
bootargs String Kernel command line
|
||||
========================== ====== ===========================================
|
||||
|
||||
@ -155,7 +155,7 @@ the basic algorithm:
|
||||
optimisation.
|
||||
|
||||
If there are too many CPUs to read the currently_voting array in
|
||||
one transaction then multiple transations are still required. The
|
||||
one transaction then multiple transactions are still required. The
|
||||
implementation uses a simple loop of word-sized loads for this
|
||||
case. The number of transactions is still fewer than would be
|
||||
required if bytes were loaded individually.
|
||||
|
||||
@ -45,7 +45,7 @@ APMT Signature Reserved (signature == "APMT")
|
||||
|
||||
**Arm Performance Monitoring Table**
|
||||
|
||||
This table describes the properties of PMU support implmented by
|
||||
This table describes the properties of PMU support implemented by
|
||||
components in the system.
|
||||
|
||||
BERT Section 18.3 (signature == "BERT")
|
||||
|
||||
@ -99,7 +99,7 @@ to replace the kernel.
|
||||
|
||||
When a Linux driver or subsystem is first implemented using ACPI, it by
|
||||
definition ends up requiring a specific version of the ACPI specification
|
||||
-- it's baseline. ACPI firmware must continue to work, even though it may
|
||||
-- its baseline. ACPI firmware must continue to work, even though it may
|
||||
not be optimal, with the earliest kernel version that first provides support
|
||||
for that baseline version of ACPI. There may be a need for additional drivers,
|
||||
but adding new functionality (e.g., CPU power management) should not break
|
||||
|
||||
@ -13,9 +13,9 @@ implementation.
|
||||
arm/index
|
||||
arm64/index
|
||||
ia64/index
|
||||
../loongarch/index
|
||||
loongarch/index
|
||||
m68k/index
|
||||
../mips/index
|
||||
mips/index
|
||||
nios2/index
|
||||
openrisc/index
|
||||
parisc/index
|
||||
|
||||
@ -106,7 +106,7 @@ History
|
||||
a much improved version with changes all around.
|
||||
|
||||
10-04-2004 Matjaz Breskvar (phoenix@bsemi.com)
|
||||
alot of bugfixes all over.
|
||||
a lot of bugfixes all over.
|
||||
ethernet support, functional http and telnet servers.
|
||||
running many standard linux apps.
|
||||
|
||||
@ -114,7 +114,7 @@ History
|
||||
port to 2.6.x
|
||||
|
||||
30-11-2004 Matjaz Breskvar (phoenix@bsemi.com)
|
||||
lots of bugfixes and enhancments.
|
||||
lots of bugfixes and enhancements.
|
||||
added opencores framebuffer driver.
|
||||
|
||||
09-10-2010 Jonas Bonn (jonas@southpole.se)
|
||||
|
||||
@ -422,7 +422,7 @@ Configure the guest's AP resources
|
||||
Configuring the AP resources for a KVM guest will be performed when the
|
||||
VFIO_GROUP_NOTIFY_SET_KVM notifier callback is invoked. The notifier
|
||||
function is called when userspace connects to KVM. The guest's AP resources are
|
||||
configured via it's APCB by:
|
||||
configured via its APCB by:
|
||||
|
||||
* Setting the bits in the APM corresponding to the APIDs assigned to the
|
||||
vfio_ap mediated device via its 'assign_adapter' interface.
|
||||
|
||||
@ -1105,7 +1105,7 @@ The kernel command line should not be located below the real-mode
|
||||
code, nor should it be located in high memory.
|
||||
|
||||
|
||||
Sample Boot Configuartion
|
||||
Sample Boot Configuration
|
||||
=========================
|
||||
|
||||
As a sample configuration, assume the following layout of the real
|
||||
|
||||
@ -32,7 +32,7 @@ mechanisms to detect split locks and bus locks.
|
||||
--------------------------------------
|
||||
|
||||
Beginning with the Tremont Atom CPU split lock operations may raise an
|
||||
Alignment Check (#AC) exception when a split lock operation is attemped.
|
||||
Alignment Check (#AC) exception when a split lock operation is attempted.
|
||||
|
||||
#DB exception for bus lock detection
|
||||
------------------------------------
|
||||
|
||||
@ -60,7 +60,7 @@ needed for exploiting MDS requires:
|
||||
data
|
||||
|
||||
The existence of such a construct in the kernel cannot be excluded with
|
||||
100% certainty, but the complexity involved makes it extremly unlikely.
|
||||
100% certainty, but the complexity involved makes it extremely unlikely.
|
||||
|
||||
There is one exception, which is untrusted BPF. The functionality of
|
||||
untrusted BPF is limited, but it needs to be thoroughly investigated
|
||||
|
||||
@ -245,7 +245,7 @@ SGX will likely become unusable because the memory available to SGX is
|
||||
limited. However, while this may be fatal to SGX, the rest of the kernel
|
||||
is unlikely to be impacted and should continue to work.
|
||||
|
||||
As a result, when this happpens, user should stop running any new
|
||||
As a result, when this happens, user should stop running any new
|
||||
SGX workloads, (or just any new workloads), and migrate all valuable
|
||||
workloads. Although a machine reboot can recover all EPC memory, the bug
|
||||
should be reported to Linux developers.
|
||||
|
||||
@ -23,7 +23,7 @@ doing a Cached (WB) transaction and use the Memory RCW for un-cached
|
||||
operations.
|
||||
|
||||
For systems without an coherent cache controller, non-MX, we always
|
||||
use the memory controllers RCW, thought non-MX controlers likely
|
||||
use the memory controllers RCW, though non-MX controllers likely
|
||||
support the Internal Operation.
|
||||
|
||||
CUSTOMER-WARNING:
|
||||
|
||||
@ -209,7 +209,7 @@ will require extra work due to the application tag.
|
||||
sector must be set, and the bio should have all data pages
|
||||
added. It is up to the caller to ensure that the bio does not
|
||||
change while I/O is in progress.
|
||||
Complete bio with error if prepare failed for some reson.
|
||||
Complete bio with error if prepare failed for some reason.
|
||||
|
||||
|
||||
5.3 Passing Existing Integrity Metadata
|
||||
|
||||
@ -238,7 +238,7 @@ The's IO is assigned by a unique tag, which is 1:1 mapping with IO
|
||||
request of ``/dev/ublkb*``.
|
||||
|
||||
UAPI structure of ``ublksrv_io_desc`` is defined for describing each IO from
|
||||
the driver. A fixed mmaped area (array) on ``/dev/ublkc*`` is provided for
|
||||
the driver. A fixed mmapped area (array) on ``/dev/ublkc*`` is provided for
|
||||
exporting IO info to the server; such as IO offset, length, OP/flags and
|
||||
buffer address. Each ``ublksrv_io_desc`` instance can be indexed via queue id
|
||||
and IO tag directly.
|
||||
|
||||
@ -364,7 +364,7 @@ can be used to query the contents of cpumasks.
|
||||
----
|
||||
|
||||
Some example usages of these querying kfuncs were shown above. We will not
|
||||
replicate those exmaples here. Note, however, that all of the aforementioned
|
||||
replicate those examples here. Note, however, that all of the aforementioned
|
||||
kfuncs are tested in `tools/testing/selftests/bpf/progs/cpumask_success.c`_, so
|
||||
please take a look there if you're looking for more examples of how they can be
|
||||
used.
|
||||
|
||||
@ -23,7 +23,7 @@ Introduction
|
||||
|
||||
The BPF map API has historically been the main way to expose data structures
|
||||
of various types for use within BPF programs. Some data structures fit naturally
|
||||
with the map API (HASH, ARRAY), others less so. Consequentially, programs
|
||||
with the map API (HASH, ARRAY), others less so. Consequently, programs
|
||||
interacting with the latter group of data structures can be hard to parse
|
||||
for kernel programmers without previous BPF experience.
|
||||
|
||||
|
||||
@ -264,7 +264,7 @@ The following control flow is implemented (simplified excerpt)::
|
||||
desc->irq_data.chip->irq_unmask();
|
||||
desc->status &= ~pending;
|
||||
handle_irq_event(desc->action);
|
||||
} while (status & pending);
|
||||
} while (desc->status & pending);
|
||||
desc->status &= ~running;
|
||||
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ title: Ingenic SoCs Timer/Counter Unit (TCU)
|
||||
|
||||
description: |
|
||||
For a description of the TCU hardware and drivers, have a look at
|
||||
Documentation/mips/ingenic-tcu.rst.
|
||||
Documentation/arch/mips/ingenic-tcu.rst.
|
||||
|
||||
maintainers:
|
||||
- Paul Cercueil <paul@crapouillou.net>
|
||||
|
||||
@ -151,9 +151,9 @@ named ``Return``.
|
||||
line breaks, so if you try to format some text nicely, as in::
|
||||
|
||||
* Return:
|
||||
* 0 - OK
|
||||
* -EINVAL - invalid argument
|
||||
* -ENOMEM - out of memory
|
||||
* %0 - OK
|
||||
* %-EINVAL - invalid argument
|
||||
* %-ENOMEM - out of memory
|
||||
|
||||
this will all run together and produce::
|
||||
|
||||
@ -163,8 +163,8 @@ named ``Return``.
|
||||
ReST list, e. g.::
|
||||
|
||||
* Return:
|
||||
* * 0 - OK to runtime suspend the device
|
||||
* * -EBUSY - Device should not be runtime suspended
|
||||
* * %0 - OK to runtime suspend the device
|
||||
* * %-EBUSY - Device should not be runtime suspended
|
||||
|
||||
#) If the descriptive text you provide has lines that begin with
|
||||
some phrase followed by a colon, each of those phrases will be taken
|
||||
|
||||
@ -15,8 +15,8 @@ Driver device table
|
||||
:no-identifiers: pci_device_id
|
||||
|
||||
|
||||
Delaying, scheduling, and timer routines
|
||||
----------------------------------------
|
||||
Delaying and scheduling routines
|
||||
--------------------------------
|
||||
|
||||
.. kernel-doc:: include/linux/sched.h
|
||||
:internal:
|
||||
@ -33,16 +33,16 @@ Delaying, scheduling, and timer routines
|
||||
.. kernel-doc:: include/linux/completion.h
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: kernel/time/timer.c
|
||||
:export:
|
||||
Time and timer routines
|
||||
-----------------------
|
||||
|
||||
Wait queues and Wake events
|
||||
---------------------------
|
||||
|
||||
.. kernel-doc:: include/linux/wait.h
|
||||
.. kernel-doc:: include/linux/jiffies.h
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: kernel/sched/wait.c
|
||||
.. kernel-doc:: kernel/time/time.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: kernel/time/timer.c
|
||||
:export:
|
||||
|
||||
High-resolution timers
|
||||
@ -57,6 +57,15 @@ High-resolution timers
|
||||
.. kernel-doc:: kernel/time/hrtimer.c
|
||||
:export:
|
||||
|
||||
Wait queues and Wake events
|
||||
---------------------------
|
||||
|
||||
.. kernel-doc:: include/linux/wait.h
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: kernel/sched/wait.c
|
||||
:export:
|
||||
|
||||
Internal Functions
|
||||
------------------
|
||||
|
||||
|
||||
@ -8,12 +8,24 @@ The Basic Device Driver-Model Structures
|
||||
:internal:
|
||||
:no-identifiers: device_link_state
|
||||
|
||||
.. kernel-doc:: include/linux/device/bus.h
|
||||
:identifiers: bus_type bus_notifier_event
|
||||
|
||||
.. kernel-doc:: include/linux/device/class.h
|
||||
:identifiers: class
|
||||
|
||||
.. kernel-doc:: include/linux/device/driver.h
|
||||
:identifiers: probe_type device_driver
|
||||
|
||||
Device Drivers Base
|
||||
-------------------
|
||||
|
||||
.. kernel-doc:: drivers/base/init.c
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: include/linux/device/driver.h
|
||||
:no-identifiers: probe_type device_driver
|
||||
|
||||
.. kernel-doc:: drivers/base/driver.c
|
||||
:export:
|
||||
|
||||
@ -23,6 +35,9 @@ Device Drivers Base
|
||||
.. kernel-doc:: drivers/base/syscore.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: include/linux/device/class.h
|
||||
:no-identifiers: class
|
||||
|
||||
.. kernel-doc:: drivers/base/class.c
|
||||
:export:
|
||||
|
||||
@ -41,6 +56,9 @@ Device Drivers Base
|
||||
.. kernel-doc:: drivers/base/platform.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: include/linux/device/bus.h
|
||||
:no-identifiers: bus_type bus_notifier_event
|
||||
|
||||
.. kernel-doc:: drivers/base/bus.c
|
||||
:export:
|
||||
|
||||
|
||||
@ -243,7 +243,7 @@ proc entries
|
||||
Error Injectable Functions
|
||||
--------------------------
|
||||
|
||||
This part is for the kenrel developers considering to add a function to
|
||||
This part is for the kernel developers considering to add a function to
|
||||
ALLOW_ERROR_INJECTION() macro.
|
||||
|
||||
Requirements for the Error Injectable Functions
|
||||
|
||||
@ -9,7 +9,7 @@ works:
|
||||
|
||||
- userspace app like Xfbdev mmaps framebuffer
|
||||
- deferred IO and driver sets up fault and page_mkwrite handlers
|
||||
- userspace app tries to write to mmaped vaddress
|
||||
- userspace app tries to write to mmapped vaddress
|
||||
- we get pagefault and reach fault handler
|
||||
- fault handler finds and returns physical page
|
||||
- we get page_mkwrite where we add this page to a list
|
||||
|
||||
@ -31,5 +31,5 @@ Missing Features
|
||||
================
|
||||
(alias TODO list)
|
||||
|
||||
* 2D acceleratrion
|
||||
* 2D acceleration
|
||||
* dual-head support
|
||||
|
||||
@ -73,7 +73,7 @@ Module insertion
|
||||
the device will be /dev/fb0. You can check this by doing a
|
||||
cat /proc/fb. You can find a copy of con2fb in tools/ directory.
|
||||
if you don't have another fb device, this step is superfluous,
|
||||
as the console subsystem automagicaly binds ttys to the fb.
|
||||
as the console subsystem automagically binds ttys to the fb.
|
||||
#. switch to the virtual console you just mapped. "tadaaa" ...
|
||||
|
||||
Module removal
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
#
|
||||
# Feature name: thread-info-in-task
|
||||
# Kconfig: THREAD_INFO_IN_TASK
|
||||
# description: arch makes use of the core kernel facility to embedd thread_info in task_struct
|
||||
# description: arch makes use of the core kernel facility to embed thread_info in task_struct
|
||||
#
|
||||
-----------------------
|
||||
| arch |status|
|
||||
|
||||
@ -13,7 +13,7 @@
|
||||
| csky: | ok |
|
||||
| hexagon: | TODO |
|
||||
| ia64: | TODO |
|
||||
| loongarch: | TODO |
|
||||
| loongarch: | ok |
|
||||
| m68k: | TODO |
|
||||
| microblaze: | TODO |
|
||||
| mips: | TODO |
|
||||
|
||||
@ -13,7 +13,7 @@
|
||||
| csky: | ok |
|
||||
| hexagon: | TODO |
|
||||
| ia64: | ok |
|
||||
| loongarch: | TODO |
|
||||
| loongarch: | ok |
|
||||
| m68k: | TODO |
|
||||
| microblaze: | TODO |
|
||||
| mips: | ok |
|
||||
|
||||
@ -13,7 +13,7 @@
|
||||
| csky: | ok |
|
||||
| hexagon: | TODO |
|
||||
| ia64: | ok |
|
||||
| loongarch: | TODO |
|
||||
| loongarch: | ok |
|
||||
| m68k: | TODO |
|
||||
| microblaze: | TODO |
|
||||
| mips: | ok |
|
||||
|
||||
@ -13,7 +13,7 @@
|
||||
| csky: | ok |
|
||||
| hexagon: | TODO |
|
||||
| ia64: | TODO |
|
||||
| loongarch: | TODO |
|
||||
| loongarch: | ok |
|
||||
| m68k: | TODO |
|
||||
| microblaze: | TODO |
|
||||
| mips: | ok |
|
||||
|
||||
@ -13,7 +13,7 @@
|
||||
| csky: | ok |
|
||||
| hexagon: | TODO |
|
||||
| ia64: | TODO |
|
||||
| loongarch: | TODO |
|
||||
| loongarch: | ok |
|
||||
| m68k: | TODO |
|
||||
| microblaze: | TODO |
|
||||
| mips: | ok |
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
| mips: | ok |
|
||||
| nios2: | TODO |
|
||||
| openrisc: | ok |
|
||||
| parisc: | TODO |
|
||||
| parisc: | ok |
|
||||
| powerpc: | ok |
|
||||
| riscv: | ok |
|
||||
| s390: | ok |
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
#
|
||||
# Feature name: ELF-ASLR
|
||||
# Kconfig: ARCH_HAS_ELF_RANDOMIZE
|
||||
# Kconfig: ARCH_WANT_DEFAULT_TOPDOWN_MMAP_LAYOUT
|
||||
# description: arch randomizes the stack, heap and binary images of ELF binaries
|
||||
#
|
||||
-----------------------
|
||||
@ -10,10 +11,10 @@
|
||||
| arc: | TODO |
|
||||
| arm: | ok |
|
||||
| arm64: | ok |
|
||||
| csky: | TODO |
|
||||
| csky: | ok |
|
||||
| hexagon: | TODO |
|
||||
| ia64: | TODO |
|
||||
| loongarch: | TODO |
|
||||
| loongarch: | ok |
|
||||
| m68k: | TODO |
|
||||
| microblaze: | TODO |
|
||||
| mips: | ok |
|
||||
|
||||
@ -79,7 +79,7 @@ Options
|
||||
|
||||
cache=mode specifies a caching policy. By default, no caches are used.
|
||||
The mode can be specified as a bitmask or by using one of the
|
||||
prexisting common 'shortcuts'.
|
||||
preexisting common 'shortcuts'.
|
||||
The bitmask is described below: (unspecified bits are reserved)
|
||||
|
||||
========== ====================================================
|
||||
|
||||
@ -44,7 +44,7 @@ options::
|
||||
|
||||
CONFIG_AF_RXRPC - The RxRPC protocol transport
|
||||
CONFIG_RXKAD - The RxRPC Kerberos security handler
|
||||
CONFIG_AFS - The AFS filesystem
|
||||
CONFIG_AFS_FS - The AFS filesystem
|
||||
|
||||
Additionally, the following can be turned on to aid debugging::
|
||||
|
||||
|
||||
@ -106,8 +106,8 @@ iocharset=xxx Use xxx as the name of the NLS translation table.
|
||||
debug The driver will output debugging information to the syslog.
|
||||
============= ===========================================================
|
||||
|
||||
How to Get Lastest Version
|
||||
==========================
|
||||
How to Get Latest Version
|
||||
=========================
|
||||
|
||||
The latest version is currently available at:
|
||||
<http://befs-driver.sourceforge.net/>
|
||||
|
||||
@ -416,7 +416,7 @@ process is the target of an operation by some other process (SIGKILL for
|
||||
example).
|
||||
|
||||
The subjective security holds the active security properties of a process, and
|
||||
may be overridden. This is not seen externally, and is used whan a process
|
||||
may be overridden. This is not seen externally, and is used when a process
|
||||
acts upon another object, for example SIGKILLing another process or opening a
|
||||
file.
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@ A filesystem would typically have a volume cookie for each superblock.
|
||||
|
||||
The filesystem then acquires a cookie for each file within that volume using an
|
||||
object key. Object keys are binary blobs and only need to be unique within
|
||||
their parent volume. The cache backend is reponsible for rendering the binary
|
||||
their parent volume. The cache backend is responsible for rendering the binary
|
||||
blob into something it can use and may employ hash tables, trees or whatever to
|
||||
improve its ability to find an object. This is transparent to the network
|
||||
filesystem.
|
||||
@ -91,7 +91,7 @@ actually required and it can use the fscache I/O API directly.
|
||||
Volume Registration
|
||||
===================
|
||||
|
||||
The first step for a network filsystem is to acquire a volume cookie for the
|
||||
The first step for a network filesystem is to acquire a volume cookie for the
|
||||
volume it wants to access::
|
||||
|
||||
struct fscache_volume *
|
||||
@ -119,7 +119,7 @@ is provided. If the coherency data doesn't match, the entire cache volume will
|
||||
be invalidated.
|
||||
|
||||
This function can return errors such as EBUSY if the volume key is already in
|
||||
use by an acquired volume or ENOMEM if an allocation failure occured. It may
|
||||
use by an acquired volume or ENOMEM if an allocation failure occurred. It may
|
||||
also return a NULL volume cookie if fscache is not enabled. It is safe to
|
||||
pass a NULL cookie to any function that takes a volume cookie. This will
|
||||
cause that function to do nothing.
|
||||
|
||||
@ -253,7 +253,7 @@ to be used.
|
||||
If binary attribute is readable and the config_item provides a
|
||||
ct_item_ops->read_bin_attribute() method, that method will be called
|
||||
whenever userspace asks for a read(2) on the attribute. The converse
|
||||
will happen for write(2). The reads/writes are bufferred so only a
|
||||
will happen for write(2). The reads/writes are buffered so only a
|
||||
single read/write will occur; the attributes' need not concern itself
|
||||
with it.
|
||||
|
||||
|
||||
@ -291,7 +291,7 @@ The DAX code does not work correctly on architectures which have virtually
|
||||
mapped caches such as ARM, MIPS and SPARC.
|
||||
|
||||
Calling :c:func:`get_user_pages()` on a range of user memory that has been
|
||||
mmaped from a `DAX` file will fail when there are no 'struct page' to describe
|
||||
mmapped from a `DAX` file will fail when there are no 'struct page' to describe
|
||||
those pages. This problem has been addressed in some device drivers
|
||||
by adding optional struct page support for pages under the control of
|
||||
the driver (see `CONFIG_NVDIMM_PFN` in ``drivers/nvdimm`` for an example of
|
||||
|
||||
@ -5,8 +5,8 @@ The Devpts Filesystem
|
||||
=====================
|
||||
|
||||
Each mount of the devpts filesystem is now distinct such that ptys
|
||||
and their indicies allocated in one mount are independent from ptys
|
||||
and their indicies in all other mounts.
|
||||
and their indices allocated in one mount are independent from ptys
|
||||
and their indices in all other mounts.
|
||||
|
||||
All mounts of the devpts filesystem now create a ``/dev/pts/ptmx`` node
|
||||
with permissions ``0000``.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user