STM32 more information in README file #13053

jeromecoutant · 2020-06-02T09:21:21Z

Summary of changes

STM part needs often more information in documentation.

I tried to summarize the questions I hear/read.
With this kind of read me file, every one could later update the information.

@MarceloSalazar
@ARMmbed/team-st-mcd

Impact of changes

none

Migration actions required

Documentation

Pull request type

[x] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results

[x] No Tests required for this change (E.g docs only update)
[] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR

Reviewers

ladislas · 2020-06-02T09:58:00Z

This is great! thanks @jeromecoutant

ciarmcom · 2020-06-02T11:00:29Z

@jeromecoutant, thank you for your changes.
@ARMmbed/mbed-os-maintainers please review.

0xc0170 · 2020-06-02T11:47:03Z

targets/TARGET_STM/README.md

 https://www.st.com/en/embedded-software/stm32cube-mcu-packages.html

-This table summarizes the STM32Cube versions currently used :
+There is one STM32Cube package for each individual STM32 MCU serie.


serie -> family ?

Correct. I think F0, F1, F2... are families, Fx is the serie...

0xc0170 · 2020-06-02T11:48:49Z

targets/TARGET_STM/README.md

+Mbed OS HAL calls ST porting layer, which calls ST HAL and LL API.
+
+Note that all ST HAL and LL files are available:
+- you can then develop some applications with direct ST HAL and LL call, even if feature is not supported in mbed-os


mbed-os -> Mbed OS everywhere in this doc

0xc0170 · 2020-06-02T11:49:15Z

targets/TARGET_STM/README.md

+- BSP for LCD, AUDIO, SENSORS, etc... are not available in mbed-os, but you should be able to use it in your local application.
+
+
+Each STM32Cube package is also available in GitHub.


on Github

0xc0170 · 2020-06-02T11:53:03Z

targets/TARGET_STM/README.md

 | L5          |    1.1.0     | https://github.com/STMicroelectronics/STM32CubeL5 |
 | WB          |    1.4.0     | https://github.com/STMicroelectronics/STM32CubeWB |
+
+In mbed repo, we try to minimize the difference between "official" and copied files.


Mbed OS repository

0xc0170 · 2020-06-02T11:53:56Z

targets/TARGET_STM/README.md

+- PeripheralPins.c
+- PinNames.h
+
+Tip is to use a python script to generate those files


Tip is to use a python script to generate those files

Recommended to use a python script to generate these files

MarceloSalazar

Few minor things to tweak

targets/TARGET_STM/README.md

jeromecoutant

Thx for comments

targets/TARGET_STM/README.md

jeromecoutant · 2020-06-08T07:55:18Z

targets/TARGET_STM/README.md

 https://www.st.com/en/embedded-software/stm32cube-mcu-packages.html

-This table summarizes the STM32Cube versions currently used :
+There is one STM32Cube package for each individual STM32 MCU serie.


Correct. I think F0, F1, F2... are families, Fx is the serie...

jeromecoutant · 2020-06-08T07:57:13Z

targets/TARGET_STM/README.md

+Mbed OS HAL calls ST porting layer, which calls ST HAL and LL API.
+
+Note that all ST HAL and LL files are available:
+- you can then develop some applications with direct ST HAL and LL call, even if feature is not supported in mbed-os


jeromecoutant · 2020-06-08T07:58:02Z

targets/TARGET_STM/README.md

+- BSP for LCD, AUDIO, SENSORS, etc... are not available in mbed-os, but you should be able to use it in your local application.
+
+
+Each STM32Cube package is also available in GitHub.


jeromecoutant · 2020-06-08T07:58:26Z

targets/TARGET_STM/README.md

 | L5          |    1.1.0     | https://github.com/STMicroelectronics/STM32CubeL5 |
 | WB          |    1.4.0     | https://github.com/STMicroelectronics/STM32CubeWB |
+
+In mbed repo, we try to minimize the difference between "official" and copied files.


jeromecoutant · 2020-06-08T07:59:39Z

targets/TARGET_STM/README.md

+- PeripheralPins.c
+- PinNames.h
+
+Tip is to use a python script to generate those files


targets/TARGET_STM/README.md

See ARMmbed#12975

Pull request has been modified.

0xc0170 · 2020-06-09T11:53:39Z

CI started

ciarmcom requested a review from a team June 2, 2020 11:00

ciarmcom added the needs: review label Jun 2, 2020

0xc0170 reviewed Jun 2, 2020

View reviewed changes

0xc0170 requested a review from MarceloSalazar June 2, 2020 11:54

MarceloSalazar previously requested changes Jun 2, 2020

View reviewed changes

targets/TARGET_STM/README.md Show resolved Hide resolved

targets/TARGET_STM/README.md Show resolved Hide resolved

targets/TARGET_STM/README.md Outdated Show resolved Hide resolved

mergify bot added needs: work and removed needs: review labels Jun 2, 2020

jeromecoutant commented Jun 8, 2020

View reviewed changes

jeromecoutant added 2 commits June 8, 2020 10:02

STM32WB ReadMe quick update

c9e0c4f

See ARMmbed#12975

STM32 more information in README file

1292053

jeromecoutant force-pushed the PR_README branch from cba2731 to 1292053 Compare June 8, 2020 08:03

0xc0170 approved these changes Jun 9, 2020

View reviewed changes

mergify bot added needs: CI and removed needs: work labels Jun 9, 2020

mergify bot added ready for merge and removed needs: CI labels Jun 9, 2020

0xc0170 added the release-type: patch Indentifies a PR as containing just a patch label Jun 10, 2020

0xc0170 merged commit 0f2a28d into ARMmbed:master Jun 10, 2020

mergify bot removed the ready for merge label Jun 10, 2020

jeromecoutant deleted the PR_README branch June 10, 2020 09:49

jeromecoutant mentioned this pull request Jun 11, 2020

STM32_gen_PeripheralPins.py script v1.12 #13036

Merged

adbridge added release-version: 6.1.0 Release-pending and removed release-type: patch Indentifies a PR as containing just a patch Release-pending labels Jun 24, 2020

		- BSP for LCD, AUDIO, SENSORS, etc... are not available in mbed-os, but you should be able to use it in your local application.


		Each STM32Cube package is also available in GitHub.

STM32 more information in README file #13053

STM32 more information in README file #13053

Uh oh!

Conversation

jeromecoutant commented Jun 2, 2020

Summary of changes

Impact of changes

Migration actions required

Documentation

Pull request type

Test results

Reviewers

Uh oh!

ladislas commented Jun 2, 2020

Uh oh!

ciarmcom commented Jun 2, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MarceloSalazar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeromecoutant left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

0xc0170 commented Jun 9, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants