Mirrors/u-boot
2
0
Fork 0
mirror of https://github.com/AsahiLinux/u-boot synced 2025-03-03 23:07:12 +00:00
Code Issues Projects Releases Packages Wiki Activity
u-boot/doc/develop/driver-model/index.rst

32 lines
507 B
ReStructuredText
Raw Normal View History

doc: Add driver-model to Sphinx TOC tree Add index.rst for driver model. More docs will be added later. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glkpk@gmx.de>
2019-07-18 00:33:48 -07:00
.. SPDX-License-Identifier: GPL-2.0+
Driver Model
============
doc: Move driver model docs under develop/ These docs are useful for developers, not users. Move them under that section. Suggested-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Signed-off-by: Simon Glass <sjg@chromium.org>
2021-03-18 20:25:12 +13:00
The following holds information on the U-Boot device driver framework:
driver-model, including the design details of itself and several driver
subsystems
doc: Add driver-model to Sphinx TOC tree Add index.rst for driver model. More docs will be added later. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glkpk@gmx.de>
2019-07-18 00:33:48 -07:00
.. toctree::
:maxdepth: 2
doc: driver-model: Convert README.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2019-07-18 00:33:49 -07:00
doc: add bind/unbind command documentation Add documentation in doc/drivel-model for the bind/unbind command. Part of this documentation is extracted from original patch commit message: commit 49c752c93a78 ("cmd: Add bind/unbind commands to bind a device to a driver from the command line") Signed-off-by: Patrice Chotard <patrice.chotard@st.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2020-07-28 09:13:35 +02:00
bind
dm: core: Add documentation on how to debug driver model Sometimes devices don't appear and it can be confusing. Add a few notes to help with this situation. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com> Tested-by: Bin Meng <bmeng.cn@gmail.com> [bmeng: fix 2 issues in the doc and include the doc in the index.rst] Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-09-25 08:55:48 -06:00
debugging
doc: driver-model: Convert README.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2019-07-18 00:33:49 -07:00
design
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>
2019-11-25 01:32:15 +00:00
ethernet
doc: driver-model: Convert fdt-fixup.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-07-18 00:33:51 -07:00
fdt-fixup
doc: driver-model: Convert fs_firmware_loader.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-07-18 00:33:52 -07:00
fs_firmware_loader
doc: driver-model: Convert i2c-howto.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-07-18 00:33:53 -07:00
i2c-howto
doc: driver-model: Convert livetree.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-07-18 00:33:54 -07:00
livetree
doc: driver-model: Convert MIGRATION.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2019-07-18 00:33:50 -07:00
migration
doc: develop: Convert README.nvme to reST This converts the existing README.nvme to reST, and puts it under the develop/driver-model/ directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2021-06-22 21:16:22 +08:00
nvme
doc: driver-model: Convert of-plat.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-07-18 00:33:55 -07:00
of-plat
doc: driver-model: Convert pci-info.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-07-18 00:33:56 -07:00
pci-info
doc: driver-model: Convert pmic-framework.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-07-18 00:33:57 -07:00
pmic-framework
doc: driver-model: Convert remoteproc-framework.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-07-18 00:33:58 -07:00
remoteproc-framework
doc: driver-model: Convert serial-howto.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-07-18 00:33:59 -07:00
serial-howto
doc: Add new doc for soc ID driver model Add a new documentation file for UCLASS_SOC and its usage to describe the SoC Device ID framework that allows SoC identification and device data matching. Signed-off-by: Dave Gerlach <d-gerlach@ti.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2020-07-15 23:39:56 -05:00
soc-framework
doc: driver-model: Convert spi-howto.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-07-18 00:34:00 -07:00
spi-howto
doc: driver-model: Convert usb-info.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-07-18 00:34:01 -07:00
usb-info
doc: develop: Convert README.virtio to reST This converts the existing README.virtio to reST, and puts it under the develop/driver-model/ directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2021-04-29 17:40:07 +08:00
virtio
Reference in a new issue Copy permalink