[thirdparty/util-linux.git] / sys-utils / hwclock.h

#ifndef HWCLOCK_CLOCK_H
#define HWCLOCK_CLOCK_H

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/time.h>
#include <time.h>

#include "c.h"
#include "debug.h"
#include "nls.h"

#define HWCLOCK_DEBUG_INIT		(1 << 0)
#define HWCLOCK_DEBUG_RANDOM_SLEEP	(1 << 1)
#define HWCLOCK_DEBUG_DELTA_VS_TARGET	(1 << 2)
#define HWCLOCK_DEBUG_ALL		0xFFFF

UL_DEBUG_DECLARE_MASK(hwclock);
#define DBG(m, x)	__UL_DBG(hwclock, HWCLOCK_DEBUG_, m, x)
#define ON_DBG(m, x)	__UL_DBG_CALL(hwclock, HWCLOCK_DEBUG_, m, x)

struct hwclock_control {
	char *date_opt;
	char *adj_file_name;
	double rtc_delay;	/* --delay <seconds> */
#if defined(__linux__) && defined(__alpha__)
	char *epoch_option;
#endif
#ifdef __linux__
	char *rtc_dev_name;
#endif
	char *param_get_option;
	char *param_set_option;
	unsigned int
		hwaudit_on:1,
		adjust:1,
		show:1,
		hctosys:1,
		utc:1,
		systohc:1,
#if defined(__linux__) && defined(__alpha__)
		getepoch:1,
		setepoch:1,
#endif
		noadjfile:1,
		local_opt:1,
		directisa:1,
		testing:1,
		systz:1,
		predict:1,
		get:1,
		set:1,
		update:1,
		universal:1,	/* will store hw_clock_is_utc() return value */
		verbose:1;
};

struct clock_ops {
	char *interface_name;
	int (*get_permissions) (void);
	int (*read_hardware_clock) (const struct hwclock_control *ctl, struct tm * tm);
	int (*set_hardware_clock) (const struct hwclock_control *ctl, const struct tm * tm);
	int (*synchronize_to_clock_tick) (const struct hwclock_control *ctl);
	const char *(*get_device_path) (void);
};

extern struct clock_ops *probe_for_cmos_clock(void);
extern struct clock_ops *probe_for_rtc_clock(const struct hwclock_control *ctl);

/* hwclock.c */
extern double time_diff(struct timeval subtrahend, struct timeval subtractor);

/* rtc.c */
#if defined(__linux__) && defined(__alpha__)
extern int get_epoch_rtc(const struct hwclock_control *ctl, unsigned long *epoch);
extern int set_epoch_rtc(const struct hwclock_control *ctl);
#endif

struct rtc_param {
	uint64_t param;
	union {
		uint64_t uvalue;
		int64_t svalue;
		uint64_t ptr;
	};
	uint32_t index;
	uint32_t __pad;
};

#define RTC_PARAM_GET	_IOW('p', 0x13, struct rtc_param)
#define RTC_PARAM_SET	_IOW('p', 0x14, struct rtc_param)

#define RTC_PARAM_FEATURES		0
#define RTC_PARAM_CORRECTION		1
#define RTC_PARAM_BACKUP_SWITCH_MODE	2

struct hwclock_param {
	int id;
	const char *name;
	const char *help;
};

extern const struct hwclock_param *get_hwclock_params(void);
extern int get_param_rtc(const struct hwclock_control *ctl, struct rtc_param *param);
extern int set_param_rtc(const struct hwclock_control *ctl);

extern void __attribute__((__noreturn__))
hwclock_exit(const struct hwclock_control *ctl, int status);

extern int parse_date(struct timespec *, char const *, struct timespec const *);

#endif				/* HWCLOCK_CLOCK_H */
Commit	Line	Data
9abb2685 KZ	1	#ifndef HWCLOCK_CLOCK_H
	2	#define HWCLOCK_CLOCK_H
	3
7eda085c	4	#include <stdio.h>
66ee8158	5	#include <stdlib.h>
7eda085c	6	#include <string.h>
f2ff0adf	7	#include <sys/time.h>
7eda085c KZ	8	#include <time.h>
7eda085c KZ	9
b940bae3	10	#include "c.h"
ff4e18bd	11	#include "debug.h"
6097b12d	12	#include "nls.h"
ff4e18bd WP	13
	14	#define HWCLOCK_DEBUG_INIT (1 << 0)
	15	#define HWCLOCK_DEBUG_RANDOM_SLEEP (1 << 1)
	16	#define HWCLOCK_DEBUG_DELTA_VS_TARGET (1 << 2)
	17	#define HWCLOCK_DEBUG_ALL 0xFFFF
	18
	19	UL_DEBUG_DECLARE_MASK(hwclock);
	20	#define DBG(m, x) __UL_DBG(hwclock, HWCLOCK_DEBUG_, m, x)
	21	#define ON_DBG(m, x) __UL_DBG_CALL(hwclock, HWCLOCK_DEBUG_, m, x)
