Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

FireWire: add driver-api Introduction section

Replace the Introduction section's TBD with some useful overview text.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Stefan Richter <stefanr@s5r6.in-berlin.de>
Cc: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Cc: linux-doc@vger.kernel.org
Cc: linux-scsi@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: "James E.J. Bottomley" <jejb@linux.vnet.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Takashi Sakamoto and committed by
Jonathan Corbet
2f4830ef ea2ae0ec

+16 -1
+16 -1
Documentation/driver-api/firewire.rst
··· 5 5 Introduction and Overview 6 6 ========================= 7 7 8 - TBD 8 + The Linux FireWire subsystem adds some interfaces into the Linux system to 9 + use/maintain+any resource on IEEE 1394 bus. 10 + 11 + The main purpose of these interfaces is to access address space on each node 12 + on IEEE 1394 bus by ISO/IEC 13213 (IEEE 1212) procedure, and to control 13 + isochronous resources on the bus by IEEE 1394 procedure. 14 + 15 + Two types of interfaces are added, according to consumers of the interface. A 16 + set of userspace interfaces is available via `firewire character devices`. A set 17 + of kernel interfaces is available via exported symbols in `firewire-core` module. 9 18 10 19 Firewire char device data structures 11 20 ==================================== 21 + 22 + .. include:: /ABI/stable/firewire-cdev 23 + :literal: 12 24 13 25 .. kernel-doc:: include/uapi/linux/firewire-cdev.h 14 26 :internal: 15 27 16 28 Firewire device probing and sysfs interfaces 17 29 ============================================ 30 + 31 + .. include:: /ABI/stable/sysfs-bus-firewire 32 + :literal: 18 33 19 34 .. kernel-doc:: drivers/firewire/core-device.c 20 35 :export: