[mirror_ubuntu-artful-kernel.git] / include / linux / rtc.h

/*
 * Generic RTC interface.
 * This version contains the part of the user interface to the Real Time Clock
 * service. It is used with both the legacy mc146818 and also  EFI
 * Struct rtc_time and first 12 ioctl by Paul Gortmaker, 1996 - separated out
 * from <linux/mc146818rtc.h> to this file for 2.4 kernels.
 * 
 * Copyright (C) 1999 Hewlett-Packard Co.
 * Copyright (C) 1999 Stephane Eranian <eranian@hpl.hp.com>
 */
#ifndef _LINUX_RTC_H_
#define _LINUX_RTC_H_

/*
 * The struct used to pass data via the following ioctl. Similar to the
 * struct tm in <time.h>, but it needs to be here so that the kernel 
 * source is self contained, allowing cross-compiles, etc. etc.
 */

struct rtc_time {
	int tm_sec;
	int tm_min;
	int tm_hour;
	int tm_mday;
	int tm_mon;
	int tm_year;
	int tm_wday;
	int tm_yday;
	int tm_isdst;
};

/*
 * This data structure is inspired by the EFI (v0.92) wakeup
 * alarm API.
 */
struct rtc_wkalrm {
	unsigned char enabled;	/* 0 = alarm disable, 1 = alarm disabled */
	unsigned char pending;  /* 0 = alarm pending, 1 = alarm not pending */
	struct rtc_time time;	/* time the alarm is set to */
};

/*
 * Data structure to control PLL correction some better RTC feature
 * pll_value is used to get or set current value of correction,
 * the rest of the struct is used to query HW capabilities.
 * This is modeled after the RTC used in Q40/Q60 computers but
 * should be sufficiently flexible for other devices
 *
 * +ve pll_value means clock will run faster by
 *   pll_value*pll_posmult/pll_clock
 * -ve pll_value means clock will run slower by
 *   pll_value*pll_negmult/pll_clock
 */ 

struct rtc_pll_info {
	int pll_ctrl;       /* placeholder for fancier control */
	int pll_value;      /* get/set correction value */
	int pll_max;        /* max +ve (faster) adjustment value */
	int pll_min;        /* max -ve (slower) adjustment value */
	int pll_posmult;    /* factor for +ve correction */
	int pll_negmult;    /* factor for -ve correction */
	long pll_clock;     /* base PLL frequency */
};

/*
 * ioctl calls that are permitted to the /dev/rtc interface, if
 * any of the RTC drivers are enabled.
 */

#define RTC_AIE_ON	_IO('p', 0x01)	/* Alarm int. enable on		*/
#define RTC_AIE_OFF	_IO('p', 0x02)	/* ... off			*/
#define RTC_UIE_ON	_IO('p', 0x03)	/* Update int. enable on	*/
#define RTC_UIE_OFF	_IO('p', 0x04)	/* ... off			*/
#define RTC_PIE_ON	_IO('p', 0x05)	/* Periodic int. enable on	*/
#define RTC_PIE_OFF	_IO('p', 0x06)	/* ... off			*/
#define RTC_WIE_ON	_IO('p', 0x0f)  /* Watchdog int. enable on	*/
#define RTC_WIE_OFF	_IO('p', 0x10)  /* ... off			*/

#define RTC_ALM_SET	_IOW('p', 0x07, struct rtc_time) /* Set alarm time  */
#define RTC_ALM_READ	_IOR('p', 0x08, struct rtc_time) /* Read alarm time */
#define RTC_RD_TIME	_IOR('p', 0x09, struct rtc_time) /* Read RTC time   */
#define RTC_SET_TIME	_IOW('p', 0x0a, struct rtc_time) /* Set RTC time    */
#define RTC_IRQP_READ	_IOR('p', 0x0b, unsigned long)	 /* Read IRQ rate   */
#define RTC_IRQP_SET	_IOW('p', 0x0c, unsigned long)	 /* Set IRQ rate    */
#define RTC_EPOCH_READ	_IOR('p', 0x0d, unsigned long)	 /* Read epoch      */
#define RTC_EPOCH_SET	_IOW('p', 0x0e, unsigned long)	 /* Set epoch       */

#define RTC_WKALM_SET	_IOW('p', 0x0f, struct rtc_wkalrm)/* Set wakeup alarm*/
#define RTC_WKALM_RD	_IOR('p', 0x10, struct rtc_wkalrm)/* Get wakeup alarm*/

#define RTC_PLL_GET	_IOR('p', 0x11, struct rtc_pll_info)  /* Get PLL correction */
#define RTC_PLL_SET	_IOW('p', 0x12, struct rtc_pll_info)  /* Set PLL correction */

/* interrupt flags */
#define RTC_IRQF 0x80 /* any of the following is active */
#define RTC_PF 0x40
#define RTC_AF 0x20
#define RTC_UF 0x10

#ifdef __KERNEL__

#include <linux/interrupt.h>

