diff options
Diffstat (limited to 'Documentation/ABI')
-rw-r--r-- | Documentation/ABI/removed/ip_queue | 9 | ||||
-rw-r--r-- | Documentation/ABI/testing/dev-kmsg | 90 | ||||
-rw-r--r-- | Documentation/ABI/testing/sysfs-bus-usb | 15 | ||||
-rw-r--r-- | Documentation/ABI/testing/sysfs-class-extcon | 97 | ||||
-rw-r--r-- | Documentation/ABI/testing/sysfs-class-net-mesh | 9 |
5 files changed, 220 insertions, 0 deletions
diff --git a/Documentation/ABI/removed/ip_queue b/Documentation/ABI/removed/ip_queue new file mode 100644 index 000000000000..3243613bc2d2 --- /dev/null +++ b/Documentation/ABI/removed/ip_queue | |||
@@ -0,0 +1,9 @@ | |||
1 | What: ip_queue | ||
2 | Date: finally removed in kernel v3.5.0 | ||
3 | Contact: Pablo Neira Ayuso <pablo@netfilter.org> | ||
4 | Description: | ||
5 | ip_queue has been replaced by nfnetlink_queue which provides | ||
6 | more advanced queueing mechanism to user-space. The ip_queue | ||
7 | module was already announced to become obsolete years ago. | ||
8 | |||
9 | Users: | ||
diff --git a/Documentation/ABI/testing/dev-kmsg b/Documentation/ABI/testing/dev-kmsg new file mode 100644 index 000000000000..281ecc5f9709 --- /dev/null +++ b/Documentation/ABI/testing/dev-kmsg | |||
@@ -0,0 +1,90 @@ | |||
1 | What: /dev/kmsg | ||
2 | Date: Mai 2012 | ||
3 | KernelVersion: 3.5 | ||
4 | Contact: Kay Sievers <kay@vrfy.org> | ||
5 | Description: The /dev/kmsg character device node provides userspace access | ||
6 | to the kernel's printk buffer. | ||
7 | |||
8 | Injecting messages: | ||
9 | Every write() to the opened device node places a log entry in | ||
10 | the kernel's printk buffer. | ||
11 | |||
12 | The logged line can be prefixed with a <N> syslog prefix, which | ||
13 | carries the syslog priority and facility. The single decimal | ||
14 | prefix number is composed of the 3 lowest bits being the syslog | ||
15 | priority and the higher bits the syslog facility number. | ||
16 | |||
17 | If no prefix is given, the priority number is the default kernel | ||
18 | log priority and the facility number is set to LOG_USER (1). It | ||
19 | is not possible to inject messages from userspace with the | ||
20 | facility number LOG_KERN (0), to make sure that the origin of | ||
21 | the messages can always be reliably determined. | ||
22 | |||
23 | Accessing the buffer: | ||
24 | Every read() from the opened device node receives one record | ||
25 | of the kernel's printk buffer. | ||
26 | |||
27 | The first read() directly following an open() always returns | ||
28 | first message in the buffer; there is no kernel-internal | ||
29 | persistent state; many readers can concurrently open the device | ||
30 | and read from it, without affecting other readers. | ||
31 | |||
32 | Every read() will receive the next available record. If no more | ||
33 | records are available read() will block, or if O_NONBLOCK is | ||
34 | used -EAGAIN returned. | ||
35 | |||
36 | Messages in the record ring buffer get overwritten as whole, | ||
37 | there are never partial messages received by read(). | ||
38 | |||
39 | In case messages get overwritten in the circular buffer while | ||
40 | the device is kept open, the next read() will return -EPIPE, | ||
41 | and the seek position be updated to the next available record. | ||
42 | Subsequent reads() will return available records again. | ||
43 | |||
44 | Unlike the classic syslog() interface, the 64 bit record | ||
45 | sequence numbers allow to calculate the amount of lost | ||
46 | messages, in case the buffer gets overwritten. And they allow | ||
47 | to reconnect to the buffer and reconstruct the read position | ||
48 | if needed, without limiting the interface to a single reader. | ||
49 | |||
50 | The device supports seek with the following parameters: | ||
51 | SEEK_SET, 0 | ||
52 | seek to the first entry in the buffer | ||
53 | SEEK_END, 0 | ||
54 | seek after the last entry in the buffer | ||
55 | SEEK_DATA, 0 | ||
56 | seek after the last record available at the time | ||
57 | the last SYSLOG_ACTION_CLEAR was issued. | ||
58 | |||
59 | The output format consists of a prefix carrying the syslog | ||
60 | prefix including priority and facility, the 64 bit message | ||
61 | sequence number and the monotonic timestamp in microseconds. | ||
62 | The values are separated by a ','. Future extensions might | ||
63 | add more comma separated values before the terminating ';'. | ||
64 | Unknown values should be gracefully ignored. | ||
65 | |||
66 | The human readable text string starts directly after the ';' | ||
67 | and is terminated by a '\n'. Untrusted values derived from | ||
68 | hardware or other facilities are printed, therefore | ||
69 | all non-printable characters in the log message are escaped | ||
70 | by "\x00" C-style hex encoding. | ||
71 | |||
72 | A line starting with ' ', is a continuation line, adding | ||
73 | key/value pairs to the log message, which provide the machine | ||
74 | readable context of the message, for reliable processing in | ||
75 | userspace. | ||
76 | |||
77 | Example: | ||
78 | 7,160,424069;pci_root PNP0A03:00: host bridge window [io 0x0000-0x0cf7] (ignored) | ||
79 | SUBSYSTEM=acpi | ||
80 | DEVICE=+acpi:PNP0A03:00 | ||
81 | 6,339,5140900;NET: Registered protocol family 10 | ||
82 | 30,340,5690716;udevd[80]: starting version 181 | ||
83 | |||
84 | The DEVICE= key uniquely identifies devices the following way: | ||
85 | b12:8 - block dev_t | ||
86 | c127:3 - char dev_t | ||
87 | n8 - netdev ifindex | ||
88 | +sound:card0 - subsystem:devname | ||
89 | |||
90 | Users: dmesg(1), userspace kernel log consumers | ||
diff --git a/Documentation/ABI/testing/sysfs-bus-usb b/Documentation/ABI/testing/sysfs-bus-usb index 7c22a532fdfb..6ae9fec8e07d 100644 --- a/Documentation/ABI/testing/sysfs-bus-usb +++ b/Documentation/ABI/testing/sysfs-bus-usb | |||
@@ -135,6 +135,17 @@ Description: | |||
135 | for the device and attempt to bind to it. For example: | 135 | for the device and attempt to bind to it. For example: |
136 | # echo "8086 10f5" > /sys/bus/usb/drivers/foo/new_id | 136 | # echo "8086 10f5" > /sys/bus/usb/drivers/foo/new_id |
137 | 137 | ||
138 | Reading from this file will list all dynamically added | ||
139 | device IDs in the same format, with one entry per | ||
140 | line. For example: | ||
141 | # cat /sys/bus/usb/drivers/foo/new_id | ||
142 | 8086 10f5 | ||
143 | dead beef 06 | ||
144 | f00d cafe | ||
145 | |||
146 | The list will be truncated at PAGE_SIZE bytes due to | ||
147 | sysfs restrictions. | ||
148 | |||
138 | What: /sys/bus/usb-serial/drivers/.../new_id | 149 | What: /sys/bus/usb-serial/drivers/.../new_id |
139 | Date: October 2011 | 150 | Date: October 2011 |
140 | Contact: linux-usb@vger.kernel.org | 151 | Contact: linux-usb@vger.kernel.org |
@@ -157,6 +168,10 @@ Description: | |||
157 | match the driver to the device. For example: | 168 | match the driver to the device. For example: |
158 | # echo "046d c315" > /sys/bus/usb/drivers/foo/remove_id | 169 | # echo "046d c315" > /sys/bus/usb/drivers/foo/remove_id |
159 | 170 | ||
171 | Reading from this file will list the dynamically added | ||
172 | device IDs, exactly like reading from the entry | ||
173 | "/sys/bus/usb/drivers/.../new_id" | ||
174 | |||
160 | What: /sys/bus/usb/device/.../avoid_reset_quirk | 175 | What: /sys/bus/usb/device/.../avoid_reset_quirk |
161 | Date: December 2009 | 176 | Date: December 2009 |
162 | Contact: Oliver Neukum <oliver@neukum.org> | 177 | Contact: Oliver Neukum <oliver@neukum.org> |
diff --git a/Documentation/ABI/testing/sysfs-class-extcon b/Documentation/ABI/testing/sysfs-class-extcon new file mode 100644 index 000000000000..20ab361bd8c6 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-class-extcon | |||
@@ -0,0 +1,97 @@ | |||
1 | What: /sys/class/extcon/.../ | ||
2 | Date: February 2012 | ||
3 | Contact: MyungJoo Ham <myungjoo.ham@samsung.com> | ||
4 | Description: | ||
5 | Provide a place in sysfs for the extcon objects. | ||
6 | This allows accessing extcon specific variables. | ||
7 | The name of extcon object denoted as ... is the name given | ||
8 | with extcon_dev_register. | ||
9 | |||
10 | One extcon device denotes a single external connector | ||
11 | port. An external connector may have multiple cables | ||
12 | attached simultaneously. Many of docks, cradles, and | ||
13 | accessory cables have such capability. For example, | ||
14 | the 30-pin port of Nuri board (/arch/arm/mach-exynos) | ||
15 | may have both HDMI and Charger attached, or analog audio, | ||
16 | video, and USB cables attached simulteneously. | ||
17 | |||
18 | If there are cables mutually exclusive with each other, | ||
19 | such binary relations may be expressed with extcon_dev's | ||
20 | mutually_exclusive array. | ||
21 | |||
22 | What: /sys/class/extcon/.../name | ||
23 | Date: February 2012 | ||
24 | Contact: MyungJoo Ham <myungjoo.ham@samsung.com> | ||
25 | Description: | ||
26 | The /sys/class/extcon/.../name shows the name of the extcon | ||
27 | object. If the extcon object has an optional callback | ||
28 | "show_name" defined, the callback will provide the name with | ||
29 | this sysfs node. | ||
30 | |||
31 | What: /sys/class/extcon/.../state | ||
32 | Date: February 2012 | ||
33 | Contact: MyungJoo Ham <myungjoo.ham@samsung.com> | ||
34 | Description: | ||
35 | The /sys/class/extcon/.../state shows and stores the cable | ||
36 | attach/detach information of the corresponding extcon object. | ||
37 | If the extcon object has an optional callback "show_state" | ||
38 | defined, the showing function is overriden with the optional | ||
39 | callback. | ||
40 | |||
41 | If the default callback for showing function is used, the | ||
42 | format is like this: | ||
43 | # cat state | ||
44 | USB_OTG=1 | ||
45 | HDMI=0 | ||
46 | TA=1 | ||
47 | EAR_JACK=0 | ||
48 | # | ||
49 | In this example, the extcon device have USB_OTG and TA | ||
50 | cables attached and HDMI and EAR_JACK cables detached. | ||
51 | |||
52 | In order to update the state of an extcon device, enter a hex | ||
53 | state number starting with 0x. | ||
54 | echo 0xHEX > state | ||
55 | |||
56 | This updates the whole state of the extcon dev. | ||
57 | Inputs of all the methods are required to meet the | ||
58 | mutually_exclusive contidions if they exist. | ||
59 | |||
60 | It is recommended to use this "global" state interface if | ||
61 | you need to enter the value atomically. The later state | ||
62 | interface associated with each cable cannot update | ||
63 | multiple cable states of an extcon device simultaneously. | ||
64 | |||
65 | What: /sys/class/extcon/.../cable.x/name | ||
66 | Date: February 2012 | ||
67 | Contact: MyungJoo Ham <myungjoo.ham@samsung.com> | ||
68 | Description: | ||
69 | The /sys/class/extcon/.../cable.x/name shows the name of cable | ||
70 | "x" (integer between 0 and 31) of an extcon device. | ||
71 | |||
72 | What: /sys/class/extcon/.../cable.x/state | ||
73 | Date: February 2012 | ||
74 | Contact: MyungJoo Ham <myungjoo.ham@samsung.com> | ||
75 | Description: | ||
76 | The /sys/class/extcon/.../cable.x/name shows and stores the | ||
77 | state of cable "x" (integer between 0 and 31) of an extcon | ||
78 | device. The state value is either 0 (detached) or 1 | ||
79 | (attached). | ||
80 | |||
81 | What: /sys/class/extcon/.../mutually_exclusive/... | ||
82 | Date: December 2011 | ||
83 | Contact: MyungJoo Ham <myungjoo.ham@samsung.com> | ||
84 | Description: | ||
85 | Shows the relations of mutually exclusiveness. For example, | ||
86 | if the mutually_exclusive array of extcon_dev is | ||
87 | {0x3, 0x5, 0xC, 0x0}, the, the output is: | ||
88 | # ls mutually_exclusive/ | ||
89 | 0x3 | ||
90 | 0x5 | ||
91 | 0xc | ||
92 | # | ||
93 | |||
94 | Note that mutually_exclusive is a sub-directory of the extcon | ||
95 | device and the file names under the mutually_exclusive | ||
96 | directory show the mutually-exclusive sets, not the contents | ||
97 | of the files. | ||
diff --git a/Documentation/ABI/testing/sysfs-class-net-mesh b/Documentation/ABI/testing/sysfs-class-net-mesh index b218e0f8bdb3..c81fe89c4c46 100644 --- a/Documentation/ABI/testing/sysfs-class-net-mesh +++ b/Documentation/ABI/testing/sysfs-class-net-mesh | |||
@@ -14,6 +14,15 @@ Description: | |||
14 | mesh will be sent using multiple interfaces at the | 14 | mesh will be sent using multiple interfaces at the |
15 | same time (if available). | 15 | same time (if available). |
16 | 16 | ||
17 | What: /sys/class/net/<mesh_iface>/mesh/bridge_loop_avoidance | ||
18 | Date: November 2011 | ||
19 | Contact: Simon Wunderlich <siwu@hrz.tu-chemnitz.de> | ||
20 | Description: | ||
21 | Indicates whether the bridge loop avoidance feature | ||
22 | is enabled. This feature detects and avoids loops | ||
23 | between the mesh and devices bridged with the soft | ||
24 | interface <mesh_iface>. | ||
25 | |||
17 | What: /sys/class/net/<mesh_iface>/mesh/fragmentation | 26 | What: /sys/class/net/<mesh_iface>/mesh/fragmentation |
18 | Date: October 2010 | 27 | Date: October 2010 |
19 | Contact: Andreas Langer <an.langer@gmx.de> | 28 | Contact: Andreas Langer <an.langer@gmx.de> |