diff options
author | Amir Hammad <amir.hammad@hotmail.com> | 2016-07-08 23:21:37 +0200 |
---|---|---|
committer | Amir Hammad <amir.hammad@hotmail.com> | 2016-07-08 23:45:57 +0200 |
commit | 2c0f82a4f07fe35bc043f68b9f58b954a16ea689 (patch) | |
tree | 857bf067cf88fe1e4b8182020791a286173bfddd /include/usbh_driver_hid_mouse.h | |
parent | e61ed66174df0bf889586c757aa6a9d23d9401c0 (diff) | |
download | secure-hid-2c0f82a4f07fe35bc043f68b9f58b954a16ea689.tar.gz secure-hid-2c0f82a4f07fe35bc043f68b9f58b954a16ea689.tar.bz2 secure-hid-2c0f82a4f07fe35bc043f68b9f58b954a16ea689.zip |
documentation: add some basic documentation accross the headers
Signed-off-by: Amir Hammad <amir.hammad@hotmail.com>
Diffstat (limited to 'include/usbh_driver_hid_mouse.h')
-rw-r--r-- | include/usbh_driver_hid_mouse.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/include/usbh_driver_hid_mouse.h b/include/usbh_driver_hid_mouse.h index c12fed4..de7707c 100644 --- a/include/usbh_driver_hid_mouse.h +++ b/include/usbh_driver_hid_mouse.h @@ -30,10 +30,19 @@ BEGIN_DECLS struct _hid_mouse_config { + /** + * @brief this is called when some data is read when polling the device + * @param device_id + * @param data pointer to the data (only 4 bytes are valid!) + */ void (*mouse_in_message_handler)(uint8_t device_id, const uint8_t *data); }; typedef struct _hid_mouse_config hid_mouse_config_t; +/** + * @brief hid_mouse_driver_init initialization routine - this will initialize internal structures of this device driver + * @param config + */ void hid_mouse_driver_init(const hid_mouse_config_t *config); extern const usbh_dev_driver_t usbh_hid_mouse_driver; |