Fork us on GitHub Follow us on Facebook Follow us on Twitter

Changeset a22004f in mainline


Ignore:
Timestamp:
2011-06-16T15:55:00Z (11 years ago)
Author:
Vojtech Horky <vojtechhorky@…>
Branches:
lfn, master
Children:
90474acb
Parents:
d022500
Message:

Add Doxygen comments to USB HID subdrivers

Also changed return type of usb_hid_driver_poll_ended_t to void.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • uspace/drv/usbhid/usbhid.h

    rd022500 ra22004f  
    4949typedef struct usb_hid_subdriver usb_hid_subdriver_t;
    5050
     51/** Subdriver initialization callback.
     52 *
     53 * @param dev Backing USB HID device.
     54 * @param data Custom subdriver data (pointer where to store them).
     55 * @return Error code.
     56 */
    5157typedef int (*usb_hid_driver_init_t)(usb_hid_dev_t *dev, void **data);
     58
     59/** Subdriver deinitialization callback.
     60 *
     61 * @param dev Backing USB HID device.
     62 * @param data Custom subdriver data.
     63 */
    5264typedef void (*usb_hid_driver_deinit_t)(usb_hid_dev_t *dev, void *data);
     65
     66/** Subdriver callback on data from device.
     67 *
     68 * @param dev Backing USB HID device.
     69 * @param data Custom subdriver data.
     70 * @return Whether to continue polling (typically true always).
     71 */
    5372typedef bool (*usb_hid_driver_poll_t)(usb_hid_dev_t *dev, void *data);
    54 typedef int (*usb_hid_driver_poll_ended_t)(usb_hid_dev_t *dev, void *data,
    55                                          bool reason);
     73
     74/** Subdriver callback after communication with the device ceased.
     75 *
     76 * @param dev Backing USB HID device.
     77 * @param data Custom subdriver data.
     78 * @param ended_due_to_errors Whether communication ended due to errors in
     79 *      communication (true) or deliberately by driver (false).
     80 */
     81typedef void (*usb_hid_driver_poll_ended_t)(usb_hid_dev_t *dev, void *data,
     82    bool ended_due_to_errors);
    5683
    5784struct usb_hid_subdriver {
Note: See TracChangeset for help on using the changeset viewer.