1STM32Cube HAL packages updater.
2###############################
3
4Introduction:
5
6This module provides scripts to update the STM32Cube for Zephyr.
7Follow below steps to update the STM32Cube HAL from the latest
8version found in STM32CubeXX repositories.
9
10Step 1: Modify the code
11***********************
12
13In order to update all the STM32CubeXX versions at once, run::
14
15    $ python3 ./update_stm32_package.py
16
17Alternatively, in order to update STM32CubeXX versions one by one, run for example::
18
19    $ python3 ./update_stm32_package.py -s stm32f1
20
21Note: This requires $ZEPHYR_BASE is set in your environment.
22
23Check STM32CubeXX changes
24=========================
25
26Check that all existing change to modules are correctly reported
27in the new hal_stm32 version
28
29Update each modified stm32cube/stm32XXxx/README in the last section,
30
31Remove the following line::
32	--> please check that the following list is still valid:
33
34
35Step 2: Open a pull requests
36****************************
37
38hal_stm32 PR
39============
40Open a single pull request with 1 commit per stm32 familly (stm32xx)
41in repo https://github.com/zephyrproject-rtos/hal_stm32
42
43
44Modify the west.yml
45===================
46In order to benefit from this PR in zephyr, modify zephyrproject/zephyr/west.yml
47so that hal_stm32 points to above pull request. Example::
48
49	    - name: hal_stm32
50	      revision: pull/60/head
51	      path: modules/hal/stm32
52
53
54Open a 2nd pull request with west.yml in repo
55https://github.com/zephyrproject-rtos/zephyr
56
57
58Step 3: After Merge
59*******************
60
61re-Modify the west.yml
62======================
63
64Once the hal_stm32 pull request is merged (see step 2), in the zephyrproject-rtos/hal_stm32
65
66then change again the zephyrproject-rtos/zephyr/west.yml
67
68to reflect the actual zephyrproject-rtos/hal_stm32 SHA1, example::
69
70	    - name: hal_stm32
71	      revision: a813cd83b0cfbaaa625f4941d04baa3f93c37476
72	      path: modules/hal/stm32
73
74The zephyrproject-rtos/zephyr pull request (see 2) must be updated consequently.
75
76COMMENT:
77
78- "set the SHA1 after merge of STM32Cube versions (modules/hal/stm32)"
79
80See Example : https://github.com/zephyrproject-rtos/zephyr/pull/23259
81
82
83clean
84=====
85once all is correct, clean .rej and .log files, with :
86
87::
88
89 $ git clean -fdx
90