diff options
| author | Andre Przywara <andre.przywara@arm.com> | 2019-11-25 01:32:15 +0000 |
|---|---|---|
| committer | Joe Hershberger <joe.hershberger@ni.com> | 2020-03-09 18:11:24 -0500 |
| commit | 21e4ee3c9cbbcd639ebad1bb811788804047096f (patch) | |
| tree | 23f4bc8342e556b47ca90302568407adf867ab4d /doc/driver-model/index.rst | |
| parent | 2d5d5266e1f350082b4fd9e3d430791bf03c1974 (diff) | |
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>
Diffstat (limited to 'doc/driver-model/index.rst')
| -rw-r--r-- | doc/driver-model/index.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/driver-model/index.rst b/doc/driver-model/index.rst index 6d55774b4c..b9df221627 100644 --- a/doc/driver-model/index.rst +++ b/doc/driver-model/index.rst @@ -8,6 +8,7 @@ Driver Model debugging design + ethernet fdt-fixup fs_firmware_loader i2c-howto |