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)))
220 * Now we are ready to call the device driver interrupt handler.
223 cdev->handler(cdev, cdev->private->intparm,
224 &cdev->private->irb);
227 * Clear the old and now useless interrupt response block.
229 memset(&cdev->private->irb, 0, sizeof(struct irb));
235 * Search for CIW command in extended sense data.
238 ccw_device_get_ciw(struct ccw_device *cdev, __u32 ct)
242 if (cdev->private->flags.esid == 0)
244 for (ciw_cnt = 0; ciw_cnt < MAX_CIWS; ciw_cnt++)
245 if (cdev->private->senseid.ciw[ciw_cnt].ct == ct)
246 return cdev->private->senseid.ciw + ciw_cnt;
251 ccw_device_get_path_mask(struct ccw_device *cdev)
253 struct subchannel *sch;
255 sch = to_subchannel(cdev->dev.parent);
263 ccw_device_wake_up(struct ccw_device *cdev, unsigned long ip, struct irb *irb)
266 /* unsolicited interrupt */
269 /* Abuse intparm for error reporting. */
271 cdev->private->intparm = -EIO;
272 else if (irb->scsw.cc == 1)
273 /* Retry for deferred condition code. */
274 cdev->private->intparm = -EAGAIN;
275 else if ((irb->scsw.dstat !=
276 (DEV_STAT_CHN_END|DEV_STAT_DEV_END)) ||
277 (irb->scsw.cstat != 0)) {
279 * We didn't get channel end / device end. Check if path
280 * verification has been started; we can retry after it has
281 * finished. We also retry unit checks except for command reject
282 * or intervention required. Also check for long busy
285 if (cdev->private->flags.doverify ||
286 cdev->private->state == DEV_STATE_VERIFY)
287 cdev->private->intparm = -EAGAIN;
288 if ((irb->scsw.dstat & DEV_STAT_UNIT_CHECK) &&
290 (SNS0_CMD_REJECT | SNS0_INTERVENTION_REQ)))
291 cdev->private->intparm = -EAGAIN;
292 else if ((irb->scsw.dstat & DEV_STAT_ATTENTION) &&
293 (irb->scsw.dstat & DEV_STAT_DEV_END) &&
294 (irb->scsw.dstat & DEV_STAT_UNIT_EXCEP))
295 cdev->private->intparm = -EAGAIN;
297 cdev->private->intparm = -EIO;
300 cdev->private->intparm = 0;
301 wake_up(&cdev->private->wait_q);
305 __ccw_device_retry_loop(struct ccw_device *cdev, struct ccw1 *ccw, long magic, __u8 lpm)
308 struct subchannel *sch;
310 sch = to_subchannel(cdev->dev.parent);
312 ret = cio_start (sch, ccw, lpm);
314 /* Try again later. */
315 spin_unlock_irq(&sch->lock);
317 spin_lock_irq(&sch->lock);
321 /* Non-retryable error. */
323 /* Wait for end of request. */
324 cdev->private->intparm = magic;
325 spin_unlock_irq(&sch->lock);
326 wait_event(cdev->private->wait_q,
327 (cdev->private->intparm == -EIO) ||
328 (cdev->private->intparm == -EAGAIN) ||
329 (cdev->private->intparm == 0));
330 spin_lock_irq(&sch->lock);
331 /* Check at least for channel end / device end */
332 if (cdev->private->intparm == -EIO) {
333 /* Non-retryable error. */
337 if (cdev->private->intparm == 0)
340 /* Try again later. */
341 spin_unlock_irq(&sch->lock);
343 spin_lock_irq(&sch->lock);
350 * read_dev_chars() - read device characteristics
351 * @param cdev target ccw device
352 * @param buffer pointer to buffer for rdc data
353 * @param length size of rdc data
354 * @returns 0 for success, negative error value on failure
357 * called for online device, lock not held
360 read_dev_chars (struct ccw_device *cdev, void **buffer, int length)
362 void (*handler)(struct ccw_device *, unsigned long, struct irb *);
363 struct subchannel *sch;
365 struct ccw1 *rdc_ccw;
369 if (!buffer || !length)
371 sch = to_subchannel(cdev->dev.parent);
373 CIO_TRACE_EVENT (4, "rddevch");
374 CIO_TRACE_EVENT (4, sch->dev.bus_id);
376 rdc_ccw = kzalloc(sizeof(struct ccw1), GFP_KERNEL | GFP_DMA);
379 rdc_ccw->cmd_code = CCW_CMD_RDC;
380 rdc_ccw->count = length;
381 rdc_ccw->flags = CCW_FLAG_SLI;
382 ret = set_normalized_cda (rdc_ccw, (*buffer));
388 spin_lock_irq(&sch->lock);
389 /* Save interrupt handler. */
390 handler = cdev->handler;
391 /* Temporarily install own handler. */
392 cdev->handler = ccw_device_wake_up;
393 if (cdev->private->state != DEV_STATE_ONLINE)
395 else if (((sch->schib.scsw.stctl & SCSW_STCTL_PRIM_STATUS) &&
396 !(sch->schib.scsw.stctl & SCSW_STCTL_SEC_STATUS)) ||
397 cdev->private->flags.doverify)
400 /* 0x00D9C4C3 == ebcdic "RDC" */
401 ret = __ccw_device_retry_loop(cdev, rdc_ccw, 0x00D9C4C3, 0);
403 /* Restore interrupt handler. */
404 cdev->handler = handler;
405 spin_unlock_irq(&sch->lock);
407 clear_normalized_cda (rdc_ccw);
414 * Read Configuration data using path mask
417 read_conf_data_lpm (struct ccw_device *cdev, void **buffer, int *length, __u8 lpm)
419 void (*handler)(struct ccw_device *, unsigned long, struct irb *);
420 struct subchannel *sch;
424 struct ccw1 *rcd_ccw;
428 if (!buffer || !length)
430 sch = to_subchannel(cdev->dev.parent);
432 CIO_TRACE_EVENT (4, "rdconf");
433 CIO_TRACE_EVENT (4, sch->dev.bus_id);
436 * scan for RCD command in extended SenseID data
438 ciw = ccw_device_get_ciw(cdev, CIW_TYPE_RCD);
439 if (!ciw || ciw->cmd == 0)
442 /* Adjust requested path mask to excluded varied off paths. */
449 rcd_ccw = kzalloc(sizeof(struct ccw1), GFP_KERNEL | GFP_DMA);
452 rcd_buf = kzalloc(ciw->count, GFP_KERNEL | GFP_DMA);
457 rcd_ccw->cmd_code = ciw->cmd;
458 rcd_ccw->cda = (__u32) __pa (rcd_buf);
459 rcd_ccw->count = ciw->count;
460 rcd_ccw->flags = CCW_FLAG_SLI;
462 spin_lock_irq(&sch->lock);
463 /* Save interrupt handler. */
464 handler = cdev->handler;
465 /* Temporarily install own handler. */
466 cdev->handler = ccw_device_wake_up;
467 if (cdev->private->state != DEV_STATE_ONLINE)
469 else if (((sch->schib.scsw.stctl & SCSW_STCTL_PRIM_STATUS) &&
470 !(sch->schib.scsw.stctl & SCSW_STCTL_SEC_STATUS)) ||
471 cdev->private->flags.doverify)
474 /* 0x00D9C3C4 == ebcdic "RCD" */
475 ret = __ccw_device_retry_loop(cdev, rcd_ccw, 0x00D9C3C4, lpm);
477 /* Restore interrupt handler. */
478 cdev->handler = handler;
479 spin_unlock_irq(&sch->lock);
482 * on success we update the user input parms
489 *length = ciw->count;
498 * Read Configuration data
501 read_conf_data (struct ccw_device *cdev, void **buffer, int *length)
503 return read_conf_data_lpm (cdev, buffer, length, 0);
507 * Try to break the lock on a boxed device.
510 ccw_device_stlck(struct ccw_device *cdev)
514 struct subchannel *sch;
520 if (cdev->drv && !cdev->private->options.force)
523 sch = to_subchannel(cdev->dev.parent);
525 CIO_TRACE_EVENT(2, "stl lock");
526 CIO_TRACE_EVENT(2, cdev->dev.bus_id);
528 buf = kmalloc(32*sizeof(char), GFP_DMA|GFP_KERNEL);
531 buf2 = kmalloc(32*sizeof(char), GFP_DMA|GFP_KERNEL);
536 spin_lock_irqsave(&sch->lock, flags);
537 ret = cio_enable_subchannel(sch, 3);
541 * Setup ccw. We chain an unconditional reserve and a release so we
542 * only break the lock.
544 cdev->private->iccws[0].cmd_code = CCW_CMD_STLCK;
545 cdev->private->iccws[0].cda = (__u32) __pa(buf);
546 cdev->private->iccws[0].count = 32;
547 cdev->private->iccws[0].flags = CCW_FLAG_CC;
548 cdev->private->iccws[1].cmd_code = CCW_CMD_RELEASE;
549 cdev->private->iccws[1].cda = (__u32) __pa(buf2);
550 cdev->private->iccws[1].count = 32;
551 cdev->private->iccws[1].flags = 0;
552 ret = cio_start(sch, cdev->private->iccws, 0);
554 cio_disable_subchannel(sch); //FIXME: return code?
557 cdev->private->irb.scsw.actl |= SCSW_ACTL_START_PEND;
558 spin_unlock_irqrestore(&sch->lock, flags);
559 wait_event(cdev->private->wait_q, cdev->private->irb.scsw.actl == 0);
560 spin_lock_irqsave(&sch->lock, flags);
561 cio_disable_subchannel(sch); //FIXME: return code?
562 if ((cdev->private->irb.scsw.dstat !=
563 (DEV_STAT_CHN_END|DEV_STAT_DEV_END)) ||
564 (cdev->private->irb.scsw.cstat != 0))
567 memset(&cdev->private->irb, 0, sizeof(struct irb));
571 spin_unlock_irqrestore(&sch->lock, flags);
576 ccw_device_get_chp_desc(struct ccw_device *cdev, int chp_no)
578 struct subchannel *sch;
580 sch = to_subchannel(cdev->dev.parent);
581 return chsc_get_chp_desc(sch, chp_no);
584 // FIXME: these have to go:
587 _ccw_device_get_subchannel_number(struct ccw_device *cdev)
589 return cdev->private->sch_no;
593 _ccw_device_get_device_number(struct ccw_device *cdev)
595 return cdev->private->devno;
599 MODULE_LICENSE("GPL");
600 EXPORT_SYMBOL(ccw_device_set_options);
601 EXPORT_SYMBOL(ccw_device_clear);
602 EXPORT_SYMBOL(ccw_device_halt);
603 EXPORT_SYMBOL(ccw_device_resume);
604 EXPORT_SYMBOL(ccw_device_start_timeout);
605 EXPORT_SYMBOL(ccw_device_start);
606 EXPORT_SYMBOL(ccw_device_start_timeout_key);
607 EXPORT_SYMBOL(ccw_device_start_key);
608 EXPORT_SYMBOL(ccw_device_get_ciw);
609 EXPORT_SYMBOL(ccw_device_get_path_mask);
610 EXPORT_SYMBOL(read_conf_data);
611 EXPORT_SYMBOL(read_dev_chars);
612 EXPORT_SYMBOL(_ccw_device_get_subchannel_number);
613 EXPORT_SYMBOL(_ccw_device_get_device_number);
614 EXPORT_SYMBOL_GPL(ccw_device_get_chp_desc);
615 EXPORT_SYMBOL_GPL(read_conf_data_lpm);