kni: identify device by name

[dpdk.git] / lib / librte_kni / rte_kni.h

diff --git a/lib/librte_kni/rte_kni.h b/lib/librte_kni/rte_kni.h
index e3a2547..8be6281 100644 (file)
--- a/lib/librte_kni/rte_kni.h
+++ b/lib/librte_kni/rte_kni.h
@@ -46,8 +46,11 @@
  * and burst transmit packets to KNI interfaces.
  */
 
+#include <rte_pci.h>
 #include <rte_mbuf.h>
 
+#include <exec-env/rte_kni_common.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -58,6 +61,8 @@ struct rte_kni;
  * Structure which has the function pointers for KNI interface.
  */
 struct rte_kni_ops {
+       uint8_t port_id; /* Port ID */
+
        /* Pointer to function of changing MTU */
        int (*change_mtu)(uint8_t port_id, unsigned new_mtu);
 
@@ -66,24 +71,65 @@ struct rte_kni_ops {
 };
 
 /**
- * Create kni interface according to the port id. It will create a paired KNI
- * interface in the kernel space for each NIC port. The KNI interface created
+ * Structure for configuring KNI device.
+ */
+struct rte_kni_conf {
+       /*
+        * KNI name which will be used in relevant network device.
+        * Let the name as short as possible, as it will be part of
+        * memzone name.
+        */
+       char name[RTE_KNI_NAMESIZE];
+       uint16_t group_id;  /* Group ID */
+       unsigned mbuf_size; /* mbuf size */
+       struct rte_pci_addr addr;
+       struct rte_pci_id id;
+};
+
+/**
+ * Allocate KNI interface according to the port id, mbuf size, mbuf pool,
+ * configurations and callbacks for kernel requests.The KNI interface created
  * in the kernel space is the net interface the traditional Linux application
  * talking to.
  *
- * @param port_id
- *  The port id.
  * @param pktmbuf_pool
  *  The mempool for allocting mbufs for packets.
+ * @param conf
+ *  The pointer to the configurations of the KNI device.
+ * @param ops
+ *  The pointer to the callbacks for the KNI kernel requests.
+ *
+ * @return
+ *  - The pointer to the context of a KNI interface.
+ *  - NULL indicate error.
+ */
+extern struct rte_kni *rte_kni_alloc(struct rte_mempool *pktmbuf_pool,
+                                    const struct rte_kni_conf *conf,
+                                    struct rte_kni_ops *ops);
+
+/**
+ * It create a KNI device for specific port.
+ *
+ * Note: It is deprecated and just for backward compatibility.
+ *
+ * @param port_id
+ *  Port ID.
  * @param mbuf_size
- *  The mbuf size to store a packet.
+ *  mbuf size.
+ * @param pktmbuf_pool
+ *  The mempool for allocting mbufs for packets.
+ * @param ops
+ *  The pointer to the callbacks for the KNI kernel requests.
  *
  * @return
  *  - The pointer to the context of a KNI interface.
  *  - NULL indicate error.
  */
-extern struct rte_kni *rte_kni_create(uint8_t port_id, unsigned mbuf_size,
-               struct rte_mempool *pktmbuf_pool, struct rte_kni_ops *ops);
+extern struct rte_kni *rte_kni_create(uint8_t port_id,
+                                     unsigned mbuf_size,
+                                     struct rte_mempool *pktmbuf_pool,
+                                     struct rte_kni_ops *ops) \
+                                     __attribute__ ((deprecated));
 
 /**
  * Release KNI interface according to the context. It will also release the
@@ -154,6 +200,8 @@ extern unsigned rte_kni_tx_burst(struct rte_kni *kni,
 /**
  * Get the port id from KNI interface.
  *
+ * Note: It is deprecated and just for backward compatibility.
+ *
  * @param kni
  *  The KNI interface context.
  *
@@ -161,11 +209,26 @@ extern unsigned rte_kni_tx_burst(struct rte_kni *kni,
  *  On success: The port id.
  *  On failure: ~0x0
  */
-extern uint8_t rte_kni_get_port_id(struct rte_kni *kni);
+extern uint8_t rte_kni_get_port_id(struct rte_kni *kni) \
+                               __attribute__ ((deprecated));
+
+/**
+ * Get the KNI context of its name.
+ *
+ * @param name
+ *  pointer to the KNI device name.
+ *
+ * @return
+ *  On success: Pointer to KNI interface.
+ *  On failure: NULL.
+ */
+extern struct rte_kni *rte_kni_get(const char *name);
 
 /**
  * Get the KNI context of the specific port.
  *
+ * Note: It is deprecated and just for backward compatibility.
+ *
  * @param port_id
  *  the port id.
  *
@@ -173,7 +236,8 @@ extern uint8_t rte_kni_get_port_id(struct rte_kni *kni);
  *  On success: Pointer to KNI interface.
  *  On failure: NULL
  */
-extern struct rte_kni * rte_kni_info_get(uint8_t port_id);
+extern struct rte_kni *rte_kni_info_get(uint8_t port_id) \
+                               __attribute__ ((deprecated));
 
 /**
  * Register KNI request handling for a specified port,and it can