xref: /freebsd/share/man/man4/sdhci.4 (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
1.\"
2.\" Copyright (c) 2008 Alexander Motin <mav@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. The name of the author may not be used to endorse or promote products
11.\"    derived from this software without specific prior written permission.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd August 25, 2020
26.Dt SDHCI 4
27.Os
28.Sh NAME
29.Nm sdhci
30.Nd PCI SD Host Controller bridge driver
31.Sh SYNOPSIS
32To compile this driver into the kernel, place the following lines in your
33kernel configuration file:
34.Bd -ragged -offset indent
35.Cd "device mmc"
36.Cd "device mmcsd"
37.Cd "device sdhci"
38.Ed
39.Pp
40Alternatively, to load the driver as a module at boot time, place the
41following lines in
42.Xr loader.conf 5 :
43.Bd -literal -offset indent
44mmc_load="YES"
45mmcsd_load="YES"
46sdhci_load="YES"
47.Ed
48.Sh DESCRIPTION
49The
50.Nm
51driver supports PCI devices with class 8 and subclass 5 according to
52SD Host Controller Specification.
53Driver supports up to six high speed 4bit MMC/SD slots per controller.
54Driver attaches mmc bus to the respective slot on card insertion and
55detaches it on card removing.
56.Sh HARDWARE
57The
58.Nm
59driver supports different specification compatible chips.
60The following chips have been verified to work:
61.Pp
62.Bl -bullet -compact
63.It
64ENE CB712
65.It
66ENE CB714
67.It
68RICOH R5C822
69.It
70RICOH R5CE823
71.It
72TI PCIXX21/XX11/XX12
73.El
74.Sh SEE ALSO
75.Xr mmc 4 ,
76.Xr mmcsd 4
77.Rs
78.%T "SD Specifications, Part 2, SD Host Controller, Simplified Specification"
79.Re
80.Sh AUTHORS
81.An Alexander Motin Aq Mt mav@FreeBSD.org
82.Sh BUGS
83Many of existing SD controller chips have some nonstandard requirements,
84proprietary registers and hardware bugs, requiring additional handling.
85ENE chips are handled to work fine, while some revisions of RICOH and TI
86controllers still do not see cards without some additional initialization.
87