rtc.h 3.9 KB

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