[qemu.git] / include / hw / rtc / xlnx-zynqmp-rtc.h

/*
 * QEMU model of the Xilinx ZynqMP Real Time Clock (RTC).
 *
 * Copyright (c) 2017 Xilinx Inc.
 *
 * Written-by: Alistair Francis
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef HW_RTC_XLNX_ZYNQMP_H
#define HW_RTC_XLNX_ZYNQMP_H

#include "hw/register.h"
#include "hw/sysbus.h"

#define TYPE_XLNX_ZYNQMP_RTC "xlnx-zynmp.rtc"

#define XLNX_ZYNQMP_RTC(obj) \
     OBJECT_CHECK(XlnxZynqMPRTC, (obj), TYPE_XLNX_ZYNQMP_RTC)

REG32(SET_TIME_WRITE, 0x0)
REG32(SET_TIME_READ, 0x4)
REG32(CALIB_WRITE, 0x8)
    FIELD(CALIB_WRITE, FRACTION_EN, 20, 1)
    FIELD(CALIB_WRITE, FRACTION_DATA, 16, 4)
    FIELD(CALIB_WRITE, MAX_TICK, 0, 16)
REG32(CALIB_READ, 0xc)
    FIELD(CALIB_READ, FRACTION_EN, 20, 1)
    FIELD(CALIB_READ, FRACTION_DATA, 16, 4)
    FIELD(CALIB_READ, MAX_TICK, 0, 16)
REG32(CURRENT_TIME, 0x10)
REG32(CURRENT_TICK, 0x14)
    FIELD(CURRENT_TICK, VALUE, 0, 16)
REG32(ALARM, 0x18)
REG32(RTC_INT_STATUS, 0x20)
    FIELD(RTC_INT_STATUS, ALARM, 1, 1)
    FIELD(RTC_INT_STATUS, SECONDS, 0, 1)
REG32(RTC_INT_MASK, 0x24)
    FIELD(RTC_INT_MASK, ALARM, 1, 1)
    FIELD(RTC_INT_MASK, SECONDS, 0, 1)
REG32(RTC_INT_EN, 0x28)
    FIELD(RTC_INT_EN, ALARM, 1, 1)
    FIELD(RTC_INT_EN, SECONDS, 0, 1)
REG32(RTC_INT_DIS, 0x2c)
    FIELD(RTC_INT_DIS, ALARM, 1, 1)
    FIELD(RTC_INT_DIS, SECONDS, 0, 1)
REG32(ADDR_ERROR, 0x30)
    FIELD(ADDR_ERROR, STATUS, 0, 1)
REG32(ADDR_ERROR_INT_MASK, 0x34)
    FIELD(ADDR_ERROR_INT_MASK, MASK, 0, 1)
REG32(ADDR_ERROR_INT_EN, 0x38)
    FIELD(ADDR_ERROR_INT_EN, MASK, 0, 1)
REG32(ADDR_ERROR_INT_DIS, 0x3c)
    FIELD(ADDR_ERROR_INT_DIS, MASK, 0, 1)
REG32(CONTROL, 0x40)
    FIELD(CONTROL, BATTERY_DISABLE, 31, 1)
    FIELD(CONTROL, OSC_CNTRL, 24, 4)
    FIELD(CONTROL, SLVERR_ENABLE, 0, 1)
REG32(SAFETY_CHK, 0x50)

#define XLNX_ZYNQMP_RTC_R_MAX (R_SAFETY_CHK + 1)

typedef struct XlnxZynqMPRTC {
    SysBusDevice parent_obj;
    MemoryRegion iomem;
    qemu_irq irq_rtc_int;
    qemu_irq irq_addr_error_int;

    uint32_t tick_offset;

    uint32_t regs[XLNX_ZYNQMP_RTC_R_MAX];
    RegisterInfo regs_info[XLNX_ZYNQMP_RTC_R_MAX];
} XlnxZynqMPRTC;

#endif
Commit	Line	Data
07664ca6 AF	1	/*
	2	* QEMU model of the Xilinx ZynqMP Real Time Clock (RTC).
	3	*
	4	* Copyright (c) 2017 Xilinx Inc.
	5	*
8035f85e	6	* Written-by: Alistair Francis
07664ca6 AF	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	21	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	24	* THE SOFTWARE.
	25	*/
	26
