sdhci_if.m revision 318198 
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: stable/10/sys/dev/sdhci/sdhci_if.m 318198 2017-05-11 21:01:02Z marius $
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/types.h>
62#include <sys/bus.h>
63#include <sys/sysctl.h>
64#include <sys/taskqueue.h>
65
66#include <machine/bus.h>
67
68#include <dev/mmc/bridge.h>
69#include <dev/sdhci/sdhci.h>
70
71INTERFACE sdhci;
72
73METHOD uint8_t read_1 {
74	device_t		brdev;
75	struct sdhci_slot	*slot;
76	bus_size_t		off;
77}
78
79METHOD uint16_t read_2 {
80	device_t		brdev;
81	struct sdhci_slot	*slot;
82	bus_size_t		off;
83}
84
85METHOD uint32_t read_4 {
86	device_t		brdev;
87	struct sdhci_slot	*slot;
88	bus_size_t		off;
89}
90
91METHOD void read_multi_4 {
92	device_t		brdev;
93	struct sdhci_slot	*slot;
94	bus_size_t		off;
95	uint32_t		*data;
96	bus_size_t		count;
97}
98
99METHOD void write_1 {
100	device_t		brdev;
101	struct sdhci_slot	*slot;
102	bus_size_t		off;
103	uint8_t			val;
104}
105
106METHOD void write_2 {
107	device_t		brdev;
108	struct sdhci_slot	*slot;
109	bus_size_t		off;
110	uint16_t		val;
111}
112
113METHOD void write_4 {
114	device_t		brdev;
115	struct sdhci_slot	*slot;
116	bus_size_t		off;
117	uint32_t		val;
118}
119
120METHOD void write_multi_4 {
121	device_t		brdev;
122	struct sdhci_slot	*slot;
123	bus_size_t		off;
124	uint32_t		*data;
125	bus_size_t		count;
126}
127
128METHOD int platform_will_handle {
129	device_t		brdev;
130	struct sdhci_slot	*slot;
131}
132
133METHOD void platform_start_transfer {
134	device_t		brdev;
135	struct sdhci_slot	*slot;
136	uint32_t		*intmask;
137}
138
139METHOD void platform_finish_transfer {
140	device_t		brdev;
141	struct sdhci_slot	*slot;
142}
143
144METHOD uint32_t min_freq {
145	device_t		brdev;
146	struct sdhci_slot	*slot;
147} DEFAULT sdhci_generic_min_freq;
148
149METHOD bool get_card_present {
150	device_t		brdev;
151	struct sdhci_slot	*slot;
152} DEFAULT sdhci_generic_get_card_present;
153
154