diff options
| author | Thomas Pugliese <thomas.pugliese@gmail.com> | 2014-09-16 16:53:09 -0400 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2014-09-24 01:04:44 -0400 |
| commit | 005799d560769bca8d87b08502c34317ab5e3bcd (patch) | |
| tree | b55963bb8a257d4152321ccebad1acb38a433eed /Documentation/usb | |
| parent | 848879340a7d220fd9801396eba82ecac2f2a739 (diff) | |
uwb: doc: bring uwb documentation up to date
The existing UWB documentation states that UWB devices show up in
/sys/class/uwb and /sys/bus/uwb/devices. Up until the most recent
changes to add uwb devices to their own bus, neither of these statements
were actually true. Now, UWB devices do show up in /sys/bus/uwb/devices
so the documentation has been updated to reflect that and removed
references to /sys/class/uwb.
The existing documentation also states that local UWB radio controller
(RC) devices also show up as UWB devices along with their wireless peer
UWB devices under /sys/class/uwb. This is not true so that statement
has been removed.
Signed-off-by: Thomas Pugliese <thomas.pugliese@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/usb')
| -rw-r--r-- | Documentation/usb/WUSB-Design-overview.txt | 17 |
1 files changed, 4 insertions, 13 deletions
diff --git a/Documentation/usb/WUSB-Design-overview.txt b/Documentation/usb/WUSB-Design-overview.txt index 1cd07c017cf6..512238c3dc86 100644 --- a/Documentation/usb/WUSB-Design-overview.txt +++ b/Documentation/usb/WUSB-Design-overview.txt | |||
| @@ -161,19 +161,10 @@ now on), such as to start/stop beaconing, scan, allocate bandwidth, etc. | |||
| 161 | The main building block here is the UWB device (struct uwb_dev). For | 161 | The main building block here is the UWB device (struct uwb_dev). For |
| 162 | each device that pops up in radio presence (ie: the UWB host receives a | 162 | each device that pops up in radio presence (ie: the UWB host receives a |
| 163 | beacon from it) you get a struct uwb_dev that will show up in | 163 | beacon from it) you get a struct uwb_dev that will show up in |
| 164 | /sys/class/uwb and in /sys/bus/uwb/devices. | 164 | /sys/bus/uwb/devices. |
| 165 | 165 | ||
| 166 | For each RC that is detected, a new struct uwb_rc is created. In turn, a | 166 | For each RC that is detected, a new struct uwb_rc and struct uwb_dev are |
| 167 | RC is also a device, so they also show in /sys/class/uwb and | 167 | created. An entry is also created in /sys/class/uwb_rc for each RC. |
| 168 | /sys/bus/uwb/devices, but at the same time, only radio controllers show | ||
| 169 | up in /sys/class/uwb_rc. | ||
| 170 | |||
| 171 | * | ||
| 172 | |||
| 173 | [*] The reason for RCs being also devices is that not only we can | ||
| 174 | see them while enumerating the system device tree, but also on the | ||
| 175 | radio (their beacons and stuff), so the handling has to be | ||
| 176 | likewise to that of a device. | ||
| 177 | 168 | ||
| 178 | Each RC driver is implemented by a separate driver that plugs into the | 169 | Each RC driver is implemented by a separate driver that plugs into the |
| 179 | interface that the UWB stack provides through a struct uwb_rc_ops. The | 170 | interface that the UWB stack provides through a struct uwb_rc_ops. The |
| @@ -246,7 +237,7 @@ the beacon cache of dead devices]. | |||
| 246 | 237 | ||
| 247 | Device lists | 238 | Device lists |
| 248 | 239 | ||
| 249 | All UWB devices are kept in the list of the struct bus_type uwb_bus. | 240 | All UWB devices are kept in the list of the struct bus_type uwb_bus_type. |
| 250 | 241 | ||
| 251 | 242 | ||
| 252 | Bandwidth allocation | 243 | Bandwidth allocation |
