kni: remove deprecated functions

[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 1a0b004..ef9faa9 100644 (file)
--- a/lib/librte_kni/rte_kni.h
+++ b/lib/librte_kni/rte_kni.h
@@ -47,7 +47,8 @@
  */
 
 #include <rte_pci.h>
-#include <rte_mbuf.h>
+#include <rte_memory.h>
+#include <rte_mempool.h>
 
 #include <exec-env/rte_kni_common.h>
 
@@ -56,6 +57,7 @@ extern "C" {
 #endif
 
 struct rte_kni;
+struct rte_mbuf;
 
 /**
  * Structure which has the function pointers for KNI interface.
@@ -89,12 +91,28 @@ struct rte_kni_conf {
        uint8_t force_bind : 1; /* Flag to bind kernel thread */
 };
 
+/**
+ * Initialize and preallocate KNI subsystem
+ *
+ * This function is to be executed on the MASTER lcore only, after EAL
+ * initialization and before any KNI interface is attempted to be
+ * allocated
+ *
+ * @param max_kni_ifaces
+ *  The maximum number of KNI interfaces that can coexist concurrently
+ */
+extern void rte_kni_init(unsigned int max_kni_ifaces);
+
+
 /**
  * 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.
  *
+ * The rte_kni_alloc shall not be called before rte_kni_init() has been
+ * called. rte_kni_alloc is thread safe.
+ *
  * @param pktmbuf_pool
  *  The mempool for allocting mbufs for packets.
  * @param conf
@@ -110,35 +128,13 @@ 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
- *  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) \
-                                     __attribute__ ((deprecated));
-
 /**
  * Release KNI interface according to the context. It will also release the
  * paired KNI interface in kernel space. All processing on the specific KNI
  * context need to be stopped before calling this interface.
  *
+ * rte_kni_release is thread safe.
+ *
  * @param kni
  *  The pointer to the context of an existent KNI interface.
  *
@@ -200,21 +196,6 @@ extern unsigned rte_kni_rx_burst(struct rte_kni *kni,
 extern unsigned rte_kni_tx_burst(struct rte_kni *kni,
                struct rte_mbuf **mbufs, unsigned num);
 
-/**
- * Get the port id from KNI interface.
- *
- * Note: It is deprecated and just for backward compatibility.
- *
- * @param kni
- *  The KNI interface context.
- *
- * @return
- *  On success: The port id.
- *  On failure: ~0x0
- */
-extern uint8_t rte_kni_get_port_id(struct rte_kni *kni) \
-                               __attribute__ ((deprecated));
-
 /**
  * Get the KNI context of its name.
  *
@@ -228,19 +209,14 @@ extern uint8_t rte_kni_get_port_id(struct rte_kni *kni) \
 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.
+ * Get the name given to a KNI device
  *
+ * @param kni
+ *   The KNI instance to query
  * @return
- *  On success: Pointer to KNI interface.
- *  On failure: NULL
+ *   The pointer to the KNI name
  */
-extern struct rte_kni *rte_kni_info_get(uint8_t port_id) \
-                               __attribute__ ((deprecated));
+extern const char *rte_kni_get_name(const struct rte_kni *kni);
 
 /**
  * Register KNI request handling for a specified port,and it can
@@ -271,12 +247,7 @@ extern int rte_kni_register_handlers(struct rte_kni *kni,
 extern int rte_kni_unregister_handlers(struct rte_kni *kni);
 
 /**
- *  close KNI device.
- *
- *  @param void
- *
- *  @return
- *   void
+ *  Close KNI device.
  */
 extern void rte_kni_close(void);
 
@@ -285,4 +256,3 @@ extern void rte_kni_close(void);
 #endif
 
 #endif /* _RTE_KNI_H_ */
-