common: Add the gps module.
[gps-watch.git] / src / common / register.rs
1 /*
2  * Copyright (c) 2019 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 core::ptr;
25 use core::marker::PhantomData;
26
27 pub struct Register<T>
28 {
29     pub address: u32,
30     phantom: PhantomData<T>,
31 }
32
33 impl<T> Register<T> {
34     pub fn new(addr: u32) -> Register<T> {
35         Register {
36             address: addr,
37             phantom: PhantomData,
38         }
39     }
40
41     pub fn read(&self) -> T {
42         let ptr = self.address as *const T;
43
44         unsafe { ptr::read_volatile(ptr) }
45     }
46
47     pub fn write(&mut self, value: T) {
48         let ptr = self.address as *mut T;
49
50         unsafe { ptr::write_volatile(ptr, value) }
51     }
52
53     pub fn modify<F>(&mut self, func: F)
54         where F: FnOnce(T) -> T
55     {
56         let mut v = self.read();
57         v = func(v);
58         self.write(v);
59     }
60 }