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