path: root/Documentation/driver-api
diff options
authorLinus Torvalds <torvalds@linux-foundation.org>2018-10-24 18:01:11 +0100
committerLinus Torvalds <torvalds@linux-foundation.org>2018-10-24 18:01:11 +0100
commit01aa9d518eae8a4d75cd3049defc6ed0b6d0a658 (patch)
tree54ca513c49396618e7c6381d74b924fe18f0c202 /Documentation/driver-api
parent5993692f09582accb4cb7af11d344598af43c3b8 (diff)
parentaea74de4b216cdacda797d54220b8ac19daa1bf7 (diff)
Merge tag 'docs-4.20' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "This is a fairly typical cycle for documentation. There's some welcome readability improvements for the formatted output, some LICENSES updates including the addition of the ISC license, the removal of the unloved and unmaintained 00-INDEX files, the deprecated APIs document from Kees, more MM docs from Mike Rapoport, and the usual pile of typo fixes and corrections" * tag 'docs-4.20' of git://git.lwn.net/linux: (41 commits) docs: Fix typos in histogram.rst docs: Introduce deprecated APIs list kernel-doc: fix declaration type determination doc: fix a typo in adding-syscalls.rst docs/admin-guide: memory-hotplug: remove table of contents doc: printk-formats: Remove bogus kobject references for device nodes Documentation: preempt-locking: Use better example dm flakey: Document "error_writes" feature docs/completion.txt: Fix a couple of punctuation nits LICENSES: Add ISC license text LICENSES: Add note to CDDL-1.0 license that it should not be used docs/core-api: memory-hotplug: add some details about locking internals docs/core-api: rename memory-hotplug-notifier to memory-hotplug docs: improve readability for people with poorer eyesight yama: clarify ptrace_scope=2 in Yama documentation docs/vm: split memory hotplug notifier description to Documentation/core-api docs: move memory hotplug description into admin-guide/mm doc: Fix acronym "FEKEK" in ecryptfs docs: fix some broken documentation references iommu: Fix passthrough option documentation ...
Diffstat (limited to 'Documentation/driver-api')
3 files changed, 52 insertions, 0 deletions
diff --git a/Documentation/driver-api/basics.rst b/Documentation/driver-api/basics.rst
index 826e85d50a16..e970fadf4d1a 100644
--- a/Documentation/driver-api/basics.rst
+++ b/Documentation/driver-api/basics.rst
@@ -121,6 +121,9 @@ Kernel utility functions
.. kernel-doc:: kernel/rcu/update.c
+.. kernel-doc:: include/linux/overflow.h
+ :internal:
Device Resource Management
diff --git a/Documentation/driver-api/firewire.rst b/Documentation/driver-api/firewire.rst
new file mode 100644
index 000000000000..94a2d7f01d99
--- /dev/null
+++ b/Documentation/driver-api/firewire.rst
@@ -0,0 +1,48 @@
+Firewire (IEEE 1394) driver Interface Guide
+Introduction and Overview
+The Linux FireWire subsystem adds some interfaces into the Linux system to
+ use/maintain+any resource on IEEE 1394 bus.
+The main purpose of these interfaces is to access address space on each node
+on IEEE 1394 bus by ISO/IEC 13213 (IEEE 1212) procedure, and to control
+isochronous resources on the bus by IEEE 1394 procedure.
+Two types of interfaces are added, according to consumers of the interface. A
+set of userspace interfaces is available via `firewire character devices`. A set
+of kernel interfaces is available via exported symbols in `firewire-core` module.
+Firewire char device data structures
+.. include:: /ABI/stable/firewire-cdev
+ :literal:
+.. kernel-doc:: include/uapi/linux/firewire-cdev.h
+ :internal:
+Firewire device probing and sysfs interfaces
+.. include:: /ABI/stable/sysfs-bus-firewire
+ :literal:
+.. kernel-doc:: drivers/firewire/core-device.c
+ :export:
+Firewire core transaction interfaces
+.. kernel-doc:: drivers/firewire/core-transaction.c
+ :export:
+Firewire Isochronous I/O interfaces
+.. kernel-doc:: drivers/firewire/core-iso.c
+ :export:
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 6d9f2f9fe20e..1f0cdba2b2bf 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -29,6 +29,7 @@ available subsections can be seen below.
+ firewire