Incorporated code review comments, source file cleanup, implemented support for GMAC...

[keystone-rtos/netapi.git] / ti / runtime / netapi / src / pdkv3 / netapi_navig.c

diff --git a/ti/runtime/netapi/src/pdkv3/netapi_navig.c b/ti/runtime/netapi/src/pdkv3/netapi_navig.c
index 017f194ae5805892378538512bca187dd9284021..3888ba7929168c9c17e0a2db7585d7838b520d8a 100755 (executable)
--- a/ti/runtime/netapi/src/pdkv3/netapi_navig.c
+++ b/ti/runtime/netapi/src/pdkv3/netapi_navig.c
@@ -57,13 +57,16 @@
 #include "qmss_device.c"
 #include "cppi_device.c"
 
-/******************************************************************************
-* Macro to convert to IP Register Virtual Address from a mapped base Virtual
-* Address
-* Input: virtBaseAddr: Virtual base address mapped using mmap for IP
-*        phyBaseAddr: Physical base address for the IP
-*        phyRegAddr:  Physical register address
-******************************************************************************/
+/********************************************************************
+ * FUNCTION PURPOSE:  Internal NETAPI macro to convert to IP Register
+ *                    Virtual Address from a mapped base Virtual
+ *                    Address.
+ ********************************************************************
+ * DESCRIPTION:  Arguments:
+ *      virtBaseAddr: Virtual base address mapped using mmap for IP
+ *       phyBaseAddr: Physical base address for the IP
+ *       phyRegAddr:  Physical register address
+ ********************************************************************/
 static inline void* NETAPI_GET_REG_VADDR (void *    virtBaseAddr,
                                           uint32_t  phyBaseAddr,
                                           uint32_t  phyRegAddr)