Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 005799d5 authored by Thomas Pugliese's avatar Thomas Pugliese Committed by Greg Kroah-Hartman
Browse files

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: default avatarThomas Pugliese <thomas.pugliese@gmail.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 84887934

Documentation/usb/WUSB-Design-overview.txt

+4 −13
Original line number Diff line number Diff line
@@ -161,19 +161,10 @@ now on), such as to start/stop beaconing, scan, allocate bandwidth, etc. 
The main building block here is the UWB device (struct uwb_dev). For

each device that pops up in radio presence (ie: the UWB host receives a

beacon from it) you get a struct uwb_dev that will show up in

/sys/class/uwb and in /sys/bus/uwb/devices.

/sys/bus/uwb/devices.



For each RC that is detected, a new struct uwb_rc is created. In turn, a

RC is also a device, so they also show in /sys/class/uwb and

/sys/bus/uwb/devices, but at the same time, only radio controllers show

up in /sys/class/uwb_rc.



    *



      [*] The reason for RCs being also devices is that not only we can

      see them while enumerating the system device tree, but also on the

      radio (their beacons and stuff), so the handling has to be

      likewise to that of a device.

For each RC that is detected, a new struct uwb_rc and struct uwb_dev are

created. An entry is also created in /sys/class/uwb_rc for each RC.



Each RC driver is implemented by a separate driver that plugs into the

interface that the UWB stack provides through a struct uwb_rc_ops. The
@@ -246,7 +237,7 @@ the beacon cache of dead devices]. 


      Device lists



All UWB devices are kept in the list of the struct bus_type uwb_bus.

All UWB devices are kept in the list of the struct bus_type uwb_bus_type.





      Bandwidth allocation