xref: /freebsd/sys/dev/sdhci/sdhci_if.m (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1#-
2# Copyright (c) 2006 M. Warner Losh <imp@FreeBSD.org>
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions
6# are met:
7# 1. Redistributions of source code must retain the above copyright
8#    notice, this list of conditions and the following disclaimer.
9# 2. Redistributions in binary form must reproduce the above copyright
10#    notice, this list of conditions and the following disclaimer in the
11#    documentation and/or other materials provided with the distribution.
12#
13# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23# 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#
53
54#
55# This is the set of callbacks that mmc bridges call into the bus, or
56# that mmc/sd card drivers call to make requests.
57#
58
59#include <sys/lock.h>
60#include <sys/mutex.h>
61#include <sys/types.h>
62#include <sys/sysctl.h>
63#include <sys/taskqueue.h>
64
65#include <machine/bus.h>
66
67#include <dev/mmc/bridge.h>
68#include <dev/sdhci/sdhci.h>
69
70CODE {
71	static int
72	null_set_clock(device_t brdev __unused,
73	    struct sdhci_slot *slot __unused,
74	    int clock)
75	{
76		return (clock);
77	}
78
79	static void
80	null_set_uhs_timing(device_t brdev __unused,
81	    struct sdhci_slot *slot __unused)
82	{
83
84	}
85}
86
87INTERFACE sdhci;
88
89METHOD uint8_t read_1 {
90	device_t		brdev;
91	struct sdhci_slot	*slot;
92	bus_size_t		off;
93}
94
95METHOD uint16_t read_2 {
96	device_t		brdev;
97	struct sdhci_slot	*slot;
98	bus_size_t		off;
99}
100
101METHOD uint32_t read_4 {
102	device_t		brdev;
103	struct sdhci_slot	*slot;
104	bus_size_t		off;
105}
106
107METHOD void read_multi_4 {
108	device_t		brdev;
109	struct sdhci_slot	*slot;
110	bus_size_t		off;
111	uint32_t		*data;
112	bus_size_t		count;
113}
114
115METHOD void write_1 {
116	device_t		brdev;
117	struct sdhci_slot	*slot;
118	bus_size_t		off;
119	uint8_t			val;
120}
121
122METHOD void write_2 {
123	device_t		brdev;
124	struct sdhci_slot	*slot;
125	bus_size_t		off;
126	uint16_t		val;
127}
128
129METHOD void write_4 {
130	device_t		brdev;
131	struct sdhci_slot	*slot;
132	bus_size_t		off;
133	uint32_t		val;
134}
135
136METHOD void write_multi_4 {
137	device_t		brdev;
138	struct sdhci_slot	*slot;
139	bus_size_t		off;
140	uint32_t		*data;
141	bus_size_t		count;
142}
143
144METHOD int platform_will_handle {
145	device_t		brdev;
146	struct sdhci_slot	*slot;
147}
148
149METHOD void platform_start_transfer {
150	device_t		brdev;
151	struct sdhci_slot	*slot;
152	uint32_t		*intmask;
153}
154
155METHOD void platform_finish_transfer {
156	device_t		brdev;
157	struct sdhci_slot	*slot;
158}
159
160METHOD uint32_t min_freq {
161	device_t		brdev;
162	struct sdhci_slot	*slot;
163} DEFAULT sdhci_generic_min_freq;
164
165METHOD bool get_card_present {
166	device_t		brdev;
167	struct sdhci_slot	*slot;
168} DEFAULT sdhci_generic_get_card_present;
169
170METHOD void set_uhs_timing {
171	device_t		brdev;
172	struct sdhci_slot	*slot;
173} DEFAULT null_set_uhs_timing;
174
175METHOD int set_clock {
176	device_t		brdev;
177	struct sdhci_slot	*slot;
178	int			clock;
179} DEFAULT null_set_clock;
180
181METHOD void reset {
182	device_t		brdev;
183	struct sdhci_slot	*slot;
184	uint8_t			mask;
185} DEFAULT sdhci_generic_reset;
186