Fujitsu DTV/STB solution driver (FAPex driver) Documentation [V01L00R00]


VIDEO OUTPUT Driver

Table of Contents

Introduction
Configuration

Public Interface

Driver Usage
Driver Relationship
References

Back to top

Introduction

This driver controls the Video Output block. The driver provides HD, SD scaler function and display function for OSD1, OSD2, Cursor Plane.

Back to top

Configuration

OSD memory configuration


The OSD1 and OSD2 plane are statically mapped to the area from FAPEX_SYS_MMAP_OSD_PLANE_START to (FAPEX_SYS_MMAP_OSD_PLANE_END - 1).
FAPEX_SYS_MMAP_OSD_PLANE_START and FAPEX_SYS_MMAP_OSD_PLANE_END are defined with the board configuration header file.

In case of Fujitsu MB86H61 Development Kit board, this board configuration header file is "${KERNEL_TOP}/drivers/media/fapex/wfe/include/fapex/sys_config_mb86h61_devkit.h", these are defined as follows.
    // uncashed heap memory's location and size.
    #define FAPEX_SYS_MMAP_UNCASHED_HEAP_START    0x21700000UL
    #define FAPEX_SYS_MMAP_UNCASHED_HEAP_SIZE     0x00100000UL // 1 MB
    
    // OSD/Cursor memory's location and size.
    #define FAPEX_SYS_MMAP_OSD_PLANE_START        0x21804000UL
    
    #define FAPEX_SYS_MMAP_OSD_PLANE_BYTES        0x006FC000UL // 6.99 MB
    #define FAPEX_SYS_MMAP_OSD_PLANE_END          0x21F00000UL

The method of area allocation for OSD1 and OSD2 is configurable. This is dependent on OSD1/OSD2 mapping configuration of "make menuconfig" as follows.

---- menu config
  Device Drivers  --->
    Multimedia devices  --->
     <M> Fujitsu DTV/STB solution
           Fujitsu DTV/STB extension module configuration  --->
             Fujitsu DTV/STB extension module functional configuration  --->
              <M> Function Driver of WFE : Video Output
              [ ]   OSD1/2 fixed mapping

In above case, OSD1 and OSD2 memory area are allocated flexibly within OSD's total memory size (FAPEX_SYS_MMAP_OSD_PLANE_BYTES).
If you want to lock the memory area size for both OSD1 and OSD2, you can setup with "make menuconfig" as follows.

---- menu config
  Device Drivers  --->
    Multimedia devices  --->
     <M> Fujitsu DTV/STB solution
           Fujitsu DTV/STB extension module configuration  --->
             Fujitsu DTV/STB extension module functional configuration  --->
              <M> Function Driver of WFE : Video Output
              [*]   OSD1/2 fixed mapping
              (0x00400000) OSD1 memory area max size

Cursor Plane memory configuration


The Cursor Plane is statically mapped to the area of FAPEX_SYS_MMAP_CURSOR_PLANE_BYTES bytes from FAPEX_SYS_MMAP_CURSOR_PLANE_START.
FAPEX_SYS_MMAP_CURSOR_PLANE_START and FAPEX_SYS_MMAP_CURSOR_PLANE_BYTES are defined with the board configuration header file.

In case of Fujitsu MB86H61 Development Kit board, this board configuration header file is "${KERNEL_TOP}/drivers/media/fapex/wfe/include/fapex/sys_config_mb86h61_devkit.h" and these are defined as follows.
    // uncashed heap memory's location and size.
    #define FAPEX_SYS_MMAP_UNCASHED_HEAP_START    0x21700000UL
    #define FAPEX_SYS_MMAP_UNCASHED_HEAP_SIZE     0x00100000UL // 1 MB
    
    // OSD/Cursor memory's location and size.
    #define FAPEX_SYS_MMAP_CURSOR_PLANE_START     0x21800000UL
    #define FAPEX_SYS_MMAP_CURSOR_PLANE_BYTES     0x00004000UL // 16 KB

Back to top

Public Interface

System Driver Interface

Driver initialization function

  • Linux:
    The VIDEO OUTPUT driver module is initialized by following command on target board.
     # modprobe fapex_fdlviout
  • RTOS:
    The VIDEO OUTPUT driver module is initialized by calling FAPEX_common_init().

Driver exit function

  • Linux:
    The VIDEO OUTPUT driver module is unregistered by following command on target board.
     # modprobe -rq fapex_fdlviout
  • RTOS:
    The VIDEO OUTPUT driver module is unregistered by calling FAPEX_common_exit().

Application Programming Interface

Functions and Macros

The driver provides the functions and macros listed below. For more information please follow the links to their detailed documentation.

Open Driver
FAPEX_VIOUT_Open()
Close Driver
FAPEX_VIOUT_Close()
I/O control of Driver
FAPEX_VIOUT_Ioctl()
Memory Mapping
FAPEX_VIOUT_Mmap()
FAPEX_VIOUT_Munmap()
Back to top

Driver Usage

The VIDEO OUTPUT module have the common descriptor and the sub descriptor.
The common descriptor is connected to functions of entire layer. The sub descriptor is connected to functions for each layer.
Please refer to following sequence diagram for the usage of this driver.

inline_dotgraph_19.dot
Back to top

Driver Relationship

The VIDEO OUTPUT driver is related with the following drivers:

Back to top

References

  • MB86H61 Device Manual
    Chapter 21.Video output (VO)


Copyright © 2006-2010 by Fujitsu Semiconductor Europe GmbH
Copyright © 2008-2010 by Fujitsu Semiconductor Limited

Disclaimer:
Please note that the use of this has been based on the terms and conditions of "DK Consent Letter (For Linux)" agreement between you and Fujitsu Semiconductor Limited.
The contents of this document may be revised without prior notice. Contact our sales department for confirmation. The information in this document are presented as is, no license is granted by implication or otherwise.
More...

FUJITSU sales representatives