rtc.h 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  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 _LINUX_RTC_H_
  12. #define _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_SET_RESOLUTION _IOW('p', 0x13, unsigned long) /* Set Timer resolution */
  84. #define RTC_GET_RESOLUTION _IOR('p', 0x14, unsigned long) /* Set Timer resolution */
  85. /* interrupt flags */
  86. #define RTC_IRQF 0x80 /* any of the following is active */
  87. #define RTC_PF 0x40
  88. #define RTC_AF 0x20
  89. #define RTC_UF 0x10
  90. #ifdef __KERNEL__
  91. #include <linux/interrupt.h>
  92. extern int rtc_month_days(unsigned int month, unsigned int year);
  93. extern int rtc_year_days(unsigned int day, unsigned int month, unsigned int year);
  94. extern int rtc_valid_tm(struct rtc_time *tm);
  95. extern int rtc_tm_to_time(struct rtc_time *tm, unsigned long *time);
  96. extern void rtc_time_to_tm(unsigned long time, struct rtc_time *tm);
  97. extern void rtc_merge_alarm(struct rtc_time *now, struct rtc_time *alarm);
  98. #include <linux/device.h>
  99. #include <linux/seq_file.h>
  100. #include <linux/cdev.h>
  101. #include <linux/poll.h>
  102. #include <linux/mutex.h>
  103. extern struct class *rtc_class;
  104. struct rtc_class_ops {
  105. int (*open)(struct device *);
  106. void (*release)(struct device *);
  107. int (*ioctl)(struct device *, unsigned int, unsigned long);
  108. int (*read_time)(struct device *, struct rtc_time *);
  109. int (*set_time)(struct device *, struct rtc_time *);
  110. int (*read_alarm)(struct device *, struct rtc_wkalrm *);
  111. int (*set_alarm)(struct device *, struct rtc_wkalrm *);
  112. int (*proc)(struct device *, struct seq_file *);
  113. int (*set_mmss)(struct device *, unsigned long secs);
  114. int (*irq_set_state)(struct device *, int enabled);
  115. int (*irq_set_freq)(struct device *, int freq);
  116. int (*read_callback)(struct device *, int data);
  117. };
  118. #define RTC_DEVICE_NAME_SIZE 20
  119. struct rtc_task;
  120. struct rtc_device
  121. {
  122. struct class_device class_dev;
  123. struct module *owner;
  124. int id;
  125. char name[RTC_DEVICE_NAME_SIZE];
  126. const struct rtc_class_ops *ops;
  127. struct mutex ops_lock;
  128. struct class_device *rtc_dev;
  129. struct cdev char_dev;
  130. struct mutex char_lock;
  131. unsigned long irq_data;
  132. spinlock_t irq_lock;
  133. wait_queue_head_t irq_queue;
  134. struct fasync_struct *async_queue;
  135. struct rtc_task *irq_task;
  136. spinlock_t irq_task_lock;
  137. int irq_freq;
  138. int max_user_freq;
  139. #ifdef CONFIG_RTC_INTF_DEV_UIE_EMUL
  140. struct work_struct uie_task;
  141. struct timer_list uie_timer;
  142. /* Those fields are protected by rtc->irq_lock */
  143. unsigned int oldsecs;
  144. unsigned int irq_active:1;
  145. unsigned int stop_uie_polling:1;
  146. unsigned int uie_task_active:1;
  147. unsigned int uie_timer_active:1;
  148. #endif
  149. };
  150. #define to_rtc_device(d) container_of(d, struct rtc_device, class_dev)
  151. extern struct rtc_device *rtc_device_register(const char *name,
  152. struct device *dev,
  153. const struct rtc_class_ops *ops,
  154. struct module *owner);
  155. extern void rtc_device_unregister(struct rtc_device *rdev);
  156. extern int rtc_interface_register(struct class_interface *intf);
  157. extern int rtc_read_time(struct class_device *class_dev, struct rtc_time *tm);
  158. extern int rtc_set_time(struct class_device *class_dev, struct rtc_time *tm);
  159. extern int rtc_set_mmss(struct class_device *class_dev, unsigned long secs);
  160. extern int rtc_read_alarm(struct class_device *class_dev,
  161. struct rtc_wkalrm *alrm);
  162. extern int rtc_set_alarm(struct class_device *class_dev,
  163. struct rtc_wkalrm *alrm);
  164. extern void rtc_update_irq(struct class_device *class_dev,
  165. unsigned long num, unsigned long events);
  166. extern struct class_device *rtc_class_open(char *name);
  167. extern void rtc_class_close(struct class_device *class_dev);
  168. extern int rtc_irq_register(struct class_device *class_dev,
  169. struct rtc_task *task);
  170. extern void rtc_irq_unregister(struct class_device *class_dev,
  171. struct rtc_task *task);
  172. extern int rtc_irq_set_state(struct class_device *class_dev,
  173. struct rtc_task *task, int enabled);
  174. extern int rtc_irq_set_freq(struct class_device *class_dev,
  175. struct rtc_task *task, int freq);
  176. typedef struct rtc_task {
  177. void (*func)(void *private_data);
  178. void *private_data;
  179. } rtc_task_t;
  180. int rtc_register(rtc_task_t *task);
  181. int rtc_unregister(rtc_task_t *task);
  182. int rtc_control(rtc_task_t *t, unsigned int cmd, unsigned long arg);
  183. void rtc_get_rtc_time(struct rtc_time *rtc_tm);
  184. irqreturn_t rtc_interrupt(int irq, void *dev_id);
  185. #endif /* __KERNEL__ */
  186. #endif /* _LINUX_RTC_H_ */