# errorinever/bare-metal-mini-library architecture

> Architecture diagram of the GitHub repository errorinever/bare-metal-mini-library, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/errorinever/bare-metal-mini-library
- Repository: https://github.com/errorinever/bare-metal-mini-library

## Overview

This is a bare-metal STM32F446 peripheral-driver library. An application configures a peripheral through its driver API, then performs I/O through polling, interrupts, or DMA; callbacks report asynchronous completion. The map preserves the distinct GPIO, ADC, DAC, I2C, SPI, and timer capabilities, plus shared DMA and resource-mapping layers. The README is empty and main.c is minimal, so application entry points and some unsampled subsystem wiring are not established; dashed edges mark the unverified application-to-driver relationship.

Main entry points: [`Drivers/CMSIS/Device/ST/STM32F4xx/Include/stm32f446xx.h`](https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/CMSIS/Device/ST/STM32F4xx/Include/stm32f446xx.h) (STM32F446), [`Drivers/DAC/dac.c`](https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/DAC/dac.c) (DAC), [`Drivers/ADC/adc.c`](https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/ADC/adc.c) (ADC), [`Drivers/I2C/i2c.c`](https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/I2C/i2c.c) (I2C)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_peripherals["Peripheral Drivers"]
  node_gpio["GPIO<br/>[gpio.c]"]
  node_adc["ADC<br/>[adc.c]"]
  node_dac["DAC<br/>[dac.c]"]
  node_i2c["I2C<br/>[i2c.c]"]
  node_spi["SPI<br/>[spi.c]"]
  node_timer["Timers<br/>[timer.c]"]
end

subgraph group_shared["Shared Runtime"]
  node_dma["Shared DMA<br/>[bmml_dma_shared.c]"]
  node_utilities["Utilities<br/>[bmml_utilities.c]"]
  node_irq["IRQ Sharing<br/>[bmml_irq_shared.c]"]
  node_status["Status Contract<br/>[bmml_status.h]"]
end

subgraph group_resources["Hardware Resources"]
  node_gpio_map["GPIO Resources<br/>[bmml_res_gpio.h]"]
  node_adc_map["ADC Resources<br/>[bmml_res_adc.h]"]
  node_dac_map["DAC Resources<br/>[bmml_res_dac.h]"]
  node_i2c_map["I2C Resources<br/>[bmml_res_i2c.h]"]
  node_spi_map["SPI Resources<br/>[bmml_res_spi.h]"]
  node_timer_map["Timer Resources<br/>[bmml_res_timer.h]"]
end

subgraph group_platform["MCU Platform"]
  node_stm32["STM32F446<br/>[stm32f446xx.h]"]
end

node_application(("Application"))

node_application -.->|"configures and uses"| node_gpio
node_application -.->|"configures and samples"| node_adc
node_application -.->|"configures and outputs"| node_dac
node_application -.->|"starts transactions"| node_i2c
node_application -.->|"starts transfers"| node_spi
node_application -.->|"configures timing"| node_timer
node_adc -->|"acquires stream"| node_dma
node_i2c -->|"acquires streams"| node_dma
node_spi -->|"acquires streams"| node_dma
node_dac -->|"acquires stream"| node_dma
node_dac -->|"acquires TIM6"| node_timer
node_gpio -->|"accesses registers"| node_stm32
node_adc -->|"accesses registers"| node_stm32
node_dac -->|"accesses registers"| node_stm32
node_i2c -->|"accesses registers"| node_stm32
node_spi -->|"accesses registers"| node_stm32
node_timer -->|"accesses registers"| node_stm32
node_gpio -->|"uses mapping"| node_gpio_map
node_adc -->|"uses mapping"| node_adc_map
node_dac -->|"uses mapping"| node_dac_map
node_i2c -->|"uses mapping"| node_i2c_map
node_spi -->|"uses mapping"| node_spi_map
node_timer -->|"uses mapping"| node_timer_map

