doc: net: Rewrite network driver documentation
authorAndre Przywara <andre.przywara@arm.com>
Mon, 25 Nov 2019 01:32:15 +0000 (01:32 +0000)
committerJoe Hershberger <joe.hershberger@ni.com>
Mon, 9 Mar 2020 23:11:24 +0000 (18:11 -0500)
commit21e4ee3c9cbbcd639ebad1bb811788804047096f
tree23f4bc8342e556b47ca90302568407adf867ab4d
parent2d5d5266e1f350082b4fd9e3d430791bf03c1974
doc: net: Rewrite network driver documentation

doc/README.drivers.eth seems like a good source for understanding
U-Boot's network subsystem, but is only talking about legacy network
drivers. This is particularly sad as proper documentation would help in
porting drivers over to the driver model.

Rewrite the document to describe network drivers in the new driver model
world. Most driver callbacks/methods are almost identical in their
semantic, but recv() differs in some important details.

Also keep some parts of the original text at the end, to help
understanding old drivers. Add some hints on how to port drivers over.

This also uses the opportunity to reformat the document in reST, on the
way moving it into doc/driver-model and adding it into the structure
there.

Signed-off-by: Andre Przywara <andre.przywara@arm.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
Acked-by: Joe Hershberger <joe.hershberger@ni.com>
doc/README.drivers.eth [deleted file]
doc/driver-model/ethernet.rst [new file with mode: 0644]
doc/driver-model/index.rst