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;
46 const SR_WIP: u8 = 1 << 0;
49 pub fn new(cs_gpio: u32, cs_gpio_pin: u32) -> Mx25l {
52 cs_gpio_pin: cs_gpio_pin,
56 pub fn read_status(&self) -> u8 {
57 self.with_selected(|| {
58 spi::tx8(spi::SPI0, Command::RDSR as u8);
60 spi::tx8(spi::SPI0, 0xff)
64 pub fn read_id(&self) -> (u8, u16) {
65 self.with_selected(|| {
66 spi::tx8(spi::SPI0, Command::RDID as u8);
68 let manufacturer_id = spi::tx8(spi::SPI0, 0xff);
69 let device_id0 = spi::tx8(spi::SPI0, 0xff) as u16;
70 let device_id1 = spi::tx8(spi::SPI0, 0xff) as u16;
72 (manufacturer_id, device_id0 | (device_id1 << 8))
76 pub fn erase_all(&self) {
79 self.with_selected(|| {
80 spi::tx8(spi::SPI0, Command::CE as u8);
83 while self.write_in_progress() {
87 pub fn erase_sector(&self, address: usize) -> Result<(), Error> {
88 if (address & (SECTOR_SIZE - 1)) != 0 {
89 return Err(Error::UnalignedAddress);
94 self.with_selected(|| {
95 spi::tx8(spi::SPI0, Command::SE as u8);
97 spi::tx8(spi::SPI0, (address >> 16) as u8);
98 spi::tx8(spi::SPI0, (address >> 8) as u8);
99 spi::tx8(spi::SPI0, (address >> 0) as u8);
102 while self.write_in_progress() {
108 pub fn program_page(&self, address: usize, buffer: &[u8; PAGE_SIZE])
109 -> Result<(), Error> {
110 if (address & (PAGE_SIZE - 1)) != 0 {
111 return Err(Error::UnalignedAddress);
114 if buffer.iter().all(|&b| b == 0xff) {
120 self.with_selected(|| {
121 spi::tx8(spi::SPI0, Command::PP as u8);
123 spi::tx8(spi::SPI0, (address >> 16) as u8);
124 spi::tx8(spi::SPI0, (address >> 8) as u8);
125 spi::tx8(spi::SPI0, (address >> 0) as u8);
127 for &b in buffer.iter() {
128 spi::tx8(spi::SPI0, b);
132 while self.write_in_progress() {
138 fn write_enable(&self) {
139 self.with_selected(|| {
140 spi::tx8(spi::SPI0, Command::WREN as u8);
144 fn write_in_progress(&self) -> bool {
145 (self.read_status() & SR_WIP) != 0
148 fn with_selected<F, T>(&self, func: F) -> T
149 where F: FnOnce() -> T
151 gpio::clear(self.cs_gpio, self.cs_gpio_pin);
155 gpio::set(self.cs_gpio, self.cs_gpio_pin);
161 impl Storage for Mx25l {
162 fn size(&self) -> usize {
166 fn read(&self, address: usize, buffer: &mut [u8]) {
167 self.with_selected(|| {
168 spi::tx8(spi::SPI0, Command::READ as u8);
170 spi::tx8(spi::SPI0, (address >> 16) as u8);
171 spi::tx8(spi::SPI0, (address >> 8) as u8);
172 spi::tx8(spi::SPI0, (address >> 0) as u8);
174 for i in 0..buffer.len() {
175 buffer[i] = spi::tx8(spi::SPI0, 0xff);
180 fn write(&mut self, address: usize, buffer: &[u8; SECTOR_SIZE])
181 -> Result<(), Error> {
182 if let Err(e) = self.erase_sector(address) {
186 for (i, page_bytes) in buffer.chunks(PAGE_SIZE).enumerate() {
187 let page_address = address + (i * PAGE_SIZE);
190 let mut ba = [0xff; PAGE_SIZE];
191 ba.copy_from_slice(&page_bytes);
193 if let Err(e) = self.program_page(page_address, &ba) {
201 fn clear(&mut self) {