card_if.m revision 70746
1# 2# Copyright (c) 1999 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: head/sys/dev/pccard/card_if.m 70746 2001-01-07 08:08:54Z imp $ 27# 28 29#include <sys/bus.h> 30 31INTERFACE card; 32 33# 34# Companion interface for pccard. We need to set attributes for memory 35# and i/o port mappings (as well as other types of attributes) that have 36# a well defined meaning inside the pccard/cardbus system. The bus 37# methods are inadequate for this because this must be done at the time the 38# resources are set for the device, which predates their activation. Also, 39# the driver activating the resources doesn't necessarily know or need to know 40# these attributes. 41# 42METHOD int set_res_flags { 43 device_t dev; 44 device_t child; 45 int restype; 46 int rid; 47 u_long value; 48}; 49 50METHOD int get_res_flags { 51 device_t dev; 52 device_t child; 53 int restype; 54 int rid; 55 u_long *value; 56}; 57 58# 59# Sets the memory offset of the pccard bridge's window into attribute 60# or common memory space. 61# 62METHOD int set_memory_offset { 63 device_t dev; 64 device_t child; 65 int rid; 66 u_int32_t cardaddr; 67} 68 69METHOD int get_memory_offset { 70 device_t dev; 71 device_t child; 72 int rid; 73 u_int32_t *offset; 74} 75 76# 77# pccard bridges call this method to initate the attachment of a card 78# 79METHOD int attach_card { 80 device_t dev; 81} 82 83# 84# pccard bridges call this to detach a card. 85# 86METHOD int detach_card { 87 device_t dev; 88 int flags; 89} 90 91HEADER { 92 #define DETACH_FORCE 0x01 93 #define DETACH_NOWARN 0x02 94} 95 96# 97# Returns the type of card this is. Maybe we don't need this. 98# 99METHOD int get_type { 100 device_t dev; 101 int *type; 102} 103 104# 105# Returns the function number for this device. 106# 107METHOD int get_function { 108 device_t dev; 109 device_t child; 110 int *func; 111} 112 113# 114# Activates (and powers up if necessary) the card's nth function 115# since each function gets its own device, there is no need to 116# to specify a function number 117# 118METHOD int activate_function { 119 device_t dev; 120 device_t child; 121} 122 123METHOD int deactivate_function { 124 device_t dev; 125 device_t child; 126} 127 128# 129# Compatibility methods for OLDCARD drivers. We use these routines to make 130# it possible to call the OLDCARD driver's probe routine in the context that 131# it expects. For OLDCARD these are implemented as pass throughs to the 132# device_{probe,attach} routines. For NEWCARD they are implemented such 133# such that probe becomes strictly a matching routine and attach does both 134# the old probe and old attach. 135# 136# compat devices should use the following: 137# 138# /* Device interface */ 139# DEVMETHOD(device_probe), pccard_compat_probe), 140# DEVMETHOD(device_attach), pccard_compat_attach), 141# /* Card interface */ 142# DEVMETHOD(card_compat_match, foo_match), /* newly written */ 143# DEVMETHOD(card_compat_probe, foo_probe), /* old probe */ 144# DEVMETHOD(card_compat_attach, foo_attach), /* old attach */ 145# 146# This will allow a single driver binary image to be used for both 147# OLDCARD and NEWCARD. 148# 149# Drivers wishing to not retain OLDCARD compatibility needn't do this. 150# 151METHOD int compat_probe { 152 device_t dev; 153} 154 155METHOD int compat_attach { 156 device_t dev; 157} 158 159# 160# Helper method for the above. When a compatibility driver is converted, 161# one must write a match routine. This routine is unused on OLDCARD but 162# is used as a discriminator for NEWCARD. 163# 164METHOD int compat_match { 165 device_t dev; 166} 167 168# 169# Method for devices to ask its CIS-enabled parent bus for CIS info. 170# Device driver requests all tuples if type 'id', the routine places 171# 'nret' number of tuples in 'buff'. Returns 0 if all tuples processed, 172# or an error code if processing was aborted. 173# Users of this method will be responsible for freeing the memory allocated 174# by calling the cis_free method. 175# 176 177HEADER { 178 struct cis_tupleinfo { 179 u_int8_t id; 180 int len; 181 char* data; 182 }; 183}; 184 185CODE { 186 static int 187 null_cis_read(device_t dev, device_t child, u_int8_t id, 188 struct cis_tupleinfo **buff, int* nret) 189 { 190 *nret = 0; 191 *buff = NULL; 192 return ENXIO; 193 } 194 static void 195 null_cis_free(device_t dev, struct cis_tupleinfo *buff, int* nret) 196 { 197 return; 198 } 199}; 200 201 202METHOD int cis_read { 203 device_t dev; 204 device_t child; 205 u_int8_t id; 206 struct cis_tupleinfo **buff; 207 int* nret; 208} DEFAULT null_cis_read; 209 210METHOD int cis_free { 211 device_t dev; 212 struct cis_tupleinfo *buff; 213 int nret; 214} DEFAULT null_cis_free; 215 216 217