share/man/man4/man4.sparc64/ofw_console.4

   1 .\"-
   2 .\" Copyright (c) 2001 Miodrag Vallat.
   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. Redistribution 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 WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\"     from: OpenBSD: pcons.4,v 1.4 2003/06/02 16:16:26 miod Exp
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd June 18, 2005
  30 .Dt OFW_CONSOLE 4 sparc64
  31 .Os
  32 .Sh NAME
  33 .Nm ofw_console
  34 .Nd "Open Firmware console"
  35 .Sh SYNOPSIS
  36 .Cd "device ofw_console"
  37 .Cd "options OFWCONS_POLL_HZ=N"
  38 .Pp
  39 .Cd "options KDB"
  40 .Cd "options DDB"
  41 .Cd "options ALT_BREAK_TO_DEBUGGER"
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 driver provides a simple text console,
  46 using the Open Firmware services for input and output.
  47 It will use the Open Firmware console devices set via the
  48 .Va input-device
  49 and
  50 .Va output-device
  51 variables.
  52 .Pp
  53 This driver is deprecated and only provided as a fallback console mechanism
  54 if the real console hardware can not be driven by
  55 .Fx .
  56 .Pp
  57 In case the
  58 .Nm
  59 console appears to work too slowly, its responsiveness probably can be improved
  60 by including
  61 .Cd "options OFWCONS_POLL_HZ=N" .
  62 When omitted,
  63 .Dv OFWCONS_POLL_HZ
  64 defaults to 4.
  65 For example, on
  66 .Tn Sun Ultra 2
  67 a value of 20 or higher works best.
  68 Too high values, on the other hand, can cause
  69 .Nm
  70 to unnecessarily consume CPU.
  71 .Sh FILES
  72 .Bl -tag -width ".Pa /dev/keyboard" -compact
  73 .It Pa /dev/console
  74 .It Pa /dev/keyboard
  75 terminal input device in case the console input device is the keyboard
  76 .It Pa /dev/screen
  77 terminal output device in case the console output device is the screen
  78 .It Pa /dev/tty[a-z]
  79 terminal device in case both the console input and output device is tty[a-z]
  80 .El
  81 .Sh SEE ALSO
  82 .Xr creator 4 ,
  83 .Xr machfb 4 ,
  84 .Xr syscons 4 ,
  85 .Xr uart 4 ,
  86 .Xr eeprom 8
  87 .Sh HISTORY
  88 The
  89 .Nm
  90 driver first appeared in
  91 .Fx 5.0 .
  92 .Sh AUTHORS
  93 The
  94 .Nm
  95 driver was written by
  96 .An "Benno Rice" Aq benno@FreeBSD.org .
  97 .Sh CAVEATS
  98 Since the Open Firmware will handle BREAK
  99 (or Stop-A)
 100 sequences before
 101 .Nm ,
 102 the preferred way to enter
 103 .Xr ddb 4
 104 when using
 105 .Nm
 106 is to include
 107 .Cd "options ALT_BREAK_TO_DEBUGGER"
 108 in a ddb-enabled kernel, and enter the alternate BREAK sequence
 109 (RETURN TILDE CTRL-b).
 110 .Sh BUGS
 111 The
 112 .Nm
 113 driver
 114 is not a real
 115 .Xr tty 4
 116 driver and is not MPSAFE.
 117 The
 118 .Nm
 119 driver also does not attach to the hardware resources it actually talks to.
 120 Therefore it cannot be included in the kernel together with real console
 121 hardware drivers
 122 like
 123 .Xr creator 4 ,
 124 .Xr machfb 4
 125 and
 126 .Xr uart 4 .