dt-bindings: net: dwmac-sun8i: Add binding for GMAC on Allwinner R40 SoC
[linux-2.6-block.git] / Documentation / 00-INDEX
CommitLineData
1da177e4
LT
1
2This is a brief list of all the files in ./linux/Documentation and what
3they contain. If you add a documentation file, please list it here in
4alphabetical order as well, or risk being hunted down like a rabid dog.
449e3a72 5Please keep the descriptions small enough to fit on one line.
1da177e4
LT
6 Thanks -- Paul G.
7
8Following translations are available on the WWW:
9
010f4564
MI
10 - Japanese, maintained by the JF Project (jf@listserv.linux.or.jp), at
11 http://linuxjf.sourceforge.jp/
1da177e4
LT
12
1300-INDEX
14 - this file.
f6b07d39
JJ
15ABI/
16 - info on kernel <-> userspace ABI and relative interface stability.
0f60724f
MCC
17CodingStyle
18 - nothing here, just a pointer to process/coding-style.rst.
1da177e4
LT
19DMA-API.txt
20 - DMA API, pci_ API & extensions for non-consistent memory machines.
449e3a72
PG
21DMA-API-HOWTO.txt
22 - Dynamic DMA mapping Guide
5ef43567
RL
23DMA-ISA-LPC.txt
24 - How to do DMA with ISA (and LPC) devices.
449e3a72
PG
25DMA-attributes.txt
26 - listing of the various possible attributes a DMA region can have
449e3a72
PG
27EDID/
28 - directory with info on customizing EDID for broken gfx/displays.
1da177e4
LT
29IPMI.txt
30 - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
31IRQ-affinity.txt
32 - how to select which CPU(s) handle which interrupt events on SMP.
449e3a72 33IRQ-domain.txt
453f42d3 34 - info on interrupt numbering and setting up IRQ domains.
f6b07d39
JJ
35IRQ.txt
36 - description of what an IRQ is.
449e3a72
PG
37Intel-IOMMU.txt
38 - basic info on the Intel IOMMU virtualization support.
39Makefile
9e22ff43 40 - It's not of interest for those who aren't touching the build system.
822d289f
MCC
41PCI/
42 - info related to PCI drivers.
1da177e4
LT
43RCU/
44 - directory with info on RCU (read-copy update).
1da177e4
LT
45SAK.txt
46 - info on Secure Attention Keys.
5ef43567
RL
47SM501.txt
48 - Silicon Motion SM501 multimedia companion chip
0f60724f
MCC
49SubmittingPatches
50 - nothing here, just a pointer to process/coding-style.rst.
f6b07d39
JJ
51accounting/
52 - documentation on accounting and taskstats.
b4d2730a
LB
53acpi/
54 - info on ACPI-specific hooks in the kernel.
79c87c30
MCC
55admin-guide/
56 - info related to Linux users and system admins.
f6b07d39
JJ
57aoe/
58 - description of AoE (ATA over Ethernet) along with config examples.
1da177e4
LT
59arm/
60 - directory with info about Linux on the ARM architecture.
449e3a72
PG
61arm64/
62 - directory with info about Linux on the 64 bit ARM architecture.
f6b07d39
JJ
63auxdisplay/
64 - misc. LCD driver documentation (cfag12864b, ks0108).
449e3a72
PG
65backlight/
66 - directory with info on controlling backlights in flat panel displays
3cf8ca1c
HA
67bcache.txt
68 - Block-layer cache on fast SSDs to improve slow (raid) I/O performance.
1da177e4
LT
69block/
70 - info on the Block I/O (BIO) layer.
31c00fc1
RD
71blockdev/
72 - info on block devices & drivers
449e3a72
PG
73bt8xxgpio.txt
74 - info on how to modify a bt8xx video card for GPIO usage.
196be0cd
BZ
75btmrvl.txt
76 - info on Marvell Bluetooth driver usage.
449e3a72
PG
77bus-devices/
78 - directory with info on TI GPMC (General Purpose Memory Controller)
9fe41e41
RD
79bus-virt-phys-mapping.txt
80 - how to access I/O mapped memory from within device drivers.
1da177e4
LT
81cachetlb.txt
82 - describes the cache/TLB flushing interfaces Linux uses.
1da177e4
LT
83cdrom/
84 - directory with information on the CD-ROM drivers that Linux has.
822d289f
MCC
85cgroup-v1/
86 - cgroups v1 features, including cpusets and memory controller.
87cgroup-v2.txt
88 - cgroups v2 features, including cpusets and memory controller.
449e3a72
PG
89circular-buffers.txt
90 - how to make use of the existing circular buffer infrastructure
91clk.txt
92 - info on the common clock framework
822d289f
MCC
93cma/
94 - Continuous Memory Area (CMA) debugfs interface.
0f60724f 95conf.py
9e22ff43 96 - It's not of interest for those who aren't touching the build system.
f6b07d39
JJ
97connector/
98 - docs on the netlink based userspace<->kernel space communication mod.
99console/
100 - documentation on Linux console drivers.
24755a55
SF
101core-api/
102 - documentation on kernel core components.
1da177e4
LT
103cpu-freq/
104 - info on CPU frequency and voltage scaling.
f6b07d39
JJ
105cpu-hotplug.txt
106 - document describing CPU hotplug support in the Linux kernel.
107cpu-load.txt
108 - document describing how CPU load statistics are collected.
fe8e288a
VP
109cpuidle/
110 - info on CPU_IDLE, CPU idle state management subsystem.
f6b07d39
JJ
111cputopology.txt
112 - documentation on how CPU topology info is exported via sysfs.
fbedceb1
BP
113crc32.txt
114 - brief tutorial on CRC computation
1da177e4
LT
115crypto/
116 - directory with info on the Crypto API.
f6b07d39
JJ
117dcdbas.txt
118 - information on the Dell Systems Management Base Driver.
1da177e4
LT
119debugging-modules.txt
120 - some notes on debugging modules after Linux 2.6.3.
449e3a72
PG
121debugging-via-ohci1394.txt
122 - how to use firewire like a hardware debugger memory reader.
f6b07d39
JJ
123dell_rbu.txt
124 - document demonstrating the use of the Dell Remote BIOS Update driver.
822d289f
MCC
125dev-tools/
126 - directory with info on development tools for the kernel.
1da177e4
LT
127device-mapper/
128 - directory with info on Device Mapper.
822d289f
MCC
129dmaengine/
130 - the DMA engine and controller API guides.
449e3a72
PG
131devicetree/
132 - directory with info on device tree files used by OF/PowerPC/ARM
133digsig.txt
134 -info on the Digital Signature Verification API
135dma-buf-sharing.txt
136 - the DMA Buffer Sharing API Guide
0f60724f
MCC
137docutils.conf
138 - nothing here. Just a configuration file for docutils.
f6b07d39
JJ
139dontdiff
140 - file containing a list of files that should never be diff'ed.
822d289f
MCC
141driver-api/
142 - the Linux driver implementer's API guide.
1da177e4
LT
143driver-model/
144 - directory with info about Linux driver model.
1da177e4
LT
145early-userspace/
146 - info about initramfs, klibc, and userspace early during boot.
3cf8ca1c
HA
147efi-stub.txt
148 - How to use the EFI boot stub to bypass GRUB or elilo on EFI systems.
1da177e4
LT
149eisa.txt
150 - info on EISA bus support.
449e3a72
PG
151extcon/
152 - directory with porting guide for Android kernel switch driver.
822d289f
MCC
153isa.txt
154 - info on EISA bus support.
f6b07d39
JJ
155fault-injection/
156 - dir with docs about the fault injection capabilities infrastructure.
1da177e4
LT
157fb/
158 - directory with info on the frame buffer graphics abstraction layer.
822d289f
MCC
159features/
160 - status of feature implementation on different architectures.
1da177e4 161filesystems/
4f3b19ca 162 - info on the vfs and the various filesystems that Linux supports.
1da177e4
LT
163firmware_class/
164 - request_firmware() hotplug interface info.
449e3a72
PG
165flexible-arrays.txt
166 - how to make use of flexible sized arrays in linux
022c6747
AR
167fmc/
168 - information about the FMC bus abstraction
822d289f
MCC
169fpga/
170 - FPGA Manager Core.
449e3a72
PG
171futex-requeue-pi.txt
172 - info on requeueing of tasks from a non-PI futex to a PI futex
822d289f
MCC
173gcc-plugins.txt
174 - GCC plugin infrastructure.
3cf8ca1c
HA
175gpio/
176 - gpio related documentation
822d289f
MCC
177gpu/
178 - directory with information on GPU driver developer's guide.
449e3a72
PG
179hid/
180 - directory with information on human interface devices
1da177e4
LT
181highuid.txt
182 - notes on the change from 16 bit to 32 bit user/group IDs.
449e3a72
PG
183hwspinlock.txt
184 - hardware spinlock provides hardware assistance for synchronization
3833eecc
TG
185timers/
186 - info on the timer related topics
1da177e4
LT
187hw_random.txt
188 - info on Linux support for random number generator in i8xx chipsets.
f6b07d39
JJ
189hwmon/
190 - directory with docs on various hardware monitoring drivers.
1da177e4
LT
191i2c/
192 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
71cced6e 193x86/i386/
1da177e4
LT
194 - directory with info about Linux on Intel 32 bit architecture.
195ia64/
196 - directory with info about Linux on Intel 64 bit architecture.
822d289f
MCC
197ide/
198 - Information regarding the Enhanced IDE drive.
199iio/
200 - info on industrial IIO configfs support.
0f60724f
MCC
201index.rst
202 - main index for the documentation at ReST format.
f6b07d39
JJ
203infiniband/
204 - directory with documents concerning Linux InfiniBand support.
1da177e4
LT
205input/
206 - info on Linux input device support.
449e3a72
PG
207intel_txt.txt
208 - info on intel Trusted Execution Technology (intel TXT).
9fe41e41
RD
209io-mapping.txt
210 - description of io_mapping functions in linux/io-mapping.h
1da177e4
LT
211io_ordering.txt
212 - info on ordering I/O writes to memory-mapped addresses.
f6b07d39
JJ
213ioctl/
214 - directory with documents describing various IOCTL calls.
1da177e4
LT
215iostats.txt
216 - info on I/O statistics Linux kernel provides.
f6b07d39
JJ
217irqflags-tracing.txt
218 - how to use the irq-flags tracing feature.
1da177e4
LT
219isapnp.txt
220 - info on Linux ISA Plug & Play support.
221isdn/
222 - directory with info on the Linux ISDN support, and supported cards.
1da177e4
LT
223kbuild/
224 - directory with info about the kernel build process.
f6b07d39
JJ
225kdump/
226 - directory with mini HowTo on getting the crash dump code to work.
1dc4bbf0 227doc-guide/
8ed292fe 228 - how to write and format reStructuredText kernel documentation
3cf8ca1c
HA
229kernel-per-CPU-kthreads.txt
230 - List of all per-CPU kthreads and how they introduce jitter.
1da177e4
LT
231kobject.txt
232 - info of the kobject infrastructure of the Linux kernel.
f6b07d39
JJ
233kprobes.txt
234 - documents the kernel probes debugging feature.
235kref.txt
236 - docs on adding reference counters (krefs) to kernel objects.
d6ff3655
CC
237laptops/
238 - directory with laptop related info and laptop driver documentation.
1da177e4
LT
239ldm.txt
240 - a brief description of LDM (Windows Dynamic Disks).
9a684e19
AO
241leds/
242 - directory with info about LED handling under Linux.
822d289f
MCC
243livepatch/
244 - info on kernel live patching.
214e0aed
DB
245locking/
246 - directory with info about kernel locking primitives
fd058733
JD
247lockup-watchdogs.txt
248 - info on soft and hard lockup detectors (aka nmi_watchdog).
1da177e4 249logo.gif
f6b07d39 250 - full colour GIF image of Linux logo (penguin - Tux).
1da177e4 251logo.txt
f6b07d39 252 - info on creator of above logo & site to get additional images from.
415008af
MCC
253lsm.txt
254 - Linux Security Modules: General Security Hooks for Linux
8ea8f3eb
HA
255lzo.txt
256 - kernel LZO decompressor input formats
1da177e4
LT
257m68k/
258 - directory with info about Linux on Motorola 68k architecture.
8ea8f3eb
HA
259mailbox.txt
260 - How to write drivers for the common mailbox framework (IPC).
1601c590
SL
261md/
262 - directory with info about Linux Software RAID
822d289f
MCC
263media/
264 - info on media drivers: uAPI, kAPI and driver documentation.
f6b07d39
JJ
265memory-barriers.txt
266 - info on Linux kernel memory barriers.
449e3a72
PG
267memory-devices/
268 - directory with info on parts like the Texas Instruments EMIF driver
5ef43567
RL
269memory-hotplug.txt
270 - Hotpluggable memory support, how to use and current status.
822d289f
MCC
271men-chameleon-bus.txt
272 - info on MEN chameleon bus.
822d289f
MCC
273mic/
274 - Intel Many Integrated Core (MIC) architecture device driver.
1da177e4
LT
275mips/
276 - directory with info about Linux on MIPS architecture.
449e3a72
PG
277misc-devices/
278 - directory with info about devices using the misc dev subsystem
dfe86cba
AH
279mmc/
280 - directory with info about the MMC subsystem
449e3a72
PG
281mtd/
282 - directory with info about memory technology devices (flash)
2868f89f
PE
283namespaces/
284 - directory with various information about namespaces
8802f616
PM
285netlabel/
286 - directory with information on the NetLabel subsystem.
1da177e4
LT
287networking/
288 - directory with info on various aspects of networking with Linux.
449e3a72
PG
289nfc/
290 - directory relating info about Near Field Communications support.
822d289f
MCC
291nios2/
292 - Linux on the Nios II architecture.
f6b07d39
JJ
293nommu-mmap.txt
294 - documentation about no-mmu memory mapping support.
1da177e4
LT
295numastat.txt
296 - info on how to read Numa policy hit/miss statistics in sysfs.
822d289f
MCC
297ntb.txt
298 - info on Non-Transparent Bridge (NTB) drivers.
299nvdimm/
300 - info on non-volatile devices.
301nvmem/
302 - info on non volatile memory framework.
0f60724f
MCC
303output/
304 - default directory where html/LaTeX/pdf files will be written.
4047f8b1
JC
305padata.txt
306 - An introduction to the "padata" parallel execution API
1da177e4
LT
307parisc/
308 - directory with info on using Linux on PA-RISC architecture.
1da177e4
LT
309parport-lowlevel.txt
310 - description and usage of the low level parallel port functions.
f6b07d39
JJ
311pcmcia/
312 - info on the Linux PCMCIA driver.
449e3a72
PG
313percpu-rw-semaphore.txt
314 - RCU based read-write semaphore optimized for locking for reading
822d289f
MCC
315perf/
316 - info about the APM X-Gene SoC Performance Monitoring Unit (PMU).
317phy/
318 - ino on Samsung USB 2.0 PHY adaptation layer.
3cf8ca1c
HA
319phy.txt
320 - Description of the generic PHY framework.
f6b07d39 321pi-futex.txt
449e3a72
PG
322 - documentation on lightweight priority inheritance futexes.
323pinctrl.txt
324 - info on pinctrl subsystem and the PINMUX/PINCONF and drivers
822d289f
MCC
325platform/
326 - List of supported hardware by compal and Dell laptop.
1da177e4
LT
327pnp.txt
328 - Linux Plug and Play documentation.
329power/
330 - directory with info on Linux PCI power management.
331powerpc/
332 - directory with info on using Linux with the PowerPC.
449e3a72
PG
333prctl/
334 - directory with info on the priveledge control subsystem
1da177e4
LT
335preempt-locking.txt
336 - info on locking under a preemptive kernel.
79c87c30
MCC
337process/
338 - how to work with the mainline kernel development process.
449e3a72
PG
339pps/
340 - directory with information on the pulse-per-second support
822d289f
MCC
341pti/
342 - directory with info on Intel MID PTI.
449e3a72
PG
343ptp/
344 - directory with info on support for IEEE 1588 PTP clocks in Linux.
345pwm.txt
346 - info on the pulse width modulation driver subsystem
449e3a72
PG
347rapidio/
348 - directory with info on RapidIO packet-based fabric interconnect
f6b07d39
JJ
349rbtree.txt
350 - info on what red-black trees are and what they are for.
449e3a72
PG
351remoteproc.txt
352 - info on how to handle remote processor (e.g. AMP) offloads/usage.
353rfkill.txt
354 - info on the radio frequency kill switch subsystem/support.
f6b07d39
JJ
355robust-futex-ABI.txt
356 - documentation of the robust futex ABI.
357robust-futexes.txt
358 - a description of what robust futexes are.
449e3a72
PG
359rpmsg.txt
360 - info on the Remote Processor Messaging (rpmsg) Framework
1da177e4
LT
361rtc.txt
362 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
363s390/
364 - directory with info on using Linux on the IBM S390.
9b8eae72
BF
365scheduler/
366 - directory with info on the scheduler.
1da177e4
LT
367scsi/
368 - directory with info on Linux scsi support.
d410fa4e
RD
369security/
370 - directory that contains security-related info
1da177e4
LT
371serial/
372 - directory with info on the low level serial API.
f6b07d39
JJ
373sgi-ioc4.txt
374 - description of the SGI IOC4 PCI (multi function) device.
1da177e4
LT
375sh/
376 - directory with info on porting Linux to a new architecture.
449e3a72
PG
377smsc_ece1099.txt
378 -info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
1da177e4
LT
379sound/
380 - directory with info on sound card support.
f6b07d39
JJ
381spi/
382 - overview of Linux kernel Serial Peripheral Interface (SPI) support.
0f60724f 383sphinx/
9e22ff43 384 - no documentation here, just files required by Sphinx toolchain.
0f60724f 385sphinx-static/
9e22ff43 386 - no documentation here, just files required by Sphinx toolchain.
449e3a72
PG
387static-keys.txt
388 - info on how static keys allow debug code in hotpaths via patching
1da177e4
LT
389svga.txt
390 - short guide on selecting video modes at boot via VGA BIOS.
822d289f
MCC
391sync_file.txt
392 - Sync file API guide.
1da177e4
LT
393sysctl/
394 - directory with info on the /proc/sys/* files.
449e3a72
PG
395target/
396 - directory with info on generating TCM v4 fabric .ko modules
6a6e7700
JW
397tee.txt
398 - info on the TEE subsystem and drivers
3cf8ca1c
HA
399this_cpu_ops.txt
400 - List rationale behind and the way to use this_cpu operations.
449e3a72
PG
401thermal/
402 - directory with information on managing thermal issues (CPU/temp)
403trace/
404 - directory with info on tracing technologies within linux
822d289f
MCC
405translations/
406 - translations of this document from English to another language
449e3a72
PG
407unaligned-memory-access.txt
408 - info on how to avoid arch breaking unaligned memory access in code.
f6b07d39
JJ
409unshare.txt
410 - description of the Linux unshare system call.
1da177e4
LT
411usb/
412 - directory with info regarding the Universal Serial Bus.
449e3a72
PG
413vfio.txt
414 - info on Virtual Function I/O used in guest/hypervisor instances.
f6b07d39
JJ
415video-output.txt
416 - sysfs class driver interface to enable/disable a video output device.
449e3a72
PG
417virtual/
418 - directory with information on the various linux virtualizations.
1da177e4
LT
419vm/
420 - directory with info on the Linux vm code.
f6b07d39
JJ
421w1/
422 - directory with documents regarding the 1-wire (w1) subsystem.
1da177e4
LT
423watchdog/
424 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
449e3a72
PG
425wimax/
426 - directory with info about Intel Wireless Wimax Connections
24755a55 427core-api/workqueue.rst
449e3a72 428 - information on the Concurrency Managed Workqueue implementation
71cced6e 429x86/x86_64/
1da177e4 430 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
8ea8f3eb
HA
431xillybus.txt
432 - Overview and basic ui of xillybus driver
449e3a72
PG
433xtensa/
434 - directory with documents relating to arch/xtensa port/implementation
435xz.txt
436 - how to make use of the XZ data compression within linux kernel
1da177e4
LT
437zorro.txt
438 - info on writing drivers for Zorro bus devices found on Amigas.