kni: minor changes

Signed-off-by: Intel

1 files changed, 22 insertions, 22 deletions

diff --git a/lib/librte_kni/rte_kni.h b/lib/librte_kni/rte_kni.h
index 375e882..e3a2547 100644
--- a/lib/librte_kni/rte_kni.h
+++ b/lib/librte_kni/rte_kni.h
@@ -79,19 +79,19 @@ struct rte_kni_ops {
  *  The mbuf size to store a packet.
  *
  * @return
- *  - The pointer to the context of a kni interface.
+ *  - 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);
 
 /**
- * Release kni interface according to the context. It will also release the
- * paired KNI interface in kernel space. All processing on the specific kni
+ * 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.
  *
  * @param kni
- *  The pointer to the context of an existant kni interface.
+ *  The pointer to the context of an existant KNI interface.
  *
  * @return
  *  - 0 indicates success.
@@ -105,22 +105,22 @@ extern int rte_kni_release(struct rte_kni *kni);
  * Finally constructs the response mbuf and puts it back to the resp_q.
  *
  * @param kni
- *  The pointer to the context of an existant kni interface.
+ *  The pointer to the context of an existant KNI interface.
  *
  * @return
- *  - 0
+ *  - 0 
  *  - negative value indicates failure.
  */
 extern int rte_kni_handle_request(struct rte_kni *kni);
 
 /**
- * Retrieve a burst of packets from a kni interface. The retrieved packets are
+ * Retrieve a burst of packets from a KNI interface. The retrieved packets are
  * stored in rte_mbuf structures whose pointers are supplied in the array of
  * mbufs, and the maximum number is indicated by num. It handles the freeing of
- * the mbufs in the free queue of kni interface.
+ * the mbufs in the free queue of KNI interface.
  *
  * @param kni
- *  The kni interface context.
+ *  The KNI interface context.
  * @param mbufs
  *  The array to store the pointers of mbufs.
  * @param num
@@ -133,13 +133,13 @@ extern unsigned rte_kni_rx_burst(struct rte_kni *kni,
 		struct rte_mbuf **mbufs, unsigned num);
 
 /**
- * Send a burst of packets to a kni interface. The packets to be sent out are
+ * Send a burst of packets to a KNI interface. The packets to be sent out are
  * stored in rte_mbuf structures whose pointers are supplied in the array of
  * mbufs, and the maximum number is indicated by num. It handles allocating
- * the mbufs for kni interface alloc queue.
+ * the mbufs for KNI interface alloc queue.
  *
  * @param kni
- *  The kni interface context.
+ *  The KNI interface context.
  * @param mbufs
  *  The array to store the pointers of mbufs.
  * @param num
@@ -152,10 +152,10 @@ extern unsigned rte_kni_tx_burst(struct rte_kni *kni,
 		struct rte_mbuf **mbufs, unsigned num);
 
 /**
- * Get the port id from kni interface.
+ * Get the port id from KNI interface.
  *
  * @param kni
- *  The kni interface context.
+ *  The KNI interface context.
  *
  * @return
  *  On success: The port id.
@@ -164,23 +164,23 @@ extern unsigned rte_kni_tx_burst(struct rte_kni *kni,
 extern uint8_t rte_kni_get_port_id(struct rte_kni *kni);
 
 /**
- * Get kni context information of the port.  
+ * Get the KNI context of the specific port.
  *
- * @port_id
+ * @param port_id
  *  the port id.
  *
  * @return 
- *  On success: Pointer to kni interface.
+ *  On success: Pointer to KNI interface.
  *  On failure: NULL
  */
 extern struct rte_kni * rte_kni_info_get(uint8_t port_id);
 
 /**
- * Register kni request handling for a specified port,and it can
+ * Register KNI request handling for a specified port,and it can
  * be called by master process or slave process.
  *
  * @param kni 
- *  pointer to struct rte_kni.
+ *  pointer to struct rte_kni. 
  * @param ops 
  *  ponter to struct rte_kni_ops.
  *
@@ -192,10 +192,10 @@ extern int rte_kni_register_handlers(struct rte_kni *kni,
 			struct rte_kni_ops *ops);
 
 /**
- *  Unregister kni request handling for a specified port.
+ *  Unregister KNI request handling for a specified port.
  * 
- *  @param kni
- *   pointer to struct rte_kni.
+ *  @param kni 
+ *   pointer to struct rte_kni. 
  *
  *  @return
  *   On success: 0