src/common/mx25l.rs

   1 /*
   2  * Copyright (c) 2020 Tilman Sauerbeck (tilman at code-monkey de)
   3  *
   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:
  11  *
  12  * The above copyright notice and this permission notice shall be
  13  * included in all copies or substantial portions of the Software.
  14  *
  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.
  22  */
  23
  24 use gpio;
  25 use spi;
  26 use storage::{Storage, Error};
  27
  28 const SECTOR_SIZE: usize = 4096;
  29 const PAGE_SIZE:   usize = 256;
  30
  31 pub struct Mx25l {
  32     cs_gpio: u32,
  33     cs_gpio_pin: u32,
  34 }
  35
  36 enum Command {
  37     PP   = 0x02,
  38     READ = 0x03,
  39     RDSR = 0x05,
  40     WREN = 0x06,
  41     SE   = 0x20,
  42     RDID = 0x9f,
  43 }
  44
  45 const SR_WIP: u8 = 1 << 0;
  46
  47 impl Mx25l {
  48     pub fn new(cs_gpio: u32, cs_gpio_pin: u32) -> Mx25l {
  49         Mx25l {
  50             cs_gpio: cs_gpio,
  51             cs_gpio_pin: cs_gpio_pin,
  52         }
  53     }
  54
  55     pub fn read_status(&self) -> u8 {
  56         self.with_selected(|| {
  57             spi::tx8(spi::SPI0, Command::RDSR as u8);
  58
  59             spi::tx8(spi::SPI0, 0xff)
  60         })
  61     }
  62
  63     pub fn read_id(&self) -> (u8, u16) {
  64         self.with_selected(|| {
  65             spi::tx8(spi::SPI0, Command::RDID as u8);
  66
  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;
  70
  71             (manufacturer_id, device_id0 | (device_id1 << 8))
  72         })
  73     }
  74
  75     pub fn erase_sector(&self, address: usize) -> Result<(), Error> {
  76         if (address & (SECTOR_SIZE - 1)) != 0 {
  77             return Err(Error::UnalignedAddress);
  78         }
  79
  80         self.write_enable();
  81
  82         self.with_selected(|| {
  83             spi::tx8(spi::SPI0, Command::SE as u8);
  84
  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);
  88         });
  89
  90         while self.write_in_progress() {
  91         }
  92
  93         Ok(())
  94     }
  95
  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);
 100         }
 101
 102         if buffer.iter().all(|&b| b == 0xff) {
 103             return Ok(());
 104         }
 105
 106         self.with_selected(|| {
 107             spi::tx8(spi::SPI0, Command::PP as u8);
 108
 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);
 112
 113             for &b in buffer.iter() {
 114                 spi::tx8(spi::SPI0, b);
 115             }
 116         });
 117
 118         while self.write_in_progress() {
 119         }
 120
 121         Ok(())
 122     }
 123
 124     fn write_enable(&self) {
 125         self.with_selected(|| {
 126             spi::tx8(spi::SPI0, Command::WREN as u8);
 127         });
 128     }
 129
 130     fn write_in_progress(&self) -> bool {
 131         (self.read_status() & SR_WIP) != 0
 132     }
 133
 134     fn with_selected<F, T>(&self, func: F) -> T
 135         where F: FnOnce() -> T
 136     {
 137         gpio::clear(self.cs_gpio, self.cs_gpio_pin);
 138
 139         let r = func();
 140
 141         gpio::set(self.cs_gpio, self.cs_gpio_pin);
 142
 143         r
 144     }
 145 }
 146
 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);
 151
 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);
 155
 156             for i in 0..buffer.len() {
 157                 buffer[i] = spi::tx8(spi::SPI0, 0xff);
 158             }
 159         })
 160     }
 161
 162     fn write(&mut self, address: usize, buffer: &[u8; SECTOR_SIZE])
 163              -> Result<(), Error> {
 164         if let Err(e) = self.erase_sector(address) {
 165             return Err(e);
 166         }
 167
 168         for (i, page_bytes) in buffer.chunks(PAGE_SIZE).enumerate() {
 169             let page_address = address + (i * PAGE_SIZE);
 170
 171             // XXX: Inefficient.
 172             let mut ba = [0xff; PAGE_SIZE];
 173             ba.copy_from_slice(&page_bytes);
 174
 175             if let Err(e) = self.program_page(page_address, &ba) {
 176                 return Err(e);
 177             }
 178         }
 179
 180         Ok(())
 181     }
 182 }