readme.mambolfb

SigmDesign SMP8634 media decode chip development SDK

EM86XX OSD / LINUX FRAME BUFFER
===============================

1 Purpose
=========

This README describes how to setup the linux frame buffer for EM86xx with 2.4
Linux kernels. For 2.6 kernels, please consult
                       rua/emhwlib_kernel/kernel_src/README.fb

You should have built and insmoded mum (or llad for standalone)  and em8xxx
(see the corresponding README). To build the EM86xx linux frame buffer driver,
in mambolfb folder, type "make", this should build the mambolfb.o object file.


2 Linux frame buffer setup
==========================

 2.1 Host
 --------

 Before using the frame buffer, setup /boot/grub/grub.conf file or menu.lst
 (lilo config file if you use lilo boot loader). Add the vga=773 parameter:
 kernel /vmlinuz-2.4.22-1.2115.nptl ro root=LABEL=/ vga=773.
 
 If your kernel doesn't have its console on a frame buffer, then once you
 insmod the mambolfb module, you won't be able to remove it because the
 framebuffer takes over all the console not already owned by a frame buffer by
 default.


 2.2 Standalone
 --------------

 If you are working on a standalone system, you need to make sure that you have
 enabled the frame buffer support in your kernel (make linuxconfig or make
 menuconfig).
 
 There are two ways to setup the frame buffer :

    * The first one is to insmod the frame buffer kernel module directly with
      the right parameters. 

	$#Create a 640x480 32bpp with key color OSD buffer
        $./osdbuf_control -c -Ftck:16bpp_565
        $#Get the parameters to insert the mambolfb module (use them in the insmod below)
        $./osdbuf_control -p
        $#This command returns OSD parameters suitable for mambolfb. Then, compile the
        $#mambolfb module, probe for fbcon and run insmod mambolfb.o with the parameters
        $cd ../MRUA_src/mambolfb/
        $make
        $#Optional
        $modprobe fbcon-mfb
        $insmod mambolfb.o videomemory=0x10000040 videomemorysize=614400 palette=0x79000 mode=640:480:16
	$#Test
	$./fb_test /dev/fb/0

    * The second one, easier, it just to insmod the mambolfb.o module, and then
      use the osdbuf_control application to bind or unbind an OSD buffer to
      this frame buffer :

	$cd MRUA_src/samples/
        $insmod ../mambolfb/mambolfb.o
	$#Should have created /dev/fb/0 check kernel console (dmesg)
	$#Now, create an OSD buffer and binds it to the FB
	$./osdbuf_control -c -Ftck:16bpp_565 -x /dev/fb/0
	$#Test
	$./fb_test /dev/fb/0
	$#Use a new OSD buffer 
	$./osdbuf_control -c1024x768 -Ftck:16bpp_565 -x /dev/fb/0
	$#Test
	$./fb_test /dev/fb/0
	$#Unbind the current OSD buffer
	$./osdbuf_control -X /dev/fb/0
	
 Then, you can use the frame buffer as any linux frame buffer device. Any
 program running with sufficient permission can mmap the fb device, and then
 access the video memory directly.


3 osdbuf_control utility
========================

You can control OSD buffers with osdbuf_control. This program will allow you to
configure, create, delete or simply get informations on currently registered
OSD buffer. Start the program without parameters to get the full list of
command line options :

       Usage :
               ./osdbuf_control [DISPLAY OPTIONS] -c[withxheigt] [-F <format:subformat>]
                       to create an OSD buffer
               ./osdbuf_control -p
                       to print parameters suitable for mambolfb
               ./osdbuf_control -d
                       to delete current OSD buffer
               ./osdbuf_control -i
                       to get full info on current OSD buffer
               ./osdbuf_control -x <fb device>
                       to bind the current OSD buffer to a frame buffer device
               ./osdbuf_control -X <fb device>
                       to unbind the current OSD buffer from a frame buffer device
               ./osdbuf_control [-k <r,g,b:range>] [-e <0|1>] [-t <2|4>] [-l <c:a>] 
                       [-0 <level>] [-1 <level>] [-z <x,y>] [-a <0|1>] [-O <0|1>]
                       [-C <csc>]
                       to tune the OSD buffer
       
       DISPLAY OPTIONS (default values inside brackets)
               -f standard: Sets output format, default is NTSC_M
                       CVT_640x480x50 CVT_640x480x60 CVT_640x480x75 CVT_640x480x85 CVT_800x600x50 
                       CVT_800x600x60 CVT_800x600x75 CVT_800x600x85 CVT_1024x768x50 CVT_1024x768x60 
                       CVT_1024x768x75 CVT_1024x768x85 CVT_1152x864x50 CVT_1152x864x60 CVT_1152x864x75 
                       CVT_1152x864x85 CVT_1280x960x50 CVT_1280x960x60 CVT_1280x960x75 CVT_1280x960x85 
                       CVT_1280x1024x50 CVT_1280x1024x60 CVT_1280x1024x75 CVT_1280x1024x85 CVT_1600x1200x50 
                       CVT_1600x1200x60 SYABAS_848x480x60 DBL3_1952x1232 DBL3_1952x30 HDMI_640x480p59 
                       HDMI_640x480p60 HDMI_480p59 HDMI_480p60 HDMI_720p59 HDMI_720p60 
                       HDMI_1080i59 HDMI_1080i60 HDMI_480i59 HDMI_480i60 HDMI_720x240p59 
                       HDMI_720x240p60 HDMI_2880x480i59 HDMI_2880x480i60 HDMI_2880x240p59 HDMI_2880x240p60 
                       HDMI_1440x480p59 HDMI_1440x480p60 HDMI_1080p59 HDMI_1080p60 HDMI_576p50 
                       HDMI_720p50 HDMI_1080i50 HDMI_576i50 HDMI_720x288p50 HDMI_2880x576i50 
                       HDMI_2880x288p50 HDMI_1440x576p50 HDMI_1080p50 HDMI_1080p23 HDMI_1080p24 
                       HDMI_1080p25 HDMI_1080p29 HDMI_1080p30 1080p60 1080p59 
                       1080p50 1080i60 1080i59 1080i50 1080i48 
                       1080i47 1080p30 1080p29 1080p25 1080p24 
                       1080p23 1080i50_1250 1080p50_1250 720p60 720p59 
                       720p50 720p30 720p29 720p25 720p24 
                       720p23 NTSC_M_Japan NTSC_M PAL_60 PAL_M 
                       480p59 NTSC_M_Japan_714 NTSC_M_714 PAL_60_714 PAL_M_714 
                       480p59_714 PAL_BG 576p50 PAL_BG_702 576p50_702 
                       VESA_640x350x85 VESA_640x400x85 VESA_720x400x85 VESA_640x480x60 VESA_640x480x72 
                       VESA_640x480x75 VESA_640x480x85 VESA_848x480x60 VESA_800x600x56 VESA_800x600x60 
                       VESA_800x600x72 VESA_800x600x75 VESA_800x600x85 VESA_1024x768x43 SYABAS_852x480x60 
                       VESA_1024x768x60 VESA_1024x768x70 VESA_1024x768x75 VESA_1024x768x85 VESA_1152x864x75 
                       VESA_1280x768x60RB VESA_1280x768x60 VESA_1280x768x75 VESA_1280x768x85 VESA_1280x960x60 
                       VESA_1280x960x85 VESA_1280x1024x60 VESA_1280x1024x75 VESA_1280x1024x85 VESA_1360x768x60 
                       VESA_1400x1050x60RB VESA_1400x1050x60 VESA_1400x1050x75 VESA_1400x1050x85 VESA_1600x1200x60 
                       VESA_1920x1200x60RB VESA_1920x1200x60 VESA_640x480i30 VESA_640x480i60 Apple_LCD_23_1920x1200x5994 
                       Samsung_S50HWXD01_1366x768x50 Samsung_S50HWXD01_1366x768x5994 Samsung_S50HWXD01_1366x768x60 Samsung_S50HWXD02_1366x768x50 Samsung_S50HWXD02_1366x768x5994 
                       Samsung_S50HWXD02_1366x768x60 Samsung_S50HWXD03_1366x768x50 Samsung_S50HWXD03_1366x768x5994 Samsung_S50HWXD03_1366x768x60 Samsung_S42AXXD02_1024x768x50 
                       Samsung_S42AXXD02_1024x768x5994 Samsung_S42AXXD02_1024x768x60 Samsung_S42SDYD04_852x480x50 Samsung_S42SDYD04_852x480x5994 Samsung_S42SDYD04_852x480x60 
                       Samsung_LTP400WQF01_480x272x5994 ChiMei_V296W1L01_1280x768x5994 ChiMei_V296W1L01_1280x768x60 ChiMei_V270W1L03_1280x720x5994 ChiMei_V270W1L03_1280x720x60 
                       1280x768x60 LG_LC150X02_1024x768x50 LG_LC150X02_1024x768x5994 LG_LC150X02_1024x768x60 LG_LC150X02_1024x768x50L 
                       LG_LC150X02_1024x768x60L LG_LC150X02_1024x768x5994H LG_LC150X02_1024x768x60H LG_LC260W01_1280x768x60 LG_LCxx0W01_1366x768x60 
                       Fujitsu_Plasma_42_1024x1024xi50 Fujitsu_Plasma_42_1024x1024xi52 Fujitsu_Plasma_42_1024x1024xi5994 Fujitsu_Plasma_42_1024x1024xi60 Fujitsu_Plasma_42_1024x1024xi70 
                       Casio_COM35H3125_320x240x50 Casio_COM35H3125_320x240x5994 Casio_COM35H3125_320x240x60 Casio_COM35H3125_320x240x70 InnoluxAT102TN01_800x480x60 
                       AUOptronicsB104SN02_800x600x60 eLCOS_1920x1080x60 eLCOS_1920x1080x5994 Chunghwa_CLAA070VA01_800x480x60 Chunghwa_CLAA070VA01_800x480x5994 
                       Chunghwa_CLAA070VA01_800x480x50 720x480x60 
                       edid (to use preferred standard from EDID info)
               -vgaf standard: sets output format for VGA/DVI output separately fom analog out
               -cs colorspace: Sets the output colorspace. [yuv_601] yuv_709 rgb_0_255 rgb_16_235
               -sm mode : Sets display scaling mode [letterBox] panScan
               -asp x y: Sets display aspect ratio  (x y in [0-255] range) [4 3]
                       (0 0 means that the source aspect ratio is used for the display aspect ratio (used with WSS).
               -zoom x y w h: Selects the input window to display [0 0 width height] 
               -o output: Selects the output
                       [svideo] composite dvi_8 dvi_16 dvi_24 lvds dig_8 dig_16 dig_24 vga scart
                       component_rgb_scart component_rgb_sog component_rgb_smpte
                       component_yuv_betacam component_yuv_m2 component_yuv_smpte
               -dvi_hdmi [siI164] siI170 siI9030 - Selects supported DVI/HDMI chip
               -hdcp - Enable HDCP (only valid on siI170 and siI9030 DVI chip)
               -edid - Display EDID information of the TV/Monitor
               -ed n: use EDID short descriptor number 'n' instead of detailed descriptor with '-f edid'
               -agc level: Sets the macrovision level [0] 1 2 3
               -cgmsa level: Sets the cgms level [0] 1 2 3
               -b osd_bitmap_filename: Displays an OSD bitmap at the same time
               -vgab osd_bitmap_filename: Displays an OSD bitmap on the seconday output (VGA)
               -vgadram: put secondary output bitmap into second DRAM bank
               -oa osd_alpha_level (0..255) [128]
               -ozoom x y w h: Selects the osd input window to display [0 0 width height] 
               -owindow x y w h: Selects the osd output window to display [0 0 width height] 
               -odump <directory>: dumps bitmap.bin, dvi.bin and userpref.bin in the specified directory.
               -oscaler scaler_index: Selects the scaler to use to display the osd image [0] (OSDScaler), 1 (GFXScaler), 2 (MainVideoScaler)
               -hwc: Displays Sigma logo using the hardware cursor
               -swap order: swaps the output's color component order [rgb] rbg grb gbr brg bgr
               -fs type: Selects the field selection algorithm
                       [type] : to select the input field ID that matches the output field ID
                       time: to select the input field the most time accurate
                       one: to select only one field per frame
               -strips h v : Sets display horizontal and vertical black strip mode (h v in [0-4096] range) [4096 4096]
               -nonlin w l: select non-linear scaling width (0..3) and level (0..3) [0 0]
                       Note: also specify '-strips 4096 0' or -nonlin will have no visible effect!
               -D mode: selects the deinterlacing mode
                       0: Bob - no deinterlacing
                       1: modulated Weave
                       2: motion adaptative
                       3: Weave
               -disp_init: force reinitialisation of the display
               -cdb <boundary>: sets the color degradation boundary (0..512) [0]
               -dp <protocol>: sets the protocol on the digital output (601, 656, vip) [601]
               -dclk: don't invert the digital video clock (inverted by default)
               -scart_en <0|1> <pio>: disable/standby (0) or enable (1) the SCART display. pio is optional, defaults to 13.
               -scart_ws <0|1> <pio>: signal 4:3 (0) or 16:9 (1) aspect ratio to the SCART connector. pio is optional, defaults to 14.
       
       OSD specific options :
               -0 set alpha0 level
               -1 set alpha1 level
               -a enable/disable fading
               -m chip number
               -e activate direction estimation in adaptive scaler
               -d delete current OSD buffer
               -i get complete info on current buffer
               -k set the key color to (r,g,b) with given range (0->15).
                  Matching range for each component : [keycolor, keycolor + 2 ^ range [
               -l set anti flicker level for color and alpha (color:alpha)
                  0 (no filtering) -> 3 (strong filtering)
               -c create a new OSD buffer of size widhtxheight (640x480 by default)
               -p get OSD parameters suitable for mambolfb
               -t set the number of taps used by adaptive scaler
               -O enable/disable the OSD channel
               -F color mode : color format to use (default tc:32bpp) 
                  color modes (for lut or tc selection) :
                       lut1bpp      - clut with 1bpp
                       lut2bpp      - clut with 2bpp
                       lut4bpp      - clut with 4bpp
                       lut8bpp      - clut with 8bpp
                       tc           - true color
                       tck          - true color with alpha key
                  color formats (for pixel or lut format selection) :
                       24bpp_565    - 24 bpp 5:6:5 (alpha0)
                       24bpp        - 24 bpp 8:8:8 (alpha0)
                       32bpp_4444   - 32 bpp 4:4:4:4
                       32bpp        - 32 bpp 8:8:8:8