tmk_core/protocol/arm_atsam/usb/udc_desc.h

   1 /**
   2  * \file
   3  *
   4  * \brief Common API for USB Device Interface
   5  *
   6  * Copyright (c) 2009-2015 Atmel Corporation. All rights reserved.
   7  *
   8  * \asf_license_start
   9  *
  10  * \page License
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions are met:
  14  *
  15  * 1. Redistributions of source code must retain the above copyright notice,
  16  *    this list of conditions and the following disclaimer.
  17  *
  18  * 2. Redistributions in binary form must reproduce the above copyright notice,
  19  *    this list of conditions and the following disclaimer in the documentation
  20  *    and/or other materials provided with the distribution.
  21  *
  22  * 3. The name of Atmel may not be used to endorse or promote products derived
  23  *    from this software without specific prior written permission.
  24  *
  25  * 4. This software may only be redistributed and used in connection with an
  26  *    Atmel microcontroller product.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
  29  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
  31  * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
  32  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  37  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38  * POSSIBILITY OF SUCH DAMAGE.
  39  *
  40  * \asf_license_stop
  41  *
  42  */
  43 /*
  44  * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
  45  */
  46
  47 #ifndef _UDC_DESC_H_
  48 #define _UDC_DESC_H_
  49
  50 #include "conf_usb.h"
  51 #include "usb_protocol.h"
  52 #include "udi.h"
  53
  54 #ifdef __cplusplus
  55 extern "C" {
  56 #endif
  57
  58 /**
  59  * \ingroup udc_group
  60  * \defgroup udc_desc_group USB Device Descriptor
  61  *
  62  * @{
  63  */
  64
  65 /**
  66  * \brief Defines the memory's location of USB descriptors
  67  *
  68  * By default the Descriptor is stored in RAM
  69  * (UDC_DESC_STORAGE is defined empty).
  70  *
  71  * If you have need to free RAM space,
  72  * it is possible to put descriptor in flash in following case:
  73  * - USB driver authorize flash transfer (USBB on UC3 and USB on Mega)
  74  * - USB Device is not high speed (UDC no need to change USB descriptors)
  75  *
  76  * For UC3 application used "const".
  77  *
  78  * For Mega application used "code".
  79  */
  80 #define  UDC_DESC_STORAGE
  81     // Descriptor storage in internal RAM
  82 #if (defined UDC_DATA_USE_HRAM_SUPPORT)
  83 #if defined(__GNUC__)
  84 #define UDC_DATA(x)              COMPILER_WORD_ALIGNED __attribute__((__section__(".data_hram0")))
  85 #define UDC_BSS(x)               COMPILER_ALIGNED(x)   __attribute__((__section__(".bss_hram0")))
  86 #elif defined(__ICCAVR32__)
  87 #define UDC_DATA(x)              COMPILER_ALIGNED(x)   __data32
  88 #define UDC_BSS(x)               COMPILER_ALIGNED(x)   __data32
  89 #endif
  90 #else
  91 #define UDC_DATA(x)              COMPILER_ALIGNED(x)
  92 #define UDC_BSS(x)               COMPILER_ALIGNED(x)
  93 #endif
  94
  95
  96
  97 /**
  98  * \brief Configuration descriptor and UDI link for one USB speed
  99  */
 100 typedef struct {
 101     //! USB configuration descriptor
 102     usb_conf_desc_t UDC_DESC_STORAGE *desc;
 103     //! Array of UDI API pointer
 104     udi_api_t UDC_DESC_STORAGE *UDC_DESC_STORAGE * udi_apis;
 105 } udc_config_speed_t;
 106
 107
 108 /**
 109  * \brief All information about the USB Device
 110  */
 111 typedef struct {
 112     //! USB device descriptor for low or full speed
 113     usb_dev_desc_t UDC_DESC_STORAGE *confdev_lsfs;
 114     //! USB configuration descriptor and UDI API pointers for low or full speed
 115     udc_config_speed_t UDC_DESC_STORAGE *conf_lsfs;
 116 #ifdef USB_DEVICE_HS_SUPPORT
 117     //! USB device descriptor for high speed
 118     usb_dev_desc_t UDC_DESC_STORAGE *confdev_hs;
 119     //! USB device qualifier, only use in high speed mode
 120     usb_dev_qual_desc_t UDC_DESC_STORAGE *qualifier;
 121     //! USB configuration descriptor and UDI API pointers for high speed
 122     udc_config_speed_t UDC_DESC_STORAGE *conf_hs;
 123 #endif
 124     usb_dev_bos_desc_t UDC_DESC_STORAGE *conf_bos;
 125 } udc_config_t;
 126
 127 //! Global variables of USB Device Descriptor and UDI links
 128 extern UDC_DESC_STORAGE udc_config_t udc_config;
 129
 130 //@}
 131
 132 #ifdef __cplusplus
 133 }
 134 #endif
 135 #endif // _UDC_DESC_H_