Skip to content

Commit d9ada32

Browse files
committed
[cortex-m] Fix linker macros documentation
1 parent b50454d commit d9ada32

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

src/modm/platform/core/cortex/module.lb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ def common_memories(env):
7070
Computes memory properties:
7171
7272
- `memories`: unfiltered memory regions
73+
- `ram_regions`: memory region name with `ram` in their names
7374
- `regions`: memory region names
7475
- `cont_ram_regions`: all continuous internal SRAM sections
7576
- `cont_ram`: largest continuous internal SRAM section
@@ -136,9 +137,8 @@ def common_linkerscript(env):
136137
Additional memory properties:
137138
138139
- `memories`: unfiltered memory regions
140+
- `ram_regions`: memory region name with `ram` in their names
139141
- `regions`: memory region names
140-
- `ram_origin`: Lowest SRAM origin address
141-
- `ram_origin`: Total size of all SRAM regions
142142
- `cont_ram_regions`: all continuous internal SRAM sections
143143
- `cont_ram`: largest continuous internal SRAM section
144144

src/modm/platform/core/cortex/module.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -135,11 +135,12 @@ The following macros are available:
135135
- `section_vector_rom(memory)`: places the read-only vector table into ROM
136136
`memory`.
137137
138-
- `section_vector_ram(memory)`: places the volatile vector table into RAM
139-
`memory`. You must satisfy alignment requirements externally.
138+
- `section_vector_ram(memory, table_copy)`: places the volatile vector table
139+
into RAM `memory` and add it to the copy table. You must satisfy alignment
140+
requirements externally.
140141
141-
- `section(memory, name, sections=[])`: place section `.{name}` into `memory`
142-
and include `sections` into the `.{name}` section.
142+
- `section_load(memory, table_copy, sections)`: place each `.{section}` in
143+
`sections` into `memory` and add them the copy table.
143144
144145
- `section_stack(memory, start=None)`: place the main stack into `memory` after
145146
moving the location counter to `start`.
@@ -152,14 +153,16 @@ The following macros are available:
152153
section end address, so that previous sections will push this section back.
153154
154155
- `all_heap_sections(table_copy, table_heap)`: places the heap sections as
155-
described by `cont_ram_regions` of the `linkerscript` query.
156+
described by `cont_ram_regions` of the `linkerscript` query. This also adds
157+
bss and noinit sections into each region.
156158
157159
- `section_rom(memory)`: place all read-only sections (`.text`, `.rodata` etc)
158160
into `memory`.
159161
160-
- `section_ram(memory, rom, sections=[])`: place all volatile sections (`.data`,
161-
`.bss` etc) into `memory` and load from `rom`. Adds `sections` into the
162-
`.data` section.
162+
- `section_ram(memory, rom, table_copy, table_zero,
163+
sections_data=[], sections_bss=[], sections_noinit=[])`: place all volatile
164+
sections (`.data`, `.bss` etc) into `memory` and load from `rom`. Additional
165+
sections can be added.
163166
164167
- `section_tables(memory, copy, zero, heap)`: place the zero, copy and heap
165168
table into `memory`.

0 commit comments

Comments
 (0)