share/man/man4/man4.x68k/pow.4

   1 .\"     $NetBSD: pow.4,v 1.13 2008/12/20 17:25:20 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1995 MINOURA Makoto.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"    This product includes software developed by Minoura Makoto.
  17 .\" 4. The name of the author may not be used to endorse or promote products
  18 .\"    derived from this software without specific prior written permission
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  21 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  22 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  23 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  29 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .Dd December 20, 2008
  32 .Dt POW 4 x68k
  33 .Os
  34 .Sh NAME
  35 .Nm pow
  36 .Nd X68k power switch device
  37 .Sh DESCRIPTION
  38 File
  39 .Pa /dev/pow0
  40 is a device used to access the x68k power switch / bootstrap information and
  41 the RTC alarm timer.
  42 The following operations are allowed using the
  43 .Xr ioctl 2
  44 system call:
  45 .Pp
  46 .Bl -tag -width POWIOCGPOWERINFO -compact -offset indent
  47 .It POWIOGPOWERINFO
  48 Get power switch status
  49 .It POWIOGALARMINFO
  50 Get RTC alarm timer status
  51 .It POWIOSALARMINFO
  52 Set RTC alarm timer
  53 .El
  54 .Pp
  55 Any power switch events are reported to
  56 .Xr powerd 8 .
  57 .Sh GETTING POWER SWITCH STATUS
  58 .Bd -literal -offset indent
  59 #include \*[Lt]sys/ioctl.h\*[Gt]
  60 #include \*[Lt]machine/powioctl.h\*[Gt]
  61
  62 ioctl (fd, POWIOCGPOWERINFO, \*[Am]powerinfo);
  63 struct x68k_powerinfo powerinfo;
  64 .Ed
  65 .Pp
  66 Returns the power switch status etc. in the following structure.
  67 .Bd -literal -offset indent
  68 struct x68k_powerinfo {
  69         int pow_switch_boottime;
  70         int pow_switch_current;
  71         time_t pow_boottime;
  72         unsigned int pow_bootcount;
  73         time_t pow_usedtotal;
  74 };
  75 .Ed
  76 .Pp
  77 The members of the structure mean:
  78 .Bl -hang
  79 .It pow_switch_boottime :
  80 The power switch status at the system start time.
  81 The status can be checked by testing for the following definitions
  82 with the logical
  83 .Dq and
  84 (\*[Am]):
  85 .Pp
  86 .Bl -tag -compact -width POW_EXTERNALSW
  87 .It POW_ALARMSW
  88 True if the system started by the RTC alarm timer
  89 .It POW_EXTERNALSW
  90 True if the EXPWON signal of the I/O slot is on
  91 .It POW_FRONTSW
  92 True if the front power switch is on
  93 .El
  94 .Pp
  95 EXPWON-related information is not tested.
  96 .It pow_switch_current :
  97 Current power switch status.
  98 See above.
  99 .It pow_boottime :
 100 The time when
 101 .Nx
 102 started.
 103 .It pow_bootcount , pow_usedtotal :
 104 Host's boot information from the system memory switch.
 105 Total usage in count (pow_bootcount) and second (pow_usedtotal).
 106 .El
 107 .Sh ACCESSING RTC ALARM TIMER
 108 .Ss Getting the alarm timer
 109 .Bd -literal -offset indent
 110 #include \*[Lt]sys/ioctl.h\*[Gt]
 111 #include \*[Lt]machine/powioctl.h\*[Gt]
 112
 113 ioctl (fd, POWIOCGALARMINFO, \*[Am]alarminfo);
 114 struct x68k_alarminfo alarminfo;
 115 .Ed
 116 .Pp
 117 Returns x68k's alarm timer information in the following structure.
 118 .Bd -literal -offset indent
 119 struct x68k_alarminfo {
 120         int al_enable;
 121         unsigned int al_ontime;
 122         int al_dowhat;
 123         time_t al_offtime;
 124 };
 125 .Ed
 126 .Pp
 127 The members mean:
 128 .Bl -hang
 129 .It al_enable :
 130 True if the alarm timer is enable.
 131 .It al_ontime :
 132 Internal expression of the alarm timer.
 133 See
 134 .Dq C Compiler PRO-68K Programmers' Manual
 135 Chapter 3 Section ALARMSET.
 136 .It al_dowhat :
 137 What to do when started by the alarm timer.
 138 See
 139 .Dq Programmers' manual .
 140 .It al_offtime :
 141 Display the time in seconds since the alarm is activated until
 142 the power is turned off (though the resolution is resolved to minutes).
 143 Be cautious when using IOCS and the like as these require minute
 144 time units.
 145 0 indicates an infinity.
 146 .El
 147 .Ss Setting the alarm timer
 148 .Bd -literal -offset indent
 149 ioctl (fd, POWIOCSALARMINFO, \*[Am]alarminfo);
 150 struct x68k_alarminfo alarminfo;
 151 .Ed
 152 .Pp
 153 Sets the alarm timer according to the argument
 154 .Ar alarminfo
 155 (see above).
 156 .Sh SEE ALSO
 157 .Xr ioctl 2 ,
 158 .Xr powerd 8 ,
 159 .Xr rtcalarm 8
 160 .Rs
 161 .%T C Compiler PRO-68K Programmers' Manual', Chapter 3 IOCS Calls, Section ALARMSET
 162 .%I Sharp
 163 .Re
 164 .Sh AUTHORS
 165 .An Minoura Makoto Aq minoura@flab.fujitsu.co.jp
 166 .Ss SPECIAL THANKS
 167 Liam Hahne Minn
 168 .Aq hahne@sail.t.u-tokyo.ac.jp
 169 .Sh BUGS
 170 The file
 171 .Pa /dev/pow0
 172 can only be opened by one process at a time.