[PATCH v4 5/5] FireWire: add driver-api Introduction section
From: Randy Dunlap <hidden>
Date: 2018-09-05 00:02:25
Also in:
linux-scsi
From: Takashi Sakamoto <o-takashi@sakamocchi.jp> Replace the Introduction section's TBD with some useful overview text. Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp> Acked-by: Randy Dunlap <redacted> Tested-by: Randy Dunlap <redacted> Signed-off-by: Randy Dunlap <redacted> 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 <redacted> Cc: Andrew Morton <akpm@linux-foundation.org> Cc: "James E.J. Bottomley" <redacted> Cc: "Martin K. Petersen" <martin.petersen@oracle.com> Cc: Jonathan Corbet <corbet@lwn.net> --- Documentation/driver-api/firewire.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-)
--- linux-next-20180904.orig/Documentation/driver-api/firewire.rst
+++ linux-next-20180904/Documentation/driver-api/firewire.rst@@ -5,17 +5,32 @@ Firewire (IEEE 1394) driver Interface Gu Introduction and Overview ========================= -TBD +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: