readme.fb

Sigma SMP8634 Mrua v. 2.8.2.0

Linux 2.6 frame buffer driver
=============================

This file describe how to use the frame buffer driver for Sigma Designs' 86xx
chips. Noth that this framebuffer is for Linux kernels >= 2.6.15.1 only. 

1. Compilation
==============

Nothing special is required. Default compilation produces a em8xxxfb.ko file
which is the frame buffer kernel module driver.


2. Usage
========

2.1 Kernel configuration
------------------------
Be sure your kernel is configured for frame buffer utilisation.

Example:
CONFIG_FB=y
CONFIG_FB_CFB_FILLRECT=y
CONFIG_FB_CFB_COPYAREA=y
CONFIG_FB_CFB_IMAGEBLIT=y
CONFIG_FRAMEBUFFER_CONSOLE=y

You can use modules if you prefer.


2.2 Kernel module usage
-----------------------
First, you need to create an OSD buffer, using the osdbuf_control sample
application for instance.

Example:
 $ samples/osdbuf_control -c1024x768 -Ftc:32bpp

The application gives some information on the OSD buffer on a single line
starting with `videomemory'. You can copy and paste this line for the parameters
needed by the kernel module:

Example:
 $ insmod rua/emhwlib_kernel/kernel_set em8xxxfb.ko videomemory=0x...
videomemorysize=... palette=0x... mode=...

You can test the framebuffer using the fb_test sample application.

Example:
 $ samples/fb_test /dev/fb1


2.3 Making X run on top of the frame buffer
-------------------------------------------
Tell X you want to use the `fbdev' driver in xorg.conf.
You can use the provided xorg.conf as an example.

Example:
 $ Xorg -config xorg.conf

2.4 Using the frame buffer console
----------------------------------
Insert the fbcon module if necessary. Be sue you created the OSD buffer in LUT
mode (see the -F option). Then use samples/sendconsoletoframebuffer.

Example (to redirect /dev/tty5 to /dev/fb1):
 $ modprobe fbcon
 $ ./osdbuf_control -c -Flut8bpp:32bpp
 $ insmod rua/emhwlib_kernel/kernel_set em8xxxfb.ko videomemory=0x...
videomemorysize=... palette=0x... mode=...
 $ samples/sendconsoletoframebuffer 5 /dev/fb1