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;
  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 pub enum Error {
  46     UnalignedAddress = 1,
  47 }
  48
  49 const SR_WIP: u8 = 1 << 0;
  50
  51 impl Mx25l {
  52     pub fn new(cs_gpio: u32, cs_gpio_pin: u32) -> Mx25l {
  53         Mx25l {
  54             cs_gpio: cs_gpio,
  55             cs_gpio_pin: cs_gpio_pin,
  56         }
  57     }
  58
  59     pub fn read_status(&self) -> u8 {
  60         self.with_selected(|| {
  61             spi::tx8(spi::SPI0, Command::RDSR as u8);
  62
  63             spi::tx8(spi::SPI0, 0xff)
  64         })
  65     }
  66
  67     pub fn read_id(&self) -> (u8, u16) {
  68         self.with_selected(|| {
  69             spi::tx8(spi::SPI0, Command::RDID as u8);
  70
  71             let manufacturer_id = spi::tx8(spi::SPI0, 0xff);
  72             let device_id0 = spi::tx8(spi::SPI0, 0xff) as u16;
  73             let device_id1 = spi::tx8(spi::SPI0, 0xff) as u16;
  74
  75             (manufacturer_id, device_id0 | (device_id1 << 8))
  76         })
  77     }
  78
  79     pub fn erase_sector(&self, address: usize) -> Result<(), Error> {
  80         if (address & (SECTOR_SIZE - 1)) != 0 {
  81             return Err(Error::UnalignedAddress);
  82         }
  83
  84         self.write_enable();
  85
  86         self.with_selected(|| {
  87             spi::tx8(spi::SPI0, Command::SE as u8);
  88
  89             spi::tx8(spi::SPI0, (address >> 16) as u8);
  90             spi::tx8(spi::SPI0, (address >>  8) as u8);
  91             spi::tx8(spi::SPI0, (address >>  0) as u8);
  92         });
  93
  94         while self.write_in_progress() {
  95         }
  96
  97         Ok(())
  98     }
  99
 100     pub fn program_page(&self, address: usize, buffer: &[u8; PAGE_SIZE])
 101                         -> Result<(), Error> {
 102         if (address & (PAGE_SIZE - 1)) != 0 {
 103             return Err(Error::UnalignedAddress);
 104         }
 105
 106         if buffer.iter().all(|&b| b == 0xff) {
 107             return Ok(());
 108         }
 109
 110         self.with_selected(|| {
 111             spi::tx8(spi::SPI0, Command::PP as u8);
 112
 113             spi::tx8(spi::SPI0, (address >> 16) as u8);
 114             spi::tx8(spi::SPI0, (address >>  8) as u8);
 115             spi::tx8(spi::SPI0, (address >>  0) as u8);
 116
 117             for &b in buffer.iter() {
 118                 spi::tx8(spi::SPI0, b);
 119             }
 120         });
 121
 122         while self.write_in_progress() {
 123         }
 124
 125         Ok(())
 126     }
 127
 128     fn write_enable(&self) {
 129         self.with_selected(|| {
 130             spi::tx8(spi::SPI0, Command::WREN as u8);
 131         });
 132     }
 133
 134     fn write_in_progress(&self) -> bool {
 135         (self.read_status() & SR_WIP) != 0
 136     }
 137
 138     fn with_selected<F, T>(&self, func: F) -> T
 139         where F: FnOnce() -> T
 140     {
 141         gpio::clear(self.cs_gpio, self.cs_gpio_pin);
 142
 143         let r = func();
 144
 145         gpio::set(self.cs_gpio, self.cs_gpio_pin);
 146
 147         r
 148     }
 149 }
 150
 151 impl Storage for Mx25l {
 152     fn read(&self, address: usize, buffer: &mut [u8]) {
 153         self.with_selected(|| {
 154             spi::tx8(spi::SPI0, Command::READ as u8);
 155
 156             spi::tx8(spi::SPI0, (address >> 16) as u8);
 157             spi::tx8(spi::SPI0, (address >>  8) as u8);
 158             spi::tx8(spi::SPI0, (address >>  0) as u8);
 159
 160             for i in 0..buffer.len() {
 161                 buffer[i] = spi::tx8(spi::SPI0, 0xff);
 162             }
 163         })
 164     }
 165 }