The Linux Kernel
  • The Linux kernel user’s and administrator’s guide
    • Linux kernel release 4.x <http://kernel.org/>
      • What is Linux?
      • On what hardware does it run?
      • Documentation
      • Installing the kernel source
      • Software requirements
      • Build directory for the kernel
      • Configuring the kernel
      • Compiling the kernel
      • If something goes wrong
    • The kernel’s command-line parameters
      • cpu lists:
      • Todo
    • Linux allocated devices (4.x+ version)
      • Additional /dev/ directory entries
        • Compulsory links
        • Recommended links
        • Locally defined links
        • Sockets and pipes
        • Mount points
      • Terminal devices
        • Virtual consoles and the console device
        • Serial ports
        • Pseudoterminals (PTYs)
    • Reporting bugs
      • Background
      • How to report Linux kernel bugs
        • Identify the problematic subsystem
        • Identify who to notify
        • Tips for reporting bugs
        • Gather information
      • Follow up
        • Expectations for bug reporters
        • Expectations for kernel maintainers
    • Security bugs
      • Contact
      • Disclosure
      • Coordination
      • CVE assignment
      • Non-disclosure agreements
    • Bug hunting
      • Where is the Oops message is located?
      • Finding the bug’s location
        • gdb
        • objdump
      • Reporting the bug
      • Fixing the bug
      • Notes on Oops tracing with klogd
    • Bisecting a bug
      • Introduction
      • Devices not appearing
      • Finding patch that caused a bug
    • Tainted kernels
    • Ramoops oops/panic logger
      • Introduction
      • Ramoops concepts
      • Setting the parameters
      • Dump format
      • Reading the data
      • Persistent function tracing
    • Dynamic debug
      • Introduction
      • Controlling dynamic debug Behaviour
      • Viewing Dynamic Debug Behaviour
      • Command Language Reference
      • Debug messages during Boot Process
      • Debug Messages at Module Initialization Time
      • Examples
    • Explaining the dreaded “No init found.” boot hang message
    • Rules on how to access information in sysfs
    • Using the initial RAM disk (initrd)
      • Operation
      • Boot command-line options
      • Compressed cpio images
      • Installation
      • Changing the root device
      • Usage scenarios
      • Obsolete root change mechanism
      • Mixed change_root and pivot_root mechanism
      • Resources
    • Linux Serial Console
    • Linux Braille Console
    • Parport
      • Parport as modules
        • modprobe
        • Parport probe [optional]
      • Parport linked into the kernel statically
      • Files in /proc
      • Device drivers
      • Reporting printer problems with parport
    • RAID arrays
      • Boot time assembly of RAID arrays
        • md device no.
        • raid level
        • chunk size factor
        • fault level
        • dev0 to devn
      • Boot time autodetection of RAID arrays
      • Boot time assembly of degraded/dirty arrays
      • Superblock formats
      • General Rules - apply for all superblock formats
      • Specific Rules that apply to format-0 super block arrays, and arrays with no superblock (non-persistent)
      • MD devices in sysfs
    • Kernel module signing facility
      • Overview
      • Configuring module signing
      • Generating signing keys
      • Public keys in the kernel
      • Manually signing modules
      • Signed modules and stripping
      • Loading signed modules
      • Non-valid signatures and unsigned modules
      • Administering/protecting the private key
    • Linux Magic System Request Key Hacks
      • What is the magic SysRq key?
      • How do I enable the magic SysRq key?
      • How do I use the magic SysRq key?
      • What are the ‘command’ keys?
      • Okay, so what can I use them for?
      • Sometimes SysRq seems to get ‘stuck’ after using it, what can I do?
      • I hit SysRq, but nothing seems to happen, what’s wrong?
      • I want to add SysRQ key events to a module, how does it work?
      • When I hit a SysRq key combination only the header appears on the console?
      • I have more questions, who can I ask?
      • Credits
    • Unicode support
      • Introduction
      • Actual characters assigned in the Linux Zone
      • Klingon language support
      • Other Fictional and Artificial Scripts
    • Software cursor for VGA
      • Examples
    • Kernel Support for miscellaneous (your favourite) Binary Formats v1.1
      • Hints
    • Mono(tm) Binary Kernel Support for Linux
    • Java(tm) Binary Kernel Support for Linux v1.03
    • Reliability, Availability and Serviceability
      • RAS concepts
        • Improving RAS
        • Types of errors
        • Identifying a bad hardware component
        • ECC memory
      • EDAC - Error Detection And Correction
        • Purpose
        • Memory
        • Other hardware elements
        • PCI bus scanning
        • Versioning
        • Loading
        • Sysfs interface
        • Memory Controller (mc) Model
        • mcX directories
        • dimmX or rankX directories
        • csrowX directories
        • System Logging
        • PCI Bus Parity Detection
        • Sysfs configuration
        • Module parameters
        • EDAC device type
        • Instances
        • Blocks
        • Usage of EDAC APIs on Nehalem and newer Intel CPUs
        • Reference documents used on amd64_edac
    • Power Management
      • CPU Performance Scaling
        • The Concept of CPU Performance Scaling
        • CPU Performance Scaling in Linux
        • CPUFreq Policy Objects
        • CPU Initialization
        • Policy Interface in sysfs
        • Generic Scaling Governors
        • Frequency Boost Support
      • intel_pstate CPU Performance Scaling Driver
        • General Information
        • Operation Modes
        • Turbo P-states Support
        • Processor Support
        • User Space Interface in sysfs
        • intel_pstate vs acpi-cpufreq
        • Kernel Command Line Options for intel_pstate
        • Diagnostics and Tuning
    • Thunderbolt
      • Security levels and how to use them
      • Authorizing devices when security level is user or secure
      • Upgrading NVM on Thunderbolt device or host
      • Upgrading NVM when host controller is in safe mode
    • Linux Security Module Usage
      • AppArmor
        • What is AppArmor?
        • How to enable/disable
        • Documentation
        • Links
      • LoadPin
      • SELinux
      • Smack
        • The Simplified Mandatory Access Control Kernel (Whitepaper)
      • TOMOYO
        • What is TOMOYO?
        • How to enable TOMOYO?
        • Where is documentation?
        • What is future plan?
      • Yama
        • ptrace_scope
  • The Linux kernel user-space API guide
    • No New Privileges Flag
    • Seccomp BPF (SECure COMPuting with filters)
      • Introduction
      • What it isn’t
      • Usage
      • Return values
      • Pitfalls
      • Example
      • Adding architecture support
      • Caveats
    • unshare system call
      • Change Log
      • Contents
      • 1) Overview
      • 2) Benefits
        • 2.1 Per-security context namespaces
        • 2.2 unsharing of virtual memory and/or open files
      • 3) Cost
      • 4) Requirements
      • 5) Functional Specification
      • 6) High Level Design
      • 7) Low Level Design
        • 7.1) Reorganization of copy_* functions
        • 7.2) unshare() system call service function
        • 7.3) unshare_* helper functions
        • 7.4) Finally
      • 8) Test Specification
      • 9) Future Work
  • Working with the kernel development community
    • HOWTO do Linux kernel development
      • Introduction
      • Legal Issues
      • Documentation
      • Becoming A Kernel Developer
      • The development process
        • 4.x kernel tree
        • 4.x.y -stable kernel tree
        • 4.x -git patches
        • Subsystem Specific kernel trees and patches
        • 4.x -next kernel tree for integration tests
      • Bug Reporting
      • Managing bug reports
      • Mailing lists
      • Working with the community
      • Differences between the kernel community and corporate structures
      • Break up your changes
      • Justify your change
      • Document your change
    • Code of Conflict
    • A guide to the Kernel Development Process
      • 1. Introduction
        • 1.1. Executive summary
        • 1.2. What this document is about
        • 1.3. Credits
        • 1.4. The importance of getting code into the mainline
        • 1.5. Licensing
      • 2. How the development process works
        • 2.1. The big picture
        • 2.2. The lifecycle of a patch
        • 2.3. How patches get into the Kernel
        • 2.4. Next trees
        • 2.5. Staging trees
        • 2.6. Tools
        • 2.7. Mailing lists
        • 2.8. Getting started with Kernel development
      • 3. Early-stage planning
        • 3.1. Specifying the problem
        • 3.2. Early discussion
        • 3.3. Who do you talk to?
        • 3.4. When to post?
        • 3.5. Getting official buy-in
      • 4. Getting the code right
        • 4.1. Pitfalls
        • 4.2. Code checking tools
        • 4.3. Documentation
        • 4.4. Internal API changes
      • 5. Posting patches
        • 5.1. When to post
        • 5.2. Before creating patches
        • 5.3. Patch preparation
        • 5.4. Patch formatting and changelogs
        • 5.5. Sending the patch
      • 6. Followthrough
        • 6.1. Working with reviewers
        • 6.2. What happens next
        • 6.3. Other things that can happen
      • 7. Advanced topics
        • 7.1. Managing patches with git
        • 7.2. Reviewing patches
      • 8. For more information
      • 9. Conclusion
    • Submitting patches: the essential guide to getting your code into the kernel
      • 0) Obtain a current source tree
      • 1) diff -up
      • 2) Describe your changes
      • 3) Separate your changes
      • 4) Style-check your changes
      • 5) Select the recipients for your patch
      • 6) No MIME, no links, no compression, no attachments. Just plain text
      • 7) E-mail size
      • 8) Respond to review comments
      • 9) Don’t get discouraged - or impatient
      • 10) Include PATCH in the subject
      • 11) Sign your work — the Developer’s Certificate of Origin
        • Developer’s Certificate of Origin 1.1
      • 12) When to use Acked-by: and Cc:
      • 13) Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes:
        • Reviewer’s statement of oversight
      • 14) The canonical patch format
      • 15) Explicit In-Reply-To headers
      • 16) Sending git pull requests
      • References
    • Linux kernel coding style
      • 1) Indentation
      • 2) Breaking long lines and strings
      • 3) Placing Braces and Spaces
        • 3.1) Spaces
      • 4) Naming
      • 5) Typedefs
      • 6) Functions
      • 7) Centralized exiting of functions
      • 8) Commenting
      • 9) You’ve made a mess of it
      • 10) Kconfig configuration files
      • 11) Data structures
      • 12) Macros, Enums and RTL
      • 13) Printing kernel messages
      • 14) Allocating memory
      • 15) The inline disease
      • 16) Function return values and names
      • 17) Don’t re-invent the kernel macros
      • 18) Editor modelines and other cruft
      • 19) Inline assembly
      • 20) Conditional Compilation
      • Appendix I) References
    • Email clients info for Linux
      • Git
      • General Preferences
      • Some email client (MUA) hints
        • Alpine (TUI)
        • Claws Mail (GUI)
        • Evolution (GUI)
        • Kmail (GUI)
        • Lotus Notes (GUI)
        • IBM Verse (Web GUI)
        • Mutt (TUI)
        • Pine (TUI)
        • Sylpheed (GUI)
        • Thunderbird (GUI)
        • TkRat (GUI)
        • Gmail (Web GUI)
    • Minimal requirements to compile the Kernel
      • Intro
        • Current Minimal Requirements
        • Kernel compilation
        • System utilities
        • Networking
        • Kernel documentation
      • Getting updated software
        • Kernel compilation
        • System utilities
        • Networking
        • Kernel documentation
    • Submitting Drivers For The Linux Kernel
      • Allocating Device Numbers
      • Who To Submit Drivers To
      • What Criteria Determine Acceptance
      • What Criteria Do Not Determine Acceptance
      • Resources
    • The Linux Kernel Driver Interface
      • Executive Summary
      • Intro
      • Binary Kernel Interface
      • Stable Kernel Source Interfaces
      • What to do
    • Linux kernel management style
      • 1) Decisions
      • 2) People
      • 3) People II - the Good Kind
      • 4) Placing blame
      • 5) Things to avoid
      • 6) Why me?
    • Everything you ever wanted to know about Linux -stable releases
      • Procedure for submitting patches to the -stable tree
      • For all other submissions, choose one of the following procedures
        • Option 1
        • Option 2
        • Option 3
      • Review cycle
      • Trees
      • Review committee
    • Linux Kernel patch submission checklist
    • Index of Documentation for People Interested in Writing and/or Understanding the Linux Kernel
      • Docs at the Linux Kernel tree
      • On-line docs
      • Published books
      • Miscellaneous
    • Applying Patches To The Linux Kernel
      • What is a patch?
      • How do I apply or revert a patch?
      • How do I feed a patch/diff file to patch?
      • Common errors when patching
      • Are there any alternatives to patch?
      • Where can I download the patches?
      • The 4.x kernels
      • The 4.x.y kernels
      • The -rc kernels
      • The -git kernels
      • The -mm patches and the linux-next tree
    • Adding a New System Call
      • System Call Alternatives
      • Designing the API: Planning for Extension
      • Designing the API: Other Considerations
      • Proposing the API
      • Generic System Call Implementation
      • x86 System Call Implementation
      • Compatibility System Calls (Generic)
      • Compatibility System Calls (x86)
      • System Calls Returning Elsewhere
      • Other Details
      • Testing
      • Man Page
      • References and Sources
    • Linux magic numbers
    • Why the “volatile” type class should not be used
      • References
      • Credits
  • Development tools for the kernel
    • Coccinelle
      • Getting Coccinelle
      • Supplemental documentation
      • Using Coccinelle on the Linux kernel
        • Examples
      • Coccinelle parallelization
      • Using Coccinelle with a single semantic patch
      • Controlling Which Files are Processed by Coccinelle
      • Debugging Coccinelle SmPL patches
      • .cocciconfig support
      • Additional flags
      • SmPL patch specific options
      • SmPL patch Coccinelle requirements
      • Proposing new semantic patches
      • Detailed description of the report mode
        • Example
      • Detailed description of the patch mode
        • Example
      • Detailed description of the context mode
        • Example
      • Detailed description of the org mode
        • Example
    • Sparse
      • Using sparse for typechecking
      • Using sparse for lock checking
      • Getting sparse
      • Using sparse
    • kcov: code coverage for fuzzing
      • Usage
    • Using gcov with the Linux kernel
      • Preparation
      • Customization
      • Files
      • Modules
      • Separated build and test machines
      • Troubleshooting
      • Appendix A: gather_on_build.sh
      • Appendix B: gather_on_test.sh
    • The Kernel Address Sanitizer (KASAN)
      • Overview
      • Usage
        • Error reports
      • Implementation details
    • The Undefined Behavior Sanitizer - UBSAN
      • Report example
      • Usage
      • References
    • Kernel Memory Leak Detector
      • Usage
      • Basic Algorithm
      • Testing specific sections with kmemleak
      • Freeing kmemleak internal objects
      • Kmemleak API
      • Dealing with false positives/negatives
      • Limitations and Drawbacks
    • Getting started with kmemcheck
      • Introduction
      • Downloading
      • Configuring and compiling
      • How to use
        • Booting
        • Run-time enable/disable
        • Debugging
        • Annotating false positives
      • Reporting errors
      • Technical description
    • Debugging kernel and modules via gdb
      • Requirements
      • Setup
      • Examples of using the Linux-provided gdb helpers
      • List of commands and functions
    • Using kgdb, kdb and the kernel debugger internals
      • Introduction
      • Compiling a kernel
        • Kernel config options for kgdb
        • Kernel config options for kdb
      • Kernel Debugger Boot Arguments
        • Kernel parameter: kgdboc
        • Kernel parameter: kgdbwait
        • Kernel parameter: kgdbcon
        • Run time parameter: kgdbreboot
      • Using kdb
        • Quick start for kdb on a serial port
        • Quick start for kdb using a keyboard connected console
      • Using kgdb / gdb
        • Connecting with gdb to a serial port
      • kgdb and kdb interoperability
        • Switching between kdb and kgdb
        • Running kdb commands from gdb
      • kgdb Test Suite
      • Kernel Debugger Internals
        • Architecture Specifics
        • kgdboc internals
      • Credits
    • Linux Kernel Selftests
      • Running the selftests (hotplug tests are run in limited mode)
      • Running a subset of selftests
      • Running the full range hotplug selftests
      • Install selftests
      • Running installed selftests
      • Contributing new tests
      • Contributing new tests (details)
      • Test Harness
        • Example
        • Helpers
        • Operators
  • How to write kernel documentation
    • Introduction
    • Sphinx Build
    • Writing Documentation
      • Specific guidelines for the kernel documentation
      • the C domain
      • list tables
    • Figures & Images
    • Including kernel-doc comments
    • Writing kernel-doc comments
      • How to format kernel-doc comments
      • Highlights and cross-references
        • Cross-referencing from reStructuredText
      • Function documentation
      • Structure, union, and enumeration documentation
        • In-line member documentation comments
        • Private members
      • Typedef documentation
      • Overview documentation comments
      • Recommendations
    • Including uAPI header files
      • parse_headers.pl
        • NAME
        • SYNOPSIS
        • OPTIONS
        • DESCRIPTION
        • EXAMPLES
        • BUGS
        • COPYRIGHT
  • Kernel Hacking Guides
    • Unreliable Guide To Hacking The Linux Kernel
      • Introduction
      • The Players
        • User Context
        • Hardware Interrupts (Hard IRQs)
        • Software Interrupt Context: Softirqs and Tasklets
      • Some Basic Rules
      • ioctls: Not writing a new system call
      • Recipes for Deadlock
      • Common Routines
        • printk()
        • copy_to_user() / copy_from_user() / get_user() / put_user()
        • kmalloc()/kfree()
        • current()
        • mdelay()/udelay()
        • cpu_to_be32()/be32_to_cpu()/cpu_to_le32()/le32_to_cpu()
        • local_irq_save()/local_irq_restore()
        • local_bh_disable()/local_bh_enable()
        • smp_processor_id()
        • __init/__exit/__initdata
        • __initcall()/module_init()
        • module_exit()
        • try_module_get()/module_put()
      • Wait Queues include/linux/wait.h
        • Declaring
        • Queuing
        • Waking Up Queued Tasks
      • Atomic Operations
      • Symbols
        • EXPORT_SYMBOL()
        • EXPORT_SYMBOL_GPL()
      • Routines and Conventions
        • Double-linked lists include/linux/list.h
        • Return Conventions
        • Breaking Compilation
        • Initializing structure members
        • GNU Extensions
        • C++
        • NUMif
      • Putting Your Stuff in the Kernel
      • Kernel Cantrips
      • Thanks
    • Unreliable Guide To Locking
      • Introduction
      • The Problem With Concurrency
        • Race Conditions and Critical Regions
      • Locking in the Linux Kernel
        • Two Main Types of Kernel Locks: Spinlocks and Mutexes
        • Locks and Uniprocessor Kernels
        • Locking Only In User Context
        • Locking Between User Context and Softirqs
        • Locking Between User Context and Tasklets
        • Locking Between User Context and Timers
        • Locking Between Tasklets/Timers
        • Locking Between Softirqs
      • Hard IRQ Context
        • Locking Between Hard IRQ and Softirqs/Tasklets
        • Locking Between Two Hard IRQ Handlers
      • Cheat Sheet For Locking
        • Table of Minimum Requirements
      • The trylock Functions
      • Common Examples
        • All In User Context
        • Accessing From Interrupt Context
        • Exposing Objects Outside This File
        • Protecting The Objects Themselves
      • Common Problems
        • Deadlock: Simple and Advanced
        • Preventing Deadlock
        • Racing Timers: A Kernel Pastime
      • Locking Speed
        • Read/Write Lock Variants
        • Avoiding Locks: Read Copy Update
        • Per-CPU Data
        • Data Which Mostly Used By An IRQ Handler
      • What Functions Are Safe To Call From Interrupts?
        • Some Functions Which Sleep
        • Some Functions Which Don’t Sleep
      • Mutex API reference
      • Futex API reference
      • Further reading
      • Thanks
      • Glossary
  • The Linux driver implementer’s API guide
    • Driver Basics
      • Driver Entry and Exit points
      • Driver device table
      • Atomic and pointer manipulation
      • Delaying, scheduling, and timer routines
      • Wait queues and Wake events
      • High-resolution timers
      • Workqueues and Kevents
      • Internal Functions
      • Kernel objects manipulation
      • Kernel utility functions
      • Device Resource Management
    • Device drivers infrastructure
      • The Basic Device Driver-Model Structures
      • Device Drivers Base
      • Device Drivers DMA Management
      • Device drivers PnP support
      • Userspace IO devices
    • Device Power Management
      • Device Power Management Basics
        • Two Models for Device Power Management
        • Interfaces for Entering System Sleep States
        • Calling Drivers to Enter and Leave System Sleep States
        • Power Management Notifiers
        • Device Low-Power (suspend) States
        • Device Power Management Domains
        • Runtime Power Management
      • Suspend/Hibernation Notifiers
      • Device Power Management Data Types
    • Bus-Independent Device Accesses
      • Introduction
      • Memory Mapped IO
        • Getting Access to the Device
        • Accessing the device
      • Port Space Accesses
        • Port Space Explained
        • Accessing Port Space
      • Public Functions Provided
    • Buffer Sharing and Synchronization
      • Shared DMA Buffers
        • Userspace Interface Notes
        • Basic Operation and Device DMA Access
        • CPU Access to DMA Buffer Objects
        • Fence Poll Support
        • Kernel Functions and Structures Reference
      • Reservation Objects
      • DMA Fences
        • Seqno Hardware Fences
        • DMA Fence Array
        • DMA Fence uABI/Sync File
    • Device links
      • Usage
      • Limitations
      • Examples
      • Alternatives
      • Implementation
      • State machine
      • API
    • Message-based devices
      • Fusion message devices
    • Sound Devices
    • Frame Buffer Library
      • Frame Buffer Memory
      • Frame Buffer Colormap
      • Frame Buffer Video Mode Database
      • Frame Buffer Macintosh Video Mode Database
      • Frame Buffer Fonts
    • Voltage and current regulator API
      • Introduction
        • Glossary
      • Consumer driver interface
        • Enabling and disabling
        • Configuration
        • Callbacks
      • Regulator driver interface
      • Machine interface
        • Supplies
        • Constraints
      • API reference
    • Industrial I/O
      • Introduction
      • Core elements
        • Industrial I/O Devices
      • Buffers
        • IIO buffer sysfs interface
        • IIO buffer setup
        • More details
      • Triggers
        • IIO trigger sysfs interface
        • IIO trigger setup
        • IIO trigger ops
        • More details
      • Triggered Buffers
        • IIO triggered buffer setup
        • More details
    • Input Subsystem
      • Input core
      • Multitouch Library
      • Polled input devices
      • Matrix keyboards/keypads
      • Sparse keymap support
    • Linux USB API
      • The Linux-USB Host Side API
        • Introduction to USB on Linux
        • USB Host-Side API Model
        • USB-Standard Types
        • Host-Side Data Types and Macros
        • USB Core APIs
        • Host Controller APIs
        • The USB character device nodes
        • The USB devices
      • USB Gadget API for Linux
        • Introduction
        • Structure of Gadget Drivers
        • Kernel Mode Gadget API
        • Peripheral Controller Drivers
        • Gadget Drivers
        • USB On-The-GO (OTG)
      • USB Anchors
        • What is anchor?
        • Allocation and Initialisation
        • Deallocation
        • Association and disassociation of URBs with anchors
        • Operations on multitudes of URBs
      • USB bulk streams
        • Background
        • Device-side implications
        • Driver implications
        • Picking new Stream IDs to use
        • Clean up
      • USB core callbacks
        • What callbacks will usbcore do?
        • Calling conventions
        • Hotplugging callbacks
        • Device level callbacks
        • Call sequences
      • USB DMA
        • API overview
        • Eliminating copies
        • Working with existing buffers
      • USB Request Block (URB)
        • Basic concept or ‘What is an URB?’
        • The URB structure
        • How to get an URB?
        • What has to be filled in?
        • How to submit an URB?
        • How to cancel an already running URB?
        • What about the completion handler?
        • How to do isochronous (ISO) transfers?
        • How to start interrupt (INT) transfers?
      • Power Management for USB
        • What is Power Management?
        • What is Remote Wakeup?
        • When is a USB device idle?
        • Forms of dynamic PM
        • The user interface for dynamic PM
        • Changing the default idle-delay time
        • Warnings
        • The driver interface for Power Management
        • The driver interface for autosuspend and autoresume
        • Other parts of the driver interface
        • Mutual exclusion
        • Interaction between dynamic PM and system PM
        • xHCI hardware link PM
        • USB Port Power Control
        • User Interface for Port Power Control
        • Suggested Userspace Port Power Policy
      • USB hotplugging
        • Linux Hotplugging
        • Kernel Hotplug Helper (/sbin/hotplug)
        • USB Policy Agent
        • USB Modutils Support
      • USB device persistence during system suspend
        • What is the problem?
        • What is the solution?
        • Is this the best solution?
        • WARNING: USB-persist can be dangerous!!
      • USB Error codes
        • Error codes returned by usb_submit_urb()
        • Error codes returned by in urb->status or in iso_frame_desc[n].status (for ISO)
        • Error codes returned by usbcore-functions
      • Writing USB Device Drivers
        • Introduction
        • Linux USB Basics
        • Device operation
        • Isochronous Data
        • Conclusion
        • Resources
      • Synopsys DesignWare Core SuperSpeed USB 3.0 Controller
        • Introduction
        • Summary of Features
        • Driver Design
        • Known Limitations
        • Reporting Bugs
        • Debugging
        • Structures, Methods and Definitions
      • Writing a MUSB Glue Layer
        • Introduction
        • Linux MUSB Basics
        • Handling IRQs
        • Device Platform Data
        • Device Quirks
        • Conclusion
        • Acknowledgements
        • Resources
      • USB Type-C connector class
        • Introduction
        • User space interface
        • Driver API
      • USB3 debug port
        • GENERAL
        • INTRODUCTION
        • EARLY PRINTK
    • PCI Support Library
    • PCI Hotplug Support Library
    • Serial Peripheral Interface (SPI)
    • I2C and SMBus Subsystem
    • High Speed Synchronous Serial Interface (HSI)
      • Introduction
      • HSI Subsystem in Linux
      • hsi-char Device
      • The kernel HSI API
    • Error Detection And Correction (EDAC) Devices
      • Main Concepts used at the EDAC subsystem
      • Memory Controllers
      • PCI Controllers
      • EDAC Blocks
    • SCSI Interfaces Guide
      • Introduction
        • Protocol vs bus
        • Design of the Linux SCSI subsystem
      • SCSI upper layer
        • sd (SCSI Disk)
        • sr (SCSI CD-ROM)
        • st (SCSI Tape)
        • sg (SCSI Generic)
        • ch (SCSI Media Changer)
      • SCSI mid layer
        • SCSI midlayer implementation
        • Transport classes
      • SCSI lower layer
        • Host Bus Adapter transport types
    • libATA Developer’s Guide
      • Introduction
      • libata Driver API
        • struct ata_port_operations
      • Error handling
        • Origins of commands
        • How commands are issued
        • How commands are processed
        • How commands are completed
        • ata_scsi_error()
        • Problems with the current EH
      • libata Library
      • libata Core Internals
      • libata SCSI translation/emulation
      • ATA errors and exceptions
        • Exception categories
        • EH recovery actions
      • ata_piix Internals
      • sata_sil Internals
      • Thanks
    • MTD NAND Driver Programming Interface
      • Introduction
      • Known Bugs And Assumptions
      • Documentation hints
        • Function identifiers [XXX]
        • Struct member identifiers [XXX]
      • Basic board driver
        • Basic defines
        • Partition defines
        • Hardware control function
        • Device ready function
        • Init function
        • Exit function
      • Advanced board driver functions
        • Multiple chip control
        • Hardware ECC support
        • Bad block table support
        • Spare area (auto)placement
        • Spare area autoplacement default schemes
      • Filesystem support
      • Tools
      • Constants
        • Chip option constants
        • ECC selection constants
        • Hardware control related constants
        • Bad block table related constants
      • Structures
      • Public Functions Provided
      • Internal Functions Provided
      • Credits
    • Parallel Port Devices
    • 16x50 UART Driver
    • Pulse-Width Modulation (PWM)
    • W1: Dallas’ 1-wire bus
      • W1 API internal to the kernel
        • W1 API internal to the kernel
    • RapidIO Subsystem Guide
      • Introduction
      • Known Bugs and Limitations
        • Bugs
        • Limitations
      • RapidIO driver interface
        • Functions
      • Internals
        • Structures
        • Enumeration and Discovery
        • Driver functionality
        • Device model support
        • PPC32 support
      • Credits
    • Writing s390 channel device drivers
      • Introduction
      • The ccw bus
        • I/O functions for channel-attached devices
        • ccw devices
        • The channel-measurement facility
      • The ccwgroup bus
        • ccw group devices
      • Generic interfaces
    • VME Device Drivers
      • Driver registration
      • Resource management
      • Master windows
        • Master window configuration
        • Master window access
      • Slave windows
        • Slave window configuration
        • Slave window buffer allocation
        • Slave window access
      • DMA channels
        • List Management
        • List Population
        • Transfer Attributes
        • List Execution
      • Interrupts
        • Attaching Interrupt Handlers
        • Interrupt Generation
      • Location monitors
        • Location Monitor Management
        • Location Monitor Configuration
        • Location Monitor Use
      • Slot Detection
      • Bus Detection
      • VME API
    • Linux 802.11 Driver Developer’s Guide
      • Introduction
      • cfg80211 subsystem
        • Device registration
        • Actions and configuration
        • Scanning and BSS list handling
        • Utility functions
        • Data path helpers
        • Regulatory enforcement infrastructure
        • RFkill integration
        • Test mode
      • mac80211 subsystem (basics)
        • Basic hardware handling
        • PHY configuration
        • Virtual interfaces
        • Receive and transmit processing
        • Frame filtering
        • The mac80211 workqueue
      • mac80211 subsystem (advanced)
        • LED support
        • Hardware crypto acceleration
        • Powersave support
        • Beacon filter support
        • Multiple queues and QoS support
        • Access point mode support
        • Supporting multiple virtual interfaces
        • Station handling
        • Hardware scan offload
        • Aggregation
        • Spatial Multiplexing Powersave (SMPS)
        • Rate Control API
        • Key handling
        • Receive processing
        • Transmit processing
        • Station info handling
        • Aggregation
        • Synchronisation
    • The Userspace I/O HOWTO
      • About this document
        • Translations
        • Preface
        • Acknowledgments
        • Feedback
      • About UIO
        • How UIO works
      • Writing your own kernel module
        • struct uio_info
        • Adding an interrupt handler
        • Using uio_pdrv for platform devices
        • Using uio_pdrv_genirq for platform devices
        • Using uio_dmem_genirq for platform devices
      • Writing a driver in userspace
        • Getting information about your UIO device
        • mmap() device memory
        • Waiting for interrupts
      • Generic PCI UIO driver
        • Making the driver recognize the device
        • Things to know about uio_pci_generic
        • Writing userspace driver using uio_pci_generic
        • Example code using uio_pci_generic
      • Generic Hyper-V UIO driver
        • Making the driver recognize the device
        • Things to know about uio_hv_generic
      • Further information
    • Linux Firmware API
      • Introduction
        • Types of firmware requests
      • Firmware API core features
        • Firmware search paths
        • Built-in firmware
        • Firmware cache
        • Direct filesystem lookup
        • Fallback mechanisms
        • Firmware lookup order
      • request_firmware API
        • Synchronous firmware requests
        • Asynchronous firmware requests
        • Considerations for suspend and resume
        • request firmware API expected driver use
      • Other Firmware Interfaces
        • DMI Interfaces
        • EDD Interfaces
    • PINCTRL (PIN CONTROL) subsystem
      • Top-level interface
      • Pin groups
      • Pin configuration
      • Interaction with the GPIO subsystem
      • PINMUX interfaces
      • What is pinmuxing?
      • Pinmux conventions
      • Pinmux drivers
      • Pin control interaction with the GPIO subsystem
      • GPIO mode pitfalls
        • And your machine configuration may look like this:
      • Board/machine configuration
      • Complex mappings
      • Pin control requests from drivers
      • Drivers needing both pin control and GPIOs
      • System pin control hogging
      • Runtime pinmuxing
    • Miscellaneous Devices
  • Core API Documentation
    • Core utilities
      • The Linux Kernel API
        • Data Types
        • Basic C Library Functions
        • Basic Kernel Library Functions
        • Memory Management in Linux
        • Kernel IPC facilities
        • FIFO Buffer
        • relay interface support
        • Module Support
        • Hardware Interfaces
        • Security Framework
        • Audit Interfaces
        • Accounting Framework
        • Block Devices
        • Char devices
        • Clock Framework
      • Generic Associative Array Implementation
        • Overview
        • The Public API
        • Internal Workings
      • Semantics and Behavior of Atomic and Bitmask Operations
        • Atomic Type And Operations
        • Atomic Bitmask
      • CPU hotplug in the Kernel
        • Introduction
        • Command Line Switches
        • CPU maps
        • Using CPU hotplug
        • The CPU hotplug coordination
        • Testing of hotplug states
        • Architecture’s requirements
        • User Space Notification
        • Kernel Inline Documentations Reference
      • Semantics and Behavior of Local Atomic Operations
        • Purpose of local atomic operations
        • Implementation for a given architecture
        • Rules to follow when using local atomic operations
        • How to use local atomic operations
        • Counting
        • Reading the counters
      • Concurrency Managed Workqueue (cmwq)
        • Introduction
        • Why cmwq?
        • The Design
        • Application Programming Interface (API)
        • Example Execution Scenarios
        • Guidelines
        • Debugging
        • Kernel Inline Documentations Reference
      • Linux generic IRQ handling
        • Introduction
        • Rationale
        • Known Bugs And Assumptions
        • Abstraction layers
        • __do_IRQ entry point
        • Locking on SMP
        • Generic interrupt chip
        • Structures
        • Public Functions Provided
        • Internal Functions Provided
        • Credits
      • Using flexible arrays in the kernel
        • Flexible array functions
      • Reed-Solomon Library Programming Interface
        • Introduction
        • Known Bugs And Assumptions
        • Usage
        • Structures
        • Public Functions Provided
        • Credits
    • Interfaces for kernel debugging
      • The object-lifetime debugging infrastructure
        • Introduction
        • Howto use debugobjects
        • Debug functions
        • Fixup functions
        • Known Bugs And Assumptions
      • The Linux Kernel Tracepoint API
        • Introduction
        • IRQ
        • SIGNAL
        • Block IO
        • Workqueue
  • Linux Media Subsystem Documentation
    • Linux Media Infrastructure userspace API
      • Introduction
      • Part I - Video for Linux API
        • 1. Common API Elements
        • 2. Image Formats
        • 3. Input/Output
        • 4. Interfaces
        • 5. V4L2 Driver Programming
        • 6. Libv4l Userspace Library
        • 7. Changes
        • 8. Function Reference
        • 9. Common definitions for V4L2 and V4L2 subdev interfaces
        • 10. Video For Linux Two Header File
        • 11. Video Capture Example
        • 12. Video Grabber example using libv4l
        • 13. References
        • Revision and Copyright
        • Revision History
      • Part II - Digital TV API
        • 1. Introduction
        • 2. DVB Frontend API
        • 3. DVB Demux Device
        • 4. DVB CA Device
        • 5. DVB Network API
        • 6. DVB net Function Calls
        • 7. DVB Deprecated APIs
        • 8. Examples
        • 9. DVB Audio Header File
        • 10. DVB Conditional Access Header File
        • 11. DVB Demux Header File
        • 12. DVB Frontend Header File
        • 13. DVB Network Header File
        • 14. DVB Video Header File
        • Revision and Copyright
        • Revision History
      • Part III - Remote Controller API
        • 1. Introduction
        • 2. Remote Controller’s sysfs nodes
        • 3. Remote controller tables
        • 4. Changing default Remote Controller mappings
        • 5. LIRC Device Interface
        • Revision and Copyright
        • Revision History
      • Part IV - Media Controller API
        • 1. Introduction
        • 2. Media device model
        • 3. Types and flags used to represent the media graph elements
        • 4. Function Reference
        • 5. Media Controller Header File
        • Revision and Copyright
        • Revision History
      • Part V - Consumer Electronics Control API
        • 1. Introduction
        • 2. Function Reference
        • 3. CEC Header File
        • Revision and Copyright
        • Revision History
      • Generic Error Codes
      • GNU Free Documentation License
        • 0. PREAMBLE
        • 1. APPLICABILITY AND DEFINITIONS
        • 2. VERBATIM COPYING
        • 3. COPYING IN QUANTITY
        • 4. MODIFICATIONS
        • 5. COMBINING DOCUMENTS
        • 6. COLLECTIONS OF DOCUMENTS
        • 7. AGGREGATION WITH INDEPENDENT WORKS
        • 8. TRANSLATION
        • 9. TERMINATION
        • 10. FUTURE REVISIONS OF THIS LICENSE
        • Addendum
    • Media subsystem kernel internal API
      • 1. Video4Linux devices
        • 1.1. Introduction
        • 1.2. Structure of a V4L driver
        • 1.3. Structure of the V4L2 framework
        • 1.4. Video device’ s internal representation
        • 1.5. V4L2 device instance
        • 1.6. V4L2 File handlers
        • 1.7. V4L2 sub-devices
        • 1.8. V4L2 sub-device userspace API
        • 1.9. I2C sub-device drivers
        • 1.10. V4L2 sub-device functions and data structures
        • 1.11. V4L2 events
        • 1.12. V4L2 Controls
        • 1.13. Videobuf Framework
        • 1.14. V4L2 videobuf2 functions and data structures
        • 1.15. V4L2 clocks
        • 1.16. V4L2 DV Timings functions
        • 1.17. V4L2 flash functions and data structures
        • 1.18. V4L2 Media Controller functions and data structures
        • 1.19. V4L2 Media Bus functions and data structures
        • 1.20. V4L2 Memory to Memory functions and data structures
        • 1.21. V4L2 fwnode kAPI
        • 1.22. V4L2 rect helper functions
        • 1.23. Tuner functions and data structures
        • 1.24. V4L2 common functions and data structures
        • 1.25. Hauppauge TV EEPROM functions and data structures
      • 2. Digital TV (DVB) devices
      • 3. Digital TV Common functions
      • 4. Digital TV Ring buffer
      • 5. Digital TV Frontend kABI
        • 5.1. Digital TV Frontend
      • 6. Digital TV Demux kABI
        • 6.1. Digital TV Demux
      • 7. Demux Callback API
        • 7.1. Demux Callback
      • 8. Digital TV Conditional Access kABI
      • 9. Remote Controller devices
        • 9.1. Remote Controller core
        • 9.2. LIRC
      • 10. Media Controller devices
        • 10.1. Media Controller
      • 11. CEC Kernel Support
        • 11.1. The CEC Protocol
        • 11.2. CEC Adapter Interface
        • 11.3. Implementing the Low-Level CEC Adapter
        • 11.4. Implementing the interrupt handler
        • 11.5. Implementing the High-Level CEC Adapter
        • 11.6. CEC framework functions
      • 12. MIPI CSI-2
        • 12.1. Transmitter drivers
        • 12.2. Receiver drivers
    • Linux Digital TV driver-specific documentation
      • 1. Introduction
      • 2. HOWTO: Get An Avermedia DVB-T working under Linux
        • 2.1. Assumptions and Introduction
        • 2.2. The Avermedia DVB-T
        • 2.3. Getting the card going
        • 2.4. Receiving DVB-T in Australia
        • 2.5. Known Limitations
        • 2.6. Further Update
      • 3. How to get the bt8xx cards working
        • 3.1. General information
        • 3.2. Loading Modules
      • 4. Hardware supported by the linuxtv.org DVB drivers
      • 5. Digital TV Conditional Access Interface (CI API)
        • 5.1. ca_zap
        • 5.2. Cards that fall in this category
        • 5.3. CI modules that are supported
        • 5.4. The High level CI API
        • 5.5. Why the need for another CI interface?
      • 6. Idea behind the dvb-usb-framework
        • 6.1. Supported devices
        • 6.2. How to use?
        • 6.3. Known problems and bugs
        • 6.4. 3. Acknowledgements
      • 7. FAQ
      • 8. Firmware files for lmedm04 cards
        • 8.1. For DM04+/QQBOX LME2510C (Sharp 7395 Tuner)
        • 8.2. For DM04 LME2510 (LG Tuner)
        • 8.3. For DM04 LME2510C (LG Tuner)
        • 8.4. For LME2510
        • 8.5. For LME2510C
      • 9. Opera firmware
      • 10. How to set up the Technisat/B2C2 Flexcop devices
        • 10.1. Find out what device you have
        • 10.2. Kernel compilation:
      • 11. TechnoTrend/Hauppauge DEC USB Driver
        • 11.1. Driver Status
        • 11.2. Getting the Firmware
        • 11.3. Hotplug Firmware Loading
      • 12. UDEV rules for DVB
      • 13. Contributors
    • Video4Linux (V4L) driver-specific documentation
      • 1. Guidelines for Video4Linux pixel format 4CCs
        • 1.1. Raw bayer
      • 2. Infrared remote control support in video4linux drivers
        • 2.1. Basics
        • 2.2. How it works
      • 3. Using with lircd
      • 4. Using without lircd
      • 5. Tuner drivers
        • 5.1. Simple tuner Programming
        • 5.2. Tuner Manufacturers
      • 6. Cards List
        • 6.1. AU0828 cards list
        • 6.2. BTTV cards list
        • 6.3. cx23885 cards list
        • 6.4. CX88 cards list
        • 6.5. EM28xx cards list
        • 6.6. IVTV cards list
        • 6.7. SAA7134 cards list
        • 6.8. SAA7164 cards list
        • 6.9. TM6000 cards list
        • 6.10. Tuner cards list
        • 6.11. USBvision cards list
        • 6.12. The gspca cards list
      • 7. The bttv driver
        • 7.1. Release notes for bttv
        • 7.2. Make bttv work with your card
        • 7.3. Autodetecting cards
        • 7.4. Still doesn’t work?
        • 7.5. Modprobe options
        • 7.6. If the box freezes hard with bttv
        • 7.7. Bttv quirks
        • 7.8. bttv and sound mini howto
        • 7.9. Cards
        • 7.10. Chips used at bttv devices
        • 7.11. Specs
        • 7.12. Thanks
        • 7.13. Contributors
      • 8. The cafe_ccic driver
        • 8.1. Introduction
        • 8.2. Load time options
      • 9. The cpia2 driver
        • 9.1. Introduction
        • 9.2. Features
        • 9.3. Making and installing the stv672 driver modules
      • 10. The cx18 driver
      • 11. The cx2341x driver
        • 11.1. Memory at cx2341x chips
        • 11.2. Missing documentation
        • 11.3. The cx2341x firmware upload
        • 11.4. How to call the firmware API
        • 11.5. OSD firmware API description
        • 11.6. Encoder firmware API description
        • 11.7. Decoder firmware API description
        • 11.8. PVR350 Video decoder registers 0x02002800 -> 0x02002B00
        • 11.9. The cx231xx DMA engine
        • 11.10. Non-compressed file format
        • 11.11. Format of embedded V4L2_MPEG_STREAM_VBI_FMT_IVTV VBI data
      • 12. The cx88 driver
        • 12.1. Current status
        • 12.2. How to add support for new cards
        • 12.3. Documentation missing at the cx88 datasheet
        • 12.4. Hauppauge WinTV cx88 IR information
      • 13. The VPBE V4L2 driver design
        • 13.1. File partitioning
        • 13.2. Functional partitioning
        • 13.3. Current status
        • 13.4. To be done
      • 14. The Samsung S5P/EXYNOS4 FIMC driver
        • 14.1. Supported SoCs
        • 14.2. Supported features
        • 14.3. Not currently supported
        • 14.4. Files partitioning
        • 14.5. User space interfaces
        • 14.6. 5. Device mapping to video and subdev device nodes
        • 14.7. 7. Build
      • 15. The ivtv driver
        • 15.1. Features
        • 15.2. Additional features for the PVR-350 (CX23415 based)
        • 15.3. See also
        • 15.4. IRC
        • 15.5. Devices
        • 15.6. Base devices
      • 16. Maxim Integrated MAX2175 RF to bits tuner driver
        • 16.1. V4L2_CID_MAX2175_I2S_ENABLE
        • 16.2. V4L2_CID_MAX2175_HSLS
        • 16.3. V4L2_CID_MAX2175_RX_MODE (menu)
      • 17. Vaio Picturebook Motion Eye Camera Driver
        • 17.1. Hardware supported
        • 17.2. Driver options
        • 17.3. Module use
        • 17.4. Usage:
        • 17.5. Private API
        • 17.6. Bugs / Todo
      • 18. OMAP 3 Image Signal Processor (ISP) driver
        • 18.1. Introduction
        • 18.2. Split to subdevs
        • 18.3. Controlling the OMAP 3 ISP
        • 18.4. Events
        • 18.5. Private IOCTLs
        • 18.6. CCDC and preview block IOCTLs
        • 18.7. Statistic blocks IOCTLs
        • 18.8. VIDIOC_OMAP3ISP_STAT_EN
        • 18.9. VIDIOC_OMAP3ISP_AEWB_CFG, VIDIOC_OMAP3ISP_HIST_CFG and VIDIOC_OMAP3ISP_AF_CFG
        • 18.10. VIDIOC_OMAP3ISP_STAT_REQ
        • 18.11. Technical reference manuals (TRMs) and other documentation
        • 18.12. References
      • 19. OMAP4 ISS Driver
        • 19.1. Introduction
        • 19.2. Tested platforms
        • 19.3. File list
        • 19.4. References
      • 20. Philips webcams (pwc driver)
      • 21. The pvrusb2 driver
        • 21.1. Background
        • 21.2. Building
        • 21.3. Source file list / functional overview
      • 22. PXA-Camera Host Driver
        • 22.1. Constraints
        • 22.2. Global video workflow
        • 22.3. DMA usage
      • 23. The Radiotrack radio driver
        • 23.1. ACKNOWLEDGMENTS
        • 23.2. WHY THIS DOCUMENT?
        • 23.3. PHYSICAL DESCRIPTION
        • 23.4. CONTROLLING THE CARD WITH IOPORT
        • 23.5. PROGRAMMING EXAMPLES
      • 24. Renesas R-Car Fine Display Processor (FDP1) Driver
      • 25. The saa7134 driver
        • 25.1. Status
        • 25.2. Build
        • 25.3. Changes / Fixes
        • 25.4. Known Problems
        • 25.5. Card Variations:
        • 25.6. LifeView GPIOs
        • 25.7. Credits
      • 26. Cropping and Scaling algorithm, used in the sh_mobile_ceu_camera driver
        • 26.1. Terminology
        • 26.2. Generic scaling / cropping scheme
        • 26.3. S_FMT
        • 26.4. S_CROP
      • 27. The Silicon Labs Si470x FM Radio Receivers driver
        • 27.1. Information from Silicon Labs
        • 27.2. Supported ICs
        • 27.3. Supported USB devices
        • 27.4. Software
        • 27.5. Audio Listing
        • 27.6. Module Parameters
        • 27.7. Errors
        • 27.8. Open Issues
        • 27.9. Other useful information and links
      • 28. The Silicon Labs Si4713 FM Radio Transmitter Driver
        • 28.1. Information about the Device
        • 28.2. Device driver description
        • 28.3. Properties description
        • 28.4. RNL
        • 28.5. Stereo/Mono and RDS subchannels
        • 28.6. Testing
      • 29. The SI476x Driver
        • 29.1. TODO for the driver
        • 29.2. Parameters exposed over debugfs
      • 30. The Soc-Camera Drivers
        • 30.1. Terminology
        • 30.2. Purpose of the soc-camera subsystem
        • 30.3. Existing drivers
        • 30.4. Camera host API
        • 30.5. Camera API
        • 30.6. VIDIOC_S_CROP and VIDIOC_S_FMT behaviour
        • 30.7. Format conversion
      • 31. The Linux USB Video Class (UVC) driver
        • 31.1. Extension Unit (XU) support
      • 32. The Virtual Video Test Driver (vivid)
        • 32.1. Configuring the driver
        • 32.2. Video Capture
        • 32.3. Video Output
        • 32.4. VBI Capture
        • 32.5. VBI Output
        • 32.6. Radio Receiver
        • 32.7. Radio Transmitter
        • 32.8. Software Defined Radio Receiver
        • 32.9. Controls
        • 32.10. Video, VBI and RDS Looping
        • 32.11. Cropping, Composing, Scaling
        • 32.12. Formats
        • 32.13. Capture Overlay
        • 32.14. Output Overlay
        • 32.15. CEC (Consumer Electronics Control)
        • 32.16. Some Future Improvements
      • 33. The Zoran driver
        • 33.1. Frequently Asked Questions
        • 33.2. What cards are supported
        • 33.3. 1.1 What the TV decoder can do an what not
        • 33.4. What the TV encoder can do an what not
        • 33.5. How do I get this damn thing to work
        • 33.6. What mainboard should I use (or why doesn’t my card work)
        • 33.7. Programming interface
        • 33.8. Applications
        • 33.9. Concerning buffer sizes, quality, output size etc.
        • 33.10. It hangs/crashes/fails/whatevers! Help!
        • 33.11. Maintainers/Contacting
        • 33.12. Driver’s License
      • 34. Zoran 364xx based USB webcam module
        • 34.1. Introduction
        • 34.2. Install
        • 34.3. Usage
        • 34.4. links
        • 34.5. Supported devices
  • Linux Networking Documentation
    • Linux Networking and Network Devices APIs
      • Linux Networking
        • Networking Base Types
        • Socket Buffer Functions
        • Socket Filter
        • Generic Network Statistics
        • SUN RPC subsystem
        • WiMAX
      • Network device support
        • Driver Support
        • PHY Support
    • Z8530 Programming Guide
      • Introduction
      • Driver Modes
      • Using the Z85230 driver
      • Attaching Network Interfaces
      • Configuring And Activating The Port
      • Network Layer Functions
      • Porting The Z8530 Driver
      • Known Bugs And Assumptions
      • Public Functions Provided
      • Internal Functions
  • The Linux Input Documentation
    • Linux Input Subsystem userspace API
      • 1. Introduction
        • 1.1. Architecture
        • 1.2. Simple Usage
        • 1.3. Detailed Description
        • 1.4. Verifying if it works
        • 1.5. Event interface
      • 2. Input event codes
        • 2.1. Event types
        • 2.2. Event codes
        • 2.3. Device properties
        • 2.4. Guidelines
      • 3. Multi-touch (MT) Protocol
        • 3.1. Introduction
        • 3.2. Protocol Usage
        • 3.3. Protocol Example A
        • 3.4. Protocol Example B
        • 3.5. Event Usage
        • 3.6. Event Semantics
        • 3.7. Event Computation
        • 3.8. Finger Tracking
        • 3.9. Gestures
        • 3.10. Notes
      • 4. Linux Gamepad Specification
        • 4.1. Introduction
        • 4.2. Geometry
        • 4.3. Detection
        • 4.4. Events
      • 5. Force feedback for Linux
        • 5.1. Introduction
        • 5.2. Instructions to the user
        • 5.3. Instructions to the developer
      • 6. Linux Joystick support
        • 6.1. Introduction
        • 6.2. Usage
        • 6.3. HW specific driver information
        • 6.4. Troubleshooting
        • 6.5. FAQ
        • 6.6. Programming Interface
      • 7. uinput module
        • 7.1. Introduction
        • 7.2. Interface
        • 7.3. libevdev
        • 7.4. Examples
      • 8. The userio Protocol
        • 8.1. Introduction
        • 8.2. Usage overview
        • 8.3. Command Structure
        • 8.4. Commands
        • 8.5. Userspace tools
    • Linux Input Subsystem kernel API
      • 1. Creating an input device driver
        • 1.1. The simplest example
        • 1.2. What the example does
        • 1.3. dev->open() and dev->close()
        • 1.4. Basic event types
        • 1.5. BITS_TO_LONGS(), BIT_WORD(), BIT_MASK()
        • 1.6. The id* and name fields
        • 1.7. The keycode, keycodemax, keycodesize fields
        • 1.8. dev->getkeycode() and dev->setkeycode()
        • 1.9. Key autorepeat
        • 1.10. Other event types, handling output events
      • 2. Programming gameport drivers
        • 2.1. A basic classic gameport
        • 2.2. Memory mapped gameport
        • 2.3. Cooked mode gameport
        • 2.4. More complex gameports
        • 2.5. Unregistering a gameport
        • 2.6. The gameport structure
      • 3. Keyboard notifier
    • Driver-specific documentation
      • 1. ALPS Touchpad Protocol
        • 1.1. Introduction
        • 1.2. Detection
        • 1.3. Command Mode
        • 1.4. Packet Format
        • 1.5. PS/2 packet format
        • 1.6. ALPS Absolute Mode - Protocol Version 1
        • 1.7. ALPS Absolute Mode - Protocol Version 2
        • 1.8. Dualpoint device – interleaved packet format
        • 1.9. ALPS Absolute Mode - Protocol Version 3
        • 1.10. ALPS Absolute Mode - Protocol Version 4
        • 1.11. ALPS Absolute Mode - Protocol Version 5
        • 1.12. ALPS Absolute Mode - Protocol Version 6
        • 1.13. ALPS Absolute Mode - Protocol Version 7
        • 1.14. ALPS Absolute Mode - Protocol Version 8
      • 2. Amiga joystick extensions
        • 2.1. Amiga 4-joystick parport extension
        • 2.2. Amiga digital joystick pinout
        • 2.3. Amiga mouse pinout
        • 2.4. Amiga analog joystick pinout
        • 2.5. Amiga lightpen pinout
      • 3. Apple Touchpad Driver (appletouch)
        • 3.1. Usage
        • 3.2. Fuzz problems
      • 4. Intelligent Keyboard (ikbd) Protocol
        • 4.1. Introduction
        • 4.2. Keyboard
        • 4.3. Mouse
        • 4.4. Joystick
        • 4.5. Time-of-Day Clock
        • 4.6. Status Inquiries
        • 4.7. Power-Up Mode
        • 4.8. ikbd Command Set
        • 4.9. SCAN CODES
      • 5. BCM5974 Driver (bcm5974)
        • 5.1. Usage
        • 5.2. USB Race
        • 5.3. Debug output
        • 5.4. Trivia
      • 6. CMA3000-D0x Accelerometer
        • 6.1. Description
        • 6.2. Platform Data
        • 6.3. Input Interface
        • 6.4. Register/Platform parameters Description
      • 7. Crystal SoundFusion CS4610/CS4612/CS461 joystick
      • 8. EDT ft5x06 based Polytouch devices
      • 9. Elantech Touchpad Driver
        • 9.1. Introduction
        • 9.2. Extra knobs
        • 9.3. Differentiating hardware versions
        • 9.4. Hardware version 1
        • 9.5. Hardware version 2
        • 9.6. Hardware version 3
        • 9.7. Hardware version 4
        • 9.8. Trackpoint (for Hardware version 3 and 4)
      • 10. Driver for tilt-switches connected via GPIOs
        • 10.1. Data structures
        • 10.2. Example
      • 11. Iforce Protocol
        • 11.1. Introduction
        • 11.2. Preliminary Notes
        • 11.3. Device input state
        • 11.4. Device effects states
        • 11.5. Appendix: How to study the protocol?
        • 11.6. URLS
      • 12. Parallel Port Joystick Drivers
        • 12.1. Disclaimer
        • 12.2. Introduction
        • 12.3. Devices supported
        • 12.4. The drivers
        • 12.5. PC parallel port pinout
      • 13. N-Trig touchscreen Driver
        • 13.1. Parameters
        • 13.2. Additional sysfs items
        • 13.3. Filtering
        • 13.4. Calibration
        • 13.5. Tracking
      • 14. rotary-encoder - a generic driver for GPIO connected devices
        • 14.1. Function
        • 14.2. Events / state machine
        • 14.3. Platform requirements
        • 14.4. Board integration
      • 15. Sentelic Touchpad
        • 15.1. Finger Sensing Pad Intellimouse Mode (scrolling wheel, 4th and 5th buttons)
        • 15.2. Absolute position for STL3886-G0
        • 15.3. Absolute position for STL3888-Ax
        • 15.4. Absolute position for STL3888-B0
        • 15.5. Absolute position for STL3888-Cx and STL3888-Dx
        • 15.6. FSP Enable/Disable packet
        • 15.7. PS/2 Command Set
        • 15.8. Programming Sequence for Determining Packet Parsing Flow
        • 15.9. Programming Sequence for Register Reading/Writing
        • 15.10. Programming Sequence for Page Register Reading/Writing
        • 15.11. Gesture ID
        • 15.12. Register Listing
      • 16. Walkera WK-0701 transmitter
        • 16.1. Connecting to PC
        • 16.2. Software
        • 16.3. Technical details
      • 17. xpad - Linux USB driver for Xbox compatible controllers
        • 17.1. Notes
        • 17.2. USB adapters
        • 17.3. Driver Installation
        • 17.4. Supported Controllers
        • 17.5. Manual Testing
        • 17.6. Thanks
        • 17.7. References
        • 17.8. Historic Edits
      • 18. Driver documentation for yealink usb-p1k phones
        • 18.1. Status
        • 18.2. keyboard features
        • 18.3. LCD features
        • 18.4. Driver usage
        • 18.5. Sound features
        • 18.6. Troubleshooting
        • 18.7. Credits & Acknowledgments
  • Linux GPU Driver Developer’s Guide
    • Introduction
      • Style Guidelines
      • Getting Started
      • Contribution Process
        • Feature Merge Deadlines
        • Code of Conduct
    • DRM Internals
      • Driver Initialization
        • Driver Information
        • Device Instance and Driver Handling
        • Driver Load
        • Bus-specific Device Registration and PCI Support
      • Open/Close, File Operations and IOCTLs
        • File Operations
      • Misc Utilities
        • Printer
      • Legacy Support Code
        • Legacy Suspend/Resume
        • Legacy DMA Services
    • DRM Memory Management
      • The Translation Table Manager (TTM)
        • TTM initialization
      • The Graphics Execution Manager (GEM)
        • GEM Initialization
        • GEM Objects Creation
        • GEM Objects Lifetime
        • GEM Objects Naming
        • GEM Objects Mapping
        • Memory Coherency
        • Command Execution
        • GEM Function Reference
        • GEM CMA Helper Functions Reference
      • VMA Offset Manager
      • PRIME Buffer Sharing
        • Overview and Driver Interface
        • PRIME Helper Functions
        • PRIME Function References
      • DRM MM Range Allocator
        • Overview
        • LRU Scan/Eviction Support
        • DRM MM Range Allocator Function References
      • DRM Cache Handling
      • DRM Sync Objects
    • Kernel Mode Setting (KMS)
      • Overview
      • KMS Core Structures and Functions
      • Modeset Base Object Abstraction
      • Atomic Mode Setting
        • Atomic Mode Setting Function Reference
      • CRTC Abstraction
        • CRTC Functions Reference
      • Frame Buffer Abstraction
        • Frame Buffer Functions Reference
      • DRM Format Handling
      • Dumb Buffer Objects
      • Plane Abstraction
        • Plane Functions Reference
      • Display Modes Function Reference
      • Connector Abstraction
        • Connector Functions Reference
      • Encoder Abstraction
        • Encoder Functions Reference
      • KMS Initialization and Cleanup
        • CRTCs (struct drm_crtc)
        • Cleanup
        • Output discovery and initialization example
      • KMS Locking
      • KMS Properties
        • Property Types and Blob Property Support
        • Standard Connector Properties
        • Plane Composition Properties
        • Color Management Properties
        • Tile Group Property
        • Explicit Fencing Properties
        • Existing KMS Properties
      • Vertical Blanking
        • Vertical Blanking and Interrupt Handling Functions Reference
    • Mode Setting Helper Functions
      • Modeset Helper Reference for Common Vtables
      • Atomic Modeset Helper Functions Reference
        • Overview
        • Implementing Asynchronous Atomic Commit
        • Atomic State Reset and Initialization
        • Helper Functions Reference
      • Legacy CRTC/Modeset Helper Functions Reference
      • Simple KMS Helper Reference
      • fbdev Helper Functions Reference
      • Framebuffer CMA Helper Functions Reference
      • Bridges
        • Overview
        • Default bridge callback sequence
        • Bridge Helper Reference
        • Panel-Bridge Helper Reference
      • Panel Helper Reference
      • Display Port Helper Functions Reference
      • Display Port Dual Mode Adaptor Helper Functions Reference
      • Display Port MST Helper Functions Reference
      • MIPI DSI Helper Functions Reference
      • Output Probing Helper Functions Reference
      • EDID Helper Functions Reference
      • SCDC Helper Functions Reference
      • Rectangle Utilities Reference
      • HDMI Infoframes Helper Reference
      • Flip-work Helper Reference
      • Plane Helper Reference
      • Auxiliary Modeset Helpers
    • Userland interfaces
      • libdrm Device Lookup
      • Primary Nodes, DRM Master and Authentication
      • Open-Source Userspace Requirements
      • Render nodes
      • IOCTL Support on Device Nodes
      • Testing and validation
        • Validating changes with IGT
        • Display CRC Support
        • Debugfs Support
      • Sysfs Support
      • VBlank event handling
    • drm/i915 Intel GFX Driver
      • Core Driver Infrastructure
        • Runtime Power Management
        • Interrupt Handling
        • Intel GVT-g Guest Support(vGPU)
        • Intel GVT-g Host Support(vGPU device model)
      • Display Hardware Handling
        • Mode Setting Infrastructure
        • Frontbuffer Tracking
        • Display FIFO Underrun Reporting
        • Plane Configuration
        • Atomic Plane Helpers
        • Output Probing
        • Hotplug
        • High Definition Audio
        • Intel HDMI LPE Audio Support
        • Panel Self Refresh PSR (PSR/SRD)
        • Frame Buffer Compression (FBC)
        • Display Refresh Rate Switching (DRRS)
        • DPIO
        • CSR firmware support for DMC
        • Video BIOS Table (VBT)
        • Display clocks
        • Display PLLs
      • Memory Management and Command Submission
        • Batchbuffer Parsing
        • Batchbuffer Pools
        • Logical Rings, Logical Ring Contexts and Execlists
        • Global GTT views
        • GTT Fences and Swizzling
        • Object Tiling IOCTLs
        • Buffer Object Eviction
        • Buffer Object Memory Shrinking
      • GuC
        • GuC-specific firmware loader
        • GuC-based command submission
        • GuC Firmware Layout
      • Tracing
        • i915_ppgtt_create and i915_ppgtt_release
        • i915_context_create and i915_context_free
        • switch_mm
      • Perf
        • Overview
        • Comparison with Core Perf
        • i915 Driver Entry Points
        • i915 Perf Stream
        • i915 Perf Observation Architecture Stream
        • All i915 Perf Internals
    • drm/meson AmLogic Meson Video Processing Unit
      • Video Processing Unit
      • Video Input Unit
      • Video Post Processing
      • Video Encoder
      • Video Canvas Management
      • Video Clocks
      • HDMI Video Output
    • drm/pl111 ARM PrimeCell PL111 CLCD Driver
    • drm/tegra NVIDIA Tegra GPU and display driver
      • Driver Infrastructure
        • Host1x Infrastructure Reference
        • Host1x Syncpoint Reference
      • KMS driver
        • Display Controllers
        • Outputs
      • Userspace Interface
        • GEM Buffers
        • Syncpoints
        • Command Stream Submission
    • drm/tinydrm Driver library
      • Core functionality
      • Additional helpers
      • MIPI DBI Compatible Controllers
    • drm/vc4 Broadcom VC4 Graphics Driver
      • Display Hardware Handling
        • Pixel Valve (DRM CRTC)
        • HVS
        • HVS planes
        • HDMI encoder
        • DSI encoder
        • DPI encoder
        • VEC (Composite TV out) encoder
      • Memory Management and 3D Command Submission
        • GPU buffer object (BO) management
        • V3D binner command list (BCL) validation
        • V3D render command list (RCL) generation
        • Shader validator for VC4
        • V3D Interrupts
    • VGA Switcheroo
      • Modes of Use
        • Manual switching and manual power control
        • Driver power control
      • API
        • Public functions
        • Public structures
        • Public constants
        • Private structures
      • Handlers
        • apple-gmux Handler
    • VGA Arbiter
      • vgaarb kernel/userspace ABI
      • In-kernel interface
      • libpciaccess
      • xf86VGAArbiter (X server implementation)
      • References
    • drm/bridge/dw-hdmi Synopsys DesignWare HDMI Controller
      • Synopsys DesignWare HDMI Controller
        • Supported Input Formats and Encodings
    • TODO list
      • Subsystem-wide refactorings
        • De-midlayer drivers
        • Switch from reference/unreference to get/put
        • Convert existing KMS drivers to atomic modesetting
        • Clean up the clipped coordination confusion around planes
        • Implement deferred fbdev setup in the helper
        • Convert early atomic drivers to async commit helpers
        • Better manual-upload support for atomic
        • Fallout from atomic KMS
        • Get rid of dev->struct_mutex from GEM drivers
      • Core refactorings
        • Use new IDR deletion interface to clean up drm_gem_handle_delete()
        • Clean up the DRM header mess
        • Add missing kerneldoc for exported functions
        • Hide legacy cruft better
        • Make panic handling work
        • Clean up the debugfs support
      • Better Testing
        • Enable trinity for DRM
        • Make KMS tests in i-g-t generic
        • Create a virtual KMS driver for testing (vkms)
      • Driver Specific
        • tinydrm
      • Outside DRM
  • Security Documentation
    • Credentials in Linux
      • Overview
      • Types of Credentials
      • File Markings
      • Task Credentials
        • Immutable Credentials
        • Accessing Task Credentials
        • Accessing Another Task’s Credentials
        • Altering Credentials
        • Managing Credentials
      • Open File Credentials
      • Overriding the VFS’s Use of Credentials
    • IMA Template Management Mechanism
      • Introduction
      • Supported Template Fields and Descriptors
      • Use
    • Kernel Keys
      • Kernel Key Retention Service
        • Key Overview
        • Key Service Overview
        • Key Access Permissions
        • SELinux Support
        • New ProcFS Files
        • Userspace System Call Interface
        • Kernel Services
        • Notes On Accessing Payload Contents
        • Defining a Key Type
        • Request-Key Callback Service
        • Garbage Collection
      • Encrypted keys for the eCryptfs filesystem
      • Key Request Service
        • The Process
        • Negative Instantiation And Rejection
        • The Search Algorithm
      • Trusted and Encrypted Keys
    • Linux Security Module Development
    • Kernel Self-Protection
      • Attack Surface Reduction
        • Strict kernel memory permissions
        • Reduced access to syscalls
        • Restricting access to kernel modules
      • Memory integrity
        • Stack buffer overflow
        • Stack depth overflow
        • Heap memory integrity
        • Counter integrity
        • Size calculation overflow detection
      • Probabilistic defenses
        • Canaries, blinding, and other secrets
        • Kernel Address Space Layout Randomization (KASLR)
      • Preventing Information Exposures
        • Unique identifiers
        • Memory initialization
        • Memory poisoning
        • Destination tracking
    • Trusted Platform Module documentation
      • Virtual TPM Proxy Driver for Linux Containers
        • Introduction
        • Design
        • UAPI
  • Linux Sound Subsystem Documentation
    • ALSA Kernel API Documentation
      • The ALSA Driver API
        • Management of Cards and Devices
        • PCM API
        • Control/Mixer API
        • MIDI API
        • Proc Info API
        • Compress Offload
        • ASoC
        • Miscellaneous Functions
      • Writing an ALSA Driver
        • Preface
        • File Tree Structure
        • Basic Flow for PCI Drivers
        • Management of Cards and Components
        • PCI Resource Management
        • PCM Interface
        • Control Interface
        • API for AC97 Codec
        • MIDI (MPU401-UART) Interface
        • RawMIDI Interface
        • Miscellaneous Devices
        • Buffer and Memory Management
        • Proc Interface
        • Power Management
        • Module Parameters
        • How To Put Your Driver Into ALSA Tree
        • Useful Functions
        • Acknowledgments
    • Designs and Implementations
      • Standard ALSA Control Names
        • Standard Syntax
        • Exceptions (deprecated)
        • PCM interface
        • IEC958 (S/PDIF) interface
      • ALSA PCM channel-mapping API
        • General
        • Design
      • ALSA Compress-Offload API
        • Overview
        • Requirements
        • Design
        • Gapless Playback
        • Not supported
        • Credits
      • ALSA PCM Timestamping
      • ALSA Jack Controls
        • Why we need Jack kcontrols
        • Jack Kcontrol Internals
        • How to use jack kcontrols
      • Tracepoints in ALSA
        • Tracepoints in ALSA PCM core
        • Tracepoints in drivers
      • Proc Files of ALSA Drivers
        • General
        • Global Information
        • Card Specific Files
        • PCM Proc Files
        • AC97 Codec Information
        • USB Audio Streams
        • HD-Audio Codecs
        • Sequencer Information
        • Help For Debugging?
      • Notes on Power-Saving Mode
      • Notes on Kernel OSS-Emulation
        • Modules
        • Device Mapping
        • PCM Mode
        • Mixer Elements
        • Duplex Streams
        • Unsupported Features
      • OSS Sequencer Emulation on ALSA
        • Description
        • Installation
        • Using Synthesizer Devices
        • Using MIDI Devices
        • Module Options
        • Queue Mechanism
        • Interface to Synthesizer Device
        • Events
        • Interface to MIDI Device
        • Known Problems / TODO’s
    • ALSA SoC Layer
      • ALSA SoC Layer Overview
        • ASoC Design
      • ASoC Codec Class Driver
        • ASoC Codec driver breakdown
      • ASoC Digital Audio Interface (DAI)
        • AC97
        • I2S
        • PCM
      • Dynamic Audio Power Management for Portable Devices
        • Description
        • DAPM Widgets
        • Codec/DSP Widget Interconnections
        • Endpoint Widgets
        • DAPM Widget Events
      • ASoC Platform Driver
        • Audio DMA
        • SoC DAI Drivers
        • SoC DSP Drivers
      • ASoC Machine Driver
        • probe()/remove()
        • suspend()/resume()
        • Machine DAI Configuration
        • Machine Power Map
        • Machine Controls
      • Audio Pops and Clicks
        • Minimising Playback Pops and Clicks
        • Minimising Capture Pops and Clicks
        • Zipper Noise
      • Audio Clocking
        • Master Clock
        • DAI Clocks
      • ASoC jack detection
        • The jack - struct snd_soc_jack
        • snd_soc_jack_pin
        • Jack detection methods
        • Machine drivers
      • Dynamic PCM
        • Description
        • DPCM machine driver
        • Writing a DPCM DSP driver
        • Hostless PCM streams
      • Creating codec to codec dai link for ALSA dapm
    • Advanced Linux Sound Architecture - Driver Configuration guide
      • Kernel Configuration
      • Module parameters
        • Module snd
        • Module snd-pcm-oss
        • Module snd-rawmidi
        • Common parameters for top sound card modules
        • Module snd-adlib
        • Module snd-ad1816a
        • Module snd-ad1848
        • Module snd-ad1889
        • Module snd-ali5451
        • Module snd-als100
        • Module snd-als300
        • Module snd-als4000
        • Module snd-asihpi
        • Module snd-atiixp
        • Module snd-atiixp-modem
        • Module snd-au8810, snd-au8820, snd-au8830
        • Module snd-azt1605
        • Module snd-azt2316
        • Module snd-aw2
        • Module snd-azt2320
        • Module snd-azt3328
        • Module snd-bt87x
        • Module snd-ca0106
        • Module snd-cmi8330
        • Module snd-cmipci
        • Module snd-cs4231
        • Module snd-cs4236
        • Module snd-cs4281
        • Module snd-cs46xx
        • Module snd-cs5530
        • Module snd-cs5535audio
        • Module snd-ctxfi
        • Module snd-darla20
        • Module snd-darla24
        • Module snd-dt019x
        • Module snd-dummy
        • Module snd-echo3g
        • Module snd-emu10k1
        • Module snd-emu10k1x
        • Module snd-ens1370
        • Module snd-ens1371
        • Module snd-es1688
        • Module snd-es18xx
        • Module snd-es1938
        • Module snd-es1968
        • Module snd-fm801
        • Module snd-gina20
        • Module snd-gina24
        • Module snd-gusclassic
        • Module snd-gusextreme
        • Module snd-gusmax
        • Module snd-hda-intel
        • Module snd-hdsp
        • Module snd-hdspm
        • Module snd-ice1712
        • Module snd-ice1724
        • Module snd-indigo
        • Module snd-indigodj
        • Module snd-indigoio
        • Module snd-intel8x0
        • Module snd-intel8x0m
        • Module snd-interwave
        • Module snd-interwave-stb
        • Module snd-jazz16
        • Module snd-korg1212
        • Module snd-layla20
        • Module snd-layla24
        • Module snd-lola
        • Module snd-lx6464es
        • Module snd-maestro3
        • Module snd-mia
        • Module snd-miro
        • Module snd-mixart
        • Module snd-mona
        • Module snd-mpu401
        • Module snd-msnd-classic
        • Module snd-msnd-pinnacle
        • Module snd-mtpav
        • Module snd-mts64
        • Module snd-nm256
        • Module snd-opl3sa2
        • Module snd-opti92x-ad1848
        • Module snd-opti92x-cs4231
        • Module snd-opti93x
        • Module snd-oxygen
        • Module snd-pcsp
        • Module snd-pcxhr
        • Module snd-portman2x4
        • Module snd-powermac (on ppc only)
        • Module snd-pxa2xx-ac97 (on arm only)
        • Module snd-riptide
        • Module snd-rme32
        • Module snd-rme96
        • Module snd-rme9652
        • Module snd-sa11xx-uda1341 (on arm only)
        • Module snd-sb8
        • Module snd-sb16 and snd-sbawe
        • Module snd-sc6000
        • Module snd-sscape
        • Module snd-sun-amd7930 (on sparc only)
        • Module snd-sun-cs4231 (on sparc only)
        • Module snd-sun-dbri (on sparc only)
        • Module snd-wavefront
        • Module snd-sonicvibes
        • Module snd-serial-u16550
        • Module snd-trident
        • Module snd-ua101
        • Module snd-usb-audio
        • Module snd-usb-caiaq
        • Module snd-usb-usx2y
        • Module snd-via82xx
        • Module snd-via82xx-modem
        • Module snd-virmidi
        • Module snd-virtuoso
        • Module snd-vx222
        • Module snd-vxpocket
        • Module snd-ymfpci
        • Module snd-pdaudiocf
      • AC97 Quirk Option
      • Configuring Non-ISAPNP Cards
      • Module Autoloading Support
      • ALSA PCM devices to OSS devices mapping
      • Proc interfaces (/proc/asound)
        • /proc/asound/card#/pcm#[cp]/oss
      • Early Buffer Allocation
      • Links and Addresses
    • HD-Audio
      • More Notes on HD-Audio Driver
        • General
        • HD-Audio Controller
        • HD-Audio Codec
        • Other Issues
        • Debug Tools
      • HD-Audio Codec-Specific Models
        • ALC880
        • ALC260
        • ALC262
        • ALC267/268
        • ALC22x/23x/25x/269/27x/28x/29x (and vendor-specific ALC3xxx models)
        • ALC66x/67x/892
        • ALC680
        • ALC88x/898/1150
        • ALC861/660
        • ALC861VD/660VD
        • CMI9880
        • AD1882 / AD1882A
        • AD1884A / AD1883 / AD1984A / AD1984B
        • AD1884
        • AD1981
        • AD1983
        • AD1984
        • AD1986A
        • AD1988/AD1988B/AD1989A/AD1989B
        • Conexant 5045
        • Conexant 5047
        • Conexant 5051
        • Conexant 5066
        • STAC9200
        • STAC9205/9254
        • STAC9220/9221
        • STAC9202/9250/9251
        • STAC9227/9228/9229/927x
        • STAC92HD71B*
        • STAC92HD73*
        • STAC92HD83*
        • STAC92HD95
        • STAC9872
        • Cirrus Logic CS4206/4207
        • Cirrus Logic CS4208
        • VIA VT17xx/VT18xx/VT20xx
      • HD-Audio Codec-Specific Mixer Controls
        • Realtek codecs
        • IDT/Sigmatel codecs
        • VIA codecs
        • Conexant codecs
        • Analog codecs
      • HD-Audio DP-MST Support
        • PCM
        • Pin Initialization
        • Connection list
        • Jack
        • Others to be added later
    • Card-Specific Information
      • Analog Joystick Support on ALSA Drivers
        • General
        • PCI Cards
        • ISA Cards
      • Brief Notes on C-Media 8338/8738/8768/8770 Driver
        • Front/Rear Multi-channel Playback
        • 4/6 Multi-Channel Playback
        • Digital I/O
        • The AC3 (RAW DIGITAL) OUTPUT
        • ANALOG MIXER INTERFACE
        • MIDI CONTROLLER
        • FM OPL/3 Synth
        • Joystick and Modem
        • Debugging Information
      • Sound Blaster Live mixer / default DSP code
        • IEC958 (S/PDIF) raw PCM
        • Digital mixer controls
        • PCM stream related controls
        • MANUALS/PATENTS
      • Sound Blaster Audigy mixer / default DSP code
        • Digital mixer controls
        • PCM stream related controls
        • MANUALS/PATENTS
      • Low latency, multichannel audio with JACK and the emu10k1/emu10k2
      • VIA82xx mixer
      • Guide to using M-Audio Audiophile USB with ALSA and Jack
        • History
        • Audiophile USB Specs and correct usage
        • Audiophile USB MIDI support in ALSA
        • Audiophile USB Audio support in ALSA
        • Audiophile USB and Jack support
      • Alsa driver for Digigram miXart8 and miXart8AES/EBU soundcards
        • GENERAL
        • VERSION 0.1.0
        • NOT YET IMPLEMENTED
        • FIRMWARE
        • COPYRIGHT
      • ALSA BT87x Driver
        • Intro
        • Driver Status
        • Audio modes
        • Digital audio mode
        • Analog audio mode (A/D)
      • Notes on Maya44 USB Audio Support
        • STATE OF DEVELOPMENT
        • DRIVER DETAILS
        • SAMPLING RATES
        • SOUND DEVICES
        • NAMING OF MIXER CONTROLS
      • Software Interface ALSA-DSP MADI Driver
        • Hardware functionality
        • Calling Parameter
      • Serial UART 16450/16550 MIDI driver
      • Imagination Technologies SPDIF Input Controllers
  • Linux Kernel Crypto API
    • Kernel Crypto API Interface Specification
      • Introduction
      • Terminology
    • Kernel Crypto API Architecture
      • Cipher algorithm types
      • Ciphers And Templates
      • Synchronous And Asynchronous Operation
      • Crypto API Cipher References And Priority
      • Key Sizes
      • Cipher Allocation Type And Masks
      • Internal Structure of Kernel Crypto API
        • Generic AEAD Cipher Structure
        • Generic Block Cipher Structure
        • Generic Keyed Message Digest Structure
    • Developing Cipher Algorithms
      • Registering And Unregistering Transformation
      • Single-Block Symmetric Ciphers [CIPHER]
        • Registration specifics
        • Cipher Definition With struct cipher_alg
      • Multi-Block Ciphers
        • Registration Specifics
        • Cipher Definition With struct blkcipher_alg and ablkcipher_alg
        • Specifics Of Asynchronous Multi-Block Cipher
      • Hashing [HASH]
        • Registering And Unregistering The Transformation
        • Cipher Definition With struct shash_alg and ahash_alg
        • Specifics Of Asynchronous HASH Transformation
    • User Space Interface
      • Introduction
      • User Space API General Remarks
      • In-place Cipher operation
      • Message Digest API
      • Symmetric Cipher API
      • AEAD Cipher API
        • AEAD Memory Structure
      • Random Number Generator API
      • Zero-Copy Interface
      • Setsockopt Interface
      • User space API example
    • Programming Interface
      • Block Cipher Algorithm Definitions
      • Symmetric Key Cipher API
      • Symmetric Key Cipher Request Handle
      • Single Block Cipher API
      • Asynchronous Block Cipher API - Deprecated
      • Asynchronous Cipher Request Handle - Deprecated
      • Synchronous Block Cipher API - Deprecated
      • Authenticated Encryption With Associated Data (AEAD) Algorithm Definitions
      • Authenticated Encryption With Associated Data (AEAD) Cipher API
      • Asynchronous AEAD Request Handle
      • Message Digest Algorithm Definitions
      • Asynchronous Message Digest API
      • Asynchronous Hash Request Handle
      • Synchronous Message Digest API
      • Random Number Algorithm Definitions
      • Crypto API Random Number API
      • Asymmetric Cipher Algorithm Definitions
      • Asymmetric Cipher API
      • Asymmetric Cipher Request Handle
      • Key-agreement Protocol Primitives (KPP) Cipher Algorithm Definitions
      • Key-agreement Protocol Primitives (KPP) Cipher API
      • Key-agreement Protocol Primitives (KPP) Cipher Request Handle
      • ECDH Helper Functions
      • DH Helper Functions
    • Code Examples
      • Code Example For Symmetric Key Cipher Operation
      • Code Example For Use of Operational State Memory With SHASH
      • Code Example For Random Number Generator Usage
  • Linux Filesystems API
    • The Linux VFS
      • The Filesystem types
      • The Directory Cache
      • Inode Handling
      • Registration and Superblocks
      • File Locks
      • Other Functions
    • The proc filesystem
      • sysctl interface
      • proc filesystem interface
    • Events based on file descriptors
    • The Filesystem for Exporting Kernel Objects
    • The debugfs filesystem
      • debugfs interface
    • The Linux Journalling API
      • Overview
        • Details
        • Summary
      • Data Types
        • Structures
      • Functions
        • Journal Level
        • Transasction Level
      • See also
    • splice API
    • pipes API
  • SuperH Interfaces Guide
    • Memory Management
      • SH-4
        • Store Queue API
      • SH-5
        • TLB Interfaces
    • Machine Specific Interfaces
      • mach-dreamcast
      • mach-x3proto
    • Busses
      • SuperHyway
      • Maple
  • Korean translations
    • 어떻게 리눅스 커널 개발을 하는가
      • 소개
      • 법적 문제
      • 문서
      • 커널 개발자가 되는 것
      • 개발 프로세스
        • 4.x 커널 트리
        • 4.x.y - 안정 커널 트리
        • 4.x -git 패치들
        • 서브시스템 커널 트리들과 패치들
      • 4.x - 통합 테스트를 위한 next 커널 트리
      • 버그 보고
      • 버그 리포트들의 관리
      • 메일링 리스트들
      • 커뮤니티와 협력하는 법
      • 커널 커뮤니티와 기업 조직간의 차이점
      • 여러분의 변경을 나누어라
      • 변경을 정당화해라
      • 변경을 문서화해라
  • Chinese translations
    • Linux 内核代码风格
      • 1) 缩进
      • 2) 把长的行和字符串打散
      • 3) 大括号和空格的放置
        • 3.1) 空格
      • 4) 命名
      • 5) Typedef
      • 6) 函数
      • 7) 集中的函数退出途径
      • 8) 注释
      • 9) 你已经把事情弄糟了
      • 10) Kconfig 配置文件
      • 11) 数据结构
      • 12) 宏，枚举和RTL
      • 13) 打印内核消息
      • 14) 分配内存
      • 15) 内联弊病
      • 16) 函数返回值及命名
      • 17) 不要重新发明内核宏
      • 18) 编辑器模式行和其他需要罗嗦的事情
      • 19) 内联汇编
      • 20) 条件编译
      • 附录 I) 参考
  • Japanese translations
    • Linux カーネル開発のやり方
      • はじめに
      • 法的問題
      • ドキュメント
      • カーネル開発者になるには
      • 開発プロセス
        • 4.x カーネルツリー
        • 4.x.y -stable カーネルツリー
        • 4.x -git パッチ
        • サブシステム毎のカーネルツリーとパッチ
        • 統合テストのための 4.x -next カーネルツリー
      • バグレポート
      • バグレポートの管理
      • メーリングリスト
      • コミュニティと共に働くこと
      • カーネルコミュニティと企業組織のちがい
      • 変更を分割する
      • あなたの変更を正当化する
      • あなたの変更を説明する
 
