datasheet-and-refmanual-reading

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Datasheet and Reference Manual Reading

数据手册与参考手册阅读

Purpose

目的

Teach agents a systematic methodology for reading MCU datasheets and reference manuals: which sections matter for firmware, how to cross-reference pin tables with register maps, and how to avoid documentation pitfalls (errata, footnotes, conditional fields). Not merged with

skills/baremetal/peripherals-from-datasheet

— this skill covers how to read docs; that skill covers how to write drivers from them.

教Agent掌握阅读MCU数据手册和参考手册的系统化方法：哪些章节对固件开发至关重要，如何交叉引用引脚表与寄存器映射，以及如何避开文档陷阱（勘误表、脚注、条件字段）。请勿与
skills/baremetal/peripherals-from-datasheet
合并——本技能聚焦如何阅读文档；该技能聚焦如何基于文档编写驱动。

When to Use

使用场景

Starting driver work on unfamiliar silicon
Resolving ambiguous register bit behavior
Verifying electrical and timing constraints before PCB/firmware sign-off

Complementing

skills/baremetal/peripherals-from-datasheet

(implementation focus)

Answering "where in the RM do I find X?"

针对陌生芯片启动驱动开发工作
解决寄存器位行为模糊的问题
PCB/固件签核前验证电气与时序约束

配合

skills/baremetal/peripherals-from-datasheet

使用（聚焦实现）

解答“在RM手册的哪个位置能找到X？”这类问题

Workflow

工作流程

1. Document types

1. 文档类型

Document	Primary use
Datasheet	Pinout, max ratings, package, brief features
Reference Manual (RM)	Register maps, bit fields, clock trees, peripheral behavior
Programming Manual (PM)	Cortex-M core, NVIC, MPU, debug (ARM doc)
Errata sheet	Silicon bugs that affect firmware workarounds

Read the datasheet for what exists; read the RM for how to program it.

文档类型	主要用途
Datasheet	引脚定义、最大额定值、封装、核心特性概览
Reference Manual (RM)	寄存器映射、位字段、时钟树、外设行为说明
Programming Manual (PM)	Cortex-M内核、NVIC、MPU、调试相关内容（ARM官方文档）
Errata sheet	影响固件工作的芯片缺陷及规避方案

阅读Datasheet了解芯片具备哪些功能；阅读RM手册了解如何对其编程。

2. First-pass reading order (RM)

2. RM手册首次阅读顺序

1. Memory and bus architecture (address map)
2. Reset and clock control (RCC / CGU)
3. GPIO / pin multiplexing
4. Target peripheral chapter (e.g. USART, SPI, DMA)
5. NVIC / EXTI interrupt mapping table
6. Electrical characteristics (only if timing-critical)
7. Errata — search peripheral name

1. 内存与总线架构（地址映射）
2. 复位与时钟控制（RCC / CGU）
3. GPIO / 引脚复用
4. 目标外设章节（如USART、SPI、DMA）
5. NVIC / EXTI中断映射表
6. 电气特性（仅当时序要求严格时查看）
7. 勘误表——搜索外设名称

3. Register map extraction checklist

3. 寄存器映射提取检查清单

For each register:

Offset from peripheral base (verify against memory map table)
Reset value (affects read-modify-write defaults)
Read-only / write-only / write-1-to-clear bits
Fields that depend on mode (check "Notes" under table)
Side effects: clearing flags, auto-clear bits, reserved must-write-0

/* Good — named constants from RM bit table */
#define USART_CR1_UE   (1U << 13)
#define USART_CR1_TE   (1U << 3)

/* Bad — magic numbers without RM citation */
*(volatile uint32_t *)0x40011000 = 0x2000;

针对每个寄存器：

相对于外设基地址的偏移量（需与内存映射表核对）
复位值（影响读-改-写操作的默认状态）
只读/只写/写1清除位
依赖工作模式的字段（查看表格下方的“注释”）
副作用：标志位清除、自动清除位、保留位必须写0

/* Good — named constants from RM bit table */
#define USART_CR1_UE   (1U << 13)
#define USART_CR1_TE   (1U << 3)

/* Bad — magic numbers without RM citation */
*(volatile uint32_t *)0x40011000 = 0x2000;

4. Pin / signal cross-reference

4. 引脚/信号交叉引用流程

Schematic net → Datasheet pin table (AF number)
             → RM GPIO chapter (MODER, AFR)
             → Peripheral chapter (USART_TX on PA2 = AF7)

Always confirm default state after reset (analog mode, pull, JTAG pins).

原理图网络 → Datasheet引脚表（AF编号）
             → RM手册GPIO章节（MODER、AFR寄存器）
             → 外设章节（如PA2上的USART_TX对应AF7）

务必确认复位后的默认状态（模拟模式、上下拉、JTAG引脚）。

5. Timing and electrical traps

5. 时序与电气陷阱

Setup/hold for external bus modes (FSMC, SDIO)
ADC sampling time vs source impedance (datasheet graph)
Maximum GPIO toggle rate vs load capacitance
Boot mode pins sampled only at reset

外部总线模式（FSMC、SDIO）的建立/保持时间
ADC采样时间与源阻抗的关系（查看Datasheet图表）
GPIO最大翻转速率与负载电容的关系
启动模式引脚仅在复位时采样

6. Errata workflow

6. 勘误表处理流程

Symptom matches errata?
├── Yes → apply documented workaround in driver
└── No  → verify silicon revision (DBGMCU_IDCODE / UID)

症状是否匹配勘误表描述？
├── 是 → 在驱动中应用文档记录的规避方案
└── 否 → 验证芯片版本（通过DBGMCU_IDCODE / UID）

7. Agent usage

7. Agent使用示例

/datasheet-and-refmanual-reading Find STM32F4 USART baud rate formula and required clock source

/datasheet-and-refmanual-reading Find STM32F4 USART baud rate formula and required clock source

Common Problems

常见问题

Symptom	Cause	Fix
Wrong register behavior	Read wrong silicon rev errata	Check ERRATA sheet first
AF does not work	Confused DS pin name with RM AF table	Cross-check both tables
Intermittent DMA	Missed footnote on buffer alignment	RM DMA chapter notes
Clock mismatch	Used max frequency from DS banner, not voltage range table	Use operating conditions table

症状	原因	解决方法
寄存器行为异常	查看了错误版本的芯片勘误表	优先检查ERRATA表
AF功能无法正常工作	将Datasheet引脚名称与RM手册AF表混淆	交叉核对两张表格
DMA间歇性故障	忽略了缓冲区对齐的脚注	查看RM手册DMA章节的注释
时钟不匹配	使用了Datasheet标题栏的最大频率，而非电压范围对应的表格	参考工作条件表格