2 * drivers/s390/cio/device_pgid.c
4 * Copyright (C) 2002 IBM Deutschland Entwicklung GmbH,
6 * Author(s): Cornelia Huck (cornelia.huck@de.ibm.com)
7 * Martin Schwidefsky (schwidefsky@de.ibm.com)
9 * Path Group ID functions.
12 #include <linux/module.h>
13 #include <linux/init.h>
15 #include <asm/ccwdev.h>
17 #include <asm/delay.h>
18 #include <asm/lowcore.h>
21 #include "cio_debug.h"
28 * Helper function called from interrupt context to decide whether an
29 * operation should be tried again.
31 static int __ccw_device_should_retry(union scsw
*scsw
)
33 /* CC is only valid if start function bit is set. */
34 if ((scsw
->cmd
.fctl
& SCSW_FCTL_START_FUNC
) && scsw
->cmd
.cc
== 1)
36 /* No more activity. For sense and set PGID we stubbornly try again. */
43 * Start Sense Path Group ID helper function. Used in ccw_device_recog
44 * and ccw_device_sense_pgid.
47 __ccw_device_sense_pgid_start(struct ccw_device
*cdev
)
49 struct subchannel
*sch
;
54 sch
= to_subchannel(cdev
->dev
.parent
);
55 /* Return if we already checked on all paths. */
56 if (cdev
->private->imask
== 0)
57 return (sch
->lpm
== 0) ? -ENODEV
: -EACCES
;
58 i
= 8 - ffs(cdev
->private->imask
);
60 /* Setup sense path group id channel program. */
61 ccw
= cdev
->private->iccws
;
62 ccw
->cmd_code
= CCW_CMD_SENSE_PGID
;
63 ccw
->count
= sizeof (struct pgid
);
64 ccw
->flags
= CCW_FLAG_SLI
;
66 /* Reset device status. */
67 memset(&cdev
->private->irb
, 0, sizeof(struct irb
));
68 /* Try on every path. */
70 while (cdev
->private->imask
!= 0) {
71 /* Try every path multiple times. */
72 ccw
->cda
= (__u32
) __pa (&cdev
->private->pgid
[i
]);
73 if (cdev
->private->iretry
> 0) {
74 cdev
->private->iretry
--;
75 /* Reset internal retry indication. */
76 cdev
->private->flags
.intretry
= 0;
77 ret
= cio_start (sch
, cdev
->private->iccws
,
78 cdev
->private->imask
);
79 /* ret is 0, -EBUSY, -EACCES or -ENODEV */
82 CIO_MSG_EVENT(3, "SNID - Device %04x on Subchannel "
83 "0.%x.%04x, lpm %02X, became 'not "
85 cdev
->private->dev_id
.devno
,
87 sch
->schid
.sch_no
, cdev
->private->imask
);
90 cdev
->private->imask
>>= 1;
91 cdev
->private->iretry
= 5;
99 ccw_device_sense_pgid_start(struct ccw_device
*cdev
)
103 /* Set a timeout of 60s */
104 ccw_device_set_timeout(cdev
, 60*HZ
);
106 cdev
->private->state
= DEV_STATE_SENSE_PGID
;
107 cdev
->private->imask
= 0x80;
108 cdev
->private->iretry
= 5;
109 memset (&cdev
->private->pgid
, 0, sizeof (cdev
->private->pgid
));
110 ret
= __ccw_device_sense_pgid_start(cdev
);
111 if (ret
&& ret
!= -EBUSY
)
112 ccw_device_sense_pgid_done(cdev
, ret
);
116 * Called from interrupt context to check if a valid answer
117 * to Sense Path Group ID was received.
120 __ccw_device_check_sense_pgid(struct ccw_device
*cdev
)
122 struct subchannel
*sch
;
126 sch
= to_subchannel(cdev
->dev
.parent
);
127 irb
= &cdev
->private->irb
;
128 if (irb
->scsw
.cmd
.fctl
& (SCSW_FCTL_HALT_FUNC
| SCSW_FCTL_CLEAR_FUNC
)) {
129 /* Retry Sense PGID if requested. */
130 if (cdev
->private->flags
.intretry
) {
131 cdev
->private->flags
.intretry
= 0;
136 if (irb
->esw
.esw0
.erw
.cons
&&
137 (irb
->ecw
[0]&(SNS0_CMD_REJECT
|SNS0_INTERVENTION_REQ
))) {
139 * If the device doesn't support the Sense Path Group ID
140 * command further retries wouldn't help ...
144 if (irb
->esw
.esw0
.erw
.cons
) {
145 CIO_MSG_EVENT(2, "SNID - device 0.%x.%04x, unit check, "
146 "lpum %02X, cnt %02d, sns : "
147 "%02X%02X%02X%02X %02X%02X%02X%02X ...\n",
148 cdev
->private->dev_id
.ssid
,
149 cdev
->private->dev_id
.devno
,
150 irb
->esw
.esw0
.sublog
.lpum
,
151 irb
->esw
.esw0
.erw
.scnt
,
152 irb
->ecw
[0], irb
->ecw
[1],
153 irb
->ecw
[2], irb
->ecw
[3],
154 irb
->ecw
[4], irb
->ecw
[5],
155 irb
->ecw
[6], irb
->ecw
[7]);
158 if (irb
->scsw
.cmd
.cc
== 3) {
161 lpm
= to_io_private(sch
)->orb
.cmd
.lpm
;
162 CIO_MSG_EVENT(3, "SNID - Device %04x on Subchannel 0.%x.%04x,"
163 " lpm %02X, became 'not operational'\n",
164 cdev
->private->dev_id
.devno
, sch
->schid
.ssid
,
165 sch
->schid
.sch_no
, lpm
);
168 i
= 8 - ffs(cdev
->private->imask
);
169 if (cdev
->private->pgid
[i
].inf
.ps
.state2
== SNID_STATE2_RESVD_ELSE
) {
170 CIO_MSG_EVENT(2, "SNID - Device %04x on Subchannel 0.%x.%04x "
171 "is reserved by someone else\n",
172 cdev
->private->dev_id
.devno
, sch
->schid
.ssid
,
180 * Got interrupt for Sense Path Group ID.
183 ccw_device_sense_pgid_irq(struct ccw_device
*cdev
, enum dev_event dev_event
)
185 struct subchannel
*sch
;
189 irb
= (struct irb
*) __LC_IRB
;
191 if (irb
->scsw
.cmd
.stctl
==
192 (SCSW_STCTL_STATUS_PEND
| SCSW_STCTL_ALERT_STATUS
)) {
193 if (__ccw_device_should_retry(&irb
->scsw
)) {
194 ret
= __ccw_device_sense_pgid_start(cdev
);
195 if (ret
&& ret
!= -EBUSY
)
196 ccw_device_sense_pgid_done(cdev
, ret
);
200 if (ccw_device_accumulate_and_sense(cdev
, irb
) != 0)
202 sch
= to_subchannel(cdev
->dev
.parent
);
203 ret
= __ccw_device_check_sense_pgid(cdev
);
204 memset(&cdev
->private->irb
, 0, sizeof(struct irb
));
206 /* 0, -ETIME, -EOPNOTSUPP, -EAGAIN, -EACCES or -EUSERS */
207 case -EOPNOTSUPP
: /* Sense Path Group ID not supported */
208 ccw_device_sense_pgid_done(cdev
, -EOPNOTSUPP
);
210 case -ETIME
: /* Sense path group id stopped by timeout. */
211 ccw_device_sense_pgid_done(cdev
, -ETIME
);
213 case -EACCES
: /* channel is not operational. */
214 sch
->lpm
&= ~cdev
->private->imask
;
216 case 0: /* Sense Path Group ID successful. */
217 cdev
->private->imask
>>= 1;
218 cdev
->private->iretry
= 5;
220 case -EAGAIN
: /* Try again. */
221 ret
= __ccw_device_sense_pgid_start(cdev
);
222 if (ret
!= 0 && ret
!= -EBUSY
)
223 ccw_device_sense_pgid_done(cdev
, ret
);
225 case -EUSERS
: /* device is reserved for someone else. */
226 ccw_device_sense_pgid_done(cdev
, -EUSERS
);
232 * Path Group ID helper function.
235 __ccw_device_do_pgid(struct ccw_device
*cdev
, __u8 func
)
237 struct subchannel
*sch
;
241 sch
= to_subchannel(cdev
->dev
.parent
);
243 /* Setup sense path group id channel program. */
244 cdev
->private->pgid
[0].inf
.fc
= func
;
245 ccw
= cdev
->private->iccws
;
246 if (cdev
->private->flags
.pgid_single
)
247 cdev
->private->pgid
[0].inf
.fc
|= SPID_FUNC_SINGLE_PATH
;
249 cdev
->private->pgid
[0].inf
.fc
|= SPID_FUNC_MULTI_PATH
;
250 ccw
->cmd_code
= CCW_CMD_SET_PGID
;
251 ccw
->cda
= (__u32
) __pa (&cdev
->private->pgid
[0]);
252 ccw
->count
= sizeof (struct pgid
);
253 ccw
->flags
= CCW_FLAG_SLI
;
255 /* Reset device status. */
256 memset(&cdev
->private->irb
, 0, sizeof(struct irb
));
258 /* Try multiple times. */
260 if (cdev
->private->iretry
> 0) {
261 cdev
->private->iretry
--;
262 /* Reset internal retry indication. */
263 cdev
->private->flags
.intretry
= 0;
264 ret
= cio_start (sch
, cdev
->private->iccws
,
265 cdev
->private->imask
);
266 /* We expect an interrupt in case of success or busy
268 if ((ret
== 0) || (ret
== -EBUSY
))
271 /* PGID command failed on this path. */
272 CIO_MSG_EVENT(3, "SPID - Device %04x on Subchannel "
273 "0.%x.%04x, lpm %02X, became 'not operational'\n",
274 cdev
->private->dev_id
.devno
, sch
->schid
.ssid
,
275 sch
->schid
.sch_no
, cdev
->private->imask
);
280 * Helper function to send a nop ccw down a path.
282 static int __ccw_device_do_nop(struct ccw_device
*cdev
)
284 struct subchannel
*sch
;
288 sch
= to_subchannel(cdev
->dev
.parent
);
290 /* Setup nop channel program. */
291 ccw
= cdev
->private->iccws
;
292 ccw
->cmd_code
= CCW_CMD_NOOP
;
295 ccw
->flags
= CCW_FLAG_SLI
;
297 /* Reset device status. */
298 memset(&cdev
->private->irb
, 0, sizeof(struct irb
));
300 /* Try multiple times. */
302 if (cdev
->private->iretry
> 0) {
303 cdev
->private->iretry
--;
304 /* Reset internal retry indication. */
305 cdev
->private->flags
.intretry
= 0;
306 ret
= cio_start (sch
, cdev
->private->iccws
,
307 cdev
->private->imask
);
308 /* We expect an interrupt in case of success or busy
310 if ((ret
== 0) || (ret
== -EBUSY
))
313 /* nop command failed on this path. */
314 CIO_MSG_EVENT(3, "NOP - Device %04x on Subchannel "
315 "0.%x.%04x, lpm %02X, became 'not operational'\n",
316 cdev
->private->dev_id
.devno
, sch
->schid
.ssid
,
317 sch
->schid
.sch_no
, cdev
->private->imask
);
323 * Called from interrupt context to check if a valid answer
324 * to Set Path Group ID was received.
327 __ccw_device_check_pgid(struct ccw_device
*cdev
)
329 struct subchannel
*sch
;
332 sch
= to_subchannel(cdev
->dev
.parent
);
333 irb
= &cdev
->private->irb
;
334 if (irb
->scsw
.cmd
.fctl
& (SCSW_FCTL_HALT_FUNC
| SCSW_FCTL_CLEAR_FUNC
)) {
335 /* Retry Set PGID if requested. */
336 if (cdev
->private->flags
.intretry
) {
337 cdev
->private->flags
.intretry
= 0;
342 if (irb
->esw
.esw0
.erw
.cons
) {
343 if (irb
->ecw
[0] & SNS0_CMD_REJECT
)
345 /* Hmm, whatever happened, try again. */
346 CIO_MSG_EVENT(2, "SPID - device 0.%x.%04x, unit check, "
348 "sns : %02X%02X%02X%02X %02X%02X%02X%02X ...\n",
349 cdev
->private->dev_id
.ssid
,
350 cdev
->private->dev_id
.devno
,
351 irb
->esw
.esw0
.erw
.scnt
,
352 irb
->ecw
[0], irb
->ecw
[1],
353 irb
->ecw
[2], irb
->ecw
[3],
354 irb
->ecw
[4], irb
->ecw
[5],
355 irb
->ecw
[6], irb
->ecw
[7]);
358 if (irb
->scsw
.cmd
.cc
== 3) {
359 CIO_MSG_EVENT(3, "SPID - Device %04x on Subchannel 0.%x.%04x,"
360 " lpm %02X, became 'not operational'\n",
361 cdev
->private->dev_id
.devno
, sch
->schid
.ssid
,
362 sch
->schid
.sch_no
, cdev
->private->imask
);
369 * Called from interrupt context to check the path status after a nop has
372 static int __ccw_device_check_nop(struct ccw_device
*cdev
)
374 struct subchannel
*sch
;
377 sch
= to_subchannel(cdev
->dev
.parent
);
378 irb
= &cdev
->private->irb
;
379 if (irb
->scsw
.cmd
.fctl
& (SCSW_FCTL_HALT_FUNC
| SCSW_FCTL_CLEAR_FUNC
)) {
380 /* Retry NOP if requested. */
381 if (cdev
->private->flags
.intretry
) {
382 cdev
->private->flags
.intretry
= 0;
387 if (irb
->scsw
.cmd
.cc
== 3) {
388 CIO_MSG_EVENT(3, "NOP - Device %04x on Subchannel 0.%x.%04x,"
389 " lpm %02X, became 'not operational'\n",
390 cdev
->private->dev_id
.devno
, sch
->schid
.ssid
,
391 sch
->schid
.sch_no
, cdev
->private->imask
);
398 __ccw_device_verify_start(struct ccw_device
*cdev
)
400 struct subchannel
*sch
;
404 sch
= to_subchannel(cdev
->dev
.parent
);
405 /* Repeat for all paths. */
406 for (; cdev
->private->imask
; cdev
->private->imask
>>= 1,
407 cdev
->private->iretry
= 5) {
408 if ((cdev
->private->imask
& sch
->schib
.pmcw
.pam
) == 0)
409 /* Path not available, try next. */
411 if (cdev
->private->options
.pgroup
) {
412 if (sch
->opm
& cdev
->private->imask
)
413 func
= SPID_FUNC_ESTABLISH
;
415 func
= SPID_FUNC_RESIGN
;
416 ret
= __ccw_device_do_pgid(cdev
, func
);
418 ret
= __ccw_device_do_nop(cdev
);
419 /* We expect an interrupt in case of success or busy
421 if (ret
== 0 || ret
== -EBUSY
)
423 /* Permanent path failure, try next. */
425 /* Done with all paths. */
426 ccw_device_verify_done(cdev
, (sch
->vpm
!= 0) ? 0 : -ENODEV
);
430 * Got interrupt for Set Path Group ID.
433 ccw_device_verify_irq(struct ccw_device
*cdev
, enum dev_event dev_event
)
435 struct subchannel
*sch
;
439 irb
= (struct irb
*) __LC_IRB
;
441 if (irb
->scsw
.cmd
.stctl
==
442 (SCSW_STCTL_STATUS_PEND
| SCSW_STCTL_ALERT_STATUS
)) {
443 if (__ccw_device_should_retry(&irb
->scsw
))
444 __ccw_device_verify_start(cdev
);
447 if (ccw_device_accumulate_and_sense(cdev
, irb
) != 0)
449 sch
= to_subchannel(cdev
->dev
.parent
);
450 if (cdev
->private->options
.pgroup
)
451 ret
= __ccw_device_check_pgid(cdev
);
453 ret
= __ccw_device_check_nop(cdev
);
454 memset(&cdev
->private->irb
, 0, sizeof(struct irb
));
457 /* 0, -ETIME, -EAGAIN, -EOPNOTSUPP or -EACCES */
459 /* Path verification ccw finished successfully, update lpm. */
460 sch
->vpm
|= sch
->opm
& cdev
->private->imask
;
461 /* Go on with next path. */
462 cdev
->private->imask
>>= 1;
463 cdev
->private->iretry
= 5;
464 __ccw_device_verify_start(cdev
);
468 * One of those strange devices which claim to be able
469 * to do multipathing but not for Set Path Group ID.
471 if (cdev
->private->flags
.pgid_single
)
472 cdev
->private->options
.pgroup
= 0;
474 cdev
->private->flags
.pgid_single
= 1;
477 cdev
->private->imask
= 0x80;
478 cdev
->private->iretry
= 5;
480 case -EAGAIN
: /* Try again. */
481 __ccw_device_verify_start(cdev
);
483 case -ETIME
: /* Set path group id stopped by timeout. */
484 ccw_device_verify_done(cdev
, -ETIME
);
486 case -EACCES
: /* channel is not operational. */
487 cdev
->private->imask
>>= 1;
488 cdev
->private->iretry
= 5;
489 __ccw_device_verify_start(cdev
);
495 ccw_device_verify_start(struct ccw_device
*cdev
)
497 struct subchannel
*sch
= to_subchannel(cdev
->dev
.parent
);
499 cdev
->private->flags
.pgid_single
= 0;
500 cdev
->private->imask
= 0x80;
501 cdev
->private->iretry
= 5;
503 /* Start with empty vpm. */
506 /* Get current pam. */
507 if (cio_update_schib(sch
)) {
508 ccw_device_verify_done(cdev
, -ENODEV
);
511 /* After 60s path verification is considered to have failed. */
512 ccw_device_set_timeout(cdev
, 60*HZ
);
513 __ccw_device_verify_start(cdev
);
517 __ccw_device_disband_start(struct ccw_device
*cdev
)
519 struct subchannel
*sch
;
522 sch
= to_subchannel(cdev
->dev
.parent
);
523 while (cdev
->private->imask
!= 0) {
524 if (sch
->lpm
& cdev
->private->imask
) {
525 ret
= __ccw_device_do_pgid(cdev
, SPID_FUNC_DISBAND
);
529 cdev
->private->iretry
= 5;
530 cdev
->private->imask
>>= 1;
532 ccw_device_disband_done(cdev
, (sch
->lpm
!= 0) ? 0 : -ENODEV
);
536 * Got interrupt for Unset Path Group ID.
539 ccw_device_disband_irq(struct ccw_device
*cdev
, enum dev_event dev_event
)
541 struct subchannel
*sch
;
545 irb
= (struct irb
*) __LC_IRB
;
547 if (irb
->scsw
.cmd
.stctl
==
548 (SCSW_STCTL_STATUS_PEND
| SCSW_STCTL_ALERT_STATUS
)) {
549 if (__ccw_device_should_retry(&irb
->scsw
))
550 __ccw_device_disband_start(cdev
);
553 if (ccw_device_accumulate_and_sense(cdev
, irb
) != 0)
555 sch
= to_subchannel(cdev
->dev
.parent
);
556 ret
= __ccw_device_check_pgid(cdev
);
557 memset(&cdev
->private->irb
, 0, sizeof(struct irb
));
559 /* 0, -ETIME, -EAGAIN, -EOPNOTSUPP or -EACCES */
560 case 0: /* disband successful. */
561 ccw_device_disband_done(cdev
, ret
);
565 * One of those strange devices which claim to be able
566 * to do multipathing but not for Unset Path Group ID.
568 cdev
->private->flags
.pgid_single
= 1;
570 case -EAGAIN
: /* Try again. */
571 __ccw_device_disband_start(cdev
);
573 case -ETIME
: /* Set path group id stopped by timeout. */
574 ccw_device_disband_done(cdev
, -ETIME
);
576 case -EACCES
: /* channel is not operational. */
577 cdev
->private->imask
>>= 1;
578 cdev
->private->iretry
= 5;
579 __ccw_device_disband_start(cdev
);
585 ccw_device_disband_start(struct ccw_device
*cdev
)
587 /* After 60s disbanding is considered to have failed. */
588 ccw_device_set_timeout(cdev
, 60*HZ
);
590 cdev
->private->flags
.pgid_single
= 0;
591 cdev
->private->iretry
= 5;
592 cdev
->private->imask
= 0x80;
593 __ccw_device_disband_start(cdev
);