Add subinterface documentation

Signed-off-by: Eli Cohen <eli@mellanox.co.il>

diff --git a/ipoib_release_notes.txt b/ipoib_release_notes.txt
index bab4c038d23b20a102a355e01e072ad47f0cba7e..b53f4487171e3c604fd52d09c5a620c3093ad8b7 100644 (file)
--- a/ipoib_release_notes.txt
+++ b/ipoib_release_notes.txt
@@ -11,12 +11,13 @@ Table of Contents
 2. Known Issues
 3. DHCP Support of IPoIB
 4. The ib-bonding driver
-5. Bug Fixes and Enhancements Since OFED 1.3
-6. Bug Fixes and Enhancements Since OFED 1.3.1
-7. Bug Fixes and Enhancements Since OFED 1.4
-8. Bug Fixes and Enhancements Since OFED 1.4.2
-9. Bug Fixes and Enhancements Since OFED 1.5.0
-10. Performance tuning
+5. Child interfaces
+6. Bug Fixes and Enhancements Since OFED 1.3
+7. Bug Fixes and Enhancements Since OFED 1.3.1
+8. Bug Fixes and Enhancements Since OFED 1.4
+9. Bug Fixes and Enhancements Since OFED 1.4.2
+10. Bug Fixes and Enhancements Since OFED 1.5.0
+11. Performance tuning
 
 ===============================================================================
 1. Overview
@@ -311,7 +312,60 @@ Notes:
 
 
 ===============================================================================
-5. Bug Fixes and Enhancements Since OFED 1.3
+5. Child interfaces
+===============================================================================
+
+5.1 Subinterfaces
+
+You can create subinterfaces for a primary IPoIB interface to provide traffic
+isolation. Each such subinterface (also called a child interface) has a
+different IP and network addresses from the primary (parent) interface. The
+default Partition Key (PKey), ff:ff, applies to the primary (parent) interface.
+
+5.1.1 Creating a Subinterface
+
+To create a child interface (subinterface), follow this procedure:
+Note: In the following procedure, ib0 is used as an example of an IB
+subinterface.
+
+Step 1. Decide on the PKey to be used in the subnet. Valid values are 0-255.
+The actual PKey used is a 16-bit number with the most significant bit set. For
+example, a value of 0 will give a PKey with the value 0x8000.
+
+Step 2. Create a child interface by running:
+host1$ echo <PKey> > /sys/class/net/<IB subinterface>/create_child
+Example:
+host1$ echo 0 > /sys/class/net/ib0/create_child
+This will create the interface ib0.8000.
+
+Step 3. Verify the configuration of this interface by running:
+Using the example of Step 2:
+host1$ ifconfig ib0.8000
+ib0.8000 Link encap:UNSPEC HWaddr 80-00-00-4A-FE-80-00-00-00-00-
+00-00-00-00-00-00
+BROADCAST MULTICAST MTU:2044 Metric:1
+RX packets:0 errors:0 dropped:0 overruns:0 frame:0
+TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+collisions:0 txqueuelen:128
+RX bytes:0 (0.0 b) TX bytes:0 (0.0 b)
+
+Step 4. As can be seen, the interface does not have IP or network addresses so
+it needs to be configured.
+
+Step 5. To be able to use this interface, a configuration of the Subnet Manager is needed so that
+the PKey chosen, which defines a broadcast address, be recognized.
+
+5.1.2 Removing a Subinterface
+To remove a child interface (subinterface), run:
+echo <subinterface PKey> /sys/class/net/<ib_interface>/delete_child
+Using the example of Step 2:
+echo 0x8000 > /sys/class/net/ib0/delete_child
+Note that when deleting the interface you must use the PKey value with the most
+significant bit set (e.g., 0x8000 in the example above).
+
+
+===============================================================================
+6. Bug Fixes and Enhancements Since OFED 1.3
 ===============================================================================
 - There is no default configuration for IPoIB interfaces: One should manually
   specify the full IP configuration or use the ofed_net.conf file. See
@@ -331,7 +385,7 @@ Notes:
   documentation for details)
 
 ===============================================================================
-6. Bug Fixes and Enhancements Since OFED 1.3.1
+7. Bug Fixes and Enhancements Since OFED 1.3.1
 ===============================================================================
 - IPoIB: Refresh paths instead of flushing them on SM change events to improve 
   failover respond
@@ -341,7 +395,7 @@ Notes:
 - Bonding: Set default number of grat. ARP after failover to three (was one)
 
 ===============================================================================
-7. Bug Fixes and Enhancements Since OFED 1.4
+8. Bug Fixes and Enhancements Since OFED 1.4
 ===============================================================================
 - Performance tuning is enabled by default for IPOIB CM.
 - Clear IPOIB_FLAG_ADMIN_UP if ipoib_open fails 
@@ -356,7 +410,7 @@ Notes:
 
   
 ===============================================================================
-8. Bug Fixes and Enhancements Since OFED 1.4.2
+9. Bug Fixes and Enhancements Since OFED 1.4.2
 ===============================================================================
 
 - Check that the format of multicast link addresses is correct before taking
@@ -374,7 +428,7 @@ Notes:
   The fix is to set ipoib_neigh->dgid to zero in ipoib_neigh_alloc().
 
 ===============================================================================
-8. Bug Fixes and Enhancements Since OFED 1.5.0
+10. Bug Fixes and Enhancements Since OFED 1.5.0
 ===============================================================================
 
 - Fix lockup of the tx queue on mixed CM/UD traffic
@@ -382,7 +436,7 @@ Notes:
   could be stopped by CM path but not re-enabled.
 
 ===============================================================================
-9. Performance tuning
+11. Performance tuning
 ===============================================================================
 When IPoIB is configured to run in connected mode, tcp parameter tuning is
 performed at driver startup -- to improve the throughput of medium and large