Add hal/flash porting guide #129
Conversation
There is a new folder hal where a porting guides will be placed. The first one, flash.md file is part of this commit. It contains information about flash HAL API porting plus changes required for bootloader to use this API.
docs/hal/flash.md
Outdated
| 1. Update target to support bootloader | ||
| * Update linker script | ||
| * Implement flash HAL API | ||
| * Add pack support to mbed-os |
There was a problem hiding this comment.
I think we agreed to remove this point until things are finalized?
There was a problem hiding this comment.
Russ is working currently on adding this to the mbed-os. I can remove it for now, and add it later.
@AnotherButler If you do any edits, please remove this, will be added with more information later
docs/hal/flash.md
Outdated
|
|
||
| There are two options how to implement flash HAL: | ||
|
|
||
| 1. CMSIS flash algorithm routines - quick to implement (use CMSIS device packs and scripts to generate binary blobs). As these algos do not have well specified behavior, they might do things like disabling cache, reconfigure clocks or any other actions you might not expect. Therefore a proper testing is required. First, make sure your device is supported by CMSIS device packs. Run a script in the mbedmicro/FlashAlgo to generate flash blob that should be checked in into targets HAL. |
There was a problem hiding this comment.
It might help to provide the link to the script (flash_algo.py or generate_blobs.py ?? ).
On a side note, @sg- , did we decide to NOT use the FlashAlgo repo completely at all? Does this whole section needs to be removed?
There was a problem hiding this comment.
This documentation should be updated to point to the script here:
ARMmbed/mbed-os#3996
The FlashAlgo repo only needs to be used if the algorithm provided by the pack needs to be modified.
docs/hal/flash.md
Outdated
|
|
||
| ``` | ||
|
|
||
| Be careful with these defines, they move the application flash sections, thus any sections within flash sectors should be moved accordingly. For instance data section should start >= MBED_APP_SIZE. |
There was a problem hiding this comment.
should start >= MBED_APP_SIZE be start >= MBED_APP_START?
-Add subjects and pronouns. -Change passive to active voice. -Standardize style. -Make minor grammar changes.
|
@0xc0170 Please review my suggested changes and make sure that I didn't change the meaning of any of your sentences. |
Fix spelling, replace sentence about mbedmicro/FlashAlgo and standardize abbreviations.
Add information about VTOR addresses and change regular text to code
|
I am closing this in favor of PR #130 because after careful consideration, I think that is a better location for this document. |
There is a new folder hal where a porting guides will be placed.
The first one, flash.md file is part of this commit. It contains information
about flash HAL API porting plus changes required for bootloader to use this API.
This is for 5.4 (flash API is part of it). This porting guide should describe flash HAL API, how to port it (2 options, both of them should be described).
Please review, I expect some changes within a day.
cc @c1728p9 @sg- @ashok-rao @AnotherButler
Rendered