Merge tag 'ntb-5.11' of git://github.com/jonmason/ntb
[linux-2.6-microblaze.git] / Documentation / ABI / stable / sysfs-bus-firewire
1 What:           /sys/bus/firewire/devices/fw[0-9]+/
2 Date:           May 2007
3 KernelVersion:  2.6.22
4 Contact:        linux1394-devel@lists.sourceforge.net
5 Description:
6                 IEEE 1394 node device attributes.
7                 Read-only.  Mutable during the node device's lifetime.
8                 See IEEE 1212 for semantic definitions.
9
10                 config_rom
11                         Contents of the Configuration ROM register.
12                         Binary attribute; an array of host-endian u32.
13
14                 guid
15                         The node's EUI-64 in the bus information block of
16                         Configuration ROM.
17                         Hexadecimal string representation of an u64.
18
19
20 What:           /sys/bus/firewire/devices/fw[0-9]+/units
21 Date:           June 2009
22 KernelVersion:  2.6.31
23 Contact:        linux1394-devel@lists.sourceforge.net
24 Description:
25                 IEEE 1394 node device attribute.
26                 Read-only.  Mutable during the node device's lifetime.
27                 See IEEE 1212 for semantic definitions.
28
29                 units
30                         Summary of all units present in an IEEE 1394 node.
31                         Contains space-separated tuples of specifier_id and
32                         version of each unit present in the node.  Specifier_id
33                         and version are hexadecimal string representations of
34                         u24 of the respective unit directory entries.
35                         Specifier_id and version within each tuple are separated
36                         by a colon.
37
38 Users:          udev rules to set ownership and access permissions or ACLs of
39                 /dev/fw[0-9]+ character device files
40
41
42 What:           /sys/bus/firewire/devices/fw[0-9]+/is_local
43 Date:           July 2012
44 KernelVersion:  3.6
45 Contact:        linux1394-devel@lists.sourceforge.net
46 Description:
47                 IEEE 1394 node device attribute.
48                 Read-only and immutable.
49 Values:         1: The sysfs entry represents a local node (a controller card).
50
51                 0: The sysfs entry represents a remote node.
52
53
54 What:           /sys/bus/firewire/devices/fw[0-9]+[.][0-9]+/
55 Date:           May 2007
56 KernelVersion:  2.6.22
57 Contact:        linux1394-devel@lists.sourceforge.net
58 Description:
59                 IEEE 1394 unit device attributes.
60                 Read-only.  Immutable during the unit device's lifetime.
61                 See IEEE 1212 for semantic definitions.
62
63                 modalias
64                         Same as MODALIAS in the uevent at device creation.
65
66                 rom_index
67                         Offset of the unit directory within the parent device's
68                         (node device's) Configuration ROM, in quadlets.
69                         Decimal string representation.
70
71
72 What:           /sys/bus/firewire/devices/*/
73 Date:           May 2007
74 KernelVersion:  2.6.22
75 Contact:        linux1394-devel@lists.sourceforge.net
76 Description:
77                 Attributes common to IEEE 1394 node devices and unit devices.
78                 Read-only.  Mutable during the node device's lifetime.
79                 Immutable during the unit device's lifetime.
80                 See IEEE 1212 for semantic definitions.
81
82                 These attributes are only created if the root directory of an
83                 IEEE 1394 node or the unit directory of an IEEE 1394 unit
84                 actually contains according entries.
85
86                 hardware_version
87                         Hexadecimal string representation of an u24.
88
89                 hardware_version_name
90                         Contents of a respective textual descriptor leaf.
91
92                 model
93                         Hexadecimal string representation of an u24.
94
95                 model_name
96                         Contents of a respective textual descriptor leaf.
97
98                 specifier_id
99                         Hexadecimal string representation of an u24.
100                         Mandatory in unit directories according to IEEE 1212.
101
102                 vendor
103                         Hexadecimal string representation of an u24.
104                         Mandatory in the root directory according to IEEE 1212.
105
106                 vendor_name
107                         Contents of a respective textual descriptor leaf.
108
109                 version
110                         Hexadecimal string representation of an u24.
111                         Mandatory in unit directories according to IEEE 1212.
112
113
114 What:           /sys/bus/firewire/drivers/sbp2/fw*/host*/target*/*:*:*:*/ieee1394_id
115                 formerly
116                 /sys/bus/ieee1394/drivers/sbp2/fw*/host*/target*/*:*:*:*/ieee1394_id
117 Date:           Feb 2004
118 KernelVersion:  2.6.4
119 Contact:        linux1394-devel@lists.sourceforge.net
120 Description:
121                 SCSI target port identifier and logical unit identifier of a
122                 logical unit of an SBP-2 target.  The identifiers are specified
123                 in SAM-2...SAM-4 annex A.  They are persistent and world-wide
124                 unique properties the SBP-2 attached target.
125
126                 Read-only attribute, immutable during the target's lifetime.
127                 Format, as exposed by firewire-sbp2 since 2.6.22, May 2007:
128                 Colon-separated hexadecimal string representations of
129
130                         u64 EUI-64 : u24 directory_ID : u16 LUN
131
132                 without 0x prefixes, without whitespace.  The former sbp2 driver
133                 (removed in 2.6.37 after being superseded by firewire-sbp2) used
134                 a somewhat shorter format which was not as close to SAM.
135
136 Users:          udev rules to create /dev/disk/by-id/ symlinks