docs: RMT_CHANNEL_RAM_SIZE counts pulse codes, not bytes (#2955)

checked all values against the technical reference manuals
This commit is contained in:
Benedikt 2025-01-16 18:04:59 +01:00 committed by GitHub
parent 660e43effa
commit 6583f1c617
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 6 additions and 6 deletions

View File

@ -44,7 +44,7 @@ pub(crate) mod constants {
pub const I2S_DEFAULT_CLK_SRC: u32 = 2;
/// The starting address of the Remote Control (RMT) module's RAM.
pub const RMT_RAM_START: usize = 0x3ff56800;
/// The size, in bytes, of each RMT channel's dedicated RAM.
/// The size (number of pulse codes) of each RMT channel's dedicated RAM.
pub const RMT_CHANNEL_RAM_SIZE: usize = 64;
/// The lower bound of the system's DRAM (Data RAM) address space.
pub const SOC_DRAM_LOW: usize = 0x3FFA_E000;

View File

@ -47,7 +47,7 @@ pub(crate) mod constants {
/// The starting address of the Remote Control (RMT) module's RAM.
pub const RMT_RAM_START: usize = 0x60016400;
/// The size, in bytes, of each RMT channel's dedicated RAM.
/// The size (number of pulse codes) of each RMT channel's dedicated RAM.
pub const RMT_CHANNEL_RAM_SIZE: usize = 48;
/// RMT Clock source value.
pub const RMT_CLOCK_SRC: u8 = 1;

View File

@ -52,7 +52,7 @@ pub(crate) mod constants {
/// The starting address of the RMT (Remote Control) peripheral's RAM.
pub const RMT_RAM_START: usize = 0x60006400;
/// The size of each RMT channel's RAM in bytes.
/// The size (number of pulse codes) of each RMT channel's dedicated RAM.
pub const RMT_CHANNEL_RAM_SIZE: usize = 48;
/// The default clock source for the RMT peripheral.
pub const RMT_CLOCK_SRC: u8 = 1;

View File

@ -51,7 +51,7 @@ pub(crate) mod constants {
/// Start address of the RMT (Remote Control) peripheral's RAM.
pub const RMT_RAM_START: usize = 0x60007400;
/// Size of the RAM allocated per RMT channel, in bytes.
/// The size (number of pulse codes) of each RMT channel's dedicated RAM.
pub const RMT_CHANNEL_RAM_SIZE: usize = 48;
/// Clock source for the RMT peripheral (false = default source).
pub const RMT_CLOCK_SRC: bool = false;

View File

@ -48,7 +48,7 @@ pub(crate) mod constants {
pub const I2S_DEFAULT_CLK_SRC: u32 = 2;
/// Start address of the RMT (Remote Control) peripheral's RAM.
pub const RMT_RAM_START: usize = 0x3f416400;
/// Size of the RAM allocated per RMT channel, in bytes.
/// The size (number of pulse codes) of each RMT channel's dedicated RAM.
pub const RMT_CHANNEL_RAM_SIZE: usize = 64;
/// Start address of the system's DRAM (low range).
pub const SOC_DRAM_LOW: usize = 0x3FFB_0000;

View File

@ -50,7 +50,7 @@ pub(crate) mod constants {
/// The starting address of the Remote Control (RMT) module's RAM.
pub const RMT_RAM_START: usize = 0x60016800;
/// The size, in bytes, of each RMT channel's dedicated RAM.
/// The size (number of pulse codes) of each RMT channel's dedicated RAM.
pub const RMT_CHANNEL_RAM_SIZE: usize = 48;
/// RMT Clock source value.
pub const RMT_CLOCK_SRC: u8 = 1;