2 * drivers/s390/cio/device_ops.c
4 * Copyright (C) 2002 IBM Deutschland Entwicklung GmbH,
6 * Author(s): Martin Schwidefsky (schwidefsky@de.ibm.com)
7 * Cornelia Huck (cornelia.huck@de.ibm.com)
9 #include <linux/module.h>
10 #include <linux/init.h>
11 #include <linux/errno.h>
12 #include <linux/slab.h>
13 #include <linux/list.h>
14 #include <linux/device.h>
15 #include <linux/delay.h>
17 #include <asm/ccwdev.h>
18 #include <asm/idals.h>
21 #include "cio_debug.h"
27 ccw_device_set_options(struct ccw_device *cdev, unsigned long flags)
30 * The flag usage is mutal exclusive ...
32 if ((flags & CCWDEV_EARLY_NOTIFICATION) &&
33 (flags & CCWDEV_REPORT_ALL))
35 cdev->private->options.fast = (flags & CCWDEV_EARLY_NOTIFICATION) != 0;
36 cdev->private->options.repall = (flags & CCWDEV_REPORT_ALL) != 0;
37 cdev->private->options.pgroup = (flags & CCWDEV_DO_PATHGROUP) != 0;
38 cdev->private->options.force = (flags & CCWDEV_ALLOW_FORCE) != 0;
43 ccw_device_clear(struct ccw_device *cdev, unsigned long intparm)
45 struct subchannel *sch;
50 if (cdev->private->state == DEV_STATE_NOT_OPER)
52 if (cdev->private->state != DEV_STATE_ONLINE &&
53 cdev->private->state != DEV_STATE_WAIT4IO &&
54 cdev->private->state != DEV_STATE_W4SENSE)
56 sch = to_subchannel(cdev->dev.parent);
61 cdev->private->intparm = intparm;
66 ccw_device_start_key(struct ccw_device *cdev, struct ccw1 *cpa,
67 unsigned long intparm, __u8 lpm, __u8 key,
70 struct subchannel *sch;
75 sch = to_subchannel(cdev->dev.parent);
78 if (cdev->private->state == DEV_STATE_NOT_OPER)
80 if (cdev->private->state == DEV_STATE_VERIFY ||
81 cdev->private->state == DEV_STATE_CLEAR_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;
88 /* There's already a fake I/O around. */
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)
96 ret = cio_set_options (sch, flags);
99 /* Adjust requested path mask to excluded varied off paths. */
105 ret = cio_start_key (sch, cpa, lpm, key);
107 cdev->private->intparm = intparm;
113 ccw_device_start_timeout_key(struct ccw_device *cdev, struct ccw1 *cpa,
114 unsigned long intparm, __u8 lpm, __u8 key,
115 unsigned long flags, int expires)
121 ccw_device_set_timeout(cdev, expires);
122 ret = ccw_device_start_key(cdev, cpa, intparm, lpm, key, flags);
124 ccw_device_set_timeout(cdev, 0);
129 ccw_device_start(struct ccw_device *cdev, struct ccw1 *cpa,
130 unsigned long intparm, __u8 lpm, unsigned long flags)
132 return ccw_device_start_key(cdev, cpa, intparm, lpm,
133 PAGE_DEFAULT_KEY, flags);
137 ccw_device_start_timeout(struct ccw_device *cdev, struct ccw1 *cpa,
138 unsigned long intparm, __u8 lpm, unsigned long flags,
141 return ccw_device_start_timeout_key(cdev, cpa, intparm, lpm,
142 PAGE_DEFAULT_KEY, flags,
148 ccw_device_halt(struct ccw_device *cdev, unsigned long intparm)
150 struct subchannel *sch;
155 if (cdev->private->state == DEV_STATE_NOT_OPER)
157 if (cdev->private->state != DEV_STATE_ONLINE &&
158 cdev->private->state != DEV_STATE_WAIT4IO &&
159 cdev->private->state != DEV_STATE_W4SENSE)
161 sch = to_subchannel(cdev->dev.parent);
166 cdev->private->intparm = intparm;
171 ccw_device_resume(struct ccw_device *cdev)
173 struct subchannel *sch;
177 sch = to_subchannel(cdev->dev.parent);
180 if (cdev->private->state == DEV_STATE_NOT_OPER)
182 if (cdev->private->state != DEV_STATE_ONLINE ||
183 !(sch->schib.scsw.actl & SCSW_ACTL_SUSPENDED))
185 return cio_resume(sch);
189 * Pass interrupt to device driver.
192 ccw_device_call_handler(struct ccw_device *cdev)
194 struct subchannel *sch;
198 sch = to_subchannel(cdev->dev.parent);
201 * we allow for the device action handler if .
202 * - we received ending status
203 * - the action handler requested to see all interrupts
204 * - we received an intermediate status
205 * - fast notification was requested (primary status)
206 * - unsolicited interrupts
208 stctl = cdev->private->irb.scsw.stctl;
209 ending_status = (stctl & SCSW_STCTL_SEC_STATUS) ||
210 (stctl == (SCSW_STCTL_ALERT_STATUS | SCSW_STCTL_STATUS_PEND)) ||
211 (stctl == SCSW_STCTL_STATUS_PEND);
212 if (!ending_status &&
213 !cdev->private->options.repall &&
214 !(stctl & SCSW_STCTL_INTER_STATUS) &&
215 !(cdev->private->options.fast &&
216 (stctl & SCSW_STCTL_PRIM_STATUS)))
219 /* Clear pending timers for device driver initiated I/O. */
221 ccw_device_set_timeout(cdev, 0);
223 * Now we are ready to call the device driver interrupt handler.
226 cdev->handler(cdev, cdev->private->intparm,
227 &cdev->private->irb);
230 * Clear the old and now useless interrupt response block.
232 memset(&cdev->private->irb, 0, sizeof(struct irb));
238 * Search for CIW command in extended sense data.
241 ccw_device_get_ciw(struct ccw_device *cdev, __u32 ct)
245 if (cdev->private->flags.esid == 0)
247 for (ciw_cnt = 0; ciw_cnt < MAX_CIWS; ciw_cnt++)
248 if (cdev->private->senseid.ciw[ciw_cnt].ct == ct)
249 return cdev->private->senseid.ciw + ciw_cnt;
254 ccw_device_get_path_mask(struct ccw_device *cdev)
256 struct subchannel *sch;
258 sch = to_subchannel(cdev->dev.parent);
266 ccw_device_wake_up(struct ccw_device *cdev, unsigned long ip, struct irb *irb)
269 /* unsolicited interrupt */
272 /* Abuse intparm for error reporting. */
274 cdev->private->intparm = -EIO;
275 else if (irb->scsw.cc == 1)
276 /* Retry for deferred condition code. */
277 cdev->private->intparm = -EAGAIN;
278 else if ((irb->scsw.dstat !=
279 (DEV_STAT_CHN_END|DEV_STAT_DEV_END)) ||
280 (irb->scsw.cstat != 0)) {
282 * We didn't get channel end / device end. Check if path
283 * verification has been started; we can retry after it has
284 * finished. We also retry unit checks except for command reject
285 * or intervention required. Also check for long busy
288 if (cdev->private->flags.doverify ||
289 cdev->private->state == DEV_STATE_VERIFY)
290 cdev->private->intparm = -EAGAIN;
291 else if ((irb->scsw.dstat & DEV_STAT_UNIT_CHECK) &&
293 (SNS0_CMD_REJECT | SNS0_INTERVENTION_REQ)))
294 cdev->private->intparm = -EAGAIN;
295 else if ((irb->scsw.dstat & DEV_STAT_ATTENTION) &&
296 (irb->scsw.dstat & DEV_STAT_DEV_END) &&
297 (irb->scsw.dstat & DEV_STAT_UNIT_EXCEP))
298 cdev->private->intparm = -EAGAIN;
300 cdev->private->intparm = -EIO;
303 cdev->private->intparm = 0;
304 wake_up(&cdev->private->wait_q);
308 __ccw_device_retry_loop(struct ccw_device *cdev, struct ccw1 *ccw, long magic, __u8 lpm)
311 struct subchannel *sch;
313 sch = to_subchannel(cdev->dev.parent);
315 ccw_device_set_timeout(cdev, 60 * HZ);
316 ret = cio_start (sch, ccw, lpm);
318 ccw_device_set_timeout(cdev, 0);
320 /* Try again later. */
321 spin_unlock_irq(&sch->lock);
323 spin_lock_irq(&sch->lock);
327 /* Non-retryable error. */
329 /* Wait for end of request. */
330 cdev->private->intparm = magic;
331 spin_unlock_irq(&sch->lock);
332 wait_event(cdev->private->wait_q,
333 (cdev->private->intparm == -EIO) ||
334 (cdev->private->intparm == -EAGAIN) ||
335 (cdev->private->intparm == 0));
336 spin_lock_irq(&sch->lock);
337 /* Check at least for channel end / device end */
338 if (cdev->private->intparm == -EIO) {
339 /* Non-retryable error. */
343 if (cdev->private->intparm == 0)
346 /* Try again later. */
347 spin_unlock_irq(&sch->lock);
349 spin_lock_irq(&sch->lock);
356 * read_dev_chars() - read device characteristics
357 * @param cdev target ccw device
358 * @param buffer pointer to buffer for rdc data
359 * @param length size of rdc data
360 * @returns 0 for success, negative error value on failure
363 * called for online device, lock not held
366 read_dev_chars (struct ccw_device *cdev, void **buffer, int length)
368 void (*handler)(struct ccw_device *, unsigned long, struct irb *);
369 struct subchannel *sch;
371 struct ccw1 *rdc_ccw;
375 if (!buffer || !length)
377 sch = to_subchannel(cdev->dev.parent);
379 CIO_TRACE_EVENT (4, "rddevch");
380 CIO_TRACE_EVENT (4, sch->dev.bus_id);
382 rdc_ccw = kzalloc(sizeof(struct ccw1), GFP_KERNEL | GFP_DMA);
385 rdc_ccw->cmd_code = CCW_CMD_RDC;
386 rdc_ccw->count = length;
387 rdc_ccw->flags = CCW_FLAG_SLI;
388 ret = set_normalized_cda (rdc_ccw, (*buffer));
394 spin_lock_irq(&sch->lock);
395 /* Save interrupt handler. */
396 handler = cdev->handler;
397 /* Temporarily install own handler. */
398 cdev->handler = ccw_device_wake_up;
399 if (cdev->private->state != DEV_STATE_ONLINE)
401 else if (((sch->schib.scsw.stctl & SCSW_STCTL_PRIM_STATUS) &&
402 !(sch->schib.scsw.stctl & SCSW_STCTL_SEC_STATUS)) ||
403 cdev->private->flags.doverify)
406 /* 0x00D9C4C3 == ebcdic "RDC" */
407 ret = __ccw_device_retry_loop(cdev, rdc_ccw, 0x00D9C4C3, 0);
409 /* Restore interrupt handler. */
410 cdev->handler = handler;
411 spin_unlock_irq(&sch->lock);
413 clear_normalized_cda (rdc_ccw);
420 * Read Configuration data using path mask
423 read_conf_data_lpm (struct ccw_device *cdev, void **buffer, int *length, __u8 lpm)
425 void (*handler)(struct ccw_device *, unsigned long, struct irb *);
426 struct subchannel *sch;
430 struct ccw1 *rcd_ccw;
434 if (!buffer || !length)
436 sch = to_subchannel(cdev->dev.parent);
438 CIO_TRACE_EVENT (4, "rdconf");
439 CIO_TRACE_EVENT (4, sch->dev.bus_id);
442 * scan for RCD command in extended SenseID data
444 ciw = ccw_device_get_ciw(cdev, CIW_TYPE_RCD);
445 if (!ciw || ciw->cmd == 0)
448 /* Adjust requested path mask to excluded varied off paths. */
455 rcd_ccw = kzalloc(sizeof(struct ccw1), GFP_KERNEL | GFP_DMA);
458 rcd_buf = kzalloc(ciw->count, GFP_KERNEL | GFP_DMA);
463 rcd_ccw->cmd_code = ciw->cmd;
464 rcd_ccw->cda = (__u32) __pa (rcd_buf);
465 rcd_ccw->count = ciw->count;
466 rcd_ccw->flags = CCW_FLAG_SLI;
468 spin_lock_irq(&sch->lock);
469 /* Save interrupt handler. */
470 handler = cdev->handler;
471 /* Temporarily install own handler. */
472 cdev->handler = ccw_device_wake_up;
473 if (cdev->private->state != DEV_STATE_ONLINE)
475 else if (((sch->schib.scsw.stctl & SCSW_STCTL_PRIM_STATUS) &&
476 !(sch->schib.scsw.stctl & SCSW_STCTL_SEC_STATUS)) ||
477 cdev->private->flags.doverify)
480 /* 0x00D9C3C4 == ebcdic "RCD" */
481 ret = __ccw_device_retry_loop(cdev, rcd_ccw, 0x00D9C3C4, lpm);
483 /* Restore interrupt handler. */
484 cdev->handler = handler;
485 spin_unlock_irq(&sch->lock);
488 * on success we update the user input parms
495 *length = ciw->count;
504 * Read Configuration data
507 read_conf_data (struct ccw_device *cdev, void **buffer, int *length)
509 return read_conf_data_lpm (cdev, buffer, length, 0);
513 * Try to break the lock on a boxed device.
516 ccw_device_stlck(struct ccw_device *cdev)
520 struct subchannel *sch;
526 if (cdev->drv && !cdev->private->options.force)
529 sch = to_subchannel(cdev->dev.parent);
531 CIO_TRACE_EVENT(2, "stl lock");
532 CIO_TRACE_EVENT(2, cdev->dev.bus_id);
534 buf = kmalloc(32*sizeof(char), GFP_DMA|GFP_KERNEL);
537 buf2 = kmalloc(32*sizeof(char), GFP_DMA|GFP_KERNEL);
542 spin_lock_irqsave(&sch->lock, flags);
543 ret = cio_enable_subchannel(sch, 3);
547 * Setup ccw. We chain an unconditional reserve and a release so we
548 * only break the lock.
550 cdev->private->iccws[0].cmd_code = CCW_CMD_STLCK;
551 cdev->private->iccws[0].cda = (__u32) __pa(buf);
552 cdev->private->iccws[0].count = 32;
553 cdev->private->iccws[0].flags = CCW_FLAG_CC;
554 cdev->private->iccws[1].cmd_code = CCW_CMD_RELEASE;
555 cdev->private->iccws[1].cda = (__u32) __pa(buf2);
556 cdev->private->iccws[1].count = 32;
557 cdev->private->iccws[1].flags = 0;
558 ret = cio_start(sch, cdev->private->iccws, 0);
560 cio_disable_subchannel(sch); //FIXME: return code?
563 cdev->private->irb.scsw.actl |= SCSW_ACTL_START_PEND;
564 spin_unlock_irqrestore(&sch->lock, flags);
565 wait_event(cdev->private->wait_q, cdev->private->irb.scsw.actl == 0);
566 spin_lock_irqsave(&sch->lock, flags);
567 cio_disable_subchannel(sch); //FIXME: return code?
568 if ((cdev->private->irb.scsw.dstat !=
569 (DEV_STAT_CHN_END|DEV_STAT_DEV_END)) ||
570 (cdev->private->irb.scsw.cstat != 0))
573 memset(&cdev->private->irb, 0, sizeof(struct irb));
577 spin_unlock_irqrestore(&sch->lock, flags);
582 ccw_device_get_chp_desc(struct ccw_device *cdev, int chp_no)
584 struct subchannel *sch;
586 sch = to_subchannel(cdev->dev.parent);
587 return chsc_get_chp_desc(sch, chp_no);
590 // FIXME: these have to go:
593 _ccw_device_get_subchannel_number(struct ccw_device *cdev)
595 return cdev->private->sch_no;
599 _ccw_device_get_device_number(struct ccw_device *cdev)
601 return cdev->private->devno;
605 MODULE_LICENSE("GPL");
606 EXPORT_SYMBOL(ccw_device_set_options);
607 EXPORT_SYMBOL(ccw_device_clear);
608 EXPORT_SYMBOL(ccw_device_halt);
609 EXPORT_SYMBOL(ccw_device_resume);
610 EXPORT_SYMBOL(ccw_device_start_timeout);
611 EXPORT_SYMBOL(ccw_device_start);
612 EXPORT_SYMBOL(ccw_device_start_timeout_key);
613 EXPORT_SYMBOL(ccw_device_start_key);
614 EXPORT_SYMBOL(ccw_device_get_ciw);
615 EXPORT_SYMBOL(ccw_device_get_path_mask);
616 EXPORT_SYMBOL(read_conf_data);
617 EXPORT_SYMBOL(read_dev_chars);
618 EXPORT_SYMBOL(_ccw_device_get_subchannel_number);
619 EXPORT_SYMBOL(_ccw_device_get_device_number);
620 EXPORT_SYMBOL_GPL(ccw_device_get_chp_desc);
621 EXPORT_SYMBOL_GPL(read_conf_data_lpm);