git.gag.com Git - fw/stlink/blob - example/stm32f4/STM32_USB_OTG_Driver/inc/usb_conf_template.h

   1 /**
   2   ******************************************************************************
   3   * @file    usb_conf.h
   4   * @author  MCD Application Team
   5   * @version V2.0.0
   6   * @date    22-July-2011
   7   * @brief   general low level driver configuration
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
  12   * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
  13   * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
  14   * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
  15   * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
  16   * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
  17   *
  18   * <h2><center>&copy; COPYRIGHT 2011 STMicroelectronics</center></h2>
  19   ******************************************************************************
  20   */
  21
  22 /* Define to prevent recursive inclusion -------------------------------------*/
  23 #ifndef __USB_CONF__H__
  24 #define __USB_CONF__H__
  25
  26 /* Includes ------------------------------------------------------------------*/
  27 #include "stm32f2xx.h"
  28
  29
  30 /** @addtogroup USB_OTG_DRIVER
  31   * @{
  32   */
  33
  34 /** @defgroup USB_CONF
  35   * @brief USB low level driver configuration file
  36   * @{
  37   */
  38
  39 /** @defgroup USB_CONF_Exported_Defines
  40   * @{
  41   */
  42
  43 /* USB Core and PHY interface configuration.
  44    Tip: To avoid modifying these defines each time you need to change the USB
  45         configuration, you can declare the needed define in your toolchain
  46         compiler preprocessor.
  47    */
  48 #ifndef USE_USB_OTG_FS
  49  //#define USE_USB_OTG_FS
  50 #endif /* USE_USB_OTG_FS */
  51
  52 #ifndef USE_USB_OTG_HS
  53  //#define USE_USB_OTG_HS
  54 #endif /* USE_USB_OTG_HS */
  55
  56 #ifndef USE_ULPI_PHY
  57  //#define USE_ULPI_PHY
  58 #endif /* USE_ULPI_PHY */
  59
  60 #ifndef USE_EMBEDDED_PHY
  61  //#define USE_EMBEDDED_PHY
  62 #endif /* USE_EMBEDDED_PHY */
  63
  64 #ifndef USE_I2C_PHY
  65  //#define USE_I2C_PHY
  66 #endif /* USE_I2C_PHY */
  67
  68
  69 #ifdef USE_USB_OTG_FS
  70  #define USB_OTG_FS_CORE
  71 #endif
  72
  73 #ifdef USE_USB_OTG_HS
  74  #define USB_OTG_HS_CORE
  75 #endif
  76
  77 /*******************************************************************************
  78 *                      FIFO Size Configuration in Device mode
  79 *
  80 *  (i) Receive data FIFO size = RAM for setup packets +
  81 *                   OUT endpoint control information +
  82 *                   data OUT packets + miscellaneous
  83 *      Space = ONE 32-bits words
  84 *     --> RAM for setup packets = 10 spaces
  85 *        (n is the nbr of CTRL EPs the device core supports)
  86 *     --> OUT EP CTRL info      = 1 space
  87 *        (one space for status information written to the FIFO along with each
  88 *        received packet)
  89 *     --> data OUT packets      = (Largest Packet Size / 4) + 1 spaces
  90 *        (MINIMUM to receive packets)
  91 *     --> OR data OUT packets  = at least 2*(Largest Packet Size / 4) + 1 spaces
  92 *        (if high-bandwidth EP is enabled or multiple isochronous EPs)
  93 *     --> miscellaneous = 1 space per OUT EP
  94 *        (one space for transfer complete status information also pushed to the
  95 *        FIFO with each endpoint's last packet)
  96 *
  97 *  (ii)MINIMUM RAM space required for each IN EP Tx FIFO = MAX packet size for
  98 *       that particular IN EP. More space allocated in the IN EP Tx FIFO results
  99 *       in a better performance on the USB and can hide latencies on the AHB.
 100 *
 101 *  (iii) TXn min size = 16 words. (n  : Transmit FIFO index)
 102 *   (iv) When a TxFIFO is not used, the Configuration should be as follows:
 103 *       case 1 :  n > m    and Txn is not used    (n,m  : Transmit FIFO indexes)
 104 *       --> Txm can use the space allocated for Txn.
 105 *       case2  :  n < m    and Txn is not used    (n,m  : Transmit FIFO indexes)
 106 *       --> Txn should be configured with the minimum space of 16 words
 107 *  (v) The FIFO is used optimally when used TxFIFOs are allocated in the top
 108 *       of the FIFO.Ex: use EP1 and EP2 as IN instead of EP1 and EP3 as IN ones.
 109 *******************************************************************************/
 110
 111 /*******************************************************************************
 112 *                     FIFO Size Configuration in Host mode
 113 *
 114 *  (i) Receive data FIFO size = (Largest Packet Size / 4) + 1 or
 115 *                             2x (Largest Packet Size / 4) + 1,  If a
 116 *                             high-bandwidth channel or multiple isochronous
 117 *                             channels are enabled
 118 *
 119 *  (ii) For the host nonperiodic Transmit FIFO is the largest maximum packet size
 120 *      for all supported nonperiodic OUT channels. Typically, a space
 121 *      corresponding to two Largest Packet Size is recommended.
 122 *
 123 *  (iii) The minimum amount of RAM required for Host periodic Transmit FIFO is
 124 *        the largest maximum packet size for all supported periodic OUT channels.
 125 *        If there is at least one High Bandwidth Isochronous OUT endpoint,
 126 *        then the space must be at least two times the maximum packet size for
 127 *        that channel.
 128 *******************************************************************************/
 129
 130 /****************** USB OTG HS CONFIGURATION **********************************/
 131 #ifdef USB_OTG_HS_CORE
 132  #define RX_FIFO_HS_SIZE                          512
 133  #define TX0_FIFO_HS_SIZE                         512
 134  #define TX1_FIFO_HS_SIZE                         512
 135  #define TX2_FIFO_HS_SIZE                          0
 136  #define TX3_FIFO_HS_SIZE                          0
 137  #define TX4_FIFO_HS_SIZE                          0
 138  #define TX5_FIFO_HS_SIZE                          0
 139  #define TXH_NP_HS_FIFOSIZ                         96
 140  #define TXH_P_HS_FIFOSIZ                          96
 141
 142  //#define USB_OTG_HS_LOW_PWR_MGMT_SUPPORT
 143  //#define USB_OTG_HS_SOF_OUTPUT_ENABLED
 144
 145  //#define USB_OTG_INTERNAL_VBUS_ENABLED
 146  #define USB_OTG_EXTERNAL_VBUS_ENABLED
 147
 148  #ifdef USE_ULPI_PHY
 149   #define USB_OTG_ULPI_PHY_ENABLED
 150  #endif
 151  #ifdef USE_EMBEDDED_PHY
 152    #define USB_OTG_EMBEDDED_PHY_ENABLED
 153  #endif
 154  #ifdef USE_I2C_PHY
 155   #define USB_OTG_I2C_PHY_ENABLED
 156  #endif
 157  #define USB_OTG_HS_INTERNAL_DMA_ENABLED
 158  #define USB_OTG_HS_DEDICATED_EP1_ENABLED
 159 #endif
 160
 161 /****************** USB OTG FS CONFIGURATION **********************************/
 162 #ifdef USB_OTG_FS_CORE
 163  #define RX_FIFO_FS_SIZE                          128
 164  #define TX0_FIFO_FS_SIZE                          64
 165  #define TX1_FIFO_FS_SIZE                         128
 166  #define TX2_FIFO_FS_SIZE                          0
 167  #define TX3_FIFO_FS_SIZE                          0
 168  #define TXH_NP_HS_FIFOSIZ                         96
 169  #define TXH_P_HS_FIFOSIZ                          96
 170
 171  //#define USB_OTG_FS_LOW_PWR_MGMT_SUPPORT
 172  //#define USB_OTG_FS_SOF_OUTPUT_ENABLED
 173 #endif
 174
 175 /****************** USB OTG MODE CONFIGURATION ********************************/
 176 //#define USE_HOST_MODE
 177 #define USE_DEVICE_MODE
 178 //#define USE_OTG_MODE
 179
 180
 181 #ifndef USB_OTG_FS_CORE
 182  #ifndef USB_OTG_HS_CORE
 183     #error  "USB_OTG_HS_CORE or USB_OTG_FS_CORE should be defined"
 184  #endif
 185 #endif
 186
 187
 188 #ifndef USE_DEVICE_MODE
 189  #ifndef USE_HOST_MODE
 190     #error  "USE_DEVICE_MODE or USE_HOST_MODE should be defined"
 191  #endif
 192 #endif
 193
 194 #ifndef USE_USB_OTG_HS
 195  #ifndef USE_USB_OTG_FS
 196     #error  "USE_USB_OTG_HS or USE_USB_OTG_FS should be defined"
 197  #endif
 198 #else //USE_USB_OTG_HS
 199  #ifndef USE_ULPI_PHY
 200   #ifndef USE_EMBEDDED_PHY
 201    #ifndef USE_I2C_PHY
 202      #error  "USE_ULPI_PHY or USE_EMBEDDED_PHY or USE_I2C_PHY should be defined"
 203    #endif
 204   #endif
 205  #endif
 206 #endif
 207
 208 /****************** C Compilers dependant keywords ****************************/
 209 /* In HS mode and when the DMA is used, all variables and data structures dealing
 210    with the DMA during the transaction process should be 4-bytes aligned */
 211 #ifdef USB_OTG_HS_INTERNAL_DMA_ENABLED
 212   #if defined   (__GNUC__)        /* GNU Compiler */
 213     #define __ALIGN_END    __attribute__ ((aligned (4)))
 214     #define __ALIGN_BEGIN
 215   #else
 216     #define __ALIGN_END
 217     #if defined   (__CC_ARM)      /* ARM Compiler */
 218       #define __ALIGN_BEGIN    __align(4)
 219     #elif defined (__ICCARM__)    /* IAR Compiler */
 220       #define __ALIGN_BEGIN
 221     #elif defined  (__TASKING__)  /* TASKING Compiler */
 222       #define __ALIGN_BEGIN    __align(4)
 223     #endif /* __CC_ARM */
 224   #endif /* __GNUC__ */
 225 #else
 226   #define __ALIGN_BEGIN
 227   #define __ALIGN_END
 228 #endif /* USB_OTG_HS_INTERNAL_DMA_ENABLED */
 229
 230 /* __packed keyword used to decrease the data type alignment to 1-byte */
 231 #if defined (__CC_ARM)         /* ARM Compiler */
 232   #define __packed    __packed
 233 #elif defined (__ICCARM__)     /* IAR Compiler */
 234   #define __packed    __packed
 235 #elif defined   ( __GNUC__ )   /* GNU Compiler */
 236   #define __packed    __attribute__ ((__packed__))
 237 #elif defined   (__TASKING__)  /* TASKING Compiler */
 238   #define __packed    __unaligned
 239 #endif /* __CC_ARM */
 240
 241 /**
 242   * @}
 243   */
 244
 245
 246 /** @defgroup USB_CONF_Exported_Types
 247   * @{
 248   */
 249 /**
 250   * @}
 251   */
 252
 253
 254 /** @defgroup USB_CONF_Exported_Macros
 255   * @{
 256   */
 257 /**
 258   * @}
 259   */
 260
 261 /** @defgroup USB_CONF_Exported_Variables
 262   * @{
 263   */
 264 /**
 265   * @}
 266   */
 267
 268 /** @defgroup USB_CONF_Exported_FunctionsPrototype
 269   * @{
 270   */
 271 /**
 272   * @}
 273   */
 274
 275
 276 #endif //__USB_CONF__H__
 277
 278
 279 /**
 280   * @}
 281   */
 282
 283 /**
 284   * @}
 285   */
 286 /******************* (C) COPYRIGHT 2011 STMicroelectronics *****END OF FILE****/
 287