xref: /freebsd/sys/dev/mmc/mmcvar.h (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2006 Bernd Walter.  All rights reserved.
5  * Copyright (c) 2006 M. Warner Losh <imp@FreeBSD.org>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  * Portions of this software may have been developed with reference to
28  * the SD Simplified Specification.  The following disclaimer may apply:
29  *
30  * The following conditions apply to the release of the simplified
31  * specification ("Simplified Specification") by the SD Card Association and
32  * the SD Group. The Simplified Specification is a subset of the complete SD
33  * Specification which is owned by the SD Card Association and the SD
34  * Group. This Simplified Specification is provided on a non-confidential
35  * basis subject to the disclaimers below. Any implementation of the
36  * Simplified Specification may require a license from the SD Card
37  * Association, SD Group, SD-3C LLC or other third parties.
38  *
39  * Disclaimers:
40  *
41  * The information contained in the Simplified Specification is presented only
42  * as a standard specification for SD Cards and SD Host/Ancillary products and
43  * is provided "AS-IS" without any representations or warranties of any
44  * kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD
45  * Card Association for any damages, any infringements of patents or other
46  * right of the SD Group, SD-3C LLC, the SD Card Association or any third
47  * parties, which may result from its use. No license is granted by
48  * implication, estoppel or otherwise under any patent or other rights of the
49  * SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing
50  * herein shall be construed as an obligation by the SD Group, the SD-3C LLC
51  * or the SD Card Association to disclose or distribute any technical
52  * information, know-how or other confidential information to any third party.
53  */
54 
55 #ifndef DEV_MMC_MMCVAR_H
56 #define DEV_MMC_MMCVAR_H
57 
58 enum mmc_device_ivars {
59     MMC_IVAR_SPEC_VERS,
60     MMC_IVAR_DSR_IMP,
61     MMC_IVAR_MEDIA_SIZE,
62     MMC_IVAR_RCA,
63     MMC_IVAR_SECTOR_SIZE,
64     MMC_IVAR_TRAN_SPEED,
65     MMC_IVAR_READ_ONLY,
66     MMC_IVAR_HIGH_CAP,
67     MMC_IVAR_CARD_TYPE,
68     MMC_IVAR_BUS_WIDTH,
69     MMC_IVAR_ERASE_SECTOR,
70     MMC_IVAR_MAX_DATA,
71     MMC_IVAR_CMD6_TIMEOUT,
72     MMC_IVAR_QUIRKS,
73     MMC_IVAR_CARD_ID_STRING,
74     MMC_IVAR_CARD_SN_STRING,
75 };
76 
77 /*
78  * Simplified accessors for mmc devices
79  */
80 #define MMC_ACCESSOR(var, ivar, type)					\
81 	__BUS_ACCESSOR(mmc, var, MMC, ivar, type)
82 
83 MMC_ACCESSOR(spec_vers, SPEC_VERS, uint8_t)
84 MMC_ACCESSOR(dsr_imp, DSR_IMP, int)
85 MMC_ACCESSOR(media_size, MEDIA_SIZE, long)
86 MMC_ACCESSOR(rca, RCA, int)
87 MMC_ACCESSOR(sector_size, SECTOR_SIZE, int)
88 MMC_ACCESSOR(tran_speed, TRAN_SPEED, int)
89 MMC_ACCESSOR(read_only, READ_ONLY, int)
90 MMC_ACCESSOR(high_cap, HIGH_CAP, int)
91 MMC_ACCESSOR(card_type, CARD_TYPE, int)
92 MMC_ACCESSOR(bus_width, BUS_WIDTH, int)
93 MMC_ACCESSOR(erase_sector, ERASE_SECTOR, int)
94 MMC_ACCESSOR(max_data, MAX_DATA, int)
95 MMC_ACCESSOR(cmd6_timeout, CMD6_TIMEOUT, u_int)
96 MMC_ACCESSOR(quirks, QUIRKS, u_int)
97 MMC_ACCESSOR(card_id_string, CARD_ID_STRING, const char *)
98 MMC_ACCESSOR(card_sn_string, CARD_SN_STRING, const char *)
99 
100 #endif /* DEV_MMC_MMCVAR_H */
101