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 | ===============
NVDIMM Security
===============
1. Introduction
---------------
With the introduction of Intel Device Specific Methods (DSM) v1.8
specification [1], security DSMs are introduced. The spec added the following
security DSMs: "get security state", "set passphrase", "disable passphrase",
"unlock unit", "f... | Documentation/driver-api/nvdimm/security.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============================================
The Linux PCI driver implementer's API guide
============================================
.. toctree::
:caption: Table of contents
:maxdepth: 2
pci
p2pdma
tsm | Documentation/driver-api/pci/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============================
PCI Peer-to-Peer DMA Support
============================
The PCI bus has pretty decent support for performing DMA transfers
between two devices on the bus. This type of transaction is henceforth
called Peer-to-Peer (or P2P). However, there are a number... | Documentation/driver-api/pci/p2pdma.rst | null | null | null | null | null |
source | linux | PCI Support Library
-------------------
.. kernel-doc:: drivers/pci/pci.c
:export:
.. kernel-doc:: drivers/pci/iomap.c
:export:
.. kernel-doc:: drivers/pci/devres.c
:export:
.. kernel-doc:: drivers/pci/pci-driver.c
:export:
.. kernel-doc:: drivers/pci/remove.c
:export:
.. kernel-doc:: drivers/pci/s... | Documentation/driver-api/pci/pci.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
========================================================
PCI Trusted Execution Environment Security Manager (TSM)
========================================================
Subsystem Interfaces
====================
.. kernel-doc:: include/linux/pci-ide.h
... | Documentation/driver-api/pci/tsm.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================
Generic PHY Framework
=====================
.. toctree::
phy
samsung-usb2 | Documentation/driver-api/phy/index.rst | null | null | null | null | null |
source | linux | =============
PHY subsystem
=============
:Author: Kishon Vijay Abraham I <kishon@ti.com>
This document explains the Generic PHY Framework along with the APIs provided,
and how-to-use.
Introduction
============
*PHY* is the abbreviation for physical layer. It is used to connect a device
to the physical medium e.g.,... | Documentation/driver-api/phy/phy.rst | null | null | null | null | null |
source | linux | ====================================
Samsung USB 2.0 PHY adaptation layer
====================================
1. Description
--------------
The architecture of the USB 2.0 PHY module in Samsung SoCs is similar
among many SoCs. In spite of the similarities it proved difficult to
create a one driver that would fit all... | Documentation/driver-api/phy/samsung-usb2.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-only
=========================
Driver-specific callbacks
=========================
The ``pldmfw`` module relies on the device driver for implementing device
specific behavior using the following operations.
``.match_record``
-----------------
The ``.match_record`` operation is us... | Documentation/driver-api/pldmfw/driver-ops.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-only
==================================
PLDM Firmware file format overview
==================================
A PLDM firmware package is a binary file which contains a header that
describes the contents of the firmware package. This includes an initial
package header, one or more f... | Documentation/driver-api/pldmfw/file-format.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-only
==================================
PLDM Firmware Flash Update Library
==================================
``pldmfw`` implements functionality for updating the flash on a device using
the PLDM for Firmware Update standard
<https://www.dmtf.org/documents/pmci/pldm-firmware-update... | Documentation/driver-api/pldmfw/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
========================
CPU Idle Time Management
========================
:Copyright: |copy| 2019 Intel Corporation
:Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
CPU Idle Time Management Subsystem
==================================
Every tim... | Documentation/driver-api/pm/cpuidle.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
.. _driverapi_pm_devices:
==============================
Device Power Management Basics
==============================
:Copyright: |copy| 2010-2011 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
:Copyright: |copy| 2010 Alan Stern <stern@rowland.harvard.edu>... | Documentation/driver-api/pm/devices.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===============================
CPU and Device Power Management
===============================
.. toctree::
cpuidle
devices
notifiers
types | Documentation/driver-api/pm/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
=============================
Suspend/Hibernation Notifiers
=============================
:Copyright: |copy| 2016 Intel Corporation
:Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
There are some operations that subsystems or drivers may want to ... | Documentation/driver-api/pm/notifiers.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==================================
Device Power Management Data Types
==================================
.. kernel-doc:: include/linux/pm.h | Documentation/driver-api/pm/types.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===========================
The Linux RapidIO Subsystem
===========================
.. toctree::
:maxdepth: 1
rapidio
sysfs
tsi721
mport_cdev
rio_cm | Documentation/driver-api/rapidio/index.rst | null | null | null | null | null |
source | linux | ==================================================================
RapidIO subsystem mport character device driver (rio_mport_cdev.c)
==================================================================
1. Overview
===========
This device driver is the result of collaboration within the RapidIO.org
Software Task Group ... | Documentation/driver-api/rapidio/mport_cdev.rst | null | null | null | null | null |
source | linux | ============
Introduction
============
The RapidIO standard is a packet-based fabric interconnect standard designed for
use in embedded systems. Development of the RapidIO standard is directed by the
RapidIO Trade Association (RTA). The current version of the RapidIO specification
is publicly available for download fr... | Documentation/driver-api/rapidio/rapidio.rst | null | null | null | null | null |
source | linux | ==========================================================================
RapidIO subsystem Channelized Messaging character device driver (rio_cm.c)
==========================================================================
1. Overview
===========
This device driver is the result of collaboration within the RapidIO... | Documentation/driver-api/rapidio/rio_cm.rst | null | null | null | null | null |
source | linux | =============
Sysfs entries
=============
The RapidIO sysfs files have moved to:
Documentation/ABI/testing/sysfs-bus-rapidio and
Documentation/ABI/testing/sysfs-class-rapidio | Documentation/driver-api/rapidio/sysfs.rst | null | null | null | null | null |
source | linux | =========================================================================
RapidIO subsystem mport driver for IDT Tsi721 PCI Express-to-SRIO bridge.
=========================================================================
1. Overview
===========
This driver implements all currently defined RapidIO mport callback func... | Documentation/driver-api/rapidio/tsi721.rst | null | null | null | null | null |
source | linux | ====================
Low Level Serial API
====================
This document is meant as a brief overview of some aspects of the new serial
driver. It is not complete, any questions you have should be directed to
<rmk@arm.linux.org.uk>
The reference implementation is contained within amba-pl011.c.
Low Level Seri... | Documentation/driver-api/serial/driver.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==========================
Support for Serial devices
==========================
.. toctree::
:maxdepth: 1
driver
Serial drivers
==============
.. toctree::
:maxdepth: 1
serial-iso7816
serial-rs485 | Documentation/driver-api/serial/index.rst | null | null | null | null | null |
source | linux | =============================
ISO7816 Serial Communications
=============================
1. Introduction
===============
ISO/IEC7816 is a series of standards specifying integrated circuit cards (ICC)
also known as smart cards.
2. Hardware-related considerations
==================================
Some CPUs/UA... | Documentation/driver-api/serial/serial-iso7816.rst | null | null | null | null | null |
source | linux | ===========================
RS485 Serial Communications
===========================
1. Introduction
===============
EIA-485, also known as TIA/EIA-485 or RS-485, is a standard defining the
electrical characteristics of drivers and receivers for use in balanced
digital multipoint systems.
This standard is ... | Documentation/driver-api/serial/serial-rs485.rst | null | null | null | null | null |
source | linux | ==========================
Bulk Register Access (BRA)
==========================
Conventions
-----------
Capitalized words used in this documentation are intentional and refer
to concepts of the SoundWire 1.x specification.
Introduction
------------
The SoundWire 1.x specification provides a mechanism to speed-up
c... | Documentation/driver-api/soundwire/bra.rst | null | null | null | null | null |
source | linux | Cadence IP BRA support
----------------------
Format requirements
~~~~~~~~~~~~~~~~~~~
The Cadence IP relies on PDI0 for TX and PDI1 for RX. The data needs
to be formatted with the following conventions:
(1) all Data is stored in bits 15..0 of the 32-bit PDI FIFOs.
(2) the start of packet is BIT(31).
(3) the ... | Documentation/driver-api/soundwire/bra_cadence.rst | null | null | null | null | null |
source | linux | ========================
SoundWire Error Handling
========================
The SoundWire PHY was designed with care and errors on the bus are going to
be very unlikely, and if they happen it should be limited to single bit
errors. Examples of this design can be found in the synchronization
mechanism (sync loss after t... | Documentation/driver-api/soundwire/error_handling.rst | null | null | null | null | null |
source | linux | =======================
SoundWire Documentation
=======================
.. toctree::
:maxdepth: 1
summary
stream
error_handling
locking
bra
bra_cadence | Documentation/driver-api/soundwire/index.rst | null | null | null | null | null |
source | linux | =================
SoundWire Locking
=================
This document explains locking mechanism of the SoundWire Bus. Bus uses
following locks in order to avoid race conditions in Bus operations on
shared resources.
- Bus lock
- Message lock
Bus lock
========
SoundWire Bus lock is a mutex and is part of Bus dat... | Documentation/driver-api/soundwire/locking.rst | null | null | null | null | null |
source | linux | =========================
Audio Stream in SoundWire
=========================
An audio stream is a logical or virtual connection created between
(1) System memory buffer(s) and Codec(s)
(2) DSP memory buffer(s) and Codec(s)
(3) FIFO(s) and Codec(s)
(4) Codec(s) and Codec(s)
which is typically driven by a ... | Documentation/driver-api/soundwire/stream.rst | null | null | null | null | null |
source | linux | ===========================
SoundWire Subsystem Summary
===========================
SoundWire is a new interface ratified in 2015 by the MIPI Alliance.
SoundWire is used for transporting data typically related to audio
functions. SoundWire interface is optimized to integrate audio devices in
mobile or mobile inspired ... | Documentation/driver-api/soundwire/summary.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0+
===============================
Client Driver API Documentation
===============================
.. contents::
:depth: 2
Serial Hub Communication
========================
.. kernel-doc:: include/linux/surface_aggregator/serial_hub.h
.. kernel-doc:: drivers/platform/surface/... | Documentation/driver-api/surface_aggregator/client-api.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0+
.. |ssam_controller| replace:: :c:type:`struct ssam_controller <ssam_controller>`
.. |ssam_device| replace:: :c:type:`struct ssam_device <ssam_device>`
.. |ssam_device_driver| replace:: :c:type:`struct ssam_device_driver <ssam_device_driver>`
.. |ssam_client_bind| replace:: :c:func... | Documentation/driver-api/surface_aggregator/client.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0+
=======================================
Surface System Aggregator Module (SSAM)
=======================================
.. toctree::
:maxdepth: 2
overview
client
clients/index
ssh
internal | Documentation/driver-api/surface_aggregator/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0+
==========================
Internal API Documentation
==========================
.. contents::
:depth: 2
Packet Transport Layer
======================
.. kernel-doc:: drivers/platform/surface/aggregator/ssh_parser.h
:internal:
.. kernel-doc:: drivers/platform/surface/a... | Documentation/driver-api/surface_aggregator/internal-api.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0+
.. |ssh_ptl| replace:: :c:type:`struct ssh_ptl <ssh_ptl>`
.. |ssh_ptl_submit| replace:: :c:func:`ssh_ptl_submit`
.. |ssh_ptl_cancel| replace:: :c:func:`ssh_ptl_cancel`
.. |ssh_ptl_shutdown| replace:: :c:func:`ssh_ptl_shutdown`
.. |ssh_ptl_rx_rcvbuf| replace:: :c:func:`ssh_ptl_rx_rc... | Documentation/driver-api/surface_aggregator/internal.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0+
========
Overview
========
The Surface/System Aggregator Module (SAM, SSAM) is an (arguably *the*)
embedded controller (EC) on Microsoft Surface devices. It has been originally
introduced on 4th generation devices (Surface Pro 4, Surface Book 1), but
its responsibilities and featu... | Documentation/driver-api/surface_aggregator/overview.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0+
.. |u8| replace:: :c:type:`u8 <u8>`
.. |u16| replace:: :c:type:`u16 <u16>`
.. |TYPE| replace:: ``TYPE``
.. |LEN| replace:: ``LEN``
.. |SEQ| replace:: ``SEQ``
.. |SYN| replace:: ``SYN``
.. |NAK| replace:: ``NAK``
.. |ACK| replace:: ``ACK``
.. |DATA| replace:: ``DATA``
.. |DATA_SEQ| ... | Documentation/driver-api/surface_aggregator/ssh.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0+
.. |ssam_cdev_request| replace:: :c:type:`struct ssam_cdev_request <ssam_cdev_request>`
.. |ssam_cdev_request_flags| replace:: :c:type:`enum ssam_cdev_request_flags <ssam_cdev_request_flags>`
.. |ssam_cdev_event| replace:: :c:type:`struct ssam_cdev_event <ssam_cdev_event>`
=======... | Documentation/driver-api/surface_aggregator/clients/cdev.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0+
.. |__u16| replace:: :c:type:`__u16 <__u16>`
.. |sdtx_event| replace:: :c:type:`struct sdtx_event <sdtx_event>`
.. |sdtx_event_code| replace:: :c:type:`enum sdtx_event_code <sdtx_event_code>`
.. |sdtx_base_info| replace:: :c:type:`struct sdtx_base_info <sdtx_base_info>`
.. |sdtx_de... | Documentation/driver-api/surface_aggregator/clients/dtx.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0+
===========================
Client Driver Documentation
===========================
This is the documentation for client drivers themselves. Refer to
Documentation/driver-api/surface_aggregator/client.rst for documentation
on how to write client drivers.
.. toctree::
:maxdepth... | Documentation/driver-api/surface_aggregator/clients/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0+
.. |san_client_link| replace:: :c:func:`san_client_link`
.. |san_dgpu_notifier_register| replace:: :c:func:`san_dgpu_notifier_register`
.. |san_dgpu_notifier_unregister| replace:: :c:func:`san_dgpu_notifier_unregister`
===================
Surface ACPI Notify
===================
T... | Documentation/driver-api/surface_aggregator/clients/san.rst | null | null | null | null | null |
source | linux | =======================
CPU cooling APIs How To
=======================
Written by Amit Daniel Kachhap <amit.kachhap@linaro.org>
Updated: 6 Jan 2015
Copyright (c) 2012 Samsung Electronics Co., Ltd(http://www.samsung.com)
0. Introduction
===============
The generic cpu cooling(freq clipping) provides registration/... | Documentation/driver-api/thermal/cpu-cooling-api.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
================
CPU Idle Cooling
================
Situation:
----------
Under certain circumstances a SoC can reach a critical temperature
limit and is unable to stabilize the temperature around a temperature
control. When the SoC has to stabilize the temperature, the kernel can
... | Documentation/driver-api/thermal/cpu-idle-cooling.rst | null | null | null | null | null |
source | linux | ========================
Kernel driver exynos_tmu
========================
Supported chips:
* ARM Samsung Exynos4, Exynos5 series of SoC
Datasheet: Not publicly available
Authors: Donggeun Kim <dg77.kim@samsung.com>
Authors: Amit Daniel <amit.daniel@samsung.com>
TMU controller Description:
----------------------... | Documentation/driver-api/thermal/exynos_thermal.rst | null | null | null | null | null |
source | linux | =====================
Exynos Emulation Mode
=====================
Copyright (C) 2012 Samsung Electronics
Written by Jonghwa Lee <jonghwa3.lee@samsung.com>
Description
-----------
Exynos 4x12 (4212, 4412) and 5 series provide emulation mode for thermal
management unit. Thermal emulation mode supports software debug ... | Documentation/driver-api/thermal/exynos_thermal_emulation.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=======
Thermal
=======
.. toctree::
:maxdepth: 1
cpu-cooling-api
cpu-idle-cooling
sysfs-api
power_allocator
exynos_thermal
exynos_thermal_emulation
nouveau_thermal
x86_pkg_temperature_thermal
intel_dptf | Documentation/driver-api/thermal/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===============================================================
Intel(R) Dynamic Platform and Thermal Framework Sysfs Interface
===============================================================
:Copyright: © 2022 Intel Corporation
:Author: Srinivas Pandruvada <srinivas.pandruvada@li... | Documentation/driver-api/thermal/intel_dptf.rst | null | null | null | null | null |
source | linux | =====================
Kernel driver nouveau
=====================
Supported chips:
* NV43+
Authors: Martin Peres (mupuf) <martin.peres@free.fr>
Description
-----------
This driver allows to read the GPU core temperature, drive the GPU fan and
set temperature alarms.
Currently, due to the absence of in-kernel API ... | Documentation/driver-api/thermal/nouveau_thermal.rst | null | null | null | null | null |
source | linux | =================================
Power allocator governor tunables
=================================
Trip points
-----------
The governor works optimally with the following two passive trip points:
1. "switch on" trip point: temperature above which the governor
control loop starts operating. This is the first... | Documentation/driver-api/thermal/power_allocator.rst | null | null | null | null | null |
source | linux | ===================================
Generic Thermal Sysfs driver How To
===================================
Written by Sujith Thomas <sujith.thomas@intel.com>, Zhang Rui <rui.zhang@intel.com>
Copyright (c) 2008 Intel Corporation
0. Introduction
===============
The generic thermal sysfs provides a set of interface... | Documentation/driver-api/thermal/sysfs-api.rst | null | null | null | null | null |
source | linux | ===================================
Kernel driver: x86_pkg_temp_thermal
===================================
Supported chips:
* x86: with package level thermal management
(Verify using: CPUID.06H:EAX[bit 6] =1)
Authors: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
Reference
---------
Intel® 64 and IA-... | Documentation/driver-api/thermal/x86_pkg_temperature_thermal.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=======
Console
=======
.. contents:: :local:
Struct Console
==============
.. kernel-doc:: include/linux/console.h
:identifiers: console cons_flags
Internals
---------
.. kernel-doc:: include/linux/console.h
:identifiers: nbcon_state nbcon_prio nbcon_context nbcon_write_... | Documentation/driver-api/tty/console.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===
TTY
===
Teletypewriter (TTY) layer takes care of all those serial devices. Including
the virtual ones like pseudoterminal (PTY).
TTY structures
==============
There are several major TTY structures. Every TTY device in a system has a
corresponding struct tty_port. These devic... | Documentation/driver-api/tty/index.rst | null | null | null | null | null |
source | linux | =============================================================
MOXA Smartio/Industio Family Device Driver Installation Guide
=============================================================
Copyright (C) 2008, Moxa Inc.
Copyright (C) 2021, Jiri Slaby
.. Content
1. Introduction
2. System Requirement
3. Installat... | Documentation/driver-api/tty/moxa-smartio.rst | null | null | null | null | null |
source | linux | ==============================
GSM 0710 tty multiplexor HOWTO
==============================
.. contents:: :local:
This line discipline implements the GSM 07.10 multiplexing protocol
detailed in the following 3GPP document:
https://www.3gpp.org/ftp/Specs/archive/07_series/07.10/0710-720.zip
This document give some... | Documentation/driver-api/tty/n_gsm.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====
N_TTY
=====
.. contents:: :local:
The default (and fallback) :doc:`TTY line discipline <tty_ldisc>`. It tries to
handle characters as per POSIX.
External Functions
==================
.. kernel-doc:: drivers/tty/n_tty.c
:export:
Internal Functions
==================
..... | Documentation/driver-api/tty/n_tty.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==========
TTY Buffer
==========
.. contents:: :local:
Here, we document functions for taking care of tty buffer and their flipping.
Drivers are supposed to fill the buffer by one of those functions below and
then flip the buffer, so that the data are passed to :doc:`line discipli... | Documentation/driver-api/tty/tty_buffer.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============================
TTY Driver and TTY Operations
=============================
.. contents:: :local:
Allocation
==========
The first thing a driver needs to do is to allocate a struct tty_driver. This
is done by tty_alloc_driver() (or __tty_alloc_driver()). Next, the n... | Documentation/driver-api/tty/tty_driver.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============
TTY Internals
=============
.. contents:: :local:
Kopen
=====
These functions serve for opening a TTY from the kernelspace:
.. kernel-doc:: drivers/tty/tty_io.c
:identifiers: tty_kopen_exclusive tty_kopen_shared tty_kclose
----
Exported Internal Functions
=... | Documentation/driver-api/tty/tty_internals.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=================
TTY IOCTL Helpers
=================
.. kernel-doc:: drivers/tty/tty_ioctl.c
.. kernel-doc:: include/linux/tty.h
:identifiers: tty_get_baud_rate | Documentation/driver-api/tty/tty_ioctl.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===================
TTY Line Discipline
===================
.. contents:: :local:
TTY line discipline process all incoming and outgoing character from/to a tty
device. The default line discipline is :doc:`N_TTY <n_tty>`. It is also a
fallback if establishing any other discipline f... | Documentation/driver-api/tty/tty_ldisc.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
========
TTY Port
========
.. contents:: :local:
The TTY drivers are advised to use struct tty_port helpers as much as possible.
If the drivers implement :c:member:`tty_port.ops.activate()` and
:c:member:`tty_port.ops.shutdown()`, they can use tty_port_open(),
tty_port_close(), an... | Documentation/driver-api/tty/tty_port.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==========
TTY Struct
==========
.. contents:: :local:
struct tty_struct is allocated by the TTY layer upon the first open of the TTY
device and released after the last close. The TTY layer passes this structure
to most of struct tty_operation's hooks. Members of tty_struct are do... | Documentation/driver-api/tty/tty_struct.rst | null | null | null | null | null |
source | linux | .. _usb-urb:
USB Request Block (URB)
~~~~~~~~~~~~~~~~~~~~~~~
:Revised: 2000-Dec-05
:Again: 2002-Jul-06
:Again: 2005-Sep-19
:Again: 2017-Mar-29
.. note::
The USB subsystem now has a substantial section at :ref:`usb-hostside-api`
section, generated from the current source code.
This particular docu... | Documentation/driver-api/usb/URB.rst | null | null | null | null | null |
source | linux | USB Anchors
~~~~~~~~~~~
What is anchor?
===============
A USB driver needs to support some callbacks requiring
a driver to cease all IO to an interface. To do so, a
driver has to keep track of the URBs it has submitted
to know they've all completed or to call usb_kill_urb
for them. The anchor is a data structure take... | Documentation/driver-api/usb/anchors.rst | null | null | null | null | null |
source | linux | USB bulk streams
~~~~~~~~~~~~~~~~
Background
==========
Bulk endpoint streams were added in the USB 3.0 specification. Streams allow a
device driver to overload a bulk endpoint so that multiple transfers can be
queued at once.
Streams are defined in sections 4.4.6.4 and 8.12.1.4 of the Universal Serial Bus
3.0 spec... | Documentation/driver-api/usb/bulk-streams.rst | null | null | null | null | null |
source | linux | USB core callbacks
~~~~~~~~~~~~~~~~~~
What callbacks will usbcore do?
===============================
Usbcore will call into a driver through callbacks defined in the driver
structure and through the completion handler of URBs a driver submits.
Only the former are in the scope of this document. These two kinds of
cal... | Documentation/driver-api/usb/callbacks.rst | null | null | null | null | null |
source | linux | USB DMA
~~~~~~~
In Linux 2.5 kernels (and later), USB device drivers have additional control
over how DMA may be used to perform I/O operations. The APIs are detailed
in the kernel usb programming guide (kerneldoc, from the source code).
API overview
============
The big picture is that USB drivers can continue to ... | Documentation/driver-api/usb/dma.rst | null | null | null | null | null |
source | linux | ===============================================================
Synopsys DesignWare Core SuperSpeed USB 3.0 Controller
===============================================================
:Author: Felipe Balbi <felipe.balbi@linux.intel.com>
:Date: April 2017
Introduction
============
The *Synopsys DesignWare Core SuperSp... | Documentation/driver-api/usb/dwc3.rst | null | null | null | null | null |
source | linux | .. _usb-error-codes:
USB Error codes
~~~~~~~~~~~~~~~
:Revised: 2004-Oct-21
This is the documentation of (hopefully) all possible error codes (and
their interpretation) that can be returned from usbcore.
Some of them are returned by the Host Controller Drivers (HCDs), which
device drivers only see through usbcore. ... | Documentation/driver-api/usb/error-codes.rst | null | null | null | null | null |
source | linux | ========================
USB Gadget API for Linux
========================
:Author: David Brownell
:Date: 20 August 2004
Introduction
============
This document presents a Linux-USB "Gadget" kernel mode API, for use
within peripherals and other USB devices that embed Linux. It provides
an overview of the API struc... | Documentation/driver-api/usb/gadget.rst | null | null | null | null | null |
source | linux | USB hotplugging
~~~~~~~~~~~~~~~
Linux Hotplugging
=================
In hotpluggable buses like USB (and Cardbus PCI), end-users plug devices
into the bus with power on. In most cases, users expect the devices to become
immediately usable. That means the system must do many things, including:
- Find a driver t... | Documentation/driver-api/usb/hotplug.rst | null | null | null | null | null |
source | linux | =============
Linux USB API
=============
.. toctree::
:maxdepth: 1
usb
gadget
anchors
bulk-streams
callbacks
dma
URB
power-management
hotplug
persist
error-codes
writing_usb_driver
dwc3
writing_musb_glue_layer
typec
typec_bus
usb3-debug-port | Documentation/driver-api/usb/index.rst | null | null | null | null | null |
source | linux | .. _usb-persist:
USB device persistence during system suspend
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:Author: Alan Stern <stern@rowland.harvard.edu>
:Date: September 2, 2006 (Updated February 25, 2008)
What is the problem?
====================
According to the USB specification, when a USB bus is suspended t... | Documentation/driver-api/usb/persist.rst | null | null | null | null | null |
source | linux | .. _usb-power-management:
Power Management for USB
~~~~~~~~~~~~~~~~~~~~~~~~
:Author: Alan Stern <stern@rowland.harvard.edu>
:Date: Last-updated: February 2014
..
Contents:
---------
* What is Power Management?
* What is Remote Wakeup?
* When is a USB device idle?
* Forms of dynamic PM
* The user interface for... | Documentation/driver-api/usb/power-management.rst | null | null | null | null | null |
source | linux | .. _typec:
USB Type-C connector class
==========================
Introduction
------------
The typec class is meant for describing the USB Type-C ports in a system to the
user space in unified fashion. The class is designed to provide nothing else
except the user space interface implementation in hope that it can be... | Documentation/driver-api/usb/typec.rst | null | null | null | null | null |
source | linux | API for USB Type-C Alternate Mode drivers
=========================================
Introduction
------------
Alternate modes require communication with the partner using Vendor Defined
Messages (VDM) as defined in USB Type-C and USB Power Delivery Specifications.
The communication is SVID (Standard or Vendor ID) spe... | Documentation/driver-api/usb/typec_bus.rst | null | null | null | null | null |
source | linux | .. _usb-hostside-api:
===========================
The Linux-USB Host Side API
===========================
Introduction to USB on Linux
============================
A Universal Serial Bus (USB) is used to connect a host, such as a PC or
workstation, to a number of peripheral devices. USB uses a tree
structure, with t... | Documentation/driver-api/usb/usb.rst | null | null | null | null | null |
source | linux | ===============
USB3 debug port
===============
:Author: Lu Baolu <baolu.lu@linux.intel.com>
:Date: March 2017
GENERAL
=======
This is a HOWTO for using the USB3 debug port on x86 systems.
Before using any kernel debugging functionality based on USB3
debug port, you need to::
1) check whether any USB3 debug port ... | Documentation/driver-api/usb/usb3-debug-port.rst | null | null | null | null | null |
source | linux | =========================
Writing a MUSB Glue Layer
=========================
:Author: Apelete Seketeli
Introduction
============
The Linux MUSB subsystem is part of the larger Linux USB subsystem. It
provides support for embedded USB Device Controllers (UDC) that do not
use Universal Host Controller Interface (UHCI... | Documentation/driver-api/usb/writing_musb_glue_layer.rst | null | null | null | null | null |
source | linux | .. _writing-usb-driver:
==========================
Writing USB Device Drivers
==========================
:Author: Greg Kroah-Hartman
Introduction
============
The Linux USB subsystem has grown from supporting only two different
types of devices in the 2.2.7 kernel (mice and keyboards), to over 20
different types of... | Documentation/driver-api/usb/writing_usb_driver.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
======
Virtio
======
.. toctree::
:maxdepth: 1
virtio
writing_virtio_drivers | Documentation/driver-api/virtio/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. _virtio:
===============
Virtio on Linux
===============
Introduction
============
Virtio is an open standard that defines a protocol for communication
between drivers and devices of different types, see Chapter 5 ("Device
Types") of the virtio spec (`[1]`_). Originally develo... | Documentation/driver-api/virtio/virtio.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. _writing_virtio_drivers:
======================
Writing Virtio Drivers
======================
Introduction
============
This document serves as a basic guideline for driver programmers that
need to hack a new virtio driver or understand the essentials of the
existing ones. See... | Documentation/driver-api/virtio/writing_virtio_drivers.rst | null | null | null | null | null |
source | linux | ====================================
Xilinx Zynq MPSoC EEMI Documentation
====================================
Xilinx Zynq MPSoC Firmware Interface
-------------------------------------
The zynqmp-firmware node describes the interface to platform firmware.
ZynqMP has an interface to communicate with secure firmware. F... | Documentation/driver-api/xilinx/eemi.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.2-no-invariants-or-later
=================
EDAC/RAS features
=================
Copyright (c) 2024-2025 HiSilicon Limited.
:Author: Shiju Jose <shiju.jose@huawei.com>
:License: The GNU Free Documentation License, Version 1.2 without
Invariant Sections, Front... | Documentation/edac/features.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.2-no-invariants-or-later
==============
EDAC Subsystem
==============
.. toctree::
:maxdepth: 1
features
memory_repair
scrub | Documentation/edac/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.2-no-invariants-or-later
==========================
EDAC Memory Repair Control
==========================
Copyright (c) 2024-2025 HiSilicon Limited.
:Author: Shiju Jose <shiju.jose@huawei.com>
:License: The GNU Free Documentation License, Version 1.2 without
... | Documentation/edac/memory_repair.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.2-no-invariants-or-later
=============
Scrub Control
=============
Copyright (c) 2024-2025 HiSilicon Limited.
:Author: Shiju Jose <shiju.jose@huawei.com>
:License: The GNU Free Documentation License, Version 1.2 without
Invariant Sections, Front-Cover Texts... | Documentation/edac/scrub.rst | null | null | null | null | null |
source | linux | ===========================================
Fault injection capabilities infrastructure
===========================================
See also "every_nth" module option for scsi_debug.
Available fault injection capabilities
--------------------------------------
- failslab
injects slab allocation failures. (kmallo... | Documentation/fault-injection/fault-injection.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===============
Fault-injection
===============
.. toctree::
:maxdepth: 1
fault-injection
notifier-error-inject
nvme-fault-injection
provoke-crashes | Documentation/fault-injection/index.rst | null | null | null | null | null |
source | linux | Notifier error injection
========================
Notifier error injection provides the ability to inject artificial errors to
specified notifier chain callbacks. It is useful to test the error handling of
notifier call chain failures which is rarely executed. There are kernel
modules that can be used to test the fol... | Documentation/fault-injection/notifier-error-inject.rst | null | null | null | null | null |
source | linux | NVMe Fault Injection
====================
Linux's fault injection framework provides a systematic way to support
error injection via debugfs in the /sys/kernel/debug directory. When
enabled, the default NVME_SC_INVALID_OPCODE with no retry will be
injected into the nvme_try_complete_req. Users can change the default st... | Documentation/fault-injection/nvme-fault-injection.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============================================================
Provoking crashes with Linux Kernel Dump Test Module (LKDTM)
============================================================
The lkdtm module provides an interface to disrupt (and usually crash)
the kernel at predefined code... | Documentation/fault-injection/provoke-crashes.rst | null | null | null | null | null |
source | linux | ===========================
The Frame Buffer Device API
===========================
Last revised: June 21, 2011
0. Introduction
---------------
This document describes the frame buffer API used by applications to interact
with frame buffer devices. In-kernel APIs between device drivers and the frame
buffer core are... | Documentation/fb/api.rst | null | null | null | null | null |
source | linux | ========================================
arkfb - fbdev driver for ARK Logic chips
========================================
Supported Hardware
==================
ARK 2000PV chip
ICS 5342 ramdac
- only BIOS initialized VGA devices supported
- probably not working on big endian
Supported Features
===============... | Documentation/fb/arkfb.rst | null | null | null | null | null |
source | linux | =========================================
aty128fb - ATI Rage128 framebuffer driver
=========================================
This is a driver for a graphic framebuffer for ATI Rage128 based devices
on Intel and PPC boxes.
Advantages:
* It provides a nice large console (128 cols + 48 lines with 1024x768)
without... | Documentation/fb/aty128fb.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.