2005-04-17 06:20:36 +08:00
|
|
|
|
|
|
|
|
This is a brief list of all the files in ./linux/Documentation and what
|
|
|
|
|
they contain. If you add a documentation file, please list it here in
|
|
|
|
|
alphabetical order as well, or risk being hunted down like a rabid dog.
|
2013-02-15 04:20:54 +08:00
|
|
|
Please keep the descriptions small enough to fit on one line.
|
2005-04-17 06:20:36 +08:00
|
|
|
Thanks -- Paul G.
|
|
|
|
|
|
|
|
|
|
Following translations are available on the WWW:
|
|
|
|
|
|
2012-02-14 22:19:07 +08:00
|
|
|
- Japanese, maintained by the JF Project (jf@listserv.linux.or.jp), at
|
|
|
|
|
http://linuxjf.sourceforge.jp/
|
2005-04-17 06:20:36 +08:00
|
|
|
|
|
|
|
|
00-INDEX
|
|
|
|
|
- this file.
|
2007-07-16 14:41:41 +08:00
|
|
|
ABI/
|
|
|
|
|
- info on kernel <-> userspace ABI and relative interface stability.
|
2007-11-15 08:53:21 +08:00
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
BUG-HUNTING
|
|
|
|
|
- brute force method of doing binary search of patches to find bug.
|
|
|
|
|
Changes
|
|
|
|
|
- list of changes that break older software packages.
|
|
|
|
|
CodingStyle
|
2013-02-15 04:20:54 +08:00
|
|
|
- how the maintainers expect the C code in the kernel to look.
|
2005-04-17 06:20:36 +08:00
|
|
|
DMA-API.txt
|
|
|
|
|
- DMA API, pci_ API & extensions for non-consistent memory machines.
|
2013-02-15 04:20:54 +08:00
|
|
|
DMA-API-HOWTO.txt
|
|
|
|
|
- Dynamic DMA mapping Guide
|
2007-10-17 14:31:25 +08:00
|
|
|
DMA-ISA-LPC.txt
|
|
|
|
|
- How to do DMA with ISA (and LPC) devices.
|
2013-02-15 04:20:54 +08:00
|
|
|
DMA-attributes.txt
|
|
|
|
|
- listing of the various possible attributes a DMA region can have
|
2005-04-17 06:20:36 +08:00
|
|
|
DocBook/
|
|
|
|
|
- directory with DocBook templates etc. for kernel documentation.
|
2013-02-15 04:20:54 +08:00
|
|
|
EDID/
|
|
|
|
|
- directory with info on customizing EDID for broken gfx/displays.
|
[PATCH] Add HOWTO do kernel development document to the Documentation directory
Here's a document that describes the process and procedures of how to do Linux
kernel development. It has gone through a number of rounds of review on the
linux-kernel mailing list, and contains contributions and help from Paolo
Ciarrocchi, Randy Dunlap, Gerrit Huizenga, Pat Mochel, Hanna Linder, Kay
Sievers, Vojtech Pavlik, Jan Kara, Josh Boyer, Kees Cook, Andrew Morton, Andi
Kleen, Vadim Lobanov, Jesper Juhl, Adrian Bunk, Keri Harris, Frans Pop, David
A. Wheeler, Junio Hamano, Michael Kerrisk, and Alex Shepard.
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2005-11-19 01:31:11 +08:00
|
|
|
HOWTO
|
2007-07-16 14:41:41 +08:00
|
|
|
- the process and procedures of how to do Linux kernel development.
|
2005-04-17 06:20:36 +08:00
|
|
|
IPMI.txt
|
|
|
|
|
- info on Linux Intelligent Platform Management Interface (IPMI) Driver.
|
|
|
|
|
IRQ-affinity.txt
|
|
|
|
|
- how to select which CPU(s) handle which interrupt events on SMP.
|
2013-02-15 04:20:54 +08:00
|
|
|
IRQ-domain.txt
|
2013-08-21 07:48:39 +08:00
|
|
|
- info on interrupt numbering and setting up IRQ domains.
|
2007-07-16 14:41:41 +08:00
|
|
|
IRQ.txt
|
|
|
|
|
- description of what an IRQ is.
|
2013-02-15 04:20:54 +08:00
|
|
|
Intel-IOMMU.txt
|
|
|
|
|
- basic info on the Intel IOMMU virtualization support.
|
|
|
|
|
Makefile
|
|
|
|
|
- some files in Documentation dir are actually sample code to build
|
2005-04-17 06:20:36 +08:00
|
|
|
ManagementStyle
|
|
|
|
|
- how to (attempt to) manage kernel hackers.
|
|
|
|
|
RCU/
|
|
|
|
|
- directory with info on RCU (read-copy update).
|
|
|
|
|
SAK.txt
|
|
|
|
|
- info on Secure Attention Keys.
|
2007-10-17 14:31:25 +08:00
|
|
|
SM501.txt
|
|
|
|
|
- Silicon Motion SM501 multimedia companion chip
|
2007-07-16 14:41:41 +08:00
|
|
|
SecurityBugs
|
|
|
|
|
- procedure for reporting security bugs found in the kernel.
|
|
|
|
|
SubmitChecklist
|
|
|
|
|
- Linux kernel patch submission checklist.
|
2005-04-17 06:20:36 +08:00
|
|
|
SubmittingDrivers
|
|
|
|
|
- procedure to get a new driver source included into the kernel tree.
|
|
|
|
|
SubmittingPatches
|
|
|
|
|
- procedure to get a source patch included into the kernel tree.
|
|
|
|
|
VGA-softcursor.txt
|
|
|
|
|
- how to change your VGA cursor from a blinking underscore.
|
2007-07-16 14:41:41 +08:00
|
|
|
accounting/
|
|
|
|
|
- documentation on accounting and taskstats.
|
2007-11-15 08:53:21 +08:00
|
|
|
acpi/
|
|
|
|
|
- info on ACPI-specific hooks in the kernel.
|
2007-07-16 14:41:41 +08:00
|
|
|
aoe/
|
|
|
|
|
- description of AoE (ATA over Ethernet) along with config examples.
|
2005-09-10 04:10:12 +08:00
|
|
|
applying-patches.txt
|
|
|
|
|
- description of various trees and how to apply their patches.
|
2005-04-17 06:20:36 +08:00
|
|
|
arm/
|
|
|
|
|
- directory with info about Linux on the ARM architecture.
|
2013-02-15 04:20:54 +08:00
|
|
|
arm64/
|
|
|
|
|
- directory with info about Linux on the 64 bit ARM architecture.
|
2014-02-11 06:25:33 +08:00
|
|
|
assoc_array.txt
|
|
|
|
|
- generic associative array intro.
|
2007-07-16 14:41:41 +08:00
|
|
|
atomic_ops.txt
|
|
|
|
|
- semantics and behavior of atomic and bitmask operations.
|
|
|
|
|
auxdisplay/
|
|
|
|
|
- misc. LCD driver documentation (cfag12864b, ks0108).
|
2013-02-15 04:20:54 +08:00
|
|
|
backlight/
|
|
|
|
|
- directory with info on controlling backlights in flat panel displays
|
|
|
|
|
bad_memory.txt
|
|
|
|
|
- how to use kernel parameters to exclude bad RAM regions.
|
2005-04-17 06:20:36 +08:00
|
|
|
basic_profiling.txt
|
|
|
|
|
- basic instructions for those who wants to profile Linux kernel.
|
2014-02-11 06:25:33 +08:00
|
|
|
bcache.txt
|
|
|
|
|
- Block-layer cache on fast SSDs to improve slow (raid) I/O performance.
|
2005-04-17 06:20:36 +08:00
|
|
|
binfmt_misc.txt
|
|
|
|
|
- info on the kernel support for extra binary formats.
|
2007-07-16 14:41:41 +08:00
|
|
|
blackfin/
|
|
|
|
|
- directory with documentation for the Blackfin arch.
|
2005-04-17 06:20:36 +08:00
|
|
|
block/
|
|
|
|
|
- info on the Block I/O (BIO) layer.
|
2008-11-14 05:33:24 +08:00
|
|
|
blockdev/
|
|
|
|
|
- info on block devices & drivers
|
2013-02-15 04:20:54 +08:00
|
|
|
braille-console.txt
|
|
|
|
|
- info on how to use serial devices for Braille support.
|
|
|
|
|
bt8xxgpio.txt
|
|
|
|
|
- info on how to modify a bt8xx video card for GPIO usage.
|
2009-06-03 05:29:38 +08:00
|
|
|
btmrvl.txt
|
|
|
|
|
- info on Marvell Bluetooth driver usage.
|
2013-02-15 04:20:54 +08:00
|
|
|
bus-devices/
|
|
|
|
|
- directory with info on TI GPMC (General Purpose Memory Controller)
|
2010-07-20 06:20:27 +08:00
|
|
|
bus-virt-phys-mapping.txt
|
|
|
|
|
- how to access I/O mapped memory from within device drivers.
|
2005-04-17 06:20:36 +08:00
|
|
|
cachetlb.txt
|
|
|
|
|
- describes the cache/TLB flushing interfaces Linux uses.
|
|
|
|
|
cdrom/
|
|
|
|
|
- directory with information on the CD-ROM drivers that Linux has.
|
2009-02-04 17:12:08 +08:00
|
|
|
cgroups/
|
|
|
|
|
- cgroups features, including cpusets and memory controller.
|
2013-02-15 04:20:54 +08:00
|
|
|
circular-buffers.txt
|
|
|
|
|
- how to make use of the existing circular buffer infrastructure
|
|
|
|
|
clk.txt
|
|
|
|
|
- info on the common clock framework
|
|
|
|
|
coccinelle.txt
|
|
|
|
|
- info on how to get and use the Coccinelle code checking tool.
|
2007-07-16 14:41:41 +08:00
|
|
|
connector/
|
|
|
|
|
- docs on the netlink based userspace<->kernel space communication mod.
|
|
|
|
|
console/
|
|
|
|
|
- documentation on Linux console drivers.
|
2005-04-17 06:20:36 +08:00
|
|
|
cpu-freq/
|
|
|
|
|
- info on CPU frequency and voltage scaling.
|
2007-07-16 14:41:41 +08:00
|
|
|
cpu-hotplug.txt
|
|
|
|
|
- document describing CPU hotplug support in the Linux kernel.
|
|
|
|
|
cpu-load.txt
|
|
|
|
|
- document describing how CPU load statistics are collected.
|
2008-02-14 13:16:13 +08:00
|
|
|
cpuidle/
|
|
|
|
|
- info on CPU_IDLE, CPU idle state management subsystem.
|
2007-07-16 14:41:41 +08:00
|
|
|
cputopology.txt
|
|
|
|
|
- documentation on how CPU topology info is exported via sysfs.
|
2012-03-24 06:02:22 +08:00
|
|
|
crc32.txt
|
|
|
|
|
- brief tutorial on CRC computation
|
2005-04-17 06:20:36 +08:00
|
|
|
cris/
|
|
|
|
|
- directory with info about Linux on CRIS architecture.
|
|
|
|
|
crypto/
|
|
|
|
|
- directory with info on the Crypto API.
|
2007-07-16 14:41:41 +08:00
|
|
|
dcdbas.txt
|
|
|
|
|
- information on the Dell Systems Management Base Driver.
|
2005-04-17 06:20:36 +08:00
|
|
|
debugging-modules.txt
|
|
|
|
|
- some notes on debugging modules after Linux 2.6.3.
|
2013-02-15 04:20:54 +08:00
|
|
|
debugging-via-ohci1394.txt
|
|
|
|
|
- how to use firewire like a hardware debugger memory reader.
|
2007-07-16 14:41:41 +08:00
|
|
|
dell_rbu.txt
|
|
|
|
|
- document demonstrating the use of the Dell Remote BIOS Update driver.
|
2013-02-15 04:20:54 +08:00
|
|
|
development-process/
|
|
|
|
|
- how to work with the mainline kernel development process.
|
2005-04-17 06:20:36 +08:00
|
|
|
device-mapper/
|
|
|
|
|
- directory with info on Device Mapper.
|
|
|
|
|
devices.txt
|
|
|
|
|
- plain ASCII listing of all the nodes in /dev/ with major minor #'s.
|
2013-02-15 04:20:54 +08:00
|
|
|
devicetree/
|
|
|
|
|
- directory with info on device tree files used by OF/PowerPC/ARM
|
|
|
|
|
digsig.txt
|
|
|
|
|
-info on the Digital Signature Verification API
|
|
|
|
|
dma-buf-sharing.txt
|
|
|
|
|
- the DMA Buffer Sharing API Guide
|
2007-07-16 14:41:41 +08:00
|
|
|
dontdiff
|
|
|
|
|
- file containing a list of files that should never be diff'ed.
|
2005-04-17 06:20:36 +08:00
|
|
|
driver-model/
|
|
|
|
|
- directory with info about Linux driver model.
|
|
|
|
|
dvb/
|
|
|
|
|
- info on Linux Digital Video Broadcast (DVB) subsystem.
|
2013-02-15 04:20:54 +08:00
|
|
|
dynamic-debug-howto.txt
|
|
|
|
|
- how to use the dynamic debug (dyndbg) feature.
|
2005-04-17 06:20:36 +08:00
|
|
|
early-userspace/
|
|
|
|
|
- info about initramfs, klibc, and userspace early during boot.
|
2008-02-07 16:13:33 +08:00
|
|
|
edac.txt
|
|
|
|
|
- information on EDAC - Error Detection And Correction
|
2014-02-11 06:25:33 +08:00
|
|
|
efi-stub.txt
|
|
|
|
|
- How to use the EFI boot stub to bypass GRUB or elilo on EFI systems.
|
2005-04-17 06:20:36 +08:00
|
|
|
eisa.txt
|
|
|
|
|
- info on EISA bus support.
|
2013-02-15 04:20:54 +08:00
|
|
|
email-clients.txt
|
|
|
|
|
- info on how to use e-mail to send un-mangled (git) patches.
|
|
|
|
|
extcon/
|
|
|
|
|
- directory with porting guide for Android kernel switch driver.
|
2007-07-16 14:41:41 +08:00
|
|
|
fault-injection/
|
|
|
|
|
- dir with docs about the fault injection capabilities infrastructure.
|
2005-04-17 06:20:36 +08:00
|
|
|
fb/
|
|
|
|
|
- directory with info on the frame buffer graphics abstraction layer.
|
|
|
|
|
filesystems/
|
2007-09-25 06:52:09 +08:00
|
|
|
- info on the vfs and the various filesystems that Linux supports.
|
2005-04-17 06:20:36 +08:00
|
|
|
firmware_class/
|
|
|
|
|
- request_firmware() hotplug interface info.
|
2013-02-15 04:20:54 +08:00
|
|
|
flexible-arrays.txt
|
|
|
|
|
- how to make use of flexible sized arrays in linux
|
2013-06-19 05:47:24 +08:00
|
|
|
fmc/
|
|
|
|
|
- information about the FMC bus abstraction
|
2008-02-03 21:54:28 +08:00
|
|
|
frv/
|
2007-07-16 14:41:41 +08:00
|
|
|
- Fujitsu FR-V Linux documentation.
|
2013-02-15 04:20:54 +08:00
|
|
|
futex-requeue-pi.txt
|
|
|
|
|
- info on requeueing of tasks from a non-PI futex to a PI futex
|
|
|
|
|
gcov.txt
|
|
|
|
|
- use of GCC's coverage testing tool "gcov" with the Linux kernel
|
2014-02-11 06:25:33 +08:00
|
|
|
gpio/
|
|
|
|
|
- gpio related documentation
|
2013-02-15 04:20:54 +08:00
|
|
|
hid/
|
|
|
|
|
- directory with information on human interface devices
|
2005-04-17 06:20:36 +08:00
|
|
|
highuid.txt
|
|
|
|
|
- notes on the change from 16 bit to 32 bit user/group IDs.
|
2014-12-26 16:26:22 +08:00
|
|
|
hsi.txt
|
|
|
|
|
- HSI subsystem overview.
|
2013-02-15 04:20:54 +08:00
|
|
|
hwspinlock.txt
|
|
|
|
|
- hardware spinlock provides hardware assistance for synchronization
|
2008-03-06 01:28:15 +08:00
|
|
|
timers/
|
|
|
|
|
- info on the timer related topics
|
2005-04-17 06:20:36 +08:00
|
|
|
hw_random.txt
|
|
|
|
|
- info on Linux support for random number generator in i8xx chipsets.
|
2007-07-16 14:41:41 +08:00
|
|
|
hwmon/
|
|
|
|
|
- directory with docs on various hardware monitoring drivers.
|
2005-04-17 06:20:36 +08:00
|
|
|
i2c/
|
|
|
|
|
- directory with info about the I2C bus/protocol (2 wire, kHz speed).
|
|
|
|
|
i2o/
|
|
|
|
|
- directory with info about the Linux I2O subsystem.
|
2008-10-21 00:32:21 +08:00
|
|
|
x86/i386/
|
2005-04-17 06:20:36 +08:00
|
|
|
- directory with info about Linux on Intel 32 bit architecture.
|
|
|
|
|
ia64/
|
|
|
|
|
- directory with info about Linux on Intel 64 bit architecture.
|
2007-07-16 14:41:41 +08:00
|
|
|
infiniband/
|
|
|
|
|
- directory with documents concerning Linux InfiniBand support.
|
2013-02-15 04:20:54 +08:00
|
|
|
init.txt
|
|
|
|
|
- what to do when the kernel can't find the 1st process to run.
|
2005-04-17 06:20:36 +08:00
|
|
|
initrd.txt
|
|
|
|
|
- how to use the RAM disk as an initial/temporary root filesystem.
|
|
|
|
|
input/
|
|
|
|
|
- info on Linux input device support.
|
2013-02-15 04:20:54 +08:00
|
|
|
intel_txt.txt
|
|
|
|
|
- info on intel Trusted Execution Technology (intel TXT).
|
2010-07-20 06:20:27 +08:00
|
|
|
io-mapping.txt
|
|
|
|
|
- description of io_mapping functions in linux/io-mapping.h
|
2005-04-17 06:20:36 +08:00
|
|
|
io_ordering.txt
|
|
|
|
|
- info on ordering I/O writes to memory-mapped addresses.
|
2007-07-16 14:41:41 +08:00
|
|
|
ioctl/
|
|
|
|
|
- directory with documents describing various IOCTL calls.
|
2005-04-17 06:20:36 +08:00
|
|
|
iostats.txt
|
|
|
|
|
- info on I/O statistics Linux kernel provides.
|
2007-07-16 14:41:41 +08:00
|
|
|
irqflags-tracing.txt
|
|
|
|
|
- how to use the irq-flags tracing feature.
|
2005-04-17 06:20:36 +08:00
|
|
|
isapnp.txt
|
|
|
|
|
- info on Linux ISA Plug & Play support.
|
|
|
|
|
isdn/
|
|
|
|
|
- directory with info on the Linux ISDN support, and supported cards.
|
|
|
|
|
java.txt
|
|
|
|
|
- info on the in-kernel binary support for Java(tm).
|
2013-02-15 04:20:54 +08:00
|
|
|
ja_JP/
|
|
|
|
|
- directory with Japanese translations of various documents
|
2005-04-17 06:20:36 +08:00
|
|
|
kbuild/
|
|
|
|
|
- directory with info about the kernel build process.
|
2007-07-16 14:41:41 +08:00
|
|
|
kdump/
|
|
|
|
|
- directory with mini HowTo on getting the crash dump code to work.
|
2005-04-17 06:20:36 +08:00
|
|
|
kernel-doc-nano-HOWTO.txt
|
|
|
|
|
- mini HowTo on generation and location of kernel documentation files.
|
|
|
|
|
kernel-docs.txt
|
|
|
|
|
- listing of various WWW + books that document kernel internals.
|
|
|
|
|
kernel-parameters.txt
|
|
|
|
|
- summary listing of command line / boot prompt args for the kernel.
|
2014-02-11 06:25:33 +08:00
|
|
|
kernel-per-CPU-kthreads.txt
|
|
|
|
|
- List of all per-CPU kthreads and how they introduce jitter.
|
2013-02-15 04:20:54 +08:00
|
|
|
kmemcheck.txt
|
|
|
|
|
- info on dynamic checker that detects uses of uninitialized memory.
|
|
|
|
|
kmemleak.txt
|
|
|
|
|
- info on how to make use of the kernel memory leak detection system
|
|
|
|
|
ko_KR/
|
|
|
|
|
- directory with Korean translations of various documents
|
2005-04-17 06:20:36 +08:00
|
|
|
kobject.txt
|
|
|
|
|
- info of the kobject infrastructure of the Linux kernel.
|
2007-07-16 14:41:41 +08:00
|
|
|
kprobes.txt
|
|
|
|
|
- documents the kernel probes debugging feature.
|
|
|
|
|
kref.txt
|
|
|
|
|
- docs on adding reference counters (krefs) to kernel objects.
|
2014-12-26 16:26:22 +08:00
|
|
|
kselftest.txt
|
|
|
|
|
- small unittests for (some) individual codepaths in the kernel.
|
2008-02-09 09:32:03 +08:00
|
|
|
laptops/
|
|
|
|
|
- directory with laptop related info and laptop driver documentation.
|
2005-04-17 06:20:36 +08:00
|
|
|
ldm.txt
|
|
|
|
|
- a brief description of LDM (Windows Dynamic Disks).
|
2011-04-05 06:08:46 +08:00
|
|
|
leds/
|
|
|
|
|
- directory with info about LED handling under Linux.
|
2007-07-16 14:41:41 +08:00
|
|
|
local_ops.txt
|
|
|
|
|
- semantics and behavior of local atomic operations.
|
2014-07-31 04:41:55 +08:00
|
|
|
locking/
|
|
|
|
|
- directory with info about kernel locking primitives
|
2012-10-21 18:05:51 +08:00
|
|
|
lockup-watchdogs.txt
|
|
|
|
|
- info on soft and hard lockup detectors (aka nmi_watchdog).
|
2005-04-17 06:20:36 +08:00
|
|
|
logo.gif
|
2007-07-16 14:41:41 +08:00
|
|
|
- full colour GIF image of Linux logo (penguin - Tux).
|
2005-04-17 06:20:36 +08:00
|
|
|
logo.txt
|
2007-07-16 14:41:41 +08:00
|
|
|
- info on creator of above logo & site to get additional images from.
|
2014-12-26 16:26:22 +08:00
|
|
|
lzo.txt
|
|
|
|
|
- kernel LZO decompressor input formats
|
2005-04-17 06:20:36 +08:00
|
|
|
m68k/
|
|
|
|
|
- directory with info about Linux on Motorola 68k architecture.
|
|
|
|
|
magic-number.txt
|
|
|
|
|
- list of magic numbers used to mark/protect kernel data structures.
|
2014-12-26 16:26:22 +08:00
|
|
|
mailbox.txt
|
|
|
|
|
- How to write drivers for the common mailbox framework (IPC).
|
2005-04-17 06:20:36 +08:00
|
|
|
md.txt
|
|
|
|
|
- info on boot arguments for the multiple devices driver.
|
2013-02-15 04:20:54 +08:00
|
|
|
media-framework.txt
|
|
|
|
|
- info on media framework, its data structures, functions and usage.
|
2007-07-16 14:41:41 +08:00
|
|
|
memory-barriers.txt
|
|
|
|
|
- info on Linux kernel memory barriers.
|
2013-02-15 04:20:54 +08:00
|
|
|
memory-devices/
|
|
|
|
|
- directory with info on parts like the Texas Instruments EMIF driver
|
2007-10-17 14:31:25 +08:00
|
|
|
memory-hotplug.txt
|
|
|
|
|
- Hotpluggable memory support, how to use and current status.
|
2012-10-09 18:00:27 +08:00
|
|
|
metag/
|
|
|
|
|
- directory with info about Linux on Meta architecture.
|
2005-04-17 06:20:36 +08:00
|
|
|
mips/
|
|
|
|
|
- directory with info about Linux on MIPS architecture.
|
2013-02-15 04:20:54 +08:00
|
|
|
misc-devices/
|
|
|
|
|
- directory with info about devices using the misc dev subsystem
|
mmc: add erase, secure erase, trim and secure trim operations
SD/MMC cards tend to support an erase operation. In addition, eMMC v4.4
cards can support secure erase, trim and secure trim operations that are
all variants of the basic erase command.
SD/MMC device attributes "erase_size" and "preferred_erase_size" have been
added.
"erase_size" is the minimum size, in bytes, of an erase operation. For
MMC, "erase_size" is the erase group size reported by the card. Note that
"erase_size" does not apply to trim or secure trim operations where the
minimum size is always one 512 byte sector. For SD, "erase_size" is 512
if the card is block-addressed, 0 otherwise.
SD/MMC cards can erase an arbitrarily large area up to and
including the whole card. When erasing a large area it may
be desirable to do it in smaller chunks for three reasons:
1. A single erase command will make all other I/O on the card
wait. This is not a problem if the whole card is being erased, but
erasing one partition will make I/O for another partition on the
same card wait for the duration of the erase - which could be a
several minutes.
2. To be able to inform the user of erase progress.
3. The erase timeout becomes too large to be very useful.
Because the erase timeout contains a margin which is multiplied by
the size of the erase area, the value can end up being several
minutes for large areas.
"erase_size" is not the most efficient unit to erase (especially for SD
where it is just one sector), hence "preferred_erase_size" provides a good
chunk size for erasing large areas.
For MMC, "preferred_erase_size" is the high-capacity erase size if a card
specifies one, otherwise it is based on the capacity of the card.
For SD, "preferred_erase_size" is the allocation unit size specified by
the card.
"preferred_erase_size" is in bytes.
Signed-off-by: Adrian Hunter <adrian.hunter@nokia.com>
Acked-by: Jens Axboe <axboe@kernel.dk>
Cc: Kyungmin Park <kmpark@infradead.org>
Cc: Madhusudhan Chikkature <madhu.cr@ti.com>
Cc: Christoph Hellwig <hch@lst.de>
Cc: Ben Gardiner <bengardiner@nanometrics.ca>
Cc: <linux-mmc@vger.kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2010-08-12 05:17:46 +08:00
|
|
|
mmc/
|
|
|
|
|
- directory with info about the MMC subsystem
|
2013-02-15 04:20:54 +08:00
|
|
|
mn10300/
|
|
|
|
|
- directory with info about the mn10300 architecture port
|
2014-02-11 06:25:33 +08:00
|
|
|
module-signing.txt
|
|
|
|
|
- Kernel module signing for increased security when loading modules.
|
2013-02-15 04:20:54 +08:00
|
|
|
mtd/
|
|
|
|
|
- directory with info about memory technology devices (flash)
|
2005-04-17 06:20:36 +08:00
|
|
|
mono.txt
|
|
|
|
|
- how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
|
2007-11-29 08:21:39 +08:00
|
|
|
namespaces/
|
|
|
|
|
- directory with various information about namespaces
|
2006-08-04 07:45:49 +08:00
|
|
|
netlabel/
|
|
|
|
|
- directory with information on the NetLabel subsystem.
|
2005-04-17 06:20:36 +08:00
|
|
|
networking/
|
|
|
|
|
- directory with info on various aspects of networking with Linux.
|
2013-02-15 04:20:54 +08:00
|
|
|
nfc/
|
|
|
|
|
- directory relating info about Near Field Communications support.
|
2007-07-16 14:41:41 +08:00
|
|
|
nommu-mmap.txt
|
|
|
|
|
- documentation about no-mmu memory mapping support.
|
2005-04-17 06:20:36 +08:00
|
|
|
numastat.txt
|
|
|
|
|
- info on how to read Numa policy hit/miss statistics in sysfs.
|
|
|
|
|
oops-tracing.txt
|
|
|
|
|
- how to decode those nasty internal kernel error dump messages.
|
2010-05-13 04:23:48 +08:00
|
|
|
padata.txt
|
|
|
|
|
- An introduction to the "padata" parallel execution API
|
2005-04-17 06:20:36 +08:00
|
|
|
parisc/
|
|
|
|
|
- directory with info on using Linux on PA-RISC architecture.
|
|
|
|
|
parport.txt
|
|
|
|
|
- how to use the parallel-port driver.
|
|
|
|
|
parport-lowlevel.txt
|
|
|
|
|
- description and usage of the low level parallel port functions.
|
2007-07-16 14:41:41 +08:00
|
|
|
pcmcia/
|
|
|
|
|
- info on the Linux PCMCIA driver.
|
2013-02-15 04:20:54 +08:00
|
|
|
percpu-rw-semaphore.txt
|
|
|
|
|
- RCU based read-write semaphore optimized for locking for reading
|
2014-02-11 06:25:33 +08:00
|
|
|
phy.txt
|
|
|
|
|
- Description of the generic PHY framework.
|
2007-07-16 14:41:41 +08:00
|
|
|
pi-futex.txt
|
2013-02-15 04:20:54 +08:00
|
|
|
- documentation on lightweight priority inheritance futexes.
|
|
|
|
|
pinctrl.txt
|
|
|
|
|
- info on pinctrl subsystem and the PINMUX/PINCONF and drivers
|
2005-04-17 06:20:36 +08:00
|
|
|
pnp.txt
|
|
|
|
|
- Linux Plug and Play documentation.
|
|
|
|
|
power/
|
|
|
|
|
- directory with info on Linux PCI power management.
|
|
|
|
|
powerpc/
|
|
|
|
|
- directory with info on using Linux with the PowerPC.
|
2013-02-15 04:20:54 +08:00
|
|
|
prctl/
|
|
|
|
|
- directory with info on the priveledge control subsystem
|
2005-04-17 06:20:36 +08:00
|
|
|
preempt-locking.txt
|
|
|
|
|
- info on locking under a preemptive kernel.
|
2008-11-13 05:26:55 +08:00
|
|
|
printk-formats.txt
|
|
|
|
|
- how to get printk format specifiers right
|
2013-02-15 04:20:54 +08:00
|
|
|
pps/
|
|
|
|
|
- directory with information on the pulse-per-second support
|
|
|
|
|
ptp/
|
|
|
|
|
- directory with info on support for IEEE 1588 PTP clocks in Linux.
|
|
|
|
|
pwm.txt
|
|
|
|
|
- info on the pulse width modulation driver subsystem
|
2011-08-14 03:34:56 +08:00
|
|
|
ramoops.txt
|
|
|
|
|
- documentation of the ramoops oops/panic logging module.
|
2013-02-15 04:20:54 +08:00
|
|
|
rapidio/
|
|
|
|
|
- directory with info on RapidIO packet-based fabric interconnect
|
2007-07-16 14:41:41 +08:00
|
|
|
rbtree.txt
|
|
|
|
|
- info on what red-black trees are and what they are for.
|
2013-02-15 04:20:54 +08:00
|
|
|
remoteproc.txt
|
|
|
|
|
- info on how to handle remote processor (e.g. AMP) offloads/usage.
|
|
|
|
|
rfkill.txt
|
|
|
|
|
- info on the radio frequency kill switch subsystem/support.
|
2007-07-16 14:41:41 +08:00
|
|
|
robust-futex-ABI.txt
|
|
|
|
|
- documentation of the robust futex ABI.
|
|
|
|
|
robust-futexes.txt
|
|
|
|
|
- a description of what robust futexes are.
|
2013-02-15 04:20:54 +08:00
|
|
|
rpmsg.txt
|
|
|
|
|
- info on the Remote Processor Messaging (rpmsg) Framework
|
2005-04-17 06:20:36 +08:00
|
|
|
rtc.txt
|
|
|
|
|
- notes on how to use the Real Time Clock (aka CMOS clock) driver.
|
|
|
|
|
s390/
|
|
|
|
|
- directory with info on using Linux on the IBM S390.
|
2008-02-07 16:13:37 +08:00
|
|
|
scheduler/
|
|
|
|
|
- directory with info on the scheduler.
|
2005-04-17 06:20:36 +08:00
|
|
|
scsi/
|
|
|
|
|
- directory with info on Linux scsi support.
|
2011-05-20 06:59:38 +08:00
|
|
|
security/
|
|
|
|
|
- directory that contains security-related info
|
2005-04-17 06:20:36 +08:00
|
|
|
serial/
|
|
|
|
|
- directory with info on the low level serial API.
|
|
|
|
|
serial-console.txt
|
|
|
|
|
- how to set up Linux with a serial line console as the default.
|
2007-07-16 14:41:41 +08:00
|
|
|
sgi-ioc4.txt
|
|
|
|
|
- description of the SGI IOC4 PCI (multi function) device.
|
2005-04-17 06:20:36 +08:00
|
|
|
sh/
|
|
|
|
|
- directory with info on porting Linux to a new architecture.
|
2013-02-15 04:20:54 +08:00
|
|
|
smsc_ece1099.txt
|
|
|
|
|
-info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
|
2005-04-17 06:20:36 +08:00
|
|
|
sound/
|
|
|
|
|
- directory with info on sound card support.
|
2007-07-16 14:41:41 +08:00
|
|
|
sparse.txt
|
|
|
|
|
- info on how to obtain and use the sparse tool for typechecking.
|
|
|
|
|
spi/
|
|
|
|
|
- overview of Linux kernel Serial Peripheral Interface (SPI) support.
|
2005-11-19 01:31:15 +08:00
|
|
|
stable_api_nonsense.txt
|
|
|
|
|
- info on why the kernel does not have a stable in-kernel api or abi.
|
|
|
|
|
stable_kernel_rules.txt
|
|
|
|
|
- rules and procedures for the -stable kernel releases.
|
2013-02-15 04:20:54 +08:00
|
|
|
static-keys.txt
|
|
|
|
|
- info on how static keys allow debug code in hotpaths via patching
|
2005-04-17 06:20:36 +08:00
|
|
|
svga.txt
|
|
|
|
|
- short guide on selecting video modes at boot via VGA BIOS.
|
2007-10-17 14:31:25 +08:00
|
|
|
sysfs-rules.txt
|
|
|
|
|
- How not to use sysfs.
|
2005-04-17 06:20:36 +08:00
|
|
|
sysctl/
|
|
|
|
|
- directory with info on the /proc/sys/* files.
|
|
|
|
|
sysrq.txt
|
|
|
|
|
- info on the magic SysRq key.
|
2013-02-15 04:20:54 +08:00
|
|
|
target/
|
|
|
|
|
- directory with info on generating TCM v4 fabric .ko modules
|
2014-02-11 06:25:33 +08:00
|
|
|
this_cpu_ops.txt
|
|
|
|
|
- List rationale behind and the way to use this_cpu operations.
|
2013-02-15 04:20:54 +08:00
|
|
|
thermal/
|
|
|
|
|
- directory with information on managing thermal issues (CPU/temp)
|
|
|
|
|
trace/
|
|
|
|
|
- directory with info on tracing technologies within linux
|
|
|
|
|
unaligned-memory-access.txt
|
|
|
|
|
- info on how to avoid arch breaking unaligned memory access in code.
|
2007-07-16 14:41:41 +08:00
|
|
|
unicode.txt
|
|
|
|
|
- info on the Unicode character/font mapping used in Linux.
|
|
|
|
|
unshare.txt
|
|
|
|
|
- description of the Linux unshare system call.
|
2005-04-17 06:20:36 +08:00
|
|
|
usb/
|
|
|
|
|
- directory with info regarding the Universal Serial Bus.
|
2013-02-15 04:20:54 +08:00
|
|
|
vDSO/
|
|
|
|
|
- directory with info regarding virtual dynamic shared objects
|
|
|
|
|
vfio.txt
|
|
|
|
|
- info on Virtual Function I/O used in guest/hypervisor instances.
|
|
|
|
|
vgaarbiter.txt
|
|
|
|
|
- info on enable/disable the legacy decoding on different VGA devices
|
2007-07-16 14:41:41 +08:00
|
|
|
video-output.txt
|
|
|
|
|
- sysfs class driver interface to enable/disable a video output device.
|
2005-04-17 06:20:36 +08:00
|
|
|
video4linux/
|
|
|
|
|
- directory with info regarding video/TV/radio cards and linux.
|
2013-02-15 04:20:54 +08:00
|
|
|
virtual/
|
|
|
|
|
- directory with information on the various linux virtualizations.
|
2005-04-17 06:20:36 +08:00
|
|
|
vm/
|
|
|
|
|
- directory with info on the Linux vm code.
|
2013-02-15 04:20:54 +08:00
|
|
|
vme_api.txt
|
|
|
|
|
- file relating info on the VME bus API in linux
|
2007-10-17 14:31:25 +08:00
|
|
|
volatile-considered-harmful.txt
|
|
|
|
|
- Why the "volatile" type class should not be used
|
2007-07-16 14:41:41 +08:00
|
|
|
w1/
|
|
|
|
|
- directory with documents regarding the 1-wire (w1) subsystem.
|
2005-04-17 06:20:36 +08:00
|
|
|
watchdog/
|
|
|
|
|
- how to auto-reboot Linux if it has "fallen and can't get up". ;-)
|
2013-02-15 04:20:54 +08:00
|
|
|
wimax/
|
|
|
|
|
- directory with info about Intel Wireless Wimax Connections
|
|
|
|
|
workqueue.txt
|
|
|
|
|
- information on the Concurrency Managed Workqueue implementation
|
2008-10-21 00:32:21 +08:00
|
|
|
x86/x86_64/
|
2005-04-17 06:20:36 +08:00
|
|
|
- directory with info on Linux support for AMD x86-64 (Hammer) machines.
|
2014-12-26 16:26:22 +08:00
|
|
|
xillybus.txt
|
|
|
|
|
- Overview and basic ui of xillybus driver
|
2013-02-15 04:20:54 +08:00
|
|
|
xtensa/
|
|
|
|
|
- directory with documents relating to arch/xtensa port/implementation
|
|
|
|
|
xz.txt
|
|
|
|
|
- how to make use of the XZ data compression within linux kernel
|
|
|
|
|
zh_CN/
|
|
|
|
|
- directory with Chinese translations of various documents
|
2005-04-17 06:20:36 +08:00
|
|
|
zorro.txt
|
|
|
|
|
- info on writing drivers for Zorro bus devices found on Amigas.
|