drivers/pcmcia/pcmcia_resource.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * PCMCIA 16-bit resource management functions
   4  *
   5  * The initial developer of the original code is David A. Hinds
   6  * <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
   7  * are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
   8  *
   9  * Copyright (C) 1999        David A. Hinds
  10  * Copyright (C) 2004-2010   Dominik Brodowski
  11  */
  12
  13 #include <linux/module.h>
  14 #include <linux/kernel.h>
  15 #include <linux/interrupt.h>
  16 #include <linux/delay.h>
  17 #include <linux/pci.h>
  18 #include <linux/device.h>
  19 #include <linux/netdevice.h>
  20 #include <linux/slab.h>
  21
  22 #include <asm/irq.h>
  23
  24 #include <pcmcia/ss.h>
  25 #include <pcmcia/cistpl.h>
  26 #include <pcmcia/cisreg.h>
  27 #include <pcmcia/ds.h>
  28
  29 #include "cs_internal.h"
  30
  31
  32 /* Access speed for IO windows */
  33 static int io_speed;
  34 module_param(io_speed, int, 0444);
  35
  36
  37 int pcmcia_validate_mem(struct pcmcia_socket *s)
  38 {
  39         if (s->resource_ops->validate_mem)
  40                 return s->resource_ops->validate_mem(s);
  41         /* if there is no callback, we can assume that everything is OK */
  42         return 0;
  43 }
  44
  45 struct resource *pcmcia_find_mem_region(u_long base, u_long num, u_long align,
  46                                  int low, struct pcmcia_socket *s)
  47 {
  48         if (s->resource_ops->find_mem)
  49                 return s->resource_ops->find_mem(base, num, align, low, s);
  50         return NULL;
  51 }
  52
  53
  54 /**
  55  * release_io_space() - release IO ports allocated with alloc_io_space()
  56  * @s: pcmcia socket
  57  * @res: resource to release
  58  *
  59  */
  60 static void release_io_space(struct pcmcia_socket *s, struct resource *res)
  61 {
  62         resource_size_t num = resource_size(res);
  63         int i;
  64
  65         dev_dbg(&s->dev, "release_io_space for %pR\n", res);
  66
  67         for (i = 0; i < MAX_IO_WIN; i++) {
  68                 if (!s->io[i].res)
  69                         continue;
  70                 if ((s->io[i].res->start <= res->start) &&
  71                     (s->io[i].res->end >= res->end)) {
  72                         s->io[i].InUse -= num;
  73                         if (res->parent)
  74                                 release_resource(res);
  75                         res->start = res->end = 0;
  76                         res->flags = IORESOURCE_IO;
  77                         /* Free the window if no one else is using it */
  78                         if (s->io[i].InUse == 0) {
  79                                 release_resource(s->io[i].res);
  80                                 kfree(s->io[i].res);
  81                                 s->io[i].res = NULL;
  82                         }
  83                 }
  84         }
  85 }
  86
  87
  88 /**
  89  * alloc_io_space() - allocate IO ports for use by a PCMCIA device
  90  * @s: pcmcia socket
  91  * @res: resource to allocate (begin: begin, end: size)
  92  * @lines: number of IO lines decoded by the PCMCIA card
  93  *
  94  * Special stuff for managing IO windows, because they are scarce
  95  */
  96 static int alloc_io_space(struct pcmcia_socket *s, struct resource *res,
  97                         unsigned int lines)
  98 {
  99         unsigned int align;
 100         unsigned int base = res->start;
 101         unsigned int num = res->end;
 102         int ret;
 103
 104         res->flags |= IORESOURCE_IO;
 105
 106         dev_dbg(&s->dev, "alloc_io_space request for %pR, %d lines\n",
 107                 res, lines);
 108
 109         align = base ? (lines ? 1<<lines : 0) : 1;
 110         if (align && (align < num)) {
 111                 if (base) {
 112                         dev_dbg(&s->dev, "odd IO request\n");
 113                         align = 0;
 114                 } else
 115                         while (align && (align < num))
 116                                 align <<= 1;
 117         }
 118         if (base & ~(align-1)) {
 119                 dev_dbg(&s->dev, "odd IO request\n");
 120                 align = 0;
 121         }
 122
 123         ret = s->resource_ops->find_io(s, res->flags, &base, num, align,
 124                                 &res->parent);
 125         if (ret) {
 126                 dev_dbg(&s->dev, "alloc_io_space request failed (%d)\n", ret);
 127                 return -EINVAL;
 128         }
 129
 130         res->start = base;
 131         res->end = res->start + num - 1;
 132
 133         if (res->parent) {
 134                 ret = request_resource(res->parent, res);
 135                 if (ret) {
 136                         dev_warn(&s->dev,
 137                                 "request_resource %pR failed: %d\n", res, ret);
 138                         res->parent = NULL;
 139                         release_io_space(s, res);
 140                 }
 141         }
 142         dev_dbg(&s->dev, "alloc_io_space request result %d: %pR\n", ret, res);
 143         return ret;
 144 }
 145
 146
 147 /*
 148  * pcmcia_access_config() - read or write card configuration registers
 149  *
 150  * pcmcia_access_config() reads and writes configuration registers in
 151  * attribute memory.  Memory window 0 is reserved for this and the tuple
 152  * reading services. Drivers must use pcmcia_read_config_byte() or
 153  * pcmcia_write_config_byte().
 154  */
 155 static int pcmcia_access_config(struct pcmcia_device *p_dev,
 156                                 off_t where, u8 *val,
 157                                 int (*accessf) (struct pcmcia_socket *s,
 158                                                 int attr, unsigned int addr,
 159                                                 unsigned int len, void *ptr))
 160 {
 161         struct pcmcia_socket *s;
 162         config_t *c;
 163         int addr;
 164         int ret = 0;
 165
 166         s = p_dev->socket;
 167
 168         mutex_lock(&s->ops_mutex);
 169         c = p_dev->function_config;
 170
 171         if (!(c->state & CONFIG_LOCKED)) {
 172                 dev_dbg(&p_dev->dev, "Configuration isn't locked\n");
 173                 mutex_unlock(&s->ops_mutex);
 174                 return -EACCES;
 175         }
 176
 177         addr = (p_dev->config_base + where) >> 1;
 178
 179         ret = accessf(s, 1, addr, 1, val);
 180
 181         mutex_unlock(&s->ops_mutex);
 182
 183         return ret;
 184 }
 185
 186
 187 /*
 188  * pcmcia_read_config_byte() - read a byte from a card configuration register
 189  *
 190  * pcmcia_read_config_byte() reads a byte from a configuration register in
 191  * attribute memory.
 192  */
 193 int pcmcia_read_config_byte(struct pcmcia_device *p_dev, off_t where, u8 *val)
 194 {
 195         return pcmcia_access_config(p_dev, where, val, pcmcia_read_cis_mem);
 196 }
 197 EXPORT_SYMBOL(pcmcia_read_config_byte);
 198
 199
 200 /*
 201  * pcmcia_write_config_byte() - write a byte to a card configuration register
 202  *
 203  * pcmcia_write_config_byte() writes a byte to a configuration register in
 204  * attribute memory.
 205  */
 206 int pcmcia_write_config_byte(struct pcmcia_device *p_dev, off_t where, u8 val)
 207 {
 208         return pcmcia_access_config(p_dev, where, &val, pcmcia_write_cis_mem);
 209 }
 210 EXPORT_SYMBOL(pcmcia_write_config_byte);
 211
 212
 213 /**
 214  * pcmcia_map_mem_page() - modify iomem window to point to a different offset
 215  * @p_dev: pcmcia device
 216  * @res: iomem resource already enabled by pcmcia_request_window()
 217  * @offset: card_offset to map
 218  *
 219  * pcmcia_map_mem_page() modifies what can be read and written by accessing
 220  * an iomem range previously enabled by pcmcia_request_window(), by setting
 221  * the card_offset value to @offset.
 222  */
 223 int pcmcia_map_mem_page(struct pcmcia_device *p_dev, struct resource *res,
 224                         unsigned int offset)
 225 {
 226         struct pcmcia_socket *s = p_dev->socket;
 227         unsigned int w;
 228         int ret;
 229
 230         w = ((res->flags & IORESOURCE_BITS & WIN_FLAGS_REQ) >> 2) - 1;
 231         if (w >= MAX_WIN)
 232                 return -EINVAL;
 233
 234         mutex_lock(&s->ops_mutex);
 235         s->win[w].card_start = offset;
 236         ret = s->ops->set_mem_map(s, &s->win[w]);
 237         if (ret)
 238                 dev_warn(&p_dev->dev, "failed to set_mem_map\n");
 239         mutex_unlock(&s->ops_mutex);
 240         return ret;
 241 }
 242 EXPORT_SYMBOL(pcmcia_map_mem_page);
 243
 244
 245 /**
 246  * pcmcia_fixup_iowidth() - reduce io width to 8bit
 247  * @p_dev: pcmcia device
 248  *
 249  * pcmcia_fixup_iowidth() allows a PCMCIA device driver to reduce the
 250  * IO width to 8bit after having called pcmcia_enable_device()
 251  * previously.
 252  */
 253 int pcmcia_fixup_iowidth(struct pcmcia_device *p_dev)
 254 {
 255         struct pcmcia_socket *s = p_dev->socket;
 256         pccard_io_map io_off = { 0, 0, 0, 0, 1 };
 257         pccard_io_map io_on;
 258         int i, ret = 0;
 259
 260         mutex_lock(&s->ops_mutex);
 261
 262         dev_dbg(&p_dev->dev, "fixup iowidth to 8bit\n");
 263
 264         if (!(s->state & SOCKET_PRESENT) ||
 265                 !(p_dev->function_config->state & CONFIG_LOCKED)) {
 266                 dev_dbg(&p_dev->dev, "No card? Config not locked?\n");
 267                 ret = -EACCES;
 268                 goto unlock;
 269         }
 270
 271         io_on.speed = io_speed;
 272         for (i = 0; i < MAX_IO_WIN; i++) {
 273                 if (!s->io[i].res)
 274                         continue;
 275                 io_off.map = i;
 276                 io_on.map = i;
 277
 278                 io_on.flags = MAP_ACTIVE | IO_DATA_PATH_WIDTH_8;
 279                 io_on.start = s->io[i].res->start;
 280                 io_on.stop = s->io[i].res->end;
 281
 282                 s->ops->set_io_map(s, &io_off);
 283                 msleep(40);
 284                 s->ops->set_io_map(s, &io_on);
 285         }
 286 unlock:
 287         mutex_unlock(&s->ops_mutex);
 288
 289         return ret;
 290 }
 291 EXPORT_SYMBOL(pcmcia_fixup_iowidth);
 292
 293
 294 /**
 295  * pcmcia_fixup_vpp() - set Vpp to a new voltage level
 296  * @p_dev: pcmcia device
 297  * @new_vpp: new Vpp voltage
 298  *
 299  * pcmcia_fixup_vpp() allows a PCMCIA device driver to set Vpp to
 300  * a new voltage level between calls to pcmcia_enable_device()
 301  * and pcmcia_disable_device().
 302  */
 303 int pcmcia_fixup_vpp(struct pcmcia_device *p_dev, unsigned char new_vpp)
 304 {
 305         struct pcmcia_socket *s = p_dev->socket;
 306         int ret = 0;
 307
 308         mutex_lock(&s->ops_mutex);
 309
 310         dev_dbg(&p_dev->dev, "fixup Vpp to %d\n", new_vpp);
 311
 312         if (!(s->state & SOCKET_PRESENT) ||
 313                 !(p_dev->function_config->state & CONFIG_LOCKED)) {
 314                 dev_dbg(&p_dev->dev, "No card? Config not locked?\n");
 315                 ret = -EACCES;
 316                 goto unlock;
 317         }
 318
 319         s->socket.Vpp = new_vpp;
 320         if (s->ops->set_socket(s, &s->socket)) {
 321                 dev_warn(&p_dev->dev, "Unable to set VPP\n");
 322                 ret = -EIO;
 323                 goto unlock;
 324         }
 325         p_dev->vpp = new_vpp;
 326
 327 unlock:
 328         mutex_unlock(&s->ops_mutex);
 329
 330         return ret;
 331 }
 332 EXPORT_SYMBOL(pcmcia_fixup_vpp);
 333
 334
 335 /**
 336  * pcmcia_release_configuration() - physically disable a PCMCIA device
 337  * @p_dev: pcmcia device
 338  *
 339  * pcmcia_release_configuration() is the 1:1 counterpart to
 340  * pcmcia_enable_device(): If a PCMCIA device is no longer used by any
 341  * driver, the Vpp voltage is set to 0, IRQs will no longer be generated,
 342  * and I/O ranges will be disabled. As pcmcia_release_io() and
 343  * pcmcia_release_window() still need to be called, device drivers are
 344  * expected to call pcmcia_disable_device() instead.
 345  */
 346 int pcmcia_release_configuration(struct pcmcia_device *p_dev)
 347 {
 348         pccard_io_map io = { 0, 0, 0, 0, 1 };
 349         struct pcmcia_socket *s = p_dev->socket;
 350         config_t *c;
 351         int i;
 352
 353         mutex_lock(&s->ops_mutex);
 354         c = p_dev->function_config;
 355         if (p_dev->_locked) {
 356                 p_dev->_locked = 0;
 357                 if (--(s->lock_count) == 0) {
 358                         s->socket.flags = SS_OUTPUT_ENA; /* Is this correct? */
 359                         s->socket.Vpp = 0;
 360                         s->socket.io_irq = 0;
 361                         s->ops->set_socket(s, &s->socket);
 362                 }
 363         }
 364         if (c->state & CONFIG_LOCKED) {
 365                 c->state &= ~CONFIG_LOCKED;
 366                 if (c->state & CONFIG_IO_REQ)
 367                         for (i = 0; i < MAX_IO_WIN; i++) {
 368                                 if (!s->io[i].res)
 369                                         continue;
 370                                 s->io[i].Config--;
 371                                 if (s->io[i].Config != 0)
 372                                         continue;
 373                                 io.map = i;
 374                                 s->ops->set_io_map(s, &io);
 375                         }
 376         }
 377         mutex_unlock(&s->ops_mutex);
 378
 379         return 0;
 380 }
 381
 382
 383 /**
 384  * pcmcia_release_io() - release I/O allocated by a PCMCIA device
 385  * @p_dev: pcmcia device
 386  *
 387  * pcmcia_release_io() releases the I/O ranges allocated by a PCMCIA
 388  * device.  This may be invoked some time after a card ejection has
 389  * already dumped the actual socket configuration, so if the client is
 390  * "stale", we don't bother checking the port ranges against the
 391  * current socket values.
 392  */
 393 static int pcmcia_release_io(struct pcmcia_device *p_dev)
 394 {
 395         struct pcmcia_socket *s = p_dev->socket;
 396         int ret = -EINVAL;
 397         config_t *c;
 398
 399         mutex_lock(&s->ops_mutex);
 400         if (!p_dev->_io)
 401                 goto out;
 402
 403         c = p_dev->function_config;
 404
 405         release_io_space(s, &c->io[0]);
 406
 407         if (c->io[1].end)
 408                 release_io_space(s, &c->io[1]);
 409
 410         p_dev->_io = 0;
 411         c->state &= ~CONFIG_IO_REQ;
 412
 413 out:
 414         mutex_unlock(&s->ops_mutex);
 415
 416         return ret;
 417 } /* pcmcia_release_io */
 418
 419
 420 /**
 421  * pcmcia_release_window() - release reserved iomem for PCMCIA devices
 422  * @p_dev: pcmcia device
 423  * @res: iomem resource to release
 424  *
 425  * pcmcia_release_window() releases &struct resource *res which was
 426  * previously reserved by calling pcmcia_request_window().
 427  */
 428 int pcmcia_release_window(struct pcmcia_device *p_dev, struct resource *res)
 429 {
 430         struct pcmcia_socket *s = p_dev->socket;
 431         pccard_mem_map *win;
 432         unsigned int w;
 433
 434         dev_dbg(&p_dev->dev, "releasing window %pR\n", res);
 435
 436         w = ((res->flags & IORESOURCE_BITS & WIN_FLAGS_REQ) >> 2) - 1;
 437         if (w >= MAX_WIN)
 438                 return -EINVAL;
 439
 440         mutex_lock(&s->ops_mutex);
 441         win = &s->win[w];
 442
 443         if (!(p_dev->_win & CLIENT_WIN_REQ(w))) {
 444                 dev_dbg(&p_dev->dev, "not releasing unknown window\n");
 445                 mutex_unlock(&s->ops_mutex);
 446                 return -EINVAL;
 447         }
 448
 449         /* Shut down memory window */
 450         win->flags &= ~MAP_ACTIVE;
 451         s->ops->set_mem_map(s, win);
 452         s->state &= ~SOCKET_WIN_REQ(w);
 453
 454         /* Release system memory */
 455         if (win->res) {
 456                 release_resource(res);
 457                 release_resource(win->res);
 458                 kfree(win->res);
 459                 win->res = NULL;
 460         }
 461         res->start = res->end = 0;
 462         res->flags = IORESOURCE_MEM;
 463         p_dev->_win &= ~CLIENT_WIN_REQ(w);
 464         mutex_unlock(&s->ops_mutex);
 465
 466         return 0;
 467 } /* pcmcia_release_window */
 468 EXPORT_SYMBOL(pcmcia_release_window);
 469
 470
 471 /**
 472  * pcmcia_enable_device() - set up and activate a PCMCIA device
 473  * @p_dev: the associated PCMCIA device
 474  *
 475  * pcmcia_enable_device() physically enables a PCMCIA device. It parses
 476  * the flags passed to in @flags and stored in @p_dev->flags and sets up
 477  * the Vpp voltage, enables the speaker line, I/O ports and store proper
 478  * values to configuration registers.
 479  */
 480 int pcmcia_enable_device(struct pcmcia_device *p_dev)
 481 {
 482         int i;
 483         unsigned int base;
 484         struct pcmcia_socket *s = p_dev->socket;
 485         config_t *c;
 486         pccard_io_map iomap;
 487         unsigned char status = 0;
 488         unsigned char ext_status = 0;
 489         unsigned char option = 0;
 490         unsigned int flags = p_dev->config_flags;
 491
 492         if (!(s->state & SOCKET_PRESENT))
 493                 return -ENODEV;
 494
 495         mutex_lock(&s->ops_mutex);
 496         c = p_dev->function_config;
 497         if (c->state & CONFIG_LOCKED) {
 498                 mutex_unlock(&s->ops_mutex);
 499                 dev_dbg(&p_dev->dev, "Configuration is locked\n");
 500                 return -EACCES;
 501         }
 502
 503         /* Do power control.  We don't allow changes in Vcc. */
 504         s->socket.Vpp = p_dev->vpp;
 505         if (s->ops->set_socket(s, &s->socket)) {
 506                 mutex_unlock(&s->ops_mutex);
 507                 dev_warn(&p_dev->dev, "Unable to set socket state\n");
 508                 return -EINVAL;
 509         }
 510
 511         /* Pick memory or I/O card, DMA mode, interrupt */
 512         if (p_dev->_io || flags & CONF_ENABLE_IRQ)
 513                 flags |= CONF_ENABLE_IOCARD;
 514         if (flags & CONF_ENABLE_IOCARD)
 515                 s->socket.flags |= SS_IOCARD;
 516         if (flags & CONF_ENABLE_ZVCARD)
 517                 s->socket.flags |= SS_ZVCARD | SS_IOCARD;
 518         if (flags & CONF_ENABLE_SPKR) {
 519                 s->socket.flags |= SS_SPKR_ENA;
 520                 status = CCSR_AUDIO_ENA;
 521                 if (!(p_dev->config_regs & PRESENT_STATUS))
 522                         dev_warn(&p_dev->dev, "speaker requested, but "
 523                                               "PRESENT_STATUS not set!\n");
 524         }
 525         if (flags & CONF_ENABLE_IRQ)
 526                 s->socket.io_irq = s->pcmcia_irq;
 527         else
 528                 s->socket.io_irq = 0;
 529         if (flags & CONF_ENABLE_ESR) {
 530                 p_dev->config_regs |= PRESENT_EXT_STATUS;
 531                 ext_status = ESR_REQ_ATTN_ENA;
 532         }
 533         s->ops->set_socket(s, &s->socket);
 534         s->lock_count++;
 535
 536         dev_dbg(&p_dev->dev,
 537                 "enable_device: V %d, flags %x, base %x, regs %x, idx %x\n",
 538                 p_dev->vpp, flags, p_dev->config_base, p_dev->config_regs,
 539                 p_dev->config_index);
 540
 541         /* Set up CIS configuration registers */
 542         base = p_dev->config_base;
 543         if (p_dev->config_regs & PRESENT_COPY) {
 544                 u16 tmp = 0;
 545                 dev_dbg(&p_dev->dev, "clearing CISREG_SCR\n");
 546                 pcmcia_write_cis_mem(s, 1, (base + CISREG_SCR)>>1, 1, &tmp);
 547         }
 548         if (p_dev->config_regs & PRESENT_PIN_REPLACE) {
 549                 u16 tmp = 0;
 550                 dev_dbg(&p_dev->dev, "clearing CISREG_PRR\n");
 551                 pcmcia_write_cis_mem(s, 1, (base + CISREG_PRR)>>1, 1, &tmp);
 552         }
 553         if (p_dev->config_regs & PRESENT_OPTION) {
 554                 if (s->functions == 1) {
 555                         option = p_dev->config_index & COR_CONFIG_MASK;
 556                 } else {
 557                         option = p_dev->config_index & COR_MFC_CONFIG_MASK;
 558                         option |= COR_FUNC_ENA|COR_IREQ_ENA;
 559                         if (p_dev->config_regs & PRESENT_IOBASE_0)
 560                                 option |= COR_ADDR_DECODE;
 561                 }
 562                 if ((flags & CONF_ENABLE_IRQ) &&
 563                         !(flags & CONF_ENABLE_PULSE_IRQ))
 564                         option |= COR_LEVEL_REQ;
 565                 pcmcia_write_cis_mem(s, 1, (base + CISREG_COR)>>1, 1, &option);
 566                 msleep(40);
 567         }
 568         if (p_dev->config_regs & PRESENT_STATUS)
 569                 pcmcia_write_cis_mem(s, 1, (base + CISREG_CCSR)>>1, 1, &status);
 570
 571         if (p_dev->config_regs & PRESENT_EXT_STATUS)
 572                 pcmcia_write_cis_mem(s, 1, (base + CISREG_ESR)>>1, 1,
 573                                         &ext_status);
 574
 575         if (p_dev->config_regs & PRESENT_IOBASE_0) {
 576                 u8 b = c->io[0].start & 0xff;
 577                 pcmcia_write_cis_mem(s, 1, (base + CISREG_IOBASE_0)>>1, 1, &b);
 578                 b = (c->io[0].start >> 8) & 0xff;
 579                 pcmcia_write_cis_mem(s, 1, (base + CISREG_IOBASE_1)>>1, 1, &b);
 580         }
 581         if (p_dev->config_regs & PRESENT_IOSIZE) {
 582                 u8 b = resource_size(&c->io[0]) + resource_size(&c->io[1]) - 1;
 583                 pcmcia_write_cis_mem(s, 1, (base + CISREG_IOSIZE)>>1, 1, &b);
 584         }
 585
 586         /* Configure I/O windows */
 587         if (c->state & CONFIG_IO_REQ) {
 588                 iomap.speed = io_speed;
 589                 for (i = 0; i < MAX_IO_WIN; i++)
 590                         if (s->io[i].res) {
 591                                 iomap.map = i;
 592                                 iomap.flags = MAP_ACTIVE;
 593                                 switch (s->io[i].res->flags & IO_DATA_PATH_WIDTH) {
 594                                 case IO_DATA_PATH_WIDTH_16:
 595                                         iomap.flags |= MAP_16BIT; break;
 596                                 case IO_DATA_PATH_WIDTH_AUTO:
 597                                         iomap.flags |= MAP_AUTOSZ; break;
 598                                 default:
 599                                         break;
 600                                 }
 601                                 iomap.start = s->io[i].res->start;
 602                                 iomap.stop = s->io[i].res->end;
 603                                 s->ops->set_io_map(s, &iomap);
 604                                 s->io[i].Config++;
 605                         }
 606         }
 607
 608         c->state |= CONFIG_LOCKED;
 609         p_dev->_locked = 1;
 610         mutex_unlock(&s->ops_mutex);
 611         return 0;
 612 } /* pcmcia_enable_device */
 613 EXPORT_SYMBOL(pcmcia_enable_device);
 614
 615
 616 /**
 617  * pcmcia_request_io() - attempt to reserve port ranges for PCMCIA devices
 618  * @p_dev: the associated PCMCIA device
 619  *
 620  * pcmcia_request_io() attempts to reserve the IO port ranges specified in
 621  * &struct pcmcia_device @p_dev->resource[0] and @p_dev->resource[1]. The
 622  * "start" value is the requested start of the IO port resource; "end"
 623  * reflects the number of ports requested. The number of IO lines requested
 624  * is specified in &struct pcmcia_device @p_dev->io_lines.
 625  */
 626 int pcmcia_request_io(struct pcmcia_device *p_dev)
 627 {
 628         struct pcmcia_socket *s = p_dev->socket;
 629         config_t *c = p_dev->function_config;
 630         int ret = -EINVAL;
 631
 632         mutex_lock(&s->ops_mutex);
 633         dev_dbg(&p_dev->dev, "pcmcia_request_io: %pR , %pR",
 634                 &c->io[0], &c->io[1]);
 635
 636         if (!(s->state & SOCKET_PRESENT)) {
 637                 dev_dbg(&p_dev->dev, "pcmcia_request_io: No card present\n");
 638                 goto out;
 639         }
 640
 641         if (c->state & CONFIG_LOCKED) {
 642                 dev_dbg(&p_dev->dev, "Configuration is locked\n");
 643                 goto out;
 644         }
 645         if (c->state & CONFIG_IO_REQ) {
 646                 dev_dbg(&p_dev->dev, "IO already configured\n");
 647                 goto out;
 648         }
 649
 650         ret = alloc_io_space(s, &c->io[0], p_dev->io_lines);
 651         if (ret)
 652                 goto out;
 653
 654         if (c->io[1].end) {
 655                 ret = alloc_io_space(s, &c->io[1], p_dev->io_lines);
 656                 if (ret) {
 657                         struct resource tmp = c->io[0];
 658                         /* release the previously allocated resource */
 659                         release_io_space(s, &c->io[0]);
 660                         /* but preserve the settings, for they worked... */
 661                         c->io[0].end = resource_size(&tmp);
 662                         c->io[0].start = tmp.start;
 663                         c->io[0].flags = tmp.flags;
 664                         goto out;
 665                 }
 666         } else
 667                 c->io[1].start = 0;
 668
 669         c->state |= CONFIG_IO_REQ;
 670         p_dev->_io = 1;
 671
 672         dev_dbg(&p_dev->dev, "pcmcia_request_io succeeded: %pR , %pR",
 673                 &c->io[0], &c->io[1]);
 674 out:
 675         mutex_unlock(&s->ops_mutex);
 676
 677         return ret;
 678 } /* pcmcia_request_io */
 679 EXPORT_SYMBOL(pcmcia_request_io);
 680
 681
 682 /**
 683  * pcmcia_request_irq() - attempt to request a IRQ for a PCMCIA device
 684  * @p_dev: the associated PCMCIA device
 685  * @handler: IRQ handler to register
 686  *
 687  * pcmcia_request_irq() is a wrapper around request_irq() which allows
 688  * the PCMCIA core to clean up the registration in pcmcia_disable_device().
 689  * Drivers are free to use request_irq() directly, but then they need to
 690  * call free_irq() themselfves, too. Also, only %IRQF_SHARED capable IRQ
 691  * handlers are allowed.
 692  */
 693 int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
 694                                     irq_handler_t handler)
 695 {
 696         int ret;
 697
 698         if (!p_dev->irq)
 699                 return -EINVAL;
 700
 701         ret = request_irq(p_dev->irq, handler, IRQF_SHARED,
 702                         p_dev->devname, p_dev->priv);
 703         if (!ret)
 704                 p_dev->_irq = 1;
 705
 706         return ret;
 707 }
 708 EXPORT_SYMBOL(pcmcia_request_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[32];
 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  * @type:  IRQ type (flags)
 725  *
 726  * locking note: must be called with ops_mutex locked.
 727  */
 728 static int pcmcia_setup_isa_irq(struct pcmcia_device *p_dev, int type)
 729 {
 730         struct pcmcia_socket *s = p_dev->socket;
 731         unsigned int try, irq;
 732         u32 mask = s->irq_mask;
 733         int ret = -ENODEV;
 734
 735         for (try = 0; try < 64; try++) {
 736                 irq = try % 32;
 737
 738                 if (irq > NR_IRQS)
 739                         continue;
 740
 741                 /* marked as available by driver, not blocked by userspace? */
 742                 if (!((mask >> irq) & 1))
 743                         continue;
 744
 745                 /* avoid an IRQ which is already used by another PCMCIA card */
 746                 if ((try < 32) && pcmcia_used_irq[irq])
 747                         continue;
 748
 749                 /* register the correct driver, if possible, to check whether
 750                  * registering a dummy handle works, i.e. if the IRQ isn't
 751                  * marked as used by the kernel resource management core */
 752                 ret = request_irq(irq, test_action, type, p_dev->devname,
 753                                   p_dev);
 754                 if (!ret) {
 755                         free_irq(irq, p_dev);
 756                         p_dev->irq = s->pcmcia_irq = irq;
 757                         pcmcia_used_irq[irq]++;
 758                         break;
 759                 }
 760         }
 761
 762         return ret;
 763 }
 764
 765 void pcmcia_cleanup_irq(struct pcmcia_socket *s)
 766 {
 767         pcmcia_used_irq[s->pcmcia_irq]--;
 768         s->pcmcia_irq = 0;
 769 }
 770
 771 #else /* CONFIG_PCMCIA_PROBE */
 772
 773 static int pcmcia_setup_isa_irq(struct pcmcia_device *p_dev, int type)
 774 {
 775         return -EINVAL;
 776 }
 777
 778 void pcmcia_cleanup_irq(struct pcmcia_socket *s)
 779 {
 780         s->pcmcia_irq = 0;
 781         return;
 782 }
 783
 784 #endif  /* CONFIG_PCMCIA_PROBE */
 785
 786
 787 /**
 788  * pcmcia_setup_irq() - determine IRQ to be used for device
 789  * @p_dev: the associated PCMCIA device
 790  *
 791  * locking note: must be called with ops_mutex locked.
 792  */
 793 int pcmcia_setup_irq(struct pcmcia_device *p_dev)
 794 {
 795         struct pcmcia_socket *s = p_dev->socket;
 796
 797         if (p_dev->irq)
 798                 return 0;
 799
 800         /* already assigned? */
 801         if (s->pcmcia_irq) {
 802                 p_dev->irq = s->pcmcia_irq;
 803                 return 0;
 804         }
 805
 806         /* prefer an exclusive ISA irq */
 807         if (!pcmcia_setup_isa_irq(p_dev, 0))
 808                 return 0;
 809
 810         /* but accept a shared ISA irq */
 811         if (!pcmcia_setup_isa_irq(p_dev, IRQF_SHARED))
 812                 return 0;
 813
 814         /* but use the PCI irq otherwise */
 815         if (s->pci_irq) {
 816                 p_dev->irq = s->pcmcia_irq = s->pci_irq;
 817                 return 0;
 818         }
 819
 820         return -EINVAL;
 821 }
 822
 823
 824 /**
 825  * pcmcia_request_window() - attempt to reserve iomem for PCMCIA devices
 826  * @p_dev: the associated PCMCIA device
 827  * @res: &struct resource pointing to p_dev->resource[2..5]
 828  * @speed: access speed
 829  *
 830  * pcmcia_request_window() attepts to reserve an iomem ranges specified in
 831  * &struct resource @res pointing to one of the entries in
 832  * &struct pcmcia_device @p_dev->resource[2..5]. The "start" value is the
 833  * requested start of the IO mem resource; "end" reflects the size
 834  * requested.
 835  */
 836 int pcmcia_request_window(struct pcmcia_device *p_dev, struct resource *res,
 837                         unsigned int speed)
 838 {
 839         struct pcmcia_socket *s = p_dev->socket;
 840         pccard_mem_map *win;
 841         u_long align;
 842         int w;
 843
 844         dev_dbg(&p_dev->dev, "request_window %pR %d\n", res, speed);
 845
 846         if (!(s->state & SOCKET_PRESENT)) {
 847                 dev_dbg(&p_dev->dev, "No card present\n");
 848                 return -ENODEV;
 849         }
 850
 851         /* Window size defaults to smallest available */
 852         if (res->end == 0)
 853                 res->end = s->map_size;
 854         align = (s->features & SS_CAP_MEM_ALIGN) ? res->end : s->map_size;
 855         if (res->end & (s->map_size-1)) {
 856                 dev_dbg(&p_dev->dev, "invalid map size\n");
 857                 return -EINVAL;
 858         }
 859         if ((res->start && (s->features & SS_CAP_STATIC_MAP)) ||
 860             (res->start & (align-1))) {
 861                 dev_dbg(&p_dev->dev, "invalid base address\n");
 862                 return -EINVAL;
 863         }
 864         if (res->start)
 865                 align = 0;
 866
 867         /* Allocate system memory window */
 868         mutex_lock(&s->ops_mutex);
 869         for (w = 0; w < MAX_WIN; w++)
 870                 if (!(s->state & SOCKET_WIN_REQ(w)))
 871                         break;
 872         if (w == MAX_WIN) {
 873                 dev_dbg(&p_dev->dev, "all windows are used already\n");
 874                 mutex_unlock(&s->ops_mutex);
 875                 return -EINVAL;
 876         }
 877
 878         win = &s->win[w];
 879
 880         if (!(s->features & SS_CAP_STATIC_MAP)) {
 881                 win->res = pcmcia_find_mem_region(res->start, res->end, align,
 882                                                 0, s);
 883                 if (!win->res) {
 884                         dev_dbg(&p_dev->dev, "allocating mem region failed\n");
 885                         mutex_unlock(&s->ops_mutex);
 886                         return -EINVAL;
 887                 }
 888         }
 889         p_dev->_win |= CLIENT_WIN_REQ(w);
 890
 891         /* Configure the socket controller */
 892         win->map = w+1;
 893         win->flags = res->flags & WIN_FLAGS_MAP;
 894         win->speed = speed;
 895         win->card_start = 0;
 896
 897         if (s->ops->set_mem_map(s, win) != 0) {
 898                 dev_dbg(&p_dev->dev, "failed to set memory mapping\n");
 899                 mutex_unlock(&s->ops_mutex);
 900                 return -EIO;
 901         }
 902         s->state |= SOCKET_WIN_REQ(w);
 903
 904         /* Return window handle */
 905         if (s->features & SS_CAP_STATIC_MAP)
 906                 res->start = win->static_start;
 907         else
 908                 res->start = win->res->start;
 909
 910         /* convert to new-style resources */
 911         res->end += res->start - 1;
 912         res->flags &= ~WIN_FLAGS_REQ;
 913         res->flags |= (win->map << 2) | IORESOURCE_MEM;
 914         res->parent = win->res;
 915         if (win->res)
 916                 request_resource(&iomem_resource, res);
 917
 918         dev_dbg(&p_dev->dev, "request_window results in %pR\n", res);
 919
 920         mutex_unlock(&s->ops_mutex);
 921
 922         return 0;
 923 } /* pcmcia_request_window */
 924 EXPORT_SYMBOL(pcmcia_request_window);
 925
 926
 927 /**
 928  * pcmcia_disable_device() - disable and clean up a PCMCIA device
 929  * @p_dev: the associated PCMCIA device
 930  *
 931  * pcmcia_disable_device() is the driver-callable counterpart to
 932  * pcmcia_enable_device(): If a PCMCIA device is no longer used,
 933  * drivers are expected to clean up and disable the device by calling
 934  * this function. Any I/O ranges (iomem and ioports) will be released,
 935  * the Vpp voltage will be set to 0, and IRQs will no longer be
 936  * generated -- at least if there is no other card function (of
 937  * multifunction devices) being used.
 938  */
 939 void pcmcia_disable_device(struct pcmcia_device *p_dev)
 940 {
 941         int i;
 942
 943         dev_dbg(&p_dev->dev, "disabling device\n");
 944
 945         for (i = 0; i < MAX_WIN; i++) {
 946                 struct resource *res = p_dev->resource[MAX_IO_WIN + i];
 947                 if (res->flags & WIN_FLAGS_REQ)
 948                         pcmcia_release_window(p_dev, res);
 949         }
 950
 951         pcmcia_release_configuration(p_dev);
 952         pcmcia_release_io(p_dev);
 953         if (p_dev->_irq) {
 954                 free_irq(p_dev->irq, p_dev->priv);
 955                 p_dev->_irq = 0;
 956         }
 957 }
 958 EXPORT_SYMBOL(pcmcia_disable_device);