Bootloaders/DFU/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for Descriptors.c.
  34  */
  35
  36 #ifndef _DESCRIPTORS_H_
  37 #define _DESCRIPTORS_H_
  38
  39         /* Includes: */
  40                 #include <LUFA/Drivers/USB/USB.h>
  41
  42         /* Macros: */
  43                 /** Descriptor type value for a DFU class functional descriptor. */
  44                 #define DTYPE_DFUFunctional               0x21
  45
  46                 /** DFU attribute mask, indicating that the DFU device will detach and re-attach when a DFU_DETACH
  47                  *  command is issued, rather than the host issuing a USB Reset.
  48                  */
  49                 #define ATTR_WILL_DETATCH                 (1 << 3)
  50
  51                 /** DFU attribute mask, indicating that the DFU device can communicate during the manifestation phase
  52                  *  (memory programming phase).
  53                  */
  54                 #define ATTR_MANEFESTATION_TOLLERANT      (1 << 2)
  55
  56                 /** DFU attribute mask, indicating that the DFU device can accept DFU_UPLOAD requests to send data from
  57                  *  the device to the host.
  58                  */
  59                 #define ATTR_CAN_UPLOAD                   (1 << 1)
  60
  61                 /** DFU attribute mask, indicating that the DFU device can accept DFU_DNLOAD requests to send data from
  62                  *  the host to the device.
  63                  */
  64                 #define ATTR_CAN_DOWNLOAD                 (1 << 0)
  65
  66                 #if defined(__AVR_AT90USB1286__)
  67                         #define PRODUCT_ID_CODE               0x2FFB
  68                         #define AVR_SIGNATURE_1               0x1E
  69                         #define AVR_SIGNATURE_2               0x97
  70                         #define AVR_SIGNATURE_3               0x82
  71                 #elif defined(__AVR_AT90USB1287__)
  72                         #define PRODUCT_ID_CODE               0x2FFB
  73                         #define AVR_SIGNATURE_1               0x1E
  74                         #define AVR_SIGNATURE_2               0x97
  75                         #define AVR_SIGNATURE_3               0x82
  76                 #elif defined(__AVR_AT90USB646__)
  77                         #define PRODUCT_ID_CODE               0x2FF9
  78                         #define AVR_SIGNATURE_1               0x1E
  79                         #define AVR_SIGNATURE_2               0x96
  80                         #define AVR_SIGNATURE_3               0x82
  81                 #elif defined(__AVR_ATmega32U6__)
  82                         #define PRODUCT_ID_CODE               0x2FFB
  83                         #define AVR_SIGNATURE_1               0x1E
  84                         #define AVR_SIGNATURE_2               0x95
  85                         #define AVR_SIGNATURE_3               0x88
  86                 #elif defined(__AVR_AT90USB647__)
  87                         #define PRODUCT_ID_CODE               0x2FF9
  88                         #define AVR_SIGNATURE_1               0x1E
  89                         #define AVR_SIGNATURE_2               0x96
  90                         #define AVR_SIGNATURE_3               0x82
  91                 #elif defined(__AVR_ATmega32U4__)
  92                         #define PRODUCT_ID_CODE               0x2FF4
  93                         #define AVR_SIGNATURE_1               0x1E
  94                         #define AVR_SIGNATURE_2               0x95
  95                         #define AVR_SIGNATURE_3               0x87
  96                 #elif defined(__AVR_ATmega16U4__)
  97                         #define PRODUCT_ID_CODE               0x2FF3
  98                         #define AVR_SIGNATURE_1               0x1E
  99                         #define AVR_SIGNATURE_2               0x94
 100                         #define AVR_SIGNATURE_3               0x88
 101                 #elif defined(__AVR_AT90USB162__)
 102                         #define PRODUCT_ID_CODE               0x2FFA
 103                         #define AVR_SIGNATURE_1               0x1E
 104                         #define AVR_SIGNATURE_2               0x94
 105                         #define AVR_SIGNATURE_3               0x82
 106                 #elif defined(__AVR_ATmega8U2__)
 107                         #define PRODUCT_ID_CODE               0x2FF7
 108                         #define AVR_SIGNATURE_1               0x1E
 109                         #define AVR_SIGNATURE_2               0x93
 110                         #define AVR_SIGNATURE_3               0x82
 111                 #elif defined(__AVR_ATmega16U2__)
 112                         #define PRODUCT_ID_CODE               0x2FEF
 113                         #define AVR_SIGNATURE_1               0x1E
 114                         #define AVR_SIGNATURE_2               0x94
 115                         #define AVR_SIGNATURE_3               0x89
 116                 #elif defined(__AVR_AT90USB82__)
 117                         #define PRODUCT_ID_CODE               0x2FEE
 118                         #define AVR_SIGNATURE_1               0x1E
 119                         #define AVR_SIGNATURE_2               0x93
 120                         #define AVR_SIGNATURE_3               0x89
 121                 #else
 122                         #error The selected AVR part is not currently supported by this bootloader.
 123                 #endif
 124
 125                 #if !defined(PRODUCT_ID_CODE)
 126                         #error Current AVR model is not supported by this bootloader.
 127                 #endif
 128
 129         /* Type Defines: */
 130                 /** Type define for a DFU class function descriptor. This descriptor gives DFU class information
 131                  *  to the host when read, indicating the DFU device's capabilities.
 132                  */
 133                 typedef struct
 134                 {
 135                         USB_Descriptor_Header_t               Header; /**< Standard descriptor header structure */
 136
 137                         uint8_t                               Attributes; /**< DFU device attributes, a mask comprising of the
 138                                                                             *  ATTR_* macros listed in this source file
 139                                                                             */
 140                         uint16_t                              DetachTimeout; /**< Timeout in milliseconds between a USB_DETACH
 141                                                                                 *  command being issued and the device detaching
 142                                                                                 *  from the USB bus
 143                                                                                 */
 144                         uint16_t                              TransferSize; /**< Maximum number of bytes the DFU device can accept
 145                                                                               *  from the host in a transaction
 146                                                                               */
 147                         uint16_t                              DFUSpecification; /**< BCD packed DFU specification number this DFU
 148                                                                                   *  device complies with
 149                                                                                   */
 150                 } USB_DFU_Functional_Descriptor_t;
 151
 152                 /** Type define for the device configuration descriptor structure. This must be defined in the
 153                  *  application code, as the configuration descriptor contains several sub-descriptors which
 154                  *  vary between devices, and which describe the device's usage to the host.
 155                  */
 156                 typedef struct
 157                 {
 158                         USB_Descriptor_Configuration_Header_t Config;
 159                         USB_Descriptor_Interface_t            DFUInterface;
 160                         USB_DFU_Functional_Descriptor_t       DFUFunctional;
 161                 } USB_Descriptor_Configuration_t;
 162
 163         /* Function Prototypes: */
 164                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 165                                                                                         ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 166
 167 #endif