xref: /freebsd/share/man/man4/sdhci.4 (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
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.\" $FreeBSD$
26.\"
27.Dd August 25, 2020
28.Dt SDHCI 4
29.Os
30.Sh NAME
31.Nm sdhci
32.Nd PCI SD Host Controller bridge driver
33.Sh SYNOPSIS
34To compile this driver into the kernel, place the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device mmc"
38.Cd "device mmcsd"
39.Cd "device sdhci"
40.Ed
41.Pp
42Alternatively, to load the driver as a module at boot time, place the
43following lines in
44.Xr loader.conf 5 :
45.Bd -literal -offset indent
46mmc_load="YES"
47mmcsd_load="YES"
48sdhci_load="YES"
49.Ed
50.Sh DESCRIPTION
51The
52.Nm
53driver supports PCI devices with class 8 and subclass 5 according to
54SD Host Controller Specification.
55Driver supports up to six high speed 4bit MMC/SD slots per controller.
56Driver attaches mmc bus to the respective slot on card insertion and
57detaches it on card removing.
58.Sh HARDWARE
59The
60.Nm
61driver supports different specification compatible chips.
62The following chips have been verified to work:
63.Pp
64.Bl -bullet -compact
65.It
66ENE CB712
67.It
68ENE CB714
69.It
70RICOH R5C822
71.It
72RICOH R5CE823
73.It
74TI PCIXX21/XX11/XX12
75.El
76.Sh SEE ALSO
77.Xr mmc 4 ,
78.Xr mmcsd 4
79.Rs
80.%T "SD Specifications, Part 2, SD Host Controller, Simplified Specification"
81.Re
82.Sh AUTHORS
83.An Alexander Motin Aq Mt mav@FreeBSD.org
84.Sh BUGS
85Many of existing SD controller chips have some nonstandard requirements,
86proprietary registers and hardware bugs, requiring additional handling.
87ENE chips are handled to work fine, while some revisions of RICOH and TI
88controllers still do not see cards without some additional initialization.
89