i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs/develop: fix documentation generation warnings

Browse Source 
Change-Id: Ib0e17c1f7d539ed73adf1a3d57316853c7183a4c
Reviewed-on: https://review.haiku-os.org/c/haiku/+/11249
Reviewed-by: waddlesplash <[email protected]>
Haiku-Format: Haiku-format Bot <[email protected]>
Tested-by: Commit checker robot <[email protected]>
This commit is contained in:
PulkoMandy
2026-07-09 06:50:41 +00:00
committed by Adrien Destugues
parent 7a51fa68c4
commit eb349566e3
2 changed files with 11 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/develop/busses/sdhci/sdhci_mmc_driver.rst
+9 -12
View File
@@ -98,7 +98,7 @@ Insight into the code and future tasks
-------------------------------------- --------------------------------------
MMC Bus drivers (src/add-ons/kernel/busses/mmc) MMC Bus drivers (src/add-ons/kernel/busses/mmc)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The bus driver provides the low level aspects: interrupts management, The bus driver provides the low level aspects: interrupts management,
DMA transfer, accessing the hardware registers. It acts as a platform DMA transfer, accessing the hardware registers. It acts as a platform
@@ -122,7 +122,7 @@ then work independently of each other. This setup seems pretty uncommon
in real hardware, however. in real hardware, however.
The Bus Manager (src/add-ons/kernel/bus_managers/mmc) The Bus Manager (src/add-ons/kernel/bus_managers/mmc)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The bus manager is responsible for enumerating devices on the bus, The bus manager is responsible for enumerating devices on the bus,
assigning them addresses, and keeping track of which card is active at assigning them addresses, and keeping track of which card is active at
@@ -133,14 +133,14 @@ multiple MMC devices, as well as things that are not specific to a
device type (common to SDIO, SD and MMC cards, for example) device type (common to SDIO, SD and MMC cards, for example)
Disk Driver (src/add-ons/kernel/drivers/disk/mmc) Disk Driver (src/add-ons/kernel/drivers/disk/mmc)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is a mass storage driver for MMC, SD and SDHC cards. Currently only This is a mass storage driver for MMC, SD and SDHC cards. Currently only
SD and SDHC are tested, MMC and eMMC will have to be added (they are SD and SDHC are tested, MMC and eMMC will have to be added (they are
similar but there are some differences). similar but there are some differences).
Wiring the driver in the device manager (src/system/kernel/device_manager/device_manager.cpp) Wiring the driver in the device manager (src/system/kernel/device_manager/device_manager.cpp)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
(note: possibly not accurate documentation, I did not check how things (note: possibly not accurate documentation, I did not check how things
in the device manager are actually implemented, but this is my in the device manager are actually implemented, but this is my
@@ -165,11 +165,8 @@ non-standard ones (for example, Ricoh provides SDHCI implenmentations
that are conform to the spec, except they don’t have the right device that are conform to the spec, except they don’t have the right device
type in the PCI registers). type in the PCI registers).
Insight into the code
~~~~~~~~~~~~~~~~~~~~~
MMC Bus management overview MMC Bus management overview
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ---------------------------
The device tree for MMC support looks like this: The device tree for MMC support looks like this:
@@ -217,7 +214,7 @@ could be added if sending raw SD/MMC commands to SD cards from userland
is considered desirable. is considered desirable.
SDHCI driver SDHCI driver
^^^^^^^^^^^^ ~~~~~~~~~~~~
The SDHCI driver is the lowest level of the MMC stack. It provides The SDHCI driver is the lowest level of the MMC stack. It provides
abstraction of the SDHCI device. Later on, different way to access an SD abstraction of the SDHCI device. Later on, different way to access an SD
@@ -247,7 +244,7 @@ SDHCI level. It will be responsible for executing SD commands on that
bus, and dealing with the resulting interrupts. bus, and dealing with the resulting interrupts.
The Bus Manager The Bus Manager
^^^^^^^^^^^^^^^ ~~~~~~~~~~~~~~~
The MMC bus manager manages the MMC bus (duh). Its tasks are: The MMC bus manager manages the MMC bus (duh). Its tasks are:
@@ -260,7 +257,7 @@ The MMC bus manager manages the MMC bus (duh). Its tasks are:
- publish device nodes for each card - publish device nodes for each card
Disk Driver Disk Driver
^^^^^^^^^^^ ~~~~~~~~~~~
The disk driver is attached to devices implementing SDSC or SDHC/SDXC The disk driver is attached to devices implementing SDSC or SDHC/SDXC
commands. There will be other drivers for non-storage (SDIO) cards. commands. There will be other drivers for non-storage (SDIO) cards.
@@ -276,7 +273,7 @@ the usual interface for disk devices. From this point on, the device can
be used just like any other mass storage device. be used just like any other mass storage device.
Tasks to be completed Tasks to be completed
~~~~~~~~~~~~~~~~~~~~~ ---------------------
The SDHCI driver is able to send and receive commands. However it does The SDHCI driver is able to send and receive commands. However it does
not handle card insertion and removal interrupts yet, so the card must not handle card insertion and removal interrupts yet, so the card must
docs/develop/debugging/optimizing_applications.rst
+2 -2
View File
@@ -24,7 +24,7 @@ This is basically a three steps process:
Measure Measure
------- -------
profile is a `sample-based profiler<https://nikhilism.com/post/2018/sampling-profiler-internals-introduction/>`_: this tool stops the measured process at regular intervals, and looks at the call stack at this point. The more you stop in a specified function, the more likely this function eats CPU. profile is a `sample-based profiler <https://nikhilism.com/post/2018/sampling-profiler-internals-introduction/>`_: this tool stops the measured process at regular intervals, and looks at the call stack at this point. The more you stop in a specified function, the more likely this function eats CPU.
All data is consolidated and written in the output directory. All data is consolidated and written in the output directory.
@@ -53,7 +53,7 @@ More options in profile are available. See profile --help
Tips Tips
---- ----
Haiku is mainly written in C++. Function names in C++ binaries are encoded using a specific scheme. This process is called `mangling<https://en.wikipedia.org/wiki/Name_mangling>`_. Haiku is mainly written in C++. Function names in C++ binaries are encoded using a specific scheme. This process is called `mangling <https://en.wikipedia.org/wiki/Name_mangling>`_.
In order to have more readable functions name in the analysis, you can use C++filt to pre-process result’s files. In order to have more readable functions name in the analysis, you can use C++filt to pre-process result’s files.
:: ::