common: Add the mx25l module.
[gps-watch.git] / 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
27 pub struct Mx25l {
28     cs_gpio: u32,
29     cs_gpio_pin: u32,
30 }
31
32 enum Command {
33     RDSR = 0x05,
34     RDID = 0x9f,
35 }
36
37 impl Mx25l {
38     pub fn new(cs_gpio: u32, cs_gpio_pin: u32) -> Mx25l {
39         Mx25l {
40             cs_gpio: cs_gpio,
41             cs_gpio_pin: cs_gpio_pin,
42         }
43     }
44
45     pub fn read_status(&self) -> u8 {
46         self.with_selected(|| {
47             spi::tx8(spi::SPI0, Command::RDSR as u8);
48
49             spi::tx8(spi::SPI0, 0xff)
50         })
51     }
52
53     pub fn read_id(&self) -> (u8, u16) {
54         self.with_selected(|| {
55             spi::tx8(spi::SPI0, Command::RDID as u8);
56
57             let manufacturer_id = spi::tx8(spi::SPI0, 0xff);
58             let device_id0 = spi::tx8(spi::SPI0, 0xff) as u16;
59             let device_id1 = spi::tx8(spi::SPI0, 0xff) as u16;
60
61             (manufacturer_id, device_id0 | (device_id1 << 8))
62         })
63     }
64
65     fn with_selected<F, T>(&self, func: F) -> T
66         where F: FnOnce() -> T
67     {
68         gpio::clear(self.cs_gpio, self.cs_gpio_pin);
69
70         let r = func();
71
72         gpio::set(self.cs_gpio, self.cs_gpio_pin);
73
74         r
75     }
76 }