mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-20 03:04:01 +08:00
b0ac702f33
Adjust the path of the ABI files for firewire.rst to prevent a
documentation build error. Prevents this problem:
Sphinx parallel build error:
docutils.utils.SystemMessage: Documentation/driver-api/firewire.rst:22: (SEVERE/4) Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: '../Documentation/driver-api/ABI/stable/firewire-cdev'.
Fixes: 2f4830ef96 ("FireWire: add driver-api Introduction section")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/20220119033905.4779-1-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
49 lines
1.4 KiB
ReStructuredText
49 lines
1.4 KiB
ReStructuredText
===========================================
|
|
Firewire (IEEE 1394) driver Interface Guide
|
|
===========================================
|
|
|
|
Introduction and Overview
|
|
=========================
|
|
|
|
The Linux FireWire subsystem adds some interfaces into the Linux system to
|
|
use/maintain+any resource on IEEE 1394 bus.
|
|
|
|
The main purpose of these interfaces is to access address space on each node
|
|
on IEEE 1394 bus by ISO/IEC 13213 (IEEE 1212) procedure, and to control
|
|
isochronous resources on the bus by IEEE 1394 procedure.
|
|
|
|
Two types of interfaces are added, according to consumers of the interface. A
|
|
set of userspace interfaces is available via `firewire character devices`. A set
|
|
of kernel interfaces is available via exported symbols in `firewire-core` module.
|
|
|
|
Firewire char device data structures
|
|
====================================
|
|
|
|
.. include:: ../ABI/stable/firewire-cdev
|
|
:literal:
|
|
|
|
.. kernel-doc:: include/uapi/linux/firewire-cdev.h
|
|
:internal:
|
|
|
|
Firewire device probing and sysfs interfaces
|
|
============================================
|
|
|
|
.. include:: ../ABI/stable/sysfs-bus-firewire
|
|
:literal:
|
|
|
|
.. 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:
|
|
|