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 | ST DWC3 glue logic
This file documents the parameters for the dwc3-st driver.
This driver controls the glue logic used to configure the dwc3 core on
STiH407 based platforms.
Required properties:
- compatible : must be "st,stih407-dwc3"
- reg : glue logic base address and USB syscfg ctrl register offset
- reg-name... | Documentation/devicetree/bindings/usb/dwc3-st.txt | null | null | null | null | null |
source | linux | ST USB EHCI controller
Required properties:
- compatible : must be "st,st-ehci-300x"
- reg : physical base addresses of the controller and length of memory mapped
region
- interrupts : one EHCI interrupt should be described here
- pinctrl-names : a pinctrl state named "default" must be defined
- pinctrl-... | Documentation/devicetree/bindings/usb/ehci-st.txt | null | null | null | null | null |
source | linux | USB Peripheral Controller driver for Aeroflex Gaisler GRUSBDC.
The GRUSBDC USB Device Controller core is available in the GRLIB VHDL
IP core library.
Note: In the ordinary environment for the core, a Leon SPARC system,
these properties are built from information in the AMBA plug&play.
Required properties:
- name : ... | Documentation/devicetree/bindings/usb/gr-udc.txt | null | null | null | null | null |
source | linux | HiSilicon STB xHCI
The device node for HiSilicon STB xHCI host controller
Required properties:
- compatible: should be "hisilicon,hi3798cv200-xhci"
- reg: specifies physical base address and size of the registers
- interrupts : interrupt used by the controller
- clocks: a list of phandle + clock-specifier pairs, ... | Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt | null | null | null | null | null |
source | linux | Broadcom IPROC USB Device controller.
The device node is used for UDCs integrated into Broadcom's
iProc family (Northstar2, Cygnus) of SoCs'. The UDC is based
on Synopsys Designware Cores AHB Subsystem Device Controller
IP.
Required properties:
- compatible: Add the compatibility strings for supported platforms.
... | Documentation/devicetree/bindings/usb/iproc-udc.txt | null | null | null | null | null |
source | linux | Maxim Integrated SPI-based USB 2.0 host controller MAX3421E
Required properties:
- compatible: Should be "maxim,max3421"
- spi-max-frequency: maximum frequency for this device must not exceed 26 MHz.
- reg: chip select number to which this device is connected.
- maxim,vbus-en-pin: <GPOUTx ACTIVE_LEVEL>
GPOUTx i... | Documentation/devicetree/bindings/usb/maxim,max3421.txt | null | null | null | null | null |
source | linux | OCTEON/OCTEON+ USB BLOCK
1) Main node
Required properties:
- compatible: must be "cavium,octeon-5750-usbn"
- reg: specifies the physical base address of the USBN block and
the length of the memory mapped region.
- #address-cells: specifies the number of cells needed to encode an
address. The ... | Documentation/devicetree/bindings/usb/octeon-usb.txt | null | null | null | null | null |
source | linux | DA8XX USB OHCI controller
Required properties:
- compatible: Should be "ti,da830-ohci"
- reg: Should contain one register range i.e. start and length
- interrupts: Description of the interrupt line
- phys: Phandle for the PHY device
- phy-names: Should be "usb-phy"
Optional properties:
- vbus-sup... | Documentation/devicetree/bindings/usb/ohci-da8xx.txt | null | null | null | null | null |
source | linux | ST USB OHCI controller
Required properties:
- compatible : must be "st,st-ohci-300x"
- reg : physical base addresses of the controller and length of memory mapped
region
- interrupts : one OHCI controller interrupt should be described here
- clocks : phandle list of usb clocks
- clock-names : should b... | Documentation/devicetree/bindings/usb/ohci-st.txt | null | null | null | null | null |
source | linux | OMAP GLUE AND OTHER OMAP SPECIFIC COMPONENTS
OMAP MUSB GLUE
- compatible : Should be "ti,omap4-musb" or "ti,omap3-musb"
- ti,hwmods : must be "usb_otg_hs"
- multipoint : Should be "1" indicating the musb controller supports
multipoint. This is a MUSB configuration-specific setting.
- num-eps : Specifies the num... | Documentation/devicetree/bindings/usb/omap-usb.txt | null | null | null | null | null |
source | linux | PXA USB controllers
OHCI
Required properties:
- compatible: Should be "marvell,pxa-ohci" for USB controllers
used in host mode.
Optional properties:
- "marvell,enable-port1", "marvell,enable-port2", "marvell,enable-port3"
If present, enables the appropriate USB port of the controller.
- "marvell,port-mode" ... | Documentation/devicetree/bindings/usb/pxa-usb.txt | null | null | null | null | null |
source | linux | Richtek RT1711H TypeC PD Controller.
Required properties:
- compatible : Must be "richtek,rt1711h".
- reg : Must be 0x4e, it's slave address of RT1711H.
- interrupts : <a b> where a is the interrupt number and b represents an
encoding of the sense and level information for the interrupt.
Required sub-node:
- co... | Documentation/devicetree/bindings/usb/richtek,rt1711h.txt | null | null | null | null | null |
source | linux | ULPI bus binding
----------------
Phys that are behind a ULPI connection can be described with the following
binding. The host controller shall have a "ulpi" named node as a child, and
that node shall have one enabled node underneath it representing the ulpi
device on the bus.
EXAMPLE
-------
usb {
compatible = "ve... | Documentation/devicetree/bindings/usb/ulpi.txt | null | null | null | null | null |
source | linux | SMSC USB4604 High-Speed Hub Controller
Required properties:
- compatible: Should be "smsc,usb4604"
Optional properties:
- reg: Specifies the i2c slave address, it is required and should be 0x2d
if I2C is used.
- reset-gpios: Should specify GPIO for reset.
- initial-mode: Should specify initial mode.
... | Documentation/devicetree/bindings/usb/usb4604.txt | null | null | null | null | null |
source | linux | Ux500 MUSB
Required properties:
- compatible : Should be "stericsson,db8500-musb"
- reg : Offset and length of registers
- interrupts : Interrupt; mode, number and trigger
- dr_mode : Dual-role; either host mode "host", peripheral mode "peripheral"
or both "otg"
Optional properties:
- d... | Documentation/devicetree/bindings/usb/ux500-usb.txt | null | null | null | null | null |
source | linux | * OMAP HDQ One wire bus master controller
Required properties:
- compatible : should be "ti,omap3-1w" or "ti,am4372-hdq"
- reg : Address and length of the register set for the device
- interrupts : interrupt line.
- ti,hwmods : "hdq1w"
Optional properties:
- ti,mode: should be "hdq": HDQ mode "1w": one-wire mode.
... | Documentation/devicetree/bindings/w1/omap-hdq.txt | null | null | null | null | null |
source | linux | Generic devicetree bindings for onewire (w1) busses
===================================================
Onewire busses are described through nodes of their master bus controller.
Slave devices are listed as sub-nodes of such master devices. For now, only
one slave is allowed per bus master.
Example:
charger: charg... | Documentation/devicetree/bindings/w1/w1.txt | null | null | null | null | null |
source | linux | Bindings for MEN A21 Watchdog device connected to GPIO lines
Required properties:
- compatible: "men,a021-wdt"
- gpios: Specifies the pins that control the Watchdog, order:
1: Watchdog enable
2: Watchdog fast-mode
3: Watchdog trigger
4: Watchdog reset cause bit 0
5: Watchdog reset cause bit 1
6: Watchdog r... | Documentation/devicetree/bindings/watchdog/men-a021-wdt.txt | null | null | null | null | null |
source | linux | * Microchip PIC32 Deadman Timer
The deadman timer is used to reset the processor in the event of a software
malfunction. It is a free-running instruction fetch timer, which is clocked
whenever an instruction fetch occurs until a count match occurs.
Required properties:
- compatible: must be "microchip,pic32mzda-dmt".... | Documentation/devicetree/bindings/watchdog/microchip,pic32-dmt.txt | null | null | null | null | null |
source | linux | * Microchip PIC32 Watchdog Timer
When enabled, the watchdog peripheral can be used to reset the device if the
WDT is not cleared periodically in software.
Required properties:
- compatible: must be "microchip,pic32mzda-wdt".
- reg: physical base address of the controller and length of memory mapped
region.
- clocks... | Documentation/devicetree/bindings/watchdog/microchip,pic32-wdt.txt | null | null | null | null | null |
source | linux | STMicroelectronics Low Power Controller (LPC) - Watchdog
========================================================
LPC currently supports Watchdog OR Real Time Clock OR Clocksource
functionality.
[See: ../rtc/rtc-st-lpc.txt for RTC options]
[See: ../timer/st,stih407-lpc for Clocksource options]
Required properties
-... | Documentation/devicetree/bindings/watchdog/st_lpc_wdt.txt | null | null | null | null | null |
source | linux | Technologic Systems Watchdog
Required properties:
- compatible: must be "technologic,ts4800-wdt"
- syscon: phandle / integer array that points to the syscon node which
describes the FPGA's syscon registers.
- phandle to FPGA's syscon
- offset to the watchdog register
Optional property:
-... | Documentation/devicetree/bindings/watchdog/ts4800-wdt.txt | null | null | null | null | null |
source | linux | CE4100 Device Tree Bindings
---------------------------
The CE4100 SoC uses for in core peripherals the following compatible
format: <vendor>,<chip>-<device>.
Many of the "generic" devices like HPET or IO APIC have the ce4100
name in their compatible property because they first appeared in this
SoC.
The CPU nodes
---... | Documentation/devicetree/bindings/x86/ce4100.txt | null | null | null | null | null |
source | linux | Timers
------
* High Precision Event Timer (HPET)
Required property:
compatible = "intel,ce4100-hpet"; | Documentation/devicetree/bindings/x86/timer.txt | null | null | null | null | null |
source | linux | * Xillybus driver for generic FPGA interface
Required properties:
- compatible: Should be "xillybus,xillybus-1.00.a"
- reg: Address and length of the register set for the device
- interrupts: Contains one interrupt node, typically consisting of three cells.
Optional properties:
- dma-coherent: Present if DMA operatio... | Documentation/devicetree/bindings/xillybus/xillybus.txt | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Checking for needed translation updates
=======================================
This script helps track the translation status of the documentation in
different locales, i.e., whether the documentation is up-to-date with
the English counterpart.
How it works
------------
It uses ... | Documentation/doc-guide/checktransupdate.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
How to help improve kernel documentation
========================================
Documentation is an important part of any software-development project.
Good documentation helps to bring new developers in and helps established
developers work more effectively. Without top-quality... | Documentation/doc-guide/contributing.rst | null | null | null | null | null |
source | linux | .. _doc_guide:
=================================
How to write kernel documentation
=================================
.. toctree::
:maxdepth: 1
sphinx
kernel-doc
parse-headers
contributing
maintainer-profile
checktransupdate | Documentation/doc-guide/index.rst | null | null | null | null | null |
source | linux | .. title:: Kernel-doc comments
===========================
Writing kernel-doc comments
===========================
The Linux kernel source files may contain structured documentation
comments in the kernel-doc format to describe the functions, types
and design of the code. It is easier to keep documentation up-to-date... | Documentation/doc-guide/kernel-doc.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Documentation subsystem maintainer entry profile
================================================
The documentation "subsystem" is the central coordinating point for the
kernel's documentation and associated infrastructure. It covers the
hierarchy under Documentation/ (with the ex... | Documentation/doc-guide/maintainer-profile.rst | null | null | null | null | null |
source | linux | ===========================
Including uAPI header files
===========================
Sometimes, it is useful to include header files and C example codes in
order to describe the userspace API and to generate cross-references
between the code and the documentation. Adding cross-references for
userspace API files has an ... | Documentation/doc-guide/parse-headers.rst | null | null | null | null | null |
source | linux | .. _sphinxdoc:
=====================================
Using Sphinx for kernel documentation
=====================================
The Linux kernel uses `Sphinx`_ to generate pretty documentation from
`reStructuredText`_ files under ``Documentation``. To build the documentation in
HTML or PDF formats, use ``make htmldo... | Documentation/doc-guide/sphinx.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Managing Ownership of the Framebuffer Aperture
==============================================
.. kernel-doc:: drivers/video/aperture.c
:doc: overview
.. kernel-doc:: include/linux/aperture.h
:internal:
.. kernel-doc:: drivers/video/aperture.c
:export: | Documentation/driver-api/aperture.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-only
.. _auxiliary_bus:
=============
Auxiliary Bus
=============
.. kernel-doc:: drivers/base/auxiliary.c
:doc: PURPOSE
When Should the Auxiliary Bus Be Used
=====================================
.. kernel-doc:: drivers/base/auxiliary.c
:doc: USAGE
Auxiliary Device Crea... | Documentation/driver-api/auxiliary_bus.rst | null | null | null | null | null |
source | linux | Driver Basics
=============
Driver Entry and Exit points
----------------------------
.. kernel-doc:: include/linux/module.h
:internal:
Driver device table
-------------------
.. kernel-doc:: include/linux/mod_devicetable.h
:internal:
:no-identifiers: pci_device_id
Delaying and scheduling routines
------... | Documentation/driver-api/basics.rst | null | null | null | null | null |
source | linux | ========================
The Common Clk Framework
========================
:Author: Mike Turquette <mturquette@ti.com>
This document endeavours to explain the common clk framework details,
and how to port a platform over to this framework. It is not yet a
detailed explanation of the clock api in include/linux/clk.h,... | Documentation/driver-api/clk.rst | null | null | null | null | null |
source | linux | .. _component:
======================================
Component Helper for Aggregate Drivers
======================================
.. kernel-doc:: drivers/base/component.c
:doc: overview
API
===
.. kernel-doc:: include/linux/component.h
:internal:
.. kernel-doc:: drivers/base/component.c
:export: | Documentation/driver-api/component.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
================
Kernel Connector
================
Kernel connector - new netlink based userspace <-> kernel space easy
to use communication module.
The Connector driver makes it easy to connect various agents using a
netlink based network. One must register a callback and an ide... | Documentation/driver-api/connector.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===============
Console Drivers
===============
The Linux kernel has 2 general types of console drivers. The first type is
assigned by the kernel to all the virtual consoles during the boot process.
This type will be called 'system driver', and only one system driver is allowed
to... | Documentation/driver-api/console.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
========================
Device Frequency Scaling
========================
Introduction
------------
This framework provides a standard kernel interface for Dynamic Voltage and
Frequency Switching on arbitrary devices.
It exposes controls for adjusting frequency through sysfs fil... | Documentation/driver-api/devfreq.rst | null | null | null | null | null |
source | linux | .. Copyright 2001 Matthew Wilcox
..
.. This documentation is free software; you can redistribute
.. it and/or modify it under the terms of the GNU General Public
.. License as published by the Free Software Foundation; either
.. version 2 of the License, or (at your option) any later
.. version.
==... | Documentation/driver-api/device-io.rst | null | null | null | null | null |
source | linux | .. _device_link:
============
Device links
============
By default, the driver core only enforces dependencies between devices
that are borne out of a parent/child relationship within the device
hierarchy: When suspending, resuming or shutting down the system, devices
are ordered based on this relationship, i.e. chil... | Documentation/driver-api/device_link.rst | null | null | null | null | null |
source | linux | Buffer Sharing and Synchronization (dma-buf)
============================================
The dma-buf subsystem provides the framework for sharing buffers for
hardware (DMA) access across multiple device drivers and subsystems, and
for synchronizing asynchronous hardware access.
As an example, it is used extensively ... | Documentation/driver-api/dma-buf.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===============================
The Linux kernel dpll subsystem
===============================
DPLL
====
PLL - Phase Locked Loop is an electronic circuit which syntonizes clock
signal of a device with an external clock signal. Effectively enabling
device to run on the same clock ... | Documentation/driver-api/dpll.rst | null | null | null | null | null |
source | linux | Error Detection And Correction (EDAC) Devices
=============================================
Main Concepts used at the EDAC subsystem
----------------------------------------
There are several things to be aware of that aren't at all obvious, like
*sockets, *socket sets*, *banks*, *rows*, *chip-select rows*, *channels... | Documentation/driver-api/edac.rst | null | null | null | null | null |
source | linux | ================
EISA bus support
================
:Author: Marc Zyngier <maz@wild-wind.fr.eu.org>
This document groups random notes about porting EISA drivers to the
new EISA/sysfs API.
Starting from version 2.5.59, the EISA bus is almost given the same
status as other much more mainstream buses such as PCI or USB.... | Documentation/driver-api/eisa.rst | null | null | null | null | null |
source | linux | =======================
Extcon Device Subsystem
=======================
Overview
========
The Extcon (External Connector) subsystem provides a unified framework for
managing external connectors in Linux systems. It allows drivers to report
the state of external connectors and provides a standardized interface for
use... | Documentation/driver-api/extcon.rst | null | null | null | null | null |
source | linux | ===========================================
Firewire (IEEE 1394) driver Interface Guide
===========================================
Introduction and Overview
=========================
The Linux FireWire subsystem adds some interfaces into the Linux system to
use/maintain+any resource on IEEE 1394 bus.
The main purp... | Documentation/driver-api/firewire.rst | null | null | null | null | null |
source | linux | Frame Buffer Library
====================
The frame buffer drivers depend heavily on four data structures. These
structures are declared in include/linux/fb.h. They are fb_info,
fb_var_screeninfo, fb_fix_screeninfo and fb_monospecs. The last
three can be made available to and from userland.
fb_info defines the curren... | Documentation/driver-api/frame-buffer.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=========================
Generic Counter Interface
=========================
Introduction
============
Counter devices are prevalent among a diverse spectrum of industries.
The ubiquitous presence of these devices necessitates a common interface
and standard of interaction and ex... | Documentation/driver-api/generic-counter.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
========================
Generic Radix Page Table
========================
.. kernel-doc:: include/linux/generic_pt/common.h
:doc: Generic Radix Page Table
.. kernel-doc:: drivers/iommu/generic_pt/pt_defs.h
:doc: Generic Page Table Language
Usage
=====
Generic PT is structured... | Documentation/driver-api/generic_pt.rst | null | null | null | null | null |
source | linux | High Speed Synchronous Serial Interface (HSI)
=============================================
Introduction
---------------
High Speed Synchronous Interface (HSI) is a full duplex, low latency protocol,
that is optimized for die-level interconnect between an Application Processor
and a Baseband chipset. It has been spec... | Documentation/driver-api/hsi.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=================================================
Recoverable Hardware Error Tracking in vmcoreinfo
=================================================
Overview
--------
This feature provides a generic infrastructure within the Linux kernel to track
and log recoverable hardware erro... | Documentation/driver-api/hw-recoverable-errors.rst | null | null | null | null | null |
source | linux | I\ :sup:`2`\ C and SMBus Subsystem
==================================
I\ :sup:`2`\ C (or without fancy typography, "I2C") is an acronym for
the "Inter-IC" bus, a simple bus protocol which is widely used where low
data rate communications suffice. Since it's also a licensed trademark,
some vendors use another name (suc... | Documentation/driver-api/i2c.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==============================
Driver implementer's API guide
==============================
The kernel offers a wide variety of interfaces to support the development
of device drivers. This document is an only somewhat organized collection
of some of those interfaces — it will ho... | Documentation/driver-api/index.rst | null | null | null | null | null |
source | linux | ===========================================
InfiniBand and Remote DMA (RDMA) Interfaces
===========================================
Introduction and Overview
=========================
TBD
InfiniBand core interfaces
==========================
.. kernel-doc:: drivers/infiniband/core/iwpm_util.h
:internal:
.. ker... | Documentation/driver-api/infiniband.rst | null | null | null | null | null |
source | linux | Device drivers infrastructure
=============================
The Basic Device Driver-Model Structures
----------------------------------------
.. kernel-doc:: include/linux/device.h
:internal:
:no-identifiers: device_link_state
.. kernel-doc:: include/linux/device/bus.h
:identifiers: bus_type bus_notifier_ev... | Documentation/driver-api/infrastructure.rst | null | null | null | null | null |
source | linux | Input Subsystem
===============
Input core
----------
.. kernel-doc:: include/linux/input.h
:internal:
.. kernel-doc:: drivers/input/input.c
:export:
.. kernel-doc:: drivers/input/ff-core.c
:export:
.. kernel-doc:: drivers/input/ff-memless.c
:export:
Multitouch Library
------------------
.. kernel-do... | Documentation/driver-api/input.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================================
Generic System Interconnect Subsystem
=====================================
Introduction
------------
This framework is designed to provide a standard kernel interface to control
the settings of the interconnects on an SoC. These settings can ... | Documentation/driver-api/interconnect.rst | null | null | null | null | null |
source | linux | ========================
The io_mapping functions
========================
API
===
The io_mapping functions in linux/io-mapping.h provide an abstraction for
efficiently mapping small regions of an I/O device to the CPU. The initial
usage is to support the large graphics aperture on 32-bit processors where
ioremap_wc ... | Documentation/driver-api/io-mapping.rst | null | null | null | null | null |
source | linux | ==============================================
Ordering I/O writes to memory-mapped addresses
==============================================
On some platforms, so-called memory-mapped I/O is weakly ordered. On such
platforms, driver writers are responsible for ensuring that I/O writes to
memory-mapped addresses on th... | Documentation/driver-api/io_ordering.rst | null | null | null | null | null |
source | linux | ======================
ioctl based interfaces
======================
ioctl() is the most common way for applications to interface
with device drivers. It is flexible and easily extended by adding new
commands and can be passed through character devices, block devices as
well as sockets and other special file descripto... | Documentation/driver-api/ioctl.rst | null | null | null | null | null |
source | linux | ==============================
IPMB Driver for a Satellite MC
==============================
The Intelligent Platform Management Bus or IPMB, is an
I2C bus that provides a standardized interconnection between
different boards within a chassis. This interconnection is
between the baseboard management (BMC) and chassis ... | Documentation/driver-api/ipmb.rst | null | null | null | null | null |
source | linux | =====================
The Linux IPMI Driver
=====================
:Author: Corey Minyard <minyard@mvista.com> / <minyard@acm.org>
The Intelligent Platform Management Interface, or IPMI, is a
standard for controlling intelligent devices that monitor a system.
It provides for dynamic discovery of sensors in the system ... | Documentation/driver-api/ipmi.rst | null | null | null | null | null |
source | linux | ===========
ISA Drivers
===========
The following text is adapted from the commit message of the initial
commit of the ISA bus driver authored by Rene Herman.
During the recent "isa drivers using platform devices" discussion it was
pointed out that (ALSA) ISA drivers ran into the problem of not having
the option to f... | Documentation/driver-api/isa.rst | null | null | null | null | null |
source | linux | ========================
libATA Developer's Guide
========================
:Author: Jeff Garzik
Introduction
============
libATA is a library used inside the Linux kernel to support ATA host
controllers and devices. libATA provides an ATA driver API, class
transports for ATA and ATAPI devices, and SCSI<->ATA transla... | Documentation/driver-api/libata.rst | null | null | null | null | null |
source | linux | ============================
The Common Mailbox Framework
============================
:Author: Jassi Brar <jaswinder.singh@linaro.org>
This document aims to help developers write client and controller
drivers for the API. But before we start, let us note that the
client (especially) and controller drivers are likely... | Documentation/driver-api/mailbox.rst | null | null | null | null | null |
source | linux | =================
MEN Chameleon Bus
=================
.. Table of Contents
=================
1 Introduction
1.1 Scope of this Document
1.2 Limitations of the current implementation
2 Architecture
2.1 MEN Chameleon Bus
2.2 Carrier Devices
2.3 Parser
3 Resource handling
... | Documentation/driver-api/men-chameleon-bus.rst | null | null | null | null | null |
source | linux | Message-based devices
=====================
Fusion message devices
----------------------
.. kernel-doc:: drivers/message/fusion/mptbase.c
:export:
.. kernel-doc:: drivers/message/fusion/mptscsih.c
:export: | Documentation/driver-api/message-based.rst | null | null | null | null | null |
source | linux | Parallel Port Devices
=====================
.. kernel-doc:: include/linux/parport.h
:internal:
.. kernel-doc:: drivers/parport/ieee1284.c
:export:
.. kernel-doc:: drivers/parport/share.c
:export:
.. kernel-doc:: drivers/parport/daisy.c
:internal:
16x50 UART Driver
=================
.. kernel-doc:: dri... | Documentation/driver-api/miscellaneous.rst | null | null | null | null | null |
source | linux | =====================================
MTD NAND Driver Programming Interface
=====================================
:Author: Thomas Gleixner
Introduction
============
The generic NAND driver supports almost all NAND and AG-AND based chips
and connects them to the Memory Technology Devices (MTD) subsystem of
the Linux ... | Documentation/driver-api/mtdnand.rst | null | null | null | null | null |
source | linux | ===========
NTB Drivers
===========
NTB (Non-Transparent Bridge) is a type of PCI-Express bridge chip that connects
the separate memory systems of two or more computers to the same PCI-Express
fabric. Existing NTB hardware supports a common feature set: doorbell
registers and memory translation windows, as well as non... | Documentation/driver-api/ntb.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===============
NVMEM Subsystem
===============
Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
This document explains the NVMEM Framework along with the APIs provided,
and how to use it.
1. Introduction
===============
*NVMEM* is the abbreviation for Non Volatile Memory la... | Documentation/driver-api/nvmem.rst | null | null | null | null | null |
source | linux | ===============================
PARPORT interface documentation
===============================
:Time-stamp: <2000-02-24 13:30:20 twaugh>
Described here are the following functions:
Global functions::
parport_register_driver
parport_unregister_driver
parport_enumerate
parport_register_device
parport_unreg... | Documentation/driver-api/parport-lowlevel.rst | null | null | null | null | null |
source | linux | ===============================
PINCTRL (PIN CONTROL) subsystem
===============================
This document outlines the pin control subsystem in Linux
This subsystem deals with:
- Enumerating and naming controllable pins
- Multiplexing of pins, pads, fingers (etc) see below for details
- Configuration of pins, ... | Documentation/driver-api/pin-control.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
======================
PPS - Pulse Per Second
======================
Copyright (C) 2007 Rodolfo Giometti <giometti@enneenne.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Softw... | Documentation/driver-api/pps.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===========================================
PTP hardware clock infrastructure for Linux
===========================================
This patch set introduces support for IEEE 1588 PTP clocks in
Linux. Together with the SO_TIMESTAMPING socket options, this
presents a standardi... | Documentation/driver-api/ptp.rst | null | null | null | null | null |
source | linux | ======================================
Pulse Width Modulation (PWM) interface
======================================
This provides an overview about the Linux PWM interface
PWMs are commonly used for controlling LEDs, fans or vibrators in
cell phones. PWMs with a fixed purpose have no need implementing
the Linux PWM ... | Documentation/driver-api/pwm.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-only
.. Copyright 2024 Linaro Ltd.
====================
Power Sequencing API
====================
:Author: Bartosz Golaszewski
Introduction
============
This framework is designed to abstract complex power-up sequences that are
shared between multiple logical devices in the Linux... | Documentation/driver-api/pwrseq.rst | null | null | null | null | null |
source | linux | .. Copyright 2007-2008 Wolfson Microelectronics
.. This documentation is free software; you can redistribute
.. it and/or modify it under the terms of the GNU General Public
.. License version 2 as published by the Free Software Foundation.
=================================
Voltage and current regulator API
===... | Documentation/driver-api/regulator.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-only
====================
Reset controller API
====================
Introduction
============
Reset controllers are central units that control the reset signals to multiple
peripherals.
The reset controller API is split into two parts:
the `consumer driver interface <#consumer-dri... | Documentation/driver-api/reset.rst | null | null | null | null | null |
source | linux | ===============================
rfkill - RF kill switch support
===============================
.. contents::
:depth: 2
Introduction
============
The rfkill subsystem provides a generic interface for disabling any radio
transmitter in the system. When a transmitter is blocked, it shall not
radiate any power.
Th... | Documentation/driver-api/rfkill.rst | null | null | null | null | null |
source | linux | ===================================
Writing s390 channel device drivers
===================================
:Author: Cornelia Huck
Introduction
============
This document describes the interfaces available for device drivers that
drive s390 based channel attached I/O devices. This includes interfaces
for interaction... | Documentation/driver-api/s390-drivers.rst | null | null | null | null | null |
source | linux | =====================
SCSI Interfaces Guide
=====================
:Author: James Bottomley
:Author: Rob Landley
Introduction
============
Protocol vs bus
---------------
Once upon a time, the Small Computer Systems Interface defined both a
parallel I/O bus and a data protocol to connect a wide variety of
peripheral... | Documentation/driver-api/scsi.rst | null | null | null | null | null |
source | linux | ============================
Linux kernel SLIMbus support
============================
Overview
========
What is SLIMbus?
----------------
SLIMbus (Serial Low Power Interchip Media Bus) is a specification developed by
MIPI (Mobile Industry Processor Interface) alliance. The bus uses master/slave
configuration, and is... | Documentation/driver-api/slimbus.rst | null | null | null | null | null |
source | linux | .. include:: <isonum.txt>
============
SM501 Driver
============
:Copyright: |copy| 2006, 2007 Simtec Electronics
The Silicon Motion SM501 multimedia companion chip is a multifunction device
which may provide numerous interfaces including USB host controller USB gadget,
asynchronous serial ports, audio functions, an... | Documentation/driver-api/sm501.rst | null | null | null | null | null |
source | linux | Serial Peripheral Interface (SPI)
=================================
SPI is the "Serial Peripheral Interface", widely used with embedded
systems because it is a simple and efficient interface: basically a
multiplexed shift register. Its three signal wires hold a clock (SCK,
often in the range of 1-20 MHz), a "Master Ou... | Documentation/driver-api/spi.rst | null | null | null | null | null |
source | linux | ========================
Linux Switchtec Support
========================
Microsemi's "Switchtec" line of PCI switch devices is already
supported by the kernel with standard PCI switch drivers. However, the
Switchtec device advertises a special management endpoint which
enables some additional functionality. This incl... | Documentation/driver-api/switchtec.rst | null | null | null | null | null |
source | linux | ===================
Sync File API Guide
===================
:Author: Gustavo Padovan <gustavo at padovan dot org>
This document serves as a guide for device drivers writers on what the
sync_file API is, and how drivers can support it. Sync file is the carrier of
the fences(struct dma_fence) that are needed to synchro... | Documentation/driver-api/sync_file.rst | null | null | null | null | null |
source | linux | =================================
target and iSCSI Interfaces Guide
=================================
Introduction and Overview
=========================
TBD
Target core device interfaces
=============================
This section is blank because no kerneldoc comments have been added to
drivers/target/target_core_... | Documentation/driver-api/target.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===============================================
TEE (Trusted Execution Environment) driver API
===============================================
Kernel provides a TEE bus infrastructure where a Trusted Application is
represented as a device identified via Universally Unique Identifie... | Documentation/driver-api/tee.rst | null | null | null | null | null |
source | linux | =======================
The Userspace I/O HOWTO
=======================
:Author: Hans-Jürgen Koch Linux developer, Linutronix
:Date: 2006-12-11
About this document
===================
Translations
------------
If you know of any translations for this document, or you are interested
in translating it, please email... | Documentation/driver-api/uio-howto.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-only
.. include:: <isonum.txt>
=====================
VFIO Mediated devices
=====================
:Copyright: |copy| 2016, NVIDIA CORPORATION. All rights reserved.
:Author: Neo Jia <cjia@nvidia.com>
:Author: Kirti Wankhede <kwankhede@nvidia.com>
Virtual Function I/O (VFIO) Mediat... | Documentation/driver-api/vfio-mediated-device.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Acceptance criteria for vfio-pci device specific driver variants
================================================================
Overview
--------
The vfio-pci driver exists as a device agnostic driver using the
system IOMMU and relying on the robustness of platform fault
handling... | Documentation/driver-api/vfio-pci-device-specific-driver-acceptance.rst | null | null | null | null | null |
source | linux | ==================================
VFIO - "Virtual Function I/O" [1]_
==================================
Many modern systems now provide DMA and interrupt remapping facilities
to help ensure I/O devices behave within the boundaries they've been
allotted. This includes x86 hardware with AMD-Vi and Intel VT-d,
POWER sy... | Documentation/driver-api/vfio.rst | null | null | null | null | null |
source | linux | VME Device Drivers
==================
Driver registration
-------------------
As with other subsystems within the Linux kernel, VME device drivers register
with the VME subsystem, typically called from the devices init routine. This is
achieved via a call to :c:func:`vme_register_driver`.
A pointer to a structure o... | Documentation/driver-api/vme.rst | null | null | null | null | null |
source | linux | ======================
W1: Dallas' 1-wire bus
======================
:Author: David Fries
W1 API internal to the kernel
=============================
include/linux/w1.h
~~~~~~~~~~~~~~~~~~
W1 kernel API functions.
.. kernel-doc:: include/linux/w1.h
:internal:
drivers/w1/w1.c
~~~~~~~~~~~~~~~
W1 core functions.
... | Documentation/driver-api/w1.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-or-later
=================================
WBRF - Wifi Band RFI Mitigations
=================================
Due to electrical and mechanical constraints in certain platform designs
there may be likely interference of relatively high-powered harmonics of
the GPU memory clocks with... | Documentation/driver-api/wbrf.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0-or-later
==============
WMI Driver API
==============
The WMI driver core supports a more modern bus-based interface for interacting
with WMI devices, and an older GUID-based interface. The latter interface is
considered to be deprecated, so new WMI drivers should generally avoid i... | Documentation/driver-api/wmi.rst | null | null | null | null | null |
source | linux | ==========================================
Xillybus driver for generic FPGA interface
==========================================
:Author: Eli Billauer, Xillybus Ltd. (http://xillybus.com)
:Email: eli.billauer@gmail.com or as advertised on Xillybus' site.
.. Contents:
- Introduction
-- Background
-- Xillybus Ov... | Documentation/driver-api/xillybus.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.