1 /**
2 ******************************************************************************
3 * @file stm32n6xx_hal_pcd_ex.c
4 * @author MCD Application Team
5 * @brief PCD Extended HAL module driver.
6 * This file provides firmware functions to manage the following
7 * functionalities of the USB Peripheral Controller:
8 * + Extended features functions
9 *
10 ******************************************************************************
11 * @attention
12 *
13 * Copyright (c) 2023 STMicroelectronics.
14 * All rights reserved.
15 *
16 * This software is licensed under terms that can be found in the LICENSE file
17 * in the root directory of this software component.
18 * If no LICENSE file comes with this software, it is provided AS-IS.
19 *
20 ******************************************************************************
21 */
22
23 /* Includes ------------------------------------------------------------------*/
24 #include "stm32n6xx_hal.h"
25
26 /** @addtogroup STM32N6xx_HAL_Driver
27 * @{
28 */
29
30 /** @defgroup PCDEx PCDEx
31 * @brief PCD Extended HAL module driver
32 * @{
33 */
34
35 #ifdef HAL_PCD_MODULE_ENABLED
36
37 #if defined (USB1_OTG_HS) || defined (USB2_OTG_HS)
38 /* Private types -------------------------------------------------------------*/
39 /* Private variables ---------------------------------------------------------*/
40 /* Private constants ---------------------------------------------------------*/
41 /* Private macros ------------------------------------------------------------*/
42 /* Private functions ---------------------------------------------------------*/
43 /* Exported functions --------------------------------------------------------*/
44
45 /** @defgroup PCDEx_Exported_Functions PCDEx Exported Functions
46 * @{
47 */
48
49 /** @defgroup PCDEx_Exported_Functions_Group1 Peripheral Control functions
50 * @brief PCDEx control functions
51 *
52 @verbatim
53 ===============================================================================
54 ##### Extended features functions #####
55 ===============================================================================
56 [..] This section provides functions allowing to:
57 (+) Update FIFO configuration
58
59 @endverbatim
60 * @{
61 */
62 #if defined (USB1_OTG_HS) || defined (USB2_OTG_HS)
63 /**
64 * @brief Set Tx FIFO
65 * @param hpcd PCD handle
66 * @param fifo The number of Tx fifo
67 * @param size Fifo size
68 * @retval HAL status
69 */
HAL_PCDEx_SetTxFiFo(PCD_HandleTypeDef * hpcd,uint8_t fifo,uint16_t size)70 HAL_StatusTypeDef HAL_PCDEx_SetTxFiFo(PCD_HandleTypeDef *hpcd, uint8_t fifo, uint16_t size)
71 {
72 uint8_t i;
73 uint32_t Tx_Offset;
74
75 /* TXn min size = 16 words. (n : Transmit FIFO index)
76 When a TxFIFO is not used, the Configuration should be as follows:
77 case 1 : n > m and Txn is not used (n,m : Transmit FIFO indexes)
78 --> Txm can use the space allocated for Txn.
79 case2 : n < m and Txn is not used (n,m : Transmit FIFO indexes)
80 --> Txn should be configured with the minimum space of 16 words
81 The FIFO is used optimally when used TxFIFOs are allocated in the top
82 of the FIFO.Ex: use EP1 and EP2 as IN instead of EP1 and EP3 as IN ones.
83 When DMA is used 3n * FIFO locations should be reserved for internal DMA registers */
84
85 Tx_Offset = hpcd->Instance->GRXFSIZ;
86
87 if (fifo == 0U)
88 {
89 hpcd->Instance->DIEPTXF0_HNPTXFSIZ = ((uint32_t)size << 16) | Tx_Offset;
90 }
91 else
92 {
93 Tx_Offset += (hpcd->Instance->DIEPTXF0_HNPTXFSIZ) >> 16;
94 for (i = 0U; i < (fifo - 1U); i++)
95 {
96 Tx_Offset += (hpcd->Instance->DIEPTXF[i] >> 16);
97 }
98
99 /* Multiply Tx_Size by 2 to get higher performance */
100 hpcd->Instance->DIEPTXF[fifo - 1U] = ((uint32_t)size << 16) | Tx_Offset;
101 }
102
103 return HAL_OK;
104 }
105
106 /**
107 * @brief Set Rx FIFO
108 * @param hpcd PCD handle
109 * @param size Size of Rx fifo
110 * @retval HAL status
111 */
HAL_PCDEx_SetRxFiFo(PCD_HandleTypeDef * hpcd,uint16_t size)112 HAL_StatusTypeDef HAL_PCDEx_SetRxFiFo(PCD_HandleTypeDef *hpcd, uint16_t size)
113 {
114 hpcd->Instance->GRXFSIZ = size;
115
116 return HAL_OK;
117 }
118
119 /**
120 * @brief Activate LPM feature.
121 * @param hpcd PCD handle
122 * @retval HAL status
123 */
HAL_PCDEx_ActivateLPM(PCD_HandleTypeDef * hpcd)124 HAL_StatusTypeDef HAL_PCDEx_ActivateLPM(PCD_HandleTypeDef *hpcd)
125 {
126 USB_OTG_GlobalTypeDef *USBx = hpcd->Instance;
127
128 hpcd->lpm_active = 1U;
129 hpcd->LPM_State = LPM_L0;
130 USBx->GINTMSK |= USB_OTG_GINTMSK_LPMINTM;
131 USBx->GLPMCFG |= (USB_OTG_GLPMCFG_LPMEN | USB_OTG_GLPMCFG_LPMACK | USB_OTG_GLPMCFG_ENBESL);
132
133 return HAL_OK;
134 }
135
136 /**
137 * @brief Deactivate LPM feature.
138 * @param hpcd PCD handle
139 * @retval HAL status
140 */
HAL_PCDEx_DeActivateLPM(PCD_HandleTypeDef * hpcd)141 HAL_StatusTypeDef HAL_PCDEx_DeActivateLPM(PCD_HandleTypeDef *hpcd)
142 {
143 USB_OTG_GlobalTypeDef *USBx = hpcd->Instance;
144
145 hpcd->lpm_active = 0U;
146 USBx->GINTMSK &= ~USB_OTG_GINTMSK_LPMINTM;
147 USBx->GLPMCFG &= ~(USB_OTG_GLPMCFG_LPMEN | USB_OTG_GLPMCFG_LPMACK | USB_OTG_GLPMCFG_ENBESL);
148
149 return HAL_OK;
150 }
151
152
153 /**
154 * @brief Handle BatteryCharging Process.
155 * @param hpcd PCD handle
156 * @retval HAL status
157 */
HAL_PCDEx_BCD_VBUSDetect(PCD_HandleTypeDef * hpcd)158 void HAL_PCDEx_BCD_VBUSDetect(PCD_HandleTypeDef *hpcd)
159 {
160 USB_OTG_GlobalTypeDef *USBx = hpcd->Instance;
161 uint32_t tickstart = HAL_GetTick();
162
163 /* Enable DCD : Data Contact Detect */
164 USBx->GCCFG |= USB_OTG_GCCFG_DCDETEN;
165
166 /* Wait for Min DCD Timeout */
167 HAL_Delay(300U);
168
169
170 /* Primary detection: checks if connected to Standard Downstream Port
171 (without charging capability) */
172 USBx->GCCFG &= ~USB_OTG_GCCFG_DCDETEN;
173 HAL_Delay(50U);
174 USBx->GCCFG |= USB_OTG_GCCFG_PDETEN;
175 HAL_Delay(50U);
176
177 if ((USBx->GCCFG & USB_OTG_GCCFG_CHGDET) == 0U)
178 {
179 /* Case of Standard Downstream Port */
180 #if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
181 hpcd->BCDCallback(hpcd, PCD_BCD_STD_DOWNSTREAM_PORT);
182 #else
183 HAL_PCDEx_BCD_Callback(hpcd, PCD_BCD_STD_DOWNSTREAM_PORT);
184 #endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
185 }
186 else
187 {
188 /* start secondary detection to check connection to Charging Downstream
189 Port or Dedicated Charging Port */
190 USBx->GCCFG &= ~(USB_OTG_GCCFG_PDETEN);
191 HAL_Delay(50U);
192 USBx->GCCFG |= USB_OTG_GCCFG_SDETEN;
193 HAL_Delay(50U);
194
195 if ((USBx->GCCFG & USB_OTG_GCCFG_FSVPLUS) == USB_OTG_GCCFG_FSVPLUS)
196 {
197 /* case Dedicated Charging Port */
198 #if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
199 hpcd->BCDCallback(hpcd, PCD_BCD_DEDICATED_CHARGING_PORT);
200 #else
201 HAL_PCDEx_BCD_Callback(hpcd, PCD_BCD_DEDICATED_CHARGING_PORT);
202 #endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
203 }
204 else
205 {
206 /* case Charging Downstream Port */
207 #if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
208 hpcd->BCDCallback(hpcd, PCD_BCD_CHARGING_DOWNSTREAM_PORT);
209 #else
210 HAL_PCDEx_BCD_Callback(hpcd, PCD_BCD_CHARGING_DOWNSTREAM_PORT);
211 #endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
212 }
213 }
214
215 /* Battery Charging capability discovery finished */
216 (void)HAL_PCDEx_DeActivateBCD(hpcd);
217
218 /* Check for the Timeout, else start USB Device */
219 if ((HAL_GetTick() - tickstart) > 1000U)
220 {
221 #if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
222 hpcd->BCDCallback(hpcd, PCD_BCD_ERROR);
223 #else
224 HAL_PCDEx_BCD_Callback(hpcd, PCD_BCD_ERROR);
225 #endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
226 }
227 else
228 {
229 #if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
230 hpcd->BCDCallback(hpcd, PCD_BCD_DISCOVERY_COMPLETED);
231 #else
232 HAL_PCDEx_BCD_Callback(hpcd, PCD_BCD_DISCOVERY_COMPLETED);
233 #endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
234 }
235 }
236
237 /**
238 * @brief Activate BatteryCharging feature.
239 * @param hpcd PCD handle
240 * @retval HAL status
241 */
HAL_PCDEx_ActivateBCD(PCD_HandleTypeDef * hpcd)242 HAL_StatusTypeDef HAL_PCDEx_ActivateBCD(PCD_HandleTypeDef *hpcd)
243 {
244 USB_OTG_GlobalTypeDef *USBx = hpcd->Instance;
245
246 USBx->GCCFG &= ~(USB_OTG_GCCFG_PDETEN);
247 USBx->GCCFG &= ~(USB_OTG_GCCFG_SDETEN);
248
249 hpcd->battery_charging_active = 1U;
250
251 return HAL_OK;
252 }
253
254 /**
255 * @brief Deactivate BatteryCharging feature.
256 * @param hpcd PCD handle
257 * @retval HAL status
258 */
HAL_PCDEx_DeActivateBCD(PCD_HandleTypeDef * hpcd)259 HAL_StatusTypeDef HAL_PCDEx_DeActivateBCD(PCD_HandleTypeDef *hpcd)
260 {
261 USB_OTG_GlobalTypeDef *USBx = hpcd->Instance;
262
263 USBx->GCCFG &= ~(USB_OTG_GCCFG_PDETEN);
264 USBx->GCCFG &= ~(USB_OTG_GCCFG_SDETEN);
265
266 hpcd->battery_charging_active = 0U;
267
268 return HAL_OK;
269 }
270
271 #endif /* defined (USB1_OTG_HS) || defined (USB2_OTG_HS) */
272
273 /**
274 * @brief Send LPM message to user layer callback.
275 * @param hpcd PCD handle
276 * @param msg LPM message
277 * @retval HAL status
278 */
HAL_PCDEx_LPM_Callback(PCD_HandleTypeDef * hpcd,PCD_LPM_MsgTypeDef msg)279 __weak void HAL_PCDEx_LPM_Callback(PCD_HandleTypeDef *hpcd, PCD_LPM_MsgTypeDef msg)
280 {
281 /* Prevent unused argument(s) compilation warning */
282 UNUSED(hpcd);
283 UNUSED(msg);
284
285 /* NOTE : This function should not be modified, when the callback is needed,
286 the HAL_PCDEx_LPM_Callback could be implemented in the user file
287 */
288 }
289
290 /**
291 * @brief Send BatteryCharging message to user layer callback.
292 * @param hpcd PCD handle
293 * @param msg LPM message
294 * @retval HAL status
295 */
HAL_PCDEx_BCD_Callback(PCD_HandleTypeDef * hpcd,PCD_BCD_MsgTypeDef msg)296 __weak void HAL_PCDEx_BCD_Callback(PCD_HandleTypeDef *hpcd, PCD_BCD_MsgTypeDef msg)
297 {
298 /* Prevent unused argument(s) compilation warning */
299 UNUSED(hpcd);
300 UNUSED(msg);
301
302 /* NOTE : This function should not be modified, when the callback is needed,
303 the HAL_PCDEx_BCD_Callback could be implemented in the user file
304 */
305 }
306
307 /**
308 * @}
309 */
310
311 /**
312 * @}
313 */
314 #endif /* defined (USB1_OTG_HS) || defined (USB2_OTG_HS) */
315 #endif /* HAL_PCD_MODULE_ENABLED */
316
317 /**
318 * @}
319 */
320
321 /**
322 * @}
323 */
324
