Merge tag 'ntb-5.11' of git://github.com/jonmason/ntb
[linux-2.6-microblaze.git] / Documentation / ABI / testing / sysfs-platform-kim
1 What:           /sys/devices/platform/kim/dev_name
2 Date:           January 2010
3 KernelVersion:  2.6.38
4 Contact:        "Pavan Savoy" <pavan_savoy@ti.com>
5 Description:
6                 Name of the UART device at which the WL128x chip
7                 is connected. example: "/dev/ttyS0".
8
9                 The device name flows down to architecture specific board
10                 initialization file from the SFI/ATAGS bootloader
11                 firmware. The name exposed is read from the user-space
12                 dameon and opens the device when install is requested.
13
14 What:           /sys/devices/platform/kim/baud_rate
15 Date:           January 2010
16 KernelVersion:  2.6.38
17 Contact:        "Pavan Savoy" <pavan_savoy@ti.com>
18 Description:
19                 The maximum reliable baud-rate the host can support.
20                 Different platforms tend to have different high-speed
21                 UART configurations, so the baud-rate needs to be set
22                 locally and also sent across to the WL128x via a HCI-VS
23                 command. The entry is read and made use by the user-space
24                 daemon when the ldisc install is requested.
25
26 What:           /sys/devices/platform/kim/flow_cntrl
27 Date:           January 2010
28 KernelVersion:  2.6.38
29 Contact:        "Pavan Savoy" <pavan_savoy@ti.com>
30 Description:
31                 The WL128x makes use of flow control mechanism, and this
32                 entry most often should be 1, the host's UART is required
33                 to have the capability of flow-control, or else this
34                 entry can be made use of for exceptions.
35
36 What:           /sys/devices/platform/kim/install
37 Date:           January 2010
38 KernelVersion:  2.6.38
39 Contact:        "Pavan Savoy" <pavan_savoy@ti.com>
40 Description:
41                 When one of the protocols Bluetooth, FM or GPS wants to make
42                 use of the shared UART transport, it registers to the shared
43                 transport driver, which will signal the user-space for opening,
44                 configuring baud and install line discipline via this sysfs
45                 entry. This entry would be polled upon by the user-space
46                 daemon managing the UART, and is notified about the change
47                 by the sysfs_notify. The value would be '1' when UART needs
48                 to be opened/ldisc installed, and would be '0' when UART
49                 is no more required and needs to be closed.