mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2026-10-26 10:57:38 +08:00
Takashi Sakamoto
aa7f13e25c
The core provides helper functions and structures for handling transaction requests to local address regions. Add kerneldoc comments for these symbols. Link: https://lore.kernel.org/r/20261013111509.612518-3-o-takashi@sakamocchi.jp Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
56 lines
1.8 KiB
ReStructuredText
56 lines
1.8 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:: include/linux/firewire.h
|
|
:identifiers: fw_transaction fw_transaction_callback_t fw_transaction_callback_with_tstamp_t
|
|
fw_transaction_callback fw_send_request fw_send_request_with_tstamp
|
|
fw_address_callback_t fw_address_handler fw_address_region
|
|
|
|
.. kernel-doc:: drivers/firewire/core-transaction.c
|
|
:export:
|
|
|
|
Firewire Isochronous I/O interfaces
|
|
===================================
|
|
|
|
.. kernel-doc:: include/linux/firewire.h
|
|
:functions: fw_iso_context_schedule_flush_completions
|
|
.. kernel-doc:: drivers/firewire/core-iso.c
|
|
:export:
|
|
|