diff options
| author | Randy Dunlap <rdunlap@infradead.org> | 2018-09-05 02:02:24 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2018-09-06 17:41:12 +0200 |
| commit | ea2ae0ecc9ad8c47ca25837823cc25679a1e4d1a (patch) | |
| tree | 6c61744875b3e74af06257513ac2cc974624a995 | |
| parent | FireWire: clean up core-transaction.c kernel-doc (diff) | |
| download | linux-ea2ae0ecc9ad8c47ca25837823cc25679a1e4d1a.tar.xz linux-ea2ae0ecc9ad8c47ca25837823cc25679a1e4d1a.zip | |
FireWire: add a Documentation driver-api chapter
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>
| -rw-r--r-- | Documentation/driver-api/firewire.rst | 33 | ||||
| -rw-r--r-- | Documentation/driver-api/index.rst | 1 |
2 files changed, 34 insertions, 0 deletions
diff --git a/Documentation/driver-api/firewire.rst b/Documentation/driver-api/firewire.rst new file mode 100644 index 000000000000..31f0b292bb75 --- /dev/null +++ b/Documentation/driver-api/firewire.rst @@ -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: + diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index 6d9f2f9fe20e..1f0cdba2b2bf 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -29,6 +29,7 @@ available subsections can be seen below. iio/index input usb/index + firewire pci spi i2c |