1a9ad9e73SNiek Linnenbank /* 2a9ad9e73SNiek Linnenbank * Allwinner Real Time Clock emulation 3a9ad9e73SNiek Linnenbank * 4a9ad9e73SNiek Linnenbank * Copyright (C) 2019 Niek Linnenbank <nieklinnenbank@gmail.com> 5a9ad9e73SNiek Linnenbank * 6a9ad9e73SNiek Linnenbank * This program is free software: you can redistribute it and/or modify 7a9ad9e73SNiek Linnenbank * it under the terms of the GNU General Public License as published by 8a9ad9e73SNiek Linnenbank * the Free Software Foundation, either version 2 of the License, or 9a9ad9e73SNiek Linnenbank * (at your option) any later version. 10a9ad9e73SNiek Linnenbank * 11a9ad9e73SNiek Linnenbank * This program is distributed in the hope that it will be useful, 12a9ad9e73SNiek Linnenbank * but WITHOUT ANY WARRANTY; without even the implied warranty of 13a9ad9e73SNiek Linnenbank * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14a9ad9e73SNiek Linnenbank * GNU General Public License for more details. 15a9ad9e73SNiek Linnenbank * 16a9ad9e73SNiek Linnenbank * You should have received a copy of the GNU General Public License 17a9ad9e73SNiek Linnenbank * along with this program. If not, see <http://www.gnu.org/licenses/>. 18a9ad9e73SNiek Linnenbank */ 19a9ad9e73SNiek Linnenbank 20a9ad9e73SNiek Linnenbank #ifndef HW_MISC_ALLWINNER_RTC_H 21a9ad9e73SNiek Linnenbank #define HW_MISC_ALLWINNER_RTC_H 22a9ad9e73SNiek Linnenbank 23a9ad9e73SNiek Linnenbank #include "qom/object.h" 24a9ad9e73SNiek Linnenbank #include "hw/sysbus.h" 25a9ad9e73SNiek Linnenbank 26a9ad9e73SNiek Linnenbank /** 27a9ad9e73SNiek Linnenbank * Constants 28a9ad9e73SNiek Linnenbank * @{ 29a9ad9e73SNiek Linnenbank */ 30a9ad9e73SNiek Linnenbank 31a9ad9e73SNiek Linnenbank /** Highest register address used by RTC device */ 32a9ad9e73SNiek Linnenbank #define AW_RTC_REGS_MAXADDR (0x200) 33a9ad9e73SNiek Linnenbank 34a9ad9e73SNiek Linnenbank /** Total number of known registers */ 35a9ad9e73SNiek Linnenbank #define AW_RTC_REGS_NUM (AW_RTC_REGS_MAXADDR / sizeof(uint32_t)) 36a9ad9e73SNiek Linnenbank 37a9ad9e73SNiek Linnenbank /** @} */ 38a9ad9e73SNiek Linnenbank 39a9ad9e73SNiek Linnenbank /** 40a9ad9e73SNiek Linnenbank * Object model types 41a9ad9e73SNiek Linnenbank * @{ 42a9ad9e73SNiek Linnenbank */ 43a9ad9e73SNiek Linnenbank 44a9ad9e73SNiek Linnenbank /** Generic Allwinner RTC device (abstract) */ 45a9ad9e73SNiek Linnenbank #define TYPE_AW_RTC "allwinner-rtc" 46a9ad9e73SNiek Linnenbank 47a9ad9e73SNiek Linnenbank /** Allwinner RTC sun4i family (A10, A12) */ 48a9ad9e73SNiek Linnenbank #define TYPE_AW_RTC_SUN4I TYPE_AW_RTC "-sun4i" 49a9ad9e73SNiek Linnenbank 50a9ad9e73SNiek Linnenbank /** Allwinner RTC sun6i family and newer (A31, H2+, H3, etc) */ 51a9ad9e73SNiek Linnenbank #define TYPE_AW_RTC_SUN6I TYPE_AW_RTC "-sun6i" 52a9ad9e73SNiek Linnenbank 53a9ad9e73SNiek Linnenbank /** Allwinner RTC sun7i family (A20) */ 54a9ad9e73SNiek Linnenbank #define TYPE_AW_RTC_SUN7I TYPE_AW_RTC "-sun7i" 55a9ad9e73SNiek Linnenbank 56a9ad9e73SNiek Linnenbank /** @} */ 57a9ad9e73SNiek Linnenbank 58a9ad9e73SNiek Linnenbank /** 59a9ad9e73SNiek Linnenbank * Object model macros 60a9ad9e73SNiek Linnenbank * @{ 61a9ad9e73SNiek Linnenbank */ 62a9ad9e73SNiek Linnenbank 63*db1015e9SEduardo Habkost typedef struct AwRtcClass AwRtcClass; 64*db1015e9SEduardo Habkost typedef struct AwRtcState AwRtcState; 65a9ad9e73SNiek Linnenbank #define AW_RTC(obj) \ 66a9ad9e73SNiek Linnenbank OBJECT_CHECK(AwRtcState, (obj), TYPE_AW_RTC) 67a9ad9e73SNiek Linnenbank #define AW_RTC_CLASS(klass) \ 68a9ad9e73SNiek Linnenbank OBJECT_CLASS_CHECK(AwRtcClass, (klass), TYPE_AW_RTC) 69a9ad9e73SNiek Linnenbank #define AW_RTC_GET_CLASS(obj) \ 70a9ad9e73SNiek Linnenbank OBJECT_GET_CLASS(AwRtcClass, (obj), TYPE_AW_RTC) 71a9ad9e73SNiek Linnenbank 72a9ad9e73SNiek Linnenbank /** @} */ 73a9ad9e73SNiek Linnenbank 74a9ad9e73SNiek Linnenbank /** 75a9ad9e73SNiek Linnenbank * Allwinner RTC per-object instance state. 76a9ad9e73SNiek Linnenbank */ 77*db1015e9SEduardo Habkost struct AwRtcState { 78a9ad9e73SNiek Linnenbank /*< private >*/ 79a9ad9e73SNiek Linnenbank SysBusDevice parent_obj; 80a9ad9e73SNiek Linnenbank /*< public >*/ 81a9ad9e73SNiek Linnenbank 82a9ad9e73SNiek Linnenbank /** 83a9ad9e73SNiek Linnenbank * Actual year represented by the device when year counter is zero 84a9ad9e73SNiek Linnenbank * 85a9ad9e73SNiek Linnenbank * Can be overridden by the user using the corresponding 'base-year' 86a9ad9e73SNiek Linnenbank * property. The base year used by the target OS driver can vary, for 87a9ad9e73SNiek Linnenbank * example the Linux driver for sun6i uses 1970 while NetBSD uses 2000. 88a9ad9e73SNiek Linnenbank */ 89a9ad9e73SNiek Linnenbank int base_year; 90a9ad9e73SNiek Linnenbank 91a9ad9e73SNiek Linnenbank /** Maps I/O registers in physical memory */ 92a9ad9e73SNiek Linnenbank MemoryRegion iomem; 93a9ad9e73SNiek Linnenbank 94a9ad9e73SNiek Linnenbank /** Array of hardware registers */ 95a9ad9e73SNiek Linnenbank uint32_t regs[AW_RTC_REGS_NUM]; 96a9ad9e73SNiek Linnenbank 97*db1015e9SEduardo Habkost }; 98a9ad9e73SNiek Linnenbank 99a9ad9e73SNiek Linnenbank /** 100a9ad9e73SNiek Linnenbank * Allwinner RTC class-level struct. 101a9ad9e73SNiek Linnenbank * 102a9ad9e73SNiek Linnenbank * This struct is filled by each sunxi device specific code 103a9ad9e73SNiek Linnenbank * such that the generic code can use this struct to support 104a9ad9e73SNiek Linnenbank * all devices. 105a9ad9e73SNiek Linnenbank */ 106*db1015e9SEduardo Habkost struct AwRtcClass { 107a9ad9e73SNiek Linnenbank /*< private >*/ 108a9ad9e73SNiek Linnenbank SysBusDeviceClass parent_class; 109a9ad9e73SNiek Linnenbank /*< public >*/ 110a9ad9e73SNiek Linnenbank 111a9ad9e73SNiek Linnenbank /** Defines device specific register map */ 112a9ad9e73SNiek Linnenbank const uint8_t *regmap; 113a9ad9e73SNiek Linnenbank 114a9ad9e73SNiek Linnenbank /** Size of the regmap in bytes */ 115a9ad9e73SNiek Linnenbank size_t regmap_size; 116a9ad9e73SNiek Linnenbank 117a9ad9e73SNiek Linnenbank /** 118a9ad9e73SNiek Linnenbank * Read device specific register 119a9ad9e73SNiek Linnenbank * 120a9ad9e73SNiek Linnenbank * @offset: register offset to read 121a9ad9e73SNiek Linnenbank * @return true if register read successful, false otherwise 122a9ad9e73SNiek Linnenbank */ 123a9ad9e73SNiek Linnenbank bool (*read)(AwRtcState *s, uint32_t offset); 124a9ad9e73SNiek Linnenbank 125a9ad9e73SNiek Linnenbank /** 126a9ad9e73SNiek Linnenbank * Write device specific register 127a9ad9e73SNiek Linnenbank * 128a9ad9e73SNiek Linnenbank * @offset: register offset to write 129a9ad9e73SNiek Linnenbank * @data: value to set in register 130a9ad9e73SNiek Linnenbank * @return true if register write successful, false otherwise 131a9ad9e73SNiek Linnenbank */ 132a9ad9e73SNiek Linnenbank bool (*write)(AwRtcState *s, uint32_t offset, uint32_t data); 133a9ad9e73SNiek Linnenbank 134*db1015e9SEduardo Habkost }; 135a9ad9e73SNiek Linnenbank 136a9ad9e73SNiek Linnenbank #endif /* HW_MISC_ALLWINNER_RTC_H */ 137