Hi, On Thu, Jun 27, 2019 at 09:38:16AM -0700, Florian Fainelli wrote: > On 6/27/19 3:15 AM, Benedikt Spranger wrote: > > Document the different needs of documentation for the b53 driver. > > > > Signed-off-by: Benedikt Spranger <b.spran...@linutronix.de> > > --- > > Documentation/networking/dsa/b53.rst | 300 +++++++++++++++++++++++++++ > > 1 file changed, 300 insertions(+) > > create mode 100644 Documentation/networking/dsa/b53.rst > > > > diff --git a/Documentation/networking/dsa/b53.rst > > b/Documentation/networking/dsa/b53.rst > > new file mode 100644 > > index 000000000000..5838cf6230da > > --- /dev/null > > +++ b/Documentation/networking/dsa/b53.rst > > @@ -0,0 +1,300 @@ > > +.. SPDX-License-Identifier: GPL-2.0 > > + > > +========================================== > > +Broadcom RoboSwitch Ethernet switch driver > > +========================================== > > + > > +The Broadcom RoboSwitch Ethernet switch family is used in quite a range of > > +xDSL router, cable modems and other multimedia devices. > > + > > +The actual implementation supports the devices BCM5325E, BCM5365, BCM539x, > > +BCM53115 and BCM53125 as well as BCM63XX. > > + > > +Implementation details > > +====================== > > + > > +The driver is located in ``drivers/net/dsa/bcm_sf2.c`` and is implemented > > as a > > +DSA driver; see ``Documentation/networking/dsa/dsa.rst`` for details on the > > +subsystemand what it provides. > > The driver is under drivers/net/dsa/b53/ > > s/ethernet/Ethernet/ for your global submission. > > What you are describing is not entirely specific to the B53 driver > (maybe with the exception of having a VLAN tag on the DSA master network > device, since B53 puts the CPU port tagged in all VLANs by default), and > therefore the entire document should be written with the general DSA > devices in mind, and eventually pointing out where B53 differs in a > separate document.
That's true. It makes sense to split the documentation into a generic and the b53 specific part. Thanks a lot, Bene, for doing this. It's really helpful. Thanks, Kurt
signature.asc
Description: PGP signature
