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