b940bae3	22
336f7c5f SK	23	struct hwclock_control {
336f7c5f SK	24	char *date_opt;
336f7c5f	25	char *adj_file_name;
df4f1a66	26	double rtc_delay; /* --delay <seconds> */
039a0cec	27	#if defined(__linux__) && defined(__alpha__)
f7599b4f	28	char *epoch_option;
039a0cec	29	#endif
336f7c5f SK	30	#ifdef __linux__
	31	char *rtc_dev_name;
	32	#endif
6097b12d	33	char *param_get_option;
b22b78b1	34	char *param_set_option;
336f7c5f	35	unsigned int
336f7c5f	36	hwaudit_on:1,
336f7c5f	37	adjust:1,
336f7c5f SK	38	show:1,
	39	hctosys:1,
	40	utc:1,
	41	systohc:1,
039a0cec	42	#if defined(__linux__) && defined(__alpha__)
336f7c5f SK	43	getepoch:1,
	44	setepoch:1,
	45	#endif
	46	noadjfile:1,
	47	local_opt:1,
336f7c5f SK	48	directisa:1,
	49	testing:1,
	50	systz:1,
	51	predict:1,
	52	get:1,
	53	set:1,
	54	update:1,
ff4e18bd WP	55	universal:1, /* will store hw_clock_is_utc() return value */
ff4e18bd WP	56	verbose:1;
336f7c5f SK	57	};
336f7c5f SK	58
7eda085c KZ	59	struct clock_ops {
7eda085c KZ	60	char *interface_name;
ef71b8f1	61	int (*get_permissions) (void);
336f7c5f SK	62	int (read_hardware_clock) (const struct hwclock_control ctl, struct tm * tm);
	63	int (set_hardware_clock) (const struct hwclock_control ctl, const struct tm * tm);
	64	int (synchronize_to_clock_tick) (const struct hwclock_control ctl);
df4f1a66	65	const char (get_device_path) (void);
7eda085c KZ	66	};
	67
	68	extern struct clock_ops *probe_for_cmos_clock(void);
336f7c5f	69	extern struct clock_ops probe_for_rtc_clock(const struct hwclock_control ctl);
7eda085c	70
7eda085c	71	/* hwclock.c */
982a4a5d	72	extern double time_diff(struct timeval subtrahend, struct timeval subtractor);
7eda085c KZ	73
7eda085c KZ	74	/* rtc.c */
039a0cec	75	#if defined(__linux__) && defined(__alpha__)
af68bd01	76	extern int get_epoch_rtc(const struct hwclock_control ctl, unsigned long epoch);
336f7c5f	77	extern int set_epoch_rtc(const struct hwclock_control *ctl);
039a0cec	78	#endif
88058a71	79
6097b12d BK	80	struct rtc_param {
	81	uint64_t param;
	82	union {
	83	uint64_t uvalue;
	84	int64_t svalue;
	85	uint64_t ptr;
	86	};
	87	uint32_t index;
	88	uint32_t __pad;
	89	};
	90
	91	#define RTC_PARAM_GET _IOW('p', 0x13, struct rtc_param)
b22b78b1	92	#define RTC_PARAM_SET _IOW('p', 0x14, struct rtc_param)
6097b12d BK	93
	94	#define RTC_PARAM_FEATURES 0
	95	#define RTC_PARAM_CORRECTION 1
	96	#define RTC_PARAM_BACKUP_SWITCH_MODE 2
	97
	98	struct hwclock_param {
	99	int id;
	100	const char *name;
	101	const char *help;
	102	};
	103
63d81834	104	extern const struct hwclock_param *get_hwclock_params(void);
6097b12d	105	extern int get_param_rtc(const struct hwclock_control ctl, struct rtc_param param);
b22b78b1	106	extern int set_param_rtc(const struct hwclock_control *ctl);
6097b12d	107
39ff5b34 RM	108	extern void __attribute__((__noreturn__))
39ff5b34 RM	109	hwclock_exit(const struct hwclock_control *ctl, int status);
9abb2685	110
8e1b131e KZ	111	extern int parse_date(struct timespec , char const , struct timespec const *);
8e1b131e KZ	112
ef71b8f1	113	#endif /* HWCLOCK_CLOCK_H */