Projects/AVRISP-MKII/AVRISPDescriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  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 disclaims 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 <avr/pgmspace.h>
  41
  42                 #include <LUFA/Drivers/USB/USB.h>
  43                 #include <LUFA/Drivers/Board/LEDs.h>
  44
  45                 #include "Config/AppConfig.h"
  46
  47         /* Preprocessor Checks: */
  48                 #if defined(LIBUSB_DRIVER_COMPAT) && defined(RESET_TOGGLES_LIBUSB_COMPAT)
  49                         #error LIBUSB_DRIVER_COMPAT and RESET_TOGGLES_LIBUSB_COMPAT are mutually exclusive.
  50                 #endif
  51
  52         /* Macros: */
  53                 /** Endpoint address of the AVRISP data OUT endpoint. */
  54                 #define AVRISP_DATA_OUT_EPADDR         (ENDPOINT_DIR_OUT | 2)
  55
  56                 /** Endpoint address of the AVRISP data IN endpoint, when in Jungo driver compatibility mode. */
  57                 #define AVRISP_DATA_IN_EPADDR_JUNGO    (ENDPOINT_DIR_IN  | 2)
  58
  59                 /** Endpoint address of the AVRISP data IN endpoint, when in LibUSB driver compatibility mode. */
  60                 #define AVRISP_DATA_IN_EPADDR_LIBUSB   (ENDPOINT_DIR_IN  | 3)
  61
  62                 #if defined(RESET_TOGGLES_LIBUSB_COMPAT)
  63                         #define AVRISP_DATA_IN_EPADDR      AVRISP_CurrDataINEndpointAddress
  64                 #elif defined(LIBUSB_DRIVER_COMPAT)
  65                         #define AVRISP_DATA_IN_EPADDR      AVRISP_DATA_IN_EPADDR_LIBUSB
  66                 #else
  67                         /** Endpoint address of the AVRISP data IN endpoint. */
  68                         #define AVRISP_DATA_IN_EPADDR      AVRISP_DATA_IN_EPADDR_JUNGO
  69                 #endif
  70
  71                 /** Size in bytes of the AVRISP data endpoint. */
  72                 #define AVRISP_DATA_EPSIZE             64
  73
  74         /* Type Defines: */
  75                 /** Type define for the device configuration descriptor structure. This must be defined in the
  76                  *  application code, as the configuration descriptor contains several sub-descriptors which
  77                  *  vary between devices, and which describe the device's usage to the host.
  78                  */
  79                 typedef struct
  80                 {
  81                         USB_Descriptor_Configuration_Header_t    Config;
  82
  83                         // Atmel AVRISP-MKII Interface
  84                         USB_Descriptor_Interface_t               AVRISP_Interface;
  85                         USB_Descriptor_Endpoint_t                AVRISP_DataInEndpoint;
  86                         USB_Descriptor_Endpoint_t                AVRISP_DataOutEndpoint;
  87                 } AVRISP_USB_Descriptor_Configuration_t;
  88
  89                 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
  90                  *  should have a unique ID index associated with it, which can be used to refer to the
  91                  *  interface from other descriptors.
  92                  */
  93                 enum InterfaceDescriptors_t
  94                 {
  95                         INTERFACE_ID_AVRISP = 0, /**< AVRISP interface descriptor ID */
  96                 };
  97
  98                 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
  99                  *  have a unique ID index associated with it, which can be used to refer to the string from
 100                  *  other descriptors.
 101                  */
 102                 enum AVRISP_StringDescriptors_t
 103                 {
 104                         AVRISP_STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
 105                         AVRISP_STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
 106                         AVRISP_STRING_ID_Product      = 2, /**< Product string ID */
 107                         AVRISP_STRING_ID_Serial       = 3, /**< Serial number string ID */
 108                 };
 109
 110         /* External Variables: */
 111                 #if defined(RESET_TOGGLES_LIBUSB_COMPAT)
 112                         extern uint8_t AVRISP_CurrDataINEndpointAddress;
 113                 #endif
 114
 115         /* Function Prototypes: */
 116                 uint16_t AVRISP_GetDescriptor(const uint16_t wValue,
 117                                               const uint8_t wIndex,
 118                                               const void** const DescriptorAddress,
 119                                               uint8_t* const DescriptorMemorySpace)
 120                                               ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3) ATTR_NON_NULL_PTR_ARG(4);
 121
 122                 #if defined(RESET_TOGGLES_LIBUSB_COMPAT)
 123                 void CheckExternalReset(void) ATTR_NAKED ATTR_INIT_SECTION(3);
 124                 void UpdateCurrentCompatibilityMode(void);
 125                 #endif
 126
 127 #endif
 128