greybus: interface: Expose DDBL1 manufacturing and production id in sysfs
[cascardo/linux.git] / drivers / staging / greybus / Documentation / sysfs-bus-greybus
1 What:           /sys/bus/greybus/device/greybusN
2 Date:           October 2015
3 KernelVersion:  4.XX
4 Contact:        Greg Kroah-Hartman <greg@kroah.com>
5 Description:
6                 The "root" greybus device for the Greybus device tree, or bus,
7                 where N is a dynamically assigned 1-based id.
8
9 What:           /sys/bus/greybus/device/N-I
10 Date:           October 2015
11 KernelVersion:  4.XX
12 Contact:        Greg Kroah-Hartman <greg@kroah.com>
13 Description:
14                 An Interface I on the bus N, where I is the 1-byte interface
15                 ID.
16
17 What:           /sys/bus/greybus/device/N-I/ddbl1_manufacturer_id
18 Date:           October 2015
19 KernelVersion:  4.XX
20 Contact:        Greg Kroah-Hartman <greg@kroah.com>
21 Description:
22                 Unipro Device Descriptor Block Level 1 manufacturer ID for the
23                 greybus Interface.
24
25 What:           /sys/bus/greybus/device/N-I/ddbl1_product_id
26 Date:           October 2015
27 KernelVersion:  4.XX
28 Contact:        Greg Kroah-Hartman <greg@kroah.com>
29 Description:
30                 Unipro Device Descriptor Block Level 1 product ID for the
31                 greybus Interface.
32
33 What:           /sys/bus/greybus/device/N-I/interface_id
34 Date:           October 2015
35 KernelVersion:  4.XX
36 Contact:        Greg Kroah-Hartman <greg@kroah.com>
37 Description:
38                 The ID of a Greybus interface.
39
40 What:           /sys/bus/greybus/device/N-I/product_id
41 Date:           October 2015
42 KernelVersion:  4.XX
43 Contact:        Greg Kroah-Hartman <greg@kroah.com>
44 Description:
45                 Product ID of a Greybus interface.
46
47 What:           /sys/bus/greybus/device/N-I/product_string
48 Date:           October 2015
49 KernelVersion:  4.XX
50 Contact:        Greg Kroah-Hartman <greg@kroah.com>
51 Description:
52                 Product ID string of a Greybus interface.
53
54 What:           /sys/bus/greybus/device/N-I/vendor_id
55 Date:           October 2015
56 KernelVersion:  4.XX
57 Contact:        Greg Kroah-Hartman <greg@kroah.com>
58 Description:
59                 Vendor ID of a Greybus interface.
60
61 What:           /sys/bus/greybus/device/N-I/vendor_string
62 Date:           October 2015
63 KernelVersion:  4.XX
64 Contact:        Greg Kroah-Hartman <greg@kroah.com>
65 Description:
66                 Vendor ID string of a Greybus interface block.
67
68 What:           /sys/bus/greybus/device/N-I.B
69 Date:           October 2015
70 KernelVersion:  4.XX
71 Contact:        Greg Kroah-Hartman <greg@kroah.com>
72 Description:
73                 A bundle B on the Interface I, B is replaced by a 1-byte
74                 number representing the bundle.
75
76 What:           /sys/bus/greybus/device/N-I.B/bundle_class
77 Date:           October 2015
78 KernelVersion:  4.XX
79 Contact:        Greg Kroah-Hartman <greg@kroah.com>
80 Description:
81                 The greybus class of the bundle B.
82
83 What:           /sys/bus/greybus/device/N-I.B/bundle_id
84 Date:           October 2015
85 KernelVersion:  4.XX
86 Contact:        Greg Kroah-Hartman <greg@kroah.com>
87 Description:
88                 The interface-unique id of the bundle B.
89
90 What:           /sys/bus/greybus/device/N-I.B/state
91 Date:           October 2015
92 KernelVersion:  4.XX
93 Contact:        Greg Kroah-Hartman <greg@kroah.com>
94 Description:
95                 A bundle has a state that is managed by the userspace
96                 Endo process.  This file allows that Endo to signal
97                 other Android HALs that the state of the bundle has
98                 changed to a specific value.  When written to, any
99                 process watching the file will be woken up, and the new
100                 value can be read. It's a "poor-man's IPC", yes, but
101                 simplifies the Android userspace code immensely.
102
103 What:           /sys/bus/greybus/device/N-svc
104 Date:           October 2015
105 KernelVersion:  4.XX
106 Contact:        Greg Kroah-Hartman <greg@kroah.com>
107 Description:
108                 The singleton SVC device of bus N.
109
110 What:           /sys/bus/greybus/device/N-svc/ap_intf_id
111 Date:           October 2015
112 KernelVersion:  4.XX
113 Contact:        Greg Kroah-Hartman <greg@kroah.com>
114 Description:
115                 The AP interface ID, a 1-byte non-zero integer which
116                 defines the position of the AP module on the frame.
117                 The interface positions are defined in the ARA
118                 Module Developer Kit.
119
120 What:           /sys/bus/greybus/device/N-svc/endo_id
121 Date:           October 2015
122 KernelVersion:  4.XX
123 Contact:        Greg Kroah-Hartman <greg@kroah.com>
124 Description:
125                 The Endo ID, which is a 2-byte hexadecimal value
126                 defined by the Endo layout scheme, documented in
127                 the ARA Module Developer Kit.
128
129 What:           /sys/bus/greybus/device/N-svc/unique_id
130 Date:           October 2015
131 KernelVersion:  4.XX
132 Contact:        Greg Kroah-Hartman <greg@kroah.com>
133 Description:
134                 The unique ID, or serial number, of the SVC device
135
136 What:           /sys/bus/greybus/device/N-svc/version
137 Date:           October 2015
138 KernelVersion:  4.XX
139 Contact:        Greg Kroah-Hartman <greg@kroah.com>
140 Description:
141                 The version number of the firmware in the SVC device.