paul@237 | 1 | /* |
paul@237 | 2 | * RTC (real-time clock) support for the X1600. |
paul@237 | 3 | * |
paul@237 | 4 | * Copyright (C) 2023 Paul Boddie <paul@boddie.org.uk> |
paul@237 | 5 | * |
paul@237 | 6 | * This program is free software; you can redistribute it and/or |
paul@237 | 7 | * modify it under the terms of the GNU General Public License as |
paul@237 | 8 | * published by the Free Software Foundation; either version 2 of |
paul@237 | 9 | * the License, or (at your option) any later version. |
paul@237 | 10 | * |
paul@237 | 11 | * This program is distributed in the hope that it will be useful, |
paul@237 | 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
paul@237 | 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
paul@237 | 14 | * GNU General Public License for more details. |
paul@237 | 15 | * |
paul@237 | 16 | * You should have received a copy of the GNU General Public License |
paul@237 | 17 | * along with this program; if not, write to the Free Software |
paul@237 | 18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, |
paul@237 | 19 | * Boston, MA 02110-1301, USA |
paul@237 | 20 | */ |
paul@237 | 21 | |
paul@237 | 22 | #pragma once |
paul@237 | 23 | |
paul@237 | 24 | #include <l4/sys/types.h> |
paul@237 | 25 | #include <stdint.h> |
paul@237 | 26 | |
paul@237 | 27 | |
paul@237 | 28 | |
paul@237 | 29 | #ifdef __cplusplus |
paul@237 | 30 | |
paul@237 | 31 | #include <l4/devices/hw_register_block.h> |
paul@237 | 32 | |
paul@237 | 33 | class Rtc_x1600_chip |
paul@237 | 34 | { |
paul@237 | 35 | protected: |
paul@237 | 36 | Hw::Register_block<32> _regs; |
paul@237 | 37 | |
paul@237 | 38 | /* Utility methods. */ |
paul@237 | 39 | |
paul@237 | 40 | uint32_t read_checked(unsigned reg); |
paul@237 | 41 | void wait(); |
paul@237 | 42 | void write_enable(); |
paul@237 | 43 | |
paul@237 | 44 | public: |
paul@237 | 45 | explicit Rtc_x1600_chip(l4_addr_t addr); |
paul@237 | 46 | |
paul@237 | 47 | void disable(); |
paul@237 | 48 | |
paul@237 | 49 | void enable(); |
paul@237 | 50 | |
paul@237 | 51 | void alarm_disable(); |
paul@237 | 52 | |
paul@237 | 53 | void alarm_enable(); |
paul@237 | 54 | |
paul@238 | 55 | void wakeup_alarm_disable(); |
paul@238 | 56 | |
paul@238 | 57 | void wakeup_alarm_enable(); |
paul@238 | 58 | |
paul@237 | 59 | uint32_t get_seconds(); |
paul@237 | 60 | |
paul@237 | 61 | void set_seconds(uint32_t seconds); |
paul@237 | 62 | |
paul@237 | 63 | uint32_t get_alarm_seconds(); |
paul@237 | 64 | |
paul@237 | 65 | void set_alarm_seconds(uint32_t seconds); |
paul@237 | 66 | |
paul@237 | 67 | void set_regulator(uint32_t base, uint32_t adjustment); |
paul@237 | 68 | |
paul@238 | 69 | void hibernate(); |
paul@238 | 70 | |
paul@237 | 71 | void power_down(); |
paul@237 | 72 | }; |
paul@237 | 73 | |
paul@237 | 74 | #endif /* __cplusplus */ |
paul@237 | 75 | |
paul@237 | 76 | |
paul@237 | 77 | |
paul@237 | 78 | /* C language interface. */ |
paul@237 | 79 | |
paul@237 | 80 | EXTERN_C_BEGIN |
paul@237 | 81 | |
paul@237 | 82 | void *x1600_rtc_init(l4_addr_t rtc_base); |
paul@237 | 83 | |
paul@237 | 84 | void x1600_rtc_disable(void *rtc); |
paul@237 | 85 | |
paul@237 | 86 | void x1600_rtc_enable(void *rtc); |
paul@237 | 87 | |
paul@237 | 88 | void x1600_rtc_alarm_disable(void *rtc); |
paul@237 | 89 | |
paul@237 | 90 | void x1600_rtc_alarm_enable(void *rtc); |
paul@237 | 91 | |
paul@238 | 92 | void x1600_rtc_wakeup_alarm_disable(void *rtc); |
paul@238 | 93 | |
paul@238 | 94 | void x1600_rtc_wakeup_alarm_enable(void *rtc); |
paul@238 | 95 | |
paul@237 | 96 | uint32_t x1600_rtc_get_seconds(void *rtc); |
paul@237 | 97 | |
paul@237 | 98 | void x1600_rtc_set_seconds(void *rtc, uint32_t seconds); |
paul@237 | 99 | |
paul@237 | 100 | uint32_t x1600_rtc_get_alarm_seconds(void *rtc); |
paul@237 | 101 | |
paul@237 | 102 | void x1600_rtc_set_alarm_seconds(void *rtc, uint32_t seconds); |
paul@237 | 103 | |
paul@237 | 104 | void x1600_rtc_set_regulator(void *rtc, uint32_t base, uint32_t adjustment); |
paul@237 | 105 | |
paul@238 | 106 | void x1600_rtc_hibernate(void *rtc); |
paul@238 | 107 | |
paul@237 | 108 | void x1600_rtc_power_down(void *rtc); |
paul@237 | 109 | |
paul@237 | 110 | EXTERN_C_END |