share/man/man4/genfb.4

   1 .\"     $NetBSD: genfb.4,v 1.2 2007/12/02 19:03:16 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2007 Michael Lorenz
   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. The name of the author may not be used to endorse or promote products
  15 .\"    derived from this software without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  22 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  24 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .Dd August 23, 2009
  30 .Dt GENFB 4
  31 .Os
  32 .Sh NAME
  33 .Nm genfb
  34 .Nd generic framebuffer console driver
  35 .Sh SYNOPSIS
  36 .Cd "genfb* at pci?"
  37 .Cd "genfb* at sbus?"
  38 .Cd "wsdisplay* at genfb?"
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 driver provides support for generic framebuffers that have no native driver.
  43 All it needs are some parameters to describe the framebuffer and an address.
  44 .Ss PCI
  45 When attaching to a
  46 .Xr pci 4
  47 bus the driver is configured via device properties:
  48 .Bl -tag -width Dv
  49 .It Dv width Pq Li uint32
  50 Width in pixels.
  51 .It Dv height Pq Li uint32
  52 Height in pixels.
  53 .It Dv stride Pq Li uint32
  54 Line size in bytes.
  55 .It Dv depth Pq Li uint32
  56 Bits per pixel.
  57 .It Dv is_console Pq Li bool
  58 If true,
  59 .Nm
  60 will try to become the system console.
  61 .It Dv address Pq Li uint32
  62 Bus address of the framebuffer.
  63 .El
  64 .Ss SBus
  65 When attaching to
  66 .Xr sbus 4
  67 all those parameters are retrieved from the firmware.
  68 .Sh SEE ALSO
  69 .Xr pci 4 ,
  70 .Xr sbus 4 ,
  71 .Xr wscons 4 ,
  72 .Xr wsdisplay 4
  73 .Sh BUGS
  74 There is no way to change the color map even when the firmware supports it.
  75 The
  76 .Xr pci 4
  77 bus frontend has only been tested on macppc, i386, and amd64 and requires
  78 machine dependent code to pass the properties mentioned above.
  79 So far only macppc, i386, and amd64 provides them.