card_if.m revision 100218
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 100218 2002-07-17 05:20:43Z 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 96# 97# pccard/cardbus buses call this to request a reprobe of the bus. 98# reprobe only initiated if the child bus is the same type the card inserted. 99# 100METHOD int reprobe_card { 101 device_t dev; 102 device_t child; 103} 104 105HEADER { 106 #define DETACH_FORCE 0x01 107} 108 109# 110# Returns the type of card this is. Maybe we don't need this. 111# 112METHOD int get_type { 113 device_t dev; 114 int *type; 115} 116 117# 118# Returns the function number for this device. 119# 120METHOD int get_function { 121 device_t dev; 122 device_t child; 123 int *func; 124} 125 126# 127# Activates (and powers up if necessary) the card's nth function 128# since each function gets its own device, there is no need to 129# to specify a function number 130# 131METHOD int activate_function { 132 device_t dev; 133 device_t child; 134} 135 136METHOD int deactivate_function { 137 device_t dev; 138 device_t child; 139} 140 141# 142# Compatibility methods for OLDCARD drivers. We use these routines to make 143# it possible to call the OLDCARD driver's probe routine in the context that 144# it expects. For OLDCARD these are implemented as pass throughs to the 145# device_{probe,attach} routines. For NEWCARD they are implemented such 146# such that probe becomes strictly a matching routine and attach does both 147# the old probe and old attach. 148# 149# compat devices should use the following: 150# 151# /* Device interface */ 152# DEVMETHOD(device_probe), pccard_compat_probe), 153# DEVMETHOD(device_attach), pccard_compat_attach), 154# /* Card interface */ 155# DEVMETHOD(card_compat_match, foo_match), /* newly written */ 156# DEVMETHOD(card_compat_probe, foo_probe), /* old probe */ 157# DEVMETHOD(card_compat_attach, foo_attach), /* old attach */ 158# 159# This will allow a single driver binary image to be used for both 160# OLDCARD and NEWCARD. 161# 162# Drivers wishing to not retain OLDCARD compatibility needn't do this. 163# 164# The compat_do_* versions are so that we can make the pccard_compat_probe 165# and _attach static lines and have the bus system pick the right version 166# to use so we don't enshrine pccard_* symbols in the driver's module. 167# 168METHOD int compat_probe { 169 device_t dev; 170} 171 172METHOD int compat_attach { 173 device_t dev; 174} 175 176CODE { 177 static int null_do_probe(device_t bus, device_t dev) 178 { 179 return (CARD_COMPAT_DO_PROBE(device_get_parent(bus), dev)); 180 } 181 182 static int null_do_attach(device_t bus, device_t dev) 183 { 184 return (CARD_COMPAT_DO_ATTACH(device_get_parent(bus), dev)); 185 } 186} 187 188METHOD int compat_do_probe { 189 device_t bus; 190 device_t dev; 191} DEFAULT null_do_probe; 192 193METHOD int compat_do_attach { 194 device_t bus; 195 device_t dev; 196} DEFAULT null_do_attach; 197 198# 199# Find "dev" in the passed table of devices. Return it or NULL. 200# 201METHOD struct pccard_product * do_product_lookup { 202 device_t bus; 203 device_t dev; 204 const struct pccard_product *tab; 205 size_t ent_size; 206 pccard_product_match_fn matchfn; 207} 208 209# 210# Helper method for the above. When a compatibility driver is converted, 211# one must write a match routine. This routine is unused on OLDCARD but 212# is used as a discriminator for NEWCARD. 213# 214METHOD int compat_match { 215 device_t dev; 216} 217 218# 219# Method for devices to ask its CIS-enabled parent bus for CIS info. 220# Device driver requests all tuples if type 'id', the routine places 221# 'nret' number of tuples in 'buff'. Returns 0 if all tuples processed, 222# or an error code if processing was aborted. 223# Users of this method will be responsible for freeing the memory allocated 224# by calling the cis_free method. 225# 226 227HEADER { 228 struct cis_tupleinfo { 229 u_int8_t id; 230 int len; 231 char *data; 232 }; 233}; 234 235CODE { 236 static int 237 null_cis_read(device_t dev, device_t child, u_int8_t id, 238 struct cis_tupleinfo **buff, int *nret) 239 { 240 *nret = 0; 241 *buff = NULL; 242 return ENXIO; 243 } 244 245 static void 246 null_cis_free(device_t dev, struct cis_tupleinfo *buff, int *nret) 247 { 248 return; 249 } 250}; 251 252METHOD int cis_read { 253 device_t dev; 254 device_t child; 255 u_int8_t id; 256 struct cis_tupleinfo **buff; 257 int *nret; 258} DEFAULT null_cis_read; 259 260METHOD int cis_free { 261 device_t dev; 262 struct cis_tupleinfo *buff; 263 int nret; 264} DEFAULT null_cis_free; 265 266