cleanup missing APIs

- need to be able to specify the mode that a SPIM could be in
that was set up by the bootloader
- make yield() optional - it could be useful if the API is used
in userland contexts, but in an interrupt context (e.g. swapper)
it should not be used.
This commit is contained in:
bunnie 2024-05-06 02:26:55 +08:00
parent f6dd848ef4
commit 6723b9d67c

View file

@ -876,6 +876,7 @@ impl Spim {
max_tx_len_bytes: usize, max_tx_len_bytes: usize,
max_rx_len_bytes: usize, max_rx_len_bytes: usize,
dummy_cycles: Option<u8>, dummy_cycles: Option<u8>,
mode: Option<SpimMode>,
ifram: IframRange, ifram: IframRange,
) -> Self { ) -> Self {
// this is a hardware limit - the DMA pointer is only this long! // this is a hardware limit - the DMA pointer is only this long!
@ -913,7 +914,7 @@ impl Spim {
eot_wait, eot_wait,
event_channel, event_channel,
_align: SpimByteAlign::Disable, _align: SpimByteAlign::Disable,
mode: SpimMode::Standard, mode: mode.unwrap_or(SpimMode::Standard),
ifram, ifram,
tx_buf_len_bytes: max_tx_len_bytes, tx_buf_len_bytes: max_tx_len_bytes,
rx_buf_len_bytes: max_rx_len_bytes, rx_buf_len_bytes: max_rx_len_bytes,
@ -1231,7 +1232,8 @@ impl Spim {
self.mem_cs(false); self.mem_cs(false);
} }
pub fn mem_read(&mut self, addr: u32, buf: &mut [u8]) { /// Note that `use_yield` is disallowed in interrupt contexts (e.g. swapper)
pub fn mem_read(&mut self, addr: u32, buf: &mut [u8], _use_yield: bool) {
// divide into buffer-sized chunks + repeat cycle on each buffer increment // divide into buffer-sized chunks + repeat cycle on each buffer increment
// this is because the size of the buffer is meant to represent the limit of the // this is because the size of the buffer is meant to represent the limit of the
// target device's memory page (i.e., the point at which you'd wrap when reading) // target device's memory page (i.e., the point at which you'd wrap when reading)
@ -1272,7 +1274,9 @@ impl Spim {
)]; )];
while self.udma_busy(Bank::Tx) { while self.udma_busy(Bank::Tx) {
#[cfg(feature = "std")] #[cfg(feature = "std")]
xous::yield_slice(); if _use_yield {
xous::yield_slice();
}
} }
self.send_cmd_list(&rd_cmd); self.send_cmd_list(&rd_cmd);
// safety: this is safe because rx_buf_phys() slice is only used as a base/bounds reference // safety: this is safe because rx_buf_phys() slice is only used as a base/bounds reference
@ -1281,7 +1285,9 @@ impl Spim {
}; };
while self.udma_busy(Bank::Rx) { while self.udma_busy(Bank::Rx) {
#[cfg(feature = "std")] #[cfg(feature = "std")]
xous::yield_slice(); if _use_yield {
xous::yield_slice();
}
} }
self.mem_cs(false); self.mem_cs(false);
chunk.copy_from_slice(&self.rx_buf()[..chunk.len()]); chunk.copy_from_slice(&self.rx_buf()[..chunk.len()]);
@ -1290,7 +1296,8 @@ impl Spim {
} }
/// This should only be called on SPI RAM -- not valid for FLASH devices, they need a programming routine! /// This should only be called on SPI RAM -- not valid for FLASH devices, they need a programming routine!
pub fn mem_ram_write(&mut self, addr: u32, buf: &[u8]) { /// Note that `use_yield` is disallowed in interrupt contexts
pub fn mem_ram_write(&mut self, addr: u32, buf: &[u8], _use_yield: bool) {
// divide into buffer-sized chunks + repeat cycle on each buffer increment // divide into buffer-sized chunks + repeat cycle on each buffer increment
// this is because the size of the buffer is meant to represent the limit of the // this is because the size of the buffer is meant to represent the limit of the
// target device's memory page (i.e., the point at which you'd wrap when reading) // target device's memory page (i.e., the point at which you'd wrap when reading)
@ -1316,7 +1323,9 @@ impl Spim {
)]; )];
while self.udma_busy(Bank::Tx) { while self.udma_busy(Bank::Tx) {
#[cfg(feature = "std")] #[cfg(feature = "std")]
xous::yield_slice(); if _use_yield {
xous::yield_slice();
}
} }
self.send_cmd_list(&wr_cmd); self.send_cmd_list(&wr_cmd);
self.tx_buf_mut()[..chunk.len()].copy_from_slice(chunk); self.tx_buf_mut()[..chunk.len()].copy_from_slice(chunk);
@ -1326,7 +1335,9 @@ impl Spim {
}; };
while self.udma_busy(Bank::Tx) { while self.udma_busy(Bank::Tx) {
#[cfg(feature = "std")] #[cfg(feature = "std")]
xous::yield_slice(); if _use_yield {
xous::yield_slice();
}
} }
self.mem_cs(false); self.mem_cs(false);
offset += chunk.len(); offset += chunk.len();