Skip to contentSkip to conversation

doc: add kni changes to release note

PATCH Superseded Dan Gora 3 participants 6 messages Nov 5, 2018 – Nov 18, 2018

lore
Share & tools
lore

Dan Gora

author
#0 lore raw

PATCH 1/1 doc: add kni changes to release note

Add the new module parameter for the KNI kernel module, the new command line flag for the KNI sample application, and the new API function 'rte_kni_update_link()' to the release note.

Signed-off-by Dan Gora <[email protected]>
---
 doc/guides/rel_notes/release_18_11.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)
doc/guides/rel_notes/release_18_11.rst +13 -0
index cfa92b8c0..43fe849db 100644
@@ -301,6 +301,16 @@ New Features
   computation to the NIST Cryptographic Algorithm Validation Program (CAVP)
   test vectors.
 
+* **Updated KNI kernel module and sample application.**
+
+  Updated the KNI kernel module with a new kernel module parameter,
+  ``carrier=[on|off]`` to allow the user to control the default carrier
+  state of KNI kernel network interfaces.
+
+  Added a new command line flag ``-m`` to the KNI sample application to
+  monitor and automatically reflect the physical NIC carrier state to the
+  KNI kernel network interface with the new ``rte_kni_update_link()`` API.
+
 
 API Changes
 -----------

@@ -362,6 +372,9 @@ API Changes
   and seen as invalid because of its state ``RTE_ETH_DEV_UNUSED``.
   This new behaviour is enabled per driver for a migration period.
 
+* kni: Added the new API function ``rte_kni_update_link()`` to allow the user
+  to set the carrier state of the KNI kernel network interface.
+
 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
   support MAC changes once the port has started and with this new device
Signature · 1 line
2.19.0
#1 lore raw
Quoted 32 lines · Dan Gora

Add the new module parameter for the KNI kernel module, the new command line flag for the KNI sample application, and the new API function 'rte_kni_update_link()' to the release note.

Signed-off-by Dan Gora <[email protected]>
---
 doc/guides/rel_notes/release_18_11.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)
doc/guides/rel_notes/release_18_11.rst +10 -0
index cfa92b8c0..43fe849db 100644
@@ -301,6 +301,16 @@ New Features
   computation to the NIST Cryptographic Algorithm Validation Program (CAVP)
   test vectors.
 
+* **Updated KNI kernel module and sample application.**
+
+  Updated the KNI kernel module with a new kernel module parameter,
+  ``carrier=[on|off]`` to allow the user to control the default carrier
+  state of KNI kernel network interfaces.
+
+  Added a new command line flag ``-m`` to the KNI sample application to
+  monitor and automatically reflect the physical NIC carrier state to the
+  KNI kernel network interface with the new ``rte_kni_update_link()`` API.
+
 
 API Changes
 -----------

doc/guides/rel_notes/release_18_11.rst API Changes · line 377

Quoted 6 lines
doc/guides/rel_notes/release_18_11.rst +3 -0
@@ -362,6 +372,9 @@ API Changes
   and seen as invalid because of its state ``RTE_ETH_DEV_UNUSED``.
   This new behaviour is enabled per driver for a migration period.
 
+* kni: Added the new API function ``rte_kni_update_link()`` to allow the user
+  to set the carrier state of the KNI kernel network interface.
+

It is good to document new API, which can be on "new features" section above, we mostly don't document new APIs in "api changes" section, but also it is important to document behavior change too.
Now by default kni interfaces will have carrier off, and there won't be any traffic and people may get stuck, this is to help them, that is why I mentioned sysfs interface, since this patch replaces that one, can you please add those information here?

Quoted 4 lines
doc/guides/rel_notes/release_18_11.rst +0 -0
 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
   support MAC changes once the port has started and with this new device
author
#2 lore raw
Quoted 7 lines · Ferruh Yigit

doc/guides/rel_notes/release_18_11.rst API Changes · line 377

Quoted 3 lines
doc/guides/rel_notes/release_18_11.rst +3 -0
+* kni: Added the new API function ``rte_kni_update_link()`` to allow the user
+  to set the carrier state of the KNI kernel network interface.
+

It is good to document new API, which can be on "new features" section above, we mostly don't document new APIs in "api changes" section, but also it is important to document behavior change too.

That doesn't really make any sense.. APIs which are removed are documented here, why wouldn't API additions be documented there as well?

The new API function is an API change, it's not really a new DPDK "feature" like a new subsystem or something..

Quoted 4 lines

Now by default kni interfaces will have carrier off, and there won't be any traffic and people may get stuck, this is to help them, that is why I mentioned sysfs interface, since this patch replaces that one, can you please add those information here?

The sysfs trick was never really an "interface", it is/was completely external to DPDK, but I'll add a blurb about it if you think that it'll help..

author
#3 lore raw

PATCH v2 1/1 doc: add kni changes to release note

In reply to Dan Gora

Add the new module parameter for the KNI kernel module, the new command line flag for the KNI sample application, and the new API function 'rte_kni_update_link()' to the release note.

Signed-off-by Dan Gora <[email protected]>
---
 doc/guides/rel_notes/release_18_11.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
doc/guides/rel_notes/release_18_11.rst +19 -0
index cfa92b8c0..9486faa1f 100644
@@ -301,6 +301,25 @@ New Features
   computation to the NIST Cryptographic Algorithm Validation Program (CAVP)
   test vectors.
 
+* **Updated KNI kernel module, rte_kni library, and KNI sample application.**
+
+  Updated the KNI kernel module with a new kernel module parameter,
+  ``carrier=[on|off]`` to allow the user to control the default carrier
+  state of KNI kernel network interfaces.  The default carrier state
+  is now set to ``off``, so the interfaces cannot be used until the
+  carrier state is set to ``on`` via ``rte_kni_update_link`` or
+  by writing ``1`` to ``/sys/devices/virtual/net/<iface>/carrier``.
+  In previous versions the default carrier state was left undefined.
+  See :doc:`../prog_guide/kernel_nic_interface` for more information.
+
+  Added the new API function ``rte_kni_update_link`` to allow the user
+  to set the carrier state of the KNI kernel network interface.
+
+  Added a new command line flag ``-m`` to the KNI sample application to
+  monitor and automatically reflect the physical NIC carrier state to the
+  KNI kernel network interface with the new ``rte_kni_update_link`` API.
+  See :doc:`../sample_app_ug/kernel_nic_interface` for more information.
+
 
 API Changes
 -----------
Signature · 1 line
2.19.0