Bootloaders/DFU/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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                 #elif defined(__AVR_AT90USB1287__)
  69                         #define PRODUCT_ID_CODE               0x2FFB
  70                 #elif defined(__AVR_AT90USB646__)
  71                         #define PRODUCT_ID_CODE               0x2FF9
  72                 #elif defined(__AVR_AT90USB647__)
  73                         #define PRODUCT_ID_CODE               0x2FF9
  74                 #elif defined(__AVR_AT90USB162__)
  75                         #define PRODUCT_ID_CODE               0x2FFA
  76                 #elif defined(__AVR_AT90USB82__)
  77                         #define PRODUCT_ID_CODE               0x2FF7
  78                 #elif defined(__AVR_ATmega32U6__)
  79                         #define PRODUCT_ID_CODE               0x2FFB
  80                 #elif defined(__AVR_ATmega32U4__)
  81                         #define PRODUCT_ID_CODE               0x2FF4
  82                 #elif defined(__AVR_ATmega16U4__)
  83                         #define PRODUCT_ID_CODE               0x2FF3
  84                 #else
  85                         #error The selected AVR part is not currently supported by this bootloader.
  86                 #endif
  87
  88                 #if !defined(PRODUCT_ID_CODE)
  89                         #error Current AVR model is not supported by this bootloader.
  90                 #endif
  91
  92         /* Type Defines: */
  93                 /** Type define for a DFU class function descriptor. This descriptor gives DFU class information
  94                  *  to the host when read, indicating the DFU device's capabilities.
  95                  */
  96                 typedef struct
  97                 {
  98                         USB_Descriptor_Header_t               Header; /**< Standard descriptor header structure */
  99
 100                         uint8_t                               Attributes; /**< DFU device attributes, a mask comprising of the
 101                                                                             *  ATTR_* macros listed in this source file
 102                                                                             */
 103                         uint16_t                              DetatchTimeout; /**< Timeout in milliseconds between a USB_DETACH
 104                                                                                 *  command being issued and the device detaching
 105                                                                                 *  from the USB bus
 106                                                                                 */
 107                         uint16_t                              TransferSize; /**< Maximum number of bytes the DFU device can accept
 108                                                                               *  from the host in a transaction
 109                                                                               */
 110                         uint16_t                              DFUSpecification; /**< BCD packed DFU specification number this DFU
 111                                                                                   *  device complies with
 112                                                                                   */
 113                 } USB_DFU_Functional_Descriptor_t;
 114
 115                 /** Type define for the device configuration descriptor structure. This must be defined in the
 116                  *  application code, as the configuration descriptor contains several sub-descriptors which
 117                  *  vary between devices, and which describe the device's usage to the host.
 118                  */
 119                 typedef struct
 120                 {
 121                         USB_Descriptor_Configuration_Header_t Config;
 122                         USB_Descriptor_Interface_t            DFUInterface;
 123                         USB_DFU_Functional_Descriptor_t       DFUFunctional;
 124                 } USB_Descriptor_Configuration_t;
 125
 126         /* Function Prototypes: */
 127                 uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 128                                            ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 129
 130 #endif