8035f85e PMD	27	#ifndef HW_RTC_XLNX_ZYNQMP_H
8035f85e PMD	28	#define HW_RTC_XLNX_ZYNQMP_H
f91005e1	29
07664ca6	30	#include "hw/register.h"
ec150c7e	31	#include "hw/sysbus.h"
07664ca6 AF	32
	33	#define TYPE_XLNX_ZYNQMP_RTC "xlnx-zynmp.rtc"
	34
	35	#define XLNX_ZYNQMP_RTC(obj) \
	36	OBJECT_CHECK(XlnxZynqMPRTC, (obj), TYPE_XLNX_ZYNQMP_RTC)
	37
	38	REG32(SET_TIME_WRITE, 0x0)
	39	REG32(SET_TIME_READ, 0x4)
	40	REG32(CALIB_WRITE, 0x8)
	41	FIELD(CALIB_WRITE, FRACTION_EN, 20, 1)
	42	FIELD(CALIB_WRITE, FRACTION_DATA, 16, 4)
	43	FIELD(CALIB_WRITE, MAX_TICK, 0, 16)
	44	REG32(CALIB_READ, 0xc)
	45	FIELD(CALIB_READ, FRACTION_EN, 20, 1)
	46	FIELD(CALIB_READ, FRACTION_DATA, 16, 4)
	47	FIELD(CALIB_READ, MAX_TICK, 0, 16)
	48	REG32(CURRENT_TIME, 0x10)
	49	REG32(CURRENT_TICK, 0x14)
	50	FIELD(CURRENT_TICK, VALUE, 0, 16)
	51	REG32(ALARM, 0x18)
	52	REG32(RTC_INT_STATUS, 0x20)
	53	FIELD(RTC_INT_STATUS, ALARM, 1, 1)
	54	FIELD(RTC_INT_STATUS, SECONDS, 0, 1)
	55	REG32(RTC_INT_MASK, 0x24)
	56	FIELD(RTC_INT_MASK, ALARM, 1, 1)
	57	FIELD(RTC_INT_MASK, SECONDS, 0, 1)
	58	REG32(RTC_INT_EN, 0x28)
	59	FIELD(RTC_INT_EN, ALARM, 1, 1)
	60	FIELD(RTC_INT_EN, SECONDS, 0, 1)
	61	REG32(RTC_INT_DIS, 0x2c)
	62	FIELD(RTC_INT_DIS, ALARM, 1, 1)
	63	FIELD(RTC_INT_DIS, SECONDS, 0, 1)
	64	REG32(ADDR_ERROR, 0x30)
	65	FIELD(ADDR_ERROR, STATUS, 0, 1)
	66	REG32(ADDR_ERROR_INT_MASK, 0x34)
	67	FIELD(ADDR_ERROR_INT_MASK, MASK, 0, 1)
	68	REG32(ADDR_ERROR_INT_EN, 0x38)
	69	FIELD(ADDR_ERROR_INT_EN, MASK, 0, 1)
	70	REG32(ADDR_ERROR_INT_DIS, 0x3c)
	71	FIELD(ADDR_ERROR_INT_DIS, MASK, 0, 1)
	72	REG32(CONTROL, 0x40)
	73	FIELD(CONTROL, BATTERY_DISABLE, 31, 1)
	74	FIELD(CONTROL, OSC_CNTRL, 24, 4)
	75	FIELD(CONTROL, SLVERR_ENABLE, 0, 1)
	76	REG32(SAFETY_CHK, 0x50)
	77
	78	#define XLNX_ZYNQMP_RTC_R_MAX (R_SAFETY_CHK + 1)
	79
	80	typedef struct XlnxZynqMPRTC {
	81	SysBusDevice parent_obj;
	82	MemoryRegion iomem;
	83	qemu_irq irq_rtc_int;
	84	qemu_irq irq_addr_error_int;
	85
246003ce AF	86	uint32_t tick_offset;
246003ce AF	87
07664ca6 AF	88	uint32_t regs[XLNX_ZYNQMP_RTC_R_MAX];
	89	RegisterInfo regs_info[XLNX_ZYNQMP_RTC_R_MAX];
	90	} XlnxZynqMPRTC;
f91005e1 MA	91
f91005e1 MA	92	#endif