protocol/lufa/descriptor.h

   1 /*
   2  * Copyright 2012 Jun Wako <wakojun@gmail.com>
   3  * This file is based on:
   4  *     LUFA-120219/Demos/Device/Lowlevel/KeyboardMouse
   5  *     LUFA-120219/Demos/Device/Lowlevel/GenericHID
   6  */
   7
   8 /*
   9              LUFA Library
  10      Copyright (C) Dean Camera, 2012.
  11
  12   dean [at] fourwalledcubicle [dot] com
  13            www.lufa-lib.org
  14 */
  15
  16 /*
  17   Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  18   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
  19
  20   Permission to use, copy, modify, distribute, and sell this
  21   software and its documentation for any purpose is hereby granted
  22   without fee, provided that the above copyright notice appear in
  23   all copies and that both that the copyright notice and this
  24   permission notice and warranty disclaimer appear in supporting
  25   documentation, and that the name of the author not be used in
  26   advertising or publicity pertaining to distribution of the
  27   software without specific, written prior permission.
  28
  29   The author disclaim all warranties with regard to this
  30   software, including all implied warranties of merchantability
  31   and fitness.  In no event shall the author be liable for any
  32   special, indirect or consequential damages or any damages
  33   whatsoever resulting from loss of use, data or profits, whether
  34   in an action of contract, negligence or other tortious action,
  35   arising out of or in connection with the use or performance of
  36   this software.
  37 */
  38
  39 /** \file
  40  *
  41  *  Header file for Descriptors.c.
  42  */
  43
  44 #ifndef _DESCRIPTORS_H_
  45 #define _DESCRIPTORS_H_
  46
  47 #include <LUFA/Drivers/USB/USB.h>
  48 #include <avr/pgmspace.h>
  49
  50
  51 typedef struct
  52 {
  53     USB_Descriptor_Configuration_Header_t Config;
  54
  55     // Keyboard HID Interface
  56     USB_Descriptor_Interface_t            Keyboard_Interface;
  57     USB_HID_Descriptor_HID_t              Keyboard_HID;
  58     USB_Descriptor_Endpoint_t             Keyboard_INEndpoint;
  59
  60 #ifdef MOUSE_ENABLE
  61     // Mouse HID Interface
  62     USB_Descriptor_Interface_t            Mouse_Interface;
  63     USB_HID_Descriptor_HID_t              Mouse_HID;
  64     USB_Descriptor_Endpoint_t             Mouse_INEndpoint;
  65 #endif
  66
  67 #ifdef EXTRAKEY_ENABLE
  68     // Extrakey HID Interface
  69     USB_Descriptor_Interface_t            Extrakey_Interface;
  70     USB_HID_Descriptor_HID_t              Extrakey_HID;
  71     USB_Descriptor_Endpoint_t             Extrakey_INEndpoint;
  72 #endif
  73
  74 #ifdef CONSOLE_ENABLE
  75     // Console HID Interface
  76     USB_Descriptor_Interface_t            Console_Interface;
  77     USB_HID_Descriptor_HID_t              Console_HID;
  78     USB_Descriptor_Endpoint_t             Console_INEndpoint;
  79     USB_Descriptor_Endpoint_t             Console_OUTEndpoint;
  80 #endif
  81 } USB_Descriptor_Configuration_t;
  82
  83
  84 /* index of interface */
  85 #define KEYBOARD_INTERFACE          0
  86
  87 #ifdef MOUSE_ENABLE
  88 #   define MOUSE_INTERFACE          (KEYBOARD_INTERFACE + 1)
  89 #else
  90 #   define MOUSE_INTERFACE          KEYBOARD_INTERFACE
  91 #endif
  92
  93 #ifdef EXTRAKEY_ENABLE
  94 #   define EXTRAKEY_INTERFACE       (MOUSE_INTERFACE + 1)
  95 #else
  96 #   define EXTRAKEY_INTERFACE       MOUSE_INTERFACE
  97 #endif
  98
  99 #ifdef CONSOLE_ENABLE
 100 #   define CONSOLE_INTERFACE        (EXTRAKEY_INTERFACE + 1)
 101 #else
 102 #   define CONSOLE_INTERFACE        EXTRAKEY_INTERFACE
 103 #endif
 104
 105
 106 /* nubmer of interfaces */
 107 #define TOTAL_INTERFACES            (CONSOLE_INTERFACE + 1)
 108
 109
 110 // Endopoint number and size
 111 #define KEYBOARD_IN_EPNUM           1
 112
 113 #ifdef MOUSE_ENABLE
 114 #   define MOUSE_IN_EPNUM           (KEYBOARD_IN_EPNUM + 1)
 115 #else
 116 #   define MOUSE_IN_EPNUM           KEYBOARD_IN_EPNUM
 117 #endif
 118
 119 #ifdef EXTRAKEY_ENABLE
 120 #   define EXTRAKEY_IN_EPNUM        (MOUSE_IN_EPNUM + 1)
 121 #else
 122 #   define EXTRAKEY_IN_EPNUM        MOUSE_IN_EPNUM
 123 #endif
 124
 125 #ifdef CONSOLE_ENABLE
 126 #   define CONSOLE_IN_EPNUM         (EXTRAKEY_IN_EPNUM + 1)
 127 #   define CONSOLE_OUT_EPNUM        (EXTRAKEY_IN_EPNUM + 2)
 128 #endif
 129
 130
 131 #define KEYBOARD_EPSIZE             8
 132 #define MOUSE_EPSIZE                8
 133 #define EXTRAKEY_EPSIZE             8
 134 #define CONSOLE_EPSIZE              32
 135
 136
 137 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 138                                     const uint8_t wIndex,
 139                                     const void** const DescriptorAddress)
 140                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 141
 142 #endif