1 /* 2 * Generic RTC interface. 3 * This version contains the part of the user interface to the Real Time Clock 4 * service. It is used with both the legacy mc146818 and also EFI 5 * Struct rtc_time and first 12 ioctl by Paul Gortmaker, 1996 - separated out 6 * from <linux/mc146818rtc.h> to this file for 2.4 kernels. 7 * 8 * Copyright (C) 1999 Hewlett-Packard Co. 9 * Copyright (C) 1999 Stephane Eranian <[email protected]> 10 */ 11 #ifndef _LINUX_RTC_H_ 12 #define _LINUX_RTC_H_ 13 14 #include <linux/interrupt.h> 15 16 /* 17 * The struct used to pass data via the following ioctl. Similar to the 18 * struct tm in <time.h>, but it needs to be here so that the kernel 19 * source is self contained, allowing cross-compiles, etc. etc. 20 */ 21 22 struct rtc_time { 23 int tm_sec; 24 int tm_min; 25 int tm_hour; 26 int tm_mday; 27 int tm_mon; 28 int tm_year; 29 int tm_wday; 30 int tm_yday; 31 int tm_isdst; 32 }; 33 34 /* 35 * This data structure is inspired by the EFI (v0.92) wakeup 36 * alarm API. 37 */ 38 struct rtc_wkalrm { 39 unsigned char enabled; /* 0 = alarm disable, 1 = alarm disabled */ 40 unsigned char pending; /* 0 = alarm pending, 1 = alarm not pending */ 41 struct rtc_time time; /* time the alarm is set to */ 42 }; 43 44 /* 45 * Data structure to control PLL correction some better RTC feature 46 * pll_value is used to get or set current value of correction, 47 * the rest of the struct is used to query HW capabilities. 48 * This is modeled after the RTC used in Q40/Q60 computers but 49 * should be sufficiently flexible for other devices 50 * 51 * +ve pll_value means clock will run faster by 52 * pll_value*pll_posmult/pll_clock 53 * -ve pll_value means clock will run slower by 54 * pll_value*pll_negmult/pll_clock 55 */ 56 57 struct rtc_pll_info { 58 int pll_ctrl; /* placeholder for fancier control */ 59 int pll_value; /* get/set correction value */ 60 int pll_max; /* max +ve (faster) adjustment value */ 61 int pll_min; /* max -ve (slower) adjustment value */ 62 int pll_posmult; /* factor for +ve correction */ 63 int pll_negmult; /* factor for -ve correction */ 64 long pll_clock; /* base PLL frequency */ 65 }; 66 67 /* 68 * ioctl calls that are permitted to the /dev/rtc interface, if 69 * any of the RTC drivers are enabled. 70 */ 71 72 #define RTC_AIE_ON _IO('p', 0x01) /* Alarm int. enable on */ 73 #define RTC_AIE_OFF _IO('p', 0x02) /* ... off */ 74 #define RTC_UIE_ON _IO('p', 0x03) /* Update int. enable on */ 75 #define RTC_UIE_OFF _IO('p', 0x04) /* ... off */ 76 #define RTC_PIE_ON _IO('p', 0x05) /* Periodic int. enable on */ 77 #define RTC_PIE_OFF _IO('p', 0x06) /* ... off */ 78 #define RTC_WIE_ON _IO('p', 0x0f) /* Watchdog int. enable on */ 79 #define RTC_WIE_OFF _IO('p', 0x10) /* ... off */ 80 81 #define RTC_ALM_SET _IOW('p', 0x07, struct rtc_time) /* Set alarm time */ 82 #define RTC_ALM_READ _IOR('p', 0x08, struct rtc_time) /* Read alarm time */ 83 #define RTC_RD_TIME _IOR('p', 0x09, struct rtc_time) /* Read RTC time */ 84 #define RTC_SET_TIME _IOW('p', 0x0a, struct rtc_time) /* Set RTC time */ 85 #define RTC_IRQP_READ _IOR('p', 0x0b, unsigned long) /* Read IRQ rate */ 86 #define RTC_IRQP_SET _IOW('p', 0x0c, unsigned long) /* Set IRQ rate */ 87 #define RTC_EPOCH_READ _IOR('p', 0x0d, unsigned long) /* Read epoch */ 88 #define RTC_EPOCH_SET _IOW('p', 0x0e, unsigned long) /* Set epoch */ 89 90 #define RTC_WKALM_SET _IOW('p', 0x0f, struct rtc_wkalrm)/* Set wakeup alarm*/ 91 #define RTC_WKALM_RD _IOR('p', 0x10, struct rtc_wkalrm)/* Get wakeup alarm*/ 92 93 #define RTC_PLL_GET _IOR('p', 0x11, struct rtc_pll_info) /* Get PLL correction */ 94 #define RTC_PLL_SET _IOW('p', 0x12, struct rtc_pll_info) /* Set PLL correction */ 95 96 #ifdef __KERNEL__ 97 98 typedef struct rtc_task { 99 void (*func)(void *private_data); 100 void *private_data; 101 } rtc_task_t; 102 103 int rtc_register(rtc_task_t *task); 104 int rtc_unregister(rtc_task_t *task); 105 int rtc_control(rtc_task_t *t, unsigned int cmd, unsigned long arg); 106 void rtc_get_rtc_time(struct rtc_time *rtc_tm); 107 irqreturn_t rtc_interrupt(int irq, void *dev_id, struct pt_regs *regs); 108 109 #endif /* __KERNEL__ */ 110 111 #endif /* _LINUX_RTC_H_ */ 112