some progress on spinor drivers

This commit is contained in:
bunnie 2021-07-14 00:01:09 +08:00
parent 69d34d38dc
commit 98c0054d7e
4 changed files with 121 additions and 60 deletions

View file

@ -3,7 +3,7 @@
<device schemaVersion="1.1" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="CMSIS-SVD.xsd" >
<vendor>litex</vendor>
<name>SOC</name>
<description><![CDATA[Litex SoC 2021-07-13 22:02:21]]></description>
<description><![CDATA[Litex SoC 2021-07-13 23:50:14]]></description>
<addressUnitBits>8</addressUnitBits>
<width>32</width>
@ -1238,10 +1238,10 @@ register to disable individual events.]]></description>
<register>
<name>GIT_GITREV</name>
<description><![CDATA[First 32-bits of the git revision. This documentation was built from git rev
``ab8658b6``, so this value is 2877708470, which should be enough to check out
``09bbc7a6``, so this value is 163301286, which should be enough to check out
the exact git version used to build this firmware.]]></description>
<addressOffset>0x0014</addressOffset>
<resetValue>0xab8658b6</resetValue>
<resetValue>0x9bbc7a6</resetValue>
<size>32</size>
<fields>
<field>
@ -1258,7 +1258,7 @@ the exact git version used to build this firmware.]]></description>
is ``1``, then the repository this was built from has one additional commit
beyond the tag indicated in `MAJOR`, `MINOR`, and `REVISION`.]]></description>
<addressOffset>0x0018</addressOffset>
<resetValue>0x3e</resetValue>
<resetValue>0x40</resetValue>
<size>32</size>
<fields>
<field>
@ -3276,6 +3276,10 @@ checked]]></description>
<size>0x34</size>
<usage>registers</usage>
</addressBlock>
<interrupt>
<name>spinor</name>
<value>12</value>
</interrupt>
</peripheral>
<peripheral>
<name>KEYBOARD</name>
@ -3532,7 +3536,7 @@ again until the interrupt is serviced.]]></description>
</addressBlock>
<interrupt>
<name>keyboard</name>
<value>12</value>
<value>13</value>
</interrupt>
</peripheral>
<peripheral>
@ -3580,7 +3584,7 @@ inject too fast.]]></description>
<name>SEED1</name>
<description><![CDATA[Bits 32-63 of `SEED_SEED`. Seed used for the build]]></description>
<addressOffset>0x0000</addressOffset>
<resetValue>0x4b40c4ec</resetValue>
<resetValue>0x2b76913c</resetValue>
<size>32</size>
<fields>
<field>
@ -3595,7 +3599,7 @@ inject too fast.]]></description>
<name>SEED0</name>
<description><![CDATA[Bits 0-31 of `SEED_SEED`.]]></description>
<addressOffset>0x0004</addressOffset>
<resetValue>0x3e6e25f8</resetValue>
<resetValue>0x4c088e50</resetValue>
<size>32</size>
<fields>
<field>
@ -4054,7 +4058,7 @@ I2S_FORMAT.I2S_STANDARD is I2S standard]]></description>
</addressBlock>
<interrupt>
<name>audio</name>
<value>13</value>
<value>14</value>
</interrupt>
</peripheral>
<peripheral>
@ -4225,7 +4229,7 @@ want to use this.]]></description>
</addressBlock>
<interrupt>
<name>trng_kernel</name>
<value>14</value>
<value>15</value>
</interrupt>
</peripheral>
<peripheral>
@ -5588,7 +5592,7 @@ case in testing. Not harmful in production, just wasteful.]]></description>
</addressBlock>
<interrupt>
<name>trng_server</name>
<value>15</value>
<value>16</value>
</interrupt>
</peripheral>
<peripheral>
@ -6426,7 +6430,7 @@ in bits]]></description>
</addressBlock>
<interrupt>
<name>sha512</name>
<value>16</value>
<value>17</value>
</interrupt>
</peripheral>
<peripheral>
@ -6704,7 +6708,7 @@ exactly reflects the binary layout of an Engine instruction.]]></description>
</addressBlock>
<interrupt>
<name>engine</name>
<value>17</value>
<value>18</value>
</interrupt>
</peripheral>
<peripheral>
@ -6922,7 +6926,7 @@ register to disable individual events.]]></description>
</addressBlock>
<interrupt>
<name>wdt</name>
<value>18</value>
<value>19</value>
</interrupt>
</peripheral>
<peripheral>
@ -7100,24 +7104,25 @@ of the PLL]]></description>
<constant name="CONFIG_BUS_DATA_WIDTH" value="32" />
<constant name="CONFIG_BUS_ADDRESS_WIDTH" value="32" />
<constant name="APP_UART_INTERRUPT" value="4" />
<constant name="AUDIO_INTERRUPT" value="13" />
<constant name="AUDIO_INTERRUPT" value="14" />
<constant name="BTEVENTS_INTERRUPT" value="7" />
<constant name="COM_INTERRUPT" value="5" />
<constant name="CONSOLE_INTERRUPT" value="3" />
<constant name="ENGINE_INTERRUPT" value="17" />
<constant name="ENGINE_INTERRUPT" value="18" />
<constant name="GPIO_INTERRUPT" value="1" />
<constant name="I2C_INTERRUPT" value="6" />
<constant name="KEYBOARD_INTERRUPT" value="12" />
<constant name="KEYBOARD_INTERRUPT" value="13" />
<constant name="POWER_INTERRUPT" value="10" />
<constant name="SHA512_INTERRUPT" value="16" />
<constant name="SHA512_INTERRUPT" value="17" />
<constant name="SPINOR_INTERRUPT" value="12" />
<constant name="SPINOR_SOFT_INT_INTERRUPT" value="11" />
<constant name="SUSRES_INTERRUPT" value="9" />
<constant name="TICKTIMER_INTERRUPT" value="8" />
<constant name="TIMER0_INTERRUPT" value="0" />
<constant name="TRNG_KERNEL_INTERRUPT" value="14" />
<constant name="TRNG_SERVER_INTERRUPT" value="15" />
<constant name="TRNG_KERNEL_INTERRUPT" value="15" />
<constant name="TRNG_SERVER_INTERRUPT" value="16" />
<constant name="UART_INTERRUPT" value="2" />
<constant name="WDT_INTERRUPT" value="18" />
<constant name="WDT_INTERRUPT" value="19" />
</constants>
</vendorExtensions>
</device>

