Projects/AVRISP-MKII/AVRISPDescriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2021.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2021  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         /* Macros: */
  48                 /** Endpoint address of the AVRISP data OUT endpoint. */
  49                 #define AVRISP_DATA_OUT_EPADDR         (ENDPOINT_DIR_OUT | 2)
  50
  51                 /** Endpoint address of the AVRISP data IN endpoint. */
  52                 #define AVRISP_DATA_IN_EPADDR          (ENDPOINT_DIR_IN  | 2)
  53
  54                 /** Size in bytes of the AVRISP data endpoint. */
  55                 #define AVRISP_DATA_EPSIZE             64
  56
  57         /* Type Defines: */
  58                 /** Type define for the device configuration descriptor structure. This must be defined in the
  59                  *  application code, as the configuration descriptor contains several sub-descriptors which
  60                  *  vary between devices, and which describe the device's usage to the host.
  61                  */
  62                 typedef struct
  63                 {
  64                         USB_Descriptor_Configuration_Header_t    Config;
  65
  66                         // Atmel AVRISP-MKII Interface
  67                         USB_Descriptor_Interface_t               AVRISP_Interface;
  68                         USB_Descriptor_Endpoint_t                AVRISP_DataInEndpoint;
  69                         USB_Descriptor_Endpoint_t                AVRISP_DataOutEndpoint;
  70                 } AVRISP_USB_Descriptor_Configuration_t;
  71
  72                 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
  73                  *  should have a unique ID index associated with it, which can be used to refer to the
  74                  *  interface from other descriptors.
  75                  */
  76                 enum InterfaceDescriptors_t
  77                 {
  78                         INTERFACE_ID_AVRISP = 0, /**< AVRISP interface descriptor ID */
  79                 };
  80
  81                 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
  82                  *  have a unique ID index associated with it, which can be used to refer to the string from
  83                  *  other descriptors.
  84                  */
  85                 enum AVRISP_StringDescriptors_t
  86                 {
  87                         AVRISP_STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
  88                         AVRISP_STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
  89                         AVRISP_STRING_ID_Product      = 2, /**< Product string ID */
  90                         AVRISP_STRING_ID_Serial       = 3, /**< Serial number string ID */
  91                 };
  92
  93         /* Function Prototypes: */
  94                 uint16_t AVRISP_GetDescriptor(const uint16_t wValue,
  95                                               const uint16_t wIndex,
  96                                               const void** const DescriptorAddress)
  97                                               ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
  98
  99 #endif
 100