extern int rtc_month_days(unsigned int month, unsigned int year);
extern int rtc_valid_tm(struct rtc_time *tm);
extern int rtc_tm_to_time(struct rtc_time *tm, unsigned long *time);
extern void rtc_time_to_tm(unsigned long time, struct rtc_time *tm);

#include <linux/device.h>
#include <linux/seq_file.h>
#include <linux/cdev.h>
#include <linux/poll.h>
#include <linux/mutex.h>

extern struct class *rtc_class;

struct rtc_class_ops {
	int (*open)(struct device *);
	void (*release)(struct device *);
	int (*ioctl)(struct device *, unsigned int, unsigned long);
	int (*read_time)(struct device *, struct rtc_time *);
	int (*set_time)(struct device *, struct rtc_time *);
	int (*read_alarm)(struct device *, struct rtc_wkalrm *);
	int (*set_alarm)(struct device *, struct rtc_wkalrm *);
	int (*proc)(struct device *, struct seq_file *);
	int (*set_mmss)(struct device *, unsigned long secs);
	int (*irq_set_state)(struct device *, int enabled);
	int (*irq_set_freq)(struct device *, int freq);
	int (*read_callback)(struct device *, int data);
};

#define RTC_DEVICE_NAME_SIZE 20
struct rtc_task;

struct rtc_device
{
	struct class_device class_dev;
	struct module *owner;

	int id;
	char name[RTC_DEVICE_NAME_SIZE];

	struct rtc_class_ops *ops;
	struct mutex ops_lock;

	struct class_device *rtc_dev;
	struct cdev char_dev;
	struct mutex char_lock;

	unsigned long irq_data;
	spinlock_t irq_lock;
	wait_queue_head_t irq_queue;
	struct fasync_struct *async_queue;

	struct rtc_task *irq_task;
	spinlock_t irq_task_lock;
	int irq_freq;
	int max_user_freq;
#ifdef CONFIG_RTC_INTF_DEV_UIE_EMUL
	struct work_struct uie_task;
	struct timer_list uie_timer;
	/* Those fields are protected by rtc->irq_lock */
	unsigned int oldsecs;
	unsigned int irq_active:1;
	unsigned int stop_uie_polling:1;
	unsigned int uie_task_active:1;
	unsigned int uie_timer_active:1;
#endif
};
#define to_rtc_device(d) container_of(d, struct rtc_device, class_dev)

extern struct rtc_device *rtc_device_register(const char *name,
					struct device *dev,
					struct rtc_class_ops *ops,
					struct module *owner);
extern void rtc_device_unregister(struct rtc_device *rdev);
extern int rtc_interface_register(struct class_interface *intf);

extern int rtc_read_time(struct class_device *class_dev, struct rtc_time *tm);
extern int rtc_set_time(struct class_device *class_dev, struct rtc_time *tm);
extern int rtc_set_mmss(struct class_device *class_dev, unsigned long secs);
extern int rtc_read_alarm(struct class_device *class_dev,
			struct rtc_wkalrm *alrm);
extern int rtc_set_alarm(struct class_device *class_dev,
				struct rtc_wkalrm *alrm);
extern void rtc_update_irq(struct class_device *class_dev,
			unsigned long num, unsigned long events);

extern struct class_device *rtc_class_open(char *name);
extern void rtc_class_close(struct class_device *class_dev);

extern int rtc_irq_register(struct class_device *class_dev,
				struct rtc_task *task);
extern void rtc_irq_unregister(struct class_device *class_dev,
				struct rtc_task *task);
extern int rtc_irq_set_state(struct class_device *class_dev,
				struct rtc_task *task, int enabled);
extern int rtc_irq_set_freq(struct class_device *class_dev,
				struct rtc_task *task, int freq);

typedef struct rtc_task {
	void (*func)(void *private_data);
	void *private_data;
} rtc_task_t;

int rtc_register(rtc_task_t *task);
int rtc_unregister(rtc_task_t *task);
int rtc_control(rtc_task_t *t, unsigned int cmd, unsigned long arg);
void rtc_get_rtc_time(struct rtc_time *rtc_tm);
irqreturn_t rtc_interrupt(int irq, void *dev_id, struct pt_regs *regs);

#endif /* __KERNEL__ */

#endif /* _LINUX_RTC_H_ */
Commit	Line	Data
1da177e4 LT	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	/*
	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 disable, 1 = alarm disabled */
	38	unsigned char pending; /* 0 = alarm pending, 1 = alarm not 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
0c86edc0 AZ	94	/* interrupt flags */
	95	#define RTC_IRQF 0x80 /* any of the following is active */
	96	#define RTC_PF 0x40
	97	#define RTC_AF 0x20
	98	#define RTC_UF 0x10
	99
1da177e4 LT	100	#ifdef __KERNEL__
1da177e4 LT	101
4024ce5e JK	102	#include <linux/interrupt.h>
4024ce5e JK	103
c58411e9 AZ	104	extern int rtc_month_days(unsigned int month, unsigned int year);
	105	extern int rtc_valid_tm(struct rtc_time *tm);
	106	extern int rtc_tm_to_time(struct rtc_time tm, unsigned long time);
	107	extern void rtc_time_to_tm(unsigned long time, struct rtc_time *tm);
	108
