1 /*- 2 * Copyright (c) 1997, 1998, 1999 Nicolas Souchu 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$ 27 * 28 */ 29 #include "opt_ppb_1284.h" 30 31 #include <sys/param.h> 32 #include <sys/systm.h> 33 #include <sys/kernel.h> 34 #include <sys/module.h> 35 #include <sys/bus.h> 36 #include <sys/malloc.h> 37 38 #include <dev/ppbus/ppbconf.h> 39 #include <dev/ppbus/ppb_1284.h> 40 41 #include "ppbus_if.h" 42 43 #define DEVTOSOFTC(dev) ((struct ppb_data *)device_get_softc(dev)) 44 45 static MALLOC_DEFINE(M_PPBUSDEV, "ppbusdev", "Parallel Port bus device"); 46 47 48 /* 49 * Device methods 50 */ 51 52 static void 53 ppbus_print_child(device_t bus, device_t dev) 54 { 55 struct ppb_device *ppbdev; 56 57 bus_print_child_header(bus, dev); 58 59 ppbdev = (struct ppb_device *)device_get_ivars(dev); 60 61 if (ppbdev->flags != 0) 62 printf(" flags 0x%x", ppbdev->flags); 63 64 printf(" on %s%d\n", device_get_name(bus), device_get_unit(bus)); 65 66 return; 67 } 68 69 static int 70 ppbus_probe(device_t dev) 71 { 72 device_set_desc(dev, "Parallel port bus"); 73 74 return (0); 75 } 76 77 /* 78 * ppbus_add_child() 79 * 80 * Add a ppbus device, allocate/initialize the ivars 81 */ 82 static device_t 83 ppbus_add_child(device_t dev, int order, const char *name, int unit) 84 { 85 struct ppb_device *ppbdev; 86 device_t child; 87 88 /* allocate ivars for the new ppbus child */ 89 ppbdev = malloc(sizeof(struct ppb_device), M_PPBUSDEV, 90 M_NOWAIT | M_ZERO); 91 if (!ppbdev) 92 return NULL; 93 94 /* initialize the ivars */ 95 ppbdev->name = name; 96 97 /* add the device as a child to the ppbus bus with the allocated 98 * ivars */ 99 child = device_add_child_ordered(dev, order, name, unit); 100 device_set_ivars(child, ppbdev); 101 102 return child; 103 } 104 105 static int 106 ppbus_read_ivar(device_t bus, device_t dev, int index, uintptr_t* val) 107 { 108 struct ppb_device *ppbdev = (struct ppb_device *)device_get_ivars(dev); 109 110 switch (index) { 111 case PPBUS_IVAR_MODE: 112 /* XXX yet device mode = ppbus mode = chipset mode */ 113 *val = (u_long)ppb_get_mode(bus); 114 ppbdev->mode = (u_short)*val; 115 break; 116 case PPBUS_IVAR_AVM: 117 *val = (u_long)ppbdev->avm; 118 break; 119 case PPBUS_IVAR_IRQ: 120 BUS_READ_IVAR(device_get_parent(bus), bus, PPC_IVAR_IRQ, val); 121 break; 122 default: 123 return (ENOENT); 124 } 125 126 return (0); 127 } 128 129 static int 130 ppbus_write_ivar(device_t bus, device_t dev, int index, u_long val) 131 { 132 struct ppb_device *ppbdev = (struct ppb_device *)device_get_ivars(dev); 133 134 switch (index) { 135 case PPBUS_IVAR_MODE: 136 /* XXX yet device mode = ppbus mode = chipset mode */ 137 ppb_set_mode(bus,val); 138 ppbdev->mode = ppb_get_mode(bus); 139 break; 140 default: 141 return (ENOENT); 142 } 143 144 return (0); 145 } 146 147 #define PPB_PNP_PRINTER 0 148 #define PPB_PNP_MODEM 1 149 #define PPB_PNP_NET 2 150 #define PPB_PNP_HDC 3 151 #define PPB_PNP_PCMCIA 4 152 #define PPB_PNP_MEDIA 5 153 #define PPB_PNP_FDC 6 154 #define PPB_PNP_PORTS 7 155 #define PPB_PNP_SCANNER 8 156 #define PPB_PNP_DIGICAM 9 157 158 #ifndef DONTPROBE_1284 159 160 static char *pnp_tokens[] = { 161 "PRINTER", "MODEM", "NET", "HDC", "PCMCIA", "MEDIA", 162 "FDC", "PORTS", "SCANNER", "DIGICAM", "", NULL }; 163 164 #if 0 165 static char *pnp_classes[] = { 166 "printer", "modem", "network device", 167 "hard disk", "PCMCIA", "multimedia device", 168 "floppy disk", "ports", "scanner", 169 "digital camera", "unknown device", NULL }; 170 #endif 171 172 /* 173 * search_token() 174 * 175 * Search the first occurence of a token within a string 176 */ 177 static char * 178 search_token(char *str, int slen, char *token) 179 { 180 char *p; 181 int tlen, i, j; 182 183 #define UNKNOWN_LENGTH -1 184 185 if (slen == UNKNOWN_LENGTH) 186 /* get string's length */ 187 slen = strlen(str); 188 189 /* get token's length */ 190 tlen = strlen(token); 191 if (tlen == 0) 192 return (str); 193 194 for (i = 0; i <= slen-tlen; i++) { 195 if (strncmp(str + i, token, tlen) == 0) 196 return (&str[i]); 197 } 198 199 return (NULL); 200 } 201 202 /* 203 * ppb_pnp_detect() 204 * 205 * Returns the class id. of the peripherial, -1 otherwise 206 */ 207 static int 208 ppb_pnp_detect(device_t bus) 209 { 210 char *token, *class = 0; 211 int i, len, error; 212 int class_id = -1; 213 char str[PPB_PnP_STRING_SIZE+1]; 214 int unit = device_get_unit(bus); 215 216 printf("Probing for PnP devices on ppbus%d:\n", unit); 217 218 if ((error = ppb_1284_read_id(bus, PPB_NIBBLE, str, 219 PPB_PnP_STRING_SIZE, &len))) 220 goto end_detect; 221 222 #ifdef DEBUG_1284 223 printf("ppb: <PnP> %d characters: ", len); 224 for (i = 0; i < len; i++) 225 printf("%c(0x%x) ", str[i], str[i]); 226 printf("\n"); 227 #endif 228 229 /* replace ';' characters by '\0' */ 230 for (i = 0; i < len; i++) 231 str[i] = (str[i] == ';') ? '\0' : str[i]; 232 233 if ((token = search_token(str, len, "MFG")) != NULL || 234 (token = search_token(str, len, "MANUFACTURER")) != NULL) 235 printf("ppbus%d: <%s", unit, 236 search_token(token, UNKNOWN_LENGTH, ":") + 1); 237 else 238 printf("ppbus%d: <unknown", unit); 239 240 if ((token = search_token(str, len, "MDL")) != NULL || 241 (token = search_token(str, len, "MODEL")) != NULL) 242 printf(" %s", 243 search_token(token, UNKNOWN_LENGTH, ":") + 1); 244 else 245 printf(" unknown"); 246 247 if ((token = search_token(str, len, "VER")) != NULL) 248 printf("/%s", 249 search_token(token, UNKNOWN_LENGTH, ":") + 1); 250 251 if ((token = search_token(str, len, "REV")) != NULL) 252 printf(".%s", 253 search_token(token, UNKNOWN_LENGTH, ":") + 1); 254 255 printf(">"); 256 257 if ((token = search_token(str, len, "CLS")) != NULL) { 258 class = search_token(token, UNKNOWN_LENGTH, ":") + 1; 259 printf(" %s", class); 260 } 261 262 if ((token = search_token(str, len, "CMD")) != NULL || 263 (token = search_token(str, len, "COMMAND")) != NULL) 264 printf(" %s", 265 search_token(token, UNKNOWN_LENGTH, ":") + 1); 266 267 printf("\n"); 268 269 if (class) 270 /* identify class ident */ 271 for (i = 0; pnp_tokens[i] != NULL; i++) { 272 if (search_token(class, len, pnp_tokens[i]) != NULL) { 273 class_id = i; 274 goto end_detect; 275 } 276 } 277 278 class_id = PPB_PnP_UNKNOWN; 279 280 end_detect: 281 return (class_id); 282 } 283 284 /* 285 * ppb_scan_bus() 286 * 287 * Scan the ppbus for IEEE1284 compliant devices 288 */ 289 static int 290 ppb_scan_bus(device_t bus) 291 { 292 struct ppb_data * ppb = (struct ppb_data *)device_get_softc(bus); 293 int error = 0; 294 int unit = device_get_unit(bus); 295 296 /* try all IEEE1284 modes, for one device only 297 * 298 * XXX We should implement the IEEE1284.3 standard to detect 299 * daisy chained devices 300 */ 301 302 error = ppb_1284_negociate(bus, PPB_NIBBLE, PPB_REQUEST_ID); 303 304 if ((ppb->state == PPB_ERROR) && (ppb->error == PPB_NOT_IEEE1284)) 305 goto end_scan; 306 307 ppb_1284_terminate(bus); 308 309 printf("ppbus%d: IEEE1284 device found ", unit); 310 311 if (!(error = ppb_1284_negociate(bus, PPB_NIBBLE, 0))) { 312 printf("/NIBBLE"); 313 ppb_1284_terminate(bus); 314 } 315 316 if (!(error = ppb_1284_negociate(bus, PPB_PS2, 0))) { 317 printf("/PS2"); 318 ppb_1284_terminate(bus); 319 } 320 321 if (!(error = ppb_1284_negociate(bus, PPB_ECP, 0))) { 322 printf("/ECP"); 323 ppb_1284_terminate(bus); 324 } 325 326 if (!(error = ppb_1284_negociate(bus, PPB_ECP, PPB_USE_RLE))) { 327 printf("/ECP_RLE"); 328 ppb_1284_terminate(bus); 329 } 330 331 if (!(error = ppb_1284_negociate(bus, PPB_EPP, 0))) { 332 printf("/EPP"); 333 ppb_1284_terminate(bus); 334 } 335 336 /* try more IEEE1284 modes */ 337 if (bootverbose) { 338 if (!(error = ppb_1284_negociate(bus, PPB_NIBBLE, 339 PPB_REQUEST_ID))) { 340 printf("/NIBBLE_ID"); 341 ppb_1284_terminate(bus); 342 } 343 344 if (!(error = ppb_1284_negociate(bus, PPB_PS2, 345 PPB_REQUEST_ID))) { 346 printf("/PS2_ID"); 347 ppb_1284_terminate(bus); 348 } 349 350 if (!(error = ppb_1284_negociate(bus, PPB_ECP, 351 PPB_REQUEST_ID))) { 352 printf("/ECP_ID"); 353 ppb_1284_terminate(bus); 354 } 355 356 if (!(error = ppb_1284_negociate(bus, PPB_ECP, 357 PPB_REQUEST_ID | PPB_USE_RLE))) { 358 printf("/ECP_RLE_ID"); 359 ppb_1284_terminate(bus); 360 } 361 362 if (!(error = ppb_1284_negociate(bus, PPB_COMPATIBLE, 363 PPB_EXTENSIBILITY_LINK))) { 364 printf("/Extensibility Link"); 365 ppb_1284_terminate(bus); 366 } 367 } 368 369 printf("\n"); 370 371 /* detect PnP devices */ 372 ppb->class_id = ppb_pnp_detect(bus); 373 374 return (0); 375 376 end_scan: 377 return (error); 378 } 379 380 #endif /* !DONTPROBE_1284 */ 381 382 static int 383 ppbus_attach(device_t dev) 384 { 385 386 /* Locate our children */ 387 bus_generic_probe(dev); 388 389 #ifndef DONTPROBE_1284 390 /* detect IEEE1284 compliant devices */ 391 ppb_scan_bus(dev); 392 #endif /* !DONTPROBE_1284 */ 393 394 /* launch attachement of the added children */ 395 bus_generic_attach(dev); 396 397 return 0; 398 } 399 400 static int 401 ppbus_setup_intr(device_t bus, device_t child, struct resource *r, int flags, 402 void (*ihand)(void *), void *arg, void **cookiep) 403 { 404 int error; 405 struct ppb_data *ppb = DEVTOSOFTC(bus); 406 struct ppb_device *ppbdev = (struct ppb_device *)device_get_ivars(child); 407 408 /* a device driver must own the bus to register an interrupt */ 409 if (ppb->ppb_owner != child) 410 return (EINVAL); 411 412 if ((error = BUS_SETUP_INTR(device_get_parent(bus), child, r, flags, 413 ihand, arg, cookiep))) 414 return (error); 415 416 /* store the resource and the cookie for eventually forcing 417 * handler unregistration 418 */ 419 ppbdev->intr_cookie = *cookiep; 420 ppbdev->intr_resource = r; 421 422 return (0); 423 } 424 425 static int 426 ppbus_teardown_intr(device_t bus, device_t child, struct resource *r, void *ih) 427 { 428 struct ppb_data *ppb = DEVTOSOFTC(bus); 429 struct ppb_device *ppbdev = (struct ppb_device *)device_get_ivars(child); 430 431 /* a device driver must own the bus to unregister an interrupt */ 432 if ((ppb->ppb_owner != child) || (ppbdev->intr_cookie != ih) || 433 (ppbdev->intr_resource != r)) 434 return (EINVAL); 435 436 ppbdev->intr_cookie = 0; 437 ppbdev->intr_resource = 0; 438 439 /* pass unregistration to the upper layer */ 440 return (BUS_TEARDOWN_INTR(device_get_parent(bus), child, r, ih)); 441 } 442 443 /* 444 * ppb_request_bus() 445 * 446 * Allocate the device to perform transfers. 447 * 448 * how : PPB_WAIT or PPB_DONTWAIT 449 */ 450 int 451 ppb_request_bus(device_t bus, device_t dev, int how) 452 { 453 int s, error = 0; 454 struct ppb_data *ppb = DEVTOSOFTC(bus); 455 struct ppb_device *ppbdev = (struct ppb_device *)device_get_ivars(dev); 456 457 while (!error) { 458 s = splhigh(); 459 if (ppb->ppb_owner) { 460 splx(s); 461 462 switch (how) { 463 case (PPB_WAIT | PPB_INTR): 464 error = tsleep(ppb, PPBPRI|PCATCH, "ppbreq", 0); 465 break; 466 467 case (PPB_WAIT | PPB_NOINTR): 468 error = tsleep(ppb, PPBPRI, "ppbreq", 0); 469 break; 470 471 default: 472 return (EWOULDBLOCK); 473 break; 474 } 475 476 } else { 477 ppb->ppb_owner = dev; 478 479 /* restore the context of the device 480 * The first time, ctx.valid is certainly false 481 * then do not change anything. This is usefull for 482 * drivers that do not set there operating mode 483 * during attachement 484 */ 485 if (ppbdev->ctx.valid) 486 ppb_set_mode(bus, ppbdev->ctx.mode); 487 488 splx(s); 489 return (0); 490 } 491 } 492 493 return (error); 494 } 495 496 /* 497 * ppb_release_bus() 498 * 499 * Release the device allocated with ppb_request_bus() 500 */ 501 int 502 ppb_release_bus(device_t bus, device_t dev) 503 { 504 int s, error; 505 struct ppb_data *ppb = DEVTOSOFTC(bus); 506 struct ppb_device *ppbdev = (struct ppb_device *)device_get_ivars(dev); 507 508 if (ppbdev->intr_resource != 0) 509 /* force interrupt handler unregistration when the ppbus is released */ 510 if ((error = BUS_TEARDOWN_INTR(bus, dev, ppbdev->intr_resource, 511 ppbdev->intr_cookie))) 512 return (error); 513 514 s = splhigh(); 515 if (ppb->ppb_owner != dev) { 516 splx(s); 517 return (EACCES); 518 } 519 520 ppb->ppb_owner = 0; 521 splx(s); 522 523 /* save the context of the device */ 524 ppbdev->ctx.mode = ppb_get_mode(bus); 525 526 /* ok, now the context of the device is valid */ 527 ppbdev->ctx.valid = 1; 528 529 /* wakeup waiting processes */ 530 wakeup(ppb); 531 532 return (0); 533 } 534 535 static devclass_t ppbus_devclass; 536 537 static device_method_t ppbus_methods[] = { 538 /* device interface */ 539 DEVMETHOD(device_probe, ppbus_probe), 540 DEVMETHOD(device_attach, ppbus_attach), 541 542 /* bus interface */ 543 DEVMETHOD(bus_add_child, ppbus_add_child), 544 DEVMETHOD(bus_print_child, ppbus_print_child), 545 DEVMETHOD(bus_read_ivar, ppbus_read_ivar), 546 DEVMETHOD(bus_write_ivar, ppbus_write_ivar), 547 DEVMETHOD(bus_setup_intr, ppbus_setup_intr), 548 DEVMETHOD(bus_teardown_intr, ppbus_teardown_intr), 549 DEVMETHOD(bus_alloc_resource, bus_generic_alloc_resource), 550 551 { 0, 0 } 552 }; 553 554 static driver_t ppbus_driver = { 555 "ppbus", 556 ppbus_methods, 557 sizeof(struct ppb_data), 558 }; 559 DRIVER_MODULE(ppbus, ppc, ppbus_driver, ppbus_devclass, 0, 0); 560