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
=================== ARECA FIRMWARE SPEC =================== Usage of IOP331 adapter ======================= (All In/Out is in IOP331's view) 1. Message 0 ------------ - InitThread message and return code 2. Doorbell is used for RS-232 emulation ---------------------------------------- inDoorBell bit0 data in...
Documentation/scsi/arcmsr_spec.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ========================================= Linux driver for Brocade FC/FCOE adapters ========================================= Supported Hardware ------------------ bfa 3.0.2.2 driver supports all Brocade FC/FCOE adapters. Below is a list of adapter models with corresponding PCIIDs...
Documentation/scsi/bfa.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 =========================== Operating FCoE using bnx2fc =========================== Broadcom FCoE offload through bnx2fc is full stateful hardware offload that cooperates with all interfaces provided by the Linux ecosystem for FC/FCoE and SCSI controllers. As such, FCoE functionali...
Documentation/scsi/bnx2fc.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ================================= Chelsio S3 iSCSI Driver for Linux ================================= Introduction ============ The Chelsio T3 ASIC based Adapters (S310, S320, S302, S304, Mezz cards, etc. series of products) support iSCSI acceleration and iSCSI Direct Data Placeme...
Documentation/scsi/cxgb3i.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ================== dc395x SCSI driver ================== Status ------ The driver has been tested with CD-R and CD-R/W drives. These should be safe to use. Testing with hard disks has not been done to any great degree and caution should be exercised if you want to attempt to use th...
Documentation/scsi/dc395x.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 =================== Adaptec dpti driver =================== Redistribution and use in source form, with or without modification, are permitted provided that redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. ...
Documentation/scsi/dpti.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 .. include:: <isonum.txt> ================ g_NCR5380 driver ================ Copyright |copy| 1993 Drew Eckhard NCR53c400 extensions Copyright |copy| 1994,1995,1996 Kevin Lentin This file documents the NCR53c400 extensions by Kevin Lentin and some enhancements to the NCR5380 core...
Documentation/scsi/g_NCR5380.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ========================================= HPSA - Hewlett Packard Smart Array driver ========================================= This file describes the hpsa SCSI driver for HP Smart Array controllers. The hpsa driver is intended to supplant the cciss driver for newer Smart Array cont...
Documentation/scsi/hpsa.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 .. include:: <isonum.txt> ====================================================== Highpoint RocketRAID 3xxx/4xxx Adapter Driver (hptiop) ====================================================== Controller Register Map ----------------------- For RR44xx Intel IOP based adapters, the c...
Documentation/scsi/hptiop.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ============== SCSI Subsystem ============== .. toctree:: :maxdepth: 1 Introduction ============ .. toctree:: :maxdepth: 1 scsi SCSI driver APIs ================ .. toctree:: :maxdepth: 1 scsi_mid_low_api scsi_eh SCSI driver parameters =====================...
Documentation/scsi/index.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ========= SAS Layer ========= The SAS Layer is a management infrastructure which manages SAS LLDDs. It sits between SCSI Core and SAS LLDDs. The layout is as follows: while SCSI Core is concerned with SAM/SPC issues, and a SAS LLDD+sequencer is concerned with phy/OOB/link managem...
Documentation/scsi/libsas.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ========================== Link Power Managent Policy ========================== This parameter allows the user to set the link (interface) power management. There are 6 possible options: ====================== ===================================================== Value Effect ...
Documentation/scsi/link_power_management_policy.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ========================= LPFC Driver Release Notes ========================= .. important:: Starting in the 8.0.17 release, the driver began to be targeted strictly toward the upstream kernel. As such, we removed #ifdefs for older kernels (pre 2.6.10). The 8.0.16 release s...
Documentation/scsi/lpfc.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ================================= Megaraid Common Management Module ================================= Overview -------- Different classes of controllers from LSI Logic accept and respond to the user applications in a similar way. They understand the same firmware control commands....
Documentation/scsi/megaraid.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 =========================== NCR53C8XX/SYM53C8XX drivers =========================== Written by Gerard Roudier <groudier@free.fr> 21 Rue Carnot 95170 DEUIL LA BARRE - FRANCE 29 May 1999 .. Contents: 1. Introduction 2. Supported chips and SCSI features 3. Advantages ...
Documentation/scsi/ncr53c8xx.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ====================================== Terse where to get ZIP Drive help info ====================================== General Iomega ZIP drive page for Linux: http://web.archive.org/web/%2E/http://www.torque.net/~campbell/ Driver archive for old drivers: http://web.archive.org/web/...
Documentation/scsi/ppa.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ================================= Qlogic FASXXX Family Driver Notes ================================= This driver supports the Qlogic FASXXX family of chips. This driver only works with the ISA, VLB, and PCMCIA versions of the Qlogic FastSCSI! cards as well as any other card base...
Documentation/scsi/qlogicfas.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ========================= SCSI media changer driver ========================= This is a driver for SCSI Medium Changer devices, which are listed with "Type: Medium Changer" in /proc/scsi/scsi. This is for *real* Jukeboxes. It is *not* supported to work with common small CD-ROM ch...
Documentation/scsi/scsi-changer.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ======================== SCSI Generic (sg) driver ======================== 20020126 Introduction ============ The SCSI Generic driver (sg) is one of the four "high level" SCSI device drivers along with sd, st and sr (disk, ta...
Documentation/scsi/scsi-generic.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ====================== SCSI Kernel Parameters ====================== See Documentation/admin-guide/kernel-parameters.rst for general information on specifying module parameters. This document may not be entirely up to date and comprehensive. The command ``modinfo -p ${modulename}`...
Documentation/scsi/scsi-parameters.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ============================ SCSI subsystem documentation ============================ The Linux Documentation Project (LDP) maintains a document describing the SCSI subsystem in the Linux kernel (lk) 2.4 series. See: https://www.tldp.org/HOWTO/SCSI-2.4-HOWTO . The LDP has single a...
Documentation/scsi/scsi.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ======= SCSI EH ======= This document describes SCSI midlayer error handling infrastructure. Please refer to Documentation/scsi/scsi_mid_low_api.rst for more information regarding SCSI midlayer. .. TABLE OF CONTENTS [1] How SCSI commands travel through the midlayer and to EH ...
Documentation/scsi/scsi_eh.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ================= SCSI FC Transport ================= Date: 11/18/2008 Kernel Revisions for features:: rports : <<TBS>> vports : 2.6.22 bsg support : 2.6.30 (?TBD?) Introduction ============ This file documents the features and components of the SCSI FC Transport. It als...
Documentation/scsi/scsi_fc_transport.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ============================================= SCSI mid_level - lower_level driver interface ============================================= Introduction ============ This document outlines the interface between the Linux SCSI mid level and SCSI lower level drivers. Lower level driver...
Documentation/scsi/scsi_mid_low_api.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ====================================== Linux SCSI Disk Driver (sd) Parameters ====================================== cache_type (RW) --------------- Enable/disable drive write & read cache. =========================== === === =========== ========== cache_type string ...
Documentation/scsi/sd-parameters.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ============================================== SMARTPQI - Microchip Smart Storage SCSI driver ============================================== This file describes the smartpqi SCSI driver for Microchip (http://www.microchip.com) PQI controllers. The smartpqi driver is the next genera...
Documentation/scsi/smartpqi.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ==================== The SCSI Tape Driver ==================== This file contains brief information about the SCSI tape driver. The driver is currently maintained by Kai Mäkisara (email Kai.Makisara@kolumbus.fi) Last modified: Tue Feb 9 21:54:16 2016 by kai.makisara Basics ====...
Documentation/scsi/st.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ======================= The sym53c500_cs Driver ======================= The sym53c500_cs driver originated as an add-on to David Hinds' pcmcia-cs package, and was written by Tom Corner (tcorner@via.at). A rewrite was long overdue, and the current version addresses the following co...
Documentation/scsi/sym53c500_cs.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ============ SYM-2 driver ============ Written by Gerard Roudier <groudier@free.fr> 21 Rue Carnot 95170 DEUIL LA BARRE - FRANCE Updated by Matthew Wilcox <matthew@wil.cx> 2004-10-09 .. Contents 1. Introduction 2. Supported chips and SCSI features 3. Advantages of ...
Documentation/scsi/sym53c8xx_2.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ======================== tcm_qla2xxx Driver Notes ======================== tcm_qla2xxx jam_host attribute ------------------------------ There is now a new module endpoint attribute called jam_host attribute:: jam_host: boolean=0/1 This attribute and accompanying code is only in...
Documentation/scsi/tcm_qla2xxx.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ======================= Universal Flash Storage ======================= .. Contents 1. Overview 2. UFS Architecture Overview 2.1 Application Layer 2.2 UFS Transport Protocol (UTP) layer 2.3 UFS Interconnect (UIC) Layer 3. UFSHCD Overview 3.1 UFS contr...
Documentation/scsi/ufs.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 =============================================================== Driver for Western Digital WD7193, WD7197 and WD7296 SCSI cards =============================================================== The card requires firmware that can be cut out of the Windows NT driver that can be downlo...
Documentation/scsi/wd719x.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 SCSI RDMA (SRP) transport class diagram ======================================= .. kernel-figure:: rport_state_diagram.dot
Documentation/scsi/scsi_transport_srp/figures.rst
null
null
null
null
null
source
linux
================================= IMA Template Management Mechanism ================================= Introduction ============ The original ``ima`` template is fixed length, containing the filedata hash and pathname. The filedata hash is limited to 20 bytes (md5/sha1). The pathname is a null terminated string, limi...
Documentation/security/IMA-templates.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ==== SCTP ==== SCTP LSM Support ================ Security Hooks -------------- For security module support, three SCTP specific hooks have been implemented:: security_sctp_assoc_request() security_sctp_bind_connect() security_sctp_sk_clone() security_sctp_assoc_e...
Documentation/security/SCTP.rst
null
null
null
null
null
source
linux
==================== Credentials in Linux ==================== By: David Howells <dhowells@redhat.com> .. contents:: :local: Overview ======== There are several parts to the security check performed by Linux when one object acts upon another: 1. Objects. Objects are things in the system that may be acted up...
Documentation/security/credentials.rst
null
null
null
null
null
source
linux
================================== Digital Signature Verification API ================================== :Author: Dmitry Kasatkin :Date: 06.10.2011 .. CONTENTS 1. Introduction 2. API 3. User-space utilities Introduction ============ Digital signature verification API provides a method to verify digital ...
Documentation/security/digsig.rst
null
null
null
null
null
source
linux
====================== Security Documentation ====================== .. toctree:: :maxdepth: 1 credentials snp-tdx-threat-model IMA-templates keys/index lsm lsm-development sak SCTP self-protection siphash tpm/index digsig landlock secrets/index ipe
Documentation/security/index.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 Integrity Policy Enforcement (IPE) - Kernel Documentation ========================================================= .. NOTE:: This is documentation targeted at developers, instead of administrators. If you're looking for documentation on the usage of IPE, please see :doc:...
Documentation/security/ipe.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 .. Copyright © 2017-2020 Mickaël Salaün <mic@digikod.net> .. Copyright © 2019-2020 ANSSI ================================== Landlock LSM: kernel documentation ================================== :Author: Mickaël Salaün :Date: September 2025 Landlock's goal is to create scoped acces...
Documentation/security/landlock.rst
null
null
null
null
null
source
linux
================================= Linux Security Module Development ================================= Based on https://lore.kernel.org/r/20071026073721.618b4778@laptopd505.fenrus.org, a new LSM is accepted into the kernel when its intent (a description of what it tries to protect against and in what cases one would ex...
Documentation/security/lsm-development.rst
null
null
null
null
null
source
linux
======================================================== Linux Security Modules: General Security Hooks for Linux ======================================================== :Author: Stephen Smalley :Author: Timothy Fraser :Author: Chris Vance .. note:: The APIs described in this book are outdated. Introduction ===...
Documentation/security/lsm.rst
null
null
null
null
null
source
linux
========================================= Linux Secure Attention Key (SAK) handling ========================================= :Date: 18 March 2001 :Author: Andrew Morton An operating system's Secure Attention Key is a security tool which is provided as protection against trojan password capturing programs. It is an ...
Documentation/security/sak.rst
null
null
null
null
null
source
linux
====================== Kernel Self-Protection ====================== Kernel self-protection is the design and implementation of systems and structures within the Linux kernel to protect against security flaws in the kernel itself. This covers a wide range of issues, including removing entire classes of bugs, blocking ...
Documentation/security/self-protection.rst
null
null
null
null
null
source
linux
=========================== SipHash - a short input PRF =========================== :Author: Written by Jason A. Donenfeld <jason@zx2c4.com> SipHash is a cryptographically secure PRF -- a keyed hash function -- that performs very well for short inputs, hence the name. It was designed by cryptographers Daniel J. Berns...
Documentation/security/siphash.rst
null
null
null
null
null
source
linux
====================================================== Confidential Computing in Linux for x86 virtualization ====================================================== .. contents:: :local: By: Elena Reshetova <elena.reshetova@intel.com> and Carlos Bilbao <carlos.bilbao.osdev@gmail.com> Motivation ========== Kernel de...
Documentation/security/snp-tdx-threat-model.rst
null
null
null
null
null
source
linux
============================ Kernel Key Retention Service ============================ This service allows cryptographic keys, authentication tokens, cross-domain user mappings, and similar to be cached in the kernel for the use of filesystems and other kernel services. Keyrings are permitted; these are a special typ...
Documentation/security/keys/core.rst
null
null
null
null
null
source
linux
========================================== Encrypted keys for the eCryptfs filesystem ========================================== ECryptfs is a stacked filesystem which transparently encrypts and decrypts each file using a randomly generated File Encryption Key (FEK). Each FEK is in turn encrypted with a File Encrypti...
Documentation/security/keys/ecryptfs.rst
null
null
null
null
null
source
linux
=========== Kernel Keys =========== .. toctree:: :maxdepth: 1 core ecryptfs request-key trusted-encrypted
Documentation/security/keys/index.rst
null
null
null
null
null
source
linux
=================== Key Request Service =================== The key request service is part of the key retention service (refer to Documentation/security/keys/core.rst). This document explains more fully how the requesting algorithm works. The process starts by either the kernel requesting a service by calling ``req...
Documentation/security/keys/request-key.rst
null
null
null
null
null
source
linux
========================== Trusted and Encrypted Keys ========================== Trusted and Encrypted Keys are two new key types added to the existing kernel key ring service. Both of these new types are variable length symmetric keys, and in both cases all keys are created in the kernel, and user space sees, stores...
Documentation/security/keys/trusted-encrypted.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ============================== Confidential Computing secrets ============================== This document describes how Confidential Computing secret injection is handled from the firmware to the operating system, in the EFI driver and the efi_secret kernel module. Introduction ...
Documentation/security/secrets/coco.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ===================== Secrets documentation ===================== .. toctree:: coco
Documentation/security/secrets/index.rst
null
null
null
null
null
source
linux
===================================== Trusted Platform Module documentation ===================================== .. toctree:: tpm_event_log tpm-security tpm_tis tpm_vtpm_proxy xen-tpmfront tpm_ftpm_tee tpm_ffa_crb
Documentation/security/tpm/index.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0-only TPM Security ============ The object of this document is to describe how we make the kernel's use of the TPM reasonably robust in the face of external snooping and packet alteration attacks (called passive and active interposer attack in the literature). The current security ...
Documentation/security/tpm/tpm-security.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ============= TPM Event Log ============= This document briefly describes what TPM log is and how it is handed over from the preboot firmware to the operating system. Introduction ============ The preboot firmware maintains an event log that gets new entries every time something ...
Documentation/security/tpm/tpm_event_log.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ======================== TPM CRB over FF-A Driver ======================== The TPM Command Response Buffer (CRB) interface is a standard TPM interface defined in the TCG PC Client Platform TPM Profile (PTP) Specification [1]_. The CRB provides a structured set of control registers ...
Documentation/security/tpm/tpm_ffa_crb.rst
null
null
null
null
null
source
linux
============================================= Firmware TPM Driver ============================================= This document describes the firmware Trusted Platform Module (fTPM) device driver. Introduction ============ This driver is a shim for firmware implemented in ARM's TrustZone environment. The driver allows...
Documentation/security/tpm/tpm_ftpm_tee.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ========================= TPM FIFO interface driver ========================= TCG PTP Specification defines two interface types: FIFO and CRB. The former is based on sequenced read and write operations, and the latter is based on a buffer containing the full command or response. ...
Documentation/security/tpm/tpm_tis.rst
null
null
null
null
null
source
linux
============================================= Virtual TPM Proxy Driver for Linux Containers ============================================= | Authors: | Stefan Berger <stefanb@linux.vnet.ibm.com> This document describes the virtual Trusted Platform Module (vTPM) proxy device driver for Linux containers. Introduction =...
Documentation/security/tpm/tpm_vtpm_proxy.rst
null
null
null
null
null
source
linux
============================= Virtual TPM interface for Xen ============================= Authors: Matthew Fioravante (JHUAPL), Daniel De Graaf (NSA) This document describes the virtual Trusted Platform Module (vTPM) subsystem for Xen. The reader is assumed to have familiarity with building and installing Xen, Linux,...
Documentation/security/tpm/xen-tpmfront.rst
null
null
null
null
null
source
linux
============================================================== Advanced Linux Sound Architecture - Driver Configuration guide ============================================================== Kernel Configuration ==================== To enable ALSA support you need at least to build the kernel with primary sound card s...
Documentation/sound/alsa-configuration.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ============================= Sound Subsystem Documentation ============================= .. toctree:: :maxdepth: 2 kernel-api/index designs/index soc/index alsa-configuration hd-audio/index cards/index codecs/index utimers
Documentation/sound/index.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 ======================= Userspace-driven timers ======================= :Author: Ivan Orlov <ivan.orlov0322@gmail.com> Preface ======= This document describes the userspace-driven timers: virtual ALSA timers which could be created and controlled by userspace applications using IO...
Documentation/sound/utimers.rst
null
null
null
null
null
source
linux
============================================= Sound Blaster Audigy mixer / default DSP code ============================================= This is based on sb-live-mixer.rst. The EMU10K2 chips have a DSP part which can be programmed to support various ways of sample processing, which is described here. (This article ...
Documentation/sound/cards/audigy-mixer.rst
null
null
null
null
null
source
linux
======================================================== Guide to using M-Audio Audiophile USB with ALSA and Jack ======================================================== v1.5 Thibault Le Meur <Thibault.LeMeur@supelec.fr> This document is a guide to using the M-Audio Audiophile USB (tm) device with ALSA and JACK. ...
Documentation/sound/cards/audiophile-usb.rst
null
null
null
null
null
source
linux
================= ALSA BT87x Driver ================= Intro ===== You might have noticed that the bt878 grabber cards have actually *two* PCI functions: :: $ lspci [ ... ] 00:0a.0 Multimedia video controller: Brooktree Corporation Bt878 (rev 02) 00:0a.1 Multimedia controller: Brooktree Corporation Bt878 (rev...
Documentation/sound/cards/bt87x.rst
null
null
null
null
null
source
linux
================================================= Brief Notes on C-Media 8338/8738/8768/8770 Driver ================================================= Takashi Iwai <tiwai@suse.de> Front/Rear Multi-channel Playback --------------------------------- CM8x38 chip can use ADC as the second DAC so that two different stere...
Documentation/sound/cards/cmipci.rst
null
null
null
null
null
source
linux
================================================== E-MU Digital Audio System mixer / default DSP code ================================================== This document covers the E-MU 0404/1010/1212/1616/1820 PCI/PCI-e/CardBus cards. These cards use regular EMU10K2 (SoundBlaster Audigy) chips, but with an alternative ...
Documentation/sound/cards/emu-mixer.rst
null
null
null
null
null
source
linux
================================================================= Low latency, multichannel audio with JACK and the emu10k1/emu10k2 ================================================================= This document is a guide to using the emu10k1 based devices with JACK for low latency, multichannel recording functionali...
Documentation/sound/cards/emu10k1-jack.rst
null
null
null
null
null
source
linux
======================================= Software Interface ALSA-DSP MADI Driver ======================================= (translated from German, so no good English ;-), 2004 - winfried ritsch Full functionality has been added to the driver. Since some of the Controls and startup-options are ALSA-Standard and onl...
Documentation/sound/cards/hdspm.rst
null
null
null
null
null
source
linux
================================================ Imagination Technologies SPDIF Input Controllers ================================================ The Imagination Technologies SPDIF Input controller contains the following controls: * name='IEC958 Capture Mask',index=0 This control returns a mask that shows which of ...
Documentation/sound/cards/img-spdif-in.rst
null
null
null
null
null
source
linux
Card-Specific Information ========================= .. toctree:: :maxdepth: 2 joystick cmipci sb-live-mixer audigy-mixer emu-mixer emu10k1-jack via82xx-mixer audiophile-usb mixart bt87x maya44 hdspm serial-u16550 img-spdif-in pcmtest
Documentation/sound/cards/index.rst
null
null
null
null
null
source
linux
======================================= Analog Joystick Support on ALSA Drivers ======================================= Oct. 14, 2003 Takashi Iwai <tiwai@suse.de> General ------- First of all, you need to enable GAMEPORT support on Linux kernel for using a joystick with the ALSA driver. For the details of gameport...
Documentation/sound/cards/joystick.rst
null
null
null
null
null
source
linux
================================= Notes on Maya44 USB Audio Support ================================= .. note:: The following is the original document of Rainer's patch that the current maya44 code based on. Some contents might be obsoleted, but I keep here as reference -- tiwai Feb 14, 2008 Rainer Zimmerm...
Documentation/sound/cards/maya44.rst
null
null
null
null
null
source
linux
============================================================== Alsa driver for Digigram miXart8 and miXart8AES/EBU soundcards ============================================================== Digigram <alsa@digigram.com> GENERAL ======= The miXart8 is a multichannel audio processing and mixing soundcard that has 4 ste...
Documentation/sound/cards/mixart.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 The Virtual PCM Test Driver =========================== The Virtual PCM Test Driver emulates a generic PCM device, and can be used for testing/fuzzing of the userspace ALSA applications, as well as for testing/fuzzing of the PCM middle layer. Additionally, it can be used for simula...
Documentation/sound/cards/pcmtest.rst
null
null
null
null
null
source
linux
=========================================== Sound Blaster Live mixer / default DSP code =========================================== The EMU10K1 chips have a DSP part which can be programmed to support various ways of sample processing, which is described here. (This article does not deal with the overall functionalit...
Documentation/sound/cards/sb-live-mixer.rst
null
null
null
null
null
source
linux
=================================== Serial UART 16450/16550 MIDI driver =================================== The adaptor module parameter allows you to select either: * 0 - Roland Soundcanvas support (default) * 1 - Midiator MS-124T support (1) * 2 - Midiator MS-124W S/A mode (2) * 3 - MS-124W M/B mode support (3) * 4...
Documentation/sound/cards/serial-u16550.rst
null
null
null
null
null
source
linux
============= VIA82xx mixer ============= On many VIA82xx boards, the ``Input Source Select`` mixer control does not work. Setting it to ``Input2`` on such boards will cause recording to hang, or fail with EIO (input/output error) via OSS emulation. This control should be left at ``Input1`` for such cards.
Documentation/sound/cards/via82xx-mixer.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0-only ======================================================================== Audio drivers for Cirrus Logic CS35L54/56/57/63 Boosted Smart Amplifiers ======================================================================== :Copyright: 2025 Cirrus Logic, Inc. and Ci...
Documentation/sound/codecs/cs35l56.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: GPL-2.0 Codec-Specific Information ========================== .. toctree:: :maxdepth: 2 cs35l56
Documentation/sound/codecs/index.rst
null
null
null
null
null
source
linux
============================ ALSA PCM channel-mapping API ============================ Takashi Iwai <tiwai@suse.de> General ======= The channel mapping API allows user to query the possible channel maps and the current channel map, also optionally to modify the channel map of the current stream. A channel map is an...
Documentation/sound/designs/channel-mapping-api.rst
null
null
null
null
null
source
linux
================================== ALSA Co-processor Acceleration API ================================== Jaroslav Kysela <perex@perex.cz> Overview ======== There is a requirement to expose the audio hardware that accelerates various tasks for user space such as sample rate converters, compressed stream decoders, et...
Documentation/sound/designs/compress-accel.rst
null
null
null
null
null
source
linux
========================= ALSA Compress-Offload API ========================= Pierre-Louis.Bossart <pierre-louis.bossart@linux.intel.com> Vinod Koul <vinod.koul@linux.intel.com> Overview ======== Since its early days, the ALSA API was defined with PCM support or constant bitrates payloads such as IEC61937 in mind. ...
Documentation/sound/designs/compress-offload.rst
null
null
null
null
null
source
linux
=========================== Standard ALSA Control Names =========================== This document describes standard names of mixer controls. Standard Syntax --------------- Syntax: [LOCATION] SOURCE [CHANNEL] [DIRECTION] FUNCTION DIRECTION ~~~~~~~~~ ================ =============== <nothing> both directions Playb...
Documentation/sound/designs/control-names.rst
null
null
null
null
null
source
linux
Designs and Implementations =========================== .. toctree:: :maxdepth: 2 control-names channel-mapping-api compress-accel compress-offload timestamping jack-controls tracepoints procfile powersave oss-emulation seq-oss jack-injection midi-2.0
Documentation/sound/designs/index.rst
null
null
null
null
null
source
linux
================== ALSA Jack Controls ================== Why we need Jack kcontrols ========================== ALSA uses kcontrols to export audio controls(switch, volume, Mux, ...) to user space. This means userspace applications like pulseaudio can switch off headphones and switch on speakers when no headphones are...
Documentation/sound/designs/jack-controls.rst
null
null
null
null
null
source
linux
============================ ALSA Jack Software Injection ============================ Simple Introduction On Jack Injection ===================================== Here jack injection means users could inject plugin or plugout events to the audio jacks through debugfs interface, it is helpful to validate ALSA userspac...
Documentation/sound/designs/jack-injection.rst
null
null
null
null
null
source
linux
================= MIDI 2.0 on Linux ================= General ======= MIDI 2.0 is an extended protocol for providing higher resolutions and more fine controls over the legacy MIDI 1.0. The fundamental changes introduced for supporting MIDI 2.0 are: - Support of Universal MIDI Packet (UMP) - Support of MIDI 2.0 prot...
Documentation/sound/designs/midi-2.0.rst
null
null
null
null
null
source
linux
============================= Notes on Kernel OSS-Emulation ============================= Jan. 22, 2004 Takashi Iwai <tiwai@suse.de> Modules ======= ALSA provides a powerful OSS emulation on the kernel. The OSS emulation for PCM, mixer and sequencer devices is implemented as add-on kernel modules, snd-pcm-oss, snd...
Documentation/sound/designs/oss-emulation.rst
null
null
null
null
null
source
linux
========================== Notes on Power-Saving Mode ========================== AC97 and HD-audio drivers have the automatic power-saving mode. This feature is enabled via Kconfig ``CONFIG_SND_AC97_POWER_SAVE`` and ``CONFIG_SND_HDA_POWER_SAVE`` options, respectively. With the automatic power-saving, the driver turns...
Documentation/sound/designs/powersave.rst
null
null
null
null
null
source
linux
========================== Proc Files of ALSA Drivers ========================== Takashi Iwai <tiwai@suse.de> General ======= ALSA has its own proc tree, /proc/asound. Many useful information are found in this tree. When you encounter a problem and need debugging, check the files listed in the following sections. ...
Documentation/sound/designs/procfile.rst
null
null
null
null
null
source
linux
=============================== OSS Sequencer Emulation on ALSA =============================== Copyright (c) 1998,1999 by Takashi Iwai ver.0.1.8; Nov. 16, 1999 Description =========== This directory contains the OSS sequencer emulation driver on ALSA. Note that this program is still in the development state. What...
Documentation/sound/designs/seq-oss.rst
null
null
null
null
null
source
linux
===================== ALSA PCM Timestamping ===================== The ALSA API can provide two different system timestamps: - Trigger_tstamp is the system time snapshot taken when the .trigger callback is invoked. This snapshot is taken by the ALSA core in the general case, but specific hardware may have synchron...
Documentation/sound/designs/timestamping.rst
null
null
null
null
null
source
linux
=================== Tracepoints in ALSA =================== 2017/07/02 Takasahi Sakamoto Tracepoints in ALSA PCM core ============================ ALSA PCM core registers ``snd_pcm`` subsystem to kernel tracepoint system. This subsystem includes two categories of tracepoints; for state of PCM buffer and for processi...
Documentation/sound/designs/tracepoints.rst
null
null
null
null
null
source
linux
====================================== HD-Audio Codec-Specific Mixer Controls ====================================== This file explains the codec-specific mixer controls. Realtek codecs -------------- Channel Mode This is an enum control to change the surround-channel setup, appears only when the surround chann...
Documentation/sound/hd-audio/controls.rst
null
null
null
null
null
source
linux
======================= HD-Audio DP-MST Support ======================= To support DP MST audio, HD Audio hdmi codec driver introduces virtual pin and dynamic pcm assignment. Virtual pin is an extension of per_pin. The most difference of DP MST from legacy is that DP MST introduces device entry. Each pin can contain ...
Documentation/sound/hd-audio/dp-mst.rst
null
null
null
null
null
source
linux
HD-Audio ======== .. toctree:: :maxdepth: 2 notes models controls dp-mst realtek-pc-beep intel-multi-link
Documentation/sound/hd-audio/index.rst
null
null
null
null
null
source
linux
.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) .. include:: <isonum.txt> ================================================ HDAudio multi-link extensions on Intel platforms ================================================ :Copyright: |copy| 2023 Intel Corporation This file documents the 'multi-link structu...
Documentation/sound/hd-audio/intel-multi-link.rst
null
null
null
null
null