2 * Copyright IBM Corp. 2002, 2009
4 * Author(s): Martin Schwidefsky (schwidefsky@de.ibm.com)
5 * Cornelia Huck (cornelia.huck@de.ibm.com)
7 #include <linux/module.h>
8 #include <linux/init.h>
9 #include <linux/errno.h>
10 #include <linux/slab.h>
11 #include <linux/list.h>
12 #include <linux/device.h>
13 #include <linux/delay.h>
14 #include <linux/completion.h>
16 #include <asm/ccwdev.h>
17 #include <asm/idals.h>
18 #include <asm/chpid.h>
22 #include "cio_debug.h"
29 * ccw_device_set_options_mask() - set some options and unset the rest
30 * @cdev: device for which the options are to be set
31 * @flags: options to be set
33 * All flags specified in @flags are set, all flags not specified in @flags
36 * %0 on success, -%EINVAL on an invalid flag combination.
38 int ccw_device_set_options_mask(struct ccw_device *cdev, unsigned long flags)
41 * The flag usage is mutal exclusive ...
43 if ((flags & CCWDEV_EARLY_NOTIFICATION) &&
44 (flags & CCWDEV_REPORT_ALL))
46 cdev->private->options.fast = (flags & CCWDEV_EARLY_NOTIFICATION) != 0;
47 cdev->private->options.repall = (flags & CCWDEV_REPORT_ALL) != 0;
48 cdev->private->options.pgroup = (flags & CCWDEV_DO_PATHGROUP) != 0;
49 cdev->private->options.force = (flags & CCWDEV_ALLOW_FORCE) != 0;
50 cdev->private->options.mpath = (flags & CCWDEV_DO_MULTIPATH) != 0;
55 * ccw_device_set_options() - set some options
56 * @cdev: device for which the options are to be set
57 * @flags: options to be set
59 * All flags specified in @flags are set, the remainder is left untouched.
61 * %0 on success, -%EINVAL if an invalid flag combination would ensue.
63 int ccw_device_set_options(struct ccw_device *cdev, unsigned long flags)
66 * The flag usage is mutal exclusive ...
68 if (((flags & CCWDEV_EARLY_NOTIFICATION) &&
69 (flags & CCWDEV_REPORT_ALL)) ||
70 ((flags & CCWDEV_EARLY_NOTIFICATION) &&
71 cdev->private->options.repall) ||
72 ((flags & CCWDEV_REPORT_ALL) &&
73 cdev->private->options.fast))
75 cdev->private->options.fast |= (flags & CCWDEV_EARLY_NOTIFICATION) != 0;
76 cdev->private->options.repall |= (flags & CCWDEV_REPORT_ALL) != 0;
77 cdev->private->options.pgroup |= (flags & CCWDEV_DO_PATHGROUP) != 0;
78 cdev->private->options.force |= (flags & CCWDEV_ALLOW_FORCE) != 0;
79 cdev->private->options.mpath |= (flags & CCWDEV_DO_MULTIPATH) != 0;
84 * ccw_device_clear_options() - clear some options
85 * @cdev: device for which the options are to be cleared
86 * @flags: options to be cleared
88 * All flags specified in @flags are cleared, the remainder is left untouched.
90 void ccw_device_clear_options(struct ccw_device *cdev, unsigned long flags)
92 cdev->private->options.fast &= (flags & CCWDEV_EARLY_NOTIFICATION) == 0;
93 cdev->private->options.repall &= (flags & CCWDEV_REPORT_ALL) == 0;
94 cdev->private->options.pgroup &= (flags & CCWDEV_DO_PATHGROUP) == 0;
95 cdev->private->options.force &= (flags & CCWDEV_ALLOW_FORCE) == 0;
96 cdev->private->options.mpath &= (flags & CCWDEV_DO_MULTIPATH) == 0;
100 * ccw_device_is_pathgroup() - determine if paths to this device are grouped
103 * Return non-zero if there is a path group, zero otherwise.
105 int ccw_device_is_pathgroup(struct ccw_device *cdev)
107 return cdev->private->flags.pgroup;
109 EXPORT_SYMBOL(ccw_device_is_pathgroup);
112 * ccw_device_is_multipath() - determine if device is operating in multipath mode
115 * Return non-zero if device is operating in multipath mode, zero otherwise.
117 int ccw_device_is_multipath(struct ccw_device *cdev)
119 return cdev->private->flags.mpath;
121 EXPORT_SYMBOL(ccw_device_is_multipath);
124 * ccw_device_clear() - terminate I/O request processing
125 * @cdev: target ccw device
126 * @intparm: interruption parameter; value is only used if no I/O is
127 * outstanding, otherwise the intparm associated with the I/O request
130 * ccw_device_clear() calls csch on @cdev's subchannel.
133 * -%ENODEV on device not operational,
134 * -%EINVAL on invalid device state.
136 * Interrupts disabled, ccw device lock held
138 int ccw_device_clear(struct ccw_device *cdev, unsigned long intparm)
140 struct subchannel *sch;
143 if (!cdev || !cdev->dev.parent)
145 sch = to_subchannel(cdev->dev.parent);
146 if (!sch->schib.pmcw.ena)
148 if (cdev->private->state == DEV_STATE_NOT_OPER)
150 if (cdev->private->state != DEV_STATE_ONLINE &&
151 cdev->private->state != DEV_STATE_W4SENSE)
154 ret = cio_clear(sch);
156 cdev->private->intparm = intparm;
161 * ccw_device_start_timeout_key() - start a s390 channel program with timeout and key
162 * @cdev: target ccw device
163 * @cpa: logical start address of channel program
164 * @intparm: user specific interruption parameter; will be presented back to
165 * @cdev's interrupt handler. Allows a device driver to associate
166 * the interrupt with a particular I/O request.
167 * @lpm: defines the channel path to be used for a specific I/O request. A
168 * value of 0 will make cio use the opm.
169 * @key: storage key to be used for the I/O
170 * @flags: additional flags; defines the action to be performed for I/O
172 * @expires: timeout value in jiffies
174 * Start a S/390 channel program. When the interrupt arrives, the
175 * IRQ handler is called, either immediately, delayed (dev-end missing,
176 * or sense required) or never (no IRQ handler registered).
177 * This function notifies the device driver if the channel program has not
178 * completed during the time specified by @expires. If a timeout occurs, the
179 * channel program is terminated via xsch, hsch or csch, and the device's
180 * interrupt handler will be called with an irb containing ERR_PTR(-%ETIMEDOUT).
182 * %0, if the operation was successful;
183 * -%EBUSY, if the device is busy, or status pending;
184 * -%EACCES, if no path specified in @lpm is operational;
185 * -%ENODEV, if the device is not operational.
187 * Interrupts disabled, ccw device lock held
189 int ccw_device_start_timeout_key(struct ccw_device *cdev, struct ccw1 *cpa,
190 unsigned long intparm, __u8 lpm, __u8 key,
191 unsigned long flags, int expires)
193 struct subchannel *sch;
196 if (!cdev || !cdev->dev.parent)
198 sch = to_subchannel(cdev->dev.parent);
199 if (!sch->schib.pmcw.ena)
201 if (cdev->private->state == DEV_STATE_NOT_OPER)
203 if (cdev->private->state == DEV_STATE_VERIFY) {
204 /* Remember to fake irb when finished. */
205 if (!cdev->private->flags.fake_irb) {
206 cdev->private->flags.fake_irb = FAKE_CMD_IRB;
207 cdev->private->intparm = intparm;
210 /* There's already a fake I/O around. */
213 if (cdev->private->state != DEV_STATE_ONLINE ||
214 ((sch->schib.scsw.cmd.stctl & SCSW_STCTL_PRIM_STATUS) &&
215 !(sch->schib.scsw.cmd.stctl & SCSW_STCTL_SEC_STATUS)) ||
216 cdev->private->flags.doverify)
218 ret = cio_set_options (sch, flags);
221 /* Adjust requested path mask to exclude unusable paths. */
227 ret = cio_start_key (sch, cpa, lpm, key);
230 cdev->private->intparm = intparm;
232 ccw_device_set_timeout(cdev, expires);
236 dev_fsm_event(cdev, DEV_EVENT_VERIFY);
243 * ccw_device_start_key() - start a s390 channel program with key
244 * @cdev: target ccw device
245 * @cpa: logical start address of channel program
246 * @intparm: user specific interruption parameter; will be presented back to
247 * @cdev's interrupt handler. Allows a device driver to associate
248 * the interrupt with a particular I/O request.
249 * @lpm: defines the channel path to be used for a specific I/O request. A
250 * value of 0 will make cio use the opm.
251 * @key: storage key to be used for the I/O
252 * @flags: additional flags; defines the action to be performed for I/O
255 * Start a S/390 channel program. When the interrupt arrives, the
256 * IRQ handler is called, either immediately, delayed (dev-end missing,
257 * or sense required) or never (no IRQ handler registered).
259 * %0, if the operation was successful;
260 * -%EBUSY, if the device is busy, or status pending;
261 * -%EACCES, if no path specified in @lpm is operational;
262 * -%ENODEV, if the device is not operational.
264 * Interrupts disabled, ccw device lock held
266 int ccw_device_start_key(struct ccw_device *cdev, struct ccw1 *cpa,
267 unsigned long intparm, __u8 lpm, __u8 key,
270 return ccw_device_start_timeout_key(cdev, cpa, intparm, lpm, key,
275 * ccw_device_start() - start a s390 channel program
276 * @cdev: target ccw device
277 * @cpa: logical start address of channel program
278 * @intparm: user specific interruption parameter; will be presented back to
279 * @cdev's interrupt handler. Allows a device driver to associate
280 * the interrupt with a particular I/O request.
281 * @lpm: defines the channel path to be used for a specific I/O request. A
282 * value of 0 will make cio use the opm.
283 * @flags: additional flags; defines the action to be performed for I/O
286 * Start a S/390 channel program. When the interrupt arrives, the
287 * IRQ handler is called, either immediately, delayed (dev-end missing,
288 * or sense required) or never (no IRQ handler registered).
290 * %0, if the operation was successful;
291 * -%EBUSY, if the device is busy, or status pending;
292 * -%EACCES, if no path specified in @lpm is operational;
293 * -%ENODEV, if the device is not operational.
295 * Interrupts disabled, ccw device lock held
297 int ccw_device_start(struct ccw_device *cdev, struct ccw1 *cpa,
298 unsigned long intparm, __u8 lpm, unsigned long flags)
300 return ccw_device_start_key(cdev, cpa, intparm, lpm,
301 PAGE_DEFAULT_KEY, flags);
305 * ccw_device_start_timeout() - start a s390 channel program with timeout
306 * @cdev: target ccw device
307 * @cpa: logical start address of channel program
308 * @intparm: user specific interruption parameter; will be presented back to
309 * @cdev's interrupt handler. Allows a device driver to associate
310 * the interrupt with a particular I/O request.
311 * @lpm: defines the channel path to be used for a specific I/O request. A
312 * value of 0 will make cio use the opm.
313 * @flags: additional flags; defines the action to be performed for I/O
315 * @expires: timeout value in jiffies
317 * Start a S/390 channel program. When the interrupt arrives, the
318 * IRQ handler is called, either immediately, delayed (dev-end missing,
319 * or sense required) or never (no IRQ handler registered).
320 * This function notifies the device driver if the channel program has not
321 * completed during the time specified by @expires. If a timeout occurs, the
322 * channel program is terminated via xsch, hsch or csch, and the device's
323 * interrupt handler will be called with an irb containing ERR_PTR(-%ETIMEDOUT).
325 * %0, if the operation was successful;
326 * -%EBUSY, if the device is busy, or status pending;
327 * -%EACCES, if no path specified in @lpm is operational;
328 * -%ENODEV, if the device is not operational.
330 * Interrupts disabled, ccw device lock held
332 int ccw_device_start_timeout(struct ccw_device *cdev, struct ccw1 *cpa,
333 unsigned long intparm, __u8 lpm,
334 unsigned long flags, int expires)
336 return ccw_device_start_timeout_key(cdev, cpa, intparm, lpm,
337 PAGE_DEFAULT_KEY, flags,
343 * ccw_device_halt() - halt I/O request processing
344 * @cdev: target ccw device
345 * @intparm: interruption parameter; value is only used if no I/O is
346 * outstanding, otherwise the intparm associated with the I/O request
349 * ccw_device_halt() calls hsch on @cdev's subchannel.
352 * -%ENODEV on device not operational,
353 * -%EINVAL on invalid device state,
354 * -%EBUSY on device busy or interrupt pending.
356 * Interrupts disabled, ccw device lock held
358 int ccw_device_halt(struct ccw_device *cdev, unsigned long intparm)
360 struct subchannel *sch;
363 if (!cdev || !cdev->dev.parent)
365 sch = to_subchannel(cdev->dev.parent);
366 if (!sch->schib.pmcw.ena)
368 if (cdev->private->state == DEV_STATE_NOT_OPER)
370 if (cdev->private->state != DEV_STATE_ONLINE &&
371 cdev->private->state != DEV_STATE_W4SENSE)
376 cdev->private->intparm = intparm;
381 * ccw_device_resume() - resume channel program execution
382 * @cdev: target ccw device
384 * ccw_device_resume() calls rsch on @cdev's subchannel.
387 * -%ENODEV on device not operational,
388 * -%EINVAL on invalid device state,
389 * -%EBUSY on device busy or interrupt pending.
391 * Interrupts disabled, ccw device lock held
393 int ccw_device_resume(struct ccw_device *cdev)
395 struct subchannel *sch;
397 if (!cdev || !cdev->dev.parent)
399 sch = to_subchannel(cdev->dev.parent);
400 if (!sch->schib.pmcw.ena)
402 if (cdev->private->state == DEV_STATE_NOT_OPER)
404 if (cdev->private->state != DEV_STATE_ONLINE ||
405 !(sch->schib.scsw.cmd.actl & SCSW_ACTL_SUSPENDED))
407 return cio_resume(sch);
411 * ccw_device_get_ciw() - Search for CIW command in extended sense data.
412 * @cdev: ccw device to inspect
413 * @ct: command type to look for
415 * During SenseID, command information words (CIWs) describing special
416 * commands available to the device may have been stored in the extended
417 * sense data. This function searches for CIWs of a specified command
418 * type in the extended sense data.
420 * %NULL if no extended sense data has been stored or if no CIW of the
421 * specified command type could be found,
422 * else a pointer to the CIW of the specified command type.
424 struct ciw *ccw_device_get_ciw(struct ccw_device *cdev, __u32 ct)
428 if (cdev->private->flags.esid == 0)
430 for (ciw_cnt = 0; ciw_cnt < MAX_CIWS; ciw_cnt++)
431 if (cdev->private->senseid.ciw[ciw_cnt].ct == ct)
432 return cdev->private->senseid.ciw + ciw_cnt;
437 * ccw_device_get_path_mask() - get currently available paths
438 * @cdev: ccw device to be queried
440 * %0 if no subchannel for the device is available,
441 * else the mask of currently available paths for the ccw device's subchannel.
443 __u8 ccw_device_get_path_mask(struct ccw_device *cdev)
445 struct subchannel *sch;
447 if (!cdev->dev.parent)
450 sch = to_subchannel(cdev->dev.parent);
455 * ccw_device_get_chp_desc() - return newly allocated channel-path descriptor
456 * @cdev: device to obtain the descriptor for
457 * @chp_idx: index of the channel path
459 * On success return a newly allocated copy of the channel-path description
460 * data associated with the given channel path. Return %NULL on error.
462 struct channel_path_desc *ccw_device_get_chp_desc(struct ccw_device *cdev,
465 struct subchannel *sch;
468 sch = to_subchannel(cdev->dev.parent);
470 chpid.id = sch->schib.pmcw.chpid[chp_idx];
471 return chp_get_chp_desc(chpid);
475 * ccw_device_get_id() - obtain a ccw device id
476 * @cdev: device to obtain the id for
477 * @dev_id: where to fill in the values
479 void ccw_device_get_id(struct ccw_device *cdev, struct ccw_dev_id *dev_id)
481 *dev_id = cdev->private->dev_id;
483 EXPORT_SYMBOL(ccw_device_get_id);
486 * ccw_device_tm_start_timeout_key() - perform start function
487 * @cdev: ccw device on which to perform the start function
488 * @tcw: transport-command word to be started
489 * @intparm: user defined parameter to be passed to the interrupt handler
490 * @lpm: mask of paths to use
491 * @key: storage key to use for storage access
492 * @expires: time span in jiffies after which to abort request
494 * Start the tcw on the given ccw device. Return zero on success, non-zero
497 int ccw_device_tm_start_timeout_key(struct ccw_device *cdev, struct tcw *tcw,
498 unsigned long intparm, u8 lpm, u8 key,
501 struct subchannel *sch;
504 sch = to_subchannel(cdev->dev.parent);
505 if (!sch->schib.pmcw.ena)
507 if (cdev->private->state == DEV_STATE_VERIFY) {
508 /* Remember to fake irb when finished. */
509 if (!cdev->private->flags.fake_irb) {
510 cdev->private->flags.fake_irb = FAKE_TM_IRB;
511 cdev->private->intparm = intparm;
514 /* There's already a fake I/O around. */
517 if (cdev->private->state != DEV_STATE_ONLINE)
519 /* Adjust requested path mask to exclude unusable paths. */
525 rc = cio_tm_start_key(sch, tcw, lpm, key);
527 cdev->private->intparm = intparm;
529 ccw_device_set_timeout(cdev, expires);
533 EXPORT_SYMBOL(ccw_device_tm_start_timeout_key);
536 * ccw_device_tm_start_key() - perform start function
537 * @cdev: ccw device on which to perform the start function
538 * @tcw: transport-command word to be started
539 * @intparm: user defined parameter to be passed to the interrupt handler
540 * @lpm: mask of paths to use
541 * @key: storage key to use for storage access
543 * Start the tcw on the given ccw device. Return zero on success, non-zero
546 int ccw_device_tm_start_key(struct ccw_device *cdev, struct tcw *tcw,
547 unsigned long intparm, u8 lpm, u8 key)
549 return ccw_device_tm_start_timeout_key(cdev, tcw, intparm, lpm, key, 0);
551 EXPORT_SYMBOL(ccw_device_tm_start_key);
554 * ccw_device_tm_start() - perform start function
555 * @cdev: ccw device on which to perform the start function
556 * @tcw: transport-command word to be started
557 * @intparm: user defined parameter to be passed to the interrupt handler
558 * @lpm: mask of paths to use
560 * Start the tcw on the given ccw device. Return zero on success, non-zero
563 int ccw_device_tm_start(struct ccw_device *cdev, struct tcw *tcw,
564 unsigned long intparm, u8 lpm)
566 return ccw_device_tm_start_key(cdev, tcw, intparm, lpm,
569 EXPORT_SYMBOL(ccw_device_tm_start);
572 * ccw_device_tm_start_timeout() - perform start function
573 * @cdev: ccw device on which to perform the start function
574 * @tcw: transport-command word to be started
575 * @intparm: user defined parameter to be passed to the interrupt handler
576 * @lpm: mask of paths to use
577 * @expires: time span in jiffies after which to abort request
579 * Start the tcw on the given ccw device. Return zero on success, non-zero
582 int ccw_device_tm_start_timeout(struct ccw_device *cdev, struct tcw *tcw,
583 unsigned long intparm, u8 lpm, int expires)
585 return ccw_device_tm_start_timeout_key(cdev, tcw, intparm, lpm,
586 PAGE_DEFAULT_KEY, expires);
588 EXPORT_SYMBOL(ccw_device_tm_start_timeout);
591 * ccw_device_get_mdc() - accumulate max data count
592 * @cdev: ccw device for which the max data count is accumulated
593 * @mask: mask of paths to use
595 * Return the number of 64K-bytes blocks all paths at least support
596 * for a transport command. Return values <= 0 indicate failures.
598 int ccw_device_get_mdc(struct ccw_device *cdev, u8 mask)
600 struct subchannel *sch = to_subchannel(cdev->dev.parent);
601 struct channel_path *chp;
605 /* Adjust requested path mask to excluded varied off paths. */
612 for (i = 0; i < 8; i++) {
613 if (!(mask & (0x80 >> i)))
615 chpid.id = sch->schib.pmcw.chpid[i];
616 chp = chpid_to_chp(chpid);
620 mutex_lock(&chp->lock);
621 if (!chp->desc_fmt1.f) {
622 mutex_unlock(&chp->lock);
625 if (!chp->desc_fmt1.r)
627 mdc = mdc ? min_t(int, mdc, chp->desc_fmt1.mdc) :
629 mutex_unlock(&chp->lock);
634 EXPORT_SYMBOL(ccw_device_get_mdc);
637 * ccw_device_tm_intrg() - perform interrogate function
638 * @cdev: ccw device on which to perform the interrogate function
640 * Perform an interrogate function on the given ccw device. Return zero on
641 * success, non-zero otherwise.
643 int ccw_device_tm_intrg(struct ccw_device *cdev)
645 struct subchannel *sch = to_subchannel(cdev->dev.parent);
647 if (!sch->schib.pmcw.ena)
649 if (cdev->private->state != DEV_STATE_ONLINE)
651 if (!scsw_is_tm(&sch->schib.scsw) ||
652 !(scsw_actl(&sch->schib.scsw) & SCSW_ACTL_START_PEND))
654 return cio_tm_intrg(sch);
656 EXPORT_SYMBOL(ccw_device_tm_intrg);
659 * ccw_device_get_schid() - obtain a subchannel id
660 * @cdev: device to obtain the id for
661 * @schid: where to fill in the values
663 void ccw_device_get_schid(struct ccw_device *cdev, struct subchannel_id *schid)
665 struct subchannel *sch = to_subchannel(cdev->dev.parent);
669 EXPORT_SYMBOL_GPL(ccw_device_get_schid);
671 MODULE_LICENSE("GPL");
672 EXPORT_SYMBOL(ccw_device_set_options_mask);
673 EXPORT_SYMBOL(ccw_device_set_options);
674 EXPORT_SYMBOL(ccw_device_clear_options);
675 EXPORT_SYMBOL(ccw_device_clear);
676 EXPORT_SYMBOL(ccw_device_halt);
677 EXPORT_SYMBOL(ccw_device_resume);
678 EXPORT_SYMBOL(ccw_device_start_timeout);
679 EXPORT_SYMBOL(ccw_device_start);
680 EXPORT_SYMBOL(ccw_device_start_timeout_key);
681 EXPORT_SYMBOL(ccw_device_start_key);
682 EXPORT_SYMBOL(ccw_device_get_ciw);
683 EXPORT_SYMBOL(ccw_device_get_path_mask);
684 EXPORT_SYMBOL_GPL(ccw_device_get_chp_desc);