card_if.m revision 103171
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 103171 2002-09-10 06:32:18Z imp $ 27# 28 29#include <sys/bus.h> 30#include <dev/pccard/pccardvar.h> 31 32INTERFACE card; 33 34# WARNING: THIS FILE IS USED BY BOTH OLDCARD AND NEWCARD. MAKE SURE 35# YOU TEST BOTH KERNELS IF CHANGING THIS FILE. 36 37# 38# Companion interface for pccard. We need to set attributes for memory 39# and i/o port mappings (as well as other types of attributes) that have 40# a well defined meaning inside the pccard/cardbus system. The bus 41# methods are inadequate for this because this must be done at the time the 42# resources are set for the device, which predates their activation. Also, 43# the driver activating the resources doesn't necessarily know or need to know 44# these attributes. 45# 46METHOD int set_res_flags { 47 device_t dev; 48 device_t child; 49 int restype; 50 int rid; 51 u_long value; 52}; 53 54METHOD int get_res_flags { 55 device_t dev; 56 device_t child; 57 int restype; 58 int rid; 59 u_long *value; 60}; 61 62# 63# Sets the memory offset of the pccard bridge's window into attribute 64# or common memory space. 65# 66METHOD int set_memory_offset { 67 device_t dev; 68 device_t child; 69 int rid; 70 u_int32_t cardaddr; 71 u_int32_t *deltap; 72} 73 74METHOD int get_memory_offset { 75 device_t dev; 76 device_t child; 77 int rid; 78 u_int32_t *offset; 79} 80 81# 82# pccard bridges call this method to initate the attachment of a card 83# 84METHOD int attach_card { 85 device_t dev; 86} 87 88# 89# pccard bridges call this to detach a card. 90# 91METHOD int detach_card { 92 device_t dev; 93 int flags; 94} 95 96HEADER { 97 #define DETACH_FORCE 0x01 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_probe; 183 184METHOD int compat_do_attach { 185 device_t bus; 186 device_t dev; 187} DEFAULT null_do_attach; 188 189# 190# Find "dev" in the passed table of devices. Return it or NULL. 191# 192METHOD struct pccard_product * do_product_lookup { 193 device_t bus; 194 device_t dev; 195 const struct pccard_product *tab; 196 size_t ent_size; 197 pccard_product_match_fn matchfn; 198} 199 200# 201# Helper method for the above. When a compatibility driver is converted, 202# one must write a match routine. This routine is unused on OLDCARD but 203# is used as a discriminator for NEWCARD. 204# 205METHOD int compat_match { 206 device_t dev; 207} 208 209# 210# Method for devices to ask its CIS-enabled parent bus for CIS info. 211# Device driver requests all tuples if type 'id', the routine places 212# 'nret' number of tuples in 'buff'. Returns 0 if all tuples processed, 213# or an error code if processing was aborted. 214# Users of this method will be responsible for freeing the memory allocated 215# by calling the cis_free method. 216# 217 218HEADER { 219 struct cis_tupleinfo { 220 u_int8_t id; 221 int len; 222 char *data; 223 }; 224}; 225 226CODE { 227 static int 228 null_cis_read(device_t dev, device_t child, u_int8_t id, 229 struct cis_tupleinfo **buff, int *nret) 230 { 231 *nret = 0; 232 *buff = NULL; 233 return ENXIO; 234 } 235 236 static void 237 null_cis_free(device_t dev, struct cis_tupleinfo *buff, int *nret) 238 { 239 return; 240 } 241}; 242 243METHOD int cis_read { 244 device_t dev; 245 device_t child; 246 u_int8_t id; 247 struct cis_tupleinfo **buff; 248 int *nret; 249} DEFAULT null_cis_read; 250 251METHOD int cis_free { 252 device_t dev; 253 struct cis_tupleinfo *buff; 254 int nret; 255} DEFAULT null_cis_free; 256 257