mirror of
https://github.com/saymrwulf/xous-core.git
synced 2026-11-18 08:52:45 +00:00
fix API to allow for composition of IO configurations
the main issue is that if the IO configuration fully replaces a previous configuration, two apps can't be loaded at the same time because the later one replaces the previous one's configuration. now the I/O settings take an option for a configuration mode, which is somewhat clumsily expressed as either replacing the I/O configuration, setting bits only, or clearing bits only. This maybe could use a cleaner API but not quite sure how to do it yet.
This commit is contained in:
parent
1bc7cfc7d2
commit
d647e41822
2 changed files with 98 additions and 39 deletions
|
|
@ -4,40 +4,6 @@
|
||||||
//! and pins are explicitly managed. That is: we don't try and be clever and try to imply any
|
//! and pins are explicitly managed. That is: we don't try and be clever and try to imply any
|
||||||
//! allocations. The developer has to correctly identify which engine to place their code on,
|
//! allocations. The developer has to correctly identify which engine to place their code on,
|
||||||
//! and which I/Os, if any, the thing uses.
|
//! and which I/Os, if any, the thing uses.
|
||||||
//!
|
|
||||||
//! Here is the reference for what register correspond to what functions in BIO:
|
|
||||||
//!
|
|
||||||
//! FIFO - 8-deep fifo head/tail access. Cores halt on overflow/underflow.
|
|
||||||
//! - x16 r/w fifo[0]
|
|
||||||
//! - x17 r/w fifo[1]
|
|
||||||
//! - x18 r/w fifo[2]
|
|
||||||
//! - x19 r/w fifo[3]
|
|
||||||
//!
|
|
||||||
//! Quantum - core will halt until host-configured clock divider pules occurs,
|
|
||||||
//! or an external event comes in on a host-specified GPIO pin.
|
|
||||||
//! - x20 -/w halt to quantum
|
|
||||||
//!
|
|
||||||
//! GPIO - note clear-on-0 semantics for bit-clear for data pins!
|
|
||||||
//! This is done so we can do a shift-and-move without an invert to
|
|
||||||
//! bitbang a data pin. Direction retains a more "conventional" meaning
|
|
||||||
//! where a write of `1` to either clear or set will cause the action,
|
|
||||||
//! as pin direction toggling is less likely to be in a tight inner loop.
|
|
||||||
//! - x21 r/w write: (x26 & x21) -> gpio pins; read: gpio pins -> x21
|
|
||||||
//! - x22 -/w (x26 & x22) -> `1` will set corresponding pin on gpio
|
|
||||||
//! - x23 -/w (x26 & x23) -> `0` will clear corresponding pin on gpio
|
|
||||||
//! - x24 -/w (x26 & x24) -> `1` will make corresponding gpio pin an output
|
|
||||||
//! - x25 -/w (x26 & x25) -> `1` will make corresponding gpio pin an input
|
|
||||||
//! - x26 r/w mask GPIO action outputs
|
|
||||||
//!
|
|
||||||
//! Events - operate on a shared event register. Bits [31:24] are hard-wired to FIFO
|
|
||||||
//! level flags, configured by the host; writes to bits [31:24] are ignored.
|
|
||||||
//! - x27 -/w mask event sensitivity bits
|
|
||||||
//! - x28 -/w `1` will set the corresponding event bit. Only [23:0] are wired up.
|
|
||||||
//! - x29 -/w `1` will clear the corresponding event bit Only [23:0] are wired up.
|
|
||||||
//! - x30 r/- halt until ((x27 & events) != 0), and return unmasked `events` value
|
|
||||||
//!
|
|
||||||
//! Core ID & debug:
|
|
||||||
//! - x31 r/- [31:30] -> core ID; [29:0] -> cpu clocks since reset
|
|
||||||
|
|
||||||
// Other notes:
|
// Other notes:
|
||||||
//
|
//
|
||||||
|
|
@ -51,6 +17,8 @@ use bitbybit::bitfield;
|
||||||
use num_traits::ToPrimitive;
|
use num_traits::ToPrimitive;
|
||||||
use xous::MemoryRange;
|
use xous::MemoryRange;
|
||||||
|
|
||||||
|
use crate::IoxPort;
|
||||||
|
|
||||||
pub const BIO_SERVER_NAME: &'static str = "_BIO server_";
|
pub const BIO_SERVER_NAME: &'static str = "_BIO server_";
|
||||||
|
|
||||||
/// A platform-neutral API for the BIO. Intended to be usable in both baremetal and `std` environments
|
/// A platform-neutral API for the BIO. Intended to be usable in both baremetal and `std` environments
|
||||||
|
|
@ -323,9 +291,34 @@ pub struct CoreConfig {
|
||||||
pub clock_mode: ClockMode,
|
pub clock_mode: ClockMode,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
|
||||||
|
#[repr(usize)]
|
||||||
|
#[cfg_attr(feature = "std", derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize))]
|
||||||
|
pub enum IoConfigMode {
|
||||||
|
/// values in the structure will overwrite everything
|
||||||
|
Overwrite = 0,
|
||||||
|
/// only values that are `1` will set the corresponding bit
|
||||||
|
SetOnly = 1,
|
||||||
|
/// only values that are `1` will clear the corresponding bit
|
||||||
|
ClearOnly = 2,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<usize> for IoConfigMode {
|
||||||
|
fn from(value: usize) -> Self {
|
||||||
|
match value {
|
||||||
|
0 => IoConfigMode::Overwrite,
|
||||||
|
1 => IoConfigMode::SetOnly,
|
||||||
|
2 => IoConfigMode::ClearOnly,
|
||||||
|
_ => unimplemented!(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone)]
|
#[derive(Debug, Copy, Clone)]
|
||||||
#[cfg_attr(feature = "std", derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize))]
|
#[cfg_attr(feature = "std", derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize))]
|
||||||
pub struct IoConfig {
|
pub struct IoConfig {
|
||||||
|
/// See definition of IoConfigMode enum
|
||||||
|
pub mode: IoConfigMode,
|
||||||
/// bits set to `1` here are mapped to the BIO instead of the GPIO
|
/// bits set to `1` here are mapped to the BIO instead of the GPIO
|
||||||
pub mapped: u32,
|
pub mapped: u32,
|
||||||
/// bits set to `1` in the u32 corresponding to BIO inputs passed in as raw, unsynchronized
|
/// bits set to `1` in the u32 corresponding to BIO inputs passed in as raw, unsynchronized
|
||||||
|
|
@ -347,6 +340,7 @@ pub struct IoConfig {
|
||||||
impl Default for IoConfig {
|
impl Default for IoConfig {
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
Self {
|
Self {
|
||||||
|
mode: IoConfigMode::Overwrite,
|
||||||
mapped: 0,
|
mapped: 0,
|
||||||
sync_bypass: 0,
|
sync_bypass: 0,
|
||||||
oe_inv: 0,
|
oe_inv: 0,
|
||||||
|
|
@ -515,3 +509,66 @@ impl Drop for CoreHandle {
|
||||||
.unwrap();
|
.unwrap();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn bio_bit_to_port_and_pin(bit: arbitrary_int::u5) -> (IoxPort, u8) {
|
||||||
|
match bit.value() {
|
||||||
|
// For bao1x the ports should be in correct order
|
||||||
|
0 => (IoxPort::PB, 0),
|
||||||
|
1 => (IoxPort::PB, 1),
|
||||||
|
2 => (IoxPort::PB, 2),
|
||||||
|
3 => (IoxPort::PB, 3),
|
||||||
|
4 => (IoxPort::PB, 4),
|
||||||
|
5 => (IoxPort::PB, 5),
|
||||||
|
6 => (IoxPort::PB, 6),
|
||||||
|
7 => (IoxPort::PB, 7),
|
||||||
|
8 => (IoxPort::PB, 8),
|
||||||
|
9 => (IoxPort::PB, 9),
|
||||||
|
10 => (IoxPort::PB, 10),
|
||||||
|
11 => (IoxPort::PB, 11),
|
||||||
|
12 => (IoxPort::PB, 12),
|
||||||
|
13 => (IoxPort::PB, 13),
|
||||||
|
14 => (IoxPort::PB, 14),
|
||||||
|
15 => (IoxPort::PB, 15),
|
||||||
|
// Port C
|
||||||
|
16 => (IoxPort::PC, 0),
|
||||||
|
17 => (IoxPort::PC, 1),
|
||||||
|
18 => (IoxPort::PC, 2),
|
||||||
|
19 => (IoxPort::PC, 3),
|
||||||
|
20 => (IoxPort::PC, 4),
|
||||||
|
21 => (IoxPort::PC, 5),
|
||||||
|
22 => (IoxPort::PC, 6),
|
||||||
|
23 => (IoxPort::PC, 7),
|
||||||
|
24 => (IoxPort::PC, 8),
|
||||||
|
25 => (IoxPort::PC, 9),
|
||||||
|
26 => (IoxPort::PC, 10),
|
||||||
|
27 => (IoxPort::PC, 11),
|
||||||
|
28 => (IoxPort::PC, 12),
|
||||||
|
29 => (IoxPort::PC, 13),
|
||||||
|
30 => (IoxPort::PC, 14),
|
||||||
|
31 => (IoxPort::PC, 15),
|
||||||
|
_ => unreachable!(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn port_and_pin_to_bio_bit(port: IoxPort, pin: u8) -> Option<arbitrary_int::u5> {
|
||||||
|
match port {
|
||||||
|
IoxPort::PA => None,
|
||||||
|
IoxPort::PB => {
|
||||||
|
if pin >= 16 {
|
||||||
|
None
|
||||||
|
} else {
|
||||||
|
let bio_bit = 15 - pin;
|
||||||
|
Some(arbitrary_int::u5::new(bio_bit))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
IoxPort::PC => {
|
||||||
|
if pin < 16 {
|
||||||
|
let bio_bit = pin + 16;
|
||||||
|
Some(arbitrary_int::u5::new(bio_bit))
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_ => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -83,7 +83,7 @@ pub trait IoSetup {
|
||||||
strength: Option<IoxDriveStrength>,
|
strength: Option<IoxDriveStrength>,
|
||||||
);
|
);
|
||||||
fn set_bio_bit_from_port_and_pin(&self, port: IoxPort, pin: u8) -> Option<u8>;
|
fn set_bio_bit_from_port_and_pin(&self, port: IoxPort, pin: u8) -> Option<u8>;
|
||||||
fn set_ports_from_bio_bitmask(&self, enable_bitmask: u32);
|
fn set_ports_from_bio_bitmask(&self, enable_bitmask: u32, io_mode: crate::bio::IoConfigMode);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Traits for accessing GPIOs after the port has been set up.
|
/// Traits for accessing GPIOs after the port has been set up.
|
||||||
|
|
@ -225,7 +225,9 @@ impl IoxHal {
|
||||||
/// by the mapping request. The index of the array corresponds to the bit position in
|
/// by the mapping request. The index of the array corresponds to the bit position in
|
||||||
/// the bitmask. You may use this to pass as arguments to further functions
|
/// the bitmask. You may use this to pass as arguments to further functions
|
||||||
/// that do things like control slew rate or apply pull-ups.
|
/// that do things like control slew rate or apply pull-ups.
|
||||||
pub fn set_ports_from_bio_bitmask(&self, enable_bitmask: u32) {
|
///
|
||||||
|
/// Note: IoConfigMode is only lightly tested. ClearOnly mode in particular could have bugs.
|
||||||
|
pub fn set_ports_from_bio_bitmask(&self, enable_bitmask: u32, io_mode: crate::bio::IoConfigMode) {
|
||||||
xous::send_message(
|
xous::send_message(
|
||||||
self.conn,
|
self.conn,
|
||||||
xous::Message::new_blocking_scalar(
|
xous::Message::new_blocking_scalar(
|
||||||
|
|
@ -233,7 +235,7 @@ impl IoxHal {
|
||||||
enable_bitmask as usize,
|
enable_bitmask as usize,
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
0,
|
io_mode as usize,
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
.expect("Internal error setting up BIO");
|
.expect("Internal error setting up BIO");
|
||||||
|
|
@ -288,7 +290,7 @@ impl IoSetup for IoxHal {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn set_ports_from_bio_bitmask(&self, enable_bitmask: u32) {
|
fn set_ports_from_bio_bitmask(&self, enable_bitmask: u32, io_mode: crate::bio::IoConfigMode) {
|
||||||
xous::send_message(
|
xous::send_message(
|
||||||
self.conn,
|
self.conn,
|
||||||
xous::Message::new_blocking_scalar(
|
xous::Message::new_blocking_scalar(
|
||||||
|
|
@ -296,7 +298,7 @@ impl IoSetup for IoxHal {
|
||||||
enable_bitmask as usize,
|
enable_bitmask as usize,
|
||||||
0,
|
0,
|
||||||
1,
|
1,
|
||||||
0,
|
io_mode as usize,
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
.expect("Internal error setting up BIO");
|
.expect("Internal error setting up BIO");
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue