probe-rs uses a slimmed-down YAML format to describe chip families, avoiding the bloat of full CMSIS-Packs. The YAML structure defines the chip family, its variants, CPU cores (including architecture and access options), a memory map (RAM, NVM, or Generic), and the associated flash algorithms.
---
# The name of the chip family.
name: string
# A list of all the chips in the family.
variants:
# The name of the chip.
- name: string
# Descriptions of the CPU cores.
cores:
# The name of the core.
- name: string
# Architecture: armv6m | armv7a | armv7m | armv7em | armv8a | armv8m | riscv | xtensa
type: armv7m
# Core-specific options. Can be one of: `!Arm {}`, `!Riscv {}`, `!Xtensa {}`
core_access_options: object
# A list of all the available memories and their properties.
memory_map:
- !Ram
range:
start: number
end: number
access:
boot: boolean
cores:
- core name
- !Nvm
range:
start: number
end: number
access:
boot: boolean
cores:
- core name
- !Generic
range:
start: number
end: number
cores:
- core name
# A list of all the used flash algorithms.
flash_algorithms:
- string
# A list of all the available flash algorithms.
flash_algorithms:
- name: string
description: string
default: boolean
# Base 64 encoded ELF binary blob
instructions: base64string
pc_init: number
pc_uninit: number
pc_program_page: number
pc_erase_sector: number
pc_erase_all: number
data_section_offset: number
transfer_encoding: raw | miniz
flash_properties:
address_range:
start: number
end: number
page_size: number
erased_byte_value: number
program_page_timeout: number
erase_sector_timeout: number
sectors:
- size: number
address: number
cores:
- core name
