2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 1996, Sujal M. Patel
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
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
20 * FOR 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
28 * from: pnp.c,v 1.11 1999/05/06 22:11:19 peter Exp
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/module.h>
36 #include <sys/endian.h>
37 #include <sys/malloc.h>
38 #include <isa/isavar.h>
39 #include <isa/pnpreg.h>
40 #include <isa/pnpvar.h>
41 #include <machine/bus.h>
43 typedef struct _pnp_id {
49 struct pnp_set_config_arg {
50 int csn; /* Card number to configure */
51 int ldn; /* Logical device on card */
55 uint32_t vendor_id; /* Vendor of the card */
56 uint32_t logical_id; /* ID of the device with quirk */
58 #define PNP_QUIRK_WRITE_REG 1 /* Need to write a pnp register */
59 #define PNP_QUIRK_EXTRA_IO 2 /* Has extra io ports */
64 struct pnp_quirk pnp_quirks[] = {
66 * The Gravis UltraSound needs register 0xf2 to be set to 0xff
68 * XXX need to know the logical device id.
70 { 0x0100561e /* GRV0001 */, 0,
71 PNP_QUIRK_WRITE_REG, 0xf2, 0xff },
73 * An emu8000 does not give us other than the first
76 { 0x26008c0e /* SB16 */, 0x21008c0e,
77 PNP_QUIRK_EXTRA_IO, 0x400, 0x800 },
78 { 0x42008c0e /* SB32(CTL0042) */, 0x21008c0e,
79 PNP_QUIRK_EXTRA_IO, 0x400, 0x800 },
80 { 0x44008c0e /* SB32(CTL0044) */, 0x21008c0e,
81 PNP_QUIRK_EXTRA_IO, 0x400, 0x800 },
82 { 0x49008c0e /* SB32(CTL0049) */, 0x21008c0e,
83 PNP_QUIRK_EXTRA_IO, 0x400, 0x800 },
84 { 0xf1008c0e /* SB32(CTL00f1) */, 0x21008c0e,
85 PNP_QUIRK_EXTRA_IO, 0x400, 0x800 },
86 { 0xc1008c0e /* SB64(CTL00c1) */, 0x22008c0e,
87 PNP_QUIRK_EXTRA_IO, 0x400, 0x800 },
88 { 0xc5008c0e /* SB64(CTL00c5) */, 0x22008c0e,
89 PNP_QUIRK_EXTRA_IO, 0x400, 0x800 },
90 { 0xe4008c0e /* SB64(CTL00e4) */, 0x22008c0e,
91 PNP_QUIRK_EXTRA_IO, 0x400, 0x800 },
96 /* The READ_DATA port that we are using currently */
97 static int pnp_rd_port;
99 static void pnp_send_initiation_key(void);
100 static int pnp_get_serial(pnp_id *p);
101 static int pnp_isolation_protocol(device_t parent);
104 pnp_write(int d, u_char r)
106 outb (_PNP_ADDRESS, d);
107 outb (_PNP_WRITE_DATA, r);
111 * Send Initiation LFSR as described in "Plug and Play ISA Specification",
115 pnp_send_initiation_key(void)
120 outb(_PNP_ADDRESS, 0);
121 outb(_PNP_ADDRESS, 0); /* yes, we do need it twice! */
124 outb(_PNP_ADDRESS, cur);
126 for (i = 1; i < 32; i++) {
127 cur = (cur >> 1) | (((cur ^ (cur >> 1)) << 7) & 0xff);
128 outb(_PNP_ADDRESS, cur);
134 * Get the device's serial number. Returns 1 if the serial is valid.
137 pnp_get_serial(pnp_id *p)
139 int i, bit, valid = 0, sum = 0x6a;
140 u_char *data = (u_char *)p;
142 bzero(data, sizeof(char) * 9);
143 outb(_PNP_ADDRESS, PNP_SERIAL_ISOLATION);
144 for (i = 0; i < 72; i++) {
145 bit = inb((pnp_rd_port << 2) | 0x3) == 0x55;
146 DELAY(250); /* Delay 250 usec */
148 /* Can't Short Circuit the next evaluation, so 'and' is last */
149 bit = (inb((pnp_rd_port << 2) | 0x3) == 0xaa) && bit;
150 DELAY(250); /* Delay 250 usec */
152 valid = valid || bit;
155 (((sum ^ (sum >> 1) ^ bit) << 7) & 0xff);
156 data[i / 8] = (data[i / 8] >> 1) | (bit ? 0x80 : 0);
159 valid = valid && (data[8] == sum);
165 * Fill's the buffer with resource info from the device.
166 * Returns the number of characters read.
169 pnp_get_resource_info(u_char *buffer, int len)
175 for (i = 0; i < len; i++) {
176 outb(_PNP_ADDRESS, PNP_STATUS);
177 for (j = 0; j < 100; j++) {
178 if ((inb((pnp_rd_port << 2) | 0x3)) & 0x1)
183 printf("PnP device failed to report resource data\n");
186 outb(_PNP_ADDRESS, PNP_RESOURCE_DATA);
187 temp = inb((pnp_rd_port << 2) | 0x3);
196 * This function is called after the bus has assigned resource
197 * locations for a logical device.
200 pnp_set_config(void *arg, struct isa_config *config, int enable)
202 int csn = ((struct pnp_set_config_arg *) arg)->csn;
203 int ldn = ((struct pnp_set_config_arg *) arg)->ldn;
207 * First put all cards into Sleep state with the initiation
208 * key, then put our card into Config state.
210 pnp_send_initiation_key();
211 pnp_write(PNP_WAKE, csn);
214 * Select our logical device so that we can program it.
216 pnp_write(PNP_SET_LDN, ldn);
219 * Constrain the number of resources we will try to program
221 if (config->ic_nmem > ISA_PNP_NMEM) {
222 printf("too many ISA memory ranges (%d > %d)\n",
223 config->ic_nmem, ISA_PNP_NMEM);
224 config->ic_nmem = ISA_PNP_NMEM;
226 if (config->ic_nport > ISA_PNP_NPORT) {
227 printf("too many ISA I/O ranges (%d > %d)\n", config->ic_nport,
229 config->ic_nport = ISA_PNP_NPORT;
231 if (config->ic_nirq > ISA_PNP_NIRQ) {
232 printf("too many ISA IRQs (%d > %d)\n", config->ic_nirq,
234 config->ic_nirq = ISA_PNP_NIRQ;
236 if (config->ic_ndrq > ISA_PNP_NDRQ) {
237 printf("too many ISA DRQs (%d > %d)\n", config->ic_ndrq,
239 config->ic_ndrq = ISA_PNP_NDRQ;
243 * Now program the resources.
245 for (i = 0; i < config->ic_nmem; i++) {
249 /* XXX: should handle memory control register, 32 bit memory */
250 if (config->ic_mem[i].ir_size == 0) {
251 pnp_write(PNP_MEM_BASE_HIGH(i), 0);
252 pnp_write(PNP_MEM_BASE_LOW(i), 0);
253 pnp_write(PNP_MEM_RANGE_HIGH(i), 0);
254 pnp_write(PNP_MEM_RANGE_LOW(i), 0);
256 start = config->ic_mem[i].ir_start;
257 size = config->ic_mem[i].ir_size;
259 panic("pnp_set_config: bogus memory assignment");
260 pnp_write(PNP_MEM_BASE_HIGH(i), (start >> 16) & 0xff);
261 pnp_write(PNP_MEM_BASE_LOW(i), (start >> 8) & 0xff);
262 pnp_write(PNP_MEM_RANGE_HIGH(i), (size >> 16) & 0xff);
263 pnp_write(PNP_MEM_RANGE_LOW(i), (size >> 8) & 0xff);
266 for (; i < ISA_PNP_NMEM; i++) {
267 pnp_write(PNP_MEM_BASE_HIGH(i), 0);
268 pnp_write(PNP_MEM_BASE_LOW(i), 0);
269 pnp_write(PNP_MEM_RANGE_HIGH(i), 0);
270 pnp_write(PNP_MEM_RANGE_LOW(i), 0);
273 for (i = 0; i < config->ic_nport; i++) {
276 if (config->ic_port[i].ir_size == 0) {
277 pnp_write(PNP_IO_BASE_HIGH(i), 0);
278 pnp_write(PNP_IO_BASE_LOW(i), 0);
280 start = config->ic_port[i].ir_start;
281 pnp_write(PNP_IO_BASE_HIGH(i), (start >> 8) & 0xff);
282 pnp_write(PNP_IO_BASE_LOW(i), (start >> 0) & 0xff);
285 for (; i < ISA_PNP_NPORT; i++) {
286 pnp_write(PNP_IO_BASE_HIGH(i), 0);
287 pnp_write(PNP_IO_BASE_LOW(i), 0);
290 for (i = 0; i < config->ic_nirq; i++) {
293 /* XXX: interrupt type */
294 if (config->ic_irqmask[i] == 0) {
295 pnp_write(PNP_IRQ_LEVEL(i), 0);
296 pnp_write(PNP_IRQ_TYPE(i), 2);
298 irq = ffs(config->ic_irqmask[i]) - 1;
299 pnp_write(PNP_IRQ_LEVEL(i), irq);
300 pnp_write(PNP_IRQ_TYPE(i), 2); /* XXX */
303 for (; i < ISA_PNP_NIRQ; i++) {
305 * IRQ 0 is not a valid interrupt selection and
306 * represents no interrupt selection.
308 pnp_write(PNP_IRQ_LEVEL(i), 0);
309 pnp_write(PNP_IRQ_TYPE(i), 2);
312 for (i = 0; i < config->ic_ndrq; i++) {
315 if (config->ic_drqmask[i] == 0) {
316 pnp_write(PNP_DMA_CHANNEL(i), 4);
318 drq = ffs(config->ic_drqmask[i]) - 1;
319 pnp_write(PNP_DMA_CHANNEL(i), drq);
322 for (; i < ISA_PNP_NDRQ; i++) {
324 * DMA channel 4, the cascade channel is used to
325 * indicate no DMA channel is active.
327 pnp_write(PNP_DMA_CHANNEL(i), 4);
330 pnp_write(PNP_ACTIVATE, enable ? 1 : 0);
333 * Wake everyone up again, we are finished.
335 pnp_write(PNP_CONFIG_CONTROL, PNP_CONFIG_CONTROL_WAIT_FOR_KEY);
339 * Process quirks for a logical device.. The card must be in Config state.
342 pnp_check_quirks(uint32_t vendor_id, uint32_t logical_id, int ldn,
343 struct isa_config *config)
345 struct pnp_quirk *qp;
347 for (qp = &pnp_quirks[0]; qp->vendor_id; qp++) {
348 if (qp->vendor_id == vendor_id
349 && (qp->logical_id == 0 || qp->logical_id == logical_id)) {
351 case PNP_QUIRK_WRITE_REG:
352 pnp_write(PNP_SET_LDN, ldn);
353 pnp_write(qp->arg1, qp->arg2);
355 case PNP_QUIRK_EXTRA_IO:
360 config->ic_port[config->ic_nport - 1] = config->ic_port[0];
361 config->ic_port[config->ic_nport - 1].ir_start += qp->arg1;
362 config->ic_port[config->ic_nport - 1].ir_end += qp->arg1;
366 config->ic_port[config->ic_nport - 1] = config->ic_port[0];
367 config->ic_port[config->ic_nport - 1].ir_start += qp->arg2;
368 config->ic_port[config->ic_nport - 1].ir_end += qp->arg2;
377 * Scan Resource Data for Logical Devices.
379 * This function exits as soon as it gets an error reading *ANY*
380 * Resource Data or it reaches the end of Resource Data. In the first
381 * case the return value will be TRUE, FALSE otherwise.
384 pnp_create_devices(device_t parent, pnp_id *p, int csn,
385 u_char *resources, int len)
387 u_char tag, *resp, *resinfo, *startres = NULL;
388 int large_len, scanning = len, retval = FALSE;
392 struct pnp_set_config_arg *csnldn;
397 while (scanning > 0) {
400 if (PNP_RES_TYPE(tag) != 0) {
406 large_len = resp[0] + (resp[1] << 8);
409 if (scanning < large_len) {
415 scanning -= large_len;
417 if (PNP_LRES_NUM(tag) == PNP_TAG_ID_ANSI) {
420 * This is an optional device
421 * identifier string. Skip it
426 /* else mandately card identifier string */
427 if (large_len > sizeof(buf) - 1)
428 large_len = sizeof(buf) - 1;
429 bcopy(resinfo, buf, large_len);
432 * Trim trailing spaces.
434 while (buf[large_len-1] == ' ')
436 buf[large_len] = '\0';
445 if (scanning < PNP_SRES_LEN(tag)) {
450 resp += PNP_SRES_LEN(tag);
451 scanning -= PNP_SRES_LEN(tag);
453 switch (PNP_SRES_NUM(tag)) {
454 case PNP_TAG_LOGICAL_DEVICE:
456 * Parse the resources for the previous
457 * logical device (if any).
460 pnp_parse_resources(dev, startres,
461 resinfo - startres - 1, ldn);
467 * A new logical device. Scan for end of
470 bcopy(resinfo, &logical_id, 4);
471 pnp_check_quirks(p->vendor_id, logical_id, ldn, NULL);
472 dev = BUS_ADD_CHILD(parent, ISA_ORDER_PNP, NULL, -1);
474 device_set_desc_copy(dev, desc);
476 device_set_desc_copy(dev,
477 pnp_eisaformat(logical_id));
478 isa_set_vendorid(dev, p->vendor_id);
479 isa_set_serial(dev, p->serial);
480 isa_set_logicalid(dev, logical_id);
481 isa_set_configattr(dev,
482 ISACFGATTR_CANDISABLE | ISACFGATTR_DYNAMIC);
483 csnldn = malloc(sizeof *csnldn, M_DEVBUF, M_NOWAIT);
485 device_printf(parent, "out of memory\n");
491 ISA_SET_CONFIG_CALLBACK(parent, dev, pnp_set_config,
493 isa_set_pnp_csn(dev, csn);
494 isa_set_pnp_ldn(dev, ldn);
501 device_printf(parent, "malformed resources\n");
505 pnp_parse_resources(dev, startres,
506 resinfo - startres - 1, ldn);
513 /* Skip this resource */
522 * Read 'amount' bytes of resources from the card, allocating memory
523 * as needed. If a buffer is already available, it should be passed in
524 * '*resourcesp' and its length in '*spacep'. The number of resource
525 * bytes already in the buffer should be passed in '*lenp'. The memory
526 * allocated will be returned in '*resourcesp' with its size and the
527 * number of bytes of resources in '*spacep' and '*lenp' respectively.
529 * XXX: Multiple problems here, we forget to free() stuff in one
530 * XXX: error return, and in another case we free (*resourcesp) but
531 * XXX: don't tell the caller.
534 pnp_read_bytes(int amount, u_char **resourcesp, int *spacep, int *lenp)
536 u_char *resources = *resourcesp;
543 resources = malloc(space, M_TEMP, M_NOWAIT);
548 if (len + amount > space) {
550 while (len + amount > space + extra)
552 newres = malloc(space + extra, M_TEMP, M_NOWAIT);
554 /* XXX: free resources */
557 bcopy(resources, newres, len);
558 free(resources, M_TEMP);
563 if (pnp_get_resource_info(resources + len, amount) != amount)
567 *resourcesp = resources;
575 * Read all resources from the card, allocating memory as needed. If a
576 * buffer is already available, it should be passed in '*resourcesp'
577 * and its length in '*spacep'. The memory allocated will be returned
578 * in '*resourcesp' with its size and the number of bytes of resources
579 * in '*spacep' and '*lenp' respectively.
582 pnp_read_resources(u_char **resourcesp, int *spacep, int *lenp)
584 u_char *resources = *resourcesp;
593 error = pnp_read_bytes(1, &resources, &space, &len);
596 tag = resources[len-1];
597 if (PNP_RES_TYPE(tag) == 0) {
599 * Small resource, read contents.
601 error = pnp_read_bytes(PNP_SRES_LEN(tag),
602 &resources, &space, &len);
605 if (PNP_SRES_NUM(tag) == PNP_TAG_END)
609 * Large resource, read length and contents.
611 error = pnp_read_bytes(2, &resources, &space, &len);
614 error = pnp_read_bytes(resources[len-2]
615 + (resources[len-1] << 8), &resources, &space,
623 *resourcesp = resources;
630 * Run the isolation protocol. Use pnp_rd_port as the READ_DATA port
631 * value (caller should try multiple READ_DATA locations before giving
632 * up). Upon exiting, all cards are aware that they should use
633 * pnp_rd_port as the READ_DATA port.
635 * In the first pass, a csn is assigned to each board and pnp_id's
636 * are saved to an array, pnp_devices. In the second pass, each
637 * card is woken up and the device configuration is called.
640 pnp_isolation_protocol(device_t parent)
645 u_char *resources = NULL;
650 * Put all cards into the Sleep state so that we can clear
653 pnp_send_initiation_key();
656 * Clear the CSN for all cards.
658 pnp_write(PNP_CONFIG_CONTROL, PNP_CONFIG_CONTROL_RESET_CSN);
661 * Move all cards to the Isolation state.
663 pnp_write(PNP_WAKE, 0);
666 * Tell them where the read point is going to be this time.
668 pnp_write(PNP_SET_RD_DATA, pnp_rd_port);
670 for (csn = 1; csn < PNP_MAX_CARDS; csn++) {
672 * Start the serial isolation protocol.
674 outb(_PNP_ADDRESS, PNP_SERIAL_ISOLATION);
675 DELAY(1000); /* Delay 1 msec */
677 if (pnp_get_serial(&id)) {
679 * We have read the id from a card
680 * successfully. The card which won the
681 * isolation protocol will be in Isolation
682 * mode and all others will be in Sleep.
683 * Program the CSN of the isolated card
684 * (taking it to Config state) and read its
685 * resources, creating devices as we find
686 * logical devices on the card.
688 pnp_write(PNP_SET_CSN, csn);
690 printf("Reading PnP configuration for %s.\n",
691 pnp_eisaformat(id.vendor_id));
692 error = pnp_read_resources(&resources, &space, &len);
695 pnp_create_devices(parent, &id, csn, resources, len);
701 * Put this card back to the Sleep state and
702 * simultaneously move all cards which don't have a
703 * CSN yet to Isolation state.
705 pnp_write(PNP_WAKE, 0);
709 * Unless we have chosen the wrong read port, all cards will
710 * be in Sleep state. Put them back into WaitForKey for
711 * now. Their resources will be programmed later.
713 pnp_write(PNP_CONFIG_CONTROL, PNP_CONFIG_CONTROL_WAIT_FOR_KEY);
719 free(resources, M_TEMP);
728 * autoconfiguration of pnp devices. This routine just runs the
729 * isolation protocol over several ports, until one is successful.
731 * may be called more than once ?
736 pnp_identify(driver_t *driver, device_t parent)
740 /* Try various READ_DATA ports from 0x203-0x3ff */
741 for (pnp_rd_port = 0x80; (pnp_rd_port < 0xff); pnp_rd_port += 0x10) {
743 printf("pnp_identify: Trying Read_Port at %x\n",
744 (pnp_rd_port << 2) | 0x3);
746 num_pnp_devs = pnp_isolation_protocol(parent);
751 printf("PNP Identify complete\n");
754 static device_method_t pnp_methods[] = {
755 /* Device interface */
756 DEVMETHOD(device_identify, pnp_identify),
761 static driver_t pnp_driver = {
767 DRIVER_MODULE(pnp, isa, pnp_driver, 0, 0);