drivers/s390/cio/device_ops.c

   1 /*
   2  *  drivers/s390/cio/device_ops.c
   3  *
   4  *    Copyright (C) 2002 IBM Deutschland Entwicklung GmbH,
   5  *                       IBM Corporation
   6  *    Author(s): Martin Schwidefsky (schwidefsky@de.ibm.com)
   7  *               Cornelia Huck (cornelia.huck@de.ibm.com)
   8  */
   9 #include <linux/config.h>
  10 #include <linux/module.h>
  11 #include <linux/init.h>
  12 #include <linux/errno.h>
  13 #include <linux/slab.h>
  14 #include <linux/list.h>
  15 #include <linux/device.h>
  16 #include <linux/delay.h>
  17
  18 #include <asm/ccwdev.h>
  19 #include <asm/idals.h>
  20
  21 #include "cio.h"
  22 #include "cio_debug.h"
  23 #include "css.h"
  24 #include "chsc.h"
  25 #include "device.h"
  26
  27 int
  28 ccw_device_set_options(struct ccw_device *cdev, unsigned long flags)
  29 {
  30        /*
  31         * The flag usage is mutal exclusive ...
  32         */
  33         if ((flags & CCWDEV_EARLY_NOTIFICATION) &&
  34             (flags & CCWDEV_REPORT_ALL))
  35                 return -EINVAL;
  36         cdev->private->options.fast = (flags & CCWDEV_EARLY_NOTIFICATION) != 0;
  37         cdev->private->options.repall = (flags & CCWDEV_REPORT_ALL) != 0;
  38         cdev->private->options.pgroup = (flags & CCWDEV_DO_PATHGROUP) != 0;
  39         cdev->private->options.force = (flags & CCWDEV_ALLOW_FORCE) != 0;
  40         return 0;
  41 }
  42
  43 int
  44 ccw_device_clear(struct ccw_device *cdev, unsigned long intparm)
  45 {
  46         struct subchannel *sch;
  47         int ret;
  48
  49         if (!cdev)
  50                 return -ENODEV;
  51         if (cdev->private->state == DEV_STATE_NOT_OPER)
  52                 return -ENODEV;
  53         if (cdev->private->state != DEV_STATE_ONLINE &&
  54             cdev->private->state != DEV_STATE_WAIT4IO &&
  55             cdev->private->state != DEV_STATE_W4SENSE)
  56                 return -EINVAL;
  57         sch = to_subchannel(cdev->dev.parent);
  58         if (!sch)
  59                 return -ENODEV;
  60         ret = cio_clear(sch);
  61         if (ret == 0)
  62                 cdev->private->intparm = intparm;
  63         return ret;
  64 }
  65
  66 int
  67 ccw_device_start_key(struct ccw_device *cdev, struct ccw1 *cpa,
  68                      unsigned long intparm, __u8 lpm, __u8 key,
  69                      unsigned long flags)
  70 {
  71         struct subchannel *sch;
  72         int ret;
  73
  74         if (!cdev)
  75                 return -ENODEV;
  76         sch = to_subchannel(cdev->dev.parent);
  77         if (!sch)
  78                 return -ENODEV;
  79         if (cdev->private->state == DEV_STATE_NOT_OPER)
  80                 return -ENODEV;
  81         if (cdev->private->state == DEV_STATE_VERIFY) {
  82                 /* Remember to fake irb when finished. */
  83                 if (!cdev->private->flags.fake_irb) {
  84                         cdev->private->flags.fake_irb = 1;
  85                         cdev->private->intparm = intparm;
  86                         return 0;
  87                 } else
  88                         /* There's already a fake I/O around. */
  89                         return -EBUSY;
  90         }
  91         if (cdev->private->state != DEV_STATE_ONLINE ||
  92             ((sch->schib.scsw.stctl & SCSW_STCTL_PRIM_STATUS) &&
  93              !(sch->schib.scsw.stctl & SCSW_STCTL_SEC_STATUS)) ||
  94             cdev->private->flags.doverify)
  95                 return -EBUSY;
  96         ret = cio_set_options (sch, flags);
  97         if (ret)
  98                 return ret;
  99         ret = cio_start_key (sch, cpa, lpm, key);
 100         if (ret == 0)
 101                 cdev->private->intparm = intparm;
 102         return ret;
 103 }
 104
 105
 106 int
 107 ccw_device_start_timeout_key(struct ccw_device *cdev, struct ccw1 *cpa,
 108                              unsigned long intparm, __u8 lpm, __u8 key,
 109                              unsigned long flags, int expires)
 110 {
 111         int ret;
 112
 113         if (!cdev)
 114                 return -ENODEV;
 115         ccw_device_set_timeout(cdev, expires);
 116         ret = ccw_device_start_key(cdev, cpa, intparm, lpm, key, flags);
 117         if (ret != 0)
 118                 ccw_device_set_timeout(cdev, 0);
 119         return ret;
 120 }
 121
 122 int
 123 ccw_device_start(struct ccw_device *cdev, struct ccw1 *cpa,
 124                  unsigned long intparm, __u8 lpm, unsigned long flags)
 125 {
 126         return ccw_device_start_key(cdev, cpa, intparm, lpm,
 127                                     PAGE_DEFAULT_KEY, flags);
 128 }
 129
 130 int
 131 ccw_device_start_timeout(struct ccw_device *cdev, struct ccw1 *cpa,
 132                          unsigned long intparm, __u8 lpm, unsigned long flags,
 133                          int expires)
 134 {
 135         return ccw_device_start_timeout_key(cdev, cpa, intparm, lpm,
 136                                             PAGE_DEFAULT_KEY, flags,
 137                                             expires);
 138 }
 139
 140
 141 int
 142 ccw_device_halt(struct ccw_device *cdev, unsigned long intparm)
 143 {
 144         struct subchannel *sch;
 145         int ret;
 146
 147         if (!cdev)
 148                 return -ENODEV;
 149         if (cdev->private->state == DEV_STATE_NOT_OPER)
 150                 return -ENODEV;
 151         if (cdev->private->state != DEV_STATE_ONLINE &&
 152             cdev->private->state != DEV_STATE_WAIT4IO &&
 153             cdev->private->state != DEV_STATE_W4SENSE)
 154                 return -EINVAL;
 155         sch = to_subchannel(cdev->dev.parent);
 156         if (!sch)
 157                 return -ENODEV;
 158         ret = cio_halt(sch);
 159         if (ret == 0)
 160                 cdev->private->intparm = intparm;
 161         return ret;
 162 }
 163
 164 int
 165 ccw_device_resume(struct ccw_device *cdev)
 166 {
 167         struct subchannel *sch;
 168
 169         if (!cdev)
 170                 return -ENODEV;
 171         sch = to_subchannel(cdev->dev.parent);
 172         if (!sch)
 173                 return -ENODEV;
 174         if (cdev->private->state == DEV_STATE_NOT_OPER)
 175                 return -ENODEV;
 176         if (cdev->private->state != DEV_STATE_ONLINE ||
 177             !(sch->schib.scsw.actl & SCSW_ACTL_SUSPENDED))
 178                 return -EINVAL;
 179         return cio_resume(sch);
 180 }
 181
 182 /*
 183  * Pass interrupt to device driver.
 184  */
 185 int
 186 ccw_device_call_handler(struct ccw_device *cdev)
 187 {
 188         struct subchannel *sch;
 189         unsigned int stctl;
 190         int ending_status;
 191
 192         sch = to_subchannel(cdev->dev.parent);
 193
 194         /*
 195          * we allow for the device action handler if .
 196          *  - we received ending status
 197          *  - the action handler requested to see all interrupts
 198          *  - we received an intermediate status
 199          *  - fast notification was requested (primary status)
 200          *  - unsolicited interrupts
 201          */
 202         stctl = cdev->private->irb.scsw.stctl;
 203         ending_status = (stctl & SCSW_STCTL_SEC_STATUS) ||
 204                 (stctl == (SCSW_STCTL_ALERT_STATUS | SCSW_STCTL_STATUS_PEND)) ||
 205                 (stctl == SCSW_STCTL_STATUS_PEND);
 206         if (!ending_status &&
 207             !cdev->private->options.repall &&
 208             !(stctl & SCSW_STCTL_INTER_STATUS) &&
 209             !(cdev->private->options.fast &&
 210               (stctl & SCSW_STCTL_PRIM_STATUS)))
 211                 return 0;
 212
 213         /*
 214          * Now we are ready to call the device driver interrupt handler.
 215          */
 216         if (cdev->handler)
 217                 cdev->handler(cdev, cdev->private->intparm,
 218                               &cdev->private->irb);
 219
 220         /*
 221          * Clear the old and now useless interrupt response block.
 222          */
 223         memset(&cdev->private->irb, 0, sizeof(struct irb));
 224
 225         return 1;
 226 }
 227
 228 /*
 229  * Search for CIW command in extended sense data.
 230  */
 231 struct ciw *
 232 ccw_device_get_ciw(struct ccw_device *cdev, __u32 ct)
 233 {
 234         int ciw_cnt;
 235
 236         if (cdev->private->flags.esid == 0)
 237                 return NULL;
 238         for (ciw_cnt = 0; ciw_cnt < MAX_CIWS; ciw_cnt++)
 239                 if (cdev->private->senseid.ciw[ciw_cnt].ct == ct)
 240                         return cdev->private->senseid.ciw + ciw_cnt;
 241         return NULL;
 242 }
 243
 244 __u8
 245 ccw_device_get_path_mask(struct ccw_device *cdev)
 246 {
 247         struct subchannel *sch;
 248
 249         sch = to_subchannel(cdev->dev.parent);
 250         if (!sch)
 251                 return 0;
 252         else
 253                 return sch->vpm;
 254 }
 255
 256 static void
 257 ccw_device_wake_up(struct ccw_device *cdev, unsigned long ip, struct irb *irb)
 258 {
 259         if (!ip)
 260                 /* unsolicited interrupt */
 261                 return;
 262
 263         /* Abuse intparm for error reporting. */
 264         if (IS_ERR(irb))
 265                 cdev->private->intparm = -EIO;
 266         else if ((irb->scsw.dstat !=
 267                   (DEV_STAT_CHN_END|DEV_STAT_DEV_END)) ||
 268                  (irb->scsw.cstat != 0)) {
 269                 /*
 270                  * We didn't get channel end / device end. Check if path
 271                  * verification has been started; we can retry after it has
 272                  * finished. We also retry unit checks except for command reject
 273                  * or intervention required.
 274                  */
 275                  if (cdev->private->flags.doverify ||
 276                          cdev->private->state == DEV_STATE_VERIFY)
 277                          cdev->private->intparm = -EAGAIN;
 278                  if ((irb->scsw.dstat & DEV_STAT_UNIT_CHECK) &&
 279                      !(irb->ecw[0] &
 280                        (SNS0_CMD_REJECT | SNS0_INTERVENTION_REQ)))
 281                          cdev->private->intparm = -EAGAIN;
 282                  else
 283                          cdev->private->intparm = -EIO;
 284
 285         } else
 286                 cdev->private->intparm = 0;
 287         wake_up(&cdev->private->wait_q);
 288 }
 289
 290 static inline int
 291 __ccw_device_retry_loop(struct ccw_device *cdev, struct ccw1 *ccw, long magic, __u8 lpm)
 292 {
 293         int ret;
 294         struct subchannel *sch;
 295
 296         sch = to_subchannel(cdev->dev.parent);
 297         do {
 298                 ret = cio_start (sch, ccw, lpm);
 299                 if ((ret == -EBUSY) || (ret == -EACCES)) {
 300                         /* Try again later. */
 301                         spin_unlock_irq(&sch->lock);
 302                         msleep(10);
 303                         spin_lock_irq(&sch->lock);
 304                         continue;
 305                 }
 306                 if (ret != 0)
 307                         /* Non-retryable error. */
 308                         break;
 309                 /* Wait for end of request. */
 310                 cdev->private->intparm = magic;
 311                 spin_unlock_irq(&sch->lock);
 312                 wait_event(cdev->private->wait_q,
 313                            (cdev->private->intparm == -EIO) ||
 314                            (cdev->private->intparm == -EAGAIN) ||
 315                            (cdev->private->intparm == 0));
 316                 spin_lock_irq(&sch->lock);
 317                 /* Check at least for channel end / device end */
 318                 if (cdev->private->intparm == -EIO) {
 319                         /* Non-retryable error. */
 320                         ret = -EIO;
 321                         break;
 322                 }
 323                 if (cdev->private->intparm == 0)
 324                         /* Success. */
 325                         break;
 326                 /* Try again later. */
 327                 spin_unlock_irq(&sch->lock);
 328                 msleep(10);
 329                 spin_lock_irq(&sch->lock);
 330         } while (1);
 331
 332         return ret;
 333 }
 334
 335 /**
 336  * read_dev_chars() - read device characteristics
 337  * @param cdev   target ccw device
 338  * @param buffer pointer to buffer for rdc data
 339  * @param length size of rdc data
 340  * @returns 0 for success, negative error value on failure
 341  *
 342  * Context:
 343  *   called for online device, lock not held
 344  **/
 345 int
 346 read_dev_chars (struct ccw_device *cdev, void **buffer, int length)
 347 {
 348         void (*handler)(struct ccw_device *, unsigned long, struct irb *);
 349         struct subchannel *sch;
 350         int ret;
 351         struct ccw1 *rdc_ccw;
 352
 353         if (!cdev)
 354                 return -ENODEV;
 355         if (!buffer || !length)
 356                 return -EINVAL;
 357         sch = to_subchannel(cdev->dev.parent);
 358
 359         CIO_TRACE_EVENT (4, "rddevch");
 360         CIO_TRACE_EVENT (4, sch->dev.bus_id);
 361
 362         rdc_ccw = kmalloc(sizeof(struct ccw1), GFP_KERNEL | GFP_DMA);
 363         if (!rdc_ccw)
 364                 return -ENOMEM;
 365         memset(rdc_ccw, 0, sizeof(struct ccw1));
 366         rdc_ccw->cmd_code = CCW_CMD_RDC;
 367         rdc_ccw->count = length;
 368         rdc_ccw->flags = CCW_FLAG_SLI;
 369         ret = set_normalized_cda (rdc_ccw, (*buffer));
 370         if (ret != 0) {
 371                 kfree(rdc_ccw);
 372                 return ret;
 373         }
 374
 375         spin_lock_irq(&sch->lock);
 376         /* Save interrupt handler. */
 377         handler = cdev->handler;
 378         /* Temporarily install own handler. */
 379         cdev->handler = ccw_device_wake_up;
 380         if (cdev->private->state != DEV_STATE_ONLINE)
 381                 ret = -ENODEV;
 382         else if (((sch->schib.scsw.stctl & SCSW_STCTL_PRIM_STATUS) &&
 383                   !(sch->schib.scsw.stctl & SCSW_STCTL_SEC_STATUS)) ||
 384                  cdev->private->flags.doverify)
 385                 ret = -EBUSY;
 386         else
 387                 /* 0x00D9C4C3 == ebcdic "RDC" */
 388                 ret = __ccw_device_retry_loop(cdev, rdc_ccw, 0x00D9C4C3, 0);
 389
 390         /* Restore interrupt handler. */
 391         cdev->handler = handler;
 392         spin_unlock_irq(&sch->lock);
 393
 394         clear_normalized_cda (rdc_ccw);
 395         kfree(rdc_ccw);
 396
 397         return ret;
 398 }
 399
 400 /*
 401  *  Read Configuration data using path mask
 402  */
 403 int
 404 read_conf_data_lpm (struct ccw_device *cdev, void **buffer, int *length, __u8 lpm)
 405 {
 406         void (*handler)(struct ccw_device *, unsigned long, struct irb *);
 407         struct subchannel *sch;
 408         struct ciw *ciw;
 409         char *rcd_buf;
 410         int ret;
 411         struct ccw1 *rcd_ccw;
 412
 413         if (!cdev)
 414                 return -ENODEV;
 415         if (!buffer || !length)
 416                 return -EINVAL;
 417         sch = to_subchannel(cdev->dev.parent);
 418
 419         CIO_TRACE_EVENT (4, "rdconf");
 420         CIO_TRACE_EVENT (4, sch->dev.bus_id);
 421
 422         /*
 423          * scan for RCD command in extended SenseID data
 424          */
 425         ciw = ccw_device_get_ciw(cdev, CIW_TYPE_RCD);
 426         if (!ciw || ciw->cmd == 0)
 427                 return -EOPNOTSUPP;
 428
 429         rcd_ccw = kmalloc(sizeof(struct ccw1), GFP_KERNEL | GFP_DMA);
 430         if (!rcd_ccw)
 431                 return -ENOMEM;
 432         memset(rcd_ccw, 0, sizeof(struct ccw1));
 433         rcd_buf = kmalloc(ciw->count, GFP_KERNEL | GFP_DMA);
 434         if (!rcd_buf) {
 435                 kfree(rcd_ccw);
 436                 return -ENOMEM;
 437         }
 438         memset (rcd_buf, 0, ciw->count);
 439         rcd_ccw->cmd_code = ciw->cmd;
 440         rcd_ccw->cda = (__u32) __pa (rcd_buf);
 441         rcd_ccw->count = ciw->count;
 442         rcd_ccw->flags = CCW_FLAG_SLI;
 443
 444         spin_lock_irq(&sch->lock);
 445         /* Save interrupt handler. */
 446         handler = cdev->handler;
 447         /* Temporarily install own handler. */
 448         cdev->handler = ccw_device_wake_up;
 449         if (cdev->private->state != DEV_STATE_ONLINE)
 450                 ret = -ENODEV;
 451         else if (((sch->schib.scsw.stctl & SCSW_STCTL_PRIM_STATUS) &&
 452                   !(sch->schib.scsw.stctl & SCSW_STCTL_SEC_STATUS)) ||
 453                  cdev->private->flags.doverify)
 454                 ret = -EBUSY;
 455         else
 456                 /* 0x00D9C3C4 == ebcdic "RCD" */
 457                 ret = __ccw_device_retry_loop(cdev, rcd_ccw, 0x00D9C3C4, lpm);
 458
 459         /* Restore interrupt handler. */
 460         cdev->handler = handler;
 461         spin_unlock_irq(&sch->lock);
 462
 463         /*
 464          * on success we update the user input parms
 465          */
 466         if (ret) {
 467                 kfree (rcd_buf);
 468                 *buffer = NULL;
 469                 *length = 0;
 470         } else {
 471                 *length = ciw->count;
 472                 *buffer = rcd_buf;
 473         }
 474         kfree(rcd_ccw);
 475
 476         return ret;
 477 }
 478
 479 /*
 480  *  Read Configuration data
 481  */
 482 int
 483 read_conf_data (struct ccw_device *cdev, void **buffer, int *length)
 484 {
 485         return read_conf_data_lpm (cdev, buffer, length, 0);
 486 }
 487
 488 /*
 489  * Try to break the lock on a boxed device.
 490  */
 491 int
 492 ccw_device_stlck(struct ccw_device *cdev)
 493 {
 494         void *buf, *buf2;
 495         unsigned long flags;
 496         struct subchannel *sch;
 497         int ret;
 498
 499         if (!cdev)
 500                 return -ENODEV;
 501
 502         if (cdev->drv && !cdev->private->options.force)
 503                 return -EINVAL;
 504
 505         sch = to_subchannel(cdev->dev.parent);
 506
 507         CIO_TRACE_EVENT(2, "stl lock");
 508         CIO_TRACE_EVENT(2, cdev->dev.bus_id);
 509
 510         buf = kmalloc(32*sizeof(char), GFP_DMA|GFP_KERNEL);
 511         if (!buf)
 512                 return -ENOMEM;
 513         buf2 = kmalloc(32*sizeof(char), GFP_DMA|GFP_KERNEL);
 514         if (!buf2) {
 515                 kfree(buf);
 516                 return -ENOMEM;
 517         }
 518         spin_lock_irqsave(&sch->lock, flags);
 519         ret = cio_enable_subchannel(sch, 3);
 520         if (ret)
 521                 goto out_unlock;
 522         /*
 523          * Setup ccw. We chain an unconditional reserve and a release so we
 524          * only break the lock.
 525          */
 526         cdev->private->iccws[0].cmd_code = CCW_CMD_STLCK;
 527         cdev->private->iccws[0].cda = (__u32) __pa(buf);
 528         cdev->private->iccws[0].count = 32;
 529         cdev->private->iccws[0].flags = CCW_FLAG_CC;
 530         cdev->private->iccws[1].cmd_code = CCW_CMD_RELEASE;
 531         cdev->private->iccws[1].cda = (__u32) __pa(buf2);
 532         cdev->private->iccws[1].count = 32;
 533         cdev->private->iccws[1].flags = 0;
 534         ret = cio_start(sch, cdev->private->iccws, 0);
 535         if (ret) {
 536                 cio_disable_subchannel(sch); //FIXME: return code?
 537                 goto out_unlock;
 538         }
 539         cdev->private->irb.scsw.actl |= SCSW_ACTL_START_PEND;
 540         spin_unlock_irqrestore(&sch->lock, flags);
 541         wait_event(cdev->private->wait_q, cdev->private->irb.scsw.actl == 0);
 542         spin_lock_irqsave(&sch->lock, flags);
 543         cio_disable_subchannel(sch); //FIXME: return code?
 544         if ((cdev->private->irb.scsw.dstat !=
 545              (DEV_STAT_CHN_END|DEV_STAT_DEV_END)) ||
 546             (cdev->private->irb.scsw.cstat != 0))
 547                 ret = -EIO;
 548         /* Clear irb. */
 549         memset(&cdev->private->irb, 0, sizeof(struct irb));
 550 out_unlock:
 551         kfree(buf);
 552         kfree(buf2);
 553         spin_unlock_irqrestore(&sch->lock, flags);
 554         return ret;
 555 }
 556
 557 void *
 558 ccw_device_get_chp_desc(struct ccw_device *cdev, int chp_no)
 559 {
 560         struct subchannel *sch;
 561
 562         sch = to_subchannel(cdev->dev.parent);
 563         return chsc_get_chp_desc(sch, chp_no);
 564 }
 565
 566 // FIXME: these have to go:
 567
 568 int
 569 _ccw_device_get_subchannel_number(struct ccw_device *cdev)
 570 {
 571         return cdev->private->sch_no;
 572 }
 573
 574 int
 575 _ccw_device_get_device_number(struct ccw_device *cdev)
 576 {
 577         return cdev->private->devno;
 578 }
 579
 580
 581 MODULE_LICENSE("GPL");
 582 EXPORT_SYMBOL(ccw_device_set_options);
 583 EXPORT_SYMBOL(ccw_device_clear);
 584 EXPORT_SYMBOL(ccw_device_halt);
 585 EXPORT_SYMBOL(ccw_device_resume);
 586 EXPORT_SYMBOL(ccw_device_start_timeout);
 587 EXPORT_SYMBOL(ccw_device_start);
 588 EXPORT_SYMBOL(ccw_device_start_timeout_key);
 589 EXPORT_SYMBOL(ccw_device_start_key);
 590 EXPORT_SYMBOL(ccw_device_get_ciw);
 591 EXPORT_SYMBOL(ccw_device_get_path_mask);
 592 EXPORT_SYMBOL(read_conf_data);
 593 EXPORT_SYMBOL(read_dev_chars);
 594 EXPORT_SYMBOL(_ccw_device_get_subchannel_number);
 595 EXPORT_SYMBOL(_ccw_device_get_device_number);
 596 EXPORT_SYMBOL_GPL(ccw_device_get_chp_desc);
 597 EXPORT_SYMBOL_GPL(read_conf_data_lpm);