Skip to content

Commit 54c476a

Browse files
committed
fix(linux): Fix vale errors and warnings in MMC docs
This fixes warnings and errors reported by vale linter for MMC docs. Signed-off-by: Judith Mendez <jm@ti.com>
1 parent 671ac99 commit 54c476a

4 files changed

Lines changed: 124 additions & 119 deletions

File tree

source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD.rst

Lines changed: 39 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. http://processors.wiki.ti.com/index.php/Linux_Core_MMC/SD_User%27s_Guide
22
3-
MMC/SD
3+
MMCSD
44
######
55

66
.. ifconfig:: CONFIG_part_family in ('AM62X_family', 'AM62PX_family')
@@ -13,17 +13,17 @@ MMC/SD
1313
Introduction
1414
************
1515

16-
The multimedia card high-speed/SDIO (MMC/SDIO) host controller provides
17-
an interface between a local host (LH) such as a microprocessor unit
18-
(MPU) or digital signal processor (DSP) and either MMC, SD® memory
19-
cards, or SDIO cards and handles MMC/SDIO transactions with minimal LH
20-
intervention.
16+
The MMCSD (Multi-Media Card Secure Digital) host controller provides
17+
an interface between a LH (local host) such as a MPU (microprocessor unit)
18+
or DSP (digital signal processor) and either eMMC (embedded Multi-Media Card),
19+
SD (Secure Digital), or SDIO (Secure Digital IO) devices. The MMCSD host
20+
controller handles MMCSD/SDIO protocol with minimal LH intervention.
2121

2222
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')
2323

24-
Main features of the MMC/SDIO host controllers:
24+
Main features of the MMCSD host controllers:
2525

26-
- Full compliance with MMC/SD command/response sets as defined in the
26+
- Full compliance with MMCSD command/response sets as defined in the
2727
Specification.
2828

2929
- Support:
@@ -36,9 +36,9 @@ intervention.
3636
- Two slave DMA channels (1 for TX, 1 for RX)
3737
- Designed for low power and programmable clock generation
3838
- Maximum operating frequency of 48MHz
39-
- MMC/SD card hot insertion and removal
39+
- MMCSD card hot insertion and removal
4040

41-
The following image shows the MMC/SD Driver Architecture:
41+
The following image shows the MMCSD Driver Architecture:
4242

4343
.. Image:: /images/Mmcsd_Driver.png
4444

@@ -248,9 +248,9 @@ Driver Configuration
248248

249249
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM335X_family', 'AM437X_family')
250250

251-
The default kernel configuration enables support for MMC/SD(built-in to kernel).
251+
The default kernel configuration enables support for MMCSD(built-in to kernel).
252252

253-
The selection of MMC/SD/SDIO driver can be modified using the linux kernel
253+
The selection of MMCSD/SDIO driver can be modified using the linux kernel
254254
configuration tool. Launch it by the following command:
255255

256256
.. code-block:: console
@@ -277,7 +277,7 @@ Driver Configuration
277277
278278
$ sudo -E make modules_install ARCH=arm INSTALL_MOD_PATH=path/to/filesystem
279279
280-
Boot the kernel upto kernel prompt and use modprobe to insert the driver
280+
Boot the kernel up-to kernel prompt and use modprobe to insert the driver
281281
module and all its dependencies.
282282

283283
.. code-block:: console
@@ -291,7 +291,7 @@ Driver Configuration
291291

292292
.. ifconfig:: CONFIG_part_family in ('J7_family', 'AM62X_family', 'AM64X_family', 'AM62AX_family', 'AM62PX_family', 'AM62LX_family')
293293

294-
The default kernel configuration enables support for MMC/SD driver as
294+
The default kernel configuration enables support for MMCSD driver as
295295
built-in to kernel. TI SDHCI driver is used. Following options need to be
296296
configured in Linux Kernel for successfully selecting SDHCI driver for
297297
|__PART_FAMILY_DEVICE_NAMES__|.
@@ -425,10 +425,10 @@ MMC support in Linux
425425

426426
|
427427
428-
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM57X_family', 'AM335X_family', 'AM437X_family')
428+
Steps for working around SD card issues in Linux
429+
************************************************
429430

