Demos/Device/Incomplete/Sideshow/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 #ifndef _DESCRIPTORS_H_
  32 #define _DESCRIPTORS_H_
  33
  34         /* Includes: */
  35                 #include <LUFA/Drivers/USB/USB.h>
  36
  37                 #include <avr/pgmspace.h>
  38
  39                 #include "Sideshow.h"
  40
  41         /* Macros: */
  42                 #define SIDESHOW_IN_EPNUM          3
  43                 #define SIDESHOW_OUT_EPNUM         4
  44                 #define SIDESHOW_IO_EPSIZE         64
  45
  46         /* Type Defines: */
  47                 typedef struct
  48                 {
  49                         USB_Descriptor_Configuration_Header_t Config;
  50                         USB_Descriptor_Interface_t            Interface;
  51                         USB_Descriptor_Endpoint_t             DataInEndpoint;
  52                         USB_Descriptor_Endpoint_t             DataOutEndpoint;
  53                 } USB_Descriptor_Configuration_t;
  54
  55                 typedef struct
  56                 {
  57                         USB_Descriptor_Header_t                Header;
  58
  59                         int                                    Signature[7];
  60                         uint16_t                               VendorCode;
  61                 } USB_OSDescriptor_t;
  62
  63                 typedef struct
  64                 {
  65                         uint8_t                                FirstInterfaceNumber;
  66
  67                         uint8_t                                RESERVED;
  68
  69                         uint8_t                                CompatibleID[8];
  70                         uint8_t                                SubCompatibleID[8];
  71
  72                         uint8_t                                RESERVED2[6];
  73                 } USB_OSCompatibleSection_t;
  74
  75                 typedef struct
  76                 {
  77                         uint32_t                               TotalLength;
  78                         uint16_t                               Version;
  79                         uint16_t                               Index;
  80                         uint8_t                                TotalSections;
  81
  82                         uint8_t                                RESERVED[7];
  83
  84                         USB_OSCompatibleSection_t              SideshowCompatID;
  85                 } USB_OSCompatibleIDDescriptor_t;
  86
  87         /* Function Prototypes: */
  88                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
  89                                                                             ATTR_WARN_UNUSED_RESULT ATTR_WEAK ATTR_NON_NULL_PTR_ARG(3);
  90
  91                 bool USB_GetOSFeatureDescriptor(const uint16_t wValue, const uint8_t wIndex,
  92                                                 void** const DescriptorAddress, uint16_t* const DescriptorSize)
  93                                                 ATTR_WARN_UNUSED_RESULT ATTR_WEAK ATTR_NON_NULL_PTR_ARG(3) ATTR_NON_NULL_PTR_ARG(4);
  94
  95 #endif