2 * PCMCIA 16-bit resource management functions
4 * The initial developer of the original code is David A. Hinds
5 * <dahinds@users.sourceforge.net>. Portions created by David A. Hinds
6 * are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
8 * Copyright (C) 1999 David A. Hinds
9 * Copyright (C) 2004-2005 Dominik Brodowski
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
17 #include <linux/module.h>
18 #include <linux/kernel.h>
19 #include <linux/interrupt.h>
20 #include <linux/delay.h>
21 #include <linux/pci.h>
22 #include <linux/device.h>
23 #include <linux/netdevice.h>
24 #include <linux/slab.h>
28 #include <pcmcia/cs_types.h>
29 #include <pcmcia/ss.h>
30 #include <pcmcia/cs.h>
31 #include <pcmcia/cistpl.h>
32 #include <pcmcia/cisreg.h>
33 #include <pcmcia/ds.h>
35 #include "cs_internal.h"
38 /* Access speed for IO windows */
40 module_param(io_speed, int, 0444);
43 int pcmcia_validate_mem(struct pcmcia_socket *s)
45 if (s->resource_ops->validate_mem)
46 return s->resource_ops->validate_mem(s);
47 /* if there is no callback, we can assume that everything is OK */
51 struct resource *pcmcia_find_mem_region(u_long base, u_long num, u_long align,
52 int low, struct pcmcia_socket *s)
54 if (s->resource_ops->find_mem)
55 return s->resource_ops->find_mem(base, num, align, low, s);
62 * Special stuff for managing IO windows, because they are scarce
65 static int alloc_io_space(struct pcmcia_socket *s, u_int attr,
66 unsigned int *base, unsigned int num, u_int lines)
70 align = (*base) ? (lines ? 1<<lines : 0) : 1;
71 if (align && (align < num)) {
73 dev_dbg(&s->dev, "odd IO request: num %#x align %#x\n",
77 while (align && (align < num))
80 if (*base & ~(align-1)) {
81 dev_dbg(&s->dev, "odd IO request: base %#x align %#x\n",
86 return s->resource_ops->find_io(s, attr, base, num, align);
87 } /* alloc_io_space */
90 static void release_io_space(struct pcmcia_socket *s, unsigned int base,
95 for (i = 0; i < MAX_IO_WIN; i++) {
98 if ((s->io[i].res->start <= base) &&
99 (s->io[i].res->end >= base+num-1)) {
100 s->io[i].InUse -= num;
101 /* Free the window if no one else is using it */
102 if (s->io[i].InUse == 0) {
103 release_resource(s->io[i].res);
109 } /* release_io_space */
112 /** pccard_access_configuration_register
114 * Access_configuration_register() reads and writes configuration
115 * registers in attribute memory. Memory window 0 is reserved for
116 * this and the tuple reading services.
119 int pcmcia_access_configuration_register(struct pcmcia_device *p_dev,
122 struct pcmcia_socket *s;
128 if (!p_dev || !p_dev->function_config)
133 mutex_lock(&s->ops_mutex);
134 c = p_dev->function_config;
136 if (!(c->state & CONFIG_LOCKED)) {
137 dev_dbg(&s->dev, "Configuration isnt't locked\n");
138 mutex_unlock(&s->ops_mutex);
142 addr = (c->ConfigBase + reg->Offset) >> 1;
144 switch (reg->Action) {
146 ret = pcmcia_read_cis_mem(s, 1, addr, 1, &val);
151 pcmcia_write_cis_mem(s, 1, addr, 1, &val);
154 dev_dbg(&s->dev, "Invalid conf register request\n");
158 mutex_unlock(&s->ops_mutex);
160 } /* pcmcia_access_configuration_register */
161 EXPORT_SYMBOL(pcmcia_access_configuration_register);
164 int pcmcia_map_mem_page(struct pcmcia_device *p_dev, window_handle_t wh,
167 struct pcmcia_socket *s = p_dev->socket;
173 if (req->Page != 0) {
174 dev_dbg(&s->dev, "failure: requested page is zero\n");
177 mutex_lock(&s->ops_mutex);
178 s->win[wh].card_start = req->CardOffset;
179 ret = s->ops->set_mem_map(s, &s->win[wh]);
181 dev_warn(&s->dev, "failed to set_mem_map\n");
182 mutex_unlock(&s->ops_mutex);
184 } /* pcmcia_map_mem_page */
185 EXPORT_SYMBOL(pcmcia_map_mem_page);
188 /** pcmcia_modify_configuration
190 * Modify a locked socket configuration
192 int pcmcia_modify_configuration(struct pcmcia_device *p_dev,
195 struct pcmcia_socket *s;
201 mutex_lock(&s->ops_mutex);
202 c = p_dev->function_config;
204 if (!(s->state & SOCKET_PRESENT)) {
205 dev_dbg(&s->dev, "No card present\n");
209 if (!(c->state & CONFIG_LOCKED)) {
210 dev_dbg(&s->dev, "Configuration isnt't locked\n");
215 if (mod->Attributes & (CONF_IRQ_CHANGE_VALID | CONF_VCC_CHANGE_VALID)) {
217 "changing Vcc or IRQ is not allowed at this time\n");
222 /* We only allow changing Vpp1 and Vpp2 to the same value */
223 if ((mod->Attributes & CONF_VPP1_CHANGE_VALID) &&
224 (mod->Attributes & CONF_VPP2_CHANGE_VALID)) {
225 if (mod->Vpp1 != mod->Vpp2) {
226 dev_dbg(&s->dev, "Vpp1 and Vpp2 must be the same\n");
230 s->socket.Vpp = mod->Vpp1;
231 if (s->ops->set_socket(s, &s->socket)) {
232 dev_printk(KERN_WARNING, &s->dev,
233 "Unable to set VPP\n");
237 } else if ((mod->Attributes & CONF_VPP1_CHANGE_VALID) ||
238 (mod->Attributes & CONF_VPP2_CHANGE_VALID)) {
239 dev_dbg(&s->dev, "changing Vcc is not allowed at this time\n");
244 if (mod->Attributes & CONF_IO_CHANGE_WIDTH) {
245 pccard_io_map io_off = { 0, 0, 0, 0, 1 };
249 io_on.speed = io_speed;
250 for (i = 0; i < MAX_IO_WIN; i++) {
256 io_on.flags = MAP_ACTIVE | IO_DATA_PATH_WIDTH_8;
257 io_on.start = s->io[i].res->start;
258 io_on.stop = s->io[i].res->end;
260 s->ops->set_io_map(s, &io_off);
262 s->ops->set_io_map(s, &io_on);
267 mutex_unlock(&s->ops_mutex);
270 } /* modify_configuration */
271 EXPORT_SYMBOL(pcmcia_modify_configuration);
274 int pcmcia_release_configuration(struct pcmcia_device *p_dev)
276 pccard_io_map io = { 0, 0, 0, 0, 1 };
277 struct pcmcia_socket *s = p_dev->socket;
281 mutex_lock(&s->ops_mutex);
282 c = p_dev->function_config;
283 if (p_dev->_locked) {
285 if (--(s->lock_count) == 0) {
286 s->socket.flags = SS_OUTPUT_ENA; /* Is this correct? */
288 s->socket.io_irq = 0;
289 s->ops->set_socket(s, &s->socket);
292 if (c->state & CONFIG_LOCKED) {
293 c->state &= ~CONFIG_LOCKED;
294 if (c->state & CONFIG_IO_REQ)
295 for (i = 0; i < MAX_IO_WIN; i++) {
299 if (s->io[i].Config != 0)
302 s->ops->set_io_map(s, &io);
305 mutex_unlock(&s->ops_mutex);
308 } /* pcmcia_release_configuration */
311 /** pcmcia_release_io
313 * Release_io() releases the I/O ranges allocated by a client. This
314 * may be invoked some time after a card ejection has already dumped
315 * the actual socket configuration, so if the client is "stale", we
316 * don't bother checking the port ranges against the current socket
319 static int pcmcia_release_io(struct pcmcia_device *p_dev, io_req_t *req)
321 struct pcmcia_socket *s = p_dev->socket;
325 mutex_lock(&s->ops_mutex);
326 c = p_dev->function_config;
333 if ((c->io.BasePort1 != req->BasePort1) ||
334 (c->io.NumPorts1 != req->NumPorts1) ||
335 (c->io.BasePort2 != req->BasePort2) ||
336 (c->io.NumPorts2 != req->NumPorts2))
339 c->state &= ~CONFIG_IO_REQ;
341 release_io_space(s, req->BasePort1, req->NumPorts1);
343 release_io_space(s, req->BasePort2, req->NumPorts2);
346 mutex_unlock(&s->ops_mutex);
349 } /* pcmcia_release_io */
352 int pcmcia_release_window(struct pcmcia_device *p_dev, window_handle_t wh)
354 struct pcmcia_socket *s = p_dev->socket;
361 mutex_lock(&s->ops_mutex);
364 if (!(p_dev->_win & CLIENT_WIN_REQ(wh))) {
365 dev_dbg(&s->dev, "not releasing unknown window\n");
366 mutex_unlock(&s->ops_mutex);
370 /* Shut down memory window */
371 win->flags &= ~MAP_ACTIVE;
372 s->ops->set_mem_map(s, win);
373 s->state &= ~SOCKET_WIN_REQ(wh);
375 /* Release system memory */
377 release_resource(win->res);
381 p_dev->_win &= ~CLIENT_WIN_REQ(wh);
382 mutex_unlock(&s->ops_mutex);
385 } /* pcmcia_release_window */
386 EXPORT_SYMBOL(pcmcia_release_window);
389 int pcmcia_request_configuration(struct pcmcia_device *p_dev,
394 struct pcmcia_socket *s = p_dev->socket;
398 if (!(s->state & SOCKET_PRESENT))
401 if (req->IntType & INT_CARDBUS) {
402 dev_dbg(&s->dev, "IntType may not be INT_CARDBUS\n");
406 mutex_lock(&s->ops_mutex);
407 c = p_dev->function_config;
408 if (c->state & CONFIG_LOCKED) {
409 mutex_unlock(&s->ops_mutex);
410 dev_dbg(&s->dev, "Configuration is locked\n");
414 /* Do power control. We don't allow changes in Vcc. */
415 s->socket.Vpp = req->Vpp;
416 if (s->ops->set_socket(s, &s->socket)) {
417 mutex_unlock(&s->ops_mutex);
418 dev_printk(KERN_WARNING, &s->dev,
419 "Unable to set socket state\n");
423 /* Pick memory or I/O card, DMA mode, interrupt */
424 c->IntType = req->IntType;
425 c->Attributes = req->Attributes;
426 if (req->IntType & INT_MEMORY_AND_IO)
427 s->socket.flags |= SS_IOCARD;
428 if (req->IntType & INT_ZOOMED_VIDEO)
429 s->socket.flags |= SS_ZVCARD | SS_IOCARD;
430 if (req->Attributes & CONF_ENABLE_DMA)
431 s->socket.flags |= SS_DMA_MODE;
432 if (req->Attributes & CONF_ENABLE_SPKR)
433 s->socket.flags |= SS_SPKR_ENA;
434 if (req->Attributes & CONF_ENABLE_IRQ)
435 s->socket.io_irq = s->pcmcia_irq;
437 s->socket.io_irq = 0;
438 s->ops->set_socket(s, &s->socket);
441 /* Set up CIS configuration registers */
442 base = c->ConfigBase = req->ConfigBase;
443 c->CardValues = req->Present;
444 if (req->Present & PRESENT_COPY) {
446 pcmcia_write_cis_mem(s, 1, (base + CISREG_SCR)>>1, 1, &c->Copy);
448 if (req->Present & PRESENT_OPTION) {
449 if (s->functions == 1) {
450 c->Option = req->ConfigIndex & COR_CONFIG_MASK;
452 c->Option = req->ConfigIndex & COR_MFC_CONFIG_MASK;
453 c->Option |= COR_FUNC_ENA|COR_IREQ_ENA;
454 if (req->Present & PRESENT_IOBASE_0)
455 c->Option |= COR_ADDR_DECODE;
457 if ((req->Attributes & CONF_ENABLE_IRQ) &&
458 !(req->Attributes & CONF_ENABLE_PULSE_IRQ))
459 c->Option |= COR_LEVEL_REQ;
460 pcmcia_write_cis_mem(s, 1, (base + CISREG_COR)>>1, 1, &c->Option);
463 if (req->Present & PRESENT_STATUS) {
464 c->Status = req->Status;
465 pcmcia_write_cis_mem(s, 1, (base + CISREG_CCSR)>>1, 1, &c->Status);
467 if (req->Present & PRESENT_PIN_REPLACE) {
469 pcmcia_write_cis_mem(s, 1, (base + CISREG_PRR)>>1, 1, &c->Pin);
471 if (req->Present & PRESENT_EXT_STATUS) {
472 c->ExtStatus = req->ExtStatus;
473 pcmcia_write_cis_mem(s, 1, (base + CISREG_ESR)>>1, 1, &c->ExtStatus);
475 if (req->Present & PRESENT_IOBASE_0) {
476 u_char b = c->io.BasePort1 & 0xff;
477 pcmcia_write_cis_mem(s, 1, (base + CISREG_IOBASE_0)>>1, 1, &b);
478 b = (c->io.BasePort1 >> 8) & 0xff;
479 pcmcia_write_cis_mem(s, 1, (base + CISREG_IOBASE_1)>>1, 1, &b);
481 if (req->Present & PRESENT_IOSIZE) {
482 u_char b = c->io.NumPorts1 + c->io.NumPorts2 - 1;
483 pcmcia_write_cis_mem(s, 1, (base + CISREG_IOSIZE)>>1, 1, &b);
486 /* Configure I/O windows */
487 if (c->state & CONFIG_IO_REQ) {
488 iomap.speed = io_speed;
489 for (i = 0; i < MAX_IO_WIN; i++)
492 iomap.flags = MAP_ACTIVE;
493 switch (s->io[i].res->flags & IO_DATA_PATH_WIDTH) {
494 case IO_DATA_PATH_WIDTH_16:
495 iomap.flags |= MAP_16BIT; break;
496 case IO_DATA_PATH_WIDTH_AUTO:
497 iomap.flags |= MAP_AUTOSZ; break;
501 iomap.start = s->io[i].res->start;
502 iomap.stop = s->io[i].res->end;
503 s->ops->set_io_map(s, &iomap);
508 c->state |= CONFIG_LOCKED;
510 mutex_unlock(&s->ops_mutex);
512 } /* pcmcia_request_configuration */
513 EXPORT_SYMBOL(pcmcia_request_configuration);
516 /** pcmcia_request_io
518 * Request_io() reserves ranges of port addresses for a socket.
519 * I have not implemented range sharing or alias addressing.
521 int pcmcia_request_io(struct pcmcia_device *p_dev, io_req_t *req)
523 struct pcmcia_socket *s = p_dev->socket;
527 mutex_lock(&s->ops_mutex);
529 if (!(s->state & SOCKET_PRESENT)) {
530 dev_dbg(&s->dev, "No card present\n");
537 c = p_dev->function_config;
538 if (c->state & CONFIG_LOCKED) {
539 dev_dbg(&s->dev, "Configuration is locked\n");
542 if (c->state & CONFIG_IO_REQ) {
543 dev_dbg(&s->dev, "IO already configured\n");
546 if (req->Attributes1 & (IO_SHARED | IO_FORCE_ALIAS_ACCESS)) {
547 dev_dbg(&s->dev, "bad attribute setting for IO region 1\n");
550 if ((req->NumPorts2 > 0) &&
551 (req->Attributes2 & (IO_SHARED | IO_FORCE_ALIAS_ACCESS))) {
552 dev_dbg(&s->dev, "bad attribute setting for IO region 2\n");
556 dev_dbg(&s->dev, "trying to allocate resource 1\n");
557 ret = alloc_io_space(s, req->Attributes1, &req->BasePort1,
558 req->NumPorts1, req->IOAddrLines);
560 dev_dbg(&s->dev, "allocation of resource 1 failed\n");
564 if (req->NumPorts2) {
565 dev_dbg(&s->dev, "trying to allocate resource 2\n");
566 ret = alloc_io_space(s, req->Attributes2, &req->BasePort2,
567 req->NumPorts2, req->IOAddrLines);
569 dev_dbg(&s->dev, "allocation of resource 2 failed\n");
570 release_io_space(s, req->BasePort1, req->NumPorts1);
576 c->state |= CONFIG_IO_REQ;
578 dev_dbg(&s->dev, "allocating resources succeeded: %d\n", ret);
581 mutex_unlock(&s->ops_mutex);
584 } /* pcmcia_request_io */
585 EXPORT_SYMBOL(pcmcia_request_io);
589 * pcmcia_request_irq() - attempt to request a IRQ for a PCMCIA device
591 * pcmcia_request_irq() is a wrapper around request_irq which will allow
592 * the PCMCIA core to clean up the registration in pcmcia_disable_device().
593 * Drivers are free to use request_irq() directly, but then they need to
594 * call free_irq themselfves, too. Also, only IRQF_SHARED capable IRQ
595 * handlers are allowed.
597 int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
598 irq_handler_t handler)
605 ret = request_irq(p_dev->irq, handler, IRQF_SHARED,
606 p_dev->devname, p_dev->priv);
612 EXPORT_SYMBOL(pcmcia_request_irq);
616 * pcmcia_request_exclusive_irq() - attempt to request an exclusive IRQ first
618 * pcmcia_request_exclusive_irq() is a wrapper around request_irq which
619 * attempts first to request an exclusive IRQ. If it fails, it also accepts
620 * a shared IRQ, but prints out a warning. PCMCIA drivers should allow for
621 * IRQ sharing and either use request_irq directly (then they need to call
622 * free_irq themselves, too), or the pcmcia_request_irq() function.
625 __pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
626 irq_handler_t handler)
633 ret = request_irq(p_dev->irq, handler, 0, p_dev->devname, p_dev->priv);
635 ret = pcmcia_request_irq(p_dev, handler);
636 dev_printk(KERN_WARNING, &p_dev->dev, "pcmcia: "
637 "request for exclusive IRQ could not be fulfilled.\n");
638 dev_printk(KERN_WARNING, &p_dev->dev, "pcmcia: the driver "
639 "needs updating to supported shared IRQ lines.\n");
642 dev_printk(KERN_INFO, &p_dev->dev, "request_irq() failed\n");
647 } /* pcmcia_request_exclusive_irq */
648 EXPORT_SYMBOL(__pcmcia_request_exclusive_irq);
651 #ifdef CONFIG_PCMCIA_PROBE
653 /* mask of IRQs already reserved by other cards, we should avoid using them */
654 static u8 pcmcia_used_irq[NR_IRQS];
656 static irqreturn_t test_action(int cpl, void *dev_id)
662 * pcmcia_setup_isa_irq() - determine whether an ISA IRQ can be used
663 * @p_dev - the associated PCMCIA device
665 * locking note: must be called with ops_mutex locked.
667 static int pcmcia_setup_isa_irq(struct pcmcia_device *p_dev, int type)
669 struct pcmcia_socket *s = p_dev->socket;
670 unsigned int try, irq;
671 u32 mask = s->irq_mask;
674 for (try = 0; try < 64; try++) {
677 /* marked as available by driver, not blocked by userspace? */
678 if (!((mask >> irq) & 1))
681 /* avoid an IRQ which is already used by another PCMCIA card */
682 if ((try < 32) && pcmcia_used_irq[irq])
685 /* register the correct driver, if possible, to check whether
686 * registering a dummy handle works, i.e. if the IRQ isn't
687 * marked as used by the kernel resource management core */
688 ret = request_irq(irq, test_action, type, p_dev->devname,
691 free_irq(irq, p_dev);
692 p_dev->irq = s->pcmcia_irq = irq;
693 pcmcia_used_irq[irq]++;
701 void pcmcia_cleanup_irq(struct pcmcia_socket *s)
703 pcmcia_used_irq[s->pcmcia_irq]--;
707 #else /* CONFIG_PCMCIA_PROBE */
709 static int pcmcia_setup_isa_irq(struct pcmcia_device *p_dev, int type)
714 void pcmcia_cleanup_irq(struct pcmcia_socket *s)
720 #endif /* CONFIG_PCMCIA_PROBE */
724 * pcmcia_setup_irq() - determine IRQ to be used for device
725 * @p_dev - the associated PCMCIA device
727 * locking note: must be called with ops_mutex locked.
729 int pcmcia_setup_irq(struct pcmcia_device *p_dev)
731 struct pcmcia_socket *s = p_dev->socket;
736 /* already assigned? */
738 p_dev->irq = s->pcmcia_irq;
742 /* prefer an exclusive ISA irq */
743 if (!pcmcia_setup_isa_irq(p_dev, 0))
746 /* but accept a shared ISA irq */
747 if (!pcmcia_setup_isa_irq(p_dev, IRQF_SHARED))
750 /* but use the PCI irq otherwise */
752 p_dev->irq = s->pcmcia_irq = s->pci_irq;
760 /** pcmcia_request_window
762 * Request_window() establishes a mapping between card memory space
763 * and system memory space.
765 int pcmcia_request_window(struct pcmcia_device *p_dev, win_req_t *req, window_handle_t *wh)
767 struct pcmcia_socket *s = p_dev->socket;
772 if (!(s->state & SOCKET_PRESENT)) {
773 dev_dbg(&s->dev, "No card present\n");
776 if (req->Attributes & (WIN_PAGED | WIN_SHARED)) {
777 dev_dbg(&s->dev, "bad attribute setting for iomem region\n");
781 /* Window size defaults to smallest available */
783 req->Size = s->map_size;
784 align = (((s->features & SS_CAP_MEM_ALIGN) ||
785 (req->Attributes & WIN_STRICT_ALIGN)) ?
786 req->Size : s->map_size);
787 if (req->Size & (s->map_size-1)) {
788 dev_dbg(&s->dev, "invalid map size\n");
791 if ((req->Base && (s->features & SS_CAP_STATIC_MAP)) ||
792 (req->Base & (align-1))) {
793 dev_dbg(&s->dev, "invalid base address\n");
799 /* Allocate system memory window */
800 for (w = 0; w < MAX_WIN; w++)
801 if (!(s->state & SOCKET_WIN_REQ(w)))
804 dev_dbg(&s->dev, "all windows are used already\n");
808 mutex_lock(&s->ops_mutex);
811 if (!(s->features & SS_CAP_STATIC_MAP)) {
812 win->res = pcmcia_find_mem_region(req->Base, req->Size, align,
813 (req->Attributes & WIN_MAP_BELOW_1MB), s);
815 dev_dbg(&s->dev, "allocating mem region failed\n");
816 mutex_unlock(&s->ops_mutex);
820 p_dev->_win |= CLIENT_WIN_REQ(w);
822 /* Configure the socket controller */
825 win->speed = req->AccessSpeed;
826 if (req->Attributes & WIN_MEMORY_TYPE)
827 win->flags |= MAP_ATTRIB;
828 if (req->Attributes & WIN_ENABLE)
829 win->flags |= MAP_ACTIVE;
830 if (req->Attributes & WIN_DATA_WIDTH_16)
831 win->flags |= MAP_16BIT;
832 if (req->Attributes & WIN_USE_WAIT)
833 win->flags |= MAP_USE_WAIT;
836 if (s->ops->set_mem_map(s, win) != 0) {
837 dev_dbg(&s->dev, "failed to set memory mapping\n");
838 mutex_unlock(&s->ops_mutex);
841 s->state |= SOCKET_WIN_REQ(w);
843 /* Return window handle */
844 if (s->features & SS_CAP_STATIC_MAP)
845 req->Base = win->static_start;
847 req->Base = win->res->start;
849 mutex_unlock(&s->ops_mutex);
853 } /* pcmcia_request_window */
854 EXPORT_SYMBOL(pcmcia_request_window);
856 void pcmcia_disable_device(struct pcmcia_device *p_dev)
858 pcmcia_release_configuration(p_dev);
859 pcmcia_release_io(p_dev, &p_dev->io);
861 free_irq(p_dev->irq, p_dev->priv);
863 pcmcia_release_window(p_dev, p_dev->win);
865 EXPORT_SYMBOL(pcmcia_disable_device);