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