Skip to content

Commit d0decbd

Browse files
cpu: rename doc.txt -> doc.md for remaining CPUs
1 parent 8c623fa commit d0decbd

File tree

26 files changed

+294
-385
lines changed

26 files changed

+294
-385
lines changed

cpu/cc2538/doc.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
@defgroup cpu_cc2538 TI CC2538
2+
@ingroup cpu
3+
@brief Texas Instruments CC2538 Cortex-M3 MCU specific code
4+
5+
@defgroup cpu_cc2538_regs TI CC2538 CMSIS-style Headers
6+
@ingroup cpu_cc2538
7+
@brief CMSIS-style register definitions for the TI CC2538

cpu/cc2538/doc.txt

Lines changed: 0 additions & 11 deletions
This file was deleted.

cpu/cc26x0_cc13x0/doc.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
@defgroup cpu_cc26x0_cc13x0 TI CC26x0/CC13x0
2+
@ingroup cpu
3+
@brief Texas Instruments CC26x0/CC13x0 Cortex-M3 MCU specific code
4+
5+
@defgroup cpu_specific_peripheral_memory_map TI CC26x0/CC13x0 peripheral memory map
6+
@ingroup cpu
7+
@brief Texas Instruments CC26x0/CC13x0 memory mappings for peripherals
8+
9+
@defgroup cpu_cc26x0_cc13x0_definitions TI CC26x0/CC13x0 definitions
10+
@ingroup cpu_cc26x0_cc13x0
11+
@brief Texas Instruments CC26x0 specific defines

cpu/cc26x0_cc13x0/doc.txt

Lines changed: 0 additions & 17 deletions
This file was deleted.

cpu/cc26x2_cc13x2/doc.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
@defgroup cpu_cc26x2_cc13x2 TI CC26x2, CC13x2
2+
@ingroup cpu
3+
@brief Texas Instruments CC26x2, CC13x2 Cortex-M4F MCU specific code
4+
5+
@defgroup cpu_cc26x2_cc13x2_peripheral_memory_map TI CC26x2, CC13x2 peripheral memory map
6+
@ingroup cpu
7+
@brief Texas Instruments CC26x2, CC13x2 memory mappings for peripherals
8+
9+
@defgroup cpu_cc26x2_cc13x2_definitions TI CC26x2, CC13x2 definitions
10+
@ingroup cpu_cc26x2_cc13x2
11+
@brief Texas Instruments CC26x2, CC13x2 specific defines

cpu/cc26x2_cc13x2/doc.txt

Lines changed: 0 additions & 17 deletions
This file was deleted.

cpu/cc26xx_cc13xx/doc.txt renamed to cpu/cc26xx_cc13xx/doc.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
/**
2-
@defgroup cpu_cc26xx_cc13xx CC26xx/CC13xx common
3-
@ingroup cpu
4-
@brief Common code for TI cc26xx/cc13xx family
1+
@defgroup cpu_cc26xx_cc13xx CC26xx/CC13xx common
2+
@ingroup cpu
3+
@brief Common code for TI cc26xx/cc13xx family
54

65
This module contains code common to all cc26xx/cc13xx cpus
76
supported by RIOT: @ref cpu_cc26x0_cc13x0, @ref cpu_cc26x2_cc13x2
@@ -171,14 +170,9 @@ programmer, if it's not the case for an external board, you can always use
171170
uniflash by setting this environment variable `PROGRAMMER=uniflash` to change
172171
the default programmer.
173172

174-
*/
175-
176-
/**
177-
* @defgroup cpu_cc26xx_cc13xx_definitions CC26xx/CC13xx common
178-
* @ingroup cpu
179-
* @brief Common definitions for TI cc26xx/cc13xx family
180-
*
181-
* This module contains definitions common to all cc26xx/cc13xx cpus
182-
* supported by RIOT: @ref cpu_cc26x0_cc13x0, @ref cpu_cc26x2_cc13x2
183-
*
184-
*/
173+
@defgroup cpu_cc26xx_cc13xx_definitions CC26xx/CC13xx common
174+
@ingroup cpu
175+
@brief Common definitions for TI cc26xx/cc13xx family
176+
177+
This module contains definitions common to all cc26xx/cc13xx cpus
178+
supported by RIOT: @ref cpu_cc26x0_cc13x0, @ref cpu_cc26x2_cc13x2

cpu/doc.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!--
2+
Copyright (C) 2013 Freie Universität Berlin
3+
4+
This file is subject to the terms and conditions of the GNU Lesser
5+
General Public License v2.1. See the file LICENSE in the top level
6+
directory for more details.
7+
-->
8+
9+
@defgroup cpu CPU
10+
@brief CPU specific implementations
11+
12+
This module contains all CPU specific source files. In case of multiple CPUs
13+
sharing the same architecture, the implementation is split into several CPU
14+
specific parts and an architecture part (e.g. arm7_common and lpc23xx).
15+
16+
@defgroup config_cpu CPU Configurations
17+
@ingroup config
18+
@brief Compile time configurations for different kinds of CPU.
19+
20+
@brief Skip calling `board_init()`
21+
22+
Don't call `board_init()`, leave all pins in their default state.
23+
24+
This is intended to be used with basic riotboot_slot which does not interact
25+
with any external hardware.
26+
27+
@experimental Only use this if you know what you are doing
28+
29+
#define DISABLE_BOARD_INIT 0
30+
31+
@brief Skip calling `cpu_init()`
32+
33+
Don't call `cpu_init()`, leave all CPU configuration in boot-up state.
34+
35+
This is intended to be used with basic riotboot_slot which does not interact
36+
with any CPU peripherals.
37+
38+
@experimental Only use this if you know what you are doing
39+
40+
#define DISABLE_CPU_INIT 0

