busybox/util-linux/rtcwake.c

/*
 * rtcwake -- enter a system sleep state until specified wakeup time.
 *
 * This version was taken from util-linux and scrubbed down for busybox.
 *
 * Licensed under GPLv2, see file LICENSE in this tarball for details.
 *
 * This uses cross-platform Linux interfaces to enter a system sleep state,
 * and leave it no later than a specified time.  It uses any RTC framework
 * driver that supports standard driver model wakeup flags.
 *
 * This is normally used like the old "apmsleep" utility, to wake from a
 * suspend state like ACPI S1 (standby) or S3 (suspend-to-RAM).  Most
 * platforms can implement those without analogues of BIOS, APM, or ACPI.
 *
 * On some systems, this can also be used like "nvram-wakeup", waking
 * from states like ACPI S4 (suspend to disk).  Not all systems have
 * persistent media that are appropriate for such suspend modes.
 *
 * The best way to set the system's RTC is so that it holds the current
 * time in UTC.  Use the "-l" flag to tell this program that the system
 * RTC uses a local timezone instead (maybe you dual-boot MS-Windows).
 * That flag should not be needed on systems with adjtime support.
 */

#include "libbb.h"
#include "rtc_.h"

#define SYS_RTC_PATH   "/sys/class/rtc/%s/device/power/wakeup"
#define SYS_POWER_PATH "/sys/power/state"
#define DEFAULT_MODE   "standby"

static NOINLINE bool may_wakeup(const char *rtcname)
{
	ssize_t ret;
	char buf[128];

	/* strip the '/dev/' from the rtcname here */
	if (!strncmp(rtcname, "/dev/", 5))
		rtcname += 5;

	snprintf(buf, sizeof(buf), SYS_RTC_PATH, rtcname);
	ret = open_read_close(buf, buf, sizeof(buf));
	if (ret < 0)
		return false;

	/* wakeup events could be disabled or not supported */
	return strncmp(buf, "enabled\n", 8) == 0;
}

static NOINLINE void setup_alarm(int fd, time_t *wakeup, time_t rtc_time)
{
	struct tm *ptm;
	struct linux_rtc_wkalrm	wake;

	/* The wakeup time is in POSIX time (more or less UTC).
	 * Ideally RTCs use that same time; but PCs can't do that
	 * if they need to boot MS-Windows.  Messy...
	 *
	 * When running in utc mode this process's timezone is UTC,
	 * so we'll pass a UTC date to the RTC.
	 *
	 * Else mode is local so the time given to the RTC
	 * will instead use the local time zone.
	 */
	ptm = localtime(wakeup);

	wake.time.tm_sec = ptm->tm_sec;
	wake.time.tm_min = ptm->tm_min;
	wake.time.tm_hour = ptm->tm_hour;
	wake.time.tm_mday = ptm->tm_mday;
	wake.time.tm_mon = ptm->tm_mon;
	wake.time.tm_year = ptm->tm_year;
	/* wday, yday, and isdst fields are unused by Linux */
	wake.time.tm_wday = -1;
	wake.time.tm_yday = -1;
	wake.time.tm_isdst = -1;

	/* many rtc alarms only support up to 24 hours from 'now',
	 * so use the "more than 24 hours" request only if we must
	 */
	if ((rtc_time + (24 * 60 * 60)) > *wakeup) {
		xioctl(fd, RTC_ALM_SET, &wake.time);
		xioctl(fd, RTC_AIE_ON, 0);
	} else {
		/* avoid an extra AIE_ON call */
		wake.enabled = 1;
		xioctl(fd, RTC_WKALM_SET, &wake);
	}
}

#define RTCWAKE_OPT_AUTO         0x01
#define RTCWAKE_OPT_LOCAL        0x02
#define RTCWAKE_OPT_UTC          0x04
#define RTCWAKE_OPT_DEVICE       0x08
#define RTCWAKE_OPT_SUSPEND_MODE 0x10
#define RTCWAKE_OPT_SECONDS      0x20
#define RTCWAKE_OPT_TIME         0x40

