Additional doxygen updates
[keystone-rtos/netapi.git] / ti / runtime / netapi / netapi_tune.h
index 0ac7322aa06e596a2e9228d1d9d2a54d414ce54c..5f40430ecccd9038ed90b06063dce9500864be44 100755 (executable)
@@ -51,7 +51,7 @@
 
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def NETAPI_ENABLE_SECURITY
  *      Define this to enable securtiy.
  * @note Libraries using netapi need to be built with SA enabled
@@ -60,7 +60,7 @@
 
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def NETAPI_USE_DDR
  *      Define this to enable use of cached DDR for buffers and descriptors. 
  * @note Do not define if USE_MSMC defined below
@@ -70,7 +70,7 @@
 
 #ifdef NETAPI_USE_DDR
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def NETAPI_TUNE_USE_CACHE_OPS
  *      Define this to enable use of cached DDR for buffers and descriptors. 
  * @note Do not define if USE_MSMC defined below
@@ -79,7 +79,7 @@
 #endif
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def NETAPI_USE_MSMC
  *      Define this to enable use of un-cached MSMC for buffers and descriptors 
  * @note Do not define if USE_DDR defined above 
 #endif
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
 * @def TUNE_NETAPI_NUM_CORES
 *       This defines the number of cores (theads) 
  */
 #define TUNE_NETAPI_NUM_CORES 1
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_PERM_MEM_SZ
  *      This defines how much contiguous memory to grab. This is used for
  *      descriptors and buffers in the case of uncached configuration only.  
 #define TUNE_NETAPI_PERM_MEM_SZ   (2*1024*1024) 
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_MAX_PKTIO
  *      This defines the number of GLOBAL pkt io channels
  */
 #define TUNE_NETAPI_MAX_PKTIO 16
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_DEFAULT_BUFFER_SIZE
  *      This defines the size of the netapi default pktlib heap buffers This can be set at @ref netapi_init 
  */
 
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_DEFAULT_NUM_BUFFERS
  *      This defines the number of netapi default pktlib heap buffers (and assoc descriptors)
  *      this can be set at @ref netapi_init
 #define TUNE_NETAPI_DEFAULT_NUM_BUFFERS  200 
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_DEFAULT_NUM_SOLO_DESCRIPTORS
  *      This defines the number of netapi default pkt lib heap solo descriptors
  *      this can be set at @ref netapi_init
 #define TUNE_NETAPI_DEFAULT_NUM_SOLO_DESCRIPTORS  100 
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  NETAPI_INCLUDE_SCHED
  *      Define this to include the scheduler component
  */
 #define NETAPI_INCLUDE_SCHED 
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_QM_CONFIG_MAX_DESC_NUM
  *      This defines the number of of QM descriptors (total). This can be set set in @ref netapi_init
  * @note Must be a power or 2
 
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_NUM_LOCAL_DESC
  *      This defines the number of of QM descriptors (total). This can be set set in @ref netapi_init
 */
 
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_NUM_GLOBAL_DESC
  *      This defines the number of global descriptors.
  * @note Must be a power or 2
 #define TUNE_NETAPI_NUM_GLOBAL_DESC  1024
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_DESC_SIZE
  *      This defines the descriptor size
  * @note This define should NOT be changes
 
 #ifdef NETAPI_USE_DDR
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_QM_START_INDEX
  *      This defines the queue manager start index
  * @note This must reflect what the kernel is uding for their region, see device tree blob for details.
 #define TUNE_NETAPI_QM_START_INDEX  0x2000  //WARNING:  must reflect what kernel is using for their region, see device tree blob
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_QM_GLOBAL_REGION
  *      This defines the queue manager global region
  * @note This must reflect what the kernel is uding for their region, see device tree blob for details.
 
 #else //use msmc..
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_QM_START_INDEX
   *     This defines the queue manager start index
  * @note This must reflect what the kernel is uding for their region, see device tree blob for details.
 #define TUNE_NETAPI_QM_START_INDEX  0  //ok to use 0 since kernel is somewhere higher
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_QM_GLOBAL_REGION
  *      This defines the queue manager global region
  * @note This must reflect what the kernel is uding for their region, see device tree blob for details.
  */
