GM8126 SCALER FOR VIDEO GRAPHIC

Size: px

Start display at page:

Download "GM8126 SCALER FOR VIDEO GRAPHIC"

Randolph Underwood
6 years ago
Views:

1 GM8126 SCALER FOR VIDEO GRAPHIC User Guide Rev.: 1.0 Issue Date: December 2010

3 REVISION HISTORY GM8126 Scaler for Video Graph User Guide Date Rev. From To Dec Original Copyright 2010 Grain Media, Inc. All Rights Reserved. Printed in Taiwan 2010 Grain Media and the Grain Media Logo are trademarks of Grain Media, Inc. in Taiwan and/or other countries. Other company, product and service names may be trademarks or service marks of others. All information contained in this document is subject to change without notice. The products described in this document are NOT intended for use in implantation or other life support application where malfunction may result in injury or death to persons. The information contained in this document does not affect or change Grain Media s product specification or warranties. Nothing in this document shall operate as an express or implied license or indemnity under the intellectual property rights of Grain Media or third parties. All information contained in this document was obtained in specific environments, and is presented as an illustration. The results obtained in other operating environments may vary. THE INFORMATION CONTAINED IN THIS DOCUMENT IS PROVIDED ON AN AS IS BASIS. In no event will Grain Media be liable for damages arising directly or indirectly from any use of the information contained in this document. Grain Media, Inc. 5F, No. 5, Li-Hsin Road III, Hsinchu Science Park, Hsinchu City, Taiwan 300, R.O.C. Grain Media's home page can be found at:

5 TABLE OF CONTENTS Chapter 1 Introduction... 1 Chapter 2 Driver Configuration Config Config_ Makefile.rules... 5 Chapter 3 Driver Parameter for Video Graph Video Graph Parameters Driver Info Block Module Parameters Chapter 4 Scaler/Proc File System /proc/scaler Debug System i

7 Chapter 1 Introduction Scaler (SCAR) is in charge of resizing and enhancing the video data from ITU-R BT 656, memory, or output data to AMBA AHB. With the resizing ability, users can size-down or size-up an image to the necessary resolution or perform the aspect ratio conversion. The window clipping function can clip the interested region of an image before or after sizing down. Moreover, the luminance compensation, sharpness, and color saturation controls can help make the image more pleasing to the human eyes. Several kernel device drivers are necessary for the DVR system and each driver works independent without knowing each other. Take DVR system as example, the data flow path will be decoded, scalered, and finally displayed to TV. In this example, AP has the responsibility to cascade these drivers together to meet the target. Therefore, AP acquires the output data from the first stage, and then passes it to second stage, third stage, and so on. This method makes big overhead in the Linux system due to frequently context switch between the kernel space and user space and produces the performance limitations as well. A new method, Video Graph, is proposed to solve this kind of performance issues. Each module registers itself to Video Graph during its initialization and Video Graph will cascade these registered devices together in Linux kernel. This registered device is called Video Entity. In addition to these Video Entities, an important entity, DVR entity, is used to tell Video Graph who is the first stage, who is next one. Thus, Video 1

8 Graph receives the output data from the first video entity and automatically transfers to the second video entity, and so on. That is, the data never go to the user space anymore and significantly improves the performance. To support multiple channels in Video Graph, the scaler driver registers a video entity per channel in the beginning of the module insertion. After registration of the video entity, the upstream entity will transfer the video job to the scaler driver. Every work will be accepted, dropped, or rejected and return its status by calling the callback function of the video job. If job is accepted and done, it returns with JOB_STATUS_DONE. If job is rejected or failed, it returns with JOB_STATUS_FAIL. If job is dropped, it returns JOB_STATUS_DIABLE. Users can find fscaler_vg.c in /module/scaler_v3 for more details of the video graph interface of the scaler driver. To balance the performance of the scaler hardware, the scaler driver restores the jobs by channel and then dispatch jobs by the job timestamp and priority. The scaler device will be locked and process the dispatched job independently. For more details, please refer to fscaler_device.c. The channel FD number is an integer which consists of two parts, one is upper 16 bits part and the other one is lower 16 bits, shown as below: MAJOR 10 /* upper 16 bits */ MINOR (30<<8) channel /* lower 16 bits */ The scaler driver converts the FD number into a series numbers form 0 in the scaler driver internally. 2

9 Chapter 2 Driver Configuration This chapter contains the following sections: 2.1 Config 2.2 Config_ Makefile.rules 3

