USB HC Headers (changes)

Showing changes from revision #2 to #3: Added | Removed | Changed

USBDriver

» USB HC Headers

USB HC Headers

The RISC OS USB stack is derived from the NetBSD USB stack, customised to work within a module, and the RISC OS execution model. USBDriver contains the higher level aspects of the USB stack and talks down to host controller (HC) drivers which sit between it and the HC hardware registers.

Central to this arrangement are 5 header files exported by USBDriver for inclusion in HC drivers:

Notes

The most important is usbdivar.h which contains definitions of a usbd_bus, usbd_device, usbd_interface, usbd_pipe, and usbd_xfer all of which must agree in their layout to the matching definitions that USBDriver uses. The value of RISCOS_USBDRIVER_API_VERSION is defined to denote the current usbdivar.h , and this value is changed whenever incompatible changes are made to the header. The HC can must check supply the value it assumed against the one USBDriverassumesAPI . version number to USBDriver when itregisters the bus so that USBDriver can decide whether the definitions used by the HC are compatible.

The usb_port.h header contains commonly used macros which may be helpful in porting source code written with the NetBSD stack in mind; your HC driver may choose to do this differently. The usbdevs.h database is a big table of all the known vendors and their devices; it is only likely to be useful to a HC driver if it needs to check for non compliant devices somehow or performs a dual host & device role.

For speed the interface between USBDriver and HC drivers use direct function pointers (referred to as “methods” in the above header files). However, because the two drivers reside in separate modules the function pointers will need to point to a small CMHG-like veneer to swap the value of R12 before continuing to the actual function.