util-linux/rtcwake.c

   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  * This uses cross-platform Linux interfaces to enter a system sleep state,
   7  * and leave it no later than a specified time.  It uses any RTC framework
   8  * driver that supports standard driver model wakeup flags.
   9  *
  10  * This is normally used like the old "apmsleep" utility, to wake from a
  11  * suspend state like ACPI S1 (standby) or S3 (suspend-to-RAM).  Most
  12  * platforms can implement those without analogues of BIOS, APM, or ACPI.
  13  *
  14  * On some systems, this can also be used like "nvram-wakeup", waking
  15  * from states like ACPI S4 (suspend to disk).  Not all systems have
  16  * persistent media that are appropriate for such suspend modes.
  17  *
  18  * The best way to set the system's RTC is so that it holds the current
  19  * time in UTC.  Use the "-l" flag to tell this program that the system
  20  * RTC uses a local timezone instead (maybe you dual-boot MS-Windows).
  21  * That flag should not be needed on systems with adjtime support.
  22  */
  23
  24 #include "libbb.h"
  25 #include "rtc_.h"
  26
  27 #define SYS_RTC_PATH   "/sys/class/rtc/%s/device/power/wakeup"
  28 #define SYS_POWER_PATH "/sys/power/state"
  29 #define DEFAULT_MODE   "standby"
  30
  31 static time_t rtc_time;
  32
  33 static 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 void setup_alarm(int fd, time_t *wakeup)
  52 {
  53         struct tm *tm;
  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         tm = localtime(wakeup);
  67
  68         wake.time.tm_sec = tm->tm_sec;
  69         wake.time.tm_min = tm->tm_min;
  70         wake.time.tm_hour = tm->tm_hour;
  71         wake.time.tm_mday = tm->tm_mday;
  72         wake.time.tm_mon = tm->tm_mon;
  73         wake.time.tm_year = tm->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 ATTRIBUTE_UNUSED, char **argv)
 102 {
 103         unsigned opt;
 104         const char *rtcname = NULL;
 105         const char *suspend;
 106         const char *opt_seconds;
 107         const char *opt_time;
 108
 109         time_t sys_time;
 110         time_t alarm_time = 0;
 111         unsigned seconds = 0;
 112         int utc = -1;
 113         int fd;
 114
 115 #if ENABLE_GETOPT_LONG
 116         static const char rtcwake_longopts[] ALIGN1 =
 117                 "auto\0"    No_argument "a"
 118                 "local\0"   No_argument "l"
 119                 "utc\0"     No_argument "u"
 120                 "device\0"  Required_argument "d"
 121                 "mode\0"    Required_argument "m"
 122                 "seconds\0" Required_argument "s"
 123                 "time\0"    Required_argument "t"
 124                 ;
 125         applet_long_options = rtcwake_longopts;
 126 #endif
 127         opt = getopt32(argv, "alud:m:s:t:", &rtcname, &suspend, &opt_seconds, &opt_time);
 128
 129         /* this is the default
 130         if (opt & RTCWAKE_OPT_AUTO)
 131                 utc = -1;
 132         */
 133         if (opt & (RTCWAKE_OPT_UTC | RTCWAKE_OPT_LOCAL))
 134                 utc = opt & RTCWAKE_OPT_UTC;
 135         if (!(opt & RTCWAKE_OPT_SUSPEND_MODE))
 136                 suspend = DEFAULT_MODE;
 137         if (opt & RTCWAKE_OPT_SECONDS)
 138                 /* alarm time, seconds-to-sleep (relative) */
 139                 seconds = xatoi(opt_seconds);
 140         if (opt & RTCWAKE_OPT_TIME)
 141                 /* alarm time, time_t (absolute, seconds since 1/1 1970 UTC) */
 142                 alarm_time = xatoi(opt_time);
 143
 144         if (!alarm_time && !seconds)
 145                 bb_error_msg_and_die("must provide wake time");
 146
 147         if (utc == -1)
 148                 utc = rtc_adjtime_is_utc();
 149
 150         /* the rtcname is relative to /dev */
 151         xchdir("/dev");
 152
 153         /* this RTC must exist and (if we'll sleep) be wakeup-enabled */
 154         fd = rtc_xopen(&rtcname, O_RDONLY);
 155
 156         if (strcmp(suspend, "on") && !may_wakeup(rtcname))
 157                 bb_error_msg_and_die("%s not enabled for wakeup events", rtcname);
 158
 159         /* relative or absolute alarm time, normalized to time_t */
 160         sys_time = time(0);
 161         if (sys_time == (time_t)-1)
 162                 bb_perror_msg_and_die("read system time");
 163         rtc_time = rtc_read_time(fd, utc);
 164
 165         if (alarm_time) {
 166                 if (alarm_time < sys_time)
 167                         bb_error_msg_and_die("time doesn't go backward to %s", ctime(&alarm_time));
 168                 alarm_time += sys_time - rtc_time;
 169         } else
 170                 alarm_time = rtc_time + seconds + 1;
 171         setup_alarm(fd, &alarm_time);
 172
 173         sync();
 174         printf("wakeup from \"%s\" at %s", suspend, ctime(&alarm_time));
 175         fflush(stdout);
 176         usleep(10 * 1000);
 177
 178         if (strcmp(suspend, "on"))
 179                 xopen_xwrite_close(SYS_POWER_PATH, suspend);
 180         else {
 181                 /* "fake" suspend ... we'll do the delay ourselves */
 182                 unsigned long data;
 183
 184                 do {
 185                         ssize_t ret = safe_read(fd, &data, sizeof(data));
 186                         if (ret < 0) {
 187                                 bb_perror_msg("rtc read");
 188                                 break;
 189                         }
 190                 } while (!(data & RTC_AF));
 191         }
 192
 193         xioctl(fd, RTC_AIE_OFF, 0);
 194
 195         if (ENABLE_FEATURE_CLEAN_UP)
 196                 close(fd);
 197
 198         return EXIT_SUCCESS;
 199 }