1 /*- 2 * ISP Firmware Modules for FreeBSD 3 * 4 * Copyright (c) 2000, 2001, 2006 by Matthew Jacob 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice immediately at the beginning of the file, without modification, 12 * this list of conditions, and the following disclaimer. 13 * 2. The name of the author may not be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include <sys/param.h> 33 #include <sys/firmware.h> 34 #include <sys/kernel.h> 35 #include <sys/linker.h> 36 #include <sys/module.h> 37 #include <sys/systm.h> 38 39 #if defined(ISP_ALL) || !defined(KLD_MODULE) 40 #ifdef __sparc64__ 41 #define ISP_1000 1 42 #endif 43 #define ISP_1040 1 44 #define ISP_1040_IT 1 45 #define ISP_1080 1 46 #define ISP_1080_IT 1 47 #define ISP_12160 1 48 #define ISP_12160_IT 1 49 #define ISP_2100 1 50 #define ISP_2200 1 51 #define ISP_2300 1 52 #define ISP_2322 1 53 #define ISP_2400 1 54 #define ISP_2400_MULTI 1 55 #define ISP_2500 1 56 #define ISP_2500_MULTI 1 57 #endif 58 59 #ifndef MODULE_NAME 60 #define MODULE_NAME "ispfw" 61 #endif 62 63 #if defined(ISP_1000) 64 #ifdef __sparc64__ 65 #include <dev/ispfw/asm_1000.h> 66 #else 67 #error "firmware not compatible with this platform" 68 #endif 69 #endif 70 #if defined(ISP_1040) || defined(ISP_1040_IT) 71 #include <dev/ispfw/asm_1040.h> 72 #endif 73 #if defined(ISP_1080) || defined(ISP_1080_IT) 74 #include <dev/ispfw/asm_1080.h> 75 #endif 76 #if defined(ISP_12160) || defined(ISP_12160_IT) 77 #include <dev/ispfw/asm_12160.h> 78 #endif 79 #if defined(ISP_2100) 80 #include <dev/ispfw/asm_2100.h> 81 #endif 82 #if defined(ISP_2200) 83 #include <dev/ispfw/asm_2200.h> 84 #endif 85 #if defined(ISP_2300) 86 #include <dev/ispfw/asm_2300.h> 87 #endif 88 #if defined(ISP_2322) 89 #include <dev/ispfw/asm_2322.h> 90 #endif 91 #if defined(ISP_2400) || defined(ISP_2400_MULTI) 92 #include <dev/ispfw/asm_2400.h> 93 #endif 94 #if defined(ISP_2500) || defined(ISP_2500_MULTI) 95 #include <dev/ispfw/asm_2500.h> 96 #endif 97 98 #if defined(ISP_1000) 99 static int isp_1000_loaded; 100 #endif 101 #if defined(ISP_1040) 102 static int isp_1040_loaded; 103 #endif 104 #if defined(ISP_1040_IT) 105 static int isp_1040_it_loaded; 106 #endif 107 #if defined(ISP_1080) 108 static int isp_1080_loaded; 109 #endif 110 #if defined(ISP_1080_IT) 111 static int isp_1080_it_loaded; 112 #endif 113 #if defined(ISP_12160) 114 static int isp_12160_loaded; 115 #endif 116 #if defined(ISP_12160_IT) 117 static int isp_12160_it_loaded; 118 #endif 119 #if defined(ISP_2100) 120 static int isp_2100_loaded; 121 #endif 122 #if defined(ISP_2200) 123 static int isp_2200_loaded; 124 #endif 125 #if defined(ISP_2300) 126 static int isp_2300_loaded; 127 #endif 128 #if defined(ISP_2322) 129 static int isp_2322_loaded; 130 #endif 131 #if defined(ISP_2400) 132 static int isp_2400_loaded; 133 #endif 134 #if defined(ISP_2400_MULTI) 135 static int isp_2400_multi_loaded; 136 #endif 137 #if defined(ISP_2500) 138 static int isp_2500_loaded; 139 #endif 140 #if defined(ISP_2500_MULTI) 141 static int isp_2500_multi_loaded; 142 #endif 143 144 #define ISPFW_VERSION 1 145 146 #if !defined(KLD_MODULE) 147 #define ISPFW_KLD 0 148 #else 149 #define ISPFW_KLD 1 150 #endif 151 152 #define RMACRO(token) do { \ 153 if (token##_loaded) \ 154 break; \ 155 if (firmware_register(#token, token##_risc_code, \ 156 token##_risc_code[3] * sizeof(token##_risc_code[3]), \ 157 ISPFW_VERSION, NULL) == NULL) { \ 158 printf("%s: unable to register firmware <%s>\n", \ 159 MODULE_NAME, #token); \ 160 break; \ 161 } \ 162 token##_loaded++; \ 163 if (bootverbose || ISPFW_KLD) \ 164 printf("%s: registered firmware <%s>\n", MODULE_NAME, \ 165 #token); \ 166 } while (0) 167 168 #define UMACRO(token) do { \ 169 if (!token##_loaded) \ 170 break; \ 171 if (firmware_unregister(#token) != 0) { \ 172 printf("%s: unable to unregister firmware <%s>\n", \ 173 MODULE_NAME, #token); \ 174 break; \ 175 } \ 176 token##_loaded--; \ 177 if (bootverbose || ISPFW_KLD) \ 178 printf("%s: unregistered firmware <%s>\n", MODULE_NAME, \ 179 #token); \ 180 } while (0) 181 182 static void 183 do_load_fw(void) 184 { 185 186 #if defined(ISP_1000) 187 RMACRO(isp_1000); 188 #endif 189 #if defined(ISP_1040) 190 RMACRO(isp_1040); 191 #endif 192 #if defined(ISP_1040_IT) 193 RMACRO(isp_1040_it); 194 #endif 195 #if defined(ISP_1080) 196 RMACRO(isp_1080); 197 #endif 198 #if defined(ISP_1080_IT) 199 RMACRO(isp_1080_it); 200 #endif 201 #if defined(ISP_12160) 202 RMACRO(isp_12160); 203 #endif 204 #if defined(ISP_12160_IT) 205 RMACRO(isp_12160_it); 206 #endif 207 #if defined(ISP_2100) 208 RMACRO(isp_2100); 209 #endif 210 #if defined(ISP_2200) 211 RMACRO(isp_2200); 212 #endif 213 #if defined(ISP_2300) 214 RMACRO(isp_2300); 215 #endif 216 #if defined(ISP_2322) 217 RMACRO(isp_2322); 218 #endif 219 #if defined(ISP_2400) 220 RMACRO(isp_2400); 221 #endif 222 #if defined(ISP_2400_MULTI) 223 RMACRO(isp_2400_multi); 224 #endif 225 #if defined(ISP_2500) 226 RMACRO(isp_2500); 227 #endif 228 #if defined(ISP_2500_MULTI) 229 RMACRO(isp_2500_multi); 230 #endif 231 } 232 233 static void 234 do_unload_fw(void) 235 { 236 237 #if defined(ISP_1000) 238 UMACRO(isp_1000); 239 #endif 240 #if defined(ISP_1040) 241 UMACRO(isp_1040); 242 #endif 243 #if defined(ISP_1040_IT) 244 UMACRO(isp_1040_it); 245 #endif 246 #if defined(ISP_1080) 247 UMACRO(isp_1080); 248 #endif 249 #if defined(ISP_1080_IT) 250 UMACRO(isp_1080_it); 251 #endif 252 #if defined(ISP_12160) 253 UMACRO(isp_12160); 254 #endif 255 #if defined(ISP_12160_IT) 256 UMACRO(isp_12160_it); 257 #endif 258 #if defined(ISP_2100) 259 UMACRO(isp_2100); 260 #endif 261 #if defined(ISP_2200) 262 UMACRO(isp_2200); 263 #endif 264 #if defined(ISP_2300) 265 UMACRO(isp_2300); 266 #endif 267 #if defined(ISP_2322) 268 UMACRO(isp_2322); 269 #endif 270 #if defined(ISP_2400) 271 UMACRO(isp_2400); 272 #endif 273 #if defined(ISP_2400_MULTI) 274 UMACRO(isp_2400_multi); 275 #endif 276 #if defined(ISP_2500) 277 UMACRO(isp_2500); 278 #endif 279 #if defined(ISP_2500_MULTI) 280 UMACRO(isp_2500_multi); 281 #endif 282 } 283 284 static int 285 module_handler(module_t mod, int what, void *arg) 286 { 287 288 switch (what) { 289 case MOD_LOAD: 290 do_load_fw(); 291 break; 292 case MOD_UNLOAD: 293 do_unload_fw(); 294 break; 295 case MOD_SHUTDOWN: 296 break; 297 default: 298 return (EOPNOTSUPP); 299 } 300 return (0); 301 } 302 static moduledata_t ispfw_mod = { 303 MODULE_NAME, module_handler, NULL 304 }; 305 #if defined(ISP_ALL) || !defined(KLD_MODULE) 306 DECLARE_MODULE(ispfw, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 307 #elif defined(ISP_1000) 308 DECLARE_MODULE(isp_1000, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 309 #elif defined(ISP_1040) 310 DECLARE_MODULE(isp_1040, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 311 #elif defined(ISP_1040_IT) 312 DECLARE_MODULE(isp_1040_it, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 313 #elif defined(ISP_1080) 314 DECLARE_MODULE(isp_1080, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 315 #elif defined(ISP_1080_IT) 316 DECLARE_MODULE(isp_1080_it, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 317 #elif defined(ISP_12160) 318 DECLARE_MODULE(isp_12160, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 319 #elif defined(ISP_12160_IT) 320 DECLARE_MODULE(isp_12160_IT, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 321 #elif defined(ISP_2100) 322 DECLARE_MODULE(isp_2100, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 323 #elif defined(ISP_2200) 324 DECLARE_MODULE(isp_2200, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 325 #elif defined(ISP_2300) 326 DECLARE_MODULE(isp_2300, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 327 #elif defined(ISP_2322) 328 DECLARE_MODULE(isp_2322, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 329 #elif defined(ISP_2400) 330 DECLARE_MODULE(isp_2400, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 331 #elif defined(ISP_2400_MULTI) 332 DECLARE_MODULE(isp_2400_multi, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 333 #elif defined(ISP_2500) 334 DECLARE_MODULE(isp_2500, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 335 #elif defined(ISP_2500_MULTI) 336 DECLARE_MODULE(isp_2500_multi, ispfw_mod, SI_SUB_DRIVERS, SI_ORDER_THIRD); 337 #else 338 #error "firmware not specified" 339 #endif 340