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