Mercurial > public > ostc4

comparison Common/Drivers/STM32F4xx_HAL_DRIVER_v120/Src/stm32f4xx_hal_cortex.c @ 38:5f11787b4f42

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
include in ostc4 repository
author heinrichsweikamp
date Sat, 28 Apr 2018 11:52:34 +0200
parents
children
comparison
equal deleted inserted replaced
37:ccc45c0e1ea2 38:5f11787b4f42
1 /**
2 ******************************************************************************
3 * @file stm32f4xx_hal_cortex.c
4 * @author MCD Application Team
5 * @version V1.2.0
6 * @date 26-December-2014
7 * @brief CORTEX HAL module driver.
8 * This file provides firmware functions to manage the following
9 * functionalities of the CORTEX:
10 * + Initialization and de-initialization functions
11 * + Peripheral Control functions
12 *
13 @verbatim
14 ==============================================================================
15 ##### How to use this driver #####
16 ==============================================================================
17
18 [..]
19 *** How to configure Interrupts using CORTEX HAL driver ***
20 ===========================================================
21 [..]
22 This section provides functions allowing to configure the NVIC interrupts (IRQ).
23 The Cortex-M4 exceptions are managed by CMSIS functions.
24
25 (#) Configure the NVIC Priority Grouping using HAL_NVIC_SetPriorityGrouping()
26 function according to the following table.
27 (#) Configure the priority of the selected IRQ Channels using HAL_NVIC_SetPriority().
28 (#) Enable the selected IRQ Channels using HAL_NVIC_EnableIRQ().
29 (#) please refer to programing manual for details in how to configure priority.
30
31 -@- When the NVIC_PRIORITYGROUP_0 is selected, IRQ preemption is no more possible.
32 The pending IRQ priority will be managed only by the sub priority.
33
34 -@- IRQ priority order (sorted by highest to lowest priority):
35 (+@) Lowest preemption priority
36 (+@) Lowest sub priority
37 (+@) Lowest hardware priority (IRQ number)
38
39 [..]
40 *** How to configure Systick using CORTEX HAL driver ***
41 ========================================================
42 [..]
43 Setup SysTick Timer for time base.
44
45 (+) The HAL_SYSTICK_Config() function calls the SysTick_Config() function which
46 is a CMSIS function that:
47 (++) Configures the SysTick Reload register with value passed as function parameter.
48 (++) Configures the SysTick IRQ priority to the lowest value (0x0F).
49 (++) Resets the SysTick Counter register.
50 (++) Configures the SysTick Counter clock source to be Core Clock Source (HCLK).
51 (++) Enables the SysTick Interrupt.
52 (++) Starts the SysTick Counter.
53
54 (+) You can change the SysTick Clock source to be HCLK_Div8 by calling the macro
55 __HAL_CORTEX_SYSTICKCLK_CONFIG(SYSTICK_CLKSOURCE_HCLK_DIV8) just after the
56 HAL_SYSTICK_Config() function call. The __HAL_CORTEX_SYSTICKCLK_CONFIG() macro is defined
57 inside the stm32f4xx_hal_cortex.h file.
58
59 (+) You can change the SysTick IRQ priority by calling the
60 HAL_NVIC_SetPriority(SysTick_IRQn,...) function just after the HAL_SYSTICK_Config() function
61 call. The HAL_NVIC_SetPriority() call the NVIC_SetPriority() function which is a CMSIS function.
62
63 (+) To adjust the SysTick time base, use the following formula:
64
65 Reload Value = SysTick Counter Clock (Hz) x Desired Time base (s)
66 (++) Reload Value is the parameter to be passed for HAL_SYSTICK_Config() function
67 (++) Reload Value should not exceed 0xFFFFFF
68
69 @endverbatim
70 ******************************************************************************
71 * @attention
72 *
73 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
74 *
75 * Redistribution and use in source and binary forms, with or without modification,
76 * are permitted provided that the following conditions are met:
77 * 1. Redistributions of source code must retain the above copyright notice,
78 * this list of conditions and the following disclaimer.
79 * 2. Redistributions in binary form must reproduce the above copyright notice,
80 * this list of conditions and the following disclaimer in the documentation
81 * and/or other materials provided with the distribution.
82 * 3. Neither the name of STMicroelectronics nor the names of its contributors
83 * may be used to endorse or promote products derived from this software
84 * without specific prior written permission.
85 *
86 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
87 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
88 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
89 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
90 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
91 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
92 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
93 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
94 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
95 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
96 *
97 ******************************************************************************
98 */
99
100 /* Includes ------------------------------------------------------------------*/
101 #include "stm32f4xx_hal.h"
102
103 /** @addtogroup STM32F4xx_HAL_Driver
104 * @{
105 */
106
107 /** @defgroup CORTEX CORTEX
108 * @brief CORTEX HAL module driver
109 * @{
110 */
111
112 #ifdef HAL_CORTEX_MODULE_ENABLED
113
114 /* Private types -------------------------------------------------------------*/
115 /* Private variables ---------------------------------------------------------*/
116 /* Private constants ---------------------------------------------------------*/
117 /* Private macros ------------------------------------------------------------*/
118 /* Private functions ---------------------------------------------------------*/
119 /* Exported functions --------------------------------------------------------*/
120
121 /** @defgroup CORTEX_Exported_Functions CORTEX Exported Functions
122 * @{
123 */
124
125
126 /** @defgroup CORTEX_Exported_Functions_Group1 Initialization and de-initialization functions
127 * @brief Initialization and Configuration functions
128 *
129 @verbatim
130 ==============================================================================
131 ##### Initialization and de-initialization functions #####
132 ==============================================================================
133 [..]
134 This section provides the CORTEX HAL driver functions allowing to configure Interrupts
135 Systick functionalities
136
137 @endverbatim
138 * @{
139 */
140
141
142 /**
143 * @brief Sets the priority grouping field (preemption priority and subpriority)
144 * using the required unlock sequence.
145 * @param PriorityGroup: The priority grouping bits length.
146 * This parameter can be one of the following values:
147 * @arg NVIC_PRIORITYGROUP_0: 0 bits for preemption priority
148 * 4 bits for subpriority
149 * @arg NVIC_PRIORITYGROUP_1: 1 bits for preemption priority
150 * 3 bits for subpriority
151 * @arg NVIC_PRIORITYGROUP_2: 2 bits for preemption priority
152 * 2 bits for subpriority
153 * @arg NVIC_PRIORITYGROUP_3: 3 bits for preemption priority
154 * 1 bits for subpriority
155 * @arg NVIC_PRIORITYGROUP_4: 4 bits for preemption priority
156 * 0 bits for subpriority
157 * @note When the NVIC_PriorityGroup_0 is selected, IRQ preemption is no more possible.
158 * The pending IRQ priority will be managed only by the subpriority.
159 * @retval None
160 */
161 void HAL_NVIC_SetPriorityGrouping(uint32_t PriorityGroup)
162 {
163 /* Check the parameters */
164 assert_param(IS_NVIC_PRIORITY_GROUP(PriorityGroup));
165
166 /* Set the PRIGROUP[10:8] bits according to the PriorityGroup parameter value */
167 NVIC_SetPriorityGrouping(PriorityGroup);
168 }
169
170 /**
171 * @brief Sets the priority of an interrupt.
172 * @param IRQn: External interrupt number.
173 * This parameter can be an enumerator of IRQn_Type enumeration
174 * (For the complete STM32 Devices IRQ Channels list, please refer to the appropriate CMSIS device file (stm32f4xxxx.h))
175 * @param PreemptPriority: The preemption priority for the IRQn channel.
176 * This parameter can be a value between 0 and 15
177 * A lower priority value indicates a higher priority
178 * @param SubPriority: the subpriority level for the IRQ channel.
179 * This parameter can be a value between 0 and 15
180 * A lower priority value indicates a higher priority.
181 * @retval None
182 */
183 void HAL_NVIC_SetPriority(IRQn_Type IRQn, uint32_t PreemptPriority, uint32_t SubPriority)
184 {
185 uint32_t prioritygroup = 0x00;
186
187 /* Check the parameters */
188 assert_param(IS_NVIC_SUB_PRIORITY(SubPriority));
189 assert_param(IS_NVIC_PREEMPTION_PRIORITY(PreemptPriority));
190
191 prioritygroup = NVIC_GetPriorityGrouping();
192
193 NVIC_SetPriority(IRQn, NVIC_EncodePriority(prioritygroup, PreemptPriority, SubPriority));
194 }
195
196 /**
197 * @brief Enables a device specific interrupt in the NVIC interrupt controller.
198 * @note To configure interrupts priority correctly, the NVIC_PriorityGroupConfig()
199 * function should be called before.
200 * @param IRQn External interrupt number.
201 * This parameter can be an enumerator of IRQn_Type enumeration
202 * (For the complete STM32 Devices IRQ Channels list, please refer to the appropriate CMSIS device file (stm32f4xxxx.h))
203 * @retval None
204 */
205 void HAL_NVIC_EnableIRQ(IRQn_Type IRQn)
206 {
207 /* Check the parameters */
208 assert_param(IS_NVIC_DEVICE_IRQ(IRQn));
209
210 /* Enable interrupt */
211 NVIC_EnableIRQ(IRQn);
212 }
213
214 /**
215 * @brief Disables a device specific interrupt in the NVIC interrupt controller.
216 * @param IRQn External interrupt number.
217 * This parameter can be an enumerator of IRQn_Type enumeration
218 * (For the complete STM32 Devices IRQ Channels list, please refer to the appropriate CMSIS device file (stm32f4xxxx.h))
219 * @retval None
220 */
221 void HAL_NVIC_DisableIRQ(IRQn_Type IRQn)
222 {
223 /* Check the parameters */
224 assert_param(IS_NVIC_DEVICE_IRQ(IRQn));
225
226 /* Disable interrupt */
227 NVIC_DisableIRQ(IRQn);
228 }
229
230 /**
231 * @brief Initiates a system reset request to reset the MCU.
232 * @retval None
233 */
234 void HAL_NVIC_SystemReset(void)
235 {
236 /* System Reset */
237 NVIC_SystemReset();
238 }
239
240 /**
241 * @brief Initializes the System Timer and its interrupt, and starts the System Tick Timer.
242 * Counter is in free running mode to generate periodic interrupts.
243 * @param TicksNumb: Specifies the ticks Number of ticks between two interrupts.
244 * @retval status: - 0 Function succeeded.
245 * - 1 Function failed.
246 */
247 uint32_t HAL_SYSTICK_Config(uint32_t TicksNumb)
248 {
249 return SysTick_Config(TicksNumb);
250 }
251 /**
252 * @}
253 */
254
255 /** @defgroup CORTEX_Exported_Functions_Group2 Peripheral Control functions
256 * @brief Cortex control functions
257 *
258 @verbatim
259 ==============================================================================
260 ##### Peripheral Control functions #####
261 ==============================================================================
262 [..]
263 This subsection provides a set of functions allowing to control the CORTEX
264 (NVIC, SYSTICK) functionalities.
265
266
267 @endverbatim
268 * @{
269 */
270
271 /**
272 * @brief Gets the priority grouping field from the NVIC Interrupt Controller.
273 * @retval Priority grouping field (SCB->AIRCR [10:8] PRIGROUP field)
274 */
275 uint32_t HAL_NVIC_GetPriorityGrouping(void)
276 {
277 /* Get the PRIGROUP[10:8] field value */
278 return NVIC_GetPriorityGrouping();
279 }
280
281 /**
282 * @brief Gets the priority of an interrupt.
283 * @param IRQn: External interrupt number.
284 * This parameter can be an enumerator of IRQn_Type enumeration
285 * (For the complete STM32 Devices IRQ Channels list, please refer to the appropriate CMSIS device file (stm32f4xxxx.h))
286 * @param PriorityGroup: the priority grouping bits length.
287 * This parameter can be one of the following values:
288 * @arg NVIC_PRIORITYGROUP_0: 0 bits for preemption priority
289 * 4 bits for subpriority
290 * @arg NVIC_PRIORITYGROUP_1: 1 bits for preemption priority
291 * 3 bits for subpriority
292 * @arg NVIC_PRIORITYGROUP_2: 2 bits for preemption priority
293 * 2 bits for subpriority
294 * @arg NVIC_PRIORITYGROUP_3: 3 bits for preemption priority
295 * 1 bits for subpriority
296 * @arg NVIC_PRIORITYGROUP_4: 4 bits for preemption priority
297 * 0 bits for subpriority
298 * @param pPreemptPriority: Pointer on the Preemptive priority value (starting from 0).
299 * @param pSubPriority: Pointer on the Subpriority value (starting from 0).
300 * @retval None
301 */
302 void HAL_NVIC_GetPriority(IRQn_Type IRQn, uint32_t PriorityGroup, uint32_t *pPreemptPriority, uint32_t *pSubPriority)
303 {
304 /* Check the parameters */
305 assert_param(IS_NVIC_PRIORITY_GROUP(PriorityGroup));
306 /* Get priority for Cortex-M system or device specific interrupts */
307 NVIC_DecodePriority(NVIC_GetPriority(IRQn), PriorityGroup, pPreemptPriority, pSubPriority);
308 }
309
310 /**
311 * @brief Sets Pending bit of an external interrupt.
312 * @param IRQn External interrupt number
313 * This parameter can be an enumerator of IRQn_Type enumeration
314 * (For the complete STM32 Devices IRQ Channels list, please refer to the appropriate CMSIS device file (stm32f4xxxx.h))
315 * @retval None
316 */
317 void HAL_NVIC_SetPendingIRQ(IRQn_Type IRQn)
318 {
319 /* Check the parameters */
320 assert_param(IS_NVIC_DEVICE_IRQ(IRQn));
321
322 /* Set interrupt pending */
323 NVIC_SetPendingIRQ(IRQn);
324 }
325
326 /**
327 * @brief Gets Pending Interrupt (reads the pending register in the NVIC
328 * and returns the pending bit for the specified interrupt).
329 * @param IRQn External interrupt number.
330 * This parameter can be an enumerator of IRQn_Type enumeration
331 * (For the complete STM32 Devices IRQ Channels list, please refer to the appropriate CMSIS device file (stm32f4xxxx.h))
332 * @retval status: - 0 Interrupt status is not pending.
333 * - 1 Interrupt status is pending.
334 */
335 uint32_t HAL_NVIC_GetPendingIRQ(IRQn_Type IRQn)
336 {
337 /* Check the parameters */
338 assert_param(IS_NVIC_DEVICE_IRQ(IRQn));
339
340 /* Return 1 if pending else 0 */
341 return NVIC_GetPendingIRQ(IRQn);
342 }
343
344 /**
345 * @brief Clears the pending bit of an external interrupt.
346 * @param IRQn External interrupt number.
347 * This parameter can be an enumerator of IRQn_Type enumeration
348 * (For the complete STM32 Devices IRQ Channels list, please refer to the appropriate CMSIS device file (stm32f4xxxx.h))
349 * @retval None
350 */
351 void HAL_NVIC_ClearPendingIRQ(IRQn_Type IRQn)
352 {
353 /* Check the parameters */
354 assert_param(IS_NVIC_DEVICE_IRQ(IRQn));
355
356 /* Clear pending interrupt */
357 NVIC_ClearPendingIRQ(IRQn);
358 }
359
360 /**
361 * @brief Gets active interrupt ( reads the active register in NVIC and returns the active bit).
362 * @param IRQn External interrupt number
363 * This parameter can be an enumerator of IRQn_Type enumeration
364 * (For the complete STM32 Devices IRQ Channels list, please refer to the appropriate CMSIS device file (stm32f4xxxx.h))
365 * @retval status: - 0 Interrupt status is not pending.
366 * - 1 Interrupt status is pending.
367 */
368 uint32_t HAL_NVIC_GetActive(IRQn_Type IRQn)
369 {
370 /* Check the parameters */
371 assert_param(IS_NVIC_DEVICE_IRQ(IRQn));
372
373 /* Return 1 if active else 0 */
374 return NVIC_GetActive(IRQn);
375 }
376
377 /**
378 * @brief Configures the SysTick clock source.
379 * @param CLKSource: specifies the SysTick clock source.
380 * This parameter can be one of the following values:
381 * @arg SYSTICK_CLKSOURCE_HCLK_DIV8: AHB clock divided by 8 selected as SysTick clock source.
382 * @arg SYSTICK_CLKSOURCE_HCLK: AHB clock selected as SysTick clock source.
383 * @retval None
384 */
385 void HAL_SYSTICK_CLKSourceConfig(uint32_t CLKSource)
386 {
387 /* Check the parameters */
388 assert_param(IS_SYSTICK_CLK_SOURCE(CLKSource));
389 if (CLKSource == SYSTICK_CLKSOURCE_HCLK)
390 {
391 SysTick->CTRL |= SYSTICK_CLKSOURCE_HCLK;
392 }
393 else
394 {
395 SysTick->CTRL &= ~SYSTICK_CLKSOURCE_HCLK;
396 }
397 }
398
399 /**
400 * @brief This function handles SYSTICK interrupt request.
401 * @retval None
402 */
403 void HAL_SYSTICK_IRQHandler(void)
404 {
405 HAL_SYSTICK_Callback();
406 }
407
408 /**
409 * @brief SYSTICK callback.
410 * @retval None
411 */
412 __weak void HAL_SYSTICK_Callback(void)
413 {
414 /* NOTE : This function Should not be modified, when the callback is needed,
415 the HAL_SYSTICK_Callback could be implemented in the user file
416 */
417 }
418
419 /**
420 * @}
421 */
422
423 /**
424 * @}
425 */
426
427 #endif /* HAL_CORTEX_MODULE_ENABLED */
428 /**
429 * @}
430 */
431
432 /**
433 * @}
434 */
435
436 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/