xref: /freebsd/sys/dev/mmc/mmcbr_if.m (revision 114b4164ddcb5c7b6b98fbe329d5544ece25ec9f)
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# $FreeBSD$
27#
28
29#include <sys/types.h>
30#include <dev/mmc/bridge.h>
31#include <dev/mmc/mmcreg.h>
32
33#
34# This is the interface that a mmc bridge chip gives to the mmc bus
35# that attaches to the mmc bridge.
36#
37
38INTERFACE mmcbr;
39
40#
41# Called by the mmcbus to setup the IO pins correctly, the voltage to use
42# for the card, the type of selects, power modes and bus width.
43#
44METHOD int update_ios {
45	device_t	brdev;
46	device_t	reqdev;
47};
48
49#
50# Called by the mmcbus or its children to schedule a mmc request.  These
51# requests are queued.  Time passes.  The bridge then gets notification
52# of the status of request, who then notifies the requesting device via
53# the xfer_done mmcbus method.
54#
55METHOD int request {
56	device_t	brdev;
57	device_t	reqdev;
58	struct mmc_request *req;
59};
60
61#
62# Called by mmcbus to get the read only status bits.
63#
64METHOD int get_ro {
65	device_t	brdev;
66	device_t	reqdev;
67};
68
69#
70# Claim the current bridge, blocking the current thread until the host
71# is no longer busy.
72#
73METHOD int acquire_host {
74	device_t	brdev;
75	device_t	reqdev;
76}
77
78#
79# Release the current bridge.
80#
81METHOD int release_host {
82	device_t	brdev;
83	device_t	reqdev;
84}
85