Add the rt linux 4.1.3-rt3 as base
[kvmfornfv.git] / kernel / drivers / staging / ozwpan / README
1 OZWPAN USB Host Controller Driver
2 ---------------------------------
3 This driver is a USB HCD driver that does not have an associated a physical
4 device but instead uses Wi-Fi to communicate with the wireless peripheral.
5 The USB requests are converted into a layer 2 network protocol and transmitted
6 on the network using an ethertype (0x892e) regestered to Ozmo Device Inc.
7 This driver is compatible with existing wireless devices that use Ozmo Devices
8 technology.
9
10 To operate the driver must be bound to a suitable network interface. This can
11 be done when the module is loaded (specifying the name of the network interface
12 as a parameter - e.g. 'insmod ozwpan g_net_dev=go0') or can be bound after
13 loading using an ioctl call. See the ozappif.h file and the ioctls
14 OZ_IOCTL_ADD_BINDING and OZ_IOCTL_REMOVE_BINDING.
15
16 The devices connect to the host use Wi-Fi Direct so a network card that supports
17 Wi-Fi direct is required. A recent version (0.8.x or later) version of the
18 wpa_supplicant can be used to setup the network interface to create a persistent
19 autonomous group (for older pre-WFD peripherals) or put in a listen state to
20 allow group negotiation to occur for more recent devices that support WFD.
21
22 The protocol used over the network does not directly mimic the USB bus
23 transactions as this would be rather busy and inefficient. Instead the chapter 9
24 requests are converted into a request/response pair of messages. (See
25 ozprotocol.h for data structures used in the protocol).