docs: a step-by-step first program on EmbSim's micro:bit board

未关闭
#195 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
82/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
c, markdown
领域
documentation

调研方向

Read the Cortex-M3 walkthrough in docs/manual/getting-started.md, the board table, and tests/harness/thumb-m0/boot.c and io.c; build the toolchain and run the documented program with embsim --board microbit --stats. Capture the commands and output as printed, including the librt.a link step for __aeabi_uidivmod, and explain the ARMv6-M instruction set difference. Finish when a fresh clone can follow the walkthrough and make embdoc && ./embdoc check passes.

由索引模型根据 Issue 内容生成。

描述

documentation good first issue

Context. Getting started walks through a first program on a Cortex-M3, step by step. The roadmap asks for a getting-started page for each EmbSim board. The BBC micro:bit (a Cortex-M0) is a good next one. Its row in the boards table already gives the target (thumbv6m-none-eabi), the harness (tests/harness/thumb-m0) and the link flags (-e reset -Ttext 0x0 -Tdata 0x20000000), but there is no walkthrough.

Where.

  • docs/manual/getting-started.md: the "Cortex-M3, step by step" section is the model, and the board table is around line 491. Add a "micro:bit (Cortex-M0), step by step" section next to it, or a page under docs/manual/ linked from there; ask in the comments if unsure which.
  • tests/harness/thumb-m0/: its boot.c and io.c are the start-up code and the output functions.
  • embsim --board microbit: runs the image.

Steps.

  1. Write the same small program as the Cortex-M3 section, then compile, link and run it with embcc, embld and embsim --board microbit --stats.
  2. One difference you will meet: ARMv6-M has no divide instruction, so the harness's io.c calls __aeabi_uidivmod, and the link fails with undefined symbol '__aeabi_uidivmod' until the compiler runtime is linked. Build it with make rt-embedded (or sh tools/build-rt.sh thumbv6m-none-eabi build/libc/thumbv6m-none-eabi for this target alone), put build/libc/thumbv6m-none-eabi/librt.a last on the embld line, and explain this in the section.
  3. Paste the commands and the output exactly as printed. Do not edit the output.
  4. Say what else differs from the Cortex-M3 version: ARMv6-M's smaller, mostly 16-bit instruction set.
  5. Run make embdoc && ./embdoc check.

Done when a reader with a fresh clone can follow the section from make embcc embld embsim to the program's output on EmbSim's micro:bit, the output shown is the real one, and ./embdoc check passes.

Before you start: the contributor's guide has the rules. A new test counts only after it has failed against the code before your change, and a commit subject reads area: summary. Questions are welcome in the comments or in Discussions.

主要语言
C
星标
1
派生
2
平均合并
20 小时 55 分钟
30 天内合并 PR
73

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

EmbLinkOs/EmbCC 的其他 Issue

查看 EmbLinkOs/EmbCC 的全部 Issue

相似的 Issue

更多 C Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。