Crate esp32s3_hal

source ·
Expand description

no_std HAL for the ESP32-S3 from Espressif.

Implements a number of the traits defined by the various packages in the embedded-hal repository.

Cargo Features

  • async - Enable support for asynchronous operation, with interfaces provided by embedded-hal-async and embedded-io-async
  • debug - Enable debug features in the HAL (used for development)
  • defmt - Enable defmt::Format on certain types
  • direct-boot - Use the direct boot image format
  • eh1 - Implement the traits defined in the 1.0.0-xxx pre-releases of embedded-hal, embedded-hal-nb, and embedded-io
  • embassy - Enable support for embassy, a modern asynchronous embedded framework. One of embassy-time-* features must also be enabled when using this feature.
  • embassy-executor-interrupt - Use the multicore-aware interrupt-mode embassy executor
  • embassy-executor-thread - Use the multicore-aware thread-mode embassy executor
  • embassy-time-systick - Enable the embassy time driver using the SYSTIMER peripheral
  • embassy-time-timg0 - Enable the embassy time driver using the TIMG0 peripheral
  • log - enable log output using the log crate
  • opsram-2m - Use externally connected Octal PSRAM (2MB)
  • opsram-4m - Use externally connected Octal PSRAM (4MB)
  • opsram-8m - Use externally connected Octal PSRAM (8MB)
  • opsram-16m- Use externally connected Octal PSRAM (16MB)
  • psram-2m - Use externally connected PSRAM (2MB)
  • psram-4m - Use externally connected PSRAM (4MB)
  • psram-8m - Use externally connected PSRAM (8MB)
  • rt - Runtime support
  • ufmt - Implement the ufmt_write::uWrite trait for the UART driver
  • vectored - Enable interrupt vectoring
Default Features

The rt and vectored features are enabled by default.

Supported Image Formats

This HAL supports building multiple different application image formats. You can read about each below.

The ESP-IDF Bootloader format is used unless some other format is specified via its feature.

ESP-IDF Bootloader

Use the second-stage bootloader from ESP-IDF and its associated application image format. See the App Image Format documentation for more information about this format.

Direct Boot

This device additionally supports direct-boot, which allows an application to be executed directly from flash, without using the second-stage bootloader. For more information please see the esp32c3-direct-boot-example in the Espressif organization on GitHub.

Modules

  • aes
    Advanced Encryption Standard (AES) support.
  • analog
    Analog peripherals
  • assist_debug
    Debug Assistant
  • clock
    Clock Control
  • cpu_control
    Control CPU Cores (ESP32-S3)
  • delay
    Delay driver
  • dma
    Direct Memory Access Commons
  • efuse
    Reading of eFuses (ESP32-S3)
  • gpio
    General Purpose I/Os
  • hmac
    HMAC Accelerator
  • i2c
    I2C Driver
  • i2s
    I2S Master
  • interrupt
    Interrupt support
  • ledc
    LEDC (LED PWM Controller) peripheral control
  • macros
    Overview
  • mcpwm
    MCPWM (Motor Control Pulse Width Modulator) peripheral
  • otg_fs
    USB OTG full-speed peripheral
  • pcnt
    Pulse Counter peripheral driver
  • peripheral
    Exclusive peripheral access
  • peripherals
    Peripheral instance singletons (ESP32-S3)
  • prelude
    The prelude
  • psram
    PSRAM “virtual peripheral” driver (ESP32-S2)
  • reset
    Hardware and Software Reset
  • rmt
    Remote Control Peripheral (RMT)
  • rng
    Random Number Generator
  • rom
    ESP ROM libraries
  • rsa
    RSA Accelerator support.
  • rtc_cntl
    RTC_CNTL (Real-Time Clock Control) and Low-power Management
  • sha
    Secure Hash Algorithm peripheral driver
  • spi
    Serial Peripheral Interface
  • system
    System Control
  • systimer
    System Timer peripheral driver
  • timer
    General-purpose timers
  • trapframe
    State of the CPU saved when entering exception or interrupt
  • twai
    Two-wire Automotive Interface (TWAI)
  • uart
    UART driver
  • ulp_core
    Control the ULP core
  • usb_serial_jtag
    USB Serial JTAG peripheral driver
  • xtensa_lx
  • xtensa_lx_rt

Structs

Enums

  • Cpu
    Available CPU cores

Functions

  • get_core
    Which core the application is currently executing on

Attribute Macros

  • entry
    Marks a function as the main function to be called on program start