u-boot-brain/doc/driver-model/index.rst
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

24 lines
309 B
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0+
Driver Model
============
.. toctree::
:maxdepth: 2
debugging
design
ethernet
fdt-fixup
fs_firmware_loader
i2c-howto
livetree
migration
of-plat
pci-info
pmic-framework
remoteproc-framework
serial-howto
spi-howto
usb-info