Doxygen changes for drivers

This commit is contained in:
Nava kishore Manne 2015-06-12 00:05:29 +05:30
parent 6769624eed
commit 146cd64c83
508 changed files with 2144 additions and 112 deletions

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xaxicdma.c
* @addtogroup axicdma_v3_0
* @{
* @details
*
* The implementation of the API of Xilinx CDMA engine.
*
@ -685,3 +688,4 @@ void XAxiCdma_DumpRegisters(XAxiCdma *InstancePtr)
return;
}
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xaxicdma.h
* @addtogroup axicdma_v3_0
* @{
* @details
*
* This is the driver API for the AXI CDMA engine.
*
@ -560,3 +563,4 @@ void XAxiCdma_DumpRegisters(XAxiCdma *InstancePtr);
#endif
#endif /* prevent circular inclusions */
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xaxicdma_bd.c
* @addtogroup axicdma_v3_0
* @{
* @details
*
* The implementation for the Buffer Descriptor (BD) API functions.
*
@ -489,3 +492,4 @@ void XAxiCdma_DumpBd(XAxiCdma_Bd* BdPtr)
return;
}
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xaxicdma_bd.h
* @addtogroup axicdma_v3_0
* @{
* @details
*
* The API definition for the Buffer Descriptor (BD).
*
@ -134,3 +137,4 @@ void XAxiCdma_DumpBd(XAxiCdma_Bd* BdPtr);
#endif
#endif /* prevent circular inclusions */
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xaxicdma_bdring.c
* @addtogroup axicdma_v3_0
* @{
* @details
*
* Implementation for support on Scatter Gather (SG) transfers.
* It includes the implementation of the BD ring API. There is only one BD ring
@ -1052,3 +1055,4 @@ int XAxiCdma_BdRingStartTransfer(XAxiCdma *InstancePtr)
return XST_SUCCESS;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxicdma_g.c
* @addtogroup axicdma_v3_0
* @{
* @details
*
* Provide a template for user to define their own hardware settings.
*
@ -64,3 +67,4 @@ XAxiCdma_Config XAxiCdma_ConfigTable[] =
XPAR_AXICDMA_0_M_AXI_DATA_WIDTH
}
};
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xaxicdma_hw.h
* @addtogroup axicdma_v3_0
* @{
* @details
*
* Hardware definition file. It defines the register interface and Buffer
* Descriptor (BD) definitions.
@ -237,3 +240,4 @@ extern "C" {
#endif
#endif
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xaxicdma_i.h
* @addtogroup axicdma_v3_0
* @{
* @details
*
* Header file for utility functions shared by driver files.
*
@ -71,3 +74,4 @@ int XAxiCdma_BdRingStartTransfer(XAxiCdma *InstancePtr);
#endif
#endif /* prevent circular inclusions */
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xaxicdma_intr.c
* @addtogroup axicdma_v3_0
* @{
* @details
*
* The implementation of the interrupt related API. The interrupt handler is
* also implemented here.
@ -254,3 +257,4 @@ void XAxiCdma_IntrHandler(void *HandlerRef)
return;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxicdma_porting_guide.h
* @addtogroup axicdma_v3_0
* @{
* @details
*
* This is a guide on how to move from using the XPS Central DMA driver,
* dmacentral, to use xaxidma driver.
@ -111,3 +114,4 @@
* </pre>
*
******************************************************************************/
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxicdma_sinit.c
* @addtogroup axicdma_v3_0
* @{
* @details
*
* Look up the hardware settings using device ID. The hardware setting is inside
* the configuration table in xaxivdma_g.c, generated automatically by XPS or
@ -83,3 +86,4 @@ XAxiCdma_Config *XAxiCdma_LookupConfig(u32 DeviceId)
return CfgPtr;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxidma.c
* @addtogroup axidma_v8_1
* @{
* @details
*
* This file implements DMA engine-wise initialization and control functions.
* For more information on the implementation of this driver, see xaxidma.h.
@ -951,3 +954,4 @@ int XAxiDma_SimpleTransfer(XAxiDma *InstancePtr, u32 BuffAddr, u32 Length,
return XST_SUCCESS;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxidma.h
* @addtogroup axidma_v8_1
* @{
* @details
*
* This is the driver API for the AXI DMA engine.
*
@ -730,3 +733,4 @@ int XAxiDma_Selftest(XAxiDma * InstancePtr);
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxidma_bd.c
* @addtogroup axidma_v8_1
* @{
* @details
*
* Buffer descriptor (BD) management API implementation.
*
@ -337,3 +340,4 @@ void XAxiDma_DumpBd(XAxiDma_Bd* BdPtr)
xil_printf("\r\n");
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxidma_bd.h
* @addtogroup axidma_v8_1
* @{
* @details
*
* Buffer descriptor (BD) management API.
*
@ -669,3 +672,4 @@ void XAxiDma_DumpBd(XAxiDma_Bd* BdPtr);
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxidma_bdring.c
* @addtogroup axidma_v8_1
* @{
* @details
*
* This file implements buffer descriptor ring related functions. For more
* information on how to manage the BD ring, please see xaxidma.h.
@ -1531,3 +1534,4 @@ void XAxiDma_BdRingDumpRegs(XAxiDma_BdRing *RingPtr) {
xil_printf("\r\n");
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxidma_bdring.h
* @addtogroup axidma_v8_1
* @{
* @details
*
* This file contains DMA channel related structure and constant definition
* as well as function prototypes. Each DMA channel is managed by a Buffer
@ -520,3 +523,4 @@ void XAxiDma_BdRingDumpRegs(XAxiDma_BdRing *RingPtr);
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxidma_g.c
* @addtogroup axidma_v8_1
* @{
* @details
*
* Provide a template for user to define their own hardware settings.
*
@ -81,3 +84,4 @@ XAxiDma_Config XAxiDma_ConfigTable[] =
XPAR_AXIDMA_0_NUM_S2MM_CHANNELS
}
};
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xaxidma_hw.h
* @addtogroup axidma_v8_1
* @{
* @details
*
* Hardware definition file. It defines the register interface and Buffer
* Descriptor (BD) definitions.
@ -329,3 +332,4 @@ extern "C" {
#endif
#endif
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxidma_porting_guide.h
* @addtogroup axidma_v8_1
* @{
* @details
*
* This is a guide on how to move from using the xlldma driver to use xaxidma
* driver.
@ -249,3 +252,4 @@
*</pre>
*
******************************************************************************/
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxidma_selftest.c
* @addtogroup axidma_v8_1
* @{
* @details
*
* Contains diagnostic/self-test functions for the XAxiDma component.
*
@ -110,3 +113,4 @@ int XAxiDma_Selftest(XAxiDma * InstancePtr)
return XST_SUCCESS;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxidma_sinit.c
* @addtogroup axidma_v8_1
* @{
* @details
*
* Look up the hardware settings using device ID. The hardware setting is inside
* the configuration table in xaxidma_g.c, generated automatically by XPS or
@ -90,3 +93,4 @@ XAxiDma_Config *XAxiDma_LookupConfig(u32 DeviceId)
return CfgPtr;
}
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************
**
* @file xaxipcie.c
* @addtogroup axipcie_v3_0
* @{
* @details
*
* Implements all of functions for XAxiPcie IP driver except interrupts and
* initialization.
@ -885,3 +888,4 @@ void XAxiPcie_WriteRemoteConfigSpace(XAxiPcie *InstancePtr, u8 Bus, u8 Device,
}
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxipcie.h
* @addtogroup axipcie_v3_0
* @{
* @details
*
* This file contains the software API definition of the Xilinx AXI PCIe IP
* (XAxiPcie). This driver provides "C" function interface to application/upper
@ -323,3 +326,4 @@ void XAxiPcie_ClearPendingInterrupts(XAxiPcie *InstancePtr, u32 ClearMask);
#endif /* end of protection macro */
/** @} */

View file

@ -32,6 +32,9 @@
/****************************************************************************/
/**
* @file xaxipcie_g.c
* @addtogroup axipcie_v3_0
* @{
* @details
*
* This file contains a configuration table that specifies the configuration
* of AXI PCIe devices in the system.
@ -80,3 +83,4 @@ XAxiPcie_Config XAxiPcie_ConfigTable[] = {
}
};
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxipcie_hw.h
* @addtogroup axipcie_v3_0
* @{
* @details
*
* This header file contains identifiers and basic driver functions for the
* XAxiPcie device driver.
@ -605,3 +608,4 @@ extern "C" {
#endif /* XAXIPCIE_HW_H */
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************
**
* @file xaxipcie_intr.c
* @addtogroup axipcie_v3_0
* @{
* @details
*
* This file implements interrupt functions for the XAxiPcie IP
*
@ -252,3 +255,4 @@ void XAxiPcie_ClearPendingInterrupts(XAxiPcie *InstancePtr, u32 ClearMask)
XAxiPcie_ReadReg((InstancePtr->Config.BaseAddress),
XAXIPCIE_ID_OFFSET) & (ClearMask));
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxipcie_porting_guide.h
* @addtogroup axipcie_v3_0
* @{
* @details
*
* This is a guide on how to move from using the plbv46pcie driver to use
* xaxipcie driver.
@ -132,3 +135,4 @@
* - void XPcie_DisablePCIeConnection(XPcie *InstancePtr)
*
******************************************************************************/
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************
**
* @file xaxipcie_sinit.c
* @addtogroup axipcie_v3_0
* @{
* @details
*
* This file contains the implementation of AXI PCIe driver's static
* initialization functionality.
@ -99,3 +102,4 @@ XAxiPcie_Config *XAxiPcie_LookupConfig(u16 DeviceId)
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxis_switch.c
* @addtogroup axis_switch_v1_0
* @{
* @details
*
* This is the main file for Xilinx AXI4-Stream Switch Control Router core.
* Please see xaxis_switch.h for more details of the driver.
@ -308,3 +311,4 @@ void XAxisScr_MiPortDisableAll(XAxis_Switch *InstancePtr)
XAXIS_SCR_MI_X_DISABLE_MASK);
}
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxis_switch.h
* @addtogroup axis_switch_v1_0
* @{
* @details
*
* This is the main header file for Xilinx AXI4-Stream Switch Control Router
* core. It is used for routing streams where masters in the system do not know
@ -202,3 +205,4 @@ s32 XAxisScr_SelfTest(XAxis_Switch *InstancePtr);
#endif
#endif /* End of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxis_switch_hw.h
* @addtogroup axis_switch_v1_0
* @{
* @details
*
* This header file contains identifiers and register-level core functions (or
* macros) that can be used to access the Xilinx AXI4-Stream Switch Control
@ -161,4 +164,5 @@ extern "C" {
}
#endif
#endif /* end of protection macro */
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxis_switch_selftest.c
* @addtogroup axis_switch_v1_0
* @{
* @details
*
* This file contains self test function for the AXI4-Stream Source Control
* Router core.
@ -108,3 +111,4 @@ s32 XAxisScr_SelfTest(XAxis_Switch *InstancePtr)
return Status;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxis_switch_sinit.c
* @addtogroup axis_switch_v1_0
* @{
* @details
*
* This file contains static initialization method for Xilinx AXI4-Stream
* Source Control Router core.
@ -107,4 +110,5 @@ XAxis_Switch_Config *XAxisScr_LookupConfig(u16 DeviceId)
}
return (XAxis_Switch_Config *)CfgPtr;
}
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxivdma.c
* @addtogroup axivdma_v5_1
* @{
* @details
*
* Implementation of the driver API functions for the AXI Video DMA engine.
*
@ -1386,3 +1389,4 @@ int XAxiVdma_ClearDmaChannelErrors(XAxiVdma *InstancePtr, u16 Direction,
return XST_DEVICE_NOT_FOUND;
}
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxivdma.h
* @addtogroup axivdma_v5_1
* @{
* @details
*
* This is the Xilinx MVI AXI Video DMA device driver. The DMA engine transfers
* frames from the AXI Bus or to the AXI Bus. It is in the chain of video
@ -592,3 +595,4 @@ int XAxiVdma_Selftest(XAxiVdma * InstancePtr);
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxivdma_channel.c
* @addtogroup axivdma_v5_1
* @{
* @details
*
* Implementation of the channel related functions. These functions are used
* internally by the driver, and are declared in xaxivdma_i.h.
@ -1478,3 +1481,4 @@ static int XAxiVdma_BdSetFrmDly(XAxiVdma_Bd *BdPtr, int FrmDly)
return XST_SUCCESS;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxivdma_g.c
* @addtogroup axivdma_v5_1
* @{
* @details
*
* Provide a template for user to define their own hardware settings.
*
@ -102,3 +105,4 @@ XAxiVdma_Config XAxiVdma_ConfigTable[] =
XPAR_AXIVDMA_0_ENABLE_DEBUG_ALL
}
};
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xaxivdma_hw.h
* @addtogroup axivdma_v5_1
* @{
* @details
*
* Hardware definition file. It defines the register interface and Buffer
* Descriptor (BD) definitions.
@ -365,3 +368,4 @@ extern "C" {
#endif
#endif
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xaxivdma_i.h
* @addtogroup axivdma_v5_1
* @{
* @details
*
* Internal API definitions shared by driver files.
*
@ -176,3 +179,4 @@ void XAxiVdma_ClearChannelErrors(XAxiVdma_Channel *Channel, u32 ErrorMask);
#endif
#endif
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxivdma_intr.c
* @addtogroup axivdma_v5_1
* @{
* @details
*
* Implementation of interrupt related functions.
*
@ -405,3 +408,4 @@ int XAxiVdma_SetCallBack(XAxiVdma * InstancePtr, u32 HandlerType,
return XST_SUCCESS;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxivdma_porting_guide.h
* @addtogroup axivdma_v5_1
* @{
* @details
*
* This is a guide on how to move from using the xvdma driver to use xaxivdma
* driver.
@ -249,3 +252,4 @@
*
*
******************************************************************************/
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxivdma_selftest.c
* @addtogroup axivdma_v5_1
* @{
* @details
*
* Contains diagnostic/self-test functions for the XAxiVdma component.
*
@ -129,3 +132,4 @@ int XAxiVdma_Selftest(XAxiVdma * InstancePtr)
return XST_SUCCESS;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xaxivdma_sinit.c
* @addtogroup axivdma_v5_1
* @{
* @details
*
* Look up the hardware settings using device ID. The hardware setting is inside
* the configuration table in xaxivdma_g.c, generated automatically by XPS or
@ -81,3 +84,4 @@ XAxiVdma_Config *XAxiVdma_LookupConfig(u16 DeviceId)
return CfgPtr;
}
/** @} */

View file

@ -32,6 +32,9 @@
/**
* @file xbram.c
* @addtogroup bram_v4_0
* @{
* @details
*
* The implementation of the XBram driver's basic functionality.
* See xbram.h for more information about the driver.
@ -142,3 +145,4 @@ int XBram_CfgInitialize(XBram *InstancePtr,
return (XST_SUCCESS);
}
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xbram.h
* @addtogroup bram_v4_0
* @{
* @details
*
* If ECC is not enabled, this driver exists only to allow the tools to
* create a memory test application and to populate xparameters.h with memory
@ -208,3 +211,4 @@ u32 XBram_InterruptGetStatus(XBram *InstancePtr);
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xbram_g.c
* @addtogroup bram_v4_0
* @{
* @details
*
* This file contains a configuration table that specifies the configuration
* of BRAM devices in the system.
@ -90,3 +93,4 @@ XBram_Config XBram_ConfigTable[] = {
XPAR_BRAM_0_CTRL_HIGHADDR,
}
};
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xbram_hw.h
* @addtogroup bram_v4_0
* @{
* @details
*
* This header file contains identifiers and driver functions (or
* macros) that can be used to access the device. The user should refer to the
@ -404,3 +407,4 @@ extern "C" {
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/*****************************************************************************/
/**
* @file xbram_intr.c
* @addtogroup bram_v4_0
* @{
* @details
*
* Implements BRAM interrupt processing functions for the
* XBram driver. See xbram.h for more information
@ -233,3 +236,4 @@ u32 XBram_InterruptGetStatus(XBram * InstancePtr)
return XBram_ReadReg(InstancePtr->Config.CtrlBaseAddress,
XBRAM_ECC_EN_IRQ_OFFSET);
}
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xbram_selftest.c
* @addtogroup bram_v4_0
* @{
* @details
*
* The implementation of the XBram driver's self test function. This SelfTest
* is only applicable if ECC is enabled.
@ -554,3 +557,4 @@ int XBram_SelfTest(XBram *InstancePtr, u8 IntMask)
return (XST_SUCCESS);
}
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xbram_sinit.c
* @addtogroup bram_v4_0
* @{
* @details
*
* The implementation of the XBram driver's static initialzation
* functionality.
@ -99,3 +102,4 @@ XBram_Config *XBram_LookupConfig(u16 DeviceId)
return CfgPtr;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcan.c
* @addtogroup can_v3_0
* @{
* @details
*
* The XCan driver. Functions in this file are the minimum required functions
* for this driver. See xcan.h for a detailed description of the driver.
@ -1132,3 +1135,4 @@ static void StubHandler(void)
Xil_AssertVoidAlways();
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcan.h
* @addtogroup can_v3_0
* @{
* @details
*
* The Xilinx CAN driver. This driver supports the Xilinx CAN Controller.
*
@ -526,3 +529,4 @@ int XCan_SetHandler(XCan *InstancePtr, u32 HandlerType,
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcan_config.c
* @addtogroup can_v3_0
* @{
* @details
*
* Functions in this file are CAN Configuration Register access related.
*
@ -228,3 +231,4 @@ void XCan_GetBitTiming(XCan *InstancePtr, u8 *SyncJumpWidth,
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcan_g.c
* @addtogroup can_v3_0
* @{
* @details
*
* This file contains a configuration table that specifies the configuration
* of CAN devices in the system.
@ -78,3 +81,4 @@ XCan_Config XCan_ConfigTable[XPAR_XCAN_NUM_INSTANCES] = {
XPAR_OPB_CAN_0_CAN_NUM_ACF /* Number of acceptance filters */
}
};
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcan_intr.c
* @addtogroup can_v3_0
* @{
* @details
*
* This file contains functions related to CAN interrupt handling.
*
@ -402,3 +405,4 @@ int XCan_SetHandler(XCan *InstancePtr, u32 HandlerType,
return (XST_SUCCESS);
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcan_l.h
* @addtogroup can_v3_0
* @{
* @details
*
* This header file contains the identifiers and basic driver functions (or
* macros) that can be used to access the device. Other driver functions
@ -314,3 +317,4 @@ Mask/Acceptance Filter ID)
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcan_selftest.c
* @addtogroup can_v3_0
* @{
* @details
*
* This file contains a diagnostic self-test function for the XCan driver.
*
@ -174,3 +177,4 @@ int XCan_SelfTest(XCan *InstancePtr)
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanfd.c
* @addtogroup canfd_v1_0
* @{
* @details
*
* The XCanFd driver. Functions in this file are the minimum required functions
* for this driver. See xcanfd.h for a detailed description of the driver.
@ -1574,3 +1577,4 @@ void XCanFd_Disable_Tranceiver_Delay_Compensation(XCanFd *InstancePtr)
XCanFd_WriteReg(InstancePtr->CanFdConfig.BaseAddress,
XCANFD_F_BRPR_OFFSET,RegValue);
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanfd.h
* @addtogroup canfd_v1_0
* @{
* @details
*
* The Xilinx CANFD driver. This driver supports the Xilinx CANFD Controller.
*
@ -934,3 +937,4 @@ XCanFd_Config *XCanFd_LookupConfig(u16 Deviceid);
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanfd_config.c
* @addtogroup canfd_v1_0
* @{
* @details
*
* Functions in this file are CAN Configuration Register access related.
*
@ -468,3 +471,4 @@ void XCanFd_SetBitRateSwitch_DisableNominal(XCanFd *InstancePtr)
Result = XCanFd_ReadReg(InstancePtr->CanFdConfig.BaseAddress,
XCANFD_MSR_OFFSET);
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanfd_hw.h
* @addtogroup canfd_v1_0
* @{
* @details
*
* This header file contains the identifiers and basic driver functions (or
* macros) that can be used to access the device. Other driver functions
@ -1180,3 +1183,4 @@ Mask/Acceptance Filter ID)
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanfd_intr.c
* @addtogroup canfd_v1_0
* @{
* @details
*
* This file contains functions related to CAN interrupt handling.
*
@ -598,3 +601,4 @@ int XCanFd_SetHandler(XCanFd *InstancePtr, u32 HandlerType,
}
return (XST_SUCCESS);
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanfd_selftest.c
* @addtogroup canfd_v1_0
* @{
* @details
*
* This file contains a diagnostic self-test function for the XCanFd driver.
*
@ -223,3 +226,4 @@ int XCanFd_SelfTest(XCanFd *InstancePtr)
return XST_SUCCESS;
}
/** @} */

View file

@ -42,6 +42,9 @@
/**
*
* @file xcanFd_sinit.c
* @addtogroup canfd_v1_0
* @{
* @details
*
* This file contains the implementation of the XCanFd driver's static
* initialization functionality.
@ -106,3 +109,4 @@ XCanFd_Config *XCanFd_LookupConfig(u16 DeviceId)
return (XCanFd_Config *)CfgPtr;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanps.c
* @addtogroup canps_v3_0
* @{
* @details
*
* Functions in this file are the minimum required functions for the XCanPs
* driver. See xcanps.h for a detailed description of the driver.
@ -1200,3 +1203,4 @@ static void StubHandler(void)
{
Xil_AssertVoidAlways();
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanps.h
* @addtogroup canps_v3_0
* @{
* @details
*
* The Xilinx CAN driver component. This component supports the Xilinx
* CAN Controller.
@ -565,3 +568,4 @@ XCanPs_Config *XCanPs_LookupConfig(u16 DeviceId);
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanps_g.c
* @addtogroup canps_v3_0
* @{
* @details
*
* This file contains a configuration table that specifies the configuration
* of CAN devices in the system.
@ -84,3 +87,4 @@ XCanPs_Config XCanPs_ConfigTable[XPAR_XCANPS_NUM_INSTANCES] = {
}
#endif
};
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanps_hw.c
* @addtogroup canps_v3_0
* @{
* @details
*
* This file contains the implementation of the canps interface reset sequence
*
@ -88,3 +91,4 @@ void XCanPs_ResetHw(u32 BaseAddr)
XCanPs_WriteReg(BaseAddr, XCANPS_SRR_OFFSET, \
XCANPS_SRR_SRST_MASK);
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanps_hw.h
* @addtogroup canps_v3_0
* @{
* @details
*
* This header file contains the identifiers and basic driver functions (or
* macros) that can be used to access the device. Other driver functions
@ -364,3 +367,4 @@ void XCanPs_ResetHw(u32 BaseAddr);
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanps_intr.c
* @addtogroup canps_v3_0
* @{
* @details
*
* This file contains functions related to CAN interrupt handling.
*
@ -414,3 +417,4 @@ s32 XCanPs_SetHandler(XCanPs *InstancePtr, u32 HandlerType,
return Status;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanps_selftest.c
* @addtogroup canps_v3_0
* @{
* @details
*
* This file contains a diagnostic self-test function for the XCanPs driver.
*
@ -229,3 +232,4 @@ s32 XCanPs_SelfTest(XCanPs *InstancePtr)
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcanps_sinit.c
* @addtogroup canps_v3_0
* @{
* @details
*
* This file contains the implementation of the XCanPs driver's static
* initialization functionality.
@ -98,3 +101,4 @@ XCanPs_Config *XCanPs_LookupConfig(u16 DeviceId)
return (XCanPs_Config *)CfgPtr;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xccm.c
* @addtogroup ccm_v6_0
* @{
* @details
*
* This file contains the implementation of the interface functions for CCM
* driver. Refer to the header file xccm.h for more detailed information.
@ -995,3 +998,4 @@ static s32 XCcm_FloatToFixedConv(float Input)
return Value;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xccm.h
* @addtogroup ccm_v6_0
* @{
* @details
*
* This header file contains identifiers and register-level driver functions (or
* macros), range macros, structure typedefs that can be used to access the
@ -662,3 +665,4 @@ int XCcm_SetCallBack(XCcm *InstancePtr, u32 HandlerType,
#endif
#endif /* End of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xccm_hw.h
* @addtogroup ccm_v6_0
* @{
* @details
*
* This header file contains identifiers and register-level driver functions (or
* macros) that can be used to access the Xilinx Color Correction Matrix (CCM)
@ -297,3 +300,4 @@ extern "C" {
#endif
#endif /* End of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xccm_intr.c
* @addtogroup ccm_v6_0
* @{
* @details
*
* This file contains interrupt related functions of Xilinx CCM core.
* Please see xccm.h for more details of the driver.
@ -209,3 +212,4 @@ int XCcm_SetCallBack(XCcm *InstancePtr, u32 HandlerType,
return Status;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xccm_selftest.c
* @addtogroup ccm_v6_0
* @{
* @details
*
* This file contains the self-test functions for the CCM core.
*
@ -106,3 +109,4 @@ int XCcm_SelfTest(XCcm *InstancePtr)
return Status;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xccm_sinit.c
* @addtogroup ccm_v6_0
* @{
* @details
*
* This file contains static initialization methods for Xilinx CCM core.
*
@ -104,3 +107,4 @@ XCcm_Config *XCcm_LookupConfig(u16 DeviceId)
return (XCcm_Config *)CfgPtr;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcfa.c
* @addtogroup cfa_v7_0
* @{
* @details
*
* This file contains the implementation of the interface functions for CFA
* core. Refer to the header file xcfa.h for more detailed information.
@ -643,3 +646,4 @@ static void StubErrCallBack(void *CallBackRef, u32 ErrorMask)
Xil_AssertVoid(ErrorMask != ((u32)0x0));
Xil_AssertVoidAlways();
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcfa.h
* @addtogroup cfa_v7_0
* @{
* @details
*
* This header file contains identifiers and register-level core functions (or
* macros), range macros, structure typedefs that can be used to access the
@ -599,3 +602,4 @@ int XCfa_SetCallBack(XCfa *InstancePtr, u32 HandlerType,
#endif
#endif /* End of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcfa_hw.h
* @addtogroup cfa_v7_0
* @{
* @details
*
* This header file contains identifiers and register-level driver functions (or
* macros) that can be used to access the Xilinx Color Filter Array
@ -258,3 +261,4 @@ extern "C" {
#endif
#endif /* End of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcfa_intr.c
* @addtogroup cfa_v7_0
* @{
* @details
*
* This file contains interrupt related functions of the CFA core.
* Please see xcfa.h for more details of the core.
@ -206,3 +209,4 @@ int XCfa_SetCallBack(XCfa *InstancePtr, u32 HandlerType,
return Status;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcfa_selftest.c
* @addtogroup cfa_v7_0
* @{
* @details
*
* This file contains the self-test functions for the CFA core.
* The self test function reads the Version register.
@ -108,3 +111,4 @@ int XCfa_SelfTest(XCfa *InstancePtr)
return Status;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xcfa_sinit.c
* @addtogroup cfa_v7_0
* @{
* @details
*
* This file contains static initialization methods for Xilinx CFA core.
*
@ -105,3 +108,4 @@ XCfa_Config *XCfa_LookupConfig(u16 DeviceId)
return (XCfa_Config *)CfgPtr;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xbasic_types.c
* @addtogroup common_v1_00_a
* @{
* @details
*
* This file contains basic functions for Xilinx software IP.
*
@ -145,3 +148,4 @@ void XNullHandler(void *NullParameter)
{
(void) NullParameter;
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xbasic_types.h
* @addtogroup common_v1_00_a
* @{
* @details
*
* This file contains basic types for Xilinx software IP. These types do not
* follow the standard naming convention with respect to using the component
@ -308,3 +311,4 @@ void XNullHandler(void *NullParameter);
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xenv.h
* @addtogroup common_v1_00_a
* @{
* @details
*
* Defines common services that are typically found in a host operating.
* environment. This include file simply includes an OS specific file based
@ -186,3 +189,4 @@ extern "C" {
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xenv_linux.h
* @addtogroup common_v1_00_a
* @{
* @details
*
* Defines common services specified by xenv.h.
*
@ -250,3 +253,4 @@ typedef int XENV_TIME_STAMP;
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xenv_none.h
* @addtogroup common_v1_00_a
* @{
* @details
*
* This is a legacy file kept for backwards compatibility.
*
@ -50,3 +53,4 @@
#include "xenv_standalone.h"
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xenv_standalone.h
* @addtogroup common_v1_00_a
* @{
* @details
*
* Defines common services specified by xenv.h.
*
@ -365,3 +368,4 @@ typedef int XENV_TIME_STAMP;
#endif /* #ifndef XENV_STANDALONE_H */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xenv_vxworks.h
* @addtogroup common_v1_00_a
* @{
* @details
*
* Defines common services specified by xenv.h.
*
@ -267,3 +270,4 @@ typedef struct
#endif /* #ifdef XENV_VXWORKS_H */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xparameters.h
* @addtogroup common_v1_00_a
* @{
* @details
*
* This file contains system parameters for the Xilinx device driver environment.
* It is a representation of the system in that it contains the number of each
@ -726,3 +729,4 @@ deleted XPAR_INTC_0_MAX_ID, XPAR_INTC_1_MAX_ID
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xstatus.h
* @addtogroup common_v1_00_a
* @{
* @details
*
* This file contains Xilinx software status codes. Status codes have their
* own data type called int. These codes are used throughout the Xilinx
@ -427,3 +430,4 @@ typedef int XStatus;
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xutil.h
* @addtogroup common_v1_00_a
* @{
* @details
*
* This file contains utility functions such as memory test functions.
*
@ -162,3 +165,4 @@ int XUtil_MemoryTest8(u8 *Addr, u32 Words, u8 Pattern, u8 Subtest);
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xutil_memtest.c
* @addtogroup common_v1_00_a
* @{
* @details
*
* Contains the memory test utility functions.
*
@ -1181,3 +1184,4 @@ static u32 RotateRight(u32 Input, u8 Width)
}
#endif /* ROTATE_RIGHT */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xversion.c
* @addtogroup common_v1_00_a
* @{
* @details
*
* This file contains the implementation of the XVersion component. This
* component represents a version ID. It is encapsulated within a component
@ -352,3 +355,4 @@ static int IsVersionStringValid(char *StringPtr)
return TRUE;
}
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file xversion.h
* @addtogroup common_v1_00_a
* @{
* @details
*
* This file contains the interface for the XVersion component. This
* component represents a version ID. It is encapsulated within a component
@ -106,3 +109,4 @@ void XVersion_Copy(XVersion *InstancePtr, XVersion *VersionPtr);
#endif
#endif /* end of protection macro */
/** @} */

View file

@ -32,6 +32,9 @@
/*****************************************************************************/
/**
* @file fsl.h
* @addtogroup cpu_v2_3
* @{
* @details
*
* This file contains macros for interfacing to the Fast Simplex Link (FSL)
* interface..
@ -167,3 +170,4 @@ extern "C" {
}
#endif
#endif /* _FSL_H */
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xio.c
* @addtogroup cpu_v2_3
* @{
* @details
*
* Contains I/O functions for memory-mapped or non-memory-mapped I/O
* architectures. These functions encapsulate generic CPU I/O requirements.
@ -225,3 +228,4 @@ void XIo_OutSwap32(XIo_Address OutAddress, u32 Value)
XIo_EndianSwap32(Value, &OutData);
XIo_Out32(OutAddress, OutData);
}
/** @} */

Some files were not shown because too many files have changed in this diff Show more