USB: add generic usb-mouse device driver (EXPERIMENTAL)

[bertos.git] / bertos / drv / usb_hid.h

diff --git a/bertos/drv/usb_hid.h b/bertos/drv/usb_hid.h
new file mode 100644 (file)
index 0000000..0253809
--- /dev/null
+++ b/bertos/drv/usb_hid.h
@@ -0,0 +1,79 @@
+/**
+ * \file
+ * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
+ *
+ * -->
+ *
+ * \author Andrea Righi <arighi@develer.com>
+ *
+ * \brief Generic USB Human Interface Device (HID) driver.
+ */
+
+#ifndef USB_HID_H
+#define USB_HID_H
+
+/*
+ * USB HID interface subclass and protocol codes
+ */
+#define USB_INTERFACE_SUBCLASS_BOOT    1
+#define USB_INTERFACE_PROTOCOL_KEYBOARD        1
+#define USB_INTERFACE_PROTOCOL_MOUSE   2
+
+/*
+ * HID class requests
+ */
+#define HID_REQ_GET_REPORT             0x01
+#define HID_REQ_GET_IDLE               0x02
+#define HID_REQ_GET_PROTOCOL           0x03
+#define HID_REQ_SET_REPORT             0x09
+#define HID_REQ_SET_IDLE               0x0A
+#define HID_REQ_SET_PROTOCOL           0x0B
+
+/*
+ * HID class descriptor types
+ */
+#define HID_DT_HID             (USB_TYPE_CLASS | 0x01)
+#define HID_DT_REPORT          (USB_TYPE_CLASS | 0x02)
+#define HID_DT_PHYSICAL                (USB_TYPE_CLASS | 0x03)
+
+/*
+ * USB HID descriptor
+ */
+typedef struct usb_hid_descriptor
+{
+       uint8_t bLength;
+       uint8_t bDescriptorType;
+       uint16_t bcdHID;
+       uint8_t bCountryCode;
+       uint8_t bNumDescriptors;
+       uint8_t bDescriptorHidType;
+       uint16_t wDescriptorLength;
+} PACKED usb_hid_descriptor_t;
+
+#endif /* USB_HID_H */