Skip to content

Commit 52e1a8a

Browse files
cpqcpq
committed
mcu.h -> hal.h
1 parent 9ab1b04 commit 52e1a8a

File tree

23 files changed

+30
-30
lines changed

23 files changed

+30
-30
lines changed

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1117,17 +1117,17 @@ mechanism. We use newlib, so let's modify `_write()` syscall to print to the
11171117
UART3.
11181118
11191119
Before that, let's organise our source code in the following way:
1120-
- move all API definitions to the file `mcu.h`
1120+
- move all API definitions to the file `hal.h` (Harware Abstraction Layer)
11211121
- move startup code to `startup.c`
11221122
- create an empty file `syscalls.c` for newlib "syscalls"
11231123
- modify Makefile to add `syscalls.c` and `startup.c` to the build
11241124
1125-
After moving all API definitions to the `mcu.h`, our `main.c` file becomes
1125+
After moving all API definitions to the `hal.h`, our `main.c` file becomes
11261126
quite compact. Note that it does not have any mention of the low-level
11271127
registers, just a high level API functions that are easy to understand:
11281128
11291129
```c
1130-
#include "mcu.h"
1130+
#include "hal.h"
11311131
11321132
static volatile uint32_t s_ticks;
11331133
void SysTick_Handler(void) {
@@ -1157,7 +1157,7 @@ Great, now let's retarget printf to the UART3. In the empty syscalls.c,
11571157
copy/paste the following code:
11581158
11591159
```c
1160-
#include "mcu.h"
1160+
#include "hal.h"
11611161
11621162
int _write(int fd, char *ptr, int len) {
11631163
(void) fd, (void) ptr, (void) len;
@@ -1272,7 +1272,7 @@ Choose our firmware.elf file:
12721272
<img src="images/ozone3.png" width="50%" />
12731273
12741274
Leave the defaults on the next screen, click Finish, and we've got our
1275-
debugger loaded (note the mcu.h source code is picked up):
1275+
debugger loaded (note the hal.h source code is picked up):
12761276
12771277
![](images/ozone4.png)
12781278
@@ -1329,8 +1329,8 @@ The ST CMSIS package also provides startup files for all their MCUs. We
13291329
can use those instead of hand-writing the startup.c. The ST-provided startup
13301330
file calls `SystemInit()` function, so we define it in the `main.c`.
13311331
1332-
Now, let's replace our API functions in the `mcu.h` using CMSIS definitions,
1333-
and leave the rest of the firmware intact. From the `mcu.h`, remove all
1332+
Now, let's replace our API functions in the `hal.h` using CMSIS definitions,
1333+
and leave the rest of the firmware intact. From the `hal.h`, remove all
13341334
peripheral API and definitions, and leave only standard C inludes, vendor CMSIS
13351335
include, defines to PIN, BIT, FREQ, and `timer_expired()` helper function.
13361336
@@ -1343,7 +1343,7 @@ Let's start from `systick_init()`. ARM core CMSIS headers provide a
13431343
13441344
Next goes `gpio_set_mode()` function. The `stm32f429xx.h` header has
13451345
`GPIO_TypeDef` structure, identical to our `struct gpio`. Let's use it:
1346-
https://github.com/cpq/bare-metal-programming-guide/blob/785aa2ead0432fc67327781c82b9c41149fba158/step-5-cmsis/mcu.h#L24-L33
1346+
https://github.com/cpq/bare-metal-programming-guide/blob/785aa2ead0432fc67327781c82b9c41149fba158/step-5-cmsis/hal.h#L24-L33
13471347
13481348
The `gpio_set_af()` and `gpio_write()` functions is also trivial -
13491349
simply replace `struct gpio` with `GPIO_TypeDef`, and that's all.

‎README_zh-CN.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -894,15 +894,15 @@ newlib实现了一些标准C函数，特别是文件输入输出操作，并且
894894
895895
在那之前，我们先重新组织下源码结构：
896896
897-
- 把所有API定义放到 `mcu.h` 文件中
897+
- 把所有API定义放到 `hal.h` 文件中
898898
- 把启动代码放到 `startup.c` 文件中
899899
- 为newlib的系统调用创建一个空文件 `syscalls.c`
900900
- 修改Makefile，把 `syscalls.c` 和 `startup.c` 加到build中
901901
902-
将所有 API 定义移动到 `mcu.h` 后，`main.c` 文件变得相当紧凑。注意我们还没提到底层寄存器，高级API函数很容易理解：
902+
将所有 API 定义移动到 `hal.h` 后，`main.c` 文件变得相当紧凑。注意我们还没提到底层寄存器，高级API函数很容易理解：
903903
904904
```c
905-
#include "mcu.h"
905+
#include "hal.h"
906906
907907
static volatile uint32_t s_ticks;
908908
void SysTick_Handler(void) {
@@ -931,7 +931,7 @@ int main(void) {
931931
现在我们把 `printf()` 重定向到串口3，在空的 `syscalls.c` 文件中拷入一下内容：
932932
933933
```c
934-
#include "mcu.h"
934+
#include "hal.h"
935935
936936
int _write(int fd, char *ptr, int len) {
937937
(void) fd, (void) ptr, (void) len;
@@ -1027,7 +1027,7 @@ LED: 0, tick: 1000
10271027

10281028
<img src="images/ozone3.png" width="50%" />
10291029

1030-
接下来的步骤保持默认，点击“完成”，调试器已经载入（可以看到`mcu.h`源码被拾取）：
1030+
接下来的步骤保持默认，点击“完成”，调试器已经载入（可以看到`hal.h`源码被拾取）：
10311031

10321032
<img src="images/ozone3.png" width="50%" />
10331033

@@ -1060,7 +1060,7 @@ LED: 0, tick: 1000
10601060

10611061
CMSIS代表通用微控制器软件接口标准（Common Microcontroller Software Interface Standard），因此它是MCU制造商指定外设API的共同基础。 因为CMSIS是一种ARM标准，并且CMSIS头文件由MCU厂商提供，所以是权威的来源。因此，使用供应商头文件是首选方法，而不是手动编写定义。
10621062

1063-
在这一节，我们将使用供应商CMSIS头文件替换 `mcu.h` 中的API函数，并保持固件其它部分不变。
1063+
在这一节，我们将使用供应商CMSIS头文件替换 `hal.h` 中的API函数，并保持固件其它部分不变。
10641064

10651065
STM32 F4系列的CMSIS头文件在这个[仓库](https://github.com/STMicroelectronics/cmsis_device_f4)，从那里将以下文件拷到我们的固件文件夹[step-5-cmsis](step-5-cmsis)：
10661066

@@ -1074,7 +1074,7 @@ Those two files depend on a standard ARM CMSIS includes, download them too:
10741074
- [cmsis_compiler.h](https://raw.githubusercontent.com/STMicroelectronics/STM32CubeF4/master/Drivers/CMSIS/Core/Include/cmsis_compiler.h)
10751075
- [mpu_armv7.h](https://raw.githubusercontent.com/STMicroelectronics/STM32CubeF4/master/Drivers/CMSIS/Core/Include/mpu_armv7.h)
10761076

1077-
然后移除 `mcu.h` 中所有外设API和定义，只留下标准C包含、供应商CMSIS包含，引脚定义等：
1077+
然后移除 `hal.h` 中所有外设API和定义，只留下标准C包含、供应商CMSIS包含，引脚定义等：
10781078

10791079
```c
10801080
#pragma once

‎step-4-printf/mcu.h‎ renamed to ‎step-4-printf/hal.h‎

File renamed without changes.

‎step-4-printf/main.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright (c) 2022 Cesanta Software Limited
22
// All rights reserved
33

4-
#include "mcu.h"
4+
#include "hal.h"
55

66
static volatile uint32_t s_ticks;
77
void SysTick_Handler(void) {

‎step-4-printf/syscalls.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
#include <sys/stat.h>
55

6-
#include "mcu.h"
6+
#include "hal.h"
77

88
int _fstat(int fd, struct stat *st) {
99
if (fd < 0) return -1;

‎step-5-cmsis/Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ endif
1515

1616
build: firmware.bin
1717

18-
firmware.elf: cmsis_core cmsis_f4 mcu.h link.ld Makefile $(SOURCES)
18+
firmware.elf: cmsis_core cmsis_f4 hal.h link.ld Makefile $(SOURCES)
1919
arm-none-eabi-gcc $(SOURCES) $(CFLAGS) $(CFLAGS_EXTRA) $(LDFLAGS) -o $@
2020

2121
firmware.bin: firmware.elf

‎step-5-cmsis/mcu.h‎ renamed to ‎step-5-cmsis/hal.h‎

File renamed without changes.

‎step-5-cmsis/main.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright (c) 2022 Cesanta Software Limited
22
// All rights reserved
33

4-
#include "mcu.h"
4+
#include "hal.h"
55

66
static volatile uint32_t s_ticks;
77
void SysTick_Handler(void) {

‎step-5-cmsis/syscalls.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
#include <sys/stat.h>
55

6-
#include "mcu.h"
6+
#include "hal.h"
77

88
int _fstat(int fd, struct stat *st) {
99
if (fd < 0) return -1;

‎step-6-clock/mcu.h‎ renamed to ‎step-6-clock/hal.h‎

File renamed without changes.

0 commit comments

Comments
 (0)