| 1 |
|
|---|
| 2 | /* Definitions of modules and its relations for generating Doxygen documentation */
|
|---|
| 3 |
|
|---|
| 4 | /**
|
|---|
| 5 | * @defgroup uspace Userspace
|
|---|
| 6 | * @brief All HelenOS userspace code
|
|---|
| 7 | */
|
|---|
| 8 |
|
|---|
| 9 | /**
|
|---|
| 10 | * @defgroup apps HelenOS applications
|
|---|
| 11 | * @ingroup uspace
|
|---|
| 12 | */
|
|---|
| 13 |
|
|---|
| 14 | /**
|
|---|
| 15 | * @defgroup drvs HelenOS drivers
|
|---|
| 16 | * @brief HelenOS device drivers using the DDF framework
|
|---|
| 17 | * @ingroup uspace
|
|---|
| 18 | */
|
|---|
| 19 |
|
|---|
| 20 | /**
|
|---|
| 21 | * @defgroup libs HelenOS libraries
|
|---|
| 22 | * @ingroup uspace
|
|---|
| 23 | */
|
|---|
| 24 |
|
|---|
| 25 | /**
|
|---|
| 26 | * @defgroup srvs HelenOS services
|
|---|
| 27 | * @ingroup uspace
|
|---|
| 28 | */
|
|---|
| 29 |
|
|---|
| 30 |
|
|---|
| 31 | /*
|
|---|
| 32 | * SPECIAL COMPOSITIONS
|
|---|
| 33 | */
|
|---|
| 34 |
|
|---|
| 35 | /**
|
|---|
| 36 | * @defgroup usb USB
|
|---|
| 37 | * @ingroup uspace
|
|---|
| 38 | * @brief USB support for HelenOS.
|
|---|
| 39 | */
|
|---|
| 40 |
|
|---|
| 41 | /**
|
|---|
| 42 | * @defgroup libusb Base USB library
|
|---|
| 43 | * @ingroup usb
|
|---|
| 44 | * @brief Common definitions for any driver or application
|
|---|
| 45 | * dealing with USB.
|
|---|
| 46 | */
|
|---|
| 47 |
|
|---|
| 48 | /**
|
|---|
| 49 | * @defgroup libusbdev USB library for device drivers
|
|---|
| 50 | * @ingroup usb
|
|---|
| 51 | * @brief Library for writing drivers of endpoint devices (functions).
|
|---|
| 52 | */
|
|---|
| 53 |
|
|---|
| 54 | /**
|
|---|
| 55 | * @defgroup libusbhost USB library for host controller drivers
|
|---|
| 56 | * @ingroup usb
|
|---|
| 57 | * @brief Library for writing host controller drivers.
|
|---|
| 58 | */
|
|---|
| 59 |
|
|---|
| 60 | /**
|
|---|
| 61 | * @defgroup libusbhid USB library for HID devices
|
|---|
| 62 | * @ingroup usb
|
|---|
| 63 | * @brief Library for writing USB HID drivers.
|
|---|
| 64 | */
|
|---|
| 65 |
|
|---|
| 66 | /**
|
|---|
| 67 | * @defgroup usbvirt USB virtualization
|
|---|
| 68 | * @ingroup usb
|
|---|
| 69 | * @brief Support for virtual USB devices.
|
|---|
| 70 | */
|
|---|
| 71 |
|
|---|
| 72 | /**
|
|---|
| 73 | * @defgroup libusbvirt USB virtualization library
|
|---|
| 74 | * @ingroup usbvirt
|
|---|
| 75 | * @brief Library for creating virtual USB devices.
|
|---|
| 76 | */
|
|---|
| 77 |
|
|---|
| 78 | /**
|
|---|
| 79 | * @defgroup drvusbvhc Virtual USB host controller
|
|---|
| 80 | * @ingroup usbvirt
|
|---|
| 81 | * @brief Driver simulating work of USB host controller.
|
|---|
| 82 | */
|
|---|
| 83 |
|
|---|
| 84 | /**
|
|---|
| 85 | * @defgroup usbvirthub Virtual USB hub
|
|---|
| 86 | * @ingroup usbvirt
|
|---|
| 87 | * @brief Extra virtual USB hub for virtual host controller.
|
|---|
| 88 | * @details
|
|---|
| 89 | * Some of the sources are shared with virtual host controller,
|
|---|
| 90 | * see @ref drvusbvhc for the rest of the files.
|
|---|
| 91 | */
|
|---|
| 92 |
|
|---|
| 93 | /**
|
|---|
| 94 | * @defgroup usbvirtkbd Virtual USB keybaord
|
|---|
| 95 | * @ingroup usbvirt
|
|---|
| 96 | * @brief Virtual USB keyboard for virtual host controller.
|
|---|
| 97 | */
|
|---|
| 98 |
|
|---|
| 99 | /**
|
|---|
| 100 | * @defgroup usbinfo USB info application
|
|---|
| 101 | * @ingroup usb
|
|---|
| 102 | * @brief Application for querying USB devices.
|
|---|
| 103 | * @details
|
|---|
| 104 | * The intended usage of this application is to query new USB devices
|
|---|
| 105 | * for their descriptors etc. to simplify driver writing.
|
|---|
| 106 | */
|
|---|
| 107 |
|
|---|
| 108 | /**
|
|---|
| 109 | * @defgroup lsusb HelenOS version of lsusb command
|
|---|
| 110 | * @ingroup usb
|
|---|
| 111 | * @brief Application for listing USB host controllers.
|
|---|
| 112 | * @details
|
|---|
| 113 | * List all found host controllers.
|
|---|
| 114 | */
|
|---|
| 115 |
|
|---|
| 116 | /**
|
|---|
| 117 | * @defgroup drvusbmid USB multi interface device driver
|
|---|
| 118 | * @ingroup usb
|
|---|
| 119 | * @brief USB multi interface device driver
|
|---|
| 120 | * @details
|
|---|
| 121 | * This driver serves as a mini hub (or bus) driver for devices
|
|---|
| 122 | * that have the class defined at interface level (those devices
|
|---|
| 123 | * usually have several interfaces).
|
|---|
| 124 | *
|
|---|
| 125 | * The term multi interface device driver (MID) was borrowed
|
|---|
| 126 | * Solaris operating system.
|
|---|
| 127 | */
|
|---|
| 128 |
|
|---|
| 129 | /**
|
|---|
| 130 | * @defgroup drvusbhub USB hub driver
|
|---|
| 131 | * @ingroup usb
|
|---|
| 132 | * @brief USB hub driver.
|
|---|
| 133 | */
|
|---|
| 134 |
|
|---|
| 135 | /**
|
|---|
| 136 | * @defgroup drvusbhid USB HID driver
|
|---|
| 137 | * @ingroup usb
|
|---|
| 138 | * @brief USB driver for HID devices.
|
|---|
| 139 | */
|
|---|
| 140 |
|
|---|
| 141 | /**
|
|---|
| 142 | * @defgroup drvusbmast USB mass storage driver
|
|---|
| 143 | * @ingroup usb
|
|---|
| 144 | * @brief USB driver for mass storage devices (bulk-only protocol).
|
|---|
| 145 | * This driver is a only a stub and is currently used only for
|
|---|
| 146 | * testing that bulk transfers work.
|
|---|
| 147 | */
|
|---|
| 148 |
|
|---|
| 149 | /**
|
|---|
| 150 | * @addtogroup drvusbuhci
|
|---|
| 151 | * @ingroup usb
|
|---|
| 152 | */
|
|---|
| 153 |
|
|---|
| 154 | /**
|
|---|
| 155 | * @addtogroup drvusbohci
|
|---|
| 156 | * @ingroup usb
|
|---|
| 157 | */
|
|---|
| 158 |
|
|---|
| 159 | /**
|
|---|
| 160 | * @addtogroup drvusbehci
|
|---|
| 161 | * @ingroup usb
|
|---|
| 162 | */
|
|---|
| 163 |
|
|---|
| 164 | /**
|
|---|
| 165 | * @addtogroup drvusbxhci
|
|---|
| 166 | * @ingroup usb
|
|---|
| 167 | */
|
|---|
| 168 |
|
|---|
| 169 | /**
|
|---|
| 170 | * @defgroup drvusbfallback USB fallback driver
|
|---|
| 171 | * @ingroup usb
|
|---|
| 172 | * @brief Fallback driver for any USB device.
|
|---|
| 173 | * @details
|
|---|
| 174 | * The purpose of this driver is to simplify querying of unknown
|
|---|
| 175 | * devices from within HelenOS (without a driver, no node at all
|
|---|
| 176 | * may appear under /loc/devices).
|
|---|
| 177 | */
|
|---|