The Linux Kernel
  • Docs »
  • Linux Sound Subsystem Documentation »
  • ALSA SoC Layer
  • View page source

ALSA SoC Layer¶

The documentation is spilt into the following sections:-

  • ALSA SoC Layer Overview
    • ASoC Design
  • ASoC Codec Class Driver
    • ASoC Codec driver breakdown
  • ASoC Digital Audio Interface (DAI)
    • AC97
    • I2S
    • PCM
  • Dynamic Audio Power Management for Portable Devices
    • Description
    • DAPM Widgets
    • Codec/DSP Widget Interconnections
    • Endpoint Widgets
    • DAPM Widget Events
  • ASoC Platform Driver
    • Audio DMA
    • SoC DAI Drivers
    • SoC DSP Drivers
  • ASoC Machine Driver
    • probe()/remove()
    • suspend()/resume()
    • Machine DAI Configuration
    • Machine Power Map
    • Machine Controls
  • Audio Pops and Clicks
    • Minimising Playback Pops and Clicks
    • Minimising Capture Pops and Clicks
    • Zipper Noise
  • Audio Clocking
    • Master Clock
    • DAI Clocks
  • ASoC jack detection
    • The jack - struct snd_soc_jack
    • snd_soc_jack_pin
    • Jack detection methods
    • Machine drivers
  • Dynamic PCM
    • Description
    • DPCM machine driver
    • Writing a DPCM DSP driver
    • Hostless PCM streams
  • Creating codec to codec dai link for ALSA dapm
Next Previous

© Copyright The kernel development community.

Built with Sphinx using a theme provided by Read the Docs.