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 pub struct Mx25l {
  29     cs_gpio: u32,
  30     cs_gpio_pin: u32,
  31 }
  32
  33 enum Command {
  34     READ = 0x03,
  35     RDSR = 0x05,
  36     RDID = 0x9f,
  37 }
  38
  39 impl Mx25l {
  40     pub fn new(cs_gpio: u32, cs_gpio_pin: u32) -> Mx25l {
  41         Mx25l {
  42             cs_gpio: cs_gpio,
  43             cs_gpio_pin: cs_gpio_pin,
  44         }
  45     }
  46
  47     pub fn read_status(&self) -> u8 {
  48         self.with_selected(|| {
  49             spi::tx8(spi::SPI0, Command::RDSR as u8);
  50
  51             spi::tx8(spi::SPI0, 0xff)
  52         })
  53     }
  54
  55     pub fn read_id(&self) -> (u8, u16) {
  56         self.with_selected(|| {
  57             spi::tx8(spi::SPI0, Command::RDID as u8);
  58
  59             let manufacturer_id = spi::tx8(spi::SPI0, 0xff);
  60             let device_id0 = spi::tx8(spi::SPI0, 0xff) as u16;
  61             let device_id1 = spi::tx8(spi::SPI0, 0xff) as u16;
  62
  63             (manufacturer_id, device_id0 | (device_id1 << 8))
  64         })
  65     }
  66
  67     fn with_selected<F, T>(&self, func: F) -> T
  68         where F: FnOnce() -> T
  69     {
  70         gpio::clear(self.cs_gpio, self.cs_gpio_pin);
  71
  72         let r = func();
  73
  74         gpio::set(self.cs_gpio, self.cs_gpio_pin);
  75
  76         r
  77     }
  78 }
  79
  80 impl Storage for Mx25l {
  81     fn read(&self, address: usize, buffer: &mut [u8]) {
  82         self.with_selected(|| {
  83             spi::tx8(spi::SPI0, Command::READ 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             for i in 0..buffer.len() {
  90                 buffer[i] = spi::tx8(spi::SPI0, 0xff);
  91             }
  92         })
  93     }
  94 }