eal: remove sys/queue.h from public headers
[dpdk.git] / drivers / net / bnxt / tf_core / tf_core.h
index 39a4981..fb02c2b 100644 (file)
@@ -65,6 +65,16 @@ enum tf_ext_mem_chan_type {
        TF_EXT_MEM_CHAN_TYPE_MAX
 };
 
+/**
+ * WC TCAM number of slice per row that devices supported
+ */
+enum tf_wc_num_slice {
+       TF_WC_TCAM_1_SLICE_PER_ROW = 1,
+       TF_WC_TCAM_2_SLICE_PER_ROW = 2,
+       TF_WC_TCAM_4_SLICE_PER_ROW = 4,
+       TF_WC_TCAM_8_SLICE_PER_ROW = 8,
+};
+
 /**
  * EEM record AR helper
  *
@@ -233,7 +243,7 @@ enum tf_identifier_type {
         */
        TF_IDENT_TYPE_EM_PROF,
        /**
-        *  TH
+        *  (Future)
         *  The L2 func is included in the ILT result and from recycling to
         *  enable virtualization of further lookups.
         */
@@ -283,9 +293,9 @@ enum tf_tbl_type {
        TF_TBL_TYPE_ACT_MODIFY_32B,
        /** TH 64B Modify Record */
        TF_TBL_TYPE_ACT_MODIFY_64B,
-       /** (Future) Meter Profiles */
+       /** Meter Profiles */
        TF_TBL_TYPE_METER_PROF,
-       /** (Future) Meter Instance */
+       /** Meter Instance */
        TF_TBL_TYPE_METER_INST,
        /** Wh+/SR/Th Mirror Config */
        TF_TBL_TYPE_MIRROR_CONFIG,
@@ -301,6 +311,8 @@ enum tf_tbl_type {
        TF_TBL_TYPE_EM_FKB,
        /** TH WC Flexible Key builder */
        TF_TBL_TYPE_WC_FKB,
+       /** Meter Drop Counter */
+       TF_TBL_TYPE_METER_DROP_CNT,
 
        /* External */
 
@@ -396,7 +408,7 @@ enum tf_search_status {
 enum tf_em_tbl_type {
        /** The number of internal EM records for the session */
        TF_EM_TBL_TYPE_EM_RECORD,
-       /** The number of table scopes reequested */
+       /** The number of table scopes requested */
        TF_EM_TBL_TYPE_TBL_SCOPE,
        TF_EM_TBL_TYPE_MAX
 };
@@ -415,7 +427,7 @@ enum tf_em_tbl_type {
  */
 struct tf_session_info {
        /**
-        * TrueFlow Version. Used to control the structure layout when
+        * TruFlow Version. Used to control the structure layout when
         * sharing sessions. No guarantee that a secondary process
         * would come from the same version of an executable.
         * TruFlow initializes this variable on tf_open_session().
@@ -520,7 +532,7 @@ struct tf_identifier_resources {
 struct tf_tbl_resources {
        /**
         * Array of TF Table types where each entry is expected to be
-        * set to the requeste resource number of that specific
+        * set to the requested resource number of that specific
         * type. The index used is tf_tbl_type.
         */
        uint16_t cnt[TF_TBL_TYPE_MAX];
@@ -668,6 +680,13 @@ struct tf_open_session_parms {
         */
        void *bp;
 
+       /**
+        * [in]
+        *
+        * The number of slices per row for WC TCAM entry.
+        */
+       enum tf_wc_num_slice wc_num_slices;
+
        /**
         * [out] shared_session_creator
         *
@@ -732,8 +751,6 @@ int tf_open_session(struct tf *tfp,
 /**
  * General internal resource info
  *
- * TODO: remove tf_rm_new_entry structure and use this structure
- * internally.
  */
 struct tf_resource_info {
        uint16_t start;
@@ -848,7 +865,6 @@ struct tf_get_session_info_parms {
  */
 int tf_get_session_info(struct tf *tfp,
                        struct tf_get_session_info_parms *parms);
-
 /**
  * Experimental
  *
@@ -1105,10 +1121,6 @@ struct tf_alloc_tbl_scope_parms {
         * [in] Number of flows * 1000. If set, rx_mem_size_in_mb must equal 0.
         */
        uint32_t rx_num_flows_in_k;
-       /**
-        * [in] SR2 only receive table access interface id
-        */
-       uint32_t rx_tbl_if_id;
        /**
         * [in] All Maximum key size required.
         */
@@ -1127,10 +1139,6 @@ struct tf_alloc_tbl_scope_parms {
         * [in] Number of flows * 1000
         */
        uint32_t tx_num_flows_in_k;
-       /**
-        * [in] SR2 only receive table access interface id
-        */
-       uint32_t tx_tbl_if_id;
        /**
         * [in] Flush pending HW cached flows every 1/10th of value
         * set in seconds, both idle and active flows are flushed
@@ -1242,6 +1250,12 @@ int tf_free_tbl_scope(struct tf *tfp,
  * @ref tf_get_tcam_entry
  *
  * @ref tf_free_tcam_entry
+ *
+#ifdef TF_TCAM_SHARED
+ * @ref tf_move_tcam_shared_entries
+ *
+ * @ref tf_clear_tcam_shared_entries
+#endif
  */
 
 /**
@@ -1543,92 +1557,87 @@ struct tf_free_tcam_entry_parms {
 int tf_free_tcam_entry(struct tf *tfp,
                       struct tf_free_tcam_entry_parms *parms);
 
+#ifdef TF_TCAM_SHARED
 /**
- * @page table Table Access
+ * tf_move_tcam_shared_entries parameter definition
+ */
+struct tf_move_tcam_shared_entries_parms {
+       /**
+        * [in] receive or transmit direction
+        */
+       enum tf_dir dir;
+       /**
+        * [in] TCAM table type
+        */
+       enum tf_tcam_tbl_type tcam_tbl_type;
+};
+
+/**
+ * Move TCAM entries
  *
- * @ref tf_alloc_tbl_entry
+ * This API only affects the following TCAM pools within a shared session:
  *
- * @ref tf_free_tbl_entry
+ * TF_TCAM_TBL_TYPE_WC_TCAM_HIGH
+ * TF_TCAM_TBL_TYPE_WC_TCAM_LOW
  *
- * @ref tf_set_tbl_entry
+ * When called, all allocated entries from the high pool will be moved to
+ * the low pool.  Then the allocated entries in the high pool will be
+ * cleared and freed.
  *
- * @ref tf_get_tbl_entry
+ * This API is not supported on a non-shared session.
  *
- * @ref tf_bulk_get_tbl_entry
+ * Returns success or failure code.
  */
+int tf_move_tcam_shared_entries(struct tf *tfp,
+                               struct tf_move_tcam_shared_entries_parms *parms);
 
 /**
- * tf_alloc_tbl_entry parameter definition
+ * tf_clear_tcam_shared_entries parameter definition
  */
-struct tf_search_tbl_entry_parms {
+struct tf_clear_tcam_shared_entries_parms {
        /**
-        * [in] Receive or transmit direction
+        * [in] receive or transmit direction
         */
        enum tf_dir dir;
        /**
-        * [in] Type of the allocation
-        */
-       enum tf_tbl_type type;
-       /**
-        * [in] Table scope identifier (ignored unless TF_TBL_TYPE_EXT)
-        */
-       uint32_t tbl_scope_id;
-       /**
-        * [in] Result data to search for
-        */
-       uint8_t *result;
-       /**
-        * [in] Result data size in bytes
-        */
-       uint16_t result_sz_in_bytes;
-       /**
-        * [in] Allocate on miss.
-        */
-       uint8_t alloc;
-       /**
-        * [out] Set if matching entry found
-        */
-       uint8_t hit;
-       /**
-        * [out] Search result status (hit, miss, reject)
-        */
-       enum tf_search_status search_status;
-       /**
-        * [out] Current ref count after allocation
-        */
-       uint16_t ref_cnt;
-       /**
-        * [out] Idx of allocated entry or found entry
+        * [in] TCAM table type
         */
-       uint32_t idx;
+       enum tf_tcam_tbl_type tcam_tbl_type;
 };
 
 /**
- * search Table Entry (experimental)
+ * Clear TCAM shared entries pool
  *
- * This function searches the shadow copy of an index table for a matching
- * entry.  The result data must match for hit to be set.  Only TruFlow core
- * data is accessed.  If shadow_copy is not enabled, an error is returned.
+ * This API only affects the following TCAM pools within a shared session:
  *
- * Implementation:
+ * TF_TCAM_TBL_TYPE_WC_TCAM_HIGH
+ * TF_TCAM_TBL_TYPE_WC_TCAM_LOW
  *
- * A hash is performed on the result data and mappe3d to a shadow copy entry
- * where the result is populated.  If the result matches the entry, hit is set,
- * ref_cnt is incremented (if alloc), and the search status indicates what
- * action the caller can take regarding setting the entry.
+ * When called, the indicated WC TCAM high or low pool will be cleared.
  *
- * search status should be used as follows:
- * - On MISS, the caller should set the result into the returned index.
+ * This API is not supported on a non-shared session.
  *
- * - On REJECT, the caller should reject the flow since there are no resources.
+ * Returns success or failure code.
+ */
+int tf_clear_tcam_shared_entries(struct tf *tfp,
+                             struct tf_clear_tcam_shared_entries_parms *parms);
+
+#endif /* TF_TCAM_SHARED */
+/**
+ * @page table Table Access
  *
- * - On Hit, the matching index is returned to the caller.  Additionally, the
- *   ref_cnt is updated.
+ * @ref tf_alloc_tbl_entry
  *
- * Also returns success or failure code.
+ * @ref tf_free_tbl_entry
+ *
+ * @ref tf_set_tbl_entry
+ *
+ * @ref tf_get_tbl_entry
+ *
+ * @ref tf_bulk_get_tbl_entry
+ *
+ * @ref tf_get_shared_tbl_increment
  */
-int tf_search_tbl_entry(struct tf *tfp,
-                       struct tf_search_tbl_entry_parms *parms);
 
 /**
  * tf_alloc_tbl_entry parameter definition
@@ -1646,30 +1655,9 @@ struct tf_alloc_tbl_entry_parms {
         * [in] Table scope identifier (ignored unless TF_TBL_TYPE_EXT)
         */
        uint32_t tbl_scope_id;
+
        /**
-        * [in] Enable search for matching entry. If the table type is
-        * internal the shadow copy will be searched before
-        * alloc. Session must be configured with shadow copy enabled.
-        */
-       uint8_t search_enable;
-       /**
-        * [in] Result data to search for (if search_enable)
-        */
-       uint8_t *result;
-       /**
-        * [in] Result data size in bytes (if search_enable)
-        */
-       uint16_t result_sz_in_bytes;
-       /**
-        * [out] If search_enable, set if matching entry found
-        */
-       uint8_t hit;
-       /**
-        * [out] Current ref count after allocation (if search_enable)
-        */
-       uint16_t ref_cnt;
-       /**
-        * [out] Idx of allocated entry or found entry (if search_enable)
+        * [out] Idx of allocated entry
         */
        uint32_t idx;
 };
@@ -1683,12 +1671,7 @@ struct tf_alloc_tbl_entry_parms {
  * entry of the indicated type for this TruFlow session.
  *
  * Allocates an index table record. This function will attempt to
- * allocate an entry or search an index table for a matching entry if
- * search is enabled (only the shadow copy of the table is accessed).
- *
- * If search is not enabled, the first available free entry is
- * returned. If search is enabled and a matching entry to entry_data
- * is found hit is set to TRUE and success is returned.
+ * allocate an index table entry.
  *
  * External types:
  *
@@ -1697,8 +1680,8 @@ struct tf_alloc_tbl_entry_parms {
  * Allocates an external index table action record.
  *
  * NOTE:
- * Implementation of the internals of this function will be a stack with push
- * and pop.
+ * Implementation of the internals of the external function will be a stack with
+ * push and pop.
  *
  * Returns success or failure code.
  */
@@ -1725,11 +1708,6 @@ struct tf_free_tbl_entry_parms {
         * [in] Index to free
         */
        uint32_t idx;
-       /**
-        * [out] Reference count after free, only valid if session has been
-        * created with shadow_copy.
-        */
-       uint16_t ref_cnt;
 };
 
 /**
@@ -1739,20 +1717,15 @@ struct tf_free_tbl_entry_parms {
  *
  * Internal types:
  *
- * If session has shadow_copy enabled the shadow DB is searched and if
- * found the element ref_cnt is decremented. If ref_cnt goes to
- * zero then the element is returned to the session pool.
- *
- * If the session does not have a shadow DB the element is free'ed and
- * given back to the session pool.
+ * The element is freed and given back to the session pool.
  *
  * External types:
  *
- * Free's an external index table action record.
+ * Frees an external index table action record.
  *
  * NOTE:
- * Implementation of the internals of this function will be a stack with push
- * and pop.
+ * Implementation of the internals of the external table will be a stack with
+ * push and pop.
  *
  * Returns success or failure code.
  */
@@ -1796,15 +1769,45 @@ struct tf_set_tbl_entry_parms {
 /**
  * set index table entry
  *
- * Used to insert an application programmed index table entry into a
- * previous allocated table location.  A shadow copy of the table
- * is maintained (if enabled) (only for internal objects)
+ * Used to set an application programmed index table entry into a
+ * previous allocated table location.
  *
  * Returns success or failure code.
  */
 int tf_set_tbl_entry(struct tf *tfp,
                     struct tf_set_tbl_entry_parms *parms);
 
+/**
+ * tf_get_shared_tbl_increment parameter definition
+ */
+struct tf_get_shared_tbl_increment_parms {
+       /**
+        * [in] Receive or transmit direction
+        */
+       enum tf_dir dir;
+       /**
+        * [in] Type of object to set
+        */
+       enum tf_tbl_type type;
+       /**
+        * [out] Value to increment by for resource type
+        */
+       uint32_t increment_cnt;
+};
+
+/**
+ * tf_get_shared_tbl_increment
+ *
+ * This API is currently only required for use in the shared
+ * session for Thor (p58) actions.  An increment count is returned per
+ * type to indicate how much to increment the start by for each
+ * entry (see tf_resource_info)
+ *
+ * Returns success or failure code.
+ */
+int tf_get_shared_tbl_increment(struct tf *tfp,
+                               struct tf_get_shared_tbl_increment_parms *parms);
+
 /**
  * tf_get_tbl_entry parameter definition
  */
@@ -2037,7 +2040,7 @@ struct tf_move_em_entry_parms {
        uint64_t flow_handle;
 };
 /**
- * tf_search_em_entry parameter definition
+ * tf_search_em_entry parameter definition (Future)
  */
 struct tf_search_em_entry_parms {
        /**
@@ -2140,7 +2143,7 @@ int tf_delete_em_entry(struct tf *tfp,
                       struct tf_delete_em_entry_parms *parms);
 
 /**
- * search em hash entry table memory
+ * search em hash entry table memory (Future)
  *
  * Internal:
 
@@ -2197,6 +2200,8 @@ enum tf_global_config_type {
        TF_TUNNEL_ENCAP,  /**< Tunnel Encap Config(TECT) */
        TF_ACTION_BLOCK,  /**< Action Block Config(ABCR) */
        TF_COUNTER_CFG,   /**< Counter Configuration (CNTRS_CTRL) */
+       TF_METER_CFG,     /**< Meter Config(ACTP4_FMTCR) */
+       TF_METER_INTERVAL_CFG, /**< Meter Interval Config(FMTCR_INTERVAL)  */
        TF_GLOBAL_CFG_TYPE_MAX
 };