| Randy Dunlap | ea2ae0e | 2018-09-04 17:02:24 -0700 | [diff] [blame] | 1 | =========================================== |
| 2 | Firewire (IEEE 1394) driver Interface Guide |
| 3 | =========================================== |
| 4 | |
| 5 | Introduction and Overview |
| 6 | ========================= |
| 7 | |
| Takashi Sakamoto | 2f4830e | 2018-09-04 17:02:25 -0700 | [diff] [blame] | 8 | The Linux FireWire subsystem adds some interfaces into the Linux system to |
| 9 | use/maintain+any resource on IEEE 1394 bus. |
| 10 | |
| 11 | The main purpose of these interfaces is to access address space on each node |
| 12 | on IEEE 1394 bus by ISO/IEC 13213 (IEEE 1212) procedure, and to control |
| 13 | isochronous resources on the bus by IEEE 1394 procedure. |
| 14 | |
| 15 | Two types of interfaces are added, according to consumers of the interface. A |
| 16 | set of userspace interfaces is available via `firewire character devices`. A set |
| 17 | of kernel interfaces is available via exported symbols in `firewire-core` module. |
| Randy Dunlap | ea2ae0e | 2018-09-04 17:02:24 -0700 | [diff] [blame] | 18 | |
| 19 | Firewire char device data structures |
| 20 | ==================================== |
| 21 | |
| Takashi Sakamoto | 2f4830e | 2018-09-04 17:02:25 -0700 | [diff] [blame] | 22 | .. include:: /ABI/stable/firewire-cdev |
| 23 | :literal: |
| 24 | |
| Randy Dunlap | ea2ae0e | 2018-09-04 17:02:24 -0700 | [diff] [blame] | 25 | .. kernel-doc:: include/uapi/linux/firewire-cdev.h |
| 26 | :internal: |
| 27 | |
| 28 | Firewire device probing and sysfs interfaces |
| 29 | ============================================ |
| 30 | |
| Takashi Sakamoto | 2f4830e | 2018-09-04 17:02:25 -0700 | [diff] [blame] | 31 | .. include:: /ABI/stable/sysfs-bus-firewire |
| 32 | :literal: |
| 33 | |
| Randy Dunlap | ea2ae0e | 2018-09-04 17:02:24 -0700 | [diff] [blame] | 34 | .. kernel-doc:: drivers/firewire/core-device.c |
| 35 | :export: |
| 36 | |
| 37 | Firewire core transaction interfaces |
| 38 | ==================================== |
| 39 | |
| 40 | .. kernel-doc:: drivers/firewire/core-transaction.c |
| 41 | :export: |
| 42 | |
| 43 | Firewire Isochronous I/O interfaces |
| 44 | =================================== |
| 45 | |
| 46 | .. kernel-doc:: drivers/firewire/core-iso.c |
| 47 | :export: |
| 48 | |