2 * Copyright (c) 2020 Tilman Sauerbeck (tilman at code-monkey de)
4 * Permission is hereby granted, free of charge, to any person obtaining
5 * a copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sublicense, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
12 * The above copyright notice and this permission notice shall be
13 * included in all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 use storage::{Storage, Error};
28 const SECTOR_SIZE: usize = 4096;
29 const PAGE_SIZE: usize = 256;
45 const SR_WIP: u8 = 1 << 0;
48 pub fn new(cs_gpio: u32, cs_gpio_pin: u32) -> Mx25l {
51 cs_gpio_pin: cs_gpio_pin,
55 pub fn read_status(&self) -> u8 {
56 self.with_selected(|| {
57 spi::tx8(spi::SPI0, Command::RDSR as u8);
59 spi::tx8(spi::SPI0, 0xff)
63 pub fn read_id(&self) -> (u8, u16) {
64 self.with_selected(|| {
65 spi::tx8(spi::SPI0, Command::RDID as u8);
67 let manufacturer_id = spi::tx8(spi::SPI0, 0xff);
68 let device_id0 = spi::tx8(spi::SPI0, 0xff) as u16;
69 let device_id1 = spi::tx8(spi::SPI0, 0xff) as u16;
71 (manufacturer_id, device_id0 | (device_id1 << 8))
75 pub fn erase_sector(&self, address: usize) -> Result<(), Error> {
76 if (address & (SECTOR_SIZE - 1)) != 0 {
77 return Err(Error::UnalignedAddress);
82 self.with_selected(|| {
83 spi::tx8(spi::SPI0, Command::SE as u8);
85 spi::tx8(spi::SPI0, (address >> 16) as u8);
86 spi::tx8(spi::SPI0, (address >> 8) as u8);
87 spi::tx8(spi::SPI0, (address >> 0) as u8);
90 while self.write_in_progress() {
96 pub fn program_page(&self, address: usize, buffer: &[u8; PAGE_SIZE])
97 -> Result<(), Error> {
98 if (address & (PAGE_SIZE - 1)) != 0 {
99 return Err(Error::UnalignedAddress);
102 if buffer.iter().all(|&b| b == 0xff) {
106 self.with_selected(|| {
107 spi::tx8(spi::SPI0, Command::PP as u8);
109 spi::tx8(spi::SPI0, (address >> 16) as u8);
110 spi::tx8(spi::SPI0, (address >> 8) as u8);
111 spi::tx8(spi::SPI0, (address >> 0) as u8);
113 for &b in buffer.iter() {
114 spi::tx8(spi::SPI0, b);
118 while self.write_in_progress() {
124 fn write_enable(&self) {
125 self.with_selected(|| {
126 spi::tx8(spi::SPI0, Command::WREN as u8);
130 fn write_in_progress(&self) -> bool {
131 (self.read_status() & SR_WIP) != 0
134 fn with_selected<F, T>(&self, func: F) -> T
135 where F: FnOnce() -> T
137 gpio::clear(self.cs_gpio, self.cs_gpio_pin);
141 gpio::set(self.cs_gpio, self.cs_gpio_pin);
147 impl Storage for Mx25l {
148 fn read(&self, address: usize, buffer: &mut [u8]) {
149 self.with_selected(|| {
150 spi::tx8(spi::SPI0, Command::READ as u8);
152 spi::tx8(spi::SPI0, (address >> 16) as u8);
153 spi::tx8(spi::SPI0, (address >> 8) as u8);
154 spi::tx8(spi::SPI0, (address >> 0) as u8);
156 for i in 0..buffer.len() {
157 buffer[i] = spi::tx8(spi::SPI0, 0xff);
162 fn write(&mut self, address: usize, buffer: &[u8; SECTOR_SIZE])
163 -> Result<(), Error> {
164 if let Err(e) = self.erase_sector(address) {
168 for (i, page_bytes) in buffer.chunks(PAGE_SIZE).enumerate() {
169 let page_address = address + (i * PAGE_SIZE);
172 let mut ba = [0xff; PAGE_SIZE];
173 ba.copy_from_slice(&page_bytes);
175 if let Err(e) = self.program_page(page_address, &ba) {