GitHub-Mirror/u-boot
2
0
Fork 0
mirror of https://github.com/Fishwaldo/u-boot.git synced 2025-06-28 09:31:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: driver-model: Convert pci-info.txt to reST

Browse source 
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>
This commit is contained in:
Bin Meng 2019-07-18 00:33:56 -07:00 • committed by Tom Rini
parent 45dbb4dd23
commit b598648947
2 changed files with 13 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/driver-model/index.rst
View file

@ -13,3 +13,4 @@ Driver Model
livetree livetree
migration migration
of-plat of-plat
pci-info

21
doc/driver-model/pci-info.txt → doc/driver-model/pci-info.rst
View file

@ -1,3 +1,5 @@
.. SPDX-License-Identifier: GPL-2.0+
PCI with Driver Model PCI with Driver Model
===================== =====================
@ -7,8 +9,7 @@ How busses are scanned
Any config read will end up at pci_read_config(). This uses Any config read will end up at pci_read_config(). This uses
uclass_get_device_by_seq() to get the PCI bus for a particular bus number. uclass_get_device_by_seq() to get the PCI bus for a particular bus number.
Bus number 0 will need to be requested first, and the alias in the device Bus number 0 will need to be requested first, and the alias in the device
tree file will point to the correct device: tree file will point to the correct device::
aliases { aliases {
pci0 = &pci; pci0 = &pci;
@ -45,7 +46,7 @@ present, matching on it takes precedence over PCI IDs and PCI classes.
Note we must describe PCI devices with the same bus hierarchy as the Note we must describe PCI devices with the same bus hierarchy as the
hardware, otherwise driver model cannot detect the correct parent/children hardware, otherwise driver model cannot detect the correct parent/children
relationship during PCI bus enumeration thus PCI devices won't be bound to relationship during PCI bus enumeration thus PCI devices won't be bound to
their drivers accordingly. A working example like below: their drivers accordingly. A working example like below::
pci { pci {
#address-cells = <3>; #address-cells = <3>;
@ -113,7 +114,7 @@ Sandbox
With sandbox we need a device emulator for each device on the bus since there With sandbox we need a device emulator for each device on the bus since there
is no real PCI bus. This works by looking in the device tree node for a is no real PCI bus. This works by looking in the device tree node for a
driver. For example: driver. For example::
pci@1f,0 { pci@1f,0 {
@ -129,11 +130,11 @@ Note that the first cell in the 'reg' value is the bus/device/function. See
PCI_BDF() for the encoding (it is also specified in the IEEE Std 1275-1994 PCI_BDF() for the encoding (it is also specified in the IEEE Std 1275-1994
PCI bus binding document, v2.1) PCI bus binding document, v2.1)
When this bus is scanned we will end up with something like this: When this bus is scanned we will end up with something like this::
`- * pci-controller @ 05c660c8, 0 `- * pci-controller @ 05c660c8, 0
`- pci@1f,0 @ 05c661c8, 63488 `- pci@1f,0 @ 05c661c8, 63488
`- emul@1f,0 @ 05c662c8 `- emul@1f,0 @ 05c662c8
When accesses go to the pci@1f,0 device they are forwarded to its child, the When accesses go to the pci@1f,0 device they are forwarded to its child, the
emulator. emulator.
@ -144,6 +145,8 @@ eliminating the need to provide any device tree node under the host controller
node. It is required a "sandbox,dev-info" property must be provided in the node. It is required a "sandbox,dev-info" property must be provided in the
host controller node for this functionality to work. host controller node for this functionality to work.
.. code-block:: none
pci1: pci-controller1 { pci1: pci-controller1 {
compatible = "sandbox,pci"; compatible = "sandbox,pci";
... ...
@ -156,7 +159,7 @@ Each dynamic PCI device is encoded as 4 cells a group. The first and second
cells are PCI device number and function number respectively. The third and cells are PCI device number and function number respectively. The third and
fourth cells are PCI vendor ID and device ID respectively. fourth cells are PCI vendor ID and device ID respectively.
When this bus is scanned we will end up with something like this: When this bus is scanned we will end up with something like this::
pci [ + ] pci_sandbo |-- pci-controller1 pci [ + ] pci_sandbo |-- pci-controller1
pci_emul [ ] sandbox_sw | |-- sandbox_swap_case_emul pci_emul [ ] sandbox_sw | |-- sandbox_swap_case_emul