share/man/man4/man4.sparc64/eeprom.4

   1 .\"-
   2 .\" Copyright (c) 2004 Jason L. Wright (jason@thought.net)
   3 .\" Copyright (c) 2005 Marius Strobl <marius@FreeBSD.org>
   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 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  17 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  19 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  23 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  24 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25 .\" POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\"     from: OpenBSD: clock.4,v 1.3 2004/09/24 07:04:15 miod Exp
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd February 15, 2006
  31 .Dt EEPROM 4 sparc64
  32 .Os
  33 .Sh NAME
  34 .Nm eeprom
  35 .Nd "non-volatile RAM / real time clock"
  36 .Sh SYNOPSIS
  37 .Cd "device genclock"
  38 .Cd "device mk48txx"
  39 .Cd "device eeprom"
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 driver is a front-end for the machine-independent
  44 .Tn Mostek
  45 MK48Txx driver.
  46 The
  47 .Tn Mostek
  48 MK48Txx driver provides access to the real time clock and the watchdog part
  49 of the supported chips to
  50 .Fx
  51 by interfacing them with the generic clock code and
  52 .Xr watchdog 4
  53 respectively.
  54 .Pp
  55 .Tn Mostek
  56 MK48Txx chips providing real time clock functionality are found on the
  57 .Tn EBus ,
  58 .Tn FireHose
  59 and
  60 .Tn SBus
  61 busses of
  62 .Tn UltraSPARC
  63 systems.
  64 On systems where the hostid is stored in the NVRAM part of the
  65 .Tn Mostek
  66 MK48Txx chip the
  67 .Nm
  68 driver prints out the hostid on attach.
  69 .Pp
  70 On
  71 .Tn Sun Enterprise
  72 250 and 450 systems additionally the watchdog functionality of the
  73 .Tn Mostek
  74 MK48Txx chips is available.
  75 The
  76 .Nm
  77 driver automatically registers the watchdog part with
  78 .Xr watchdog 4
  79 on these systems.
  80 Thus it can be used with
  81 .Xr watchdog 8
  82 and
  83 .Xr watchdogd 8 .
  84 The timeout interval supported by the
  85 .Tn Mostek
  86 MK48Txx watchdog is 1/16 second to 128 seconds.
  87 In the
  88 .Tn Sun Enterprise
  89 machines a system reset is triggered when the
  90 .Tn Mostek
  91 MK48Txx watchdog times out regardless of what the
  92 .Tn Open Firmware
  93 environment variable
  94 .Va watchdog-reboot?
  95 is set to.
  96 .Sh DIAGNOSTICS
  97 The following driver specific error message may be reported:
  98 .Bl -diag
  99 .It "mk48txx_attach: battery low"
 100 The device signals that its battery is low and should be replaced.
 101 The
 102 .Nm
 103 driver refused to attach the device in this case as the time in the real time
 104 clock is probably invalid.
 105 This gives the generic clock code the chance to use another device as the
 106 system real time clock that otherwise would not have been chosen.
 107 .El
 108 .Sh SEE ALSO
 109 .Xr ebus 4 ,
 110 .Xr fhc 4 ,
 111 .Xr rtc 4 ,
 112 .Xr sbus 4 ,
 113 .Xr watchdog 4 ,
 114 .Xr watchdog 8 ,
 115 .Xr watchdogd 8
 116 .Sh HISTORY
 117 The
 118 .Nm
 119 driver first appeared in
 120 .Fx 5.0 .
 121 .Sh AUTHORS
 122 .An -nosplit
 123 The
 124 .Nm
 125 driver was written by
 126 .An "Thomas Moestl" Aq tmm@FreeBSD.org
 127 based on the
 128 .Nx
 129 sparc64 clock code written by
 130 .An "Paul Kranenburg" .