data_type large_stringclasses 3
values | source large_stringclasses 29
values | code large_stringlengths 98 49.4M | filepath large_stringlengths 5 161 ⌀ | message large_stringclasses 234
values | commit large_stringclasses 234
values | subject large_stringclasses 418
values | critique large_stringlengths 101 1.26M ⌀ | metadata dict |
|---|---|---|---|---|---|---|---|---|
source | linux | ==============================
HD-Audio Codec-Specific Models
==============================
ALC880
======
3stack
3-jack in back and a headphone out
3stack-digout
3-jack in back, a HP out and a SPDIF out
5stack
5-jack in back, 2-jack in front
5stack-digout
5-jack in back, 2-jack in front, a SPDIF out
6... | Documentation/sound/hd-audio/models.rst | null | null | null | null | null |
source | linux | =============================
More Notes on HD-Audio Driver
=============================
Takashi Iwai <tiwai@suse.de>
General
=======
HD-audio is the new standard on-board audio component on modern PCs
after AC97. Although Linux has been supporting HD-audio since long
time ago, there are often problems with new m... | Documentation/sound/hd-audio/notes.rst | null | null | null | null | null |
source | linux | ===============================
Realtek PC Beep Hidden Register
===============================
This file documents the "PC Beep Hidden Register", which is present in certain
Realtek HDA codecs and controls a muxer and pair of passthrough mixers that can
route audio between pins but aren't themselves exposed as HDA wi... | Documentation/sound/hd-audio/realtek-pc-beep.rst | null | null | null | null | null |
source | linux | ===================
The ALSA Driver API
===================
Management of Cards and Devices
===============================
Card Management
---------------
.. kernel-doc:: sound/core/init.c
Device Components
-----------------
.. kernel-doc:: sound/core/device.c
Module requests and Device File Entries
--------------... | Documentation/sound/kernel-api/alsa-driver-api.rst | null | null | null | null | null |
source | linux | ALSA Kernel API Documentation
=============================
.. toctree::
:maxdepth: 2
alsa-driver-api
writing-an-alsa-driver | Documentation/sound/kernel-api/index.rst | null | null | null | null | null |
source | linux | ======================
Writing an ALSA Driver
======================
:Author: Takashi Iwai <tiwai@suse.de>
Preface
=======
This document describes how to write an `ALSA (Advanced Linux Sound
Architecture) <http://www.alsa-project.org/>`__ driver. The document
focuses mainly on PCI soundcards. In the case of other de... | Documentation/sound/kernel-api/writing-an-alsa-driver.rst | null | null | null | null | null |
source | linux | ==============
Audio Clocking
==============
This text describes the audio clocking terms in ASoC and digital audio in
general. Note: Audio clocking can be complex!
Master Clock
------------
Every audio subsystem is driven by a master clock (sometimes referred to as MCLK
or SYSCLK). This audio master clock can be d... | Documentation/sound/soc/clocking.rst | null | null | null | null | null |
source | linux | ==============================================
Creating codec to codec dai link for ALSA dapm
==============================================
Mostly the flow of audio is always from CPU to codec so your system
will look as below:
::
--------- ---------
| | dai | |
CPU ------->... | Documentation/sound/soc/codec-to-codec.rst | null | null | null | null | null |
source | linux | =======================
ASoC Codec Class Driver
=======================
The codec class driver is generic and hardware independent code that configures
the codec, FM, MODEM, BT or external DSP to provide audio capture and playback.
It should contain no code that is specific to the target platform or machine.
All platf... | Documentation/sound/soc/codec.rst | null | null | null | null | null |
source | linux | ==================================
ASoC Digital Audio Interface (DAI)
==================================
ASoC currently supports the three main Digital Audio Interfaces (DAI) found on
SoC controllers and portable audio CODECs today, namely AC97, I2S and PCM.
AC97
====
AC97 is a five wire interface commonly found on... | Documentation/sound/soc/dai.rst | null | null | null | null | null |
source | linux | ===================================================
Dynamic Audio Power Management for Portable Devices
===================================================
Description
===========
Dynamic Audio Power Management (DAPM) is designed to allow portable
Linux devices to use the minimum amount of power within the audio
subs... | Documentation/sound/soc/dapm.rst | null | null | null | null | null |
source | linux | ===========
Dynamic PCM
===========
Description
===========
Dynamic PCM allows an ALSA PCM device to digitally route its PCM audio to
various digital endpoints during the PCM stream runtime. e.g. PCM0 can route
digital audio to I2S DAI0, I2S DAI1 or PDM DAI2. This is useful for on SoC DSP
drivers that expose several ... | Documentation/sound/soc/dpcm.rst | null | null | null | null | null |
source | linux | ==============
ALSA SoC Layer
==============
The documentation is spilt into the following sections:-
.. toctree::
:maxdepth: 2
overview
codec
dai
dapm
platform
machine
pops-clicks
clocking
jack
dpcm
codec-to-codec
usb | Documentation/sound/soc/index.rst | null | null | null | null | null |
source | linux | ===================
ASoC jack detection
===================
ALSA has a standard API for representing physical jacks to user space,
the kernel side of which can be seen in include/sound/jack.h. ASoC
provides a version of this API adding two additional features:
- It allows more than one jack detection method to work... | Documentation/sound/soc/jack.rst | null | null | null | null | null |
source | linux | ===================
ASoC Machine Driver
===================
The ASoC machine (or board) driver is the code that glues together all the
component drivers (e.g. codecs, platforms and DAIs). It also describes the
relationships between each component which include audio paths, GPIOs,
interrupts, clocking, jacks and voltag... | Documentation/sound/soc/machine.rst | null | null | null | null | null |
source | linux | =======================
ALSA SoC Layer Overview
=======================
The overall project goal of the ALSA System on Chip (ASoC) layer is to
provide better ALSA support for embedded system-on-chip processors (e.g.
pxa2xx, au1x00, iMX, etc) and portable audio codecs. Prior to the ASoC
subsystem there was some suppor... | Documentation/sound/soc/overview.rst | null | null | null | null | null |
source | linux | ====================
ASoC Platform Driver
====================
An ASoC platform driver class can be divided into audio DMA drivers, SoC DAI
drivers and DSP drivers. The platform drivers only target the SoC CPU and must
have no board specific code.
Audio DMA
=========
The platform DMA driver optionally supports the f... | Documentation/sound/soc/platform.rst | null | null | null | null | null |
source | linux | =====================
Audio Pops and Clicks
=====================
Pops and clicks are unwanted audio artifacts caused by the powering up and down
of components within the audio subsystem. This is noticeable on PCs when an
audio module is either loaded or unloaded (at module load time the sound card is
powered up and c... | Documentation/sound/soc/pops-clicks.rst | null | null | null | null | null |
source | linux | ================
ASoC USB support
================
Overview
========
In order to leverage the existing USB sound device support in ALSA, the
ASoC USB APIs are introduced to allow the subsystems to exchange
configuration information.
One potential use case would be to support USB audio offloading, which is
an implemen... | Documentation/sound/soc/usb.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. This file is included in subproject root documents in conf.py
Indices
=======
* :ref:`genindex` | Documentation/sphinx-includes/subproject-index.rst | null | null | null | null | null |
source | linux | # SPDX-License-Identifier: GPL-2.0
alabaster >=0.7,<0.8
docutils>=0.15,<0.18
jinja2>=2.3,<3.1
PyYAML>=5.1,<6.1
Sphinx==3.4.3
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.1
sphinxcontrib-htmlhelp==1.0.3
sphinxcontrib-qthelp==1.0.2
sphinxcontrib-serializinghtml==1.1.4 | Documentation/sphinx/min_requirements.txt | null | null | null | null | null |
source | linux | ===================================================
spi_butterfly - parport-to-butterfly adapter driver
===================================================
This is a hardware and software project that includes building and using
a parallel port adapter cable, together with an "AVR Butterfly" to run
firmware for user i... | Documentation/spi/butterfly.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=================================
Serial Peripheral Interface (SPI)
=================================
.. toctree::
:maxdepth: 1
spi-summary
spidev
multiple-data-lanes
butterfly
spi-lm70llp
spi-sc18is602 | Documentation/spi/index.rst | null | null | null | null | null |
source | linux | ====================================
SPI devices with multiple data lanes
====================================
Some specialized SPI controllers and peripherals support multiple data lanes
that allow reading more than one word at a time in parallel. This is different
from dual/quad/octal SPI where multiple bits of a si... | Documentation/spi/multiple-data-lanes.rst | null | null | null | null | null |
source | linux | ==============================================
spi_lm70llp : LM70-LLP parport-to-SPI adapter
==============================================
Supported board/chip:
* National Semiconductor LM70 LLP evaluation board
Datasheet: https://www.ti.com/lit/gpn/lm70
Author:
Kaiwan N Billimoria <kaiwan@designerg... | Documentation/spi/spi-lm70llp.rst | null | null | null | null | null |
source | linux | ===========================
Kernel driver spi-sc18is602
===========================
Supported chips:
* NXP SI18IS602/602B/603
Datasheet: https://www.nxp.com/documents/data_sheet/SC18IS602_602B_603.pdf
Author:
Guenter Roeck <linux@roeck-us.net>
Description
-----------
This driver provides connects a... | Documentation/spi/spi-sc18is602.rst | null | null | null | null | null |
source | linux | ====================================
Overview of Linux kernel SPI support
====================================
02-Feb-2012
What is SPI?
------------
The "Serial Peripheral Interface" (SPI) is a synchronous four wire serial
link used to connect microcontrollers to sensors, memory, and peripherals.
It's a simple "de fa... | Documentation/spi/spi-summary.rst | null | null | null | null | null |
source | linux | =================
SPI userspace API
=================
SPI devices have a limited userspace API, supporting basic half-duplex
read() and write() access to SPI slave devices. Using ioctl() requests,
full duplex transfers and device I/O configuration are also available.
::
#include <fcntl.h>
#include <unistd.h>
#in... | Documentation/spi/spidev.rst | null | null | null | null | null |
source | linux | =================================
Brief tutorial on CRC computation
=================================
A CRC is a long-division remainder. You add the CRC to the message,
and the whole thing (message+CRC) is a multiple of the given
CRC polynomial. To check the CRC, you can either check that the
CRC matches the recomp... | Documentation/staging/crc32.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Unsorted Documentation
======================
.. toctree::
:maxdepth: 2
crc32
lzo
magic-number
remoteproc
rpmsg
speculation
static-keys
xz | Documentation/staging/index.rst | null | null | null | null | null |
source | linux | ===========================================================
LZO stream format as understood by Linux's LZO decompressor
===========================================================
Introduction
============
This is not a specification. No specification seems to be publicly available
for the LZO stream format. This... | Documentation/staging/lzo.rst | null | null | null | null | null |
source | linux | .. _magicnumbers:
Linux magic numbers
===================
This file is a registry of magic numbers which are in use. When you
add a magic number to a structure, you should also add it to this
file, since it is best if the magic numbers used by various structures
are unique.
It is a **very** good idea to protect ker... | Documentation/staging/magic-number.rst | null | null | null | null | null |
source | linux | ==========================
Remote Processor Framework
==========================
Introduction
============
Modern SoCs typically have heterogeneous remote processor devices in asymmetric
multiprocessing (AMP) configurations, which may be running different instances
of operating system, whether it's Linux or any other... | Documentation/staging/remoteproc.rst | null | null | null | null | null |
source | linux | ============================================
Remote Processor Messaging (rpmsg) Framework
============================================
.. note::
This document describes the rpmsg bus and how to write rpmsg drivers.
To learn how to add rpmsg support for new platforms, check out remoteproc.txt
(also a resident of... | Documentation/staging/rpmsg.rst | null | null | null | null | null |
source | linux | ===========
Speculation
===========
This document explains potential effects of speculation, and how undesirable
effects can be mitigated portably using common APIs.
------------------------------------------------------------------------------
To improve performance and minimize average latencies, many contemporary... | Documentation/staging/speculation.rst | null | null | null | null | null |
source | linux | ===========
Static Keys
===========
.. warning::
DEPRECATED API:
The use of 'struct static_key' directly, is now DEPRECATED. In addition
static_key_{true,false}() is also DEPRECATED. IE DO NOT use the following::
struct static_key false = STATIC_KEY_INIT_FALSE;
struct static_key true = STATIC_KEY_INIT_TR... | Documentation/staging/static-keys.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: 0BSD
============================
XZ data compression in Linux
============================
Introduction
============
XZ is a general purpose data compression format with high compression
ratio. The XZ decompressor in Linux is called XZ Embedded. It supports
the LZMA2 filter and optionall... | Documentation/staging/xz.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==================
TCM Virtual Device
==================
.. toctree::
:maxdepth: 1
tcmu-design
tcm_mod_builder
scripts | Documentation/target/index.rst | null | null | null | null | null |
source | linux | Target export device script
---------------------------
.. literalinclude:: target-export-device
:language: shell | Documentation/target/scripts.rst | null | null | null | null | null |
source | linux | =========================================
The TCM v4 fabric module script generator
=========================================
Greetings all,
This document is intended to be a mini-HOWTO for using the tcm_mod_builder.py
script to generate a brand new functional TCM v4 fabric .ko module of your very own,
that once buil... | Documentation/target/tcm_mod_builder.rst | null | null | null | null | null |
source | linux | ====================
TCM Userspace Design
====================
.. Contents:
1) Design
a) Background
b) Benefits
c) Design constraints
d) Implementation overview
i. Mailbox
ii. Command ring
iii. Data Area
e) Device discovery
f) Device events
g) Other conti... | Documentation/target/tcmu-design.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============================================
AMD-TEE (AMD's Trusted Execution Environment)
=============================================
The AMD-TEE driver handles the communication with AMD's TEE environment. The
TEE environment is provided by AMD Secure Processor.
The AMD Secur... | Documentation/tee/amd-tee.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============
TEE Subsystem
=============
.. toctree::
:maxdepth: 1
tee
op-tee
amd-tee
ts-tee
qtee | Documentation/tee/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
====================================================
OP-TEE (Open Portable Trusted Execution Environment)
====================================================
The OP-TEE driver handles OP-TEE [1] based TEEs. Currently it is only the ARM
TrustZone based OP-TEE solution that is suppo... | Documentation/tee/op-tee.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============================================
QTEE (Qualcomm Trusted Execution Environment)
=============================================
The QTEE driver handles communication with Qualcomm TEE [1].
The lowest level of communication with QTEE builds on the ARM SMC Calling
Conventi... | Documentation/tee/qtee.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===================================
TEE (Trusted Execution Environment)
===================================
This document describes the TEE subsystem in Linux.
Overview
========
A TEE is a trusted OS running in some secure environment, for example,
TrustZone on ARM CPUs, or a sep... | Documentation/tee/tee.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=================================
TS-TEE (Trusted Services project)
=================================
This driver provides access to secure services implemented by Trusted Services.
Trusted Services [1] is a TrustedFirmware.org project that provides a framework
for developing and ... | Documentation/tee/ts-tee.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Delay and sleep mechanisms
==========================
This document seeks to answer the common question: "What is the
RightWay (TM) to insert a delay?"
This question is most often faced by driver writers who have to
deal with hardware delays and who may not be the most intimately
... | Documentation/timers/delay_sleep_functions.rst | null | null | null | null | null |
source | linux | =====================================================
High resolution timers and dynamic ticks design notes
=====================================================
Further information can be found in the paper of the OLS 2006 talk "hrtimers
and beyond". The paper is part of the OLS 2006 Proceedings Volume 1, which can
b... | Documentation/timers/highres.rst | null | null | null | null | null |
source | linux | ===========================================
High Precision Event Timer Driver for Linux
===========================================
The High Precision Event Timer (HPET) hardware follows a specification
by Intel and Microsoft, revision 1.
Each HPET has one fixed-rate counter (at 10+ MHz, hence "High Precision")
and u... | Documentation/timers/hpet.rst | null | null | null | null | null |
source | linux | ======================================================
hrtimers - subsystem for high-resolution kernel timers
======================================================
This patch introduces a new subsystem for high-resolution kernel timers.
One might ask the question: we already have a timer subsystem
(kernel/timers.c),... | Documentation/timers/hrtimers.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
======
Timers
======
.. toctree::
:maxdepth: 1
highres
hpet
hrtimers
no_hz
timekeeping
delay_sleep_functions | Documentation/timers/index.rst | null | null | null | null | null |
source | linux | ======================================
NO_HZ: Reducing Scheduling-Clock Ticks
======================================
This document describes Kconfig options and boot parameters that can
reduce the number of scheduling-clock interrupts, thereby improving energy
efficiency and reducing OS jitter. Reducing OS jitter is... | Documentation/timers/no_hz.rst | null | null | null | null | null |
source | linux | ===========================================================
Clock sources, Clock events, sched_clock() and delay timers
===========================================================
This document tries to briefly explain some basic kernel timekeeping
abstractions. It partly pertains to the drivers usually found in
drive... | Documentation/timers/timekeeping.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
====================================
Documentation features parser module
====================================
.. automodule:: lib.python.feat.parse_features
:members:
:show-inheritance:
:undoc-members: | Documentation/tools/feat.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============
Kernel tools
============
This book covers user-space tools that are shipped with the kernel source;
more additions are needed here:
.. toctree::
:maxdepth: 1
rtla/index
rv/index
python | Documentation/tools/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=================
Job server module
=================
.. automodule:: lib.python.jobserver
:members:
:show-inheritance:
:undoc-members: | Documentation/tools/jobserver.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================================
Kernel ABI documentation tool modules
=====================================
.. toctree::
:maxdepth: 2
kabi_parser
kabi_regex
kabi_symbols
kabi_helpers | Documentation/tools/kabi.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=================
Ancillary classes
=================
.. automodule:: lib.python.abi.helpers
:members:
:member-order: bysource
:show-inheritance:
:undoc-members: | Documentation/tools/kabi_helpers.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================================
Kernel ABI documentation parser class
=====================================
.. automodule:: lib.python.abi.abi_parser
:members:
:show-inheritance:
:undoc-members: | Documentation/tools/kabi_parser.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============================
ABI regex search symbol class
=============================
.. automodule:: lib.python.abi.abi_regex
:members:
:show-inheritance:
:undoc-members: | Documentation/tools/kabi_regex.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=========================================
System ABI documentation validation class
=========================================
.. automodule:: lib.python.abi.system_symbols
:members:
:show-inheritance:
:undoc-members: | Documentation/tools/kabi_symbols.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==================
Kernel-doc modules
==================
.. toctree::
:maxdepth: 2
kdoc_parser
kdoc_output
kdoc_ancillary | Documentation/tools/kdoc.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=================
Ancillary classes
=================
Argparse formatter class
========================
.. automodule:: lib.python.kdoc.enrich_formatter
:members:
:show-inheritance:
:undoc-members:
Regular expression class handler
================================
.. aut... | Documentation/tools/kdoc_ancillary.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=======================
Kernel-doc output stage
=======================
Output handler for man pages and ReST
=====================================
.. automodule:: lib.python.kdoc.kdoc_output
:members:
:show-inheritance:
:undoc-members: | Documentation/tools/kdoc_output.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=======================
Kernel-doc parser stage
=======================
File handler classes
====================
.. automodule:: lib.python.kdoc.kdoc_files
:members:
:show-inheritance:
:undoc-members:
Parsed item data class
======================
.. automodule:: lib.py... | Documentation/tools/kdoc_parser.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
================
Python libraries
================
.. toctree::
:maxdepth: 4
jobserver
feat
kdoc
kabi | Documentation/tools/python.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
EXIT STATUS
===========
::
0 Passed: the test did not hit the stop tracing condition
1 Error: invalid argument
2 Failed: the test hit the stop tracing condition
REPORTING BUGS
==============
Report bugs to <linux-kernel@vger.kernel.org>
and <linux-trace-devel@vger.kernel.or... | Documentation/tools/rtla/common_appendix.txt | null | null | null | null | null |
source | linux | **-b**, **--bucket-size** *N*
Set the histogram bucket size (default *1*).
**-E**, **--entries** *N*
Set the number of entries of the histogram (default 256).
**--no-header**
Do not print header.
**--no-summary**
Do not print summary.
**--no-index**
Do not print index.
... | Documentation/tools/rtla/common_hist_options.txt | null | null | null | null | null |
source | linux | **-c**, **--cpus** *cpu-list*
Set the |tool| tracer to run the sample threads in the cpu-list.
By default, the |tool| tracer runs the sample threads on all CPUs.
**-H**, **--house-keeping** *cpu-list*
Run rtla control threads only on the given cpu-list.
If omitted, rtla will attempt... | Documentation/tools/rtla/common_options.txt | null | null | null | null | null |
source | linux | The **rtla osnoise** tool is an interface for the *osnoise* tracer. The
*osnoise* tracer dispatches a kernel thread per-cpu. These threads read the
time in a loop while with preemption, softirq and IRQs enabled, thus
allowing all the sources of operating system noise during its execution.
The *osnoise*'s tracer threads... | Documentation/tools/rtla/common_osnoise_description.txt | null | null | null | null | null |
source | linux | .. |threshold| replace:: **-a/--auto**, **-s/--stop**, or **-S/--stop-total**
.. |thresharg| replace:: -s
.. |tracer| replace:: osnoise
.. |actionsperf| replace::
Due to implementational limitations, actions might be delayed
up to one second after tracing is stopped.
**-a**, **--auto** *us*
... | Documentation/tools/rtla/common_osnoise_options.txt | null | null | null | null | null |
source | linux | **--dump-tasks**
prints the task running on all CPUs if stop conditions are met (depends on !--no-aa)
**--no-aa**
disable auto-analysis, reducing rtla timerlat cpu usage | Documentation/tools/rtla/common_timerlat_aa.txt | null | null | null | null | null |
source | linux | The **rtla timerlat** tool is an interface for the *timerlat* tracer. The
*timerlat* tracer dispatches a kernel thread per-cpu. These threads
set a periodic timer to wake themselves up and go back to sleep. After
the wakeup, they collect and generate useful information for the
debugging of operating system timer latenc... | Documentation/tools/rtla/common_timerlat_description.txt | null | null | null | null | null |
source | linux | .. |threshold| replace:: **-a/--auto**, **-i/--irq**, or **-T/--thread**
.. |thresharg| replace:: -T
.. |tracer| replace:: timerlat
.. |actionsperf| replace::
For time-sensitive actions, it is recommended to run **rtla timerlat** with BPF
support and RT priority. Note that due to implementational... | Documentation/tools/rtla/common_timerlat_options.txt | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
================================
The realtime Linux analysis tool
================================
RTLA provides a set of tools for the analysis of the kernel's realtime
behavior on specific hardware.
.. toctree::
:maxdepth: 1
rtla
rtla-osnoise
rtla-osnoise-hist
rt... | Documentation/tools/rtla/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. |tool| replace:: hwnoise
============
rtla-hwnoise
============
------------------------------------------
Detect and quantify hardware-related noise
------------------------------------------
:Manual section: 1
SYNOPSIS
========
**rtla hwnoise** [*OPTIONS*]
DESCRIPTION
====... | Documentation/tools/rtla/rtla-hwnoise.rst | null | null | null | null | null |
source | linux | .. |tool| replace:: osnoise hist
===================
rtla-osnoise-hist
===================
------------------------------------------------------
Display a histogram of the osnoise tracer samples
------------------------------------------------------
:Manual section: 1
SYNOPSIS
========
**rtla osnoise hist** [*OPTIO... | Documentation/tools/rtla/rtla-osnoise-hist.rst | null | null | null | null | null |
source | linux | .. |tool| replace:: osnoise top
===================
rtla-osnoise-top
===================
-----------------------------------------------
Display a summary of the operating system noise
-----------------------------------------------
:Manual section: 1
SYNOPSIS
========
**rtla osnoise top** [*OPTIONS*]
DESCRIPTION
=... | Documentation/tools/rtla/rtla-osnoise-top.rst | null | null | null | null | null |
source | linux | ===============
rtla-osnoise
===============
------------------------------------------------------------------
Measure the operating system noise
------------------------------------------------------------------
:Manual section: 1
SYNOPSIS
========
**rtla osnoise** [*MODE*] ...
DESCRIPTION
===========
.. include:... | Documentation/tools/rtla/rtla-osnoise.rst | null | null | null | null | null |
source | linux | .. |tool| replace:: timerlat hist
=====================
rtla-timerlat-hist
=====================
------------------------------------------------
Histograms of the operating system timer latency
------------------------------------------------
:Manual section: 1
SYNOPSIS
========
**rtla timerlat hist** [*OPTIONS*] .... | Documentation/tools/rtla/rtla-timerlat-hist.rst | null | null | null | null | null |
source | linux | .. |tool| replace:: timerlat top
====================
rtla-timerlat-top
====================
-------------------------------------------
Measures the operating system timer latency
-------------------------------------------
:Manual section: 1
SYNOPSIS
========
**rtla timerlat top** [*OPTIONS*] ...
DESCRIPTION
====... | Documentation/tools/rtla/rtla-timerlat-top.rst | null | null | null | null | null |
source | linux | ================
rtla-timerlat
================
-------------------------------------------
Measures the operating system timer latency
-------------------------------------------
:Manual section: 1
SYNOPSIS
========
**rtla timerlat** [*MODE*] ...
DESCRIPTION
===========
.. include:: common_timerlat_description.txt... | Documentation/tools/rtla/rtla-timerlat.rst | null | null | null | null | null |
source | linux | =========
rtla
=========
--------------------------------
Real-time Linux Analysis tool
--------------------------------
:Manual section: 1
SYNOPSIS
========
**rtla** *COMMAND* [*OPTIONS*]
DESCRIPTION
===========
The **rtla** is a meta-tool that includes a set of commands that aims to
analyze the real-time propertie... | Documentation/tools/rtla/rtla.rst | null | null | null | null | null |
source | linux | REPORTING BUGS
==============
Report bugs to <linux-kernel@vger.kernel.org>
and <linux-trace-devel@vger.kernel.org>
LICENSE
=======
**rv** is Free Software licensed under the GNU GPLv2
COPYING
=======
Copyright \(C) 2022 Red Hat, Inc. Free use of this software is granted under
the terms of the GNU Public License (... | Documentation/tools/rv/common_appendix.rst | null | null | null | null | null |
source | linux | **-h**, **--help**
Print the monitor's options and the available reactors list.
**-r**, **--reactor** *reactor*
Enables the *reactor*. See **-h** for a list of available reactors.
**-s**, **--self**
When tracing (**-t**), also print the events that happened during the **rv**
command... | Documentation/tools/rv/common_ikm.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==============================
Runtime verification (rv) tool
==============================
**rv** tool provides the interface for a collection of runtime verification
(rv) monitors.
.. toctree::
:maxdepth: 1
rv
rv-list
rv-mon
rv-mon-wip
rv-mon-wwnr
rv-mon-s... | Documentation/tools/rv/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=======
rv-list
=======
-----------------------
List available monitors
-----------------------
:Manual section: 1
SYNOPSIS
========
**rv list** [*OPTIONS*]
DESCRIPTION
===========
The **rv list** command prints all available monitors. These monitors
can be enabled using the **... | Documentation/tools/rv/rv-list.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============
rv-mon-sched
============
-----------------------------
Scheduler monitors collection
-----------------------------
:Manual section: 1
SYNOPSIS
========
**rv mon sched** [*OPTIONS*]
**rv mon <NESTED_MONITOR>** [*OPTIONS*]
**rv mon sched:<NESTED_MONITOR>** [*OPTIONS... | Documentation/tools/rv/rv-mon-sched.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==========
rv-mon-wip
==========
----------------------------
Wakeup In Preemptive monitor
----------------------------
:Manual section: 1
SYNOPSIS
========
**rv mon wip** [*OPTIONS*]
DESCRIPTION
===========
The wakeup in preemptive (**wip**) monitor is a sample per-cpu monitor... | Documentation/tools/rv/rv-mon-wip.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===========
rv-mon-wwnr
===========
--------------------------------
Wakeup While Not Running monitor
--------------------------------
:Manual section: 1
SYNOPSIS
========
**rv mon wip** [*OPTIONS*]
DESCRIPTION
===========
The wakeup while not running (**wwnr**) is a per-task s... | Documentation/tools/rv/rv-mon-wwnr.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
======
rv-mon
======
-----------------------
List available monitors
-----------------------
:Manual section: 1
SYNOPSIS
========
**rv mon** [*-h*] **monitor_name** [*-h*] [*MONITOR OPTIONS*]
DESCRIPTION
===========
The **rv mon** command runs the monitor named *monitor_name*. ... | Documentation/tools/rv/rv-mon.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==
rv
==
--------------------
Runtime Verification
--------------------
:Manual section: 1
SYNOPSIS
========
**rv** *COMMAND* [*OPTIONS*]
DESCRIPTION
===========
Runtime Verification (**RV**) is a lightweight (yet rigorous) method
for formal verification with a practical approa... | Documentation/tools/rv/rv.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=================
Boot-time tracing
=================
:Author: Masami Hiramatsu <mhiramat@kernel.org>
Overview
========
Boot-time tracing allows users to trace boot-time process including
device initialization with full features of ftrace including per-event
filter and actions, h... | Documentation/trace/boottime-trace.rst | null | null | null | null | null |
source | linux | ==============================
Using the tracer for debugging
==============================
Copyright 2024 Google LLC.
:Author: Steven Rostedt <rostedt@goodmis.org>
:License: The GNU Free Documentation License, Version 1.2
(dual licensed under the GPL v2)
- Written for: 6.12
Introduction
------------
... | Documentation/trace/debugging.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==================================
Eprobe - Event-based Probe Tracing
==================================
:Author: Steven Rostedt <rostedt@goodmis.org>
- Written for v6.17
Overview
========
Eprobes are dynamic events that are placed on existing events to either
dereference a fiel... | Documentation/trace/eprobetrace.rst | null | null | null | null | null |
source | linux | ============================
Subsystem Trace Points: kmem
============================
The kmem tracing system captures events related to object and page allocation
within the kernel. Broadly speaking there are five major subheadings.
- Slab allocation of small objects of unknown type (kmalloc)
- Slab allocation ... | Documentation/trace/events-kmem.rst | null | null | null | null | null |
source | linux | ================
MSR Trace Events
================
The x86 kernel supports tracing most MSR (Model Specific Register) accesses.
To see the definition of the MSRs on Intel systems please see the SDM
at https://www.intel.com/sdm (Volume 3)
Available trace points:
/sys/kernel/tracing/events/msr/
Trace MSR reads:
read... | Documentation/trace/events-msr.rst | null | null | null | null | null |
source | linux | ================
NMI Trace Events
================
These events normally show up here:
/sys/kernel/tracing/events/nmi
nmi_handler
-----------
You might want to use this tracepoint if you suspect that your
NMI handlers are hogging large amounts of CPU time. The kernel
will warn if it sees long-running handlers::
... | Documentation/trace/events-nmi.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===========================
Subsystem Trace Points: PCI
===========================
Overview
========
The PCI tracing system provides tracepoints to monitor critical hardware events
that can impact system performance and reliability. These events normally show
up here:
/sys/kerne... | Documentation/trace/events-pci.rst | null | null | null | null | null |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.