Skip to content

Commit

Permalink
FireWire: add a Documentation driver-api chapter
Browse files Browse the repository at this point in the history
Add a basic Firewire/IEEE 1394 driver API chapter to the Linux
kernel documentation.

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>
  • Loading branch information
Randy Dunlap authored and Jonathan Corbet committed Sep 6, 2018
1 parent 226b18a commit ea2ae0e
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
33 changes: 33 additions & 0 deletions Documentation/driver-api/firewire.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
===========================================
Firewire (IEEE 1394) driver Interface Guide
===========================================

Introduction and Overview
=========================

TBD

Firewire char device data structures
====================================

.. kernel-doc:: include/uapi/linux/firewire-cdev.h
:internal:

Firewire device probing and sysfs interfaces
============================================

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

1 change: 1 addition & 0 deletions Documentation/driver-api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ available subsections can be seen below.
iio/index
input
usb/index
firewire
pci
spi
i2c
Expand Down

0 comments on commit ea2ae0e

Please sign in to comment.