Additional doxygen updates
[keystone-rtos/netapi.git] / ti / runtime / netapi / netapi_sec.h
index 7bfc3712691100e9c19e171eeb606f8773516cea..eebd52deb20801e79ce449b7cdf610a713391756 100755 (executable)
 
 
 /**
- *  @ingroup netapi_structures
+ *  @ingroup cfg_security_structures
  *  @brief NETAPI SA Statistics
  *
- *  @details Pointer to this strucutre is passed in the call to netapi_getSaStats API. It will be popluated with the requested statistics.  Currently only IPSEC stats are valid.
+ *  @details Pointer to this strucutre is passed in the call to netapi_getSaStats API. It will be popluated with the requested statistics.
+ *  Currently only IPSEC stats are valid.
  */
 typedef struct NETAPI_SA_STATS_Tag
 {
-#define NETAPI_IPSEC_STAT_VALID                 0x0001 /**< Indicates to user application that IPSEC stats are valid for INFLOW mode */
-#define NETAPI_SIDEBAND_DATA_MODE_STAT_VALID    0x0002 /**< Indicates to user application that IPSEC stats are valid for SIDEBAND mode */
+/**
+ * Bit map indicating the IPSec SA Inflow/Side band data mode stats validity
+ * <br>
+ * The validParams field indicates to the caller which stats being returned by calling the @ref netapi_getSaStats are valid.
+ *      @ref NETAPI_IPSEC_STAT_VALID, @ref NETAPI_SIDEBAND_DATA_MODE_STAT_VALID
+ */
     uint16_t            validParams;            /**< Bit map indicating the IPSec SA Inflow/Side band data mode stats validity */
+
+/**
+ * @def NETAPI_IPSEC_STAT_VALID
+ * @ingroup security_constants
+ *      Indicates to user application that IPSEC stats are valid for INFLOW mode
+ */
+#define NETAPI_IPSEC_STAT_VALID                 0x0001 
+
+/**
+ * @def NETAPI_SIDEBAND_DATA_MODE_STAT_VALID
+ * @ingroup security_constants
+ *      Indicates to user application that IPSEC stats are valid for SIDEBAND mode 
+ */
+#define NETAPI_SIDEBAND_DATA_MODE_STAT_VALID    0x0002
+
     Sa_IpsecStats_t     saIpsecStats;           /**<  Structure containing IPSEC stats in INFLOW MODE*/
     Sa_DataModeStats_t  dataModeStats;          /**<  Structure containing IPSEC stats in SIDEBAND MODE */
 } NETAPI_SA_STATS_T;
 
 
 /**
- *  @ingroup netapi_structures
+ *  @ingroup cfg_security_structures
  *  @brief NETAPI security SA information
  *
  *  @details This structure contains the information necessary to create a security association (for either for inflow mode or sideband mode)
@@ -95,18 +115,21 @@ typedef struct NETAPI_SEC_SA_INFO_tag
 } NETAPI_SEC_SA_INFO_T;
 
 
+
 /**
- * @brief This defines the SA mode of operation to be INFLOW.  This means that IPSEC will be applied as the packet is being received or just before it is transmitted
+ * @brief This defines the SA mode of operation to be INFLOW.  This means that IPSEC will be applied as the packet is being received or just before it is transmitted TBD
+ * @ingroup security_constants
  */
 #define NETAPI_SEC_SA_INFLOW   0x2
 
 /**
- * @brief This defines the SA mode of operation to be SIDEBAND.  This means that Security Acclerator is to be used a traditional accelerator.
+ * @brief This defines the SA mode of operation to be SIDEBAND.  This means that Security Acclerator is to be used a traditional accelerator TBD
+ * @ingroup security_constants
  */
 #define NETAPI_SEC_SA_SIDEBAND 0x1
 
 /**
- *  @ingroup netapi_cfg_sec_functions
+ *  @ingroup cfg_security_functions
  *  @brief netapi_secAddSA  API to configure an IPSEC SA.
  *
  *  @details API to configure an IPSec SA. SAs are IPSec security contexts and define a uni-directional
@@ -135,7 +158,7 @@ NETCP_CFG_SA_T netapi_secAddSA(NETAPI_T h,
                                 int * perr);
 
 /**
- *  @ingroup netapi_cfg_sec_functions
+ *  @ingroup cfg_security_functions
  *  @brief  netapi_secDelSA: API to delete an IPSEC SA. 
  *
  *  @details API to delete an IPSEC SA
@@ -149,7 +172,7 @@ NETCP_CFG_SA_T netapi_secAddSA(NETAPI_T h,
 void netapi_secDelSA(NETAPI_T h,int iface_no, NETCP_CFG_SA_T  sa_app_id,  int *perr);
 
 /**
- *  @ingroup netapi_cfg_sec_functions
+ *  @ingroup cfg_security_functions
  *  @brief netapi_secAddRxPolicy: API to add a recieve security policy 
  *
  *  @details API to add a recieve security policy
@@ -158,7 +181,7 @@ void netapi_secDelSA(NETAPI_T h,int iface_no, NETCP_CFG_SA_T  sa_app_id,  int *p
  *  @param[in] ipType   IPV4 or IPV6
  *  @param[in] src_ip_addr  source IP for policy check
  *  @param[in] dst_ip_addr  destination IP for policy check
- *  @param[in] ip_qualifiers  IP qualifiers for policy check (see @ref  nwaIpOpt_t)
+ *  @param[in] ip_qualifiers  IP qualifiers for policy check
  *  @param[in] route    Optional route @ref NETCP_CFG_ROUTE_HANDLE_T
  *  @param[out] perr    Pointer to error code.
  *  @retval    Aplication id associated with created receive security policy @ref NETCP_CFG_IPSEC_POLICY_T.  This is used to refer to the policy in the @ref netapi_secDelRxPolicy call.  Also, packets that match this policy but do not pass any further lookups in NETCP will be tagged with this ID
@@ -174,7 +197,7 @@ NETCP_CFG_IPSEC_POLICY_T netapi_secAddRxPolicy(NETAPI_T h,
                                 int * perr);
 
 /**
- *  @ingroup netapi_cfg_sec_functions
+ *  @ingroup cfg_security_functions
  *  @brief netapi_secDelRxPolicy: API to add a recieve security policy 
  *
  *  @details API to add a recieve security policy
@@ -190,7 +213,7 @@ void netapi_secDelRxPolicy(NETAPI_T h,
 
 
 /**
- *  @ingroup netapi_cfg_sec_functions
+ *  @ingroup cfg_security_functions
  *  @brief netapi_getSaStats: API to retrieve SA statistics via NWAL.
  *
  *  @details API to retrieve SA statistics via NWAL.