PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

targets/cmsis/TARGET_STM/TARGET_STM32F7/stm32f7xx_hal_pcd_ex.c@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phungductung 0:e87aa4c49e95 1 /**
phungductung 0:e87aa4c49e95 2 ******************************************************************************
phungductung 0:e87aa4c49e95 3 * @file stm32f7xx_hal_pcd_ex.c
phungductung 0:e87aa4c49e95 4 * @author MCD Application Team
phungductung 0:e87aa4c49e95 5 * @version V1.0.4
phungductung 0:e87aa4c49e95 6 * @date 09-December-2015
phungductung 0:e87aa4c49e95 7 * @brief PCD HAL module driver.
phungductung 0:e87aa4c49e95 8 * This file provides firmware functions to manage the following
phungductung 0:e87aa4c49e95 9 * functionalities of the USB Peripheral Controller:
phungductung 0:e87aa4c49e95 10 * + Extended features functions
phungductung 0:e87aa4c49e95 11 *
phungductung 0:e87aa4c49e95 12 ******************************************************************************
phungductung 0:e87aa4c49e95 13 * @attention
phungductung 0:e87aa4c49e95 14 *
phungductung 0:e87aa4c49e95 15 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
phungductung 0:e87aa4c49e95 16 *
phungductung 0:e87aa4c49e95 17 * Redistribution and use in source and binary forms, with or without modification,
phungductung 0:e87aa4c49e95 18 * are permitted provided that the following conditions are met:
phungductung 0:e87aa4c49e95 19 * 1. Redistributions of source code must retain the above copyright notice,
phungductung 0:e87aa4c49e95 20 * this list of conditions and the following disclaimer.
phungductung 0:e87aa4c49e95 21 * 2. Redistributions in binary form must reproduce the above copyright notice,
phungductung 0:e87aa4c49e95 22 * this list of conditions and the following disclaimer in the documentation
phungductung 0:e87aa4c49e95 23 * and/or other materials provided with the distribution.
phungductung 0:e87aa4c49e95 24 * 3. Neither the name of STMicroelectronics nor the names of its contributors
phungductung 0:e87aa4c49e95 25 * may be used to endorse or promote products derived from this software
phungductung 0:e87aa4c49e95 26 * without specific prior written permission.
phungductung 0:e87aa4c49e95 27 *
phungductung 0:e87aa4c49e95 28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
phungductung 0:e87aa4c49e95 29 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
phungductung 0:e87aa4c49e95 30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
phungductung 0:e87aa4c49e95 31 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
phungductung 0:e87aa4c49e95 32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
phungductung 0:e87aa4c49e95 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
phungductung 0:e87aa4c49e95 34 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
phungductung 0:e87aa4c49e95 35 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
phungductung 0:e87aa4c49e95 36 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
phungductung 0:e87aa4c49e95 37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
phungductung 0:e87aa4c49e95 38 *
phungductung 0:e87aa4c49e95 39 ******************************************************************************
phungductung 0:e87aa4c49e95 40 */
phungductung 0:e87aa4c49e95 41
phungductung 0:e87aa4c49e95 42 /* Includes ------------------------------------------------------------------*/
phungductung 0:e87aa4c49e95 43 #include "stm32f7xx_hal.h"
phungductung 0:e87aa4c49e95 44
phungductung 0:e87aa4c49e95 45 /** @addtogroup STM32F7xx_HAL_Driver
phungductung 0:e87aa4c49e95 46 * @{
phungductung 0:e87aa4c49e95 47 */
phungductung 0:e87aa4c49e95 48
phungductung 0:e87aa4c49e95 49 /** @defgroup PCDEx PCDEx
phungductung 0:e87aa4c49e95 50 * @brief PCD Extended HAL module driver
phungductung 0:e87aa4c49e95 51 * @{
phungductung 0:e87aa4c49e95 52 */
phungductung 0:e87aa4c49e95 53 #ifdef HAL_PCD_MODULE_ENABLED
phungductung 0:e87aa4c49e95 54
phungductung 0:e87aa4c49e95 55 /* Private types -------------------------------------------------------------*/
phungductung 0:e87aa4c49e95 56 /* Private variables ---------------------------------------------------------*/
phungductung 0:e87aa4c49e95 57 /* Private constants ---------------------------------------------------------*/
phungductung 0:e87aa4c49e95 58 /* Private macros ------------------------------------------------------------*/
phungductung 0:e87aa4c49e95 59 /* Private functions ---------------------------------------------------------*/
phungductung 0:e87aa4c49e95 60 /* Exported functions --------------------------------------------------------*/
phungductung 0:e87aa4c49e95 61
phungductung 0:e87aa4c49e95 62 /** @defgroup PCDEx_Exported_Functions PCD Extended Exported Functions
phungductung 0:e87aa4c49e95 63 * @{
phungductung 0:e87aa4c49e95 64 */
phungductung 0:e87aa4c49e95 65
phungductung 0:e87aa4c49e95 66 /** @defgroup PCDEx_Exported_Functions_Group1 Peripheral Control functions
phungductung 0:e87aa4c49e95 67 * @brief PCDEx control functions
phungductung 0:e87aa4c49e95 68 *
phungductung 0:e87aa4c49e95 69 @verbatim
phungductung 0:e87aa4c49e95 70 ===============================================================================
phungductung 0:e87aa4c49e95 71 ##### Extended features functions #####
phungductung 0:e87aa4c49e95 72 ===============================================================================
phungductung 0:e87aa4c49e95 73 [..] This section provides functions allowing to:
phungductung 0:e87aa4c49e95 74 (+) Update FIFO configuration
phungductung 0:e87aa4c49e95 75
phungductung 0:e87aa4c49e95 76 @endverbatim
phungductung 0:e87aa4c49e95 77 * @{
phungductung 0:e87aa4c49e95 78 */
phungductung 0:e87aa4c49e95 79
phungductung 0:e87aa4c49e95 80 /**
phungductung 0:e87aa4c49e95 81 * @brief Set Tx FIFO
phungductung 0:e87aa4c49e95 82 * @param hpcd: PCD handle
phungductung 0:e87aa4c49e95 83 * @param fifo: The number of Tx fifo
phungductung 0:e87aa4c49e95 84 * @param size: Fifo size
phungductung 0:e87aa4c49e95 85 * @retval HAL status
phungductung 0:e87aa4c49e95 86 */
phungductung 0:e87aa4c49e95 87 HAL_StatusTypeDef HAL_PCDEx_SetTxFiFo(PCD_HandleTypeDef *hpcd, uint8_t fifo, uint16_t size)
phungductung 0:e87aa4c49e95 88 {
phungductung 0:e87aa4c49e95 89 uint8_t i = 0;
phungductung 0:e87aa4c49e95 90 uint32_t Tx_Offset = 0;
phungductung 0:e87aa4c49e95 91
phungductung 0:e87aa4c49e95 92 /* TXn min size = 16 words. (n : Transmit FIFO index)
phungductung 0:e87aa4c49e95 93 When a TxFIFO is not used, the Configuration should be as follows:
phungductung 0:e87aa4c49e95 94 case 1 : n > m and Txn is not used (n,m : Transmit FIFO indexes)
phungductung 0:e87aa4c49e95 95 --> Txm can use the space allocated for Txn.
phungductung 0:e87aa4c49e95 96 case2 : n < m and Txn is not used (n,m : Transmit FIFO indexes)
phungductung 0:e87aa4c49e95 97 --> Txn should be configured with the minimum space of 16 words
phungductung 0:e87aa4c49e95 98 The FIFO is used optimally when used TxFIFOs are allocated in the top
phungductung 0:e87aa4c49e95 99 of the FIFO.Ex: use EP1 and EP2 as IN instead of EP1 and EP3 as IN ones.
phungductung 0:e87aa4c49e95 100 When DMA is used 3n * FIFO locations should be reserved for internal DMA registers */
phungductung 0:e87aa4c49e95 101
phungductung 0:e87aa4c49e95 102 Tx_Offset = hpcd->Instance->GRXFSIZ;
phungductung 0:e87aa4c49e95 103
phungductung 0:e87aa4c49e95 104 if(fifo == 0)
phungductung 0:e87aa4c49e95 105 {
phungductung 0:e87aa4c49e95 106 hpcd->Instance->DIEPTXF0_HNPTXFSIZ = (uint32_t)(((uint32_t)size << 16) | Tx_Offset);
phungductung 0:e87aa4c49e95 107 }
phungductung 0:e87aa4c49e95 108 else
phungductung 0:e87aa4c49e95 109 {
phungductung 0:e87aa4c49e95 110 Tx_Offset += (hpcd->Instance->DIEPTXF0_HNPTXFSIZ) >> 16;
phungductung 0:e87aa4c49e95 111 for (i = 0; i < (fifo - 1); i++)
phungductung 0:e87aa4c49e95 112 {
phungductung 0:e87aa4c49e95 113 Tx_Offset += (hpcd->Instance->DIEPTXF[i] >> 16);
phungductung 0:e87aa4c49e95 114 }
phungductung 0:e87aa4c49e95 115
phungductung 0:e87aa4c49e95 116 /* Multiply Tx_Size by 2 to get higher performance */
phungductung 0:e87aa4c49e95 117 hpcd->Instance->DIEPTXF[fifo - 1] = (uint32_t)(((uint32_t)size << 16) | Tx_Offset);
phungductung 0:e87aa4c49e95 118 }
phungductung 0:e87aa4c49e95 119
phungductung 0:e87aa4c49e95 120 return HAL_OK;
phungductung 0:e87aa4c49e95 121 }
phungductung 0:e87aa4c49e95 122
phungductung 0:e87aa4c49e95 123 /**
phungductung 0:e87aa4c49e95 124 * @brief Set Rx FIFO
phungductung 0:e87aa4c49e95 125 * @param hpcd: PCD handle
phungductung 0:e87aa4c49e95 126 * @param size: Size of Rx fifo
phungductung 0:e87aa4c49e95 127 * @retval HAL status
phungductung 0:e87aa4c49e95 128 */
phungductung 0:e87aa4c49e95 129 HAL_StatusTypeDef HAL_PCDEx_SetRxFiFo(PCD_HandleTypeDef *hpcd, uint16_t size)
phungductung 0:e87aa4c49e95 130 {
phungductung 0:e87aa4c49e95 131 hpcd->Instance->GRXFSIZ = size;
phungductung 0:e87aa4c49e95 132
phungductung 0:e87aa4c49e95 133 return HAL_OK;
phungductung 0:e87aa4c49e95 134 }
phungductung 0:e87aa4c49e95 135
phungductung 0:e87aa4c49e95 136 /**
phungductung 0:e87aa4c49e95 137 * @brief Activate LPM Feature
phungductung 0:e87aa4c49e95 138 * @param hpcd: PCD handle
phungductung 0:e87aa4c49e95 139 * @retval HAL status
phungductung 0:e87aa4c49e95 140 */
phungductung 0:e87aa4c49e95 141 HAL_StatusTypeDef HAL_PCDEx_ActivateLPM(PCD_HandleTypeDef *hpcd)
phungductung 0:e87aa4c49e95 142 {
phungductung 0:e87aa4c49e95 143 USB_OTG_GlobalTypeDef *USBx = hpcd->Instance;
phungductung 0:e87aa4c49e95 144
phungductung 0:e87aa4c49e95 145 hpcd->lpm_active = ENABLE;
phungductung 0:e87aa4c49e95 146 hpcd->LPM_State = LPM_L0;
phungductung 0:e87aa4c49e95 147 USBx->GINTMSK |= USB_OTG_GINTMSK_LPMINTM;
phungductung 0:e87aa4c49e95 148 USBx->GLPMCFG |= (USB_OTG_GLPMCFG_LPMEN | USB_OTG_GLPMCFG_LPMACK | USB_OTG_GLPMCFG_ENBESL);
phungductung 0:e87aa4c49e95 149
phungductung 0:e87aa4c49e95 150 return HAL_OK;
phungductung 0:e87aa4c49e95 151 }
phungductung 0:e87aa4c49e95 152
phungductung 0:e87aa4c49e95 153 /**
phungductung 0:e87aa4c49e95 154 * @brief DeActivate LPM feature.
phungductung 0:e87aa4c49e95 155 * @param hpcd: PCD handle
phungductung 0:e87aa4c49e95 156 * @retval HAL status
phungductung 0:e87aa4c49e95 157 */
phungductung 0:e87aa4c49e95 158 HAL_StatusTypeDef HAL_PCDEx_DeActivateLPM(PCD_HandleTypeDef *hpcd)
phungductung 0:e87aa4c49e95 159 {
phungductung 0:e87aa4c49e95 160 USB_OTG_GlobalTypeDef *USBx = hpcd->Instance;
phungductung 0:e87aa4c49e95 161
phungductung 0:e87aa4c49e95 162 hpcd->lpm_active = DISABLE;
phungductung 0:e87aa4c49e95 163 USBx->GINTMSK &= ~USB_OTG_GINTMSK_LPMINTM;
phungductung 0:e87aa4c49e95 164 USBx->GLPMCFG &= ~(USB_OTG_GLPMCFG_LPMEN | USB_OTG_GLPMCFG_LPMACK | USB_OTG_GLPMCFG_ENBESL);
phungductung 0:e87aa4c49e95 165
phungductung 0:e87aa4c49e95 166 return HAL_OK;
phungductung 0:e87aa4c49e95 167 }
phungductung 0:e87aa4c49e95 168
phungductung 0:e87aa4c49e95 169 /**
phungductung 0:e87aa4c49e95 170 * @brief Send LPM message to user layer callback.
phungductung 0:e87aa4c49e95 171 * @param hpcd: PCD handle
phungductung 0:e87aa4c49e95 172 * @param msg: LPM message
phungductung 0:e87aa4c49e95 173 * @retval HAL status
phungductung 0:e87aa4c49e95 174 */
phungductung 0:e87aa4c49e95 175 __weak void HAL_PCDEx_LPM_Callback(PCD_HandleTypeDef *hpcd, PCD_LPM_MsgTypeDef msg)
phungductung 0:e87aa4c49e95 176 {
phungductung 0:e87aa4c49e95 177 /* Prevent unused argument(s) compilation warning */
phungductung 0:e87aa4c49e95 178 UNUSED(hpcd);
phungductung 0:e87aa4c49e95 179 UNUSED(msg);
phungductung 0:e87aa4c49e95 180
phungductung 0:e87aa4c49e95 181 /* NOTE : This function Should not be modified, when the callback is needed,
phungductung 0:e87aa4c49e95 182 the HAL_PCDEx_LPM_Callback could be implemented in the user file
phungductung 0:e87aa4c49e95 183 */
phungductung 0:e87aa4c49e95 184 }
phungductung 0:e87aa4c49e95 185
phungductung 0:e87aa4c49e95 186 /**
phungductung 0:e87aa4c49e95 187 * @}
phungductung 0:e87aa4c49e95 188 */
phungductung 0:e87aa4c49e95 189
phungductung 0:e87aa4c49e95 190 /**
phungductung 0:e87aa4c49e95 191 * @}
phungductung 0:e87aa4c49e95 192 */
phungductung 0:e87aa4c49e95 193
phungductung 0:e87aa4c49e95 194 #endif /* HAL_PCD_MODULE_ENABLED */
phungductung 0:e87aa4c49e95 195 /**
phungductung 0:e87aa4c49e95 196 * @}
phungductung 0:e87aa4c49e95 197 */
phungductung 0:e87aa4c49e95 198
phungductung 0:e87aa4c49e95 199 /**
phungductung 0:e87aa4c49e95 200 * @}
phungductung 0:e87aa4c49e95 201 */
phungductung 0:e87aa4c49e95 202
phungductung 0:e87aa4c49e95 203 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/