Skip to content
flintOS

API Reference

The full, generated API for every crate in the workspace. Regenerated from the source on each build (make apidoc), so it cannot drift from the code, and indexed by this site’s search.

Crates

Section titled “Crates”
  • api — FlintOS public API crate.
  • arch_armv6m — ARMv6-M primitives shared by Cortex-M0+ targets.
  • axp192 — X-Powers AXP192 — the power-management IC on the M5Stack Core2 (and the
  • bme280 — BME280 temperature / humidity / pressure sensor driver.
  • bmi270 — Bosch BMI270 — 6-axis IMU.
  • board — Board manifest for FlintOS.
  • crypto — First-party no_std cryptographic primitives.
  • esp32_adc — ADC1: eight channels of analog input on GPIO 32–39.
  • esp32_adc2 — ADC2: ten channels of analog input, sharing their SAR with the Wi-Fi radio.
  • esp32_crypto — The ESP32’s SHA and AES hardware accelerators.
  • esp32_dac — DAC: two 8-bit analog outputs on GPIO 25 and GPIO 26.
  • esp32_flash — Raw SPI flash access, driving SPI1 directly.
  • esp32_gpio
  • esp32_i2c
  • esp32_i2s — I2S0, driven as a DMA loopback.
  • esp32_ledc — LEDC: the ESP32’s PWM generator.
  • esp32_mcpwm — MCPWM: motor-control PWM — one unit (MCPWM0), timer 0, operator 0.
  • esp32_pcnt — PCNT: the ESP32’s pulse counter — eight units, each a signed 16-bit counter
  • esp32_rmt — RMT: the remote-control peripheral, used here as a precise pulse generator.
  • esp32_rng — The ESP32’s hardware random number generator.
  • esp32_spi
  • esp32_template — Skeleton Layer-1 esp32 driver — copy this, don’t ship it.
  • esp32_timg — TIMG0 and TIMG1: four 64-bit general-purpose timers.
  • esp32_touch — Capacitive touch sensor: ten channels (T0–T9) sharing pads with GPIO.
  • esp32_twai — TWAI (CAN 2.0): the ESP32’s CAN controller, an SJA1000-style core.
  • esp32_uart
  • esp32_wdt — The ESP32’s watchdogs.
  • ft6336u — FocalTech FT6336U — self-capacitive touch-panel controller.
  • hal — FlintOS Hardware Abstraction Layer.
  • heap — A free-list allocator over regions the caller supplies.
  • i2c_bus — I2C bus abstraction.
  • ili9342c — ILI9342C — a 320×240 RGB565 SPI TFT controller.
  • kernel — The FlintOS kernel.
  • kvstore — A key/value store that survives being interrupted.
  • led_matrix — Chained LED panels: turning (x, y) into a position along the chain.
  • led_strip — What an addressable LED strip promises, and code written against it.
  • mpu6886 — InvenSense MPU6886 — 6-axis IMU.
  • radio_esp32 — The adapter between Espressif’s radio blobs and FlintOS.
  • rp2040_adc — RP2040’s single 12-bit SAR ADC.
  • rp2040_entropy — A conditioned, best-effort RP2040 entropy seed.
  • rp2040_flash — Exclusive, word-oriented NOR region using the RP2040 ROM flash routines.
  • rp2040_gpio
  • rp2040_i2c — RP2040 DesignWare I2C controllers.
  • rp2040_pio — Exclusive block ownership, private instruction lowering and bounded FIFOs.
  • rp2040_pwm
  • rp2040_spi — RP2040’s two ARM PL022 SPI controllers.
  • rp2040_uart — RP2040 UART driver for the chip’s ARM PL011-compatible controllers.
  • rp2040_usb — Single-buffered USB device controller. No descriptors, CDC or kernel policy.
  • soc_esp32 — ESP32 SoC support.
  • soc_rp2040 — RP2040 chip facts used before peripheral drivers exist.
  • spi_bus — SPI bus abstraction.
  • ssd1306 — SSD1306 OLED display driver (128x64, I2C).
  • usb_device — Portable, allocation-free USB CDC device service. The board constructs it;
  • wpa — A first-party WPA2/WPA3-Personal supplicant: the 4-way handshake.
  • ws2812 — WS2812 / SK6812 addressable LEDs.