10 There are several definitions and configurations in the config, config_8126 as well as Makefile.rules. 2.1 Config This file includes common configurations for the scaler driver. 1. CONFIG_FSCDRV_DEBUG If CONFIG_FSCDRV_DEBUG=y, the FSCDRV_DEBUG and dbg_type scaler module parameter will both be 1, it turns on the debug message to console or video graph log dependent with supp_vg. If CONFIG_FSCDRV_DEBUG=n, there is no log output by the debug macros. 2. CONFIG_FSCDRV_KPI Support the KPI performance evaluation if CONFIG_FSCDRV_KPI=y. However, it is reserved for debug development. 2.2 Config_8126 This file includes the platform dependent configurations. 1. PLATFORM_OBJ Add the platform dependent object binary to the compile list. Different platform has different platform dependent binary. 2. CONFIG_FSCDRV_VG Set CONFIG_FSCDRV_VG=y to initialize supp_vg and define FSCDRV_VG to be 1. Scaler driver will install the video graph interface to support the register video entity to video graph. 3. CONFIG_FSCDRV_OSD Set CONFIG_FSCDRV_OSD=y to initialize supp_osd and define FSCDRV_OSD to be 1. Scaler driver will install the Scaler OSD interface to support the OSD functionality. 4. CONFIG_FSCDRV_IOCTL Set CONFIG_FSCDRV_IOCTL =y to initialize supp_io and define FSCDRV_IOCTL to be 1. Scaler driver will install the scaler I/O control interface defined in fscaler_api.h. However, in this version, the scaler driver has not implemented this interface yet. 4

11 5. CONFIG_FSCDRV_PROC Set CONFIG_FSCDRV_PROC =y to initialize supp_proc and define FSCDRV_PROC to be 1. The scaler driver will install the scaler proc interface to support the proc debug system. The reset options in config_8126 without descriptions are all hardware or driver limitation and parameters, which cannot be modified. 2.3 Makefile.rules This file includes the make rules dependent by other configurations. It also has some initial values of the module parameters. 1. FSCFD_MAX The default value of FSCFD_MAX is 512. It is the limitation of the maximum number of the scaler driver. It must be larger then FSCFD_INIT. 2. FSCFD_INIT The default value of FSCFD_INIT is 128 entities. It is also the default value of max_entity. It is the maximum number of the video entity registered in the scaler driver. It should be smaller then FSCFD_MAX. If the users application needs more than 128 entities in video graph, users should insert the scaler module with the max_entity value. If the max_entity value is large then FSCFD_MAX, users should recompile the scaler driver and modify the FSCFD_MAX definition. 3. FSCDRV_TIMEOUT Its default value is 40 milliseconds. It is also the default value of the timeout module parameter. It defines the timeout interval of the timeout handler timer. If the device does not response within this time interval, the timer will launch the timeout handler to reset the device and try to grab next job to proceed. 5

13 Chapter 3 Driver Parameter for Video Graph This chapter contains the following sections: 3.1 Video Graph Parameters 3.2 Driver Info Block 3.3 Module Parameters 7

