projects / mirror_ubuntu-artful-kernel.git / blame
| Commit | Line | Data |
|---|---|---|
| 607ca46e DH |
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 <eranian@hpl.hp.com> | |
| 10 | */ | |
| 11 | #ifndef _UAPI_LINUX_RTC_H_ | |
| 12 | #define _UAPI_LINUX_RTC_H_ | |
| 13 | ||
| 14 | /* | |
| 15 | * The struct used to pass data via the following ioctl. Similar to the | |
| 16 | * struct tm in <time.h>, but it needs to be here so that the kernel | |
| 17 | * source is self contained, allowing cross-compiles, etc. etc. | |
| 18 | */ | |
| 19 | ||
| 20 | struct rtc_time { | |
| 21 | int tm_sec; | |
| 22 | int tm_min; | |
| 23 | int tm_hour; | |
| 24 | int tm_mday; | |
| 25 | int tm_mon; | |
| 26 | int tm_year; | |
| 27 | int tm_wday; | |
| 28 | int tm_yday; | |
| 29 | int tm_isdst; | |
| 30 | }; | |
| 31 | ||
| 32 | /* | |
| 33 | * This data structure is inspired by the EFI (v0.92) wakeup | |
| 34 | * alarm API. | |
| 35 | */ | |
| 36 | struct rtc_wkalrm { | |
| 37 | unsigned char enabled; /* 0 = alarm disabled, 1 = alarm enabled */ | |
| 38 | unsigned char pending; /* 0 = alarm not pending, 1 = alarm pending */ | |
| 39 | struct rtc_time time; /* time the alarm is set to */ | |
| 40 | }; | |
| 41 | ||
| 42 | /* | |
| 43 | * Data structure to control PLL correction some better RTC feature | |
| 44 | * pll_value is used to get or set current value of correction, | |
| 45 | * the rest of the struct is used to query HW capabilities. | |
| 46 | * This is modeled after the RTC used in Q40/Q60 computers but | |
| 47 | * should be sufficiently flexible for other devices | |
| 48 | * | |
| 49 | * +ve pll_value means clock will run faster by | |
| 50 | * pll_value*pll_posmult/pll_clock | |
| 51 | * -ve pll_value means clock will run slower by | |
| 52 | * pll_value*pll_negmult/pll_clock | |
| 53 | */ | |
| 54 | ||
| 55 | struct rtc_pll_info { | |
| 56 | int pll_ctrl; /* placeholder for fancier control */ | |
| 57 | int pll_value; /* get/set correction value */ | |
| 58 | int pll_max; /* max +ve (faster) adjustment value */ | |
| 59 | int pll_min; /* max -ve (slower) adjustment value */ | |
| 60 | int pll_posmult; /* factor for +ve correction */ | |
| 61 | int pll_negmult; /* factor for -ve correction */ | |
| 62 | long pll_clock; /* base PLL frequency */ | |
| 63 | }; | |
| 64 | ||
| 65 | /* | |
| 66 | * ioctl calls that are permitted to the /dev/rtc interface, if | |
| 67 | * any of the RTC drivers are enabled. | |
| 68 | */ | |
| 69 | ||
| 70 | #define RTC_AIE_ON _IO('p', 0x01) /* Alarm int. enable on */ | |
| 71 | #define RTC_AIE_OFF _IO('p', 0x02) /* ... off */ | |
| 72 | #define RTC_UIE_ON _IO('p', 0x03) /* Update int. enable on */ | |
| 73 | #define RTC_UIE_OFF _IO('p', 0x04) /* ... off */ | |
| 74 | #define RTC_PIE_ON _IO('p', 0x05) /* Periodic int. enable on */ | |
| 75 | #define RTC_PIE_OFF _IO('p', 0x06) /* ... off */ | |
| 76 | #define RTC_WIE_ON _IO('p', 0x0f) /* Watchdog int. enable on */ | |
| 77 | #define RTC_WIE_OFF _IO('p', 0x10) /* ... off */ | |
| 78 | ||
| 79 | #define RTC_ALM_SET _IOW('p', 0x07, struct rtc_time) /* Set alarm time */ | |
| 80 | #define RTC_ALM_READ _IOR('p', 0x08, struct rtc_time) /* Read alarm time */ | |
| 81 | #define RTC_RD_TIME _IOR('p', 0x09, struct rtc_time) /* Read RTC time */ | |
| 82 | #define RTC_SET_TIME _IOW('p', 0x0a, struct rtc_time) /* Set RTC time */ | |
| 83 | #define RTC_IRQP_READ _IOR('p', 0x0b, unsigned long) /* Read IRQ rate */ | |
| 84 | #define RTC_IRQP_SET _IOW('p', 0x0c, unsigned long) /* Set IRQ rate */ | |
| 85 | #define RTC_EPOCH_READ _IOR('p', 0x0d, unsigned long) /* Read epoch */ | |
| 86 | #define RTC_EPOCH_SET _IOW('p', 0x0e, unsigned long) /* Set epoch */ | |
| 87 | ||
| 88 | #define RTC_WKALM_SET _IOW('p', 0x0f, struct rtc_wkalrm)/* Set wakeup alarm*/ | |
| 89 | #define RTC_WKALM_RD _IOR('p', 0x10, struct rtc_wkalrm)/* Get wakeup alarm*/ | |
| 90 | ||
| 91 | #define RTC_PLL_GET _IOR('p', 0x11, struct rtc_pll_info) /* Get PLL correction */ | |
| 92 | #define RTC_PLL_SET _IOW('p', 0x12, struct rtc_pll_info) /* Set PLL correction */ | |
| 93 | ||
| 94 | #define RTC_VL_READ _IOR('p', 0x13, int) /* Voltage low detector */ | |
| 95 | #define RTC_VL_CLR _IO('p', 0x14) /* Clear voltage low information */ | |
| 96 | ||
| 97 | /* interrupt flags */ | |
| 98 | #define RTC_IRQF 0x80 /* Any of the following is active */ | |
| 99 | #define RTC_PF 0x40 /* Periodic interrupt */ | |
| 100 | #define RTC_AF 0x20 /* Alarm interrupt */ | |
| 101 | #define RTC_UF 0x10 /* Update interrupt for 1Hz RTC */ | |
| 102 | ||
| 103 | ||
| 104 | #define RTC_MAX_FREQ 8192 | |
| 105 | ||
| 106 | ||
| 107 | #endif /* _UAPI_LINUX_RTC_H_ */ |