-#define  0  //ok to to use 0 since msmc addr < ddr addr 
+#define  TUNE_NETAPI_QM_GLOBAL_REGION 0  //ok to to use 0 since msmc addr < ddr addr 
 
 #endif
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_NWAL_ENABLE_PASS_LOOPBACK
  *      Define this to 1 for debutg mode where NETCP just loops pkts that tx back to rx
  */
 /// @endcond
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_MAX_NUM_MAC
  *      This defines the number of logical mac addresses
  */
 #define TUNE_NETAPI_MAX_NUM_MAC                2
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_MAX_NUM_IP
  *      This defines the number of ip addresses
  */
 #define TUNE_NETAPI_MAX_NUM_IP                 32
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_MAX_NUM_PORTS_PER_CORE
  *      This defines the number of ports per core
  */
 #define TUNE_NETAPI_MAX_NUM_PORTS_PER_CORE     4
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_MAX_NUM_PORTS
  *      This defines the number maximum number of ports
  */
 
 #ifdef NETAPI_ENABLE_SECURITY
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_MAX_NUM_IPSEC_CHANNELS
  *      This defines the number maximum number of ipsec channels
  */
 #define TUNE_NETAPI_MAX_NUM_IPSEC_CHANNELS     32
 #else
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_MAX_NUM_IPSEC_CHANNELS
  *      This defines the number maximum number of ipsec channels
  */
 #endif
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_MAX_NUM_L2_L3_HDRS
  *      This defines the number maximum number of L2_L3 headers TBD
  */
 #define TUNE_NETAPI_MAX_NUM_L2_L3_HDRS         3
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_MAX_NUM_TRANS
  *      This defines the number maximum number of trans TBD
  */
 /// @endcond
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_MAX_BURST_RCV
  *      This defines the maximum number of packets to receive in one pktio poll.
  */
 #define TUNE_NETAPI_MAX_BURST_RCV 32
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_MAX_IP
  *      This defines the maximum number of IP's that can be attached to MAC interfaces.
  */
 #define TUNE_NETAPI_MAX_IP 4
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def TUNE_NETAPI_MAX_INTERFACES
  *      This defines the maximum number of MAX interfaces */
 #define TUNE_NETAPI_MAX_INTERFACES 2
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_NUM_TIMER_CELLS
  *      This defines the number of hash bins in a timer group.
  */
 #define TUNE_NETAPI_NUM_TIMER_CELLS  128   //# of hash bins in a timer group
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_NUM_GLOBAL_TIMERS
  *      This defines the number of global timer blocks
  */
 #define TUNE_NETAPI_NUM_GLOBAL_TIMERS  4    //# global timer blocks
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_MAX_HEAPS
  *      This defines the maximum number of heaps
  */
 #define TUNE_NETAPI_MAX_HEAPS  4   //max # of heaps one instance can create
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_MAX_CLASSIFIERS
  *      This defines the maximum number of classifiers
  */
 #define TUNE_NETAPI_MAX_CLASSIFIERS 16
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_MAX_BUF_POOLS_IN_FLOW
  *      This defines the  maximum number of buffer pools in flow -TBD
  * @note This define should NOT be changes
 
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_MAX_FLOWS
  *      This defines the maximum number of flows
  */
 #define TUNE_NETAPI_MAX_FLOWS  4   //app defined flows
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
 * @def  TUNE_NETAPI_MAX_SA
 *       This defines the maximum number of security associations
 */
 #define TUNE_NETAPI_MAX_SA 8   //rx&tx combined (so MAX_SA/4 tunnels typically)
 
 /**
- * @ingroup netapi_tune_parameters
+ * @ingroup tune_parameters
  * @def  TUNE_NETAPI_MAX_POLICY
  *      This defines the maximum number of security policies.
 */