bertos/drv/usb_hid.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \author Andrea Righi <arighi@develer.com>
  34  *
  35  * \brief Generic USB Human Interface Device (HID) driver.
  36  */
  37
  38 #ifndef USB_HID_H
  39 #define USB_HID_H
  40
  41 #include <cpu/types.h>
  42
  43 /*
  44  * USB HID interface subclass and protocol codes
  45  */
  46 #define USB_INTERFACE_SUBCLASS_BOOT     1
  47 #define USB_INTERFACE_PROTOCOL_KEYBOARD 1
  48 #define USB_INTERFACE_PROTOCOL_MOUSE    2
  49
  50 /*
  51  * HID class requests
  52  */
  53 #define HID_REQ_GET_REPORT              0x01
  54 #define HID_REQ_GET_IDLE                0x02
  55 #define HID_REQ_GET_PROTOCOL            0x03
  56 #define HID_REQ_SET_REPORT              0x09
  57 #define HID_REQ_SET_IDLE                0x0A
  58 #define HID_REQ_SET_PROTOCOL            0x0B
  59
  60 /*
  61  * HID class descriptor types
  62  */
  63 #define HID_DT_HID              (USB_TYPE_CLASS | 0x01)
  64 #define HID_DT_REPORT           (USB_TYPE_CLASS | 0x02)
  65 #define HID_DT_PHYSICAL         (USB_TYPE_CLASS | 0x03)
  66
  67 /*
  68  * USB HID descriptor
  69  */
  70 typedef struct usb_HidDesc
  71 {
  72         uint8_t bLength;
  73         uint8_t bDescriptorType;
  74         uint16_t bcdHID;
  75         uint8_t bCountryCode;
  76         uint8_t bNumDescriptors;
  77         uint8_t bDescriptorHidType;
  78         uint16_t wDescriptorLength;
  79 } PACKED usb_HidDesc;
  80
  81 #endif /* USB_HID_H */