xref: /freebsd/sys/cam/mmc/mmc.h (revision a94a63f0a6bc1ec25bf0d162e1dd9a53e020d176)
1*a94a63f0SWarner Losh /*-
2*a94a63f0SWarner Losh  * Copyright (c) 2014-2016 Ilya Bakulin.  All rights reserved.
3*a94a63f0SWarner Losh  *
4*a94a63f0SWarner Losh  * Redistribution and use in source and binary forms, with or without
5*a94a63f0SWarner Losh  * modification, are permitted provided that the following conditions
6*a94a63f0SWarner Losh  * are met:
7*a94a63f0SWarner Losh  * 1. Redistributions of source code must retain the above copyright
8*a94a63f0SWarner Losh  *    notice, this list of conditions and the following disclaimer.
9*a94a63f0SWarner Losh  * 2. Redistributions in binary form must reproduce the above copyright
10*a94a63f0SWarner Losh  *    notice, this list of conditions and the following disclaimer in the
11*a94a63f0SWarner Losh  *    documentation and/or other materials provided with the distribution.
12*a94a63f0SWarner Losh  *
13*a94a63f0SWarner Losh  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14*a94a63f0SWarner Losh  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15*a94a63f0SWarner Losh  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16*a94a63f0SWarner Losh  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17*a94a63f0SWarner Losh  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18*a94a63f0SWarner Losh  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19*a94a63f0SWarner Losh  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20*a94a63f0SWarner Losh  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21*a94a63f0SWarner Losh  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22*a94a63f0SWarner Losh  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23*a94a63f0SWarner Losh  *
24*a94a63f0SWarner Losh  * Portions of this software may have been developed with reference to
25*a94a63f0SWarner Losh  * the SD Simplified Specification.  The following disclaimer may apply:
26*a94a63f0SWarner Losh  *
27*a94a63f0SWarner Losh  * The following conditions apply to the release of the simplified
28*a94a63f0SWarner Losh  * specification ("Simplified Specification") by the SD Card Association and
29*a94a63f0SWarner Losh  * the SD Group. The Simplified Specification is a subset of the complete SD
30*a94a63f0SWarner Losh  * Specification which is owned by the SD Card Association and the SD
31*a94a63f0SWarner Losh  * Group. This Simplified Specification is provided on a non-confidential
32*a94a63f0SWarner Losh  * basis subject to the disclaimers below. Any implementation of the
33*a94a63f0SWarner Losh  * Simplified Specification may require a license from the SD Card
34*a94a63f0SWarner Losh  * Association, SD Group, SD-3C LLC or other third parties.
35*a94a63f0SWarner Losh  *
36*a94a63f0SWarner Losh  * Disclaimers:
37*a94a63f0SWarner Losh  *
38*a94a63f0SWarner Losh  * The information contained in the Simplified Specification is presented only
39*a94a63f0SWarner Losh  * as a standard specification for SD Cards and SD Host/Ancillary products and
40*a94a63f0SWarner Losh  * is provided "AS-IS" without any representations or warranties of any
41*a94a63f0SWarner Losh  * kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD
42*a94a63f0SWarner Losh  * Card Association for any damages, any infringements of patents or other
43*a94a63f0SWarner Losh  * right of the SD Group, SD-3C LLC, the SD Card Association or any third
44*a94a63f0SWarner Losh  * parties, which may result from its use. No license is granted by
45*a94a63f0SWarner Losh  * implication, estoppel or otherwise under any patent or other rights of the
46*a94a63f0SWarner Losh  * SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing
47*a94a63f0SWarner Losh  * herein shall be construed as an obligation by the SD Group, the SD-3C LLC
48*a94a63f0SWarner Losh  * or the SD Card Association to disclose or distribute any technical
49*a94a63f0SWarner Losh  * information, know-how or other confidential information to any third party.
50*a94a63f0SWarner Losh  *
51*a94a63f0SWarner Losh  * Inspired coded in sys/dev/mmc. Thanks to Warner Losh <imp@FreeBSD.org>,
52*a94a63f0SWarner Losh  * Bernd Walter <tisco@FreeBSD.org>, and other authors.
53*a94a63f0SWarner Losh  *
54*a94a63f0SWarner Losh  * $FreeBSD$
55*a94a63f0SWarner Losh  */
56*a94a63f0SWarner Losh 
57*a94a63f0SWarner Losh #ifndef CAM_MMC_H
58*a94a63f0SWarner Losh #define CAM_MMC_H
59*a94a63f0SWarner Losh 
60*a94a63f0SWarner Losh #include <dev/mmc/mmcreg.h>
61*a94a63f0SWarner Losh /*
62*a94a63f0SWarner Losh  * This structure describes an MMC/SD card
63*a94a63f0SWarner Losh  */
64*a94a63f0SWarner Losh struct mmc_params {
65*a94a63f0SWarner Losh         u_int8_t	model[40]; /* Card model */
66*a94a63f0SWarner Losh 
67*a94a63f0SWarner Losh         /* Card OCR */
68*a94a63f0SWarner Losh         uint32_t card_ocr;
69*a94a63f0SWarner Losh 
70*a94a63f0SWarner Losh         /* OCR of the IO portion of the card */
71*a94a63f0SWarner Losh         uint32_t io_ocr;
72*a94a63f0SWarner Losh 
73*a94a63f0SWarner Losh         /* Card CID -- raw and parsed */
74*a94a63f0SWarner Losh         uint32_t card_cid[4];
75*a94a63f0SWarner Losh         struct mmc_cid  cid;
76*a94a63f0SWarner Losh 
77*a94a63f0SWarner Losh         /* Card CSD -- raw */
78*a94a63f0SWarner Losh         uint32_t card_csd[4];
79*a94a63f0SWarner Losh 
80*a94a63f0SWarner Losh         /* Card RCA */
81*a94a63f0SWarner Losh         uint16_t card_rca;
82*a94a63f0SWarner Losh 
83*a94a63f0SWarner Losh         /* What kind of card is it */
84*a94a63f0SWarner Losh         uint32_t card_features;
85*a94a63f0SWarner Losh #define CARD_FEATURE_MEMORY 0x1
86*a94a63f0SWarner Losh #define CARD_FEATURE_SDHC   0x1 << 1
87*a94a63f0SWarner Losh #define CARD_FEATURE_SDIO   0x1 << 2
88*a94a63f0SWarner Losh #define CARD_FEATURE_SD20   0x1 << 3
89*a94a63f0SWarner Losh #define CARD_FEATURE_MMC    0x1 << 4
90*a94a63f0SWarner Losh 
91*a94a63f0SWarner Losh         uint8_t sdio_func_count;
92*a94a63f0SWarner Losh } __packed;
93*a94a63f0SWarner Losh 
94*a94a63f0SWarner Losh #endif
95