cpu/doc.txt

Lines changed: 0 additions & 46 deletions
This file was deleted.

cpu/efm32/doc.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
@defgroup cpu_efm32 Silicon Labs EFM32/EFR32/EZR32
2+
@ingroup cpu
3+
@brief Silicon Labs's EFM32/EFR32/EZR32 MCUs implementation
4+
5+
This module contains all code and definitions for the Silicon Labs
6+
EFM32/EFR32/EZR32 MCUs. It uses the Gecko SDK (vendor library) for the
7+
peripheral drivers.
8+
9+
Supported Peripherals
10+
=====================
11+
12+
The following peripherals are supported (depends on microcontroller):
13+
- ADC
14+
- CPUID
15+
- DAC
16+
- Flash page
17+
- GPIO
18+
- HW RNG
19+
- I2C
20+
- Power Management
21+
- PWM
22+
- RTC
23+
- RTT
24+
- SPI
25+
- Timer
26+
- UART (including low-power)
27+
28+
Clock Configuration
29+
===================
30+
31+
By default the microcontroller will run on the internal RC-oscillator. If
32+
an external crystal is available, you can configure it to use by setting
33+
`CLOCK_HF=cmuSelect_HFXO`. The same applies for `CLOCK_LFA`, `CLOCK_LFB` and
34+
`CLOCK_LFE` using `cmuSelect_LFXO`.
35+
36+
If the internal RC-oscillator is not used, it will be disabled.
37+
38+
Refer to the reference manual of the specific microcontroller for the
39+
specifics.
40+
41+
EMU and CMU Configuration
42+
=========================
43+
44+
The Energy Management Unit (EMU) and Clock Management Unit (CMU) are
45+
initialized using default values provided by the Gecko SDK. You can override
46+
any of the following defaults to use other values:
47+
48+
- `CMU_HFXOINIT`
49+
- `CMU_LFXOINIT`
50+
- `EMU_DCDCINIT`
51+
- `EMU_EM23INIT`
52+
- `EMU_EM4INIT`
53+
54+
Refer to the Gecko SDK for more information about these values.
55+
56+
Low-power Configuration
57+
=======================
58+
59+
The EFM32/EFR32/EZR32 MCUs have support for low-power peripherals. Support
60+
is enabled by default, but can be disabled if not used.
61+
62+
- Setting `EFM32_LEUART_ENABLED=0` will disable support for the LEUART
63+
in the UART driver peripheral and save approximately 400 bytes.
64+
Refer to `cpu/efm32/efm32-features.mk` for more options.
65+
66+
@defgroup cpu_efm32gg Silicon Labs EFM32GG family
67+
@ingroup cpu_efm32
68+
@brief Silicon Labs's EFM32GG MCUs family implementation
69+
70+
@defgroup cpu_efm32hg Silicon Labs EFM32HG family
71+
@ingroup cpu_efm32
72+
@brief Silicon Labs's EFM32HG MCUs family implementation
73+
74+
@defgroup cpu_efm32lg Silicon Labs EFM32LG family
75+
@ingroup cpu_efm32
76+
@brief Silicon Labs's EFM32LG MCUs family implementation
77+
78+
@defgroup cpu_efm32pg1b Silicon Labs EFM32PG1B family
79+
@ingroup cpu_efm32
80+
@brief Silicon Labs's EFM32PG1B MCUs family implementation
81+
82+
@defgroup cpu_efm32pg12b Silicon Labs EFM32PG12B family
83+
@ingroup cpu_efm32
84+
@brief Silicon Labs's EFM32PG12B MCUs family implementation
85+
86+
@defgroup cpu_efm32zg Silicon Labs EFM32ZG family
87+
@ingroup cpu_efm32
88+
@brief Silicon Labs's EFM32ZG MCUs family implementation
89+
90+
@defgroup cpu_efr32mg1b Silicon Labs EFR32MG1P family
91+
@ingroup cpu_efm32
92+
@brief Silicon Labs's EFR32MG1B MCUs family implementation
93+
94+
@defgroup cpu_efr32mg1p Silicon Labs EFR32MG1P family
95+
@ingroup cpu_efm32
96+
@brief Silicon Labs's EFR32MG1P MCUs family implementation
97+
98+
@defgroup cpu_efr32mg12p Silicon Labs EFR32MG12P family
99+
@ingroup cpu_efm32
100+
@brief Silicon Labs's EFR32MG12P MCUs family implementation
101+
102+
@defgroup cpu_ezr32wg Silicon Labs EZR32WG family
103+
@ingroup cpu_efm32
104+
@brief Silicon Labs's EZR32WG MCUs family implementation

0 commit comments

Comments
 (0)