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_MMCBRVAR_H
56#define DEV_MMC_MMCBRVAR_H
57
58#include <dev/mmc/mmcreg.h>
59
60#include "mmcbr_if.h"
61
62enum mmcbr_device_ivars {
63 MMCBR_IVAR_BUS_TYPE,
64 MMCBR_IVAR_BUS_MODE,
65 MMCBR_IVAR_BUS_WIDTH,
66 MMCBR_IVAR_CHIP_SELECT,
67 MMCBR_IVAR_CLOCK,
68 MMCBR_IVAR_F_MIN,
69 MMCBR_IVAR_F_MAX,
70 MMCBR_IVAR_HOST_OCR,
71 MMCBR_IVAR_MODE,
72 MMCBR_IVAR_OCR,
73 MMCBR_IVAR_POWER_MODE,
74 MMCBR_IVAR_RETUNE_REQ,
75 MMCBR_IVAR_VDD,
76 MMCBR_IVAR_VCCQ,
77 MMCBR_IVAR_CAPS,
78 MMCBR_IVAR_TIMING,
79 MMCBR_IVAR_MAX_DATA,
80 MMCBR_IVAR_MAX_BUSY_TIMEOUT
81};
82
83/*
84 * Simplified accessors for bridge devices
85 */
86#define MMCBR_ACCESSOR(var, ivar, type) \
87 __BUS_ACCESSOR(mmcbr, var, MMCBR, ivar, type)
88
89MMCBR_ACCESSOR(bus_mode, BUS_MODE, int)
90MMCBR_ACCESSOR(bus_width, BUS_WIDTH, int)
91MMCBR_ACCESSOR(chip_select, CHIP_SELECT, int)
92MMCBR_ACCESSOR(clock, CLOCK, int)
93MMCBR_ACCESSOR(f_max, F_MAX, int)
94MMCBR_ACCESSOR(f_min, F_MIN, int)
95MMCBR_ACCESSOR(host_ocr, HOST_OCR, int)
96MMCBR_ACCESSOR(mode, MODE, int)
97MMCBR_ACCESSOR(ocr, OCR, int)
98MMCBR_ACCESSOR(power_mode, POWER_MODE, int)
99MMCBR_ACCESSOR(vdd, VDD, int)
100MMCBR_ACCESSOR(vccq, VCCQ, int)
101MMCBR_ACCESSOR(caps, CAPS, int)
102MMCBR_ACCESSOR(timing, TIMING, int)
103MMCBR_ACCESSOR(max_data, MAX_DATA, int)
104MMCBR_ACCESSOR(max_busy_timeout, MAX_BUSY_TIMEOUT, u_int)
105
106static int __inline
107mmcbr_get_retune_req(device_t dev)
108{
109 uintptr_t v;
110
111 if (__predict_false(BUS_READ_IVAR(device_get_parent(dev), dev,
112 MMCBR_IVAR_RETUNE_REQ, &v) != 0))
113 return (retune_req_none);
114 return ((int)v);
115}
116
117static int __inline
118mmcbr_get_bus_type(device_t dev)
119{
120 uintptr_t v;
121
122 if (__predict_false(BUS_READ_IVAR(device_get_parent(dev), dev,
123 MMCBR_IVAR_BUS_TYPE, &v) != 0))
124 return (bus_type_default);
125 return ((int)v);
126}
127
128/*
129 * Convenience wrappers for the mmcbr interface
130 */
131static int __inline
132mmcbr_update_ios(device_t dev)
133{
134
135 return (MMCBR_UPDATE_IOS(device_get_parent(dev), dev));
136}
137
138static int __inline
139mmcbr_tune(device_t dev, bool hs400)
140{
141
142 return (MMCBR_TUNE(device_get_parent(dev), dev, hs400));
143}
144
145static int __inline
146mmcbr_retune(device_t dev, bool reset)
147{
148
149 return (MMCBR_RETUNE(device_get_parent(dev), dev, reset));
150}
151
152static int __inline
153mmcbr_switch_vccq(device_t dev)
154{
155
156 return (MMCBR_SWITCH_VCCQ(device_get_parent(dev), dev));
157}
158
159static int __inline
160mmcbr_get_ro(device_t dev)
161{
162
163 return (MMCBR_GET_RO(device_get_parent(dev), dev));
164}
165
166#endif /* DEV_MMC_MMCBRVAR_H */