embeddedsw/XilinxProcessorIPLib/drivers/dual_splitter/examples/xdualsplitter_example.c

/******************************************************************************
*
* Copyright (C) 2014 - 2015 Xilinx, Inc.  All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* Use of the Software is limited solely to applications:
* (a) running on a Xilinx device, or
* (b) that interact with a Xilinx device through a bus or interconnect.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* XILINX BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
* OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* Except as contained in this notice, the name of the Xilinx shall not be used
* in advertising or otherwise to promote the sale, use or other dealings in
* this Software without prior written authorization from Xilinx.
*
******************************************************************************/
/*****************************************************************************/
/**
*
* @file xdualsplitter_example.c
*
* This file contains an example of how to use the Dual Splitter driver.
*
* @note		None.
*
* <pre>
* MODIFICATION HISTORY:
*
* Ver   Who Date     Changes
* ----- --- -------- --------------------------------------------------
* 1.00  sha 08/05/14 Initial release.
* </pre>
*
******************************************************************************/

/***************************** Include Files *********************************/

#include "xparameters.h"
#include "xdualsplitter.h"
#include "xil_printf.h"

/************************** Constant Definitions *****************************/


/**
* The following constants map to the XPAR parameters created in the
* xparameters.h file. They are defined here such that a user can easily
* change all the needed parameters in one place.
*/
#define XDUALSPLITTER_DEVICE_ID		XPAR_DUALSPLITTER_0_DEVICE_ID

/**************************** Type Definitions *******************************/


/***************** Macros (Inline Functions) Definitions *********************/


/************************** Function Prototypes ******************************/

int XDualSplitterExample(u16 DeviceId);

/************************** Variable Definitions *****************************/

XDualSplitter DualSplitterInst;	/**< Instance of the Dual Splitter core */

/*****************************************************************************/
/**
*
* This is the main function for Dual Splitter example.
*
* @param	None.
*
* @return
*		- XST_SUCCESS if Dual Splitter example ran successfully.
*		- XST_FAILURE if Dual Splitter example failed.
*
* @note		None
*
******************************************************************************/
int main(void)
{
	int Status;

	/* Run Dual Splitter example */
	Status = XDualSplitterExample(XDUALSPLITTER_DEVICE_ID);
	if (Status != XST_SUCCESS) {
		xil_printf("Dual Splitter driver example failed.\r\n");
		return XST_FAILURE;
	}

	xil_printf("Dual Splitter driver example ran successfully.\r\n");

	return XST_SUCCESS;
}

/*****************************************************************************/
/**
*
* This function demonstrates the use of Dual Splitter driver functions.
*
* @param	DeviceId is the unique device ID of the Dual Splitter core.
*
* @return
*		- XST_SUCCESS if Dual Splitter example ran successfully.
*		- XST_FAILURE if Dual Splitter example failed.
*
* @note		None.
*
******************************************************************************/
int XDualSplitterExample(u16 DeviceId)
{
	int Status;
	u16 Height;
	u16 Width;
	u8 InputSamples ;
	u8 OutputSamples;
	u8 ImageSegments;
	u8 Overlap = 0;
	XDualSplitter_Config *Config;

	/* Initialize the Dual Splitter driver so that it's ready to use
	 * look up the configuration in the config table, then initialize it.
	 */
	Config = XDualSplitter_LookupConfig(DeviceId);
	if (NULL == Config) {
		return XST_FAILURE;
	}

	Status = XDualSplitter_CfgInitialize(&DualSplitterInst, Config,
						Config->BaseAddress);
	if (Status != XST_SUCCESS) {
		return XST_FAILURE;
	}

	/* Enable the Dual Splitter core */
	XDualSplitter_Enable(&DualSplitterInst);

	/* Disable the register update, program all other registers and at
	 * the end of programming enable register update.
	 */
	XDualSplitter_RegUpdateDisable(&DualSplitterInst);

	/* Set image size width x height */
	Width = 1920;
	Height = 2160;
	XDualSplitter_SetImageSize(&DualSplitterInst, Height, Width);

	/* UHD2@60:
	 *	MST - 4 Streams: InputSamples per clock = 4
	 *			 OutputSamples per clock = 4
	 *			 Number of segments = 4
	 *	MST - 2 Streams: InputSamples per clock = 4
	 *			 OutPutSamples per clock = 4
	 *			 Number of segments = 2
	 * UHD@60:
	 *	SST :	InputSamples per clock = 4
	 *		OutputSamples per clock = 4
	 *		Number of segments = 1
	 * UHD@30:
	 *	SST :	InputSamples per clock = 2
	 *		OutputSamples per clock = 2
	 *		Number of segments = 1
	 */

	/* UHD2@60 in MST mode with 2 streams */
	InputSamples = 4;
	OutputSamples = 4;
	ImageSegments = 2;
	XDualSplitter_SetImgParam(&DualSplitterInst, InputSamples,
			OutputSamples, ImageSegments, Overlap);

	/* Enable the register update */
	XDualSplitter_RegUpdateEnable(&DualSplitterInst);

	return XST_SUCCESS;
}