Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/Flipper-Zero/STM32CubeWB.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'Projects/NUCLEO-WB35CE/Examples/CORTEX/CORTEXM_SysTick/readme.txt')
-rw-r--r--Projects/NUCLEO-WB35CE/Examples/CORTEX/CORTEXM_SysTick/readme.txt66
1 files changed, 66 insertions, 0 deletions
diff --git a/Projects/NUCLEO-WB35CE/Examples/CORTEX/CORTEXM_SysTick/readme.txt b/Projects/NUCLEO-WB35CE/Examples/CORTEX/CORTEXM_SysTick/readme.txt
new file mode 100644
index 000000000..0b0db6597
--- /dev/null
+++ b/Projects/NUCLEO-WB35CE/Examples/CORTEX/CORTEXM_SysTick/readme.txt
@@ -0,0 +1,66 @@
+ /**
+ @page CORTEXM_SysTick CORTEXM SysTick example
+
+ @verbatim
+ ******************************************************************************
+ * @file CORTEX/CORTEXM_SysTick/readme.txt
+ * @author MCD Application Team
+ * @brief Description of the CortexM SysTick example.
+ ******************************************************************************
+ *
+ * Copyright (c) 2019 STMicroelectronics. All rights reserved.
+ *
+ * This software component is licensed by ST under BSD 3-Clause license,
+ * the "License"; You may not use this file except in compliance with the
+ * License. You may obtain a copy of the License at:
+ * opensource.org/licenses/BSD-3-Clause
+ *
+ ******************************************************************************
+ @endverbatim
+
+@par Example Description
+
+How to use the default SysTick configuration with a 1 ms timebase to toggle LEDs.
+
+ A "HAL_Delay" function is implemented based on the SysTick end-of-count event.
+ Three LEDs are toggled with a timing defined by the HAL_Delay function.
+
+@note Care must be taken when using HAL_Delay(), this function provides accurate
+ delay (in milliseconds) based on variable incremented in SysTick ISR. This
+ implies that if HAL_Delay() is called from a peripheral ISR process, then
+ the SysTick interrupt must have higher priority (numerically lower)
+ than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
+ To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.
+
+@note The application need to ensure that the SysTick time base is always set to 1 millisecond
+ to have correct HAL operation.
+
+@par Keywords
+
+System, Cortex, Time base, Systick, HCLK
+
+@par Directory contents
+
+ - CORTEX/CORTEXM_SysTick/Inc/stm32wbxx_hal_conf.h HAL configuration file
+ - CORTEX/CORTEXM_SysTick/Inc/stm32wbxx_it.h Interrupt handlers header file
+ - CORTEX/CORTEXM_SysTick/Inc/main.h Header for main.c module
+ - CORTEX/CORTEXM_SysTick/Src/stm32wbxx_it.c Interrupt handlers
+ - CORTEX/CORTEXM_SysTick/Src//stm32wbxx_hal_msp.c HAL MSP file
+ - CORTEX/CORTEXM_SysTick/Src/main.c Main program
+ - CORTEX/CORTEXM_SysTick/Src/system_stm32wbxx.c STM32WBxx system source file
+
+@par Hardware and Software environment
+
+ - This example runs on STM32WB35CEUx devices.
+
+ - This example has been tested with NUCLEO-WB35CE board and can be
+ easily tailored to any other supported device and development board.
+
+@par How to use it ?
+In order to make the program work, you must do the following :
+- Open your preferred toolchain
+- Rebuild all files and load your image into target memory
+- Run the example
+
+ * <h3><center>&copy; COPYRIGHT STMicroelectronics</center></h3>
+ */