ppbconf.c revision 185003
1251881Speter/*- 2251881Speter * Copyright (c) 1997, 1998, 1999 Nicolas Souchu 3251881Speter * All rights reserved. 4251881Speter * 5251881Speter * Redistribution and use in source and binary forms, with or without 6251881Speter * modification, are permitted provided that the following conditions 7251881Speter * are met: 8251881Speter * 1. Redistributions of source code must retain the above copyright 9251881Speter * notice, this list of conditions and the following disclaimer. 10251881Speter * 2. Redistributions in binary form must reproduce the above copyright 11251881Speter * notice, this list of conditions and the following disclaimer in the 12251881Speter * documentation and/or other materials provided with the distribution. 13251881Speter * 14251881Speter * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15251881Speter * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16251881Speter * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17251881Speter * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18251881Speter * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19251881Speter * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20251881Speter * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21251881Speter * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22251881Speter * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23251881Speter * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24251881Speter * SUCH DAMAGE. 25251881Speter * 26251881Speter * 27251881Speter */ 28251881Speter 29251881Speter#include <sys/cdefs.h> 30251881Speter__FBSDID("$FreeBSD: head/sys/dev/ppbus/ppbconf.c 185003 2008-11-16 17:42:02Z jhb $"); 31251881Speter#include "opt_ppb_1284.h" 32251881Speter 33251881Speter#include <sys/param.h> 34251881Speter#include <sys/systm.h> 35251881Speter#include <sys/kernel.h> 36251881Speter#include <sys/module.h> 37251881Speter#include <sys/bus.h> 38251881Speter#include <sys/malloc.h> 39251881Speter#include <sys/rman.h> 40251881Speter 41251881Speter#include <machine/resource.h> 42251881Speter 43251881Speter#include <dev/ppbus/ppbconf.h> 44251881Speter#include <dev/ppbus/ppb_1284.h> 45251881Speter 46251881Speter#include "ppbus_if.h" 47251881Speter 48251881Speter#define DEVTOSOFTC(dev) ((struct ppb_data *)device_get_softc(dev)) 49251881Speter 50251881Speterstatic MALLOC_DEFINE(M_PPBUSDEV, "ppbusdev", "Parallel Port bus device"); 51251881Speter 52251881Speter 53251881Speter/* 54251881Speter * Device methods 55251881Speter */ 56251881Speter 57251881Speterstatic int 58251881Speterppbus_print_child(device_t bus, device_t dev) 59251881Speter{ 60251881Speter struct ppb_device *ppbdev; 61251881Speter int retval; 62251881Speter 63251881Speter retval = bus_print_child_header(bus, dev); 64251881Speter 65251881Speter ppbdev = (struct ppb_device *)device_get_ivars(dev); 66251881Speter 67251881Speter if (ppbdev->flags != 0) 68251881Speter retval += printf(" flags 0x%x", ppbdev->flags); 69251881Speter 70251881Speter retval += bus_print_child_footer(bus, dev); 71251881Speter 72251881Speter return (retval); 73251881Speter} 74251881Speter 75251881Speterstatic int 76251881Speterppbus_probe(device_t dev) 77251881Speter{ 78251881Speter device_set_desc(dev, "Parallel port bus"); 79251881Speter 80251881Speter return (0); 81251881Speter} 82251881Speter 83251881Speter/* 84251881Speter * ppbus_add_child() 85251881Speter * 86251881Speter * Add a ppbus device, allocate/initialize the ivars 87251881Speter */ 88251881Speterstatic device_t 89251881Speterppbus_add_child(device_t dev, int order, const char *name, int unit) 90251881Speter{ 91251881Speter struct ppb_device *ppbdev; 92251881Speter device_t child; 93251881Speter 94251881Speter /* allocate ivars for the new ppbus child */ 95251881Speter ppbdev = malloc(sizeof(struct ppb_device), M_PPBUSDEV, 96251881Speter M_NOWAIT | M_ZERO); 97251881Speter if (!ppbdev) 98251881Speter return (NULL); 99251881Speter 100251881Speter /* initialize the ivars */ 101251881Speter ppbdev->name = name; 102251881Speter 103251881Speter /* add the device as a child to the ppbus bus with the allocated 104251881Speter * ivars */ 105251881Speter child = device_add_child_ordered(dev, order, name, unit); 106251881Speter device_set_ivars(child, ppbdev); 107251881Speter 108251881Speter return (child); 109251881Speter} 110251881Speter 111251881Speterstatic int 112251881Speterppbus_read_ivar(device_t bus, device_t dev, int index, uintptr_t* val) 113251881Speter{ 114251881Speter 115251881Speter switch (index) { 116251881Speter case PPBUS_IVAR_MODE: 117251881Speter /* XXX yet device mode = ppbus mode = chipset mode */ 118251881Speter *val = (u_long)ppb_get_mode(bus); 119251881Speter break; 120251881Speter default: 121251881Speter return (ENOENT); 122251881Speter } 123251881Speter 124251881Speter return (0); 125251881Speter} 126251881Speter 127251881Speterstatic int 128251881Speterppbus_write_ivar(device_t bus, device_t dev, int index, uintptr_t val) 129251881Speter{ 130251881Speter 131251881Speter switch (index) { 132251881Speter case PPBUS_IVAR_MODE: 133251881Speter /* XXX yet device mode = ppbus mode = chipset mode */ 134251881Speter ppb_set_mode(bus, val); 135251881Speter break; 136251881Speter default: 137251881Speter return (ENOENT); 138251881Speter } 139251881Speter 140251881Speter return (0); 141251881Speter} 142251881Speter 143251881Speter#define PPB_PNP_PRINTER 0 144251881Speter#define PPB_PNP_MODEM 1 145251881Speter#define PPB_PNP_NET 2 146251881Speter#define PPB_PNP_HDC 3 147251881Speter#define PPB_PNP_PCMCIA 4 148251881Speter#define PPB_PNP_MEDIA 5 149251881Speter#define PPB_PNP_FDC 6 150251881Speter#define PPB_PNP_PORTS 7 151251881Speter#define PPB_PNP_SCANNER 8 152251881Speter#define PPB_PNP_DIGICAM 9 153251881Speter 154251881Speter#ifndef DONTPROBE_1284 155251881Speter 156251881Speterstatic char *pnp_tokens[] = { 157251881Speter "PRINTER", "MODEM", "NET", "HDC", "PCMCIA", "MEDIA", 158251881Speter "FDC", "PORTS", "SCANNER", "DIGICAM", "", NULL }; 159251881Speter 160251881Speter#if 0 161251881Speterstatic char *pnp_classes[] = { 162251881Speter "printer", "modem", "network device", 163251881Speter "hard disk", "PCMCIA", "multimedia device", 164251881Speter "floppy disk", "ports", "scanner", 165251881Speter "digital camera", "unknown device", NULL }; 166251881Speter#endif 167251881Speter 168251881Speter/* 169251881Speter * search_token() 170251881Speter * 171251881Speter * Search the first occurence of a token within a string 172251881Speter */ 173251881Speterstatic char * 174251881Spetersearch_token(char *str, int slen, char *token) 175251881Speter{ 176251881Speter int tlen, i; 177251881Speter 178251881Speter#define UNKNOWN_LENGTH -1 179251881Speter 180251881Speter if (slen == UNKNOWN_LENGTH) 181251881Speter /* get string's length */ 182251881Speter slen = strlen(str); 183251881Speter 184251881Speter /* get token's length */ 185251881Speter tlen = strlen(token); 186251881Speter if (tlen == 0) 187251881Speter return (str); 188251881Speter 189251881Speter for (i = 0; i <= slen-tlen; i++) { 190251881Speter if (strncmp(str + i, token, tlen) == 0) 191251881Speter return (&str[i]); 192251881Speter } 193251881Speter 194251881Speter return (NULL); 195251881Speter} 196251881Speter 197251881Speter/* 198251881Speter * ppb_pnp_detect() 199251881Speter * 200251881Speter * Returns the class id. of the peripherial, -1 otherwise 201251881Speter */ 202251881Speterstatic int 203251881Speterppb_pnp_detect(device_t bus) 204251881Speter{ 205251881Speter char *token, *class = 0; 206251881Speter int i, len, error; 207251881Speter int class_id = -1; 208251881Speter char str[PPB_PnP_STRING_SIZE+1]; 209251881Speter 210251881Speter device_printf(bus, "Probing for PnP devices:\n"); 211251881Speter 212251881Speter if ((error = ppb_1284_read_id(bus, PPB_NIBBLE, str, 213251881Speter PPB_PnP_STRING_SIZE, &len))) 214251881Speter goto end_detect; 215251881Speter 216251881Speter#ifdef DEBUG_1284 217251881Speter device_printf(bus, "<PnP> %d characters: ", len); 218251881Speter for (i = 0; i < len; i++) 219251881Speter printf("%c(0x%x) ", str[i], str[i]); 220251881Speter printf("\n"); 221251881Speter#endif 222251881Speter 223251881Speter /* replace ';' characters by '\0' */ 224251881Speter for (i = 0; i < len; i++) 225251881Speter str[i] = (str[i] == ';') ? '\0' : str[i]; 226251881Speter 227251881Speter if ((token = search_token(str, len, "MFG")) != NULL || 228251881Speter (token = search_token(str, len, "MANUFACTURER")) != NULL) 229251881Speter device_printf(bus, "<%s", 230251881Speter search_token(token, UNKNOWN_LENGTH, ":") + 1); 231251881Speter else 232251881Speter device_printf(bus, "<unknown"); 233251881Speter 234251881Speter if ((token = search_token(str, len, "MDL")) != NULL || 235251881Speter (token = search_token(str, len, "MODEL")) != NULL) 236251881Speter printf(" %s", 237251881Speter search_token(token, UNKNOWN_LENGTH, ":") + 1); 238251881Speter else 239251881Speter printf(" unknown"); 240251881Speter 241251881Speter if ((token = search_token(str, len, "VER")) != NULL) 242251881Speter printf("/%s", 243251881Speter search_token(token, UNKNOWN_LENGTH, ":") + 1); 244251881Speter 245251881Speter if ((token = search_token(str, len, "REV")) != NULL) 246251881Speter printf(".%s", 247251881Speter search_token(token, UNKNOWN_LENGTH, ":") + 1); 248251881Speter 249251881Speter printf(">"); 250251881Speter 251251881Speter if ((token = search_token(str, len, "CLS")) != NULL) { 252251881Speter class = search_token(token, UNKNOWN_LENGTH, ":") + 1; 253251881Speter printf(" %s", class); 254251881Speter } 255251881Speter 256251881Speter if ((token = search_token(str, len, "CMD")) != NULL || 257251881Speter (token = search_token(str, len, "COMMAND")) != NULL) 258251881Speter printf(" %s", 259251881Speter search_token(token, UNKNOWN_LENGTH, ":") + 1); 260251881Speter 261251881Speter printf("\n"); 262251881Speter 263251881Speter if (class) 264251881Speter /* identify class ident */ 265251881Speter for (i = 0; pnp_tokens[i] != NULL; i++) { 266251881Speter if (search_token(class, len, pnp_tokens[i]) != NULL) { 267251881Speter class_id = i; 268251881Speter goto end_detect; 269251881Speter } 270251881Speter } 271 272 class_id = PPB_PnP_UNKNOWN; 273 274end_detect: 275 return (class_id); 276} 277 278/* 279 * ppb_scan_bus() 280 * 281 * Scan the ppbus for IEEE1284 compliant devices 282 */ 283static int 284ppb_scan_bus(device_t bus) 285{ 286 struct ppb_data * ppb = (struct ppb_data *)device_get_softc(bus); 287 int error = 0; 288 289 /* try all IEEE1284 modes, for one device only 290 * 291 * XXX We should implement the IEEE1284.3 standard to detect 292 * daisy chained devices 293 */ 294 295 error = ppb_1284_negociate(bus, PPB_NIBBLE, PPB_REQUEST_ID); 296 297 if ((ppb->state == PPB_ERROR) && (ppb->error == PPB_NOT_IEEE1284)) 298 goto end_scan; 299 300 ppb_1284_terminate(bus); 301 302 device_printf(bus, "IEEE1284 device found "); 303 304 if (!(error = ppb_1284_negociate(bus, PPB_NIBBLE, 0))) { 305 printf("/NIBBLE"); 306 ppb_1284_terminate(bus); 307 } 308 309 if (!(error = ppb_1284_negociate(bus, PPB_PS2, 0))) { 310 printf("/PS2"); 311 ppb_1284_terminate(bus); 312 } 313 314 if (!(error = ppb_1284_negociate(bus, PPB_ECP, 0))) { 315 printf("/ECP"); 316 ppb_1284_terminate(bus); 317 } 318 319 if (!(error = ppb_1284_negociate(bus, PPB_ECP, PPB_USE_RLE))) { 320 printf("/ECP_RLE"); 321 ppb_1284_terminate(bus); 322 } 323 324 if (!(error = ppb_1284_negociate(bus, PPB_EPP, 0))) { 325 printf("/EPP"); 326 ppb_1284_terminate(bus); 327 } 328 329 /* try more IEEE1284 modes */ 330 if (bootverbose) { 331 if (!(error = ppb_1284_negociate(bus, PPB_NIBBLE, 332 PPB_REQUEST_ID))) { 333 printf("/NIBBLE_ID"); 334 ppb_1284_terminate(bus); 335 } 336 337 if (!(error = ppb_1284_negociate(bus, PPB_PS2, 338 PPB_REQUEST_ID))) { 339 printf("/PS2_ID"); 340 ppb_1284_terminate(bus); 341 } 342 343 if (!(error = ppb_1284_negociate(bus, PPB_ECP, 344 PPB_REQUEST_ID))) { 345 printf("/ECP_ID"); 346 ppb_1284_terminate(bus); 347 } 348 349 if (!(error = ppb_1284_negociate(bus, PPB_ECP, 350 PPB_REQUEST_ID | PPB_USE_RLE))) { 351 printf("/ECP_RLE_ID"); 352 ppb_1284_terminate(bus); 353 } 354 355 if (!(error = ppb_1284_negociate(bus, PPB_COMPATIBLE, 356 PPB_EXTENSIBILITY_LINK))) { 357 printf("/Extensibility Link"); 358 ppb_1284_terminate(bus); 359 } 360 } 361 362 printf("\n"); 363 364 /* detect PnP devices */ 365 ppb->class_id = ppb_pnp_detect(bus); 366 367 return (0); 368 369end_scan: 370 return (error); 371} 372 373#endif /* !DONTPROBE_1284 */ 374 375static int 376ppbus_attach(device_t dev) 377{ 378 379 /* Locate our children */ 380 bus_generic_probe(dev); 381 382#ifndef DONTPROBE_1284 383 /* detect IEEE1284 compliant devices */ 384 ppb_scan_bus(dev); 385#endif /* !DONTPROBE_1284 */ 386 387 /* launch attachment of the added children */ 388 bus_generic_attach(dev); 389 390 return (0); 391} 392 393static int 394ppbus_detach(device_t dev) 395{ 396 device_t *children; 397 int error, nchildren, i; 398 399 error = bus_generic_detach(dev); 400 if (error) 401 return (error); 402 403 /* detach & delete all children */ 404 if (!device_get_children(dev, &children, &nchildren)) { 405 for (i = 0; i < nchildren; i++) 406 if (children[i]) 407 device_delete_child(dev, children[i]); 408 free(children, M_TEMP); 409 } 410 411 return (0); 412} 413 414static int 415ppbus_setup_intr(device_t bus, device_t child, struct resource *r, int flags, 416 driver_filter_t *filt, void (*ihand)(void *), void *arg, void **cookiep) 417{ 418 int error; 419 struct ppb_data *ppb = DEVTOSOFTC(bus); 420 struct ppb_device *ppbdev = device_get_ivars(child); 421 422 /* a device driver must own the bus to register an interrupt */ 423 if (ppb->ppb_owner != child) 424 return (EINVAL); 425 426 if ((error = BUS_SETUP_INTR(device_get_parent(bus), child, r, flags, 427 filt, ihand, arg, cookiep))) 428 return (error); 429 430 /* store the resource and the cookie for eventually forcing 431 * handler unregistration 432 */ 433 ppbdev->intr_cookie = *cookiep; 434 ppbdev->intr_resource = r; 435 436 return (0); 437} 438 439static int 440ppbus_teardown_intr(device_t bus, device_t child, struct resource *r, void *ih) 441{ 442 struct ppb_data *ppb = DEVTOSOFTC(bus); 443 struct ppb_device *ppbdev = (struct ppb_device *)device_get_ivars(child); 444 445 /* a device driver must own the bus to unregister an interrupt */ 446 if ((ppb->ppb_owner != child) || (ppbdev->intr_cookie != ih) || 447 (ppbdev->intr_resource != r)) 448 return (EINVAL); 449 450 ppbdev->intr_cookie = 0; 451 ppbdev->intr_resource = 0; 452 453 /* pass unregistration to the upper layer */ 454 return (BUS_TEARDOWN_INTR(device_get_parent(bus), child, r, ih)); 455} 456 457/* 458 * ppb_request_bus() 459 * 460 * Allocate the device to perform transfers. 461 * 462 * how : PPB_WAIT or PPB_DONTWAIT 463 */ 464int 465ppb_request_bus(device_t bus, device_t dev, int how) 466{ 467 int s, error = 0; 468 struct ppb_data *ppb = DEVTOSOFTC(bus); 469 struct ppb_device *ppbdev = (struct ppb_device *)device_get_ivars(dev); 470 471 while (!error) { 472 s = splhigh(); 473 if (ppb->ppb_owner) { 474 splx(s); 475 476 switch (how) { 477 case (PPB_WAIT | PPB_INTR): 478 error = tsleep(ppb, PPBPRI|PCATCH, "ppbreq", 0); 479 break; 480 481 case (PPB_WAIT | PPB_NOINTR): 482 error = tsleep(ppb, PPBPRI, "ppbreq", 0); 483 break; 484 485 default: 486 return (EWOULDBLOCK); 487 break; 488 } 489 490 } else { 491 ppb->ppb_owner = dev; 492 493 /* restore the context of the device 494 * The first time, ctx.valid is certainly false 495 * then do not change anything. This is usefull for 496 * drivers that do not set there operating mode 497 * during attachement 498 */ 499 if (ppbdev->ctx.valid) 500 ppb_set_mode(bus, ppbdev->ctx.mode); 501 502 splx(s); 503 return (0); 504 } 505 } 506 507 return (error); 508} 509 510/* 511 * ppb_release_bus() 512 * 513 * Release the device allocated with ppb_request_bus() 514 */ 515int 516ppb_release_bus(device_t bus, device_t dev) 517{ 518 int s, error; 519 struct ppb_data *ppb = DEVTOSOFTC(bus); 520 struct ppb_device *ppbdev = (struct ppb_device *)device_get_ivars(dev); 521 522 if (ppbdev->intr_resource != 0) 523 /* force interrupt handler unregistration when the ppbus is released */ 524 if ((error = BUS_TEARDOWN_INTR(bus, dev, ppbdev->intr_resource, 525 ppbdev->intr_cookie))) 526 return (error); 527 528 s = splhigh(); 529 if (ppb->ppb_owner != dev) { 530 splx(s); 531 return (EACCES); 532 } 533 534 ppb->ppb_owner = 0; 535 splx(s); 536 537 /* save the context of the device */ 538 ppbdev->ctx.mode = ppb_get_mode(bus); 539 540 /* ok, now the context of the device is valid */ 541 ppbdev->ctx.valid = 1; 542 543 /* wakeup waiting processes */ 544 wakeup(ppb); 545 546 return (0); 547} 548 549static devclass_t ppbus_devclass; 550 551static device_method_t ppbus_methods[] = { 552 /* device interface */ 553 DEVMETHOD(device_probe, ppbus_probe), 554 DEVMETHOD(device_attach, ppbus_attach), 555 DEVMETHOD(device_detach, ppbus_detach), 556 557 /* bus interface */ 558 DEVMETHOD(bus_add_child, ppbus_add_child), 559 DEVMETHOD(bus_print_child, ppbus_print_child), 560 DEVMETHOD(bus_read_ivar, ppbus_read_ivar), 561 DEVMETHOD(bus_write_ivar, ppbus_write_ivar), 562 DEVMETHOD(bus_setup_intr, ppbus_setup_intr), 563 DEVMETHOD(bus_teardown_intr, ppbus_teardown_intr), 564 DEVMETHOD(bus_alloc_resource, bus_generic_alloc_resource), 565 DEVMETHOD(bus_release_resource, bus_generic_release_resource), 566 567 { 0, 0 } 568}; 569 570static driver_t ppbus_driver = { 571 "ppbus", 572 ppbus_methods, 573 sizeof(struct ppb_data), 574}; 575DRIVER_MODULE(ppbus, ppc, ppbus_driver, ppbus_devclass, 0, 0); 576