click node_gpio "https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/GPIO/gpio.c"
click node_adc "https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/ADC/adc.c"
click node_dac "https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/DAC/dac.c"
click node_i2c "https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/I2C/i2c.c"
click node_spi "https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/SPI/spi.c"
click node_timer "https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/TIMERS/timer.c"
click node_dma "https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Src/bmml_dma_shared.c"
click node_utilities "https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Src/bmml_utilities.c"
click node_irq "https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Src/bmml_irq_shared.c"
click node_status "https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Inc/bmml_status.h"
click node_gpio_map "https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Resources/bmml_res_gpio.h"
click node_adc_map "https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Resources/bmml_res_adc.h"
click node_dac_map "https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Resources/bmml_res_dac.h"
click node_i2c_map "https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Resources/bmml_res_i2c.h"
click node_spi_map "https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Resources/bmml_res_spi.h"
click node_timer_map "https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Resources/bmml_res_timer.h"
click node_stm32 "https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/CMSIS/Device/ST/STM32F4xx/Include/stm32f446xx.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_gpio,node_adc,node_dac,node_i2c,node_spi,node_timer toneBlue
class node_dma,node_utilities,node_irq,node_status toneAmber
class node_gpio_map,node_adc_map,node_dac_map,node_i2c_map,node_spi_map,node_timer_map toneMint
class node_stm32 toneRose
class node_application toneIndigo
```

## Components

### Peripheral Drivers

- [GPIO](https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/GPIO/gpio.c): `Drivers/GPIO/gpio.c`
- [ADC](https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/ADC/adc.c): `Drivers/ADC/adc.c`
- [DAC](https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/DAC/dac.c): `Drivers/DAC/dac.c`
- [I2C](https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/I2C/i2c.c): `Drivers/I2C/i2c.c`
- [SPI](https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/SPI/spi.c): `Drivers/SPI/spi.c`
- [Timers](https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/TIMERS/timer.c): `Drivers/TIMERS/timer.c`

### Shared Runtime

- [Shared DMA](https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Src/bmml_dma_shared.c): `Core/Src/bmml_dma_shared.c`
- [Utilities](https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Src/bmml_utilities.c): `Core/Src/bmml_utilities.c`
- [IRQ Sharing](https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Src/bmml_irq_shared.c): `Core/Src/bmml_irq_shared.c`
- [Status Contract](https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Inc/bmml_status.h): `Core/Inc/bmml_status.h`

### Hardware Resources

- [GPIO Resources](https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Resources/bmml_res_gpio.h): `Core/Resources/bmml_res_gpio.h`
- [ADC Resources](https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Resources/bmml_res_adc.h): `Core/Resources/bmml_res_adc.h`
- [DAC Resources](https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Resources/bmml_res_dac.h): `Core/Resources/bmml_res_dac.h`
- [I2C Resources](https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Resources/bmml_res_i2c.h): `Core/Resources/bmml_res_i2c.h`
- [SPI Resources](https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Resources/bmml_res_spi.h): `Core/Resources/bmml_res_spi.h`
- [Timer Resources](https://github.com/errorinever/bare-metal-mini-library/blob/main/Core/Resources/bmml_res_timer.h): `Core/Resources/bmml_res_timer.h`

### MCU Platform

- [STM32F446](https://github.com/errorinever/bare-metal-mini-library/blob/main/Drivers/CMSIS/Device/ST/STM32F4xx/Include/stm32f446xx.h): `Drivers/CMSIS/Device/ST/STM32F4xx/Include/stm32f446xx.h`

### Other components

- **Application**

## Connections

- Application → GPIO: configures and uses
- Application → ADC: configures and samples
- Application → DAC: configures and outputs
- Application → I2C: starts transactions
- Application → SPI: starts transfers
- Application → Timers: configures timing
- ADC → Shared DMA: acquires stream (evidence: `Drivers/ADC/adc.c`)
- I2C → Shared DMA: acquires streams (evidence: `Drivers/I2C/i2c.c`)
- SPI → Shared DMA: acquires streams (evidence: `Drivers/SPI/spi.c`)
- DAC → Shared DMA: acquires stream (evidence: `Drivers/DAC/dac.c`)
- DAC → Timers: acquires TIM6 (evidence: `Drivers/DAC/dac.c`)
- GPIO → STM32F446: accesses registers (evidence: `Drivers/GPIO/gpio.c`)
- ADC → STM32F446: accesses registers (evidence: `Drivers/ADC/adc.c`)
- DAC → STM32F446: accesses registers (evidence: `Drivers/DAC/dac.c`)
- I2C → STM32F446: accesses registers (evidence: `Drivers/I2C/i2c.c`)
- SPI → STM32F446: accesses registers (evidence: `Drivers/SPI/spi.c`)
- Timers → STM32F446: accesses registers (evidence: `Drivers/TIMERS/timer.c`)
- GPIO → GPIO Resources: uses mapping (evidence: `Drivers/GPIO/gpio.c`)
- ADC → ADC Resources: uses mapping (evidence: `Drivers/ADC/adc.c`)
- DAC → DAC Resources: uses mapping (evidence: `Drivers/DAC/dac.c`)
- I2C → I2C Resources: uses mapping (evidence: `Drivers/I2C/i2c.c`)
- SPI → SPI Resources: uses mapping (evidence: `Drivers/SPI/spi.c`)
- Timers → Timer Resources: uses mapping (evidence: `Drivers/TIMERS/timer.c`)
