git: bc433a0b7b04 - main - sdhci.4: Improve HARDWARE for HW Relnotes + SPDX

The branch main has been updated by ziaee:

URL: https://cgit.FreeBSD.org/src/commit/?id=bc433a0b7b046b0412777e0f3cc8f18a233af8ff

commit bc433a0b7b046b0412777e0f3cc8f18a233af8ff
Author:     Warner Losh <imp@FreeBSD.org>
AuthorDate: 2025-10-03 13:49:32 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2025-10-03 14:35:27 +0000

    sdhci.4: Improve HARDWARE for HW Relnotes + SPDX
    
    MFC after:              1 hr
    Discussed with:         ivy, olce
    Co-authored-by:         ziaee (typed up imps suggestion, tagged spdx)
    Differential Revision:  https://reviews.freebsd.org/D52860
---
 share/man/man4/sdhci.4 | 44 ++++++++++++++++++++++++--------------------
 1 file changed, 24 insertions(+), 20 deletions(-)

diff --git a/share/man/man4/sdhci.4 b/share/man/man4/sdhci.4
index 4a4e02539acd..1608d9c2fe1a 100644
--- a/share/man/man4/sdhci.4
+++ b/share/man/man4/sdhci.4
@@ -1,4 +1,6 @@
 .\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
 .\" Copyright (c) 2008 Alexander Motin <mav@FreeBSD.org>
 .\" All rights reserved.
 .\"
@@ -22,7 +24,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd August 25, 2020
+.Dd October 3, 2025
 .Dt SDHCI 4
 .Os
 .Sh NAME
@@ -56,21 +58,28 @@ detaches it on card removing.
 .Sh HARDWARE
 The
 .Nm
-driver supports different specification compatible chips.
-The following chips have been verified to work:
+driver supports the SD Host Controller Specification.
+When attaching via the PCI bus,
+the controller is automatically configured.
+Many SoC chips provide a SDHCI controller directly mapped to I/O memory.
+For those, the controller may be configured using
+.Xr fdt 4
+or
+.Xr acpi 4
+methods, supplied by your board's vendor.
 .Pp
-.Bl -bullet -compact
-.It
-ENE CB712
-.It
-ENE CB714
-.It
-RICOH R5C822
-.It
-RICOH R5CE823
-.It
-TI PCIXX21/XX11/XX12
-.El
+Unlike most other drivers that support a generic standard,
+.Nm
+requires a large number of quirks to cope with hardware bugs,
+proprietary registers and poorly specified power management.
+While many chipsets from
+Intel, Xilinx, Rockchip, Frescale, Ricoh, and TI have these entries,
+suboptimal performance may result when using some controllers.
+Quirks and custom configuration are most often required
+when the device is configured via
+.Xr fdt 4
+or
+.Xr acpi 4 .
 .Sh SEE ALSO
 .Xr mmc 4 ,
 .Xr mmcsd 4
@@ -79,8 +88,3 @@ TI PCIXX21/XX11/XX12
 .Re
 .Sh AUTHORS
 .An Alexander Motin Aq Mt mav@FreeBSD.org
-.Sh BUGS
-Many of existing SD controller chips have some nonstandard requirements,
-proprietary registers and hardware bugs, requiring additional handling.
-ENE chips are handled to work fine, while some revisions of RICOH and TI
-controllers still do not see cards without some additional initialization.