From: Takashi Sakamoto <o-takashi@xxxxxxxxxxxxx>
Replace the Introduction section's TBD with some useful overview text.
Signed-off-by: Takashi Sakamoto <o-takashi@xxxxxxxxxxxxx>
Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Cc: Stefan Richter <stefanr@xxxxxxxxxxxxxxxxx>
Cc: Takashi Sakamoto <o-takashi@xxxxxxxxxxxxx>
Cc: linux-doc@xxxxxxxxxxxxxxx
Cc: linux-scsi@xxxxxxxxxxxxxxx
Cc: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Cc: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
Cc: "James E.J. Bottomley" <jejb@xxxxxxxxxxxxxxxxxx>
Cc: "Martin K. Petersen" <martin.petersen@xxxxxxxxxx>
Cc: Jonathan Corbet <corbet@xxxxxxx>
---
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:
