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 | ========================================
Writing Device Drivers for Zorro Devices
========================================
:Author: Written by Geert Uytterhoeven <geert@linux-m68k.org>
:Last revised: September 5, 2003
Introduction
------------
The Zorro bus is the bus used in the Amiga family of computers. Thanks t... | Documentation/driver-api/zorro.rst | null | null | null | null | null |
source | linux | ==================
cfg80211 subsystem
==================
.. kernel-doc:: include/net/cfg80211.h
:doc: Introduction
Device registration
===================
.. kernel-doc:: include/net/cfg80211.h
:doc: Device registration
.. kernel-doc:: include/net/cfg80211.h
:functions:
ieee80211_channel_flags
ieee80211_... | Documentation/driver-api/80211/cfg80211.rst | null | null | null | null | null |
source | linux | =====================================
Linux 802.11 Driver Developer's Guide
=====================================
.. toctree::
introduction
cfg80211
mac80211
mac80211-advanced | Documentation/driver-api/80211/index.rst | null | null | null | null | null |
source | linux | ============
Introduction
============
Explaining wireless 802.11 networking in the Linux kernel
Copyright 2007-2009 Johannes Berg
These books attempt to give a description of the various subsystems
that play a role in 802.11 wireless networking in Linux. Since these
books are for kernel developers they attempts to ... | Documentation/driver-api/80211/introduction.rst | null | null | null | null | null |
source | linux | =============================
mac80211 subsystem (advanced)
=============================
Information contained within this part of the book is of interest only
for advanced interaction of mac80211 with drivers to exploit more
hardware capabilities and improve performance.
LED support
===========
Mac80211 supports v... | Documentation/driver-api/80211/mac80211-advanced.rst | null | null | null | null | null |
source | linux | ===========================
mac80211 subsystem (basics)
===========================
You should read and understand the information contained within this
part of the book while implementing a mac80211 driver. In some chapters,
advanced usage is noted, those may be skipped if this isn't needed.
This part of the book on... | Documentation/driver-api/80211/mac80211.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
=========================================
Why using ACPI drivers is not a good idea
=========================================
:Copyright: |copy| 2026, Intel Corporation
:Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Even though binding drivers d... | Documentation/driver-api/acpi/acpi-drivers.rst | null | null | null | null | null |
source | linux | ============
ACPI Support
============
.. toctree::
:maxdepth: 2
linuxized-acpica
scan_handlers
acpi-drivers | Documentation/driver-api/acpi/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
============================================================
Linuxized ACPICA - Introduction to ACPICA Release Automation
============================================================
:Copyright: |copy| 2013-2016, Intel Corporation
:Author: Lv Zheng <lv.zh... | Documentation/driver-api/acpi/linuxized-acpica.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
==================
ACPI Scan Handlers
==================
:Copyright: |copy| 2012, Intel Corporation
:Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
During system initialization and ACPI-based device hot-add, the ACPI namespace
is scanned in searc... | Documentation/driver-api/acpi/scan_handlers.rst | null | null | null | null | null |
source | linux | ====================
Kernel driver lp855x
====================
Backlight driver for LP855x ICs
Supported chips:
Texas Instruments LP8550, LP8551, LP8552, LP8553, LP8555, LP8556 and
LP8557
Author: Milo(Woogyom) Kim <milo.kim@ti.com>
Description
-----------
* Brightness control
Brightness can be controlled by ... | Documentation/driver-api/backlight/lp855x-driver.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
======================
Confidential Computing
======================
.. toctree::
:maxdepth: 1
measurement-registers | Documentation/driver-api/coco/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
=====================
Measurement Registers
=====================
.. kernel-doc:: include/linux/tsm-mr.h
:internal:
.. kernel-doc:: drivers/virt/coco/guest/tsm-mr.c
:export: | Documentation/driver-api/coco/measurement-registers.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==============
Crypto Drivers
==============
Documentation for crypto drivers that may need more involved setup and
configuration.
.. toctree::
:maxdepth: 1
iaa/index | Documentation/driver-api/crypto/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=========================================
IAA Compression Accelerator Crypto Driver
=========================================
Tom Zanussi <tom.zanussi@linux.intel.com>
The IAA crypto driver supports compression/decompression compatible
with the DEFLATE compression standard describ... | Documentation/driver-api/crypto/iaa/iaa-crypto.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=================================
IAA (Intel Analytics Accelerator)
=================================
IAA provides hardware compression and decompression via the crypto
API.
.. toctree::
:maxdepth: 1
iaa-crypto | Documentation/driver-api/crypto/iaa/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Compute Express Link: Linux Conventions
#######################################
There exists shipping platforms that bend or break CXL specification
expectations. Record the details and the rationale for those deviations.
Borrow the ACPI Code First template format to capture the as... | Documentation/driver-api/cxl/conventions.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
====================
Compute Express Link
====================
CXL device configuration has a complex handoff between platform (Hardware,
BIOS, EFI), OS (early boot, core kernel, driver), and user policy decisions
that have impacts on each other. The docs here break up configurati... | Documentation/driver-api/cxl/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
===========================================
Compute Express Link Subsystem Maturity Map
===========================================
The Linux CXL subsystem tracks the dynamic `CXL specification
<https://computeexpresslink.org/cxl-specification-landing-page... | Documentation/driver-api/cxl/maturity-map.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
===============================================
Compute Express Link Driver Theory of Operation
===============================================
A Compute Express Link Memory Device is a CXL component that implements the
CXL.mem protocol. It contains some a... | Documentation/driver-api/cxl/theory-of-operation.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===========
DAX Devices
===========
CXL capacity exposed as a DAX device can be accessed directly via mmap.
Users may wish to use this interface mechanism to write their own userland
CXL allocator, or to managed shared or persistent memory regions across multiple
hosts.
If the capa... | Documentation/driver-api/cxl/allocation/dax.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==========
Huge Pages
==========
Contiguous Memory Allocator
===========================
CXL Memory onlined as SystemRAM during early boot is eligible for use by CMA,
as the NUMA node hosting that capacity will be `Online` at the time CMA
carves out contiguous capacity.
CXL Memory... | Documentation/driver-api/cxl/allocation/hugepages.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==================
The Page Allocator
==================
The kernel page allocator services all general page allocation requests, such
as :code:`kmalloc`. CXL configuration steps affect the behavior of the page
allocator based on the selected `Memory Zone` and `NUMA node` the capa... | Documentation/driver-api/cxl/allocation/page-allocator.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=======
Reclaim
=======
Another way CXL memory can be utilized *indirectly* is via the reclaim system
in :code:`mm/vmscan.c`. Reclaim is engaged when memory capacity on the system
becomes pressured based on global and cgroup-local `watermark` settings.
In this section we won't dis... | Documentation/driver-api/cxl/allocation/reclaim.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
ACPI PRM CXL Address Translation
================================
Document
--------
CXL Revision 3.2, Version 1.0
License
-------
SPDX-License Identifier: CC-BY-4.0
Creator/Contributors
--------------------
- Robert Richter, AMD et al.
Summary of the Change
------------------... | Documentation/driver-api/cxl/conventions/cxl-atl.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Resolve conflict between CFMWS, Platform Memory Holes, and Endpoint Decoders
============================================================================
Document
--------
CXL Revision 3.2, Version 1.0
License
-------
SPDX-License Identifier: CC-BY-4.0
Creator/Contributors
----... | Documentation/driver-api/cxl/conventions/cxl-lmh.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. :: Template Title here:
Template File
=============
Document
--------
CXL Revision <rev>, Version <ver>
License
-------
SPDX-License Identifier: CC-BY-4.0
Creator/Contributors
--------------------
Summary of the Change
---------------------
<Detail the conflict with the spe... | Documentation/driver-api/cxl/conventions/template.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================
Devices and Protocols
=====================
The type of CXL device (Memory, Accelerator, etc) dictates many configuration steps. This section
covers some basic background on device types and on-device resources used by the platform and OS
which impact configur... | Documentation/driver-api/cxl/devices/device-types.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
==================================
CXL Access Coordinates Computation
==================================
Latency and Bandwidth Calculation
=================================
A memory region performance coordinates (latency and bandwidth) are typically
provi... | Documentation/driver-api/cxl/linux/access-coordinates.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
====================
CXL Driver Operation
====================
The devices described in this section are present in ::
/sys/bus/cxl/devices/
/dev/cxl/
The :code:`cxl-cli` library, maintained as part of the NDTCL project, may
be used to script interactions with these devices.
... | Documentation/driver-api/cxl/linux/cxl-driver.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
====================
DAX Driver Operation
====================
The `Direct Access Device` driver was originally designed to provide a
memory-like access mechanism to memory-like block-devices. It was
extended to support CXL Memory Devices, which provide user-configured
memory devic... | Documentation/driver-api/cxl/linux/dax-driver.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=======================
Linux Init (Early Boot)
=======================
Linux configuration is split into two major steps: Early-Boot and everything else.
During early boot, Linux sets up immutable resources (such as numa nodes), while
later operations include things like driver p... | Documentation/driver-api/cxl/linux/early-boot.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==============
Memory Hotplug
==============
The final phase of surfacing CXL memory to the kernel page allocator is for
the `DAX` driver to surface a `Driver Managed` memory region via the
memory-hotplug component.
There are four major configurations to consider:
1) Default Onlin... | Documentation/driver-api/cxl/linux/memory-hotplug.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
========
Overview
========
This section presents the configuration process of a CXL Type-3 memory device,
and how it is ultimately exposed to users as either a :code:`DAX` device or
normal memory pages via the kernel's page allocator.
Portions marked with a bullet are points at wh... | Documentation/driver-api/cxl/linux/overview.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============================
Inter-Host-Bridge Interleave
============================
This cxl-cli configuration dump shows the following host configuration:
* A single socket system with one CXL root
* CXL Root has Four (4) CXL Host Bridges
* Two CXL Host Bridges have a single CX... | Documentation/driver-api/cxl/linux/example-configurations/hb-interleave.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============================
Intra-Host-Bridge Interleave
============================
This cxl-cli configuration dump shows the following host configuration:
* A single socket system with one CXL root
* CXL Root has Four (4) CXL Host Bridges
* One (1) CXL Host Bridges has two CXL ... | Documentation/driver-api/cxl/linux/example-configurations/intra-hb-interleave.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
======================
Multi-Level Interleave
======================
This cxl-cli configuration dump shows the following host configuration:
* A single socket system with one CXL root
* CXL Root has Four (4) CXL Host Bridges
* Two CXL Host Bridges have a two CXL Memory Expanders At... | Documentation/driver-api/cxl/linux/example-configurations/multi-interleave.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============
Single Device
=============
This cxl-cli configuration dump shows the following host configuration:
* A single socket system with one CXL root
* CXL Root has Four (4) CXL Host Bridges
* One CXL Host Bridges has a single CXL Memory Expander Attached
* No interleave is ... | Documentation/driver-api/cxl/linux/example-configurations/single-device.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===========
ACPI Tables
===========
ACPI is the "Advanced Configuration and Power Interface", which is a standard
that defines how platforms and OS manage power and configure computer hardware.
For the purpose of this theory of operation, when referring to "ACPI" we will
usually re... | Documentation/driver-api/cxl/platform/acpi.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
======================
BIOS/EFI Configuration
======================
BIOS and EFI are largely responsible for configuring static information about
devices (or potential future devices) such that Linux can build the appropriate
logical representations of these devices.
At a high le... | Documentation/driver-api/cxl/platform/bios-and-efi.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
======================================
Coherent Device Attribute Table (CDAT)
======================================
The CDAT provides functional and performance attributes of devices such
as CXL accelerators, switches, or endpoints. The table formatting is
similar to ACPI tables.... | Documentation/driver-api/cxl/platform/cdat.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==================
CXL Device Hotplug
==================
Device hotplug refers to *physical* hotplug of a device (addition or removal
of a physical device from the machine).
BIOS/EFI software is expected to configure sufficient resources **at boot
time** to allow hotplugged device... | Documentation/driver-api/cxl/platform/device-hotplug.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Example Platform Configurations
###############################
.. toctree::
:maxdepth: 1
:caption: Contents
example-configurations/one-dev-per-hb.rst
example-configurations/multi-dev-per-hb.rst
example-configurations/hb-interleave.rst
example-configurations/flex... | Documentation/driver-api/cxl/platform/example-configs.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
================================
CEDT - CXL Early Discovery Table
================================
The CXL Early Discovery Table is generated by BIOS to describe the CXL memory
regions configured at boot by the BIOS.
CHBS
====
The CXL Host Bridge Structure describes CXL host bridg... | Documentation/driver-api/cxl/platform/acpi/cedt.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==============================================
DSDT - Differentiated system Description Table
==============================================
This table describes what peripherals a machine has.
This table's UIDs for CXL devices - specifically host bridges, must be
consistent with ... | Documentation/driver-api/cxl/platform/acpi/dsdt.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===========================================
HMAT - Heterogeneous Memory Attribute Table
===========================================
The Heterogeneous Memory Attributes Table contains information such as cache
attributes and bandwidth and latency details for memory proximity domains... | Documentation/driver-api/cxl/platform/acpi/hmat.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
========================================
SLIT - System Locality Information Table
========================================
The system locality information table provides "abstract distances" between
accessor and memory nodes. Node without initiators (cpus) are infinitely (FF)
dist... | Documentation/driver-api/cxl/platform/acpi/slit.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================================
SRAT - Static Resource Affinity Table
=====================================
The System/Static Resource Affinity Table describes resource (CPU, Memory)
affinity to "Proximity Domains". This table is technically optional, but for
performance info... | Documentation/driver-api/cxl/platform/acpi/srat.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================
Flexible Presentation
=====================
This system has a single socket with two CXL host bridges. Each host bridge
has two CXL memory expanders with a 4GB of memory (32GB total).
On this system, the platform designer wanted to provide the user flexibility... | Documentation/driver-api/cxl/platform/example-configurations/flexible.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============================
Cross-Host-Bridge Interleave
============================
This system has a single socket with two CXL host bridges. Each host bridge
has a single CXL memory expander with a 4GB of memory.
Things to note:
* Cross-Bridge interleave is described.
* The e... | Documentation/driver-api/cxl/platform/example-configurations/hb-interleave.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
================================
Multiple Devices per Host Bridge
================================
In this example system we will have a single socket and one CXL host bridge.
There are two CXL memory expanders with 4GB attached to the host bridge.
Things to note:
* Intra-Bridge ... | Documentation/driver-api/cxl/platform/example-configurations/multi-dev-per-hb.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==========================
One Device per Host Bridge
==========================
This system has a single socket with two CXL host bridges. Each host bridge
has a single CXL memory expander with a 4GB of memory.
Things to note:
* Cross-Bridge interleave is not being used.
* The e... | Documentation/driver-api/cxl/platform/example-configurations/one-dev-per-hb.rst | null | null | null | null | null |
source | linux | ====================
DMA Engine API Guide
====================
Vinod Koul <vinod dot koul at intel.com>
.. note:: For DMA Engine usage in async_tx please see:
``Documentation/crypto/async-tx-api.rst``
Below is a guide to device driver writers on how to use the Slave-DMA API of the
DMA Engine. This is appl... | Documentation/driver-api/dmaengine/client.rst | null | null | null | null | null |
source | linux | ==============
DMA Test Guide
==============
Andy Shevchenko <andriy.shevchenko@linux.intel.com>
This small document introduces how to test DMA drivers using dmatest module.
The dmatest module tests DMA memcpy, memset, XOR and RAID6 P+Q operations using
various lengths and various offsets into the source and destina... | Documentation/driver-api/dmaengine/dmatest.rst | null | null | null | null | null |
source | linux | =======================
DMAEngine documentation
=======================
DMAEngine documentation provides documents for various aspects of DMAEngine
framework.
DMAEngine development documentation
-----------------------------------
This book helps with DMAengine internal APIs and guide for DMAEngine device
driver wri... | Documentation/driver-api/dmaengine/index.rst | null | null | null | null | null |
source | linux | ==================================
DMAengine controller documentation
==================================
Hardware Introduction
=====================
Most of the Slave DMA controllers have the same general principles of
operations.
They have a given number of channels to use for the DMA transfers, and
a given number ... | Documentation/driver-api/dmaengine/provider.rst | null | null | null | null | null |
source | linux | ==============================
PXA/MMP - DMA Slave controller
==============================
Constraints
===========
a) Transfers hot queuing
A driver submitting a transfer and issuing it should be granted the transfer
is queued even on a running DMA channel.
This implies that the queuing doesn't wait for the previou... | Documentation/driver-api/dmaengine/pxa_dma.rst | null | null | null | null | null |
source | linux | ==============
Driver Binding
==============
Driver binding is the process of associating a device with a device
driver that can control it. Bus drivers have typically handled this
because there have been bus-specific structures to represent the
devices and the drivers. With generic device and device driver
structures... | Documentation/driver-api/driver-model/binding.rst | null | null | null | null | null |
source | linux | =========
Bus Types
=========
Definition
~~~~~~~~~~
See the kerneldoc for the struct bus_type.
int bus_register(struct bus_type * bus);
Declaration
~~~~~~~~~~~
Each bus type in the kernel (PCI, USB, etc) should declare one static
object of this type. They must initialize the name field, and may
optionally initiali... | Documentation/driver-api/driver-model/bus.rst | null | null | null | null | null |
source | linux | =============================
Device Driver Design Patterns
=============================
This document describes a few common design patterns found in device drivers.
It is likely that subsystem maintainers will ask driver developers to
conform to these design patterns.
1. State Container
2. container_of()
1. Stat... | Documentation/driver-api/driver-model/design-patterns.rst | null | null | null | null | null |
source | linux | ==========================
The Basic Device Structure
==========================
See the kerneldoc for the struct device.
Programming Interface
~~~~~~~~~~~~~~~~~~~~~
The bus driver that discovers the device uses this to register the
device with the core::
int device_register(struct device * dev);
The bus should ... | Documentation/driver-api/driver-model/device.rst | null | null | null | null | null |
source | linux | ================================
Devres - Managed Device Resource
================================
Tejun Heo <teheo@suse.de>
First draft 10 January 2007
.. contents
1. Intro : Huh? Devres?
2. Devres : Devres in a nutshell
3. Devres Group : Group devres'es and release them together
4. Details : Li... | Documentation/driver-api/driver-model/devres.rst | null | null | null | null | null |
source | linux | ==============
Device Drivers
==============
See the kerneldoc for the struct device_driver.
Allocation
~~~~~~~~~~
Device drivers are statically allocated structures. Though there may
be multiple devices in a system that a driver supports, struct
device_driver represents the driver as a whole (not a particular
devic... | Documentation/driver-api/driver-model/driver.rst | null | null | null | null | null |
source | linux | ============
Driver Model
============
.. toctree::
:maxdepth: 1
binding
bus
design-patterns
device
devres
driver
overview
platform
porting | Documentation/driver-api/driver-model/index.rst | null | null | null | null | null |
source | linux | =============================
The Linux Kernel Device Model
=============================
Patrick Mochel <mochel@digitalimplant.org>
Drafted 26 August 2002
Updated 31 January 2006
Overview
~~~~~~~~
The Linux Kernel Driver Model is a unification of all the disparate driver
models that were previously used in the ke... | Documentation/driver-api/driver-model/overview.rst | null | null | null | null | null |
source | linux | ============================
Platform Devices and Drivers
============================
See <linux/platform_device.h> for the driver model interface to the
platform bus: platform_device, and platform_driver. This pseudo-bus
is used to connect devices on buses with minimal infrastructure,
like those used to integrate ... | Documentation/driver-api/driver-model/platform.rst | null | null | null | null | null |
source | linux | =======================================
Porting Drivers to the New Driver Model
=======================================
Patrick Mochel
7 January 2003
Overview
Please refer to `Documentation/driver-api/driver-model/*.rst` for definitions of
various driver types and concepts.
Most of the work of porting devices dri... | Documentation/driver-api/driver-model/porting.rst | null | null | null | null | null |
source | linux | =======================
initramfs buffer format
=======================
Al Viro, H. Peter Anvin
With kernel 2.5.x, the old "initial ramdisk" protocol was complemented
with an "initial ramfs" protocol. The initramfs content is passed
using the same memory buffer protocol used by initrd, but the content
is different. ... | Documentation/driver-api/early-userspace/buffer-format.rst | null | null | null | null | null |
source | linux | =======================
Early userspace support
=======================
Last update: 2004-12-20 tlh
"Early userspace" is a set of libraries and programs that provide
various pieces of functionality that are important enough to be
available while a Linux kernel is coming up, but that don't need to be
run inside the k... | Documentation/driver-api/early-userspace/early_userspace_support.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===============
Early Userspace
===============
.. toctree::
:maxdepth: 1
early_userspace_support
buffer-format | Documentation/driver-api/early-userspace/index.rst | null | null | null | null | null |
source | linux | =================
Built-in firmware
=================
Firmware can be built-in to the kernel, this means building the firmware
into vmlinux directly, to enable avoiding having to look for firmware from
the filesystem. Instead, firmware can be looked for inside the kernel
directly. You can enable built-in firmware usin... | Documentation/driver-api/firmware/built-in-fw.rst | null | null | null | null | null |
source | linux | ==========================
Firmware API core features
==========================
The firmware API has a rich set of core features available. This section
documents these features.
.. toctree::
fw_search_path
built-in-fw
firmware_cache
direct-fs-lookup
fallback-mechanisms
lookup-order
firmware-us... | Documentation/driver-api/firmware/core.rst | null | null | null | null | null |
source | linux | ========================
Direct filesystem lookup
========================
Direct filesystem lookup is the most common form of firmware lookup performed
by the kernel. The kernel looks for the firmware directly on the root
filesystem in the paths documented in the section 'Firmware search paths'.
The filesystem lookup... | Documentation/driver-api/firmware/direct-fs-lookup.rst | null | null | null | null | null |
source | linux | ===================
Fallback mechanisms
===================
A fallback mechanism is supported to allow to overcome failures to do a direct
filesystem lookup on the root filesystem or when the firmware simply cannot be
installed for practical reasons on the root filesystem. The kernel
configuration options related to s... | Documentation/driver-api/firmware/fallback-mechanisms.rst | null | null | null | null | null |
source | linux | ===================
Firmware Guidelines
===================
Users switching to a newer kernel should *not* have to install newer
firmware files to keep their hardware working. At the same time updated
firmware files must not cause any regressions for users of older kernel
releases.
Drivers that use firmware from linu... | Documentation/driver-api/firmware/firmware-usage-guidelines.rst | null | null | null | null | null |
source | linux | ==============
Firmware cache
==============
When Linux resumes from suspend some device drivers require firmware lookups to
re-initialize devices. During resume there may be a period of time during which
firmware lookups are not possible, during this short period of time firmware
requests will fail. Time is of essenc... | Documentation/driver-api/firmware/firmware_cache.rst | null | null | null | null | null |
source | linux | =====================
Firmware search paths
=====================
The following search paths are used to look for firmware on your
root filesystem.
* fw_path_para - module parameter - default is empty so this is ignored
* /lib/firmware/updates/UTS_RELEASE/
* /lib/firmware/updates/
* /lib/firmware/UTS_RELEASE/
* /lib/... | Documentation/driver-api/firmware/fw_search_path.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===================
Firmware Upload API
===================
A device driver that registers with the firmware loader will expose
persistent sysfs nodes to enable users to initiate firmware updates for
that device. It is the responsibility of the device driver and/or the
device itse... | Documentation/driver-api/firmware/fw_upload.rst | null | null | null | null | null |
source | linux | ==================
Linux Firmware API
==================
.. toctree::
introduction
core
efi/index
request_firmware
fw_upload
other_interfaces | Documentation/driver-api/firmware/index.rst | null | null | null | null | null |
source | linux | ============
Introduction
============
The firmware API enables kernel code to request files required
for functionality from userspace, the uses vary:
* Microcode for CPU errata
* Device driver firmware, required to be loaded onto device
microcontrollers
* Device driver information data (calibration data, EEPROM ov... | Documentation/driver-api/firmware/introduction.rst | null | null | null | null | null |
source | linux | =====================
Firmware lookup order
=====================
Different functionality is available to enable firmware to be found.
Below is chronological order of how firmware will be looked for once
a driver issues a firmware API call.
* The ''Built-in firmware'' is checked first, if the firmware is present we
... | Documentation/driver-api/firmware/lookup-order.rst | null | null | null | null | null |
source | linux | Other Firmware Interfaces
=========================
DMI Interfaces
--------------
.. kernel-doc:: drivers/firmware/dmi_scan.c
:export:
EDD Interfaces
--------------
.. kernel-doc:: drivers/firmware/edd.c
:internal:
Generic System Framebuffers Interface
-------------------------------------
.. kernel-doc:: d... | Documentation/driver-api/firmware/other_interfaces.rst | null | null | null | null | null |
source | linux | ====================
request_firmware API
====================
You would typically load firmware and then load it into your device somehow.
The typical firmware work flow is reflected below::
if(request_firmware(&fw_entry, $FIRMWARE, device) == 0)
copy_fw_to_device(fw_entry->data, fw_entry->size);
... | Documentation/driver-api/firmware/request_firmware.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
====================================================
Unified Extensible Firmware Interface (UEFI) Support
====================================================
UEFI stub library functions
===========================
.. kernel-doc:: drivers/firmware/efi/libstub/mem.c
:internal:
... | Documentation/driver-api/firmware/efi/index.rst | null | null | null | null | null |
source | linux | FPGA Bridge
===========
API to implement a new FPGA bridge
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* struct fpga_bridge - The FPGA Bridge structure
* struct fpga_bridge_ops - Low level Bridge driver ops
* __fpga_bridge_register() - Create and register a bridge
* fpga_bridge_unregister() - Unregister a bridge
The helper m... | Documentation/driver-api/fpga/fpga-bridge.rst | null | null | null | null | null |
source | linux | FPGA Manager
============
Overview
--------
The FPGA manager core exports a set of functions for programming an FPGA with
an image. The API is manufacturer agnostic. All manufacturer specifics are
hidden away in a low level driver which registers a set of ops with the core.
The FPGA image data itself is very manufa... | Documentation/driver-api/fpga/fpga-mgr.rst | null | null | null | null | null |
source | linux | In-kernel API for FPGA Programming
==================================
Overview
--------
The in-kernel API for FPGA programming is a combination of APIs from
FPGA manager, bridge, and regions. The actual function used to
trigger FPGA programming is fpga_region_program_fpga().
fpga_region_program_fpga() uses function... | Documentation/driver-api/fpga/fpga-programming.rst | null | null | null | null | null |
source | linux | FPGA Region
===========
Overview
--------
This document is meant to be a brief overview of the FPGA region API usage. A
more conceptual look at regions can be found in the Device Tree binding
document [#f1]_.
For the purposes of this API document, let's just say that a region associates
an FPGA Manager and a bridge... | Documentation/driver-api/fpga/fpga-region.rst | null | null | null | null | null |
source | linux | ==============
FPGA Subsystem
==============
:Author: Alan Tull
.. toctree::
:maxdepth: 2
intro
fpga-mgr
fpga-bridge
fpga-region
fpga-programming | Documentation/driver-api/fpga/index.rst | null | null | null | null | null |
source | linux | Introduction
============
The FPGA subsystem supports reprogramming FPGAs dynamically under
Linux. Some of the core intentions of the FPGA subsystems are:
* The FPGA subsystem is vendor agnostic.
* The FPGA subsystem separates upper layers (userspace interfaces and
enumeration) from lower layers that know how to ... | Documentation/driver-api/fpga/intro.rst | null | null | null | null | null |
source | linux | =============
GPIO Mappings
=============
This document explains how GPIOs can be assigned to given devices and functions.
All platforms can enable the GPIO library, but if the platform strictly
requires GPIO functionality to be present, it needs to select GPIOLIB from its
Kconfig. Then, how GPIOs are mapped depends ... | Documentation/driver-api/gpio/board.rst | null | null | null | null | null |
source | linux | ===================================================================
A driver for a selfmade cheap BT8xx based PCI GPIO-card (bt8xxgpio)
===================================================================
For advanced documentation, see https://bues.ch/cms/unmaintained/btgpio.html
A generic digital 24-port PCI GPIO ca... | Documentation/driver-api/gpio/bt8xxgpio.rst | null | null | null | null | null |
source | linux | ==================================
GPIO Descriptor Consumer Interface
==================================
This document describes the consumer interface of the GPIO framework.
Guidelines for GPIOs consumers
==============================
Drivers that can't work without standard GPIO calls should have Kconfig entries... | Documentation/driver-api/gpio/consumer.rst | null | null | null | null | null |
source | linux | =====================
GPIO Driver Interface
=====================
This document serves as a guide for writers of GPIO chip drivers.
Each GPIO controller driver needs to include the following header, which defines
the structures used to define a GPIO driver::
#include <linux/gpio/driver.h>
Internal Representation... | Documentation/driver-api/gpio/driver.rst | null | null | null | null | null |
source | linux | ============================
Subsystem drivers using GPIO
============================
Note that standard kernel drivers exist for common GPIO tasks and will provide
the right in-kernel and userspace APIs/ABIs for the job, and that these
drivers can quite easily interconnect with other kernel subsystems using
hardware... | Documentation/driver-api/gpio/drivers-on-gpio.rst | null | null | null | null | null |
source | linux | ===================================
General Purpose Input/Output (GPIO)
===================================
Contents:
.. toctree::
:maxdepth: 2
intro
using-gpio
driver
consumer
board
legacy-boards
drivers-on-gpio
bt8xxgpio
pca953x
Core
====
.. kernel-doc:: include/linux/gpio/driver.h
... | Documentation/driver-api/gpio/index.rst | null | null | null | null | null |
source | linux | ============
Introduction
============
GPIO Interfaces
===============
The documents in this directory give detailed instructions on how to access
GPIOs in drivers, and how to write a driver for a device that provides GPIOs
itself.
What is a GPIO?
===============
A "General Purpose Input/Output" (GPIO) is a flexi... | Documentation/driver-api/gpio/intro.rst | null | null | null | null | null |
source | linux | Supporting Legacy Boards
========================
Many drivers in the kernel, such as ``leds-gpio`` and ``gpio-keys``, are
migrating away from using board-specific ``platform_data`` to a unified device
properties interface. This interface allows drivers to be simpler and more
generic, as they can query properties in a... | Documentation/driver-api/gpio/legacy-boards.rst | null | null | null | null | null |
source | linux | ============================================
PCA953x I²C GPIO expander compatibility list
============================================
:Author: Levente Révész <levente.revesz@eilabs.com>
I went through all the datasheets and created this note listing
chip functions and register layouts.
Overview of chips
===========... | Documentation/driver-api/gpio/pca953x.rst | null | null | null | null | null |
source | linux | =========================
Using GPIO Lines in Linux
=========================
The Linux kernel exists to abstract and present hardware to users. GPIO lines
as such are normally not user facing abstractions. The most obvious, natural
and preferred way to use GPIO lines is to let kernel hardware drivers deal
with them.
... | Documentation/driver-api/gpio/using-gpio.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.