0c86edc0 AZ	109	#include <linux/device.h>
	110	#include <linux/seq_file.h>
	111	#include <linux/cdev.h>
	112	#include <linux/poll.h>
	113	#include <linux/mutex.h>
	114
	115	extern struct class *rtc_class;
	116
	117	struct rtc_class_ops {
	118	int (open)(struct device );
	119	void (release)(struct device );
	120	int (ioctl)(struct device , unsigned int, unsigned long);
	121	int (read_time)(struct device , struct rtc_time *);
	122	int (set_time)(struct device , struct rtc_time *);
	123	int (read_alarm)(struct device , struct rtc_wkalrm *);
	124	int (set_alarm)(struct device , struct rtc_wkalrm *);
	125	int (proc)(struct device , struct seq_file *);
	126	int (set_mmss)(struct device , unsigned long secs);
	127	int (irq_set_state)(struct device , int enabled);
	128	int (irq_set_freq)(struct device , int freq);
	129	int (read_callback)(struct device , int data);
	130	};
	131
	132	#define RTC_DEVICE_NAME_SIZE 20
	133	struct rtc_task;
	134
	135	struct rtc_device
	136	{
	137	struct class_device class_dev;
	138	struct module *owner;
	139
	140	int id;
	141	char name[RTC_DEVICE_NAME_SIZE];
	142
	143	struct rtc_class_ops *ops;
	144	struct mutex ops_lock;
	145
	146	struct class_device *rtc_dev;
	147	struct cdev char_dev;
	148	struct mutex char_lock;
	149
	150	unsigned long irq_data;
	151	spinlock_t irq_lock;
	152	wait_queue_head_t irq_queue;
	153	struct fasync_struct *async_queue;
	154
	155	struct rtc_task *irq_task;
	156	spinlock_t irq_task_lock;
	157	int irq_freq;
110d693d	158	int max_user_freq;
655066c3 AN	159	#ifdef CONFIG_RTC_INTF_DEV_UIE_EMUL
	160	struct work_struct uie_task;
	161	struct timer_list uie_timer;
	162	/* Those fields are protected by rtc->irq_lock */
	163	unsigned int oldsecs;
	164	unsigned int irq_active:1;
	165	unsigned int stop_uie_polling:1;
	166	unsigned int uie_task_active:1;
	167	unsigned int uie_timer_active:1;
	168	#endif
0c86edc0 AZ	169	};
	170	#define to_rtc_device(d) container_of(d, struct rtc_device, class_dev)
	171
	172	extern struct rtc_device rtc_device_register(const char name,
	173	struct device *dev,
	174	struct rtc_class_ops *ops,
	175	struct module *owner);
	176	extern void rtc_device_unregister(struct rtc_device *rdev);
	177	extern int rtc_interface_register(struct class_interface *intf);
	178
	179	extern int rtc_read_time(struct class_device class_dev, struct rtc_time tm);
	180	extern int rtc_set_time(struct class_device class_dev, struct rtc_time tm);
	181	extern int rtc_set_mmss(struct class_device *class_dev, unsigned long secs);
	182	extern int rtc_read_alarm(struct class_device *class_dev,
	183	struct rtc_wkalrm *alrm);
	184	extern int rtc_set_alarm(struct class_device *class_dev,
	185	struct rtc_wkalrm *alrm);
	186	extern void rtc_update_irq(struct class_device *class_dev,
	187	unsigned long num, unsigned long events);
	188
	189	extern struct class_device rtc_class_open(char name);
	190	extern void rtc_class_close(struct class_device *class_dev);
	191
	192	extern int rtc_irq_register(struct class_device *class_dev,
	193	struct rtc_task *task);
	194	extern void rtc_irq_unregister(struct class_device *class_dev,
	195	struct rtc_task *task);
	196	extern int rtc_irq_set_state(struct class_device *class_dev,
	197	struct rtc_task *task, int enabled);
	198	extern int rtc_irq_set_freq(struct class_device *class_dev,
	199	struct rtc_task *task, int freq);
	200
1da177e4 LT	201	typedef struct rtc_task {
	202	void (func)(void private_data);
	203	void *private_data;
	204	} rtc_task_t;
	205
	206	int rtc_register(rtc_task_t *task);
	207	int rtc_unregister(rtc_task_t *task);
	208	int rtc_control(rtc_task_t *t, unsigned int cmd, unsigned long arg);
	209	void rtc_get_rtc_time(struct rtc_time *rtc_tm);
2a10e0b2	210	irqreturn_t rtc_interrupt(int irq, void dev_id, struct pt_regs regs);
1da177e4 LT	211
	212	#endif /* __KERNEL__ */
	213
	214	#endif /* _LINUX_RTC_H_ */