u-boot-brain/doc/driver-model
Andre Przywara 21e4ee3c9c 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>
2020-03-09 18:11:24 -05:00
..
debugging.rst doc: dm: debugging: Fix the steps for activating debug 2020-02-05 19:33:46 -07:00
design.rst dm: fix design.rst document 2020-02-10 22:14:18 -05:00
ethernet.rst doc: net: Rewrite network driver documentation 2020-03-09 18:11:24 -05:00
fdt-fixup.rst doc: driver-model: Convert fdt-fixup.txt to reST 2019-07-24 10:07:24 -04:00
fs_firmware_loader.rst doc: driver-model: Convert fs_firmware_loader.txt to reST 2019-07-24 10:07:24 -04:00
i2c-howto.rst doc: driver-model: Convert i2c-howto.txt to reST 2019-07-24 10:07:24 -04:00
index.rst doc: net: Rewrite network driver documentation 2020-03-09 18:11:24 -05:00
livetree.rst doc: driver-model: Convert livetree.txt to reST 2019-07-24 10:07:24 -04:00
migration.rst dm: MIGRATION: Add migration plan for CONFIG_DM 2019-09-19 12:54:30 -04:00
of-plat.rst dm: doc: Add a note about of-platdata and header files 2019-12-15 11:44:22 +08:00
pci-info.rst pci: Correct 'specifified' and 'Plese' typos 2019-10-08 13:57:42 +08:00
pmic-framework.rst doc: driver-model: Convert pmic-framework.txt to reST 2019-07-24 10:07:24 -04:00
remoteproc-framework.rst doc: driver-model: Convert remoteproc-framework.txt to reST 2019-07-24 10:07:24 -04:00
serial-howto.rst doc: driver-model: Convert serial-howto.txt to reST 2019-07-24 10:07:24 -04:00
spi-howto.rst dm: spi: Change cs_info op to return -EINVAL for invalid cs num 2019-10-25 00:48:31 +05:30
usb-info.rst doc: driver-model: Convert usb-info.txt to reST 2019-07-24 10:07:24 -04:00