OSDN Git Service

pcmcia: re-work pcmcia_request_irq()
[uclinux-h8/linux.git] / drivers / pcmcia / pcmcia_resource.c
1 /*
2  * PCMCIA 16-bit resource management functions
3  *
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.
7  *
8  * Copyright (C) 1999        David A. Hinds
9  * Copyright (C) 2004-2005   Dominik Brodowski
10  *
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.
14  *
15  */
16
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>
25
26 #include <asm/irq.h>
27
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>
34
35 #include "cs_internal.h"
36
37
38 /* Access speed for IO windows */
39 static int io_speed;
40 module_param(io_speed, int, 0444);
41
42
43 static int pcmcia_adjust_io_region(struct resource *res, unsigned long start,
44                                    unsigned long end, struct pcmcia_socket *s)
45 {
46         if (s->resource_ops->adjust_io_region)
47                 return s->resource_ops->adjust_io_region(res, start, end, s);
48         return -ENOMEM;
49 }
50
51 static struct resource *pcmcia_find_io_region(unsigned long base, int num,
52                                               unsigned long align,
53                                               struct pcmcia_socket *s)
54 {
55         if (s->resource_ops->find_io)
56                 return s->resource_ops->find_io(base, num, align, s);
57         return NULL;
58 }
59
60 int pcmcia_validate_mem(struct pcmcia_socket *s)
61 {
62         if (s->resource_ops->validate_mem)
63                 return s->resource_ops->validate_mem(s);
64         /* if there is no callback, we can assume that everything is OK */
65         return 0;
66 }
67
68 struct resource *pcmcia_find_mem_region(u_long base, u_long num, u_long align,
69                                  int low, struct pcmcia_socket *s)
70 {
71         if (s->resource_ops->find_mem)
72                 return s->resource_ops->find_mem(base, num, align, low, s);
73         return NULL;
74 }
75
76
77 /** alloc_io_space
78  *
79  * Special stuff for managing IO windows, because they are scarce
80  */
81
82 static int alloc_io_space(struct pcmcia_socket *s, u_int attr,
83                           unsigned int *base, unsigned int num, u_int lines)
84 {
85         int i;
86         unsigned int try, align;
87
88         align = (*base) ? (lines ? 1<<lines : 0) : 1;
89         if (align && (align < num)) {
90                 if (*base) {
91                         dev_dbg(&s->dev, "odd IO request: num %#x align %#x\n",
92                                num, align);
93                         align = 0;
94                 } else
95                         while (align && (align < num))
96                                 align <<= 1;
97         }
98         if (*base & ~(align-1)) {
99                 dev_dbg(&s->dev, "odd IO request: base %#x align %#x\n",
100                        *base, align);
101                 align = 0;
102         }
103         if ((s->features & SS_CAP_STATIC_MAP) && s->io_offset) {
104                 *base = s->io_offset | (*base & 0x0fff);
105                 return 0;
106         }
107         /* Check for an already-allocated window that must conflict with
108          * what was asked for.  It is a hack because it does not catch all
109          * potential conflicts, just the most obvious ones.
110          */
111         for (i = 0; i < MAX_IO_WIN; i++)
112                 if ((s->io[i].res) && *base &&
113                     ((s->io[i].res->start & (align-1)) == *base))
114                         return 1;
115         for (i = 0; i < MAX_IO_WIN; i++) {
116                 if (!s->io[i].res) {
117                         s->io[i].res = pcmcia_find_io_region(*base, num, align, s);
118                         if (s->io[i].res) {
119                                 *base = s->io[i].res->start;
120                                 s->io[i].res->flags = (s->io[i].res->flags & ~IORESOURCE_BITS) | (attr & IORESOURCE_BITS);
121                                 s->io[i].InUse = num;
122                                 break;
123                         } else
124                                 return 1;
125                 } else if ((s->io[i].res->flags & IORESOURCE_BITS) != (attr & IORESOURCE_BITS))
126                         continue;
127                 /* Try to extend top of window */
128                 try = s->io[i].res->end + 1;
129                 if ((*base == 0) || (*base == try))
130                         if (pcmcia_adjust_io_region(s->io[i].res, s->io[i].res->start,
131                                                     s->io[i].res->end + num, s) == 0) {
132                                 *base = try;
133                                 s->io[i].InUse += num;
134                                 break;
135                         }
136                 /* Try to extend bottom of window */
137                 try = s->io[i].res->start - num;
138                 if ((*base == 0) || (*base == try))
139                         if (pcmcia_adjust_io_region(s->io[i].res, s->io[i].res->start - num,
140                                                     s->io[i].res->end, s) == 0) {
141                                 *base = try;
142                                 s->io[i].InUse += num;
143                                 break;
144                         }
145         }
146         return (i == MAX_IO_WIN);
147 } /* alloc_io_space */
148
149
150 static void release_io_space(struct pcmcia_socket *s, unsigned int base,
151                              unsigned int num)
152 {
153         int i;
154
155         for (i = 0; i < MAX_IO_WIN; i++) {
156                 if (!s->io[i].res)
157                         continue;
158                 if ((s->io[i].res->start <= base) &&
159                     (s->io[i].res->end >= base+num-1)) {
160                         s->io[i].InUse -= num;
161                         /* Free the window if no one else is using it */
162                         if (s->io[i].InUse == 0) {
163                                 release_resource(s->io[i].res);
164                                 kfree(s->io[i].res);
165                                 s->io[i].res = NULL;
166                         }
167                 }
168         }
169 } /* release_io_space */
170
171
172 /** pccard_access_configuration_register
173  *
174  * Access_configuration_register() reads and writes configuration
175  * registers in attribute memory.  Memory window 0 is reserved for
176  * this and the tuple reading services.
177  */
178
179 int pcmcia_access_configuration_register(struct pcmcia_device *p_dev,
180                                          conf_reg_t *reg)
181 {
182         struct pcmcia_socket *s;
183         config_t *c;
184         int addr;
185         u_char val;
186
187         if (!p_dev || !p_dev->function_config)
188                 return -EINVAL;
189
190         s = p_dev->socket;
191
192         mutex_lock(&s->ops_mutex);
193         c = p_dev->function_config;
194
195         if (!(c->state & CONFIG_LOCKED)) {
196                 dev_dbg(&s->dev, "Configuration isnt't locked\n");
197                 mutex_unlock(&s->ops_mutex);
198                 return -EACCES;
199         }
200
201         addr = (c->ConfigBase + reg->Offset) >> 1;
202         mutex_unlock(&s->ops_mutex);
203
204         switch (reg->Action) {
205         case CS_READ:
206                 pcmcia_read_cis_mem(s, 1, addr, 1, &val);
207                 reg->Value = val;
208                 break;
209         case CS_WRITE:
210                 val = reg->Value;
211                 pcmcia_write_cis_mem(s, 1, addr, 1, &val);
212                 break;
213         default:
214                 dev_dbg(&s->dev, "Invalid conf register request\n");
215                 return -EINVAL;
216                 break;
217         }
218         return 0;
219 } /* pcmcia_access_configuration_register */
220 EXPORT_SYMBOL(pcmcia_access_configuration_register);
221
222
223 int pcmcia_map_mem_page(struct pcmcia_device *p_dev, window_handle_t wh,
224                         memreq_t *req)
225 {
226         struct pcmcia_socket *s = p_dev->socket;
227         int ret;
228
229         wh--;
230         if (wh >= MAX_WIN)
231                 return -EINVAL;
232         if (req->Page != 0) {
233                 dev_dbg(&s->dev, "failure: requested page is zero\n");
234                 return -EINVAL;
235         }
236         mutex_lock(&s->ops_mutex);
237         s->win[wh].card_start = req->CardOffset;
238         ret = s->ops->set_mem_map(s, &s->win[wh]);
239         if (ret)
240                 dev_warn(&s->dev, "failed to set_mem_map\n");
241         mutex_unlock(&s->ops_mutex);
242         return ret;
243 } /* pcmcia_map_mem_page */
244 EXPORT_SYMBOL(pcmcia_map_mem_page);
245
246
247 /** pcmcia_modify_configuration
248  *
249  * Modify a locked socket configuration
250  */
251 int pcmcia_modify_configuration(struct pcmcia_device *p_dev,
252                                 modconf_t *mod)
253 {
254         struct pcmcia_socket *s;
255         config_t *c;
256         int ret;
257
258         s = p_dev->socket;
259
260         mutex_lock(&s->ops_mutex);
261         c = p_dev->function_config;
262
263         if (!(s->state & SOCKET_PRESENT)) {
264                 dev_dbg(&s->dev, "No card present\n");
265                 ret = -ENODEV;
266                 goto unlock;
267         }
268         if (!(c->state & CONFIG_LOCKED)) {
269                 dev_dbg(&s->dev, "Configuration isnt't locked\n");
270                 ret = -EACCES;
271                 goto unlock;
272         }
273
274         if (mod->Attributes & (CONF_IRQ_CHANGE_VALID | CONF_VCC_CHANGE_VALID)) {
275                 dev_dbg(&s->dev,
276                         "changing Vcc or IRQ is not allowed at this time\n");
277                 ret = -EINVAL;
278                 goto unlock;
279         }
280
281         /* We only allow changing Vpp1 and Vpp2 to the same value */
282         if ((mod->Attributes & CONF_VPP1_CHANGE_VALID) &&
283             (mod->Attributes & CONF_VPP2_CHANGE_VALID)) {
284                 if (mod->Vpp1 != mod->Vpp2) {
285                         dev_dbg(&s->dev, "Vpp1 and Vpp2 must be the same\n");
286                         ret = -EINVAL;
287                         goto unlock;
288                 }
289                 s->socket.Vpp = mod->Vpp1;
290                 if (s->ops->set_socket(s, &s->socket)) {
291                         dev_printk(KERN_WARNING, &s->dev,
292                                    "Unable to set VPP\n");
293                         ret = -EIO;
294                         goto unlock;
295                 }
296         } else if ((mod->Attributes & CONF_VPP1_CHANGE_VALID) ||
297                    (mod->Attributes & CONF_VPP2_CHANGE_VALID)) {
298                 dev_dbg(&s->dev, "changing Vcc is not allowed at this time\n");
299                 ret = -EINVAL;
300                 goto unlock;
301         }
302
303         if (mod->Attributes & CONF_IO_CHANGE_WIDTH) {
304                 pccard_io_map io_off = { 0, 0, 0, 0, 1 };
305                 pccard_io_map io_on;
306                 int i;
307
308                 io_on.speed = io_speed;
309                 for (i = 0; i < MAX_IO_WIN; i++) {
310                         if (!s->io[i].res)
311                                 continue;
312                         io_off.map = i;
313                         io_on.map = i;
314
315                         io_on.flags = MAP_ACTIVE | IO_DATA_PATH_WIDTH_8;
316                         io_on.start = s->io[i].res->start;
317                         io_on.stop = s->io[i].res->end;
318
319                         s->ops->set_io_map(s, &io_off);
320                         mdelay(40);
321                         s->ops->set_io_map(s, &io_on);
322                 }
323         }
324         ret = 0;
325 unlock:
326         mutex_unlock(&s->ops_mutex);
327
328         return ret;
329 } /* modify_configuration */
330 EXPORT_SYMBOL(pcmcia_modify_configuration);
331
332
333 int pcmcia_release_configuration(struct pcmcia_device *p_dev)
334 {
335         pccard_io_map io = { 0, 0, 0, 0, 1 };
336         struct pcmcia_socket *s = p_dev->socket;
337         config_t *c;
338         int i;
339
340         mutex_lock(&s->ops_mutex);
341         c = p_dev->function_config;
342         if (p_dev->_locked) {
343                 p_dev->_locked = 0;
344                 if (--(s->lock_count) == 0) {
345                         s->socket.flags = SS_OUTPUT_ENA;   /* Is this correct? */
346                         s->socket.Vpp = 0;
347                         s->socket.io_irq = 0;
348                         s->ops->set_socket(s, &s->socket);
349                 }
350         }
351         if (c->state & CONFIG_LOCKED) {
352                 c->state &= ~CONFIG_LOCKED;
353                 if (c->state & CONFIG_IO_REQ)
354                         for (i = 0; i < MAX_IO_WIN; i++) {
355                                 if (!s->io[i].res)
356                                         continue;
357                                 s->io[i].Config--;
358                                 if (s->io[i].Config != 0)
359                                         continue;
360                                 io.map = i;
361                                 s->ops->set_io_map(s, &io);
362                         }
363         }
364         mutex_unlock(&s->ops_mutex);
365
366         return 0;
367 } /* pcmcia_release_configuration */
368
369
370 /** pcmcia_release_io
371  *
372  * Release_io() releases the I/O ranges allocated by a client.  This
373  * may be invoked some time after a card ejection has already dumped
374  * the actual socket configuration, so if the client is "stale", we
375  * don't bother checking the port ranges against the current socket
376  * values.
377  */
378 static int pcmcia_release_io(struct pcmcia_device *p_dev, io_req_t *req)
379 {
380         struct pcmcia_socket *s = p_dev->socket;
381         int ret = -EINVAL;
382         config_t *c;
383
384         mutex_lock(&s->ops_mutex);
385         c = p_dev->function_config;
386
387         if (!p_dev->_io)
388                 goto out;
389
390         p_dev->_io = 0;
391
392         if ((c->io.BasePort1 != req->BasePort1) ||
393             (c->io.NumPorts1 != req->NumPorts1) ||
394             (c->io.BasePort2 != req->BasePort2) ||
395             (c->io.NumPorts2 != req->NumPorts2))
396                 goto out;
397
398         c->state &= ~CONFIG_IO_REQ;
399
400         release_io_space(s, req->BasePort1, req->NumPorts1);
401         if (req->NumPorts2)
402                 release_io_space(s, req->BasePort2, req->NumPorts2);
403
404 out:
405         mutex_unlock(&s->ops_mutex);
406
407         return ret;
408 } /* pcmcia_release_io */
409
410
411 int pcmcia_release_window(struct pcmcia_device *p_dev, window_handle_t wh)
412 {
413         struct pcmcia_socket *s = p_dev->socket;
414         pccard_mem_map *win;
415
416         wh--;
417         if (wh >= MAX_WIN)
418                 return -EINVAL;
419
420         mutex_lock(&s->ops_mutex);
421         win = &s->win[wh];
422
423         if (!(p_dev->_win & CLIENT_WIN_REQ(wh))) {
424                 dev_dbg(&s->dev, "not releasing unknown window\n");
425                 mutex_unlock(&s->ops_mutex);
426                 return -EINVAL;
427         }
428
429         /* Shut down memory window */
430         win->flags &= ~MAP_ACTIVE;
431         s->ops->set_mem_map(s, win);
432         s->state &= ~SOCKET_WIN_REQ(wh);
433
434         /* Release system memory */
435         if (win->res) {
436                 release_resource(win->res);
437                 kfree(win->res);
438                 win->res = NULL;
439         }
440         p_dev->_win &= ~CLIENT_WIN_REQ(wh);
441         mutex_unlock(&s->ops_mutex);
442
443         return 0;
444 } /* pcmcia_release_window */
445 EXPORT_SYMBOL(pcmcia_release_window);
446
447
448 int pcmcia_request_configuration(struct pcmcia_device *p_dev,
449                                  config_req_t *req)
450 {
451         int i;
452         u_int base;
453         struct pcmcia_socket *s = p_dev->socket;
454         config_t *c;
455         pccard_io_map iomap;
456
457         if (!(s->state & SOCKET_PRESENT))
458                 return -ENODEV;
459
460         if (req->IntType & INT_CARDBUS) {
461                 dev_dbg(&s->dev, "IntType may not be INT_CARDBUS\n");
462                 return -EINVAL;
463         }
464
465         mutex_lock(&s->ops_mutex);
466         c = p_dev->function_config;
467         if (c->state & CONFIG_LOCKED) {
468                 mutex_unlock(&s->ops_mutex);
469                 dev_dbg(&s->dev, "Configuration is locked\n");
470                 return -EACCES;
471         }
472
473         /* Do power control.  We don't allow changes in Vcc. */
474         s->socket.Vpp = req->Vpp;
475         if (s->ops->set_socket(s, &s->socket)) {
476                 mutex_unlock(&s->ops_mutex);
477                 dev_printk(KERN_WARNING, &s->dev,
478                            "Unable to set socket state\n");
479                 return -EINVAL;
480         }
481
482         /* Pick memory or I/O card, DMA mode, interrupt */
483         c->IntType = req->IntType;
484         c->Attributes = req->Attributes;
485         if (req->IntType & INT_MEMORY_AND_IO)
486                 s->socket.flags |= SS_IOCARD;
487         if (req->IntType & INT_ZOOMED_VIDEO)
488                 s->socket.flags |= SS_ZVCARD | SS_IOCARD;
489         if (req->Attributes & CONF_ENABLE_DMA)
490                 s->socket.flags |= SS_DMA_MODE;
491         if (req->Attributes & CONF_ENABLE_SPKR)
492                 s->socket.flags |= SS_SPKR_ENA;
493         if (req->Attributes & CONF_ENABLE_IRQ)
494                 s->socket.io_irq = s->pcmcia_irq;
495         else
496                 s->socket.io_irq = 0;
497         s->ops->set_socket(s, &s->socket);
498         s->lock_count++;
499         mutex_unlock(&s->ops_mutex);
500
501         /* Set up CIS configuration registers */
502         base = c->ConfigBase = req->ConfigBase;
503         c->CardValues = req->Present;
504         if (req->Present & PRESENT_COPY) {
505                 c->Copy = req->Copy;
506                 pcmcia_write_cis_mem(s, 1, (base + CISREG_SCR)>>1, 1, &c->Copy);
507         }
508         if (req->Present & PRESENT_OPTION) {
509                 if (s->functions == 1) {
510                         c->Option = req->ConfigIndex & COR_CONFIG_MASK;
511                 } else {
512                         c->Option = req->ConfigIndex & COR_MFC_CONFIG_MASK;
513                         c->Option |= COR_FUNC_ENA|COR_IREQ_ENA;
514                         if (req->Present & PRESENT_IOBASE_0)
515                                 c->Option |= COR_ADDR_DECODE;
516                 }
517                 if ((req->Attributes & CONF_ENABLE_IRQ) &&
518                         !(req->Attributes & CONF_ENABLE_PULSE_IRQ))
519                         c->Option |= COR_LEVEL_REQ;
520                 pcmcia_write_cis_mem(s, 1, (base + CISREG_COR)>>1, 1, &c->Option);
521                 mdelay(40);
522         }
523         if (req->Present & PRESENT_STATUS) {
524                 c->Status = req->Status;
525                 pcmcia_write_cis_mem(s, 1, (base + CISREG_CCSR)>>1, 1, &c->Status);
526         }
527         if (req->Present & PRESENT_PIN_REPLACE) {
528                 c->Pin = req->Pin;
529                 pcmcia_write_cis_mem(s, 1, (base + CISREG_PRR)>>1, 1, &c->Pin);
530         }
531         if (req->Present & PRESENT_EXT_STATUS) {
532                 c->ExtStatus = req->ExtStatus;
533                 pcmcia_write_cis_mem(s, 1, (base + CISREG_ESR)>>1, 1, &c->ExtStatus);
534         }
535         if (req->Present & PRESENT_IOBASE_0) {
536                 u_char b = c->io.BasePort1 & 0xff;
537                 pcmcia_write_cis_mem(s, 1, (base + CISREG_IOBASE_0)>>1, 1, &b);
538                 b = (c->io.BasePort1 >> 8) & 0xff;
539                 pcmcia_write_cis_mem(s, 1, (base + CISREG_IOBASE_1)>>1, 1, &b);
540         }
541         if (req->Present & PRESENT_IOSIZE) {
542                 u_char b = c->io.NumPorts1 + c->io.NumPorts2 - 1;
543                 pcmcia_write_cis_mem(s, 1, (base + CISREG_IOSIZE)>>1, 1, &b);
544         }
545
546         /* Configure I/O windows */
547         if (c->state & CONFIG_IO_REQ) {
548                 mutex_lock(&s->ops_mutex);
549                 iomap.speed = io_speed;
550                 for (i = 0; i < MAX_IO_WIN; i++)
551                         if (s->io[i].res) {
552                                 iomap.map = i;
553                                 iomap.flags = MAP_ACTIVE;
554                                 switch (s->io[i].res->flags & IO_DATA_PATH_WIDTH) {
555                                 case IO_DATA_PATH_WIDTH_16:
556                                         iomap.flags |= MAP_16BIT; break;
557                                 case IO_DATA_PATH_WIDTH_AUTO:
558                                         iomap.flags |= MAP_AUTOSZ; break;
559                                 default:
560                                         break;
561                                 }
562                                 iomap.start = s->io[i].res->start;
563                                 iomap.stop = s->io[i].res->end;
564                                 s->ops->set_io_map(s, &iomap);
565                                 s->io[i].Config++;
566                         }
567                 mutex_unlock(&s->ops_mutex);
568         }
569
570         c->state |= CONFIG_LOCKED;
571         p_dev->_locked = 1;
572         return 0;
573 } /* pcmcia_request_configuration */
574 EXPORT_SYMBOL(pcmcia_request_configuration);
575
576
577 /** pcmcia_request_io
578  *
579  * Request_io() reserves ranges of port addresses for a socket.
580  * I have not implemented range sharing or alias addressing.
581  */
582 int pcmcia_request_io(struct pcmcia_device *p_dev, io_req_t *req)
583 {
584         struct pcmcia_socket *s = p_dev->socket;
585         config_t *c;
586         int ret = -EINVAL;
587
588         mutex_lock(&s->ops_mutex);
589
590         if (!(s->state & SOCKET_PRESENT)) {
591                 dev_dbg(&s->dev, "No card present\n");
592                 goto out;
593         }
594
595         if (!req)
596                 goto out;
597
598         c = p_dev->function_config;
599         if (c->state & CONFIG_LOCKED) {
600                 dev_dbg(&s->dev, "Configuration is locked\n");
601                 goto out;
602         }
603         if (c->state & CONFIG_IO_REQ) {
604                 dev_dbg(&s->dev, "IO already configured\n");
605                 goto out;
606         }
607         if (req->Attributes1 & (IO_SHARED | IO_FORCE_ALIAS_ACCESS)) {
608                 dev_dbg(&s->dev, "bad attribute setting for IO region 1\n");
609                 goto out;
610         }
611         if ((req->NumPorts2 > 0) &&
612             (req->Attributes2 & (IO_SHARED | IO_FORCE_ALIAS_ACCESS))) {
613                 dev_dbg(&s->dev, "bad attribute setting for IO region 2\n");
614                 goto out;
615         }
616
617         dev_dbg(&s->dev, "trying to allocate resource 1\n");
618         ret = alloc_io_space(s, req->Attributes1, &req->BasePort1,
619                              req->NumPorts1, req->IOAddrLines);
620         if (ret) {
621                 dev_dbg(&s->dev, "allocation of resource 1 failed\n");
622                 goto out;
623         }
624
625         if (req->NumPorts2) {
626                 dev_dbg(&s->dev, "trying to allocate resource 2\n");
627                 ret = alloc_io_space(s, req->Attributes2, &req->BasePort2,
628                                      req->NumPorts2, req->IOAddrLines);
629                 if (ret) {
630                         dev_dbg(&s->dev, "allocation of resource 2 failed\n");
631                         release_io_space(s, req->BasePort1, req->NumPorts1);
632                         goto out;
633                 }
634         }
635
636         c->io = *req;
637         c->state |= CONFIG_IO_REQ;
638         p_dev->_io = 1;
639         dev_dbg(&s->dev, "allocating resources succeeded: %d\n", ret);
640
641 out:
642         mutex_unlock(&s->ops_mutex);
643
644         return ret;
645 } /* pcmcia_request_io */
646 EXPORT_SYMBOL(pcmcia_request_io);
647
648
649 /**
650  * pcmcia_request_irq() - attempt to request a IRQ for a PCMCIA device
651  *
652  * pcmcia_request_irq() is a wrapper around request_irq which will allow
653  * the PCMCIA core to clean up the registration in pcmcia_disable_device().
654  * Drivers are free to use request_irq() directly, but then they need to
655  * call free_irq themselfves, too. Also, only IRQF_SHARED capable IRQ
656  * handlers are allowed.
657  */
658 int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
659                                     irq_handler_t handler)
660 {
661         int ret;
662
663         if (!p_dev->irq)
664                 return -EINVAL;
665
666         ret = request_irq(p_dev->irq, handler, IRQF_SHARED,
667                         p_dev->devname, p_dev->priv);
668         if (!ret)
669                 p_dev->_irq = 1;
670
671         return ret;
672 }
673 EXPORT_SYMBOL(pcmcia_request_irq);
674
675
676 /**
677  * pcmcia_request_exclusive_irq() - attempt to request an exclusive IRQ first
678  *
679  * pcmcia_request_exclusive_irq() is a wrapper around request_irq which
680  * attempts first to request an exclusive IRQ. If it fails, it also accepts
681  * a shared IRQ, but prints out a warning. PCMCIA drivers should allow for
682  * IRQ sharing and either use request_irq directly (then they need to call
683  * free_irq themselves, too), or the pcmcia_request_irq() function.
684  */
685 int __must_check
686 pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev, irq_handler_t handler)
687 {
688         int ret;
689
690         if (!p_dev->irq)
691                 return -EINVAL;
692
693         ret = request_irq(p_dev->irq, handler, 0, p_dev->devname, p_dev->priv);
694         if (ret) {
695                 ret = pcmcia_request_irq(p_dev, handler);
696                 dev_printk(KERN_WARNING, &p_dev->dev, "pcmcia: "
697                         "request for exclusive IRQ could not be fulfilled.\n");
698                 dev_printk(KERN_WARNING, &p_dev->dev, "pcmcia: the driver "
699                         "needs updating to supported shared IRQ lines.\n");
700         }
701         if (ret)
702                 dev_printk(KERN_INFO, &p_dev->dev, "request_irq() failed\n");
703         else
704                 p_dev->_irq = 1;
705
706         return ret;
707 } /* pcmcia_request_exclusive_irq */
708 EXPORT_SYMBOL(pcmcia_request_exclusive_irq);
709
710
711 #ifdef CONFIG_PCMCIA_PROBE
712
713 /* mask of IRQs already reserved by other cards, we should avoid using them */
714 static u8 pcmcia_used_irq[NR_IRQS];
715
716 static irqreturn_t test_action(int cpl, void *dev_id)
717 {
718         return IRQ_NONE;
719 }
720
721 /**
722  * pcmcia_setup_isa_irq() - determine whether an ISA IRQ can be used
723  * @p_dev - the associated PCMCIA device
724  *
725  * locking note: must be called with ops_mutex locked.
726  */
727 static int pcmcia_setup_isa_irq(struct pcmcia_device *p_dev, int type)
728 {
729         struct pcmcia_socket *s = p_dev->socket;
730         unsigned int try, irq;
731         u32 mask = s->irq_mask;
732         int ret = -ENODEV;
733
734         for (try = 0; try < 64; try++) {
735                 irq = try % 32;
736
737                 /* marked as available by driver, not blocked by userspace? */
738                 if (!((mask >> irq) & 1))
739                         continue;
740
741                 /* avoid an IRQ which is already used by another PCMCIA card */
742                 if ((try < 32) && pcmcia_used_irq[irq])
743                         continue;
744
745                 /* register the correct driver, if possible, to check whether
746                  * registering a dummy handle works, i.e. if the IRQ isn't
747                  * marked as used by the kernel resource management core */
748                 ret = request_irq(irq, test_action, type, p_dev->devname,
749                                   p_dev);
750                 if (!ret) {
751                         free_irq(irq, p_dev);
752                         p_dev->irq = s->pcmcia_irq = irq;
753                         pcmcia_used_irq[irq]++;
754                         break;
755                 }
756         }
757
758         return ret;
759 }
760
761 void pcmcia_cleanup_irq(struct pcmcia_socket *s)
762 {
763         pcmcia_used_irq[s->pcmcia_irq]--;
764         s->pcmcia_irq = 0;
765 }
766
767 #else /* CONFIG_PCMCIA_PROBE */
768
769 static int pcmcia_setup_isa_irq(struct pcmcia_device *p_dev, int type)
770 {
771         return -EINVAL;
772 }
773
774 void pcmcia_cleanup_irq(struct pcmcia_socket *s)
775 {
776         s->pcmcia_irq = 0;
777         return;
778 }
779
780 #endif  /* CONFIG_PCMCIA_PROBE */
781
782
783 /**
784  * pcmcia_setup_irq() - determine IRQ to be used for device
785  * @p_dev - the associated PCMCIA device
786  *
787  * locking note: must be called with ops_mutex locked.
788  */
789 int pcmcia_setup_irq(struct pcmcia_device *p_dev)
790 {
791         struct pcmcia_socket *s = p_dev->socket;
792
793         if (p_dev->irq)
794                 return 0;
795
796         /* already assigned? */
797         if (s->pcmcia_irq) {
798                 p_dev->irq = s->pcmcia_irq;
799                 return 0;
800         }
801
802         /* prefer an exclusive ISA irq */
803         if (!pcmcia_setup_isa_irq(p_dev, 0))
804                 return 0;
805
806         /* but accept a shared ISA irq */
807         if (!pcmcia_setup_isa_irq(p_dev, IRQF_SHARED))
808                 return 0;
809
810         /* but use the PCI irq otherwise */
811         if (s->pci_irq) {
812                 p_dev->irq = s->pcmcia_irq = s->pci_irq;
813                 return 0;
814         }
815
816         return -EINVAL;
817 }
818
819
820 /** pcmcia_request_window
821  *
822  * Request_window() establishes a mapping between card memory space
823  * and system memory space.
824  */
825 int pcmcia_request_window(struct pcmcia_device *p_dev, win_req_t *req, window_handle_t *wh)
826 {
827         struct pcmcia_socket *s = p_dev->socket;
828         pccard_mem_map *win;
829         u_long align;
830         int w;
831
832         if (!(s->state & SOCKET_PRESENT)) {
833                 dev_dbg(&s->dev, "No card present\n");
834                 return -ENODEV;
835         }
836         if (req->Attributes & (WIN_PAGED | WIN_SHARED)) {
837                 dev_dbg(&s->dev, "bad attribute setting for iomem region\n");
838                 return -EINVAL;
839         }
840
841         /* Window size defaults to smallest available */
842         if (req->Size == 0)
843                 req->Size = s->map_size;
844         align = (((s->features & SS_CAP_MEM_ALIGN) ||
845                   (req->Attributes & WIN_STRICT_ALIGN)) ?
846                  req->Size : s->map_size);
847         if (req->Size & (s->map_size-1)) {
848                 dev_dbg(&s->dev, "invalid map size\n");
849                 return -EINVAL;
850         }
851         if ((req->Base && (s->features & SS_CAP_STATIC_MAP)) ||
852             (req->Base & (align-1))) {
853                 dev_dbg(&s->dev, "invalid base address\n");
854                 return -EINVAL;
855         }
856         if (req->Base)
857                 align = 0;
858
859         /* Allocate system memory window */
860         for (w = 0; w < MAX_WIN; w++)
861                 if (!(s->state & SOCKET_WIN_REQ(w)))
862                         break;
863         if (w == MAX_WIN) {
864                 dev_dbg(&s->dev, "all windows are used already\n");
865                 return -EINVAL;
866         }
867
868         mutex_lock(&s->ops_mutex);
869         win = &s->win[w];
870
871         if (!(s->features & SS_CAP_STATIC_MAP)) {
872                 win->res = pcmcia_find_mem_region(req->Base, req->Size, align,
873                                                       (req->Attributes & WIN_MAP_BELOW_1MB), s);
874                 if (!win->res) {
875                         dev_dbg(&s->dev, "allocating mem region failed\n");
876                         mutex_unlock(&s->ops_mutex);
877                         return -EINVAL;
878                 }
879         }
880         p_dev->_win |= CLIENT_WIN_REQ(w);
881
882         /* Configure the socket controller */
883         win->map = w+1;
884         win->flags = 0;
885         win->speed = req->AccessSpeed;
886         if (req->Attributes & WIN_MEMORY_TYPE)
887                 win->flags |= MAP_ATTRIB;
888         if (req->Attributes & WIN_ENABLE)
889                 win->flags |= MAP_ACTIVE;
890         if (req->Attributes & WIN_DATA_WIDTH_16)
891                 win->flags |= MAP_16BIT;
892         if (req->Attributes & WIN_USE_WAIT)
893                 win->flags |= MAP_USE_WAIT;
894         win->card_start = 0;
895
896         if (s->ops->set_mem_map(s, win) != 0) {
897                 dev_dbg(&s->dev, "failed to set memory mapping\n");
898                 mutex_unlock(&s->ops_mutex);
899                 return -EIO;
900         }
901         s->state |= SOCKET_WIN_REQ(w);
902
903         /* Return window handle */
904         if (s->features & SS_CAP_STATIC_MAP)
905                 req->Base = win->static_start;
906         else
907                 req->Base = win->res->start;
908
909         mutex_unlock(&s->ops_mutex);
910         *wh = w + 1;
911
912         return 0;
913 } /* pcmcia_request_window */
914 EXPORT_SYMBOL(pcmcia_request_window);
915
916 void pcmcia_disable_device(struct pcmcia_device *p_dev)
917 {
918         pcmcia_release_configuration(p_dev);
919         pcmcia_release_io(p_dev, &p_dev->io);
920         if (p_dev->_irq)
921                 free_irq(p_dev->irq, p_dev->priv);
922         if (p_dev->win)
923                 pcmcia_release_window(p_dev, p_dev->win);
924 }
925 EXPORT_SYMBOL(pcmcia_disable_device);
926
927
928 struct pcmcia_cfg_mem {
929         struct pcmcia_device *p_dev;
930         void *priv_data;
931         int (*conf_check) (struct pcmcia_device *p_dev,
932                            cistpl_cftable_entry_t *cfg,
933                            cistpl_cftable_entry_t *dflt,
934                            unsigned int vcc,
935                            void *priv_data);
936         cisparse_t parse;
937         cistpl_cftable_entry_t dflt;
938 };
939
940 /**
941  * pcmcia_do_loop_config() - internal helper for pcmcia_loop_config()
942  *
943  * pcmcia_do_loop_config() is the internal callback for the call from
944  * pcmcia_loop_config() to pccard_loop_tuple(). Data is transferred
945  * by a struct pcmcia_cfg_mem.
946  */
947 static int pcmcia_do_loop_config(tuple_t *tuple, cisparse_t *parse, void *priv)
948 {
949         cistpl_cftable_entry_t *cfg = &parse->cftable_entry;
950         struct pcmcia_cfg_mem *cfg_mem = priv;
951
952         /* default values */
953         cfg_mem->p_dev->conf.ConfigIndex = cfg->index;
954         if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
955                 cfg_mem->dflt = *cfg;
956
957         return cfg_mem->conf_check(cfg_mem->p_dev, cfg, &cfg_mem->dflt,
958                                    cfg_mem->p_dev->socket->socket.Vcc,
959                                    cfg_mem->priv_data);
960 }
961
962 /**
963  * pcmcia_loop_config() - loop over configuration options
964  * @p_dev:      the struct pcmcia_device which we need to loop for.
965  * @conf_check: function to call for each configuration option.
966  *              It gets passed the struct pcmcia_device, the CIS data
967  *              describing the configuration option, and private data
968  *              being passed to pcmcia_loop_config()
969  * @priv_data:  private data to be passed to the conf_check function.
970  *
971  * pcmcia_loop_config() loops over all configuration options, and calls
972  * the driver-specific conf_check() for each one, checking whether
973  * it is a valid one. Returns 0 on success or errorcode otherwise.
974  */
975 int pcmcia_loop_config(struct pcmcia_device *p_dev,
976                        int      (*conf_check)   (struct pcmcia_device *p_dev,
977                                                  cistpl_cftable_entry_t *cfg,
978                                                  cistpl_cftable_entry_t *dflt,
979                                                  unsigned int vcc,
980                                                  void *priv_data),
981                        void *priv_data)
982 {
983         struct pcmcia_cfg_mem *cfg_mem;
984         int ret;
985
986         cfg_mem = kzalloc(sizeof(struct pcmcia_cfg_mem), GFP_KERNEL);
987         if (cfg_mem == NULL)
988                 return -ENOMEM;
989
990         cfg_mem->p_dev = p_dev;
991         cfg_mem->conf_check = conf_check;
992         cfg_mem->priv_data = priv_data;
993
994         ret = pccard_loop_tuple(p_dev->socket, p_dev->func,
995                                 CISTPL_CFTABLE_ENTRY, &cfg_mem->parse,
996                                 cfg_mem, pcmcia_do_loop_config);
997
998         kfree(cfg_mem);
999         return ret;
1000 }
1001 EXPORT_SYMBOL(pcmcia_loop_config);
1002
1003
1004 struct pcmcia_loop_mem {
1005         struct pcmcia_device *p_dev;
1006         void *priv_data;
1007         int (*loop_tuple) (struct pcmcia_device *p_dev,
1008                            tuple_t *tuple,
1009                            void *priv_data);
1010 };
1011
1012 /**
1013  * pcmcia_do_loop_tuple() - internal helper for pcmcia_loop_config()
1014  *
1015  * pcmcia_do_loop_tuple() is the internal callback for the call from
1016  * pcmcia_loop_tuple() to pccard_loop_tuple(). Data is transferred
1017  * by a struct pcmcia_cfg_mem.
1018  */
1019 static int pcmcia_do_loop_tuple(tuple_t *tuple, cisparse_t *parse, void *priv)
1020 {
1021         struct pcmcia_loop_mem *loop = priv;
1022
1023         return loop->loop_tuple(loop->p_dev, tuple, loop->priv_data);
1024 };
1025
1026 /**
1027  * pcmcia_loop_tuple() - loop over tuples in the CIS
1028  * @p_dev:      the struct pcmcia_device which we need to loop for.
1029  * @code:       which CIS code shall we look for?
1030  * @priv_data:  private data to be passed to the loop_tuple function.
1031  * @loop_tuple: function to call for each CIS entry of type @function. IT
1032  *              gets passed the raw tuple and @priv_data.
1033  *
1034  * pcmcia_loop_tuple() loops over all CIS entries of type @function, and
1035  * calls the @loop_tuple function for each entry. If the call to @loop_tuple
1036  * returns 0, the loop exits. Returns 0 on success or errorcode otherwise.
1037  */
1038 int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code,
1039                       int (*loop_tuple) (struct pcmcia_device *p_dev,
1040                                          tuple_t *tuple,
1041                                          void *priv_data),
1042                       void *priv_data)
1043 {
1044         struct pcmcia_loop_mem loop = {
1045                 .p_dev = p_dev,
1046                 .loop_tuple = loop_tuple,
1047                 .priv_data = priv_data};
1048
1049         return pccard_loop_tuple(p_dev->socket, p_dev->func, code, NULL,
1050                                  &loop, pcmcia_do_loop_tuple);
1051 }
1052 EXPORT_SYMBOL(pcmcia_loop_tuple);
1053
1054
1055 struct pcmcia_loop_get {
1056         size_t len;
1057         cisdata_t **buf;
1058 };
1059
1060 /**
1061  * pcmcia_do_get_tuple() - internal helper for pcmcia_get_tuple()
1062  *
1063  * pcmcia_do_get_tuple() is the internal callback for the call from
1064  * pcmcia_get_tuple() to pcmcia_loop_tuple(). As we're only interested in
1065  * the first tuple, return 0 unconditionally. Create a memory buffer large
1066  * enough to hold the content of the tuple, and fill it with the tuple data.
1067  * The caller is responsible to free the buffer.
1068  */
1069 static int pcmcia_do_get_tuple(struct pcmcia_device *p_dev, tuple_t *tuple,
1070                                void *priv)
1071 {
1072         struct pcmcia_loop_get *get = priv;
1073
1074         *get->buf = kzalloc(tuple->TupleDataLen, GFP_KERNEL);
1075         if (*get->buf) {
1076                 get->len = tuple->TupleDataLen;
1077                 memcpy(*get->buf, tuple->TupleData, tuple->TupleDataLen);
1078         } else
1079                 dev_dbg(&p_dev->dev, "do_get_tuple: out of memory\n");
1080         return 0;
1081 }
1082
1083 /**
1084  * pcmcia_get_tuple() - get first tuple from CIS
1085  * @p_dev:      the struct pcmcia_device which we need to loop for.
1086  * @code:       which CIS code shall we look for?
1087  * @buf:        pointer to store the buffer to.
1088  *
1089  * pcmcia_get_tuple() gets the content of the first CIS entry of type @code.
1090  * It returns the buffer length (or zero). The caller is responsible to free
1091  * the buffer passed in @buf.
1092  */
1093 size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code,
1094                         unsigned char **buf)
1095 {
1096         struct pcmcia_loop_get get = {
1097                 .len = 0,
1098                 .buf = buf,
1099         };
1100
1101         *get.buf = NULL;
1102         pcmcia_loop_tuple(p_dev, code, pcmcia_do_get_tuple, &get);
1103
1104         return get.len;
1105 }
1106 EXPORT_SYMBOL(pcmcia_get_tuple);
1107
1108
1109 /**
1110  * pcmcia_do_get_mac() - internal helper for pcmcia_get_mac_from_cis()
1111  *
1112  * pcmcia_do_get_mac() is the internal callback for the call from
1113  * pcmcia_get_mac_from_cis() to pcmcia_loop_tuple(). We check whether the
1114  * tuple contains a proper LAN_NODE_ID of length 6, and copy the data
1115  * to struct net_device->dev_addr[i].
1116  */
1117 static int pcmcia_do_get_mac(struct pcmcia_device *p_dev, tuple_t *tuple,
1118                              void *priv)
1119 {
1120         struct net_device *dev = priv;
1121         int i;
1122
1123         if (tuple->TupleData[0] != CISTPL_FUNCE_LAN_NODE_ID)
1124                 return -EINVAL;
1125         if (tuple->TupleDataLen < ETH_ALEN + 2) {
1126                 dev_warn(&p_dev->dev, "Invalid CIS tuple length for "
1127                         "LAN_NODE_ID\n");
1128                 return -EINVAL;
1129         }
1130
1131         if (tuple->TupleData[1] != ETH_ALEN) {
1132                 dev_warn(&p_dev->dev, "Invalid header for LAN_NODE_ID\n");
1133                 return -EINVAL;
1134         }
1135         for (i = 0; i < 6; i++)
1136                 dev->dev_addr[i] = tuple->TupleData[i+2];
1137         return 0;
1138 }
1139
1140 /**
1141  * pcmcia_get_mac_from_cis() - read out MAC address from CISTPL_FUNCE
1142  * @p_dev:      the struct pcmcia_device for which we want the address.
1143  * @dev:        a properly prepared struct net_device to store the info to.
1144  *
1145  * pcmcia_get_mac_from_cis() reads out the hardware MAC address from
1146  * CISTPL_FUNCE and stores it into struct net_device *dev->dev_addr which
1147  * must be set up properly by the driver (see examples!).
1148  */
1149 int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev, struct net_device *dev)
1150 {
1151         return pcmcia_loop_tuple(p_dev, CISTPL_FUNCE, pcmcia_do_get_mac, dev);
1152 }
1153 EXPORT_SYMBOL(pcmcia_get_mac_from_cis);
1154