net/i40e: extended list of operations for DDP processing
[dpdk.git] / drivers / net / i40e / rte_pmd_i40e.h
index 8e15630..356fa89 100644 (file)
@@ -59,7 +59,7 @@ enum rte_pmd_i40e_mb_event_rsp {
  */
 struct rte_pmd_i40e_mb_event_param {
        uint16_t vfid;     /**< Virtual Function number */
-       uint16_t msg_type; /**< VF to PF message type, see i40e_virtchnl_ops */
+       uint16_t msg_type; /**< VF to PF message type, see virtchnl_ops */
        uint16_t retval;   /**< return value */
        void *msg;         /**< pointer to message */
        uint16_t msglen;   /**< length of the message */
@@ -71,9 +71,26 @@ struct rte_pmd_i40e_mb_event_param {
 enum rte_pmd_i40e_package_op {
        RTE_PMD_I40E_PKG_OP_UNDEFINED = 0,
        RTE_PMD_I40E_PKG_OP_WR_ADD,   /**< load package and add to info list */
+       RTE_PMD_I40E_PKG_OP_WR_DEL, /**< load package and delete from info list */
+       RTE_PMD_I40E_PKG_OP_WR_ONLY, /**< load package without modifying info list */
        RTE_PMD_I40E_PKG_OP_MAX = 32
 };
 
+/**
+ * Types of package information.
+ */
+enum rte_pmd_i40e_package_info {
+       RTE_PMD_I40E_PKG_INFO_UNDEFINED = 0,
+       RTE_PMD_I40E_PKG_INFO_GLOBAL_HEADER,
+       RTE_PMD_I40E_PKG_INFO_GLOBAL_NOTES_SIZE,
+       RTE_PMD_I40E_PKG_INFO_GLOBAL_NOTES,
+       RTE_PMD_I40E_PKG_INFO_GLOBAL_MAX = 1024,
+       RTE_PMD_I40E_PKG_INFO_HEADER,
+       RTE_PMD_I40E_PKG_INFO_DEVID_NUM,
+       RTE_PMD_I40E_PKG_INFO_DEVID_LIST,
+       RTE_PMD_I40E_PKG_INFO_MAX = 0xFFFFFFFF
+};
+
 #define RTE_PMD_I40E_DDP_NAME_SIZE 32
 
 /**
@@ -87,6 +104,14 @@ struct rte_pmd_i40e_ddp_version {
        uint8_t draft;
 };
 
+/**
+ * Device ID for dynamic device personalization.
+ */
+struct rte_pmd_i40e_ddp_device_id {
+       uint32_t vendor_dev_id;
+       uint32_t sub_vendor_dev_id;
+};
+
 /**
  * Profile information in profile info list.
  */
@@ -98,6 +123,8 @@ struct rte_pmd_i40e_profile_info {
        uint8_t name[RTE_PMD_I40E_DDP_NAME_SIZE];
 };
 
+#define RTE_PMD_I40E_DDP_OWNER_UNKNOWN 0xFF
+
 /**
  * Profile information list returned from HW.
  */
@@ -106,6 +133,18 @@ struct rte_pmd_i40e_profile_list {
        struct rte_pmd_i40e_profile_info p_info[1];
 };
 
+/**
+ * ptype mapping table only accept RTE_PTYPE_XXX or "user defined" ptype.
+ * A ptype with MSB set will be regarded as a user defined ptype.
+ * Below macro help to create a user defined ptype.
+ */
+#define RTE_PMD_I40E_PTYPE_USER_DEFINE_MASK 0x80000000
+
+struct rte_pmd_i40e_ptype_mapping {
+       uint16_t hw_ptype; /**< hardware defined packet type*/
+       uint32_t sw_ptype; /**< software defined packet type */
+};
+
 /**
  * Notify VF when PF link status changes.
  *
@@ -386,6 +425,9 @@ int rte_pmd_i40e_reset_vf_stats(uint8_t port,
  *    ID specifying VF.
  * @param bw
  *    Bandwidth for this VF.
+ *    The value should be an absolute bandwidth in Mbps.
+ *    The bandwidth is a L2 bandwidth counting the bytes of ethernet packets.
+ *    Not count the bytes added by physical layer.
  * @return
  *   - (0) if successful.
  *   - (-ENODEV) if *port* invalid.
@@ -433,6 +475,9 @@ int rte_pmd_i40e_set_vf_tc_bw_alloc(uint8_t port,
  *    Number specifying TC.
  * @param bw
  *    Max bandwidth for this TC.
+ *    The value should be an absolute bandwidth in Mbps.
+ *    The bandwidth is a L2 bandwidth counting the bytes of ethernet packets.
+ *    Not count the bytes added by physical layer.
  * @return
  *   - (0) if successful.
  *   - (-ENODEV) if *port* invalid.
@@ -474,12 +519,35 @@ int rte_pmd_i40e_set_tc_strict_prio(uint8_t port, uint8_t tc_map);
  *   - (0) if successful.
  *   - (-ENODEV) if *port* invalid.
  *   - (-EINVAL) if bad parameter.
- *   - (1) if profile exists.
+ *   - (-EEXIST) if profile exists.
+ *   - (-EACCES) if profile does not exist.
+ *   - (-ENOTSUP) if operation not supported.
  */
 int rte_pmd_i40e_process_ddp_package(uint8_t port, uint8_t *buff,
                                     uint32_t size,
                                     enum rte_pmd_i40e_package_op op);
 
+/**
+ * rte_pmd_i40e_get_ddp_info - Get profile's info
+ * @param pkg
+ *    buffer of package.
+ * @param pkg_size
+ *    package buffer size
+ * @param info
+ *    buffer for response
+ * @param size
+ *    response buffer size
+ * @param type
+ *    type of information requested
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if information type not supported by the profile.
+ *   - (-EINVAL) if bad parameter.
+ */
+int rte_pmd_i40e_get_ddp_info(uint8_t *pkg, uint32_t pkg_size,
+                                    uint8_t *info, uint32_t size,
+                                    enum rte_pmd_i40e_package_info type);
+
 /**
  * rte_pmd_i40e_get_ddp_list - Get loaded profile list
  * @param port
@@ -495,4 +563,78 @@ int rte_pmd_i40e_process_ddp_package(uint8_t port, uint8_t *buff,
  */
 int rte_pmd_i40e_get_ddp_list(uint8_t port, uint8_t *buff, uint32_t size);
 
+/**
+ * Update hardware defined ptype to software defined packet type
+ * mapping table.
+ *
+ * @param port
+ *    pointer to port identifier of the device.
+ * @param mapping_items
+ *    the base address of the mapping items array.
+ * @param count
+ *    number of mapping items.
+ * @param exclusive
+ *    the flag indicate different ptype mapping update method.
+ *    -(0) only overwrite referred PTYPE mapping,
+ *     keep other PTYPEs mapping unchanged.
+ *    -(!0) overwrite referred PTYPE mapping,
+ *     set other PTYPEs maps to PTYPE_UNKNOWN.
+ */
+int rte_pmd_i40e_ptype_mapping_update(
+                       uint8_t port,
+                       struct rte_pmd_i40e_ptype_mapping *mapping_items,
+                       uint16_t count,
+                       uint8_t exclusive);
+
+/**
+ * Reset hardware defined ptype to software defined ptype
+ * mapping table to default.
+ *
+ * @param port
+ *    pointer to port identifier of the device
+ */
+int rte_pmd_i40e_ptype_mapping_reset(uint8_t port);
+
+/**
+ * Get hardware defined ptype to software defined ptype
+ * mapping items.
+ *
+ * @param port
+ *    pointer to port identifier of the device.
+ * @param mapping_items
+ *    the base address of the array to store returned items.
+ * @param size
+ *    the size of the input array.
+ * @param count
+ *    the place to store the number of returned items.
+ * @param valid_only
+ *    -(0) return full mapping table.
+ *    -(!0) only return mapping items which packet_type != RTE_PTYPE_UNKNOWN.
+ */
+int rte_pmd_i40e_ptype_mapping_get(
+                       uint8_t port,
+                       struct rte_pmd_i40e_ptype_mapping *mapping_items,
+                       uint16_t size,
+                       uint16_t *count,
+                       uint8_t valid_only);
+
+/**
+ * Replace a specific or a group of software defined ptypes
+ * with a new one
+ *
+ * @param port
+ *    pointer to port identifier of the device
+ * @param target
+ *    the packet type to be replaced
+ * @param mask
+ *    -(0) target represent a specific software defined ptype.
+ *    -(!0) target is a mask to represent a group of software defined ptypes.
+ * @param pkt_type
+ *    the new packet type to overwrite
+ */
+int rte_pmd_i40e_ptype_mapping_replace(uint8_t port,
+                                      uint32_t target,
+                                      uint8_t mask,
+                                      uint32_t pkt_type);
+
 #endif /* _PMD_I40E_H_ */