Binary file not shown.

View file

@ -16,6 +16,9 @@ pub(crate) enum Opcode {
/// allow the susres manager to prevent new ops from happening during a suspend
AcquireSuspendLock,
ReleaseSuspendLock,
/// internal interrupt handler ops
EccError,
}
// Erase/Write are uninterruptable operations. Split suspend/resume
// into a separate server to asynchronously manage this.

View file

@ -18,14 +18,36 @@ mod implementation {
use log::info;
use susres::{RegManager, RegOrField, SuspendResume};
/// TODO: figure out how to make spinor calls "safe"
fn spinor_safe_context(_irq_no: usize, arg: *mut usize) {
let spinor = unsafe { &mut *(arg as *mut Spinor) };
spinor.softirq.wfo(utra::spinor_soft_int::EV_PENDING_SPINOR_INT, 1);
}
/// TODO: write ECC error handler on the other side
fn ecc_handler(_irq_no: usize, arg: *mut usize) {
let spinor = unsafe { &mut *(arg as *mut Spinor) };
xous::try_send_message(spinor.handler_conn,
xous::Message::new_scalar(Opcode::EccError.to_usize().unwrap(),
spinor.csr.rf(utra::spinor::ECC_ADDRESS_ECC_ADDRESS) as usize,
spinor.csr.rf(utra::spinor::ECC_STATUS_ECC_OVERFLOW) as usize,
0, 0)).map(|_|()).unwrap();
spinor.csr.wfo(utra::spinor::EV_PENDING_ECC_ERROR, 1);
}
pub struct Spinor {
handler_conn: xous::CID,
csr: utralib::CSR<u32>,
susres_manager: RegManager::<{utra::spinor::SPINOR_NUMREGS}>,
susres: RegManager::<{utra::spinor::SPINOR_NUMREGS}>,
softirq: utralib::CSR<u32>,
ops_count: u32, // tracks total ops done; also serves as a delay to ensure that the WIP bit updates before being polled
}
impl Spinor {
pub fn new() -> Spinor {
pub fn new(handler_conn: xous::CID) -> Spinor {
let csr = xous::syscall::map_memory(
xous::MemoryAddress::new(utra::spinor::HW_SPINOR_BASE),
None,
@ -33,13 +55,42 @@ mod implementation {
xous::MemoryFlags::R | xous::MemoryFlags::W,
)
.expect("couldn't map SPINOR CSR range");
let softirq = xous::syscall::map_memory(
xous::MemoryAddress::new(utra::spinor_soft_int::HW_SPINOR_SOFT_INT_BASE),
None,
4096,
xous::MemoryFlags::R | xous::MemoryFlags::W,
)
.expect("couldn't map SPINOR soft interrupt CSR range");
let mut spinor = Spinor {
handler_conn,
csr: CSR::new(csr.as_mut_ptr() as *mut u32),
susres_manager: RegManager::new(csr.as_mut_ptr() as *mut u32),
softirq: CSR::new(softirq.as_mut_ptr() as *mut u32),
susres: RegManager::new(csr.as_mut_ptr() as *mut u32),
ops_count: 0,
};
xous::claim_interrupt(
utra::spinor_soft_int::SPINOR_SOFT_INT_IRQ,
spinor_safe_context,
(&mut spinor) as *mut Spinor as *mut usize,
)
.expect("couldn't claim SPINOR irq");
spinor.softirq.wfo(utra::spinor_soft_int::EV_PENDING_SPINOR_INT, 1);
spinor.softirq.wfo(utra::spinor_soft_int::EV_ENABLE_SPINOR_INT, 1);
xous::claim_interrupt(
utra::spinor::SPINOR_IRQ,
ecc_handler,
(&mut spinor) as *mut Spinor as *mut usize,
)
.expect("couldn't claim SPINOR irq");
spinor.softirq.wfo(utra::spinor::EV_PENDING_ECC_ERROR, 1);
spinor.softirq.wfo(utra::spinor::EV_ENABLE_ECC_ERROR, 1);
spinor.susres.push_fixed_value(RegOrField::Reg(utra::spinor::EV_PENDING), 0xFFFF_FFFF);
spinor.susres.push(RegOrField::Reg(utra::spinor::EV_ENABLE), None);
spinor
}
@ -48,7 +99,7 @@ mod implementation {
wr.result = Some(SpinorError::InvalidRequest);
return;
}
}
pub fn erase_region(&mut self, start_adr: u32, num_u8: u32) -> SpinorError {
@ -59,17 +110,19 @@ mod implementation {
}
pub fn resume(&mut self) {
self.susres_manager.resume();
self.softirq.wfo(utra::spinor_soft_int::EV_PENDING_SPINOR_INT, 1);
self.softirq.wfo(utra::spinor_soft_int::EV_ENABLE_SPINOR_INT, 1);
}
fn flash_rdsr(&mut self, lock_reads: u32) -> u32 {
self.csr.wfo(utra::spinor::CMD_ARG_CMD_ARG, 0);
self.csr.wo(utra::spinor::COMMAND,
self.csr.ms(spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(spinor::COMMAND_LOCK_READS, lock_reads)
| self.csr.ms(spinor::COMMAND_CMD_CODE, 0x05) // RDSR
| self.csr.ms(spinor::COMMAND_DUMMY_CYCLES, 4)
| self.csr.ms(spinor::COMMAND_DATA_WORDS, 1)
| self.csr.ms(spinor::COMMAND_HAS_ARG, 1)
self.csr.ms(utra::spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(utra::spinor::COMMAND_LOCK_READS, lock_reads)
| self.csr.ms(utra::spinor::COMMAND_CMD_CODE, 0x05) // RDSR
| self.csr.ms(utra::spinor::COMMAND_DUMMY_CYCLES, 4)
| self.csr.ms(utra::spinor::COMMAND_DATA_WORDS, 1)
| self.csr.ms(utra::spinor::COMMAND_HAS_ARG, 1)
);
self.ops_count += 1; // count number of ops performed; also delays polling of WIP to ensure the command machine has time to respond
while self.csr.rf(utra::spinor::STATUS_WIP) != 0 {}
@ -79,12 +132,12 @@ mod implementation {
fn flash_rdscur(&mut self) -> u32 {
self.csr.wfo(utra::spinor::CMD_ARG_CMD_ARG, 0);
self.csr.wo(utra::spinor::COMMAND,
self.csr.ms(spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(spinor::COMMAND_LOCK_READS, 1)
| self.csr.ms(spinor::COMMAND_CMD_CODE, 0x2B) // RDSCUR
| self.csr.ms(spinor::COMMAND_DUMMY_CYCLES, 4)
| self.csr.ms(spinor::COMMAND_DATA_WORDS, 1)
| self.csr.ms(spinor::COMMAND_HAS_ARG, 1)
self.csr.ms(utra::spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(utra::spinor::COMMAND_LOCK_READS, 1)
| self.csr.ms(utra::spinor::COMMAND_CMD_CODE, 0x2B) // RDSCUR
| self.csr.ms(utra::spinor::COMMAND_DUMMY_CYCLES, 4)
| self.csr.ms(utra::spinor::COMMAND_DATA_WORDS, 1)
| self.csr.ms(utra::spinor::COMMAND_HAS_ARG, 1)
);
self.ops_count += 1;
while self.csr.rf(utra::spinor::STATUS_WIP) != 0 {}
@ -94,11 +147,11 @@ mod implementation {
fn flash_rdid(&mut self, offset: u32) -> u32 {
self.csr.wfo(utra::spinor::CMD_ARG_CMD_ARG, 0);
self.csr.wo(utra::spinor::COMMAND,
self.csr.ms(spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(spinor::COMMAND_CMD_CODE, 0x9f) // RDID
| self.csr.ms(spinor::COMMAND_DUMMY_CYCLES, 4)
| self.csr.ms(spinor::COMMAND_DATA_WORDS, offset) // 2 -> 0x3b3b8080, // 1 -> 0x8080c2c2
| self.csr.ms(spinor::COMMAND_HAS_ARG, 1)
self.csr.ms(utra::spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(utra::spinor::COMMAND_CMD_CODE, 0x9f) // RDID
| self.csr.ms(utra::spinor::COMMAND_DUMMY_CYCLES, 4)
| self.csr.ms(utra::spinor::COMMAND_DATA_WORDS, offset) // 2 -> 0x3b3b8080, // 1 -> 0x8080c2c2
| self.csr.ms(utra::spinor::COMMAND_HAS_ARG, 1)
);
self.ops_count += 1;
while self.csr.rf(utra::spinor::STATUS_WIP) != 0 {}
@ -108,9 +161,9 @@ mod implementation {
fn flash_wren(&mut self) {
self.csr.wfo(utra::spinor::CMD_ARG_CMD_ARG, 0);
self.csr.wo(utra::spinor::COMMAND,
self.csr.ms(spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(spinor::COMMAND_CMD_CODE, 0x06) // WREN
| self.csr.ms(spinor::COMMAND_LOCK_READS, 1)
self.csr.ms(utra::spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(utra::spinor::COMMAND_CMD_CODE, 0x06) // WREN
| self.csr.ms(utra::spinor::COMMAND_LOCK_READS, 1)
);
self.ops_count += 1;
while self.csr.rf(utra::spinor::STATUS_WIP) != 0 {}
@ -119,9 +172,9 @@ mod implementation {
fn flash_wrdi(&mut self) {
self.csr.wfo(utra::spinor::CMD_ARG_CMD_ARG, 0);
self.csr.wo(utra::spinor::COMMAND,
self.csr.ms(spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(spinor::COMMAND_CMD_CODE, 0x04) // WRDI
| self.csr.ms(spinor::COMMAND_LOCK_READS, 1)
self.csr.ms(utra::spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(utra::spinor::COMMAND_CMD_CODE, 0x04) // WRDI
| self.csr.ms(utra::spinor::COMMAND_LOCK_READS, 1)
);
self.ops_count += 1;
while self.csr.rf(utra::spinor::STATUS_WIP) != 0 {}
@ -130,10 +183,10 @@ mod implementation {
fn flash_se4b(&mut self, sector_address: u32) {
self.csr.wfo(utra::spinor::CMD_ARG_CMD_ARG, sector_address);
self.csr.wo(utra::spinor::COMMAND,
self.csr.ms(spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(spinor::COMMAND_CMD_CODE, 0x21) // SE4B
| self.csr.ms(spinor::COMMAND_HAS_ARG, 1)
| self.csr.ms(spinor::COMMAND_LOCK_READS, 1)
self.csr.ms(utra::spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(utra::spinor::COMMAND_CMD_CODE, 0x21) // SE4B
| self.csr.ms(utra::spinor::COMMAND_HAS_ARG, 1)
| self.csr.ms(utra::spinor::COMMAND_LOCK_READS, 1)
);
self.ops_count += 1;
while self.csr.rf(utra::spinor::STATUS_WIP) != 0 {}
@ -142,10 +195,10 @@ mod implementation {
fn flash_be4b(&mut self, block_address: u32) {
self.csr.wfo(utra::spinor::CMD_ARG_CMD_ARG, block_address);
self.csr.wo(utra::spinor::COMMAND,
self.csr.ms(spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(spinor::COMMAND_CMD_CODE, 0xdc) // BE4B
| self.csr.ms(spinor::COMMAND_HAS_ARG, 1)
| self.csr.ms(spinor::COMMAND_LOCK_READS, 1)
self.csr.ms(utra::spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(utra::spinor::COMMAND_CMD_CODE, 0xdc) // BE4B
| self.csr.ms(utra::spinor::COMMAND_HAS_ARG, 1)
| self.csr.ms(utra::spinor::COMMAND_LOCK_READS, 1)
);
self.ops_count += 1;
while self.csr.rf(utra::spinor::STATUS_WIP) != 0 {}
@ -154,11 +207,11 @@ mod implementation {
fn flash_pp4b(&mut self, address: u32, data_bytes: u32) {
self.csr.wfo(utra::spinor::CMD_ARG_CMD_ARG, address);
self.csr.wo(utra::spinor::COMMAND,
self.csr.ms(spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(spinor::COMMAND_CMD_CODE, 0x12) // PP4B
| self.csr.ms(spinor::COMMAND_HAS_ARG, 1)
| self.csr.ms(spinor::COMMAND_DATA_WORDS, data_bytes / 2)
| self.csr.ms(spinor::COMMAND_LOCK_READS, 1)
self.csr.ms(utra::spinor::COMMAND_EXEC_CMD, 1)
| self.csr.ms(utra::spinor::COMMAND_CMD_CODE, 0x12) // PP4B
| self.csr.ms(utra::spinor::COMMAND_HAS_ARG, 1)
| self.csr.ms(utra::spinor::COMMAND_DATA_WORDS, data_bytes / 2)
| self.csr.ms(utra::spinor::COMMAND_LOCK_READS, 1)
);
self.ops_count += 1;
while self.csr.rf(utra::spinor::STATUS_WIP) != 0 {}