int rtcwake_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
int rtcwake_main(int argc UNUSED_PARAM, char **argv)
{
	time_t rtc_time;

	unsigned opt;
	const char *rtcname = NULL;
	const char *suspend;
	const char *opt_seconds;
	const char *opt_time;

	time_t sys_time;
	time_t alarm_time = 0;
	unsigned seconds = 0;
	int utc = -1;
	int fd;

#if ENABLE_LONG_OPTS
	static const char rtcwake_longopts[] ALIGN1 =
		"auto\0"    No_argument "a"
		"local\0"   No_argument "l"
		"utc\0"     No_argument "u"
		"device\0"  Required_argument "d"
		"mode\0"    Required_argument "m"
		"seconds\0" Required_argument "s"
		"time\0"    Required_argument "t"
		;
	applet_long_options = rtcwake_longopts;
#endif
	opt = getopt32(argv, "alud:m:s:t:", &rtcname, &suspend, &opt_seconds, &opt_time);

	/* this is the default
	if (opt & RTCWAKE_OPT_AUTO)
		utc = -1;
	*/
	if (opt & (RTCWAKE_OPT_UTC | RTCWAKE_OPT_LOCAL))
		utc = opt & RTCWAKE_OPT_UTC;
	if (!(opt & RTCWAKE_OPT_SUSPEND_MODE))
		suspend = DEFAULT_MODE;
	if (opt & RTCWAKE_OPT_SECONDS)
		/* alarm time, seconds-to-sleep (relative) */
		seconds = xatoi(opt_seconds);
	if (opt & RTCWAKE_OPT_TIME)
		/* alarm time, time_t (absolute, seconds since 1/1 1970 UTC) */
		alarm_time = xatol(opt_time);

	if (!alarm_time && !seconds)
		bb_error_msg_and_die("must provide wake time");

	if (utc == -1)
		utc = rtc_adjtime_is_utc();

	/* the rtcname is relative to /dev */
	xchdir("/dev");

	/* this RTC must exist and (if we'll sleep) be wakeup-enabled */
	fd = rtc_xopen(&rtcname, O_RDONLY);

	if (strcmp(suspend, "on") && !may_wakeup(rtcname))
		bb_error_msg_and_die("%s not enabled for wakeup events", rtcname);

	/* relative or absolute alarm time, normalized to time_t */
	sys_time = time(NULL);
	{
		struct tm tm_time;
		rtc_read_tm(&tm_time, fd);
		rtc_time = rtc_tm2time(&tm_time, utc);
	}


	if (alarm_time) {
		if (alarm_time < sys_time)
			bb_error_msg_and_die("time doesn't go backward to %s", ctime(&alarm_time));
		alarm_time += sys_time - rtc_time;
	} else
		alarm_time = rtc_time + seconds + 1;
	setup_alarm(fd, &alarm_time, rtc_time);

	sync();
	printf("wakeup from \"%s\" at %s", suspend, ctime(&alarm_time));
	fflush_all();
	usleep(10 * 1000);

	if (strcmp(suspend, "on"))
		xopen_xwrite_close(SYS_POWER_PATH, suspend);
	else {
		/* "fake" suspend ... we'll do the delay ourselves */
		unsigned long data;

		do {
			ssize_t ret = safe_read(fd, &data, sizeof(data));
			if (ret < 0) {
				bb_perror_msg("rtc read");
				break;
			}
		} while (!(data & RTC_AF));
	}

	xioctl(fd, RTC_AIE_OFF, 0);

	if (ENABLE_FEATURE_CLEAN_UP)
		close(fd);

	return EXIT_SUCCESS;
}
1	/*
2	* rtcwake -- enter a system sleep state until specified wakeup time.
3	*
4	* This version was taken from util-linux and scrubbed down for busybox.
5	*
6	* Licensed under GPLv2, see file LICENSE in this tarball for details.
7	*
8	* This uses cross-platform Linux interfaces to enter a system sleep state,
9	* and leave it no later than a specified time. It uses any RTC framework
10	* driver that supports standard driver model wakeup flags.
11	*
12	* This is normally used like the old "apmsleep" utility, to wake from a
13	* suspend state like ACPI S1 (standby) or S3 (suspend-to-RAM). Most
14	* platforms can implement those without analogues of BIOS, APM, or ACPI.
15	*
16	* On some systems, this can also be used like "nvram-wakeup", waking
17	* from states like ACPI S4 (suspend to disk). Not all systems have
18	* persistent media that are appropriate for such suspend modes.
19	*
20	* The best way to set the system's RTC is so that it holds the current
21	* time in UTC. Use the "-l" flag to tell this program that the system
22	* RTC uses a local timezone instead (maybe you dual-boot MS-Windows).
23	* That flag should not be needed on systems with adjtime support.
24	*/
25
26	#include "libbb.h"
27	#include "rtc_.h"
28
29	#define SYS_RTC_PATH "/sys/class/rtc/%s/device/power/wakeup"
30	#define SYS_POWER_PATH "/sys/power/state"
31	#define DEFAULT_MODE "standby"
32
33	static NOINLINE bool may_wakeup(const char *rtcname)
34	{
35	ssize_t ret;
36	char buf[128];
37
38	/* strip the '/dev/' from the rtcname here */
39	if (!strncmp(rtcname, "/dev/", 5))
40	rtcname += 5;
41
42	snprintf(buf, sizeof(buf), SYS_RTC_PATH, rtcname);
43	ret = open_read_close(buf, buf, sizeof(buf));
44	if (ret < 0)
45	return false;
46
47	/* wakeup events could be disabled or not supported */
48	return strncmp(buf, "enabled\n", 8) == 0;
49	}
50
51	static NOINLINE void setup_alarm(int fd, time_t *wakeup, time_t rtc_time)
52	{
53	struct tm *ptm;
54	struct linux_rtc_wkalrm wake;
55
56	/* The wakeup time is in POSIX time (more or less UTC).
57	* Ideally RTCs use that same time; but PCs can't do that
58	* if they need to boot MS-Windows. Messy...
59	*
60	* When running in utc mode this process's timezone is UTC,
61	* so we'll pass a UTC date to the RTC.
62	*
63	* Else mode is local so the time given to the RTC
64	* will instead use the local time zone.
65	*/
66	ptm = localtime(wakeup);
67
68	wake.time.tm_sec = ptm->tm_sec;
69	wake.time.tm_min = ptm->tm_min;
70	wake.time.tm_hour = ptm->tm_hour;
71	wake.time.tm_mday = ptm->tm_mday;
72	wake.time.tm_mon = ptm->tm_mon;
73	wake.time.tm_year = ptm->tm_year;
74	/* wday, yday, and isdst fields are unused by Linux */
75	wake.time.tm_wday = -1;
76	wake.time.tm_yday = -1;
77	wake.time.tm_isdst = -1;
78
79	/* many rtc alarms only support up to 24 hours from 'now',
80	* so use the "more than 24 hours" request only if we must
81	*/
82	if ((rtc_time + (24 * 60 * 60)) > *wakeup) {
83	xioctl(fd, RTC_ALM_SET, &wake.time);
84	xioctl(fd, RTC_AIE_ON, 0);
85	} else {
86	/* avoid an extra AIE_ON call */
87	wake.enabled = 1;
88	xioctl(fd, RTC_WKALM_SET, &wake);
89	}
90	}
91
92	#define RTCWAKE_OPT_AUTO 0x01
93	#define RTCWAKE_OPT_LOCAL 0x02
94	#define RTCWAKE_OPT_UTC 0x04
95	#define RTCWAKE_OPT_DEVICE 0x08
96	#define RTCWAKE_OPT_SUSPEND_MODE 0x10
97	#define RTCWAKE_OPT_SECONDS 0x20
98	#define RTCWAKE_OPT_TIME 0x40
99
100	int rtcwake_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
101	int rtcwake_main(int argc UNUSED_PARAM, char **argv)
102	{
103	time_t rtc_time;
104
105	unsigned opt;
106	const char *rtcname = NULL;
107	const char *suspend;
108	const char *opt_seconds;
109	const char *opt_time;
110
111	time_t sys_time;
112	time_t alarm_time = 0;
113	unsigned seconds = 0;
114	int utc = -1;
115	int fd;
116
117	#if ENABLE_LONG_OPTS
118	static const char rtcwake_longopts[] ALIGN1 =
119	"auto\0" No_argument "a"
120	"local\0" No_argument "l"
121	"utc\0" No_argument "u"
122	"device\0" Required_argument "d"
123	"mode\0" Required_argument "m"
124	"seconds\0" Required_argument "s"
125	"time\0" Required_argument "t"
126	;
127	applet_long_options = rtcwake_longopts;
128	#endif
129	opt = getopt32(argv, "alud:m:s:t:", &rtcname, &suspend, &opt_seconds, &opt_time);
130
131	/* this is the default
132	if (opt & RTCWAKE_OPT_AUTO)
133	utc = -1;
134	*/
135	if (opt & (RTCWAKE_OPT_UTC \| RTCWAKE_OPT_LOCAL))
136	utc = opt & RTCWAKE_OPT_UTC;
137	if (!(opt & RTCWAKE_OPT_SUSPEND_MODE))
138	suspend = DEFAULT_MODE;
139	if (opt & RTCWAKE_OPT_SECONDS)
140	/* alarm time, seconds-to-sleep (relative) */
141	seconds = xatoi(opt_seconds);
142	if (opt & RTCWAKE_OPT_TIME)
143	/* alarm time, time_t (absolute, seconds since 1/1 1970 UTC) */
144	alarm_time = xatol(opt_time);
145
146	if (!alarm_time && !seconds)
147	bb_error_msg_and_die("must provide wake time");
148
149	if (utc == -1)
150	utc = rtc_adjtime_is_utc();
151
152	/* the rtcname is relative to /dev */
153	xchdir("/dev");
154
155	/* this RTC must exist and (if we'll sleep) be wakeup-enabled */
156	fd = rtc_xopen(&rtcname, O_RDONLY);
157
158	if (strcmp(suspend, "on") && !may_wakeup(rtcname))
159	bb_error_msg_and_die("%s not enabled for wakeup events", rtcname);
160
161	/* relative or absolute alarm time, normalized to time_t */
162	sys_time = time(NULL);
163	{
164	struct tm tm_time;
165	rtc_read_tm(&tm_time, fd);
166	rtc_time = rtc_tm2time(&tm_time, utc);
167	}
168
169
170	if (alarm_time) {
171	if (alarm_time < sys_time)
172	bb_error_msg_and_die("time doesn't go backward to %s", ctime(&alarm_time));
173	alarm_time += sys_time - rtc_time;
174	} else
175	alarm_time = rtc_time + seconds + 1;
176	setup_alarm(fd, &alarm_time, rtc_time);
177
178	sync();
179	printf("wakeup from \"%s\" at %s", suspend, ctime(&alarm_time));
180	fflush_all();
181	usleep(10 * 1000);
182
183	if (strcmp(suspend, "on"))
184	xopen_xwrite_close(SYS_POWER_PATH, suspend);
185	else {
186	/* "fake" suspend ... we'll do the delay ourselves */
187	unsigned long data;
188
189	do {
190	ssize_t ret = safe_read(fd, &data, sizeof(data));
191	if (ret < 0) {
192	bb_perror_msg("rtc read");
193	break;
194	}
195	} while (!(data & RTC_AF));
196	}
197
198	xioctl(fd, RTC_AIE_OFF, 0);
199
200	if (ENABLE_FEATURE_CLEAN_UP)
201	close(fd);
202
203	return EXIT_SUCCESS;
204	}