xref: /freebsd/sys/dev/sdhci/sdhci_if.m (revision ca987d4641cdcd7f27e153db17c5bf064934faf5)
1#-
2# Copyright (c) 2006 M. Warner Losh
3# 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 AND CONTRIBUTORS ``AS IS'' AND
15# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24# 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# $FreeBSD$
54#
55
56#
57# This is the set of callbacks that mmc bridges call into the bus, or
58# that mmc/sd card drivers call to make requests.
59#
60
61#include <sys/lock.h>
62#include <sys/mutex.h>
63#include <sys/types.h>
64#include <sys/sysctl.h>
65#include <sys/taskqueue.h>
66
67#include <machine/bus.h>
68
69#include <dev/mmc/bridge.h>
70#include <dev/sdhci/sdhci.h>
71
72CODE {
73	static void
74	null_set_uhs_timing(device_t brdev __unused,
75	    struct sdhci_slot *slot __unused)
76	{
77
78	}
79}
80
81INTERFACE sdhci;
82
83METHOD uint8_t read_1 {
84	device_t		brdev;
85	struct sdhci_slot	*slot;
86	bus_size_t		off;
87}
88
89METHOD uint16_t read_2 {
90	device_t		brdev;
91	struct sdhci_slot	*slot;
92	bus_size_t		off;
93}
94
95METHOD uint32_t read_4 {
96	device_t		brdev;
97	struct sdhci_slot	*slot;
98	bus_size_t		off;
99}
100
101METHOD void read_multi_4 {
102	device_t		brdev;
103	struct sdhci_slot	*slot;
104	bus_size_t		off;
105	uint32_t		*data;
106	bus_size_t		count;
107}
108
109METHOD void write_1 {
110	device_t		brdev;
111	struct sdhci_slot	*slot;
112	bus_size_t		off;
113	uint8_t			val;
114}
115
116METHOD void write_2 {
117	device_t		brdev;
118	struct sdhci_slot	*slot;
119	bus_size_t		off;
120	uint16_t		val;
121}
122
123METHOD void write_4 {
124	device_t		brdev;
125	struct sdhci_slot	*slot;
126	bus_size_t		off;
127	uint32_t		val;
128}
129
130METHOD void write_multi_4 {
131	device_t		brdev;
132	struct sdhci_slot	*slot;
133	bus_size_t		off;
134	uint32_t		*data;
135	bus_size_t		count;
136}
137
138METHOD int platform_will_handle {
139	device_t		brdev;
140	struct sdhci_slot	*slot;
141}
142
143METHOD void platform_start_transfer {
144	device_t		brdev;
145	struct sdhci_slot	*slot;
146	uint32_t		*intmask;
147}
148
149METHOD void platform_finish_transfer {
150	device_t		brdev;
151	struct sdhci_slot	*slot;
152}
153
154METHOD uint32_t min_freq {
155	device_t		brdev;
156	struct sdhci_slot	*slot;
157} DEFAULT sdhci_generic_min_freq;
158
159METHOD bool get_card_present {
160	device_t		brdev;
161	struct sdhci_slot	*slot;
162} DEFAULT sdhci_generic_get_card_present;
163
164METHOD void set_uhs_timing {
165	device_t		brdev;
166	struct sdhci_slot	*slot;
167} DEFAULT null_set_uhs_timing;
168