xref: /dragonfly/sys/dev/disk/sdhci/sdhci_if.m (revision edf2e657)
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#
54
55#
56# This is the set of callbacks that mmc bridges call into the bus, or
57# that mmc/sd card drivers call to make requests.
58#
59
60#include <sys/types.h>
61#include <sys/bus.h>
62#include <sys/sysctl.h>
63#include <sys/taskqueue.h>
64
65#include <bus/mmc/bridge.h>
66#include <dev/disk/sdhci/sdhci.h>
67
68INTERFACE sdhci;
69
70METHOD uint8_t read_1 {
71	device_t		brdev;
72	struct sdhci_slot	*slot;
73	bus_size_t		off;
74}
75
76METHOD uint16_t read_2 {
77	device_t		brdev;
78	struct sdhci_slot	*slot;
79	bus_size_t		off;
80}
81
82METHOD uint32_t read_4 {
83	device_t		brdev;
84	struct sdhci_slot	*slot;
85	bus_size_t		off;
86}
87
88METHOD void read_multi_4 {
89	device_t		brdev;
90	struct sdhci_slot	*slot;
91	bus_size_t		off;
92	uint32_t		*data;
93	bus_size_t		count;
94}
95
96METHOD void write_1 {
97	device_t		brdev;
98	struct sdhci_slot	*slot;
99	bus_size_t		off;
100	uint8_t			val;
101}
102
103METHOD void write_2 {
104	device_t		brdev;
105	struct sdhci_slot	*slot;
106	bus_size_t		off;
107	uint16_t		val;
108}
109
110METHOD void write_4 {
111	device_t		brdev;
112	struct sdhci_slot	*slot;
113	bus_size_t		off;
114	uint32_t		val;
115}
116
117METHOD void write_multi_4 {
118	device_t		brdev;
119	struct sdhci_slot	*slot;
120	bus_size_t		off;
121	uint32_t		*data;
122	bus_size_t		count;
123}
124
125METHOD int platform_will_handle {
126	device_t		brdev;
127	struct sdhci_slot	*slot;
128}
129
130METHOD void platform_start_transfer {
131	device_t		brdev;
132	struct sdhci_slot	*slot;
133	uint32_t		*intmask;
134}
135
136METHOD void platform_finish_transfer {
137	device_t		brdev;
138	struct sdhci_slot	*slot;
139}
140
141METHOD uint32_t min_freq {
142	device_t		brdev;
143	struct sdhci_slot	*slot;
144} DEFAULT sdhci_generic_min_freq;
145
146METHOD boolean_t get_card_present {
147	device_t		brdev;
148	struct sdhci_slot	*slot;
149} DEFAULT sdhci_generic_get_card_present;
150