Skip to content

Commit 6d710a2

Browse files
egilllkartben
authored andcommitted
doc: Make SD card peripheral docs more generic, fix one acronym
Fixes an issue in which "SDHC" had been incorrectly expanded to "Secure Digital High Capacity" instead of "SD Host Controller". Since this page is listed under "Peripherals" and since the SD Host Controller API is not supposed to be used by applications, the more generic and recognizable title "SD card interface" is used, and users are pointed to pages relevant to them (disk access API and SD card subsystem). Signed-off-by: Egill Sigurdur <[email protected]>
1 parent 0b2d455 commit 6d710a2

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

doc/hardware/peripherals/sdhc.rst

+18-17
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,31 @@
11
.. _sdhc_api:
22

3-
4-
Secure Digital High Capacity (SDHC)
3+
Secure Digital (SD card) interface
54
###################################
65

7-
The SDHC api offers a generic interface for interacting with an SD host
8-
controller device. It is used by the SD subsystem, and is not intended to be
9-
directly used by the application
6+
Zephyr can communicate with an attached SD card either using a system's native
7+
SD card interface or over SPI (Serial Peripheral Interface). Some devices can
8+
also communicate with MMC (MultiMediaCard) devices.
9+
10+
Applications can use Zephyr's :ref:`the disk access API <disk_access_api>`
11+
to use SD cards as storage devices, or Zephyr's SD card subsystem to
12+
directly read from and write to a card.
1013

11-
Basic Operation
12-
***************
14+
SD Host Controller (SDHC)
15+
*************************
1316

14-
SD Host Controller
15-
==================
17+
An SD host controller (SDHC) is a device capable of sending commands to an
18+
SD card. These commands can be sent using a system's native SD card interface,
19+
or over SPI.
1620

17-
An SD host controller is a device capable of sending SD commands to an attached
18-
SD card. These commands can be sent using the native SD protocol, or over SPI.
19-
Some SD host controllers are also capable of communicating with MMC devices.
20-
The SDHC api is designed to provide a generic way to send commands to and
21-
interact with attached SD devices.
21+
Applications should generally not use the SD host controller API directly,
22+
instead they should use Zephyr's SD card subsystem.
2223

2324
Requests
2425
========
2526

26-
The core of the SDHC api is the :c:func:`sdhc_request` api. Requests contain a
27-
:c:struct:`sdhc_command` command structure, and an optional
27+
The core of the SD host controller (SDHC) API is the :c:func:`sdhc_request` API.
28+
Requests contain a :c:struct:`sdhc_command` command structure, and an optional
2829
:c:struct:`sdhc_data` data structure. The caller may check the return code,
2930
or the ``response`` field of the SD command structure to determine if the
3031
SDHC request succeeded. The data structure allows the caller to specify a
@@ -35,7 +36,7 @@ command opcode provided.
3536
Host Controller I/O
3637
===================
3738

38-
The :c:func:`sdhc_set_io` api allows the user to change I/O settings of the SD
39+
The :c:func:`sdhc_set_io` API allows the user to change I/O settings of the SD
3940
host controller, such as clock frequency, I/O voltage, and card power. Not all
4041
controllers will support applying all I/O settings. For example, SPI mode
4142
controllers typically cannot toggle power to the SD card.

0 commit comments

Comments
 (0)