Projects/AVRISP-MKII/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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/Common/Common.h>
  41                 #include <LUFA/Drivers/USB/USB.h>
  42
  43                 #if (ARCH == ARCH_AVR8)
  44                         #include <avr/pgmspace.h>
  45                 #endif
  46
  47         /* Macros: */
  48                 #if (ARCH == ARCH_UC3) // TODO: FIXME
  49                         #define PROGMEM const
  50                 #endif
  51
  52                 #if !defined(LIBUSB_DRIVER_COMPAT)
  53                         /** Endpoint number of the AVRISP data OUT endpoint. */
  54                         #define AVRISP_DATA_OUT_EPNUM      2
  55
  56                         /** Endpoint number of the AVRISP data IN endpoint. */
  57                         #define AVRISP_DATA_IN_EPNUM       2
  58                 #else
  59                         /** Endpoint number of the AVRISP data OUT endpoint. */
  60                         #define AVRISP_DATA_OUT_EPNUM      2
  61
  62                         /** Endpoint number of the AVRISP data IN endpoint. */
  63                         #define AVRISP_DATA_IN_EPNUM       3
  64                 #endif
  65
  66                 /** Size in bytes of the AVRISP data endpoint. */
  67                 #define AVRISP_DATA_EPSIZE             64
  68
  69         /* Type Defines: */
  70                 /** Type define for the device configuration descriptor structure. This must be defined in the
  71                  *  application code, as the configuration descriptor contains several sub-descriptors which
  72                  *  vary between devices, and which describe the device's usage to the host.
  73                  */
  74                 typedef struct
  75                 {
  76                         USB_Descriptor_Configuration_Header_t    Config;
  77                         USB_Descriptor_Interface_t               AVRISP_Interface;
  78                         USB_Descriptor_Endpoint_t                AVRISP_DataInEndpoint;
  79                         USB_Descriptor_Endpoint_t                AVRISP_DataOutEndpoint;
  80                 } ATTR_PACKED USB_Descriptor_Configuration_t;
  81
  82         /* Function Prototypes: */
  83                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
  84                                                     const uint8_t wIndex,
  85                                                     const void** const DescriptorAddress)
  86                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
  87
  88 #endif
  89