summaryrefslogtreecommitdiff
path: root/include/usbh_driver_hid.h
diff options
context:
space:
mode:
authorAmir Hammad <amirhammad@users.noreply.github.com>2016-09-11 13:40:59 +0200
committerGitHub <noreply@github.com>2016-09-11 13:40:59 +0200
commit5e714edfa65f2f0d18fe9dc722ccd564a04e152a (patch)
tree5e310e07bdfb28e36d663ccdffbe65f78081187e /include/usbh_driver_hid.h
parent5615b9c938f6e4d05f7fae68b5329346df1238f9 (diff)
parentb7167bf2aff1a7c9cf223dc2a1d2e401f599d5d8 (diff)
downloadsecure-hid-5e714edfa65f2f0d18fe9dc722ccd564a04e152a.tar.gz
secure-hid-5e714edfa65f2f0d18fe9dc722ccd564a04e152a.tar.bz2
secure-hid-5e714edfa65f2f0d18fe9dc722ccd564a04e152a.zip
Merge pull request #4 from amirhammad/core-refactor
Major rework
Diffstat (limited to 'include/usbh_driver_hid.h')
-rw-r--r--include/usbh_driver_hid.h85
1 files changed, 85 insertions, 0 deletions
diff --git a/include/usbh_driver_hid.h b/include/usbh_driver_hid.h
new file mode 100644
index 0000000..8155d82
--- /dev/null
+++ b/include/usbh_driver_hid.h
@@ -0,0 +1,85 @@
+/*
+ * This file is part of the libusbhost library
+ * hosted at http://github.com/libusbhost/libusbhost
+ *
+ * Copyright (C) 2016 Amir Hammad <amir.hammad@hotmail.com>
+ *
+ *
+ * libusbhost is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef USBH_DRIVER_HID_
+#define USBH_DRIVER_HID_
+
+#include "usbh_core.h"
+
+#include <stdint.h>
+
+BEGIN_DECLS
+
+struct _hid_mouse_config {
+ /**
+ * @brief this is called when some data is read when polling the device
+ * @param device_id handle of HID device
+ * @param data pointer to the data
+ * @param length count of bytes in the data
+ *
+ * TODO: make better interface that provides data contained in the report descriptor
+ *
+ */
+ void (*hid_in_message_handler)(uint8_t device_id, const uint8_t *data, uint32_t length);
+};
+typedef struct _hid_mouse_config hid_config_t;
+
+/**
+ * @brief hid_mouse_driver_init initialization routine - this will initialize internal structures of this device driver
+ * @param config
+ * @see hid_mouse_config_t
+ */
+void hid_driver_init(const hid_config_t *config);
+
+/**
+ * @brief hid_set_report
+ * @param device_id handle of HID device
+ * @returns true on success, false otherwise
+ */
+bool hid_set_report(uint8_t device_id, uint8_t val);
+
+enum HID_TYPE {
+ HID_TYPE_NONE,
+ HID_TYPE_MOUSE,
+ HID_TYPE_KEYBOARD,
+};
+
+/**
+ * @brief hid_get_type
+ * @param device_id handle of HID device
+ * @return type of attached HID
+ * @see enum HID_TYPE
+ */
+enum HID_TYPE hid_get_type(uint8_t device_id);
+
+/**
+ * @brief hid_is_connected
+ * @param device_id handle of HID device
+ * @return true if the device with device_id is connected
+ */
+bool hid_is_connected(uint8_t device_id);
+
+extern const usbh_dev_driver_t usbh_hid_driver;
+
+END_DECLS
+
+#endif