# hirakuni45/r8c architecture

> Architecture diagram of the GitHub repository hirakuni45/r8c, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/hirakuni45/r8c
- Repository: https://github.com/hirakuni45/r8c

## Overview

This repository is an R8C/M110AN and M120AN embedded firmware ecosystem: device-register templates, shared I/O and utility classes, chip drivers, and many hardware-focused examples. The main user workflow is to build firmware around the MCU and shared runtime, use a peripheral driver or utility in an application, and run it directly on the target; a separate host tool programs R8C flash. The README documents the broad capabilities, while source excerpts and the index support only selected implementation links; unsampled example and driver relationships are therefore left out where unverified.

Main entry points: [`common/renesas.hpp`](https://github.com/hirakuni45/r8c/blob/master/common/renesas.hpp) (R8C facade), [`LCD_DOT_sample/main.cpp`](https://github.com/hirakuni45/r8c/blob/master/LCD_DOT_sample/main.cpp) (Display examples), [`r8cprog/main.cpp`](https://github.com/hirakuni45/r8c/blob/master/r8cprog/main.cpp) (Programmer CLI), [`common/monograph.hpp`](https://github.com/hirakuni45/r8c/blob/master/common/monograph.hpp) (Monochrome graphics)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_platform["MCU platform"]
  node_device_defs["Device definitions<br/>[system.hpp]"]
  node_interrupts["Interrupt vectors<br/>[intr.hpp]"]
  node_device_facade["R8C facade<br/>[renesas.hpp]"]
end

subgraph group_runtime["Shared runtime"]
  node_vectors["Vector table<br/>[vect.h]"]
  node_timers["Timer I/O<br/>[trb_io.hpp]"]
  node_serial["UART I/O<br/>[uart_io.hpp]"]
  node_adc["ADC I/O<br/>[adc_io.hpp]"]
  node_spi["Software SPI<br/>[spi_io.hpp]"]
  node_utilities["Runtime utilities<br/>[command.hpp]"]
  node_input["Input handling<br/>[input.hpp]"]
  node_graphics["Monochrome graphics<br/>[monograph.hpp]"]
  node_formatting["Formatting<br/>[format.hpp]"]
  node_fifo["FIFO buffers<br/>[fifo.hpp]"]
end

subgraph group_drivers["Peripheral drivers"]
  node_can_driver["CAN driver<br/>[MCP2515.hpp]"]
  node_sensor_drivers["Sensor drivers<br/>[BMP180.hpp]"]
  node_storage_drivers["SD card access<br/>[mmc_io.hpp]"]
  node_rtc_drivers["RTC drivers<br/>[DS3231.hpp]"]
end

subgraph group_firmware["Firmware examples"]
  node_sample_sensors["Sensor examples<br/>[main.cpp]"]
  node_sample_storage["Storage examples<br/>[main.cpp]"]
  node_sample_audio["Audio playback<br/>[main.cpp]"]
  node_sample_display["Display examples<br/>[main.cpp]"]
  node_sample_control["Control examples<br/>[main.cpp]"]
end

subgraph group_programmer["Flash programming"]
  node_programmer_cli["Programmer CLI<br/>[main.cpp]"]
  node_programmer_protocol["Flash protocol<br/>[r8c_prog.hpp]"]
end

node_engineer(("Firmware developer"))

node_engineer -->|"develops firmware"| node_device_facade
node_device_facade -->|"includes device headers"| node_device_defs
node_device_facade -->|"includes interrupt headers"| node_interrupts
node_device_facade -->|"includes vectors"| node_vectors
node_device_facade -->|"includes timer I/O"| node_timers
node_device_facade -->|"includes UART I/O"| node_serial
node_device_facade -->|"includes ADC headers"| node_adc
node_device_facade -->|"includes utilities"| node_utilities
node_sample_sensors -->|"uses driver"| node_sensor_drivers
node_sample_storage -->|"uses card access"| node_storage_drivers
node_sample_audio -->|"uses card access"| node_storage_drivers
node_sample_display -->|"uses SPI"| node_spi
node_sample_display -->|"uses graphics"| node_graphics
node_sample_control -->|"uses graphics"| node_graphics
node_engineer -->|"programs target"| node_programmer_cli
node_programmer_cli -->|"uses programmer logic"| node_programmer_protocol
node_engineer -->|"uses chip classes"| node_can_driver
node_engineer -->|"uses chip classes"| node_rtc_drivers

click node_device_defs "https://github.com/hirakuni45/r8c/blob/master/M120AN/system.hpp"
click node_interrupts "https://github.com/hirakuni45/r8c/blob/master/M120AN/intr.hpp"
click node_device_facade "https://github.com/hirakuni45/r8c/blob/master/common/renesas.hpp"
click node_vectors "https://github.com/hirakuni45/r8c/blob/master/common/vect.h"
click node_timers "https://github.com/hirakuni45/r8c/blob/master/common/trb_io.hpp"
click node_serial "https://github.com/hirakuni45/r8c/blob/master/common/uart_io.hpp"
click node_adc "https://github.com/hirakuni45/r8c/blob/master/common/adc_io.hpp"
click node_spi "https://github.com/hirakuni45/r8c/blob/master/common/spi_io.hpp"
click node_utilities "https://github.com/hirakuni45/r8c/blob/master/common/command.hpp"
click node_input "https://github.com/hirakuni45/r8c/blob/master/common/input.hpp"
click node_graphics "https://github.com/hirakuni45/r8c/blob/master/common/monograph.hpp"
click node_formatting "https://github.com/hirakuni45/r8c/blob/master/common/format.hpp"
click node_fifo "https://github.com/hirakuni45/r8c/blob/master/common/fifo.hpp"
click node_can_driver "https://github.com/hirakuni45/r8c/blob/master/chip/MCP2515.hpp"
click node_sensor_drivers "https://github.com/hirakuni45/r8c/blob/master/chip/BMP180.hpp"
click node_storage_drivers "https://github.com/hirakuni45/r8c/blob/master/pfatfs/mmc_io.hpp"
click node_rtc_drivers "https://github.com/hirakuni45/r8c/blob/master/chip/DS3231.hpp"
click node_sample_sensors "https://github.com/hirakuni45/r8c/blob/master/BMP180_sample/main.cpp"
click node_sample_storage "https://github.com/hirakuni45/r8c/blob/master/SD_sample/main.cpp"
click node_sample_audio "https://github.com/hirakuni45/r8c/blob/master/SD_WAV_play/main.cpp"
click node_sample_display "https://github.com/hirakuni45/r8c/blob/master/LCD_DOT_sample/main.cpp"
click node_sample_control "https://github.com/hirakuni45/r8c/blob/master/PLUSE_OUT_LCD/main.cpp"
click node_programmer_cli "https://github.com/hirakuni45/r8c/blob/master/r8cprog/main.cpp"
click node_programmer_protocol "https://github.com/hirakuni45/r8c/blob/master/r8cprog/r8c_prog.hpp"

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_device_defs,node_interrupts,node_device_facade toneBlue
class node_vectors,node_timers,node_serial,node_adc,node_spi,node_utilities,node_input,node_graphics,node_formatting,node_fifo toneAmber
class node_can_driver,node_sensor_drivers,node_storage_drivers,node_rtc_drivers toneMint
class node_sample_sensors,node_sample_storage,node_sample_audio,node_sample_display,node_sample_control toneRose
class node_programmer_cli,node_programmer_protocol,node_engineer toneIndigo
```

## Components

### MCU platform

- [Device definitions](https://github.com/hirakuni45/r8c/blob/master/M120AN/system.hpp): `M120AN/system.hpp`
- [Interrupt vectors](https://github.com/hirakuni45/r8c/blob/master/M120AN/intr.hpp): `M120AN/intr.hpp`
- [R8C facade](https://github.com/hirakuni45/r8c/blob/master/common/renesas.hpp): `common/renesas.hpp`

### Shared runtime

- [Vector table](https://github.com/hirakuni45/r8c/blob/master/common/vect.h): `common/vect.h`
- [Timer I/O](https://github.com/hirakuni45/r8c/blob/master/common/trb_io.hpp): `common/trb_io.hpp`
- [UART I/O](https://github.com/hirakuni45/r8c/blob/master/common/uart_io.hpp): `common/uart_io.hpp`
- [ADC I/O](https://github.com/hirakuni45/r8c/blob/master/common/adc_io.hpp): `common/adc_io.hpp`
- [Software SPI](https://github.com/hirakuni45/r8c/blob/master/common/spi_io.hpp): `common/spi_io.hpp`
- [Runtime utilities](https://github.com/hirakuni45/r8c/blob/master/common/command.hpp): `common/command.hpp`
- [Input handling](https://github.com/hirakuni45/r8c/blob/master/common/input.hpp): `common/input.hpp`
- [Monochrome graphics](https://github.com/hirakuni45/r8c/blob/master/common/monograph.hpp): `common/monograph.hpp`
- [Formatting](https://github.com/hirakuni45/r8c/blob/master/common/format.hpp): `common/format.hpp`
- [FIFO buffers](https://github.com/hirakuni45/r8c/blob/master/common/fifo.hpp): `common/fifo.hpp`

### Peripheral drivers

- [CAN driver](https://github.com/hirakuni45/r8c/blob/master/chip/MCP2515.hpp): `chip/MCP2515.hpp`
- [Sensor drivers](https://github.com/hirakuni45/r8c/blob/master/chip/BMP180.hpp): `chip/BMP180.hpp`
- [SD card access](https://github.com/hirakuni45/r8c/blob/master/pfatfs/mmc_io.hpp): `pfatfs/mmc_io.hpp`
- [RTC drivers](https://github.com/hirakuni45/r8c/blob/master/chip/DS3231.hpp): `chip/DS3231.hpp`

### Firmware examples

- [Sensor examples](https://github.com/hirakuni45/r8c/blob/master/BMP180_sample/main.cpp): `BMP180_sample/main.cpp`
- [Storage examples](https://github.com/hirakuni45/r8c/blob/master/SD_sample/main.cpp): `SD_sample/main.cpp`
- [Audio playback](https://github.com/hirakuni45/r8c/blob/master/SD_WAV_play/main.cpp): `SD_WAV_play/main.cpp`
- [Display examples](https://github.com/hirakuni45/r8c/blob/master/LCD_DOT_sample/main.cpp): `LCD_DOT_sample/main.cpp`
- [Control examples](https://github.com/hirakuni45/r8c/blob/master/PLUSE_OUT_LCD/main.cpp): `PLUSE_OUT_LCD/main.cpp`

### Flash programming

- [Programmer CLI](https://github.com/hirakuni45/r8c/blob/master/r8cprog/main.cpp): `r8cprog/main.cpp`
- [Flash protocol](https://github.com/hirakuni45/r8c/blob/master/r8cprog/r8c_prog.hpp): `r8cprog/r8c_prog.hpp`

### Other components

- **Firmware developer**

## Connections

- Firmware developer → R8C facade: develops firmware (evidence: `README.md`)
- R8C facade → Device definitions: includes device headers (evidence: `common/renesas.hpp`)
- R8C facade → Interrupt vectors: includes interrupt headers (evidence: `common/renesas.hpp`)
- R8C facade → Vector table: includes vectors (evidence: `common/renesas.hpp`)
- R8C facade → Timer I/O: includes timer I/O (evidence: `common/renesas.hpp`)
- R8C facade → UART I/O: includes UART I/O (evidence: `common/renesas.hpp`)
- R8C facade → ADC I/O: includes ADC headers (evidence: `common/renesas.hpp`)
- R8C facade → Runtime utilities: includes utilities (evidence: `common/renesas.hpp`)
- Sensor examples → Sensor drivers: uses driver (evidence: `BMP180_sample/main.cpp`)
- Storage examples → SD card access: uses card access (evidence: `SD_sample/main.cpp`)
- Audio playback → SD card access: uses card access (evidence: `SD_WAV_play/main.cpp`)
- Display examples → Software SPI: uses SPI (evidence: `LCD_DOT_sample/main.cpp`)
- Display examples → Monochrome graphics: uses graphics (evidence: `LCD_DOT_sample/main.cpp`)
- Control examples → Monochrome graphics: uses graphics (evidence: `PLUSE_OUT_LCD/main.cpp`)
- Firmware developer → Programmer CLI: programs target (evidence: `README.md`)
- Programmer CLI → Flash protocol: uses programmer logic (evidence: `r8cprog/main.cpp`)
- Firmware developer → CAN driver: uses chip classes (evidence: `README.md`)
- Firmware developer → RTC drivers: uses chip classes (evidence: `README.md`)
