Re: [PATCH net-next v7 24/24] switchdev: bring documentation up-to-date

[Jiri Pirko <jiri@resnulli.us>]

Sun, May 10, 2015 at 06:48:09PM CEST, sfeldma@gmail.com wrote:
>From: Scott Feldman <sfeldma@gmail.com>
>
>Much need updated of switchdev documentation to cover what's been
>implmented to-date.  There are some XXX comments in the text for
>unimplemented or broken items.  I'd like to keep these in there (poor-man's
>TODO list) and update the document once each issue is resolved.
>
>Signed-off-by: Scott Feldman <sfeldma@gmail.com>
>---

...

>+
>+Figure 1 is a block diagram showing the components of the switchdev model for
>+an example setup using a data-center-class switch ASIC chip.  Other setups
>+with SR-IOV or soft switches, such as OVS, are possible.
>+
>+
>+                             User-space tools                                 
>+                                                                              
>+       user space                   |                                         
>+      +-------------------------------------------------------------------+   
>+       kernel                       | Netlink                                 
>+                                    |                                         
>+                     +--------------+-------------------------------+         
>+                     |         Network stack                        |         
>+                     |           (Linux)                            |         
>+                     |                                              |         
>+                     +----------------------------------------------+         
>+                                                                              
>+                           sw1p2     sw1p4     sw1p6
>+                      sw1p1  +  sw1p3  +  sw1p5  +          eth1             
>+                        +    |    +    |    +    |            +               
>+                        |    |    |    |    |    |            |               
>+                     +--+----+----+----+-+--+----+---+  +-----+-----+         
>+                     |         Switch driver         |  |    mgmt   |         
>+                     |        (this document)        |  |   driver  |         
>+                     |                               |  |           |         
>+                     +--------------+----------------+  +-----------+         
>+                                    |                                         
>+       kernel                       | HW bus (eg PCI)                         
>+      +-------------------------------------------------------------------+   
>+       hardware                     |                                         
>+                     +--------------+---+------------+                        
>+                     |         Switch device (sw1)   |                        
>+                     |  +----+                       +--------+               
>+                     |  |    v offloaded data path   | mgmt port              
>+                     |  |    |                       |                        
>+                     +--|----|----+----+----+----+---+                        

Seeing this offloaded data path seems a bit confusing to me. I thought
that this is example setup.



>+                        |    |    |    |    |    |                            
>+                        +    +    +    +    +    +                            
>+                       p1   p2   p3   p4   p5   p6
>+                                       
>+                             front-panel ports                                
>+                                                                              
>+
>+                                    Fig 1.

...

>+Port Netdev Naming
>+^^^^^^^^^^^^^^^^^^
>+
>+Udev rules should be used for port netdev naming, using some unique attribute
>+of the port as a key, for example the port MAC address or the port PHYS name.
>+Hard-coding of kernel netdev names within the driver is discouraged; let the
>+kernel pick the default netdev name, and let udev set the final name based on a
>+port attribute.
>+
>+Using port PHYS name (ndo_get_phys_port_name) for the key is particularly
>+useful for dynically-named ports where the device names it's ports based on
             ^^^^^^^^^ typo                               ^^^^ "its"?



other than that:

Acked-by: Jiri Pirko <jiri@resnulli.us>

Thanks for all your work Scott. I owe you a set of beers ;)