Changeset 70e5ad5 in mainline for uspace/drv/vhc/hub/virthubops.c


Ignore:
Timestamp:
2010-12-16T11:12:31Z (14 years ago)
Author:
Vojtech Horky <vojtechhorky@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
11658b64, 5863a95
Parents:
cea3fca
Message:

More doxygen comments

File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/drv/vhc/hub/virthubops.c

    rcea3fca r70e5ad5  
    8686}
    8787
    88 
     88/** Handle ClearHubFeature request.
     89 *
     90 * @param dev Virtual device representing the hub.
     91 * @param request The SETUP packet of the control request.
     92 * @param data Extra data (when DATA stage present).
     93 * @return Error code.
     94 */
    8995static int req_clear_hub_feature(usbvirt_device_t *dev,
    9096    usb_device_request_setup_packet_t *request,
    … …  
    94100}
    95101
     102/** Handle ClearPortFeature request.
     103 *
     104 * @param dev Virtual device representing the hub.
     105 * @param request The SETUP packet of the control request.
     106 * @param data Extra data (when DATA stage present).
     107 * @return Error code.
     108 */
    96109static int req_clear_port_feature(usbvirt_device_t *dev,
    97110    usb_device_request_setup_packet_t *request,
    … …  
    167180}
    168181
     182/** Handle GetBusState request.
     183 *
     184 * @param dev Virtual device representing the hub.
     185 * @param request The SETUP packet of the control request.
     186 * @param data Extra data (when DATA stage present).
     187 * @return Error code.
     188 */
    169189static int req_get_bus_state(usbvirt_device_t *dev,
    170190    usb_device_request_setup_packet_t *request,
    … …  
    174194}
    175195
     196/** Handle GetDescriptor request.
     197 *
     198 * @param dev Virtual device representing the hub.
     199 * @param request The SETUP packet of the control request.
     200 * @param data Extra data (when DATA stage present).
     201 * @return Error code.
     202 */
    176203static int req_get_descriptor(usbvirt_device_t *dev,
    177204    usb_device_request_setup_packet_t *request,
    … …  
    188215}
    189216
     217/** Handle GetHubStatus request.
     218 *
     219 * @param dev Virtual device representing the hub.
     220 * @param request The SETUP packet of the control request.
     221 * @param data Extra data (when DATA stage present).
     222 * @return Error code.
     223 */
    190224static int req_get_hub_status(usbvirt_device_t *dev,
    191225    usb_device_request_setup_packet_t *request,
    … …  
    198232}
    199233
     234/** Handle GetPortStatus request.
     235 *
     236 * @param dev Virtual device representing the hub.
     237 * @param request The SETUP packet of the control request.
     238 * @param data Extra data (when DATA stage present).
     239 * @return Error code.
     240 */
    200241static int req_get_port_status(usbvirt_device_t *dev,
    201242    usb_device_request_setup_packet_t *request,
    … …  
    213254}
    214255
     256/** Handle SetHubFeature request.
     257 *
     258 * @param dev Virtual device representing the hub.
     259 * @param request The SETUP packet of the control request.
     260 * @param data Extra data (when DATA stage present).
     261 * @return Error code.
     262 */
    215263static int req_set_hub_feature(usbvirt_device_t *dev,
    216264    usb_device_request_setup_packet_t *request,
    … …  
    220268}
    221269
     270/** Handle SetPortFeature request.
     271 *
     272 * @param dev Virtual device representing the hub.
     273 * @param request The SETUP packet of the control request.
     274 * @param data Extra data (when DATA stage present).
     275 * @return Error code.
     276 */
    222277static int req_set_port_feature(usbvirt_device_t *dev,
    223278    usb_device_request_setup_packet_t *request,
    … …  
    265320
    266321
    267 
     322/** IN class request. */
    268323#define CLASS_REQ_IN(recipient) \
    269324        USBVIRT_MAKE_CONTROL_REQUEST_TYPE(USB_DIRECTION_IN, \
    270325        USBVIRT_REQUEST_TYPE_CLASS, recipient)
     326/** OUT class request. */
    271327#define CLASS_REQ_OUT(recipient) \
    272328        USBVIRT_MAKE_CONTROL_REQUEST_TYPE(USB_DIRECTION_OUT, \
    273329        USBVIRT_REQUEST_TYPE_CLASS, recipient)
    274330
     331/** Recipient: other. */
    275332#define REC_OTHER USBVIRT_REQUEST_RECIPIENT_OTHER
     333/** Recipient: device. */
    276334#define REC_DEVICE USBVIRT_REQUEST_RECIPIENT_DEVICE
     335/** Direction: in. */
    277336#define DIR_IN USB_DIRECTION_IN
     337/** Direction: out. */
    278338#define DIR_OUT USB_DIRECTION_OUT
    279339
     340/** Create a class request.
     341 *
     342 * @param direction Request direction.
     343 * @param recipient Request recipient.
     344 * @param req Request code.
     345 */
    280346#define CLASS_REQ(direction, recipient, req) \
    281347        .request_type = USBVIRT_MAKE_CONTROL_REQUEST_TYPE(direction, \
    … …  
    283349        .request = req
    284350
     351/** Create a standard request.
     352 *
     353 * @param direction Request direction.
     354 * @param recipient Request recipient.
     355 * @param req Request code.
     356 */
    285357#define STD_REQ(direction, recipient, req) \
    286358        .request_type = USBVIRT_MAKE_CONTROL_REQUEST_TYPE(direction, \
Note: See TracChangeset for help on using the changeset viewer.