14 3.1 Video Graph Parameters All the Video Graph parameters are listed in fscaler_property.c, Grain Media supports these property and uses query_propertyid and set_property to proceed the read/write. const char *FSCALER_PROPERTY_NAMES[] = { [ID_NULL] = "", [ID_JOBTYPE] = "job_type", [ID_UPSTREAM] = "upstream", [ID_DOWNSTREAM] = "downstream", [ID_RUN] = "run", [ID_DISABLE] = "disable_scale", [ID_ENABLE] = "enable_scale", [ID_SYNC_MODE] = "sync_mode", [ID_SNAPSHOT] = "snapshot", [ID_DES_AXIS_X] = "des_axis_x", [ID_DES_AXIS_Y] = "des_axis_y", [ID_DES_WIDTH] = "des_width", [ID_DES_HEIGHT] = "des_height", [ID_TARGET_WIDTH] = "target_width", [ID_TARGET_HEIGHT] = "target_height", [ID_CROP_AXIS_X] = "crop_axis_x", [ID_CROP_AXIS_Y] = "crop_axis_y", [ID_CROP_WIDTH] = "crop_width", [ID_CROP_HEIGHT] = "crop_height", [ID_BUF_OFFSET] = "buf_offset", [ID_SRC_WIDTH] = "src_width", [ID_SRC_HEIGHT] = "src_height", [ID_VP_WIDTH] = "vp_width", [ID_VP_HEIGHT] = "vp_height", [ID_SWC_AXIS_X] = "swc_axis_x", [ID_SWC_AXIS_Y] = "swc_axis_y", [ID_SWC_WIDTH] = "swc_width", 8

15 [ID_SWC_HEIGHT] = "swc_height", [ID_DES_FMT] = "des_fmt", [ID_DES_SWAP_CBCR] = "des_swap_cbcr", [ID_DES_ORDER] = "des_order", [ID_DES_LEVEL] = "des_level", [ID_DES_SWAP_Y] = "des_swap_y", [ID_SRC_FMT] = "src_fmt", [ID_MEM_SRC_PIT] = "mem_src_pit", [ID_SRC_HBLANK] = "src_hblank", [ID_SRC_INTERLEAVED] = "src_interleaved", [ID_SRC_SWAP_CBCR] = "src_swap_cbcr", [ID_SRC_SWAP_Y] = "src_swap_y", [ID_ALBUM] = "album", [ID_NON_LINEAR] = "non_linear", [ID_DITHER] = "dither", [ID_US_EN] = "us_en", [ID_CORRECTION] = "correction", [ID_DES_AXIS_X_2] = "des_second_axis_x", [ID_DES_AXIS_Y_2] = "des_second_axis_y", [ID_SWC_WIDTH_2] = "swc_second_width", [ID_SWC_HEIGHT_2] = "swc_second_height", [ID_SWC_AXIS_X_2] = "swc_second_axis_x", [ID_SWC_AXIS_Y_2] = "swc_second_axis_y", [ID_TARGET_WIDTH_2] = "target_second_width", [ID_TARGET_HEIGHT_2] = "target_second_height", [ID_CROP_WIDTH_2] = "crop_second_width", [ID_CROP_HEIGHT_2] = "crop_second_height", [ID_CROP_AXIS_X_2] = "crop_second_axis_x", [ID_CROP_AXIS_Y_2] = "crop_second_axis_y", [ID_TWICE_EN] = "twice_enable", [ID_SWAP] = "swap", [ID_VP_WIDTH_2] = "vp_second_width", 9

16 }; [ID_VP_HEIGHT_2] = "vp_second_height", [ID_MEM_SRC_PIT_2] = "mem_src_second_pit", Samples: id = query_propertyid(entity_scaler1_fd, "des_axis_x"); set_property(entity_scaler1_fd,id,width,1); Please refer to Table 1-1 for the data structure of the scaler initialization. Table 1-1. Function Data Structure of Scaler Initialization README run Reserved disable_scale For performance issue only If users do not want to run scaler, please activate this function. enable_scale For performance issue only If users want to run the scaler again, please activate this function. des_axis_x Locate the X coordinate of the output frame on the frame buffer des_axis_y Locate the Y coordinate of the output frame on the frame buffer vp_width Keep the video port width vp_height Keep the video port height swc_width Keep the active frame width in vp_width, must be the multiples of 4 swc_height Keep the active frame height in vp_height, must be the multiples of 2 swc_axis_x Locate the X coordinate of the active frame on the video port, must be the multiples of 2 swc_axis_y Locate the Y coordinate of the active frame on the video port, must be the multiples of 2 target_width Keep the target frame width target_height Keep the target frame height crop_width Keep the crop width in the target frame, must be the multiples of 4 crop_height Keep the crop height in the target frame, must be the multiples of 2 crop_axis_x Locate the coordinate X of the crop frame on the target frame crop_axis_y Locate the coordinate Y of the crop frame on the target frame des_width Keep the destination memory width 10

17 Function des_height des_fmt des_level des_swap_cbcr des_swap_y src_width src_height src_fmt src_interleaved src_swap_y src_hblank README Keep the destination memory height Target format selection 0: RGB888 1: RGB565 2: H.2644 YCbCr420 mode0 3: H.2644 YCbCr420 mode1 4:YCbCr444 5: YCbCr422 6: MP4 YCbCr420 mode0 7: MP4 YCbCr420 mode1 Keep the data range 0: From 0 to 256 1: From 0 to 240 Keep the CrCb/RB order in the target frame 0: CrCb/RB 1: CbCr/BR Keep the YCbCr/RGB order in the target frame 0: CbYCr/CrYCb or RBG/BRG 1: YCbCr/YCrCb or GRB/GBR Keep the source memory width in memory-to-memory Keep the source memory height in memory-to-memory Keep the source memory format 0 ~ 3: Reserved 4: 444 5: 422 Keep the source memory interlace format 0: For interleaved 1: For non-interleave Used to keep the YCbCr/RGB order in the target frame 0: CbYCr/CrYCb or RBG/BRG 1: YCbCr/YCrCb or GRB/GBR Use to keep the pixel number of the horizontal line blank for the source memory 11

