Eric Lee / linux-smarc-t335x-v3.2

Download as
Browse Code ยป

Commit 9a00c24ae7cb08dcd46edf1327a47871e8466444

Authored by Stefan Richter
1 parent f6a7cd0212
Exists in master and in 4 other branches v3.2_AM335xPSP_04.06.00.11, v3.2_NEWT335xPSP_04.06.00.11, v3.2_SBC_SMARTMEN, v3.2_SMARCT335xPSP_04.06.00.11

firewire: document the sysfs ABIs 

of firewire-core and firewire-sbp2.

Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>

Showing 1 changed file with 122 additions and 0 deletions Side-by-side Diff

Documentation/ABI/stable/sysfs-bus-firewire
Diff comments   View file @ 9a00c24
  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]+[.][0-9]+/
  43 +Date: May 2007
  44 +KernelVersion: 2.6.22
  45 +Contact: linux1394-devel@lists.sourceforge.net
  46 +Description:
  47 + IEEE 1394 unit device attributes.
  48 + Read-only. Immutable during the unit device's lifetime.
  49 + See IEEE 1212 for semantic definitions.
  50 +
  51 + modalias
  52 + Same as MODALIAS in the uevent at device creation.
  53 +
  54 + rom_index
  55 + Offset of the unit directory within the parent device's
  56 + (node device's) Configuration ROM, in quadlets.
  57 + Decimal string representation.
  58 +
  59 +
  60 +What: /sys/bus/firewire/devices/*/
  61 +Date: May 2007
  62 +KernelVersion: 2.6.22
  63 +Contact: linux1394-devel@lists.sourceforge.net
  64 +Description:
  65 + Attributes common to IEEE 1394 node devices and unit devices.
  66 + Read-only. Mutable during the node device's lifetime.
  67 + Immutable during the unit device's lifetime.
  68 + See IEEE 1212 for semantic definitions.
  69 +
  70 + These attributes are only created if the root directory of an
  71 + IEEE 1394 node or the unit directory of an IEEE 1394 unit
  72 + actually contains according entries.
  73 +
  74 + hardware_version
  75 + Hexadecimal string representation of an u24.
  76 +
  77 + hardware_version_name
  78 + Contents of a respective textual descriptor leaf.
  79 +
  80 + model
  81 + Hexadecimal string representation of an u24.
  82 +
  83 + model_name
  84 + Contents of a respective textual descriptor leaf.
  85 +
  86 + specifier_id
  87 + Hexadecimal string representation of an u24.
  88 + Mandatory in unit directories according to IEEE 1212.
  89 +
  90 + vendor
  91 + Hexadecimal string representation of an u24.
  92 + Mandatory in the root directory according to IEEE 1212.
  93 +
  94 + vendor_name
  95 + Contents of a respective textual descriptor leaf.
  96 +
  97 + version
  98 + Hexadecimal string representation of an u24.
  99 + Mandatory in unit directories according to IEEE 1212.
  100 +
  101 +
  102 +What: /sys/bus/firewire/drivers/sbp2/fw*/host*/target*/*:*:*:*/ieee1394_id
  103 + formerly
  104 + /sys/bus/ieee1394/drivers/sbp2/fw*/host*/target*/*:*:*:*/ieee1394_id
  105 +Date: Feb 2004
  106 +KernelVersion: 2.6.4
  107 +Contact: linux1394-devel@lists.sourceforge.net
  108 +Description:
  109 + SCSI target port identifier and logical unit identifier of a
  110 + logical unit of an SBP-2 target. The identifiers are specified
  111 + in SAM-2...SAM-4 annex A. They are persistent and world-wide
  112 + unique properties the SBP-2 attached target.
  113 +
  114 + Read-only attribute, immutable during the target's lifetime.
  115 + Format, as exposed by firewire-sbp2 since 2.6.22, May 2007:
  116 + Colon-separated hexadecimal string representations of
  117 + u64 EUI-64 : u24 directory_ID : u16 LUN
  118 + without 0x prefixes, without whitespace. The former sbp2 driver
  119 + (removed in 2.6.37 after being superseded by firewire-sbp2) used
  120 + a somewhat shorter format which was not as close to SAM.
  121 +
  122 +Users: udev rules to create /dev/disk/by-id/ symlinks