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

readme.txt « HSEM_ProcessSync « HSEM « Examples « P-NUCLEO-WB55.Nucleo « Projects - github.com/Flipper-Zero/STM32CubeWB.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 15dfcb9c35b9e69d588f47ad6b3a9daba2f9c07b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/**
  @page HSEM_ProcessSync HSEM process Sync example
  
  @verbatim
  ******************************************************************************
  * @file    HSEM/HSEM_ProcessSync/readme.txt 
  * @author  MCD Application Team
  * @brief   Description of the HSEM Process Sync 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 a HW semaphore to synchronize 2 process.

In this example, HW semaphore (9) is used to synchronize 2 process.

process 1 : Toggle LED2 every 500 ms
process 2 : Set LED1 On.

First, semaphore (9) is taken using HAL API HAL_HSEM_Take with process ID  set to "12". 
if the semaphore is taken LED2 every 500 ms .
The semaphore is released after 5 seconds, using HAL API HAL_HSEM_Release. During this period, the LED2 
is toogling to mention that the semaphore is not available.

Note that HAL_HSEM_Take use the 2-Step semaphore take method (refer to the HW Semaphore
description in the reference manual)

Pushing the "User (SW1)" button will generate an EXTI interrupt. 
The corresponding EXTI callback will try to take the same semaphore (9) using 
HAL API HAL_HSEM_FastTake. 
If the semaphore has been released by first process , then semaphore can be taken 
immediately and it will set LED1 On.

If not, HW semaphore 9 not released yet by the first process , then the HAL_HSEM_FastTake API 
will return HAL_ERROR meaning that the semaphore is already taken by another process.
In this case the HAL API HAL_HSEM_ActivateNotification enable the notification receive once 
the semaphore will be released. 
Treatment will be postponed until the semaphore is released.
Once done, a HSEM interrupt is generated (semaphore 9), and HAL_HSEM_FreeCallback is asserted 
to set LED1 On.

Note that the API HAL_HSEM_FastTake use the 1-Step semaphore take method (refer to the HW Semaphore
description in the reference manual) where the process ID is assumed to be zero.

As a result both process will be synchronized, second process will toggle LED1
only when first process has ended toggle LED2 10 times.

@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 example need to ensure that the SysTick time base is always set to 1 millisecond
      to have correct HAL operation.

@par Keywords

Hardware semaphore, Semaphore, HSEM, EXTI, synchronize, Lock, Unlock, Take, Release, Process

@par Directory contents 

  - HSEM/HSEM_ProcessSync/Inc/stm32wbxx_hal_conf.h    HAL configuration file
  - HSEM/HSEM_ProcessSync/Inc/stm32wbxx_it.h          Interrupt handlers header file
  - HSEM/HSEM_ProcessSync/Inc/main.h                  Header for main.c module  
  - HSEM/HSEM_ProcessSync/Src/stm32wbxx_it.c          Interrupt handlers
  - HSEM/HSEM_ProcessSync/Src/stm32wbxx_hal_msp.c     HAL MSP file
  - HSEM/HSEM_ProcessSync/Src/main.c                  Main program
  - HSEM/HSEM_ProcessSync/Src/system_stm32wbxx.c      stm32wbxx system source file

@par Hardware and Software environment

  - This example runs on STM32WB55RGVx device.
    
  - This example has been tested with P-NUCLEO-WB55 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>
 */