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