agentleFS
mohitmishra786mohitmishra786/low-level-dev-skills/skills/baremetal/datasheet-and-refmanual-reading/SKILL.md

datasheet-and-refmanual-reading

Skill290 starsChanged 7 months agoMITView on GitHub

Datasheet and reference manual reading skill for embedded engineers. Use when extracting pinouts, electrical limits, register maps, clock trees, or timing from MCU documentation. Activates on queries about reading STM32 RM, extracting register bits, finding errata, or navigating reference manual sections.

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read the datasheet for what exists.

    line 31
  2. Distinctive:

    Read-only / write-only / write-1-to-clear bits

    line 51
  3. Distinctive:

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

    line 72

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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.

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?"

Workflow

1. Document types

DocumentPrimary use
DatasheetPinout, 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 sheetSilicon bugs that affect firmware workarounds

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

2. First-pass reading order (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

3. Register map extraction checklist

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;

4. Pin / signal cross-reference

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).

5. Timing and electrical traps

  • 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

6. Errata workflow

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

7. Agent usage

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

Common Problems

SymptomCauseFix
Wrong register behaviorRead wrong silicon rev errataCheck ERRATA sheet first
AF does not workConfused DS pin name with RM AF tableCross-check both tables
Intermittent DMAMissed footnote on buffer alignmentRM DMA chapter notes
Clock mismatchUsed max frequency from DS banner, not voltage range tableUse operating conditions table

Related Skills

  • skills/baremetal/peripherals-from-datasheet — driver implementation workflow
  • skills/baremetal/mmio-and-bit-manipulation — safe register access
  • skills/baremetal/gpio-baremetal — pin mux from RM tables
  • skills/kernel-dev/device-tree — bindings mirror RM capabilities for Linux

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.