hdcp1x: Added @addtogroup tag with appropriate version information

Signed-off-by: Nava kishore Manne <navam@xilinx.com>
Reviewed-by: Kedareswara rao Appana <appanad@xilinx.com>
This commit is contained in:
Nava kishore Manne 2015-08-13 18:02:13 +05:30
parent 70b838978e
commit 5125df28f8
25 changed files with 76 additions and 0 deletions

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This contains the implementation of the HDCP state machine module
*
@ -835,3 +837,4 @@ void XHdcp1x_Info(const XHdcp1x *InstancePtr)
XHDCP1X_DEBUG_PRINTF("unknown interface type\r\n");
}
}
/** @} */

View file

@ -33,6 +33,9 @@
/**
*
* @file xhdcp1x.h
* @addtogroup hdcp1x_v1_0
* @{
* @details
*
* This header file contains the external declarations associated with the
* HDCP interface driver.
@ -275,3 +278,4 @@ void XHdcp1x_Info(const XHdcp1x *InstancePtr);
#endif
#endif /* XHDCP1X_H */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_cipher.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This file contains the main implementation of the driver associated with
* the Xilinx HDCP Cipher core.
@ -1290,3 +1292,4 @@ static void Disable(XHdcp1x *InstancePtr)
/* Wait until the XOR has actually stopped */
while (XHdcp1x_CipherXorInProgress(InstancePtr));
}
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_cipher.h
* @addtogroup hdcp1x_v1_0
* @{
*
* This is the main header file for Xilinx HDCP Cipher core.
*
@ -146,3 +148,4 @@ void XHdcp1x_CipherHandleInterrupt(void *InstancePtr);
#endif
#endif /* XHDCP1X_CIPHER_H */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_cipher_intr.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This file contains interrupt related functions for Xilinx HDCP core.
* Please see xhdcp1x_cipher.h for more details of the driver.
@ -274,3 +276,4 @@ void XHdcp1x_CipherHandleInterrupt(void *InstancePtr)
}
}
}
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_debug.h
* @addtogroup hdcp1x_v1_0
* @{
*
* This file provides the interface of the HDCP debug commands
*
@ -79,3 +81,4 @@ extern XHdcp1x_LogMsg XHdcp1xDebugLogMsg;
#endif
#endif /* XHDCP1X_DEBUG_H */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_hw.h
* @addtogroup hdcp1x_v1_0
* @{
*
* This header file contains identifiers and register-level core functions (or
* macros) that can be used to access the Xilinx HDCP cipher core.
@ -410,3 +412,4 @@ extern "C" {
#endif
#endif /* XHDCP1X_HW_H */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_cipher_intr.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This file contains interrupt related functions for Xilinx HDCP core.
* Please see xhdcp_cipher.h for more details of the driver.
@ -111,3 +113,4 @@ void XHdcp1x_PortIntrHandler(void *InstancePtr, u32 IntCause)
XHdcp1x_PortHandleInterrupt(HdcpPtr, IntCause);
}
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_platform.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This file provides the implementation for the hdcp platform integration
* module
@ -180,3 +182,4 @@ int XHdcp1x_PlatformTimerBusy(XHdcp1x *InstancePtr, u16 DelayInMs)
return (Status);
}
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_platform.h
* @addtogroup hdcp1x_v1_0
* @{
*
* This file provides the interface for the hdcp platform integration module
*
@ -78,3 +80,4 @@ int XHdcp1x_PlatformTimerBusy(XHdcp1x *InstancePtr, u16 DelayInMs);
#endif
#endif /* XHDCP1X_PLATFORM_H */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_port.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This contains the main implementation file for the Xilinx HDCP Port driver
*
@ -386,3 +388,4 @@ int XHdcp1x_PortWrite(XHdcp1x *InstancePtr, u8 Offset, const void *Buf,
return (NumWritten);
}
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_port.h
* @addtogroup hdcp1x_v1_0
* @{
*
* This header file contains the external declarations associated with the
* HDCP port driver.
@ -211,3 +213,4 @@ void XHdcp1x_PortHandleInterrupt(XHdcp1x *InstancePtr, u32 IntCause);
#endif
#endif /* XHDCP1X_PORT_H */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_port_dp.h
* @addtogroup hdcp1x_v1_0
* @{
*
* This file contains the definitions for the hdcp port registers/offsets for
* display port interfaces
@ -134,3 +136,4 @@ extern "C" {
#endif
#endif /* XHDCP1X_PORT_DP_H */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_port_dp_rx.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This contains the implementation of the HDCP port driver for Xilinx DP
* RX interfaces
@ -524,3 +526,4 @@ const XHdcp1x_PortPhyIfAdaptor XHdcp1x_PortDpRxAdaptor =
#endif
/* defined(XPAR_XDP_RX_NUM_INSTANCES) && (XPAR_XDP_RX_NUM_INSTANCES > 0) */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_port_dp_tx.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This contains the implementation of the HDCP port driver for DP TX
* interfaces
@ -474,3 +476,4 @@ const XHdcp1x_PortPhyIfAdaptor XHdcp1x_PortDpTxAdaptor =
#endif
/* defined(XPAR_XDP_TX_NUM_INSTANCES) && (XPAR_XDP_TX_NUM_INSTANCES > 0) */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_port_hdmi.h
* @addtogroup hdcp1x_v1_0
* @{
*
* This file contains the definitions for the hdcp port registers/offsets for
* HDMI interfaces
@ -135,3 +137,4 @@ extern "C" {
#endif
#endif /* XHDCP1X_PORT_HDMI_H */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_port_hdmi_rx.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This contains the implementation of the HDCP port driver for HDMI RX
* interfaces
@ -347,3 +349,4 @@ const XHdcp1x_PortPhyIfAdaptor XHdcp1x_PortHdmiRxAdaptor =
#endif
/* defined(XPAR_XHDMI_RX_NUM_INSTANCES) && (XPAR_XHDMI_RX_NUM_INSTANCES > 0) */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_port_hdmi_tx.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This contains the implementation of the HDCP port driver for HDMI TX
* interfaces
@ -420,3 +422,4 @@ const XHdcp1x_PortPhyIfAdaptor XHdcp1x_PortHdmiTxAdaptor =
#endif
/* defined(XPAR_XHDMI_TX_NUM_INSTANCES) && (XPAR_XHDMI_TX_NUM_INSTANCES > 0) */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_port_intr.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This contains the interrupt related functions of the Xilinx HDCP port driver
*
@ -142,3 +144,4 @@ void XHdcp1x_PortHandleInterrupt(XHdcp1x *InstancePtr, u32 IntCause)
(*(Adaptor->IntrHandler))(InstancePtr, IntCause);
}
}
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_rx.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This contains the main implementation file for the Xilinx HDCP receive state
* machine
@ -1379,3 +1381,4 @@ static const char *XHdcp1x_RxStateToString(XHdcp1x_StateType State)
return (String);
}
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_rx.h
* @addtogroup hdcp1x_v1_0
* @{
*
* This file provides the interface of the HDCP RX state machine
*
@ -92,3 +94,4 @@ int XHdcp1x_RxInfo(const XHdcp1x *InstancePtr);
#endif
#endif /* XHDCP1X_RX_H */
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_selftest.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This file contains self test function for the hdcp interface
*
@ -110,3 +112,4 @@ int XHdcp1x_SelfTest(XHdcp1x *InstancePtr)
return (XST_SUCCESS);
}
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_sinit.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This file contains static initialization method for Xilinx HDCP driver
*
@ -120,3 +122,4 @@ XHdcp1x_Config *XHdcp1x_LookupConfig(u16 DeviceId)
return (CfgPtr);
}
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_tx.c
* @addtogroup hdcp1x_v1_0
* @{
*
* This contains the main implementation file for the Xilinx HDCP transmit
* state machine
@ -2506,3 +2508,4 @@ static const char *XHdcp1x_TxStateToString(XHdcp1x_StateType State)
return (String);
}
/** @} */

View file

@ -33,6 +33,8 @@
/**
*
* @file xhdcp1x_tx.h
* @addtogroup hdcp1x_v1_0
* @{
*
* This file provides the interface of the HDCP TX state machine
*
@ -97,3 +99,4 @@ int XHdcp1x_TxInfo(const XHdcp1x *InstancePtr);
#endif
#endif /* XHDCP1X_TX_H */
/** @} */