430-
Steps for working around SD card issues in Linux
431-
************************************************
431+
.. ifconfig:: CONFIG_part_family not in ('General_family', 'AM57X_family', 'AM335X_family', 'AM437X_family')
432432

433433
In some cases, failures can be seen while using some SD cards:
434434

@@ -541,13 +541,18 @@ MMC support in Linux
541541
542542
sdhci2: mmc@fa20000 {
543543
544+
.. ifconfig:: CONFIG_part_family in ('General_family', 'AM57X_family', 'AM335X_family', 'AM437X_family')
545+
546+
Steps for working around SD card issues in Linux documentation is pending for |__PART_FAMILY_DEVICE_NAMES__|
547+
please reach out to: `Help e2e <https://e2e.ti.com//>`__ for additional information.
548+
544549
|
545550
546551
.. _mmc-listing-mmc-devices-linux:
547552

548553
Listing MMC devices from Linux
549554
******************************
550-
eMMC and SD cards are registered to the MMC subsystem and availiable as a block device
555+
eMMC and SD cards are registered to the MMC subsystem and available as a block device
551556
as :file:`/dev/mmcblk{n}`. To find which device index **n** corresponds to eMMC device,
552557
check which device includes :file:`mmcblk{n}boot0` and :file:`mmcblk{n}boot1`. Here,
553558
mmcblk0* is in eMMC.
@@ -566,7 +571,7 @@ mmcblk0* is in eMMC.
566571
567572
The disk partitions for each MMC device are displayed as :file:`/dev/mmcblk{n}p{x}`,
568573
to see what disk partitions exist for an eMMC device and if they are mounted, use the
569-
command :command:`lsblk`, like so:
574+
command :command:`lsblk`, such as:
570575

571576
.. code-block:: console
572577
@@ -580,7 +585,7 @@ command :command:`lsblk`, like so:
580585
`-mmcblk1p2 179:98 0 1.9G 0 part /
581586
582587
Use the :command:`mount` and :command:`umount` commands to mount and unmount disk partitions
583-
if they are formated, usally to vfat or ext4 types.
588+
if they are formatted, usually to vfat or ext4 types.
584589

585590
.. _mmc-create-partitions-in-emmc-linux:
586591

@@ -592,27 +597,27 @@ to flash the rootfs. To create disk partitions in UDA, use the :command:`fdisk`
592597
For ex: :samp:`fdisk /dev/mmcblk{n}` in which **n** is typically 0 or 1. In the example above,
593598
eMMC is :samp:`fdisk /dev/mmcblk0`.
594599

595-
For documentation on using fdisk, please go to: `fdisk how-to <https://tldp.org/HOWTO/Partition/fdisk_partitioning.html>`__.
600+
For documentation on using fdisk, go to: `fdisk how-to <https://tldp.org/HOWTO/Partition/fdisk_partitioning.html>`__.
596601

597602
**Erase eMMC UDA**
598603

599-
In Linux, before creating disk partitions, we can optionally erase eMMC UDA using :command:`dd`
604+
In Linux, before creating disk partitions, we can optionally erase eMMC UDA by using :command:`dd`
600605
command:
601606

602607
.. code-block:: console
603608
604609
root@<machine>:~# umount /dev/mmcblk0*
605610
root@<machine>:~# dd if=/dev/zero of=/dev/mmcblk0 bs=1M count=n
606611
607-
where ``n`` should be determined according the the following formula: ``count = total size UDA (bytes) / bs``.
612+
where ``n`` should be determined according to the following formula: ``count = total size UDA (bytes) / bs``.
608613

609614
.. _mmc-create-boot-partition-emmc-linux:
610615

611616
Create "boot" partition
612617
=======================
613618

614619
In this example create a "boot" partition of size 400 MiB which can be formatted to vfat type
615-
and will store the bootloader binaries.
620+
and will store the boot loader binaries.
616621

617622
.. code-block:: console
618623
@@ -655,7 +660,7 @@ and will store the bootloader binaries.
655660
Calling ioctl() to re-read partition table.
656661
Syncing disks.
657662
658-
Make sure bootable flag is set for "boot" partition, ROM may not boot from this patitition
663+
Make sure bootable flag is set for "boot" partition, ROM might not boot from this partition
659664
if bootable flag is not set.
660665

661666
.. _mmc-create-root-partition-emmc-linux:
@@ -707,7 +712,7 @@ Linux kernel Image, DTB, and the rootfs.
707712
Formatting eMMC partitions from Linux
708713
*************************************
709714

710-
After creating a partition/s, the partition can be formated with the :command:`mkfs` command.
715+
After creating a partition/s, the partition can be formatted with the :command:`mkfs` command.
711716
For ex: :samp:`mkfs -t ext4 /dev/mmcblk{n}` where **mmcblk{n}** is the MMC device with the new
712717
disk partitions to format. The general syntax for formatting disk partitions in Linux is:
713718

@@ -761,10 +766,10 @@ Flash eMMC for MMCSD boot
761766
*************************
762767

763768
In this example, we show one simple method for flashing to eMMC for MMCSD boot from
764-
eMMC UDA in FS mode. Please know this is not the only method for flashing the eMMC
765-
for this bootmode.
769+
eMMC UDA in FS mode. Know this is not the only method for flashing the eMMC for this
770+
boot mode.
766771

767-
This example assumes the current bootmode is MMCSD boot from SD (FS mode)
772+
This example assumes the current boot mode is MMCSD boot from SD (FS mode)
768773

769774
.. _mmc-flash-emmc-uda-boot:
770775

@@ -778,7 +783,7 @@ Flash to eMMC "boot" partition
778783
root@<machine>:~# mount /dev/mmcblk0p1 /mnt/eboot
779784
root@<machine>:~# mount /dev/mmcblk1p1 /mnt/sdboot
780785
781-
Verify the partitions are mounted to the correct folders using :command:`lsblk` command in the
786+
Verify the partitions are mounted to the correct folders by using :command:`lsblk` command in the
782787
column labeled :file:`MOUNTPOINTS`.
783788

784789
.. code-block:: console
@@ -794,7 +799,7 @@ column labeled :file:`MOUNTPOINTS`.
794799
|-mmcblk1p1 179:97 0 128M 0 part /mnt/sdboot
795800
`-mmcblk1p2 179:98 0 8.7G 0 part /
796801
797-
Now we can copy bootloader binaries to eMMC and umount the partitions when writes finish.
802+
Now we can copy boot loader binaries to eMMC and umount the partitions when writes finish.
798803

799804
.. code-block:: console
800805
@@ -816,7 +821,7 @@ Flash to eMMC "root" partition
816821
[69229.982452] EXT4-fs (mmcblk0p2): mounted filesystem 74d40075-07e4-4bce-9401-6fccef68e934 r/w with ordered data mode. Quota mode: none.
817822
root@<machine>:~# mount /dev/mmcblk1p2 /mnt/sdroot
818823
819-
Verify the partitions are mounted to the correct folders using :command:`lsblk` command in the
824+
Verify the partitions are mounted to the correct folders by using :command:`lsblk` command in the
820825
column labeled :file:`MOUNTPOINTS`.
821826

822827
.. code-block:: console
@@ -833,7 +838,7 @@ column labeled :file:`MOUNTPOINTS`.
833838
`-mmcblk1p2 179:98 0 8.7G 0 part /mnt/sdroot
834839
/
835840
836-
Now we can copy rootfs to eMMC (either from SD rootfs or from tarball) and umount the partitions
841+
Now we can copy rootfs to eMMC (either from SD rootfs or from tar file) and umount the partitions
837842
when writes finish.
838843

839844
**From SD**
@@ -848,7 +853,7 @@ when writes finish.
848853
root@<machine>:~# umount /mnt/*
849854
[70154.205154] EXT4-fs (mmcblk0p2): unmounting filesystem 74d40075-07e4-4bce-9401-6fccef68e934.
850855
851-
**From tarball**
856+
**From tar file**
852857

853858
This sections requires for tisdk-base-image-<soc>evm.rootfs.tar.xz to have been previously copied
854859
to the SD card rootfs.

0 commit comments

Comments
 (0)