18 Function des_order us_en non_linear dither correction album mem_src_pit snapshot buf_offset src_swap_cbcr twice_enable des_second_axis_x des_second_axis_y README Data organization 0: Sequential order 1: 4 x 4 macro block order 2: 8 x 8 macro block order 3: 16 x 16 macro block order Enable the CbCr up-sampling algorithm 0: Duplicate 1: Up-sampling Keep the scale method 0: Linear scale 1: Non-linear scale Keep the dither function enabled/disabled 0: Disable 1: Enable Keep the affection of contrast to the saturation of the IE mode enabled/disabled 0: Disable 1: Enable Keep the album function enabled/disabled 0: Disable 1: Enable For C version chip later Set the source image pitch when the capture album mode is enabled. Set the snapshot run-n frames The offset of the output buffer Keep the CrCb/RB order in the target frame 0: CrCb/RB 1: CbCr/BR Enable the top/bottom composite case In this case, scaler merge top and bottom buffers into a special image format for the 3DI entity Locate the X coordinate of the output frame on the frame buffer For the second buffer of the top/bottom composite case Locate the Y coordinate of the output frame on the frame buffer For the second buffer of the top/bottom composite case 12

19 Function README vp_second_width Keep the video port width For the second buffer of the top/bottom composite case vp_second_height Keep the video port height For the second buffer of the top/bottom composite case swc_second_axis_x Locate the X coordinate of the active frame on the video port, must be the multiples of 2 For the second buffer of the top/bottom composite case swc_second_axis_y Locate the Y coordinate of the active frame on the video port, must be the multiples of 2 For the second buffer of the top/bottom composite case swc_second_width Keep the active frame width in vp_width, must be the multiples of 4 For the second buffer of the top/bottom composite case swc_second_height Keep the active frame width in vp_height, must be the multiples of 2 For the second buffer of the top/bottom composite case. target_second_width Keep the target frame width For the second buffer of the top/bottom composite case target_second_height Keep the target frame height For the second buffer of the top/bottom composite case crop_second_axis_x Locate the coordinate X of the crop frame on the target frame For the second buffer of the top/bottom composite case crop_second_axis_y Locate the coordinate Y of the crop frame on the target frame For the second buffer of the top/bottom composite case. crop_second_width Keep the crop width in the target frame, must be the multiples of 4 For the second buffer of the top/bottom composite case crop_second_height Keep the crop height in the target frame, must be the multiples of 2 For the second buffer of the top/bottom composite case mem_second_src_pit For C version chip later Set the source image pitch when the capture album mode is enabled. For the second buffer of the top/bottom composite case job_type Reserved for the internal job type 0: Normal 1-to-1 scaler case 1: Top/Bottom composite image case 2: Pass job: Directly pass to downstream 3: Reject job: Reject and do not pass to downstream 4: Drop job: Drop to Video Graph upstream Specify the upstream entity 13

20 Function downstream sync_mode swap README Specify the downstream entity Enable the synchronous disable mode with the swap event Disable the display when receiving the swap job Reserved for the internal swap event Source image setting 14

Target image setting Function note of output 2D U/V address is used to calculate the des_width and des_hight values by driver, AP does not need to assign the driver U/V register value.

21 Target image setting Function note of output 2D U/V address is used to calculate the des_width and des_hight values by driver, AP does not need to assign the driver U/V register value. Function notes of SNAPSHOT 1. ID_SNAPSHOT: Set value N => trigger N times, N >= 0 and <= 32767, if N = -1, always trigger 2. Set ID_SNAPSHOT and then set ID_ENABLE => Trigger N times then disable 3. Set ID_SNAPSHOT and then set ID_DISABLE => Disable trigger 4. ID_SNAPSHOT, ID_ENABLE, and ID_DISABLE are not be set => Always triggered 5. After runingn the snapshot N times then want to return always trigger => Set ID_SNAPSHOT = -1 and set ID_ENABLE 15

22 3.2 Driver Info Block Driver Info Block can be defined by each video entity. Currently, the scaler entity only identifies Drive Info Block provided by the decoder entity. Scaler parses this decoder header to decide the job type if the upstream type is specified as the decoder entity. typedef struct { unsigned int EncoderOutTag; unsigned int BitstreamOffset; unsigned int BitstreamSize; unsigned int MbInfoOffset; unsigned int MbInfoLength; unsigned int Keyframe; unsigned int Reserved1; unsigned int Reserved2; } EncoderOut_info; 3.3 Module Parameters The module parameters of the scaler device driver are listed below. extern int dbg_type Set dbg_type=1 to turn on the debug messages. In the Video Graph interface, the debug message will be printed with the Video Graph log. If users want to dump this message, please refer to the Video Graph User Guide. Its default value is defined in config, CONFIG_FSCDRV_DEBUG=n (FSCDRV_DEBUG=0). extern int supp_proc Set supp_proc to 1 to install the scaler/proc interface. Its default value is defined in config_8126, CONFIG_FSCDRV_PROC=y (FSCDRV_PROC=1). It provides the proc system under the /proc/scaler directory.there are four entities under /proc/scaler. 16

