1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun * Generic RTC interface. 4*4882a593Smuzhiyun * This version contains the part of the user interface to the Real Time Clock 5*4882a593Smuzhiyun * service. It is used with both the legacy mc146818 and also EFI 6*4882a593Smuzhiyun * Struct rtc_time and first 12 ioctl by Paul Gortmaker, 1996 - separated out 7*4882a593Smuzhiyun * from <linux/mc146818rtc.h> to this file for 2.4 kernels. 8*4882a593Smuzhiyun * 9*4882a593Smuzhiyun * Copyright (C) 1999 Hewlett-Packard Co. 10*4882a593Smuzhiyun * Copyright (C) 1999 Stephane Eranian <eranian@hpl.hp.com> 11*4882a593Smuzhiyun */ 12*4882a593Smuzhiyun #ifndef _UAPI_LINUX_RTC_H_ 13*4882a593Smuzhiyun #define _UAPI_LINUX_RTC_H_ 14*4882a593Smuzhiyun 15*4882a593Smuzhiyun #include <linux/const.h> 16*4882a593Smuzhiyun #include <linux/ioctl.h> 17*4882a593Smuzhiyun 18*4882a593Smuzhiyun /* 19*4882a593Smuzhiyun * The struct used to pass data via the following ioctl. Similar to the 20*4882a593Smuzhiyun * struct tm in <time.h>, but it needs to be here so that the kernel 21*4882a593Smuzhiyun * source is self contained, allowing cross-compiles, etc. etc. 22*4882a593Smuzhiyun */ 23*4882a593Smuzhiyun 24*4882a593Smuzhiyun struct rtc_time { 25*4882a593Smuzhiyun int tm_sec; 26*4882a593Smuzhiyun int tm_min; 27*4882a593Smuzhiyun int tm_hour; 28*4882a593Smuzhiyun int tm_mday; 29*4882a593Smuzhiyun int tm_mon; 30*4882a593Smuzhiyun int tm_year; 31*4882a593Smuzhiyun int tm_wday; 32*4882a593Smuzhiyun int tm_yday; 33*4882a593Smuzhiyun int tm_isdst; 34*4882a593Smuzhiyun }; 35*4882a593Smuzhiyun 36*4882a593Smuzhiyun /* 37*4882a593Smuzhiyun * This data structure is inspired by the EFI (v0.92) wakeup 38*4882a593Smuzhiyun * alarm API. 39*4882a593Smuzhiyun */ 40*4882a593Smuzhiyun struct rtc_wkalrm { 41*4882a593Smuzhiyun unsigned char enabled; /* 0 = alarm disabled, 1 = alarm enabled */ 42*4882a593Smuzhiyun unsigned char pending; /* 0 = alarm not pending, 1 = alarm pending */ 43*4882a593Smuzhiyun struct rtc_time time; /* time the alarm is set to */ 44*4882a593Smuzhiyun }; 45*4882a593Smuzhiyun 46*4882a593Smuzhiyun /* 47*4882a593Smuzhiyun * Data structure to control PLL correction some better RTC feature 48*4882a593Smuzhiyun * pll_value is used to get or set current value of correction, 49*4882a593Smuzhiyun * the rest of the struct is used to query HW capabilities. 50*4882a593Smuzhiyun * This is modeled after the RTC used in Q40/Q60 computers but 51*4882a593Smuzhiyun * should be sufficiently flexible for other devices 52*4882a593Smuzhiyun * 53*4882a593Smuzhiyun * +ve pll_value means clock will run faster by 54*4882a593Smuzhiyun * pll_value*pll_posmult/pll_clock 55*4882a593Smuzhiyun * -ve pll_value means clock will run slower by 56*4882a593Smuzhiyun * pll_value*pll_negmult/pll_clock 57*4882a593Smuzhiyun */ 58*4882a593Smuzhiyun 59*4882a593Smuzhiyun struct rtc_pll_info { 60*4882a593Smuzhiyun int pll_ctrl; /* placeholder for fancier control */ 61*4882a593Smuzhiyun int pll_value; /* get/set correction value */ 62*4882a593Smuzhiyun int pll_max; /* max +ve (faster) adjustment value */ 63*4882a593Smuzhiyun int pll_min; /* max -ve (slower) adjustment value */ 64*4882a593Smuzhiyun int pll_posmult; /* factor for +ve correction */ 65*4882a593Smuzhiyun int pll_negmult; /* factor for -ve correction */ 66*4882a593Smuzhiyun long pll_clock; /* base PLL frequency */ 67*4882a593Smuzhiyun }; 68*4882a593Smuzhiyun 69*4882a593Smuzhiyun /* 70*4882a593Smuzhiyun * ioctl calls that are permitted to the /dev/rtc interface, if 71*4882a593Smuzhiyun * any of the RTC drivers are enabled. 72*4882a593Smuzhiyun */ 73*4882a593Smuzhiyun 74*4882a593Smuzhiyun #define RTC_AIE_ON _IO('p', 0x01) /* Alarm int. enable on */ 75*4882a593Smuzhiyun #define RTC_AIE_OFF _IO('p', 0x02) /* ... off */ 76*4882a593Smuzhiyun #define RTC_UIE_ON _IO('p', 0x03) /* Update int. enable on */ 77*4882a593Smuzhiyun #define RTC_UIE_OFF _IO('p', 0x04) /* ... off */ 78*4882a593Smuzhiyun #define RTC_PIE_ON _IO('p', 0x05) /* Periodic int. enable on */ 79*4882a593Smuzhiyun #define RTC_PIE_OFF _IO('p', 0x06) /* ... off */ 80*4882a593Smuzhiyun #define RTC_WIE_ON _IO('p', 0x0f) /* Watchdog int. enable on */ 81*4882a593Smuzhiyun #define RTC_WIE_OFF _IO('p', 0x10) /* ... off */ 82*4882a593Smuzhiyun 83*4882a593Smuzhiyun #define RTC_ALM_SET _IOW('p', 0x07, struct rtc_time) /* Set alarm time */ 84*4882a593Smuzhiyun #define RTC_ALM_READ _IOR('p', 0x08, struct rtc_time) /* Read alarm time */ 85*4882a593Smuzhiyun #define RTC_RD_TIME _IOR('p', 0x09, struct rtc_time) /* Read RTC time */ 86*4882a593Smuzhiyun #define RTC_SET_TIME _IOW('p', 0x0a, struct rtc_time) /* Set RTC time */ 87*4882a593Smuzhiyun #define RTC_IRQP_READ _IOR('p', 0x0b, unsigned long) /* Read IRQ rate */ 88*4882a593Smuzhiyun #define RTC_IRQP_SET _IOW('p', 0x0c, unsigned long) /* Set IRQ rate */ 89*4882a593Smuzhiyun #define RTC_EPOCH_READ _IOR('p', 0x0d, unsigned long) /* Read epoch */ 90*4882a593Smuzhiyun #define RTC_EPOCH_SET _IOW('p', 0x0e, unsigned long) /* Set epoch */ 91*4882a593Smuzhiyun 92*4882a593Smuzhiyun #define RTC_WKALM_SET _IOW('p', 0x0f, struct rtc_wkalrm)/* Set wakeup alarm*/ 93*4882a593Smuzhiyun #define RTC_WKALM_RD _IOR('p', 0x10, struct rtc_wkalrm)/* Get wakeup alarm*/ 94*4882a593Smuzhiyun 95*4882a593Smuzhiyun #define RTC_PLL_GET _IOR('p', 0x11, struct rtc_pll_info) /* Get PLL correction */ 96*4882a593Smuzhiyun #define RTC_PLL_SET _IOW('p', 0x12, struct rtc_pll_info) /* Set PLL correction */ 97*4882a593Smuzhiyun 98*4882a593Smuzhiyun #define RTC_VL_DATA_INVALID _BITUL(0) /* Voltage too low, RTC data is invalid */ 99*4882a593Smuzhiyun #define RTC_VL_BACKUP_LOW _BITUL(1) /* Backup voltage is low */ 100*4882a593Smuzhiyun #define RTC_VL_BACKUP_EMPTY _BITUL(2) /* Backup empty or not present */ 101*4882a593Smuzhiyun #define RTC_VL_ACCURACY_LOW _BITUL(3) /* Voltage is low, RTC accuracy is reduced */ 102*4882a593Smuzhiyun #define RTC_VL_BACKUP_SWITCH _BITUL(4) /* Backup switchover happened */ 103*4882a593Smuzhiyun 104*4882a593Smuzhiyun #define RTC_VL_READ _IOR('p', 0x13, unsigned int) /* Voltage low detection */ 105*4882a593Smuzhiyun #define RTC_VL_CLR _IO('p', 0x14) /* Clear voltage low information */ 106*4882a593Smuzhiyun 107*4882a593Smuzhiyun /* interrupt flags */ 108*4882a593Smuzhiyun #define RTC_IRQF 0x80 /* Any of the following is active */ 109*4882a593Smuzhiyun #define RTC_PF 0x40 /* Periodic interrupt */ 110*4882a593Smuzhiyun #define RTC_AF 0x20 /* Alarm interrupt */ 111*4882a593Smuzhiyun #define RTC_UF 0x10 /* Update interrupt for 1Hz RTC */ 112*4882a593Smuzhiyun 113*4882a593Smuzhiyun 114*4882a593Smuzhiyun #define RTC_MAX_FREQ 8192 115*4882a593Smuzhiyun 116*4882a593Smuzhiyun 117*4882a593Smuzhiyun #endif /* _UAPI_LINUX_RTC_H_ */ 118