stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

dptx: Added function comments for the selftest example.

Browse source 
Signed-off-by: Andrei-Liviu Simion <andrei.simion@xilinx.com>
This commit is contained in:
Andrei-Liviu Simion 2014-08-10 16:26:10 -07:00 • committed by Jagannadha Sutradharudu Teki
parent 71f96698d0
commit 1efc76acc9
1 changed files with 35 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
XilinxProcessorIPLib/drivers/dptx/examples/xdptx_selftest_example.c
View file

@ -60,6 +60,21 @@ u32 Dptx_SelfTestExample(XDptx *InstancePtr, u16 DeviceId);
/**************************** Function Definitions ****************************/
/******************************************************************************/
/**
* This function is the main function of the XDptx selftest example.
*
* @param None.
*
* @return
* - XST_SUCCESS if the self test example passed.
* - XST_FAILURE if the self test example was unsuccessful - the
* DisplayPort TX's registers do not match their default values
* or no DisplayPort TX instance was found.
*
* @note None.
*
*******************************************************************************/
int main(void)
{
u32 Status;
@ -73,6 +88,26 @@ int main(void)
return Status;
}
/******************************************************************************/
/**
* The main entry point for the selftest example using the XDptx driver. This
* function will check whether or not the DisplayPort TX's registers are at
* their default reset values to ensure that the core is in a known and working
* state.
*
* @param InstancePtr is a pointer to the XDptx instance.
* @param DeviceId is the unique device ID of the DisplayPort TX core
* instance.
*
* @return
* - XST_SUCCESS if the DisplayPort TX's registers are at their
* default reset values.
* - XST_FAILURE if the DisplayPort TX's registers do not match
* their default values or no DisplayPort TX instance was found.
*
* @note None.
*
*******************************************************************************/
u32 Dptx_SelfTestExample(XDptx *InstancePtr, u16 DeviceId)
{
u32 Status;