linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Randy Dunlap <rd.dunlab@gmail.com>
To: linux1394-devel@lists.sourceforge.net
Cc: Stefan Richter <stefanr@s5r6.in-berlin.de>,
	Takashi Sakamoto <o-takashi@sakamocchi.jp>,
	linux-doc@vger.kernel.org, linux-scsi@vger.kernel.org,
	Randy Dunlap <rdunlap@infradead.org>,
	Andrew Morton <akpm@linux-foundation.org>,
	"James E.J. Bottomley" <jejb@linux.vnet.ibm.com>,
	"Martin K. Petersen" <martin.petersen@oracle.com>,
	Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v4 5/5] FireWire: add driver-api Introduction section
Date: Tue,  4 Sep 2018 17:02:25 -0700	[thread overview]
Message-ID: <20180905000225.10733-6-rd.dunlab@gmail.com> (raw)
In-Reply-To: <20180905000225.10733-1-rd.dunlab@gmail.com>

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 <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>
---
 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:
 

  parent reply	other threads:[~2018-09-05  0:02 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-05  0:02 [PATCH v3 0/5] FireWire: clean up kernel-doc, add Documentation chapter Randy Dunlap
2018-09-05  0:02 ` [PATCH v4 1/5] FireWire: clean up firewire-cdev.h kernel-doc Randy Dunlap
2018-09-05  0:02 ` [PATCH v4 2/5] FireWire: clean up core-iso.c kernel-doc Randy Dunlap
2018-09-05  0:02 ` [PATCH v4 3/5] FireWire: clean up core-transaction.c kernel-doc Randy Dunlap
2018-09-05  0:02 ` [PATCH v4 4/5] FireWire: add a Documentation driver-api chapter Randy Dunlap
2018-09-05  0:02 ` Randy Dunlap [this message]
2018-09-06 15:47 ` [PATCH v3 0/5] FireWire: clean up kernel-doc, add Documentation chapter Jonathan Corbet
2018-09-15 14:59   ` Stefan Richter

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180905000225.10733-6-rd.dunlab@gmail.com \
    --to=rd.dunlab@gmail.com \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=jejb@linux.vnet.ibm.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-scsi@vger.kernel.org \
    --cc=linux1394-devel@lists.sourceforge.net \
    --cc=martin.petersen@oracle.com \
    --cc=o-takashi@sakamocchi.jp \
    --cc=rdunlap@infradead.org \
    --cc=stefanr@s5r6.in-berlin.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).