23 extern int supp_kpi Set supp_kpi=1 to turn on the scaler performance evaluation. Its default value is defined in config, CONFIG_FSCDRV_KPI=n (FSCDRV_KPI=0). Currently, Grain Media does not support such information for users. It is reserved for the driver developer. extern int supp_vg Set supp_vg=1 to install the scaler video graph interface. Its default value is defined in config_8126, CONFIG_FSCDRV_VG=y (FSCDRV_VG=1). extern int supp_io Set supp_io=1 to install the scaler old-style I/O control interface. Its default value is defined in config_8126, CONFIG_FSCDRV_VG=n (FSCDRV_IOCTL=0). Currently, Grain Media does not support the old-style IOCTL interface for this scaler device driver. It is reserved for implementation in the future. extern int supp_osd Set supp_osd=1 to install the scaler OSD interface. Its default value is defined in config_8126, CONFIG_FSCDRV_OSD=y (FSCDRV_OSD=1). The OSD interface is an I/O control interface to output the simple OSD string on the specified buffer. extern unsigned int timeout Set the timeout value to specify the time interval of the scaler timeout timer in micro seconds. Its default value is defined in Makefile.rules, FSCDRV_TIMEOUT=40. The scaler timeout timer will reboot scaler and try to process next job if the hardware procudure time is overhead. extern unsigned int max_width Set max_width to limit the maxinum width of the source buffer. The defualt value is defined in Makefile.rules, FSCDRV_MAX_WIDTH=720. extern unsigned int max_height Set max_height to limit the maxinum height of the source buffer. The defualt value is defined in Makefile.rules, FSCDRV_MAX_HEIGHT=

24 extern unsigned int max_entity Set max_entity to register the maxinum number of entities for users. The defualt value is defined in Makefile.rules, FSCFD_INIT=128. It is limited by FSCFD_MAX=512. extern unsigned int max_device Set max_device to register the maxinum number of device for users. In this platform, the value should be 1 for having only one scaler IP. The defualt value is defined in config, FSCIP_INIT=1. It is limited by FSCIP_MAX=1. If users want to know more details about how to configure compile options of the scaler device drvier, please refer to config, config_8126,and Makefile.rules. 18

25 Chapter 4 Scaler/Proc File System This chapter contains the following section: 4.1 /proc/scaler Debug System 19

26 Scaler provides the /proc/scaler entry for debugging. If users want to support the proc interface of the scaler driver, please set the module parameter supp_proc=1. There are five entries in the /proc/scaler, please refer to Section 4.1 for details. 4.1 /proc/scaler Debug System If the module parameter, supp_proc, is set, the proc interface will be installed in the scaler driver. It creates some entries under the /proc/scaler directory as listed as below. /proc/scaler/device To dump the N device status and information: >> echo N > /proc/scaler/device >> cat /proc/scaler/device Grain Mdeia can only support one scaler hardware in the platform, N is always 0. /proc/scaler/grabjob/devid To find out all jobs handled by device N: >> echo N > /proc/scaler/grabjob/devid >> cat /proc/scaler/grabjob/devid /proc/scaler/grabjob/devid To find out all jobs belong to channel N: >> echo N > /proc/scaler/grabjob/fd >> cat /proc/scaler/grabjob/fd It also dumps the float» jobs in the scaler driver. /proc/scaler/property To dump the property used by channel N, >> echo N > /proc/scaler/property >> cat /proc/scaler/property /proc/scaler/dumpreg To dump every scaler device register address, >> cat /proc/scaler/dumpreg 20

GM8126 GM8126 CAPTURE. User Guide Rev.: 1.2 Issue Date: June 2011

GM8126 GM8126 CAPTURE. User Guide Rev.: 1.2 Issue Date: June 2011 GM8126 GM8126 CAPTURE User Guide Rev.: 1.2 Issue Date: June 2011 REVISION HISTORY Date Rev. From To Nov. 2010 1.0 - Original Jan. 2011 1.1 - Updated the module parameters in Chapter 3 Jun. 2011 1.2 -