share/man/man4/sdhci.4

   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: src/share/man/man4/sdhci.4,v 1.2 2009/01/16 19:28:25 mav Exp $
  26 .\"
  27 .Dd April 16, 2010
  28 .Dt SDHCI 4
  29 .Os
  30 .Sh NAME
  31 .Nm sdhci
  32 .Nd PCI SD Host Controller bridge driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel, place the following lines in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device mmc"
  38 .Cd "device mmcsd"
  39 .Cd "device sdhci"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a module at boot time, place the
  43 following lines in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 mmc_load="YES"
  47 mmcsd_load="YES"
  48 sdhci_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver supports PCI devices with class 8 and subclass 5 according to
  54 SD Host Controller Specification.
  55 Driver supports up to six high speed 4bit MMC/SD slots per controller.
  56 Driver attaches mmc bus to the respective slot on card insertion and
  57 detaches it on card removing.
  58 .Sh HARDWARE
  59 The
  60 .Nm
  61 driver supports different specification compatible chips. The following
  62 chips have been verified to work:
  63 .Pp
  64 .Bl -bullet -compact
  65 .It
  66 ENE CB712
  67 .It
  68 ENE CB714
  69 .It
  70 RICOH R5C822
  71 .It
  72 TI PCIXX21/XX11
  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 HISTORY
  81 The
  82 .Nm
  83 driver was imported from
  84 .Fx
  85 into
  86 .Dx 2.7 .
  87 .Sh AUTHORS
  88 .An Alexander Motin Aq mav@FreeBSD.org .
  89 .Sh BUGS
  90 Many of existing SD controller chips have some nonstandard requirements,
  91 proprietary registers and hardware bugs, requiring additional handling.
  92 ENE chips are handled to work fine, while some revisions of RICOH and TI
  93 controllers still don't see cards without some additional initialization.