2 * drivers/s390/cio/cio.c
3 * S/390 common I/O routines -- low level i/o calls
6 * Copyright (C) 1999-2002 IBM Deutschland Entwicklung GmbH,
8 * Author(s): Ingo Adlung (adlung@de.ibm.com)
9 * Cornelia Huck (cohuck@de.ibm.com)
10 * Arnd Bergmann (arndb@de.ibm.com)
11 * Martin Schwidefsky (schwidefsky@de.ibm.com)
14 #include <linux/module.h>
15 #include <linux/config.h>
16 #include <linux/init.h>
17 #include <linux/slab.h>
18 #include <linux/device.h>
19 #include <linux/kernel_stat.h>
20 #include <linux/interrupt.h>
23 #include <asm/delay.h>
31 #include "blacklist.h"
32 #include "cio_debug.h"
34 debug_info_t *cio_debug_msg_id;
35 debug_info_t *cio_debug_trace_id;
36 debug_info_t *cio_debug_crw_id;
41 cio_setup (char *parm)
43 if (!strcmp (parm, "yes"))
45 else if (!strcmp (parm, "no"))
48 printk (KERN_ERR "cio_setup : invalid cio_msg parameter '%s'",
53 __setup ("cio_msg=", cio_setup);
56 * Function: cio_debug_init
57 * Initializes three debug logs (under /proc/s390dbf) for common I/O:
58 * - cio_msg logs the messages which are printk'ed when CONFIG_DEBUG_IO is on
59 * - cio_trace logs the calling of different functions
60 * - cio_crw logs the messages which are printk'ed when CONFIG_DEBUG_CRW is on
61 * debug levels depend on CONFIG_DEBUG_IO resp. CONFIG_DEBUG_CRW
66 cio_debug_msg_id = debug_register ("cio_msg", 16, 4, 16*sizeof (long));
67 if (!cio_debug_msg_id)
69 debug_register_view (cio_debug_msg_id, &debug_sprintf_view);
70 debug_set_level (cio_debug_msg_id, 2);
71 cio_debug_trace_id = debug_register ("cio_trace", 16, 4, 8);
72 if (!cio_debug_trace_id)
74 debug_register_view (cio_debug_trace_id, &debug_hex_ascii_view);
75 debug_set_level (cio_debug_trace_id, 2);
76 cio_debug_crw_id = debug_register ("cio_crw", 4, 4, 16*sizeof (long));
77 if (!cio_debug_crw_id)
79 debug_register_view (cio_debug_crw_id, &debug_sprintf_view);
80 debug_set_level (cio_debug_crw_id, 2);
81 pr_debug("debugging initialized\n");
86 debug_unregister (cio_debug_msg_id);
87 if (cio_debug_trace_id)
88 debug_unregister (cio_debug_trace_id);
90 debug_unregister (cio_debug_crw_id);
91 pr_debug("could not initialize debugging\n");
95 arch_initcall (cio_debug_init);
98 cio_set_options (struct subchannel *sch, int flags)
100 sch->options.suspend = (flags & DOIO_ALLOW_SUSPEND) != 0;
101 sch->options.prefetch = (flags & DOIO_DENY_PREFETCH) != 0;
102 sch->options.inter = (flags & DOIO_SUPPRESS_INTER) != 0;
106 /* FIXME: who wants to use this? */
108 cio_get_options (struct subchannel *sch)
113 if (sch->options.suspend)
114 flags |= DOIO_ALLOW_SUSPEND;
115 if (sch->options.prefetch)
116 flags |= DOIO_DENY_PREFETCH;
117 if (sch->options.inter)
118 flags |= DOIO_SUPPRESS_INTER;
123 * Use tpi to get a pending interrupt, call the interrupt handler and
124 * return a pointer to the subchannel structure.
129 struct tpi_info *tpi_info;
130 struct subchannel *sch;
133 tpi_info = (struct tpi_info *) __LC_SUBCHANNEL_ID;
136 irb = (struct irb *) __LC_IRB;
137 /* Store interrupt response block to lowcore. */
138 if (tsch (tpi_info->schid, irb) != 0)
139 /* Not status pending or not operational. */
141 sch = (struct subchannel *)(unsigned long)tpi_info->intparm;
146 spin_lock(&sch->lock);
147 memcpy (&sch->schib.scsw, &irb->scsw, sizeof (struct scsw));
148 if (sch->driver && sch->driver->irq)
149 sch->driver->irq(&sch->dev);
150 spin_unlock(&sch->lock);
157 cio_start_handle_notoper(struct subchannel *sch, __u8 lpm)
166 stsch (sch->schid, &sch->schib);
168 CIO_MSG_EVENT(0, "cio_start: 'not oper' status for "
169 "subchannel 0.%x.%04x!\n", sch->schid.ssid,
171 sprintf(dbf_text, "no%s", sch->dev.bus_id);
172 CIO_TRACE_EVENT(0, dbf_text);
173 CIO_HEX_EVENT(0, &sch->schib, sizeof (struct schib));
175 return (sch->lpm ? -EACCES : -ENODEV);
179 cio_start_key (struct subchannel *sch, /* subchannel structure */
180 struct ccw1 * cpa, /* logical channel prog addr */
181 __u8 lpm, /* logical path mask */
182 __u8 key) /* storage key */
187 CIO_TRACE_EVENT (4, "stIO");
188 CIO_TRACE_EVENT (4, sch->dev.bus_id);
190 /* sch is always under 2G. */
191 sch->orb.intparm = (__u32)(unsigned long)sch;
194 sch->orb.pfch = sch->options.prefetch == 0;
195 sch->orb.spnd = sch->options.suspend;
196 sch->orb.ssic = sch->options.suspend && sch->options.inter;
197 sch->orb.lpm = (lpm != 0) ? (lpm & sch->opm) : sch->lpm;
200 * for 64 bit we always support 64 bit IDAWs with 4k page size only
205 sch->orb.key = key >> 4;
206 /* issue "Start Subchannel" */
207 sch->orb.cpa = (__u32) __pa (cpa);
208 ccode = ssch (sch->schid, &sch->orb);
210 /* process condition code */
211 sprintf (dbf_txt, "ccode:%d", ccode);
212 CIO_TRACE_EVENT (4, dbf_txt);
217 * initialize device status information
219 sch->schib.scsw.actl |= SCSW_ACTL_START_PEND;
221 case 1: /* status pending */
224 default: /* device/path not operational */
225 return cio_start_handle_notoper(sch, lpm);
230 cio_start (struct subchannel *sch, struct ccw1 *cpa, __u8 lpm)
232 return cio_start_key(sch, cpa, lpm, PAGE_DEFAULT_KEY);
236 * resume suspended I/O operation
239 cio_resume (struct subchannel *sch)
244 CIO_TRACE_EVENT (4, "resIO");
245 CIO_TRACE_EVENT (4, sch->dev.bus_id);
247 ccode = rsch (sch->schid);
249 sprintf (dbf_txt, "ccode:%d", ccode);
250 CIO_TRACE_EVENT (4, dbf_txt);
254 sch->schib.scsw.actl |= SCSW_ACTL_RESUME_PEND;
262 * useless to wait for request completion
263 * as device is no longer operational !
273 cio_halt(struct subchannel *sch)
281 CIO_TRACE_EVENT (2, "haltIO");
282 CIO_TRACE_EVENT (2, sch->dev.bus_id);
285 * Issue "Halt subchannel" and process condition code
287 ccode = hsch (sch->schid);
289 sprintf (dbf_txt, "ccode:%d", ccode);
290 CIO_TRACE_EVENT (2, dbf_txt);
294 sch->schib.scsw.actl |= SCSW_ACTL_HALT_PEND;
296 case 1: /* status pending */
299 default: /* device not operational */
305 * Clear I/O operation
308 cio_clear(struct subchannel *sch)
316 CIO_TRACE_EVENT (2, "clearIO");
317 CIO_TRACE_EVENT (2, sch->dev.bus_id);
320 * Issue "Clear subchannel" and process condition code
322 ccode = csch (sch->schid);
324 sprintf (dbf_txt, "ccode:%d", ccode);
325 CIO_TRACE_EVENT (2, dbf_txt);
329 sch->schib.scsw.actl |= SCSW_ACTL_CLEAR_PEND;
331 default: /* device not operational */
337 * Function: cio_cancel
338 * Issues a "Cancel Subchannel" on the specified subchannel
339 * Note: We don't need any fancy intparms and flags here
340 * since xsch is executed synchronously.
341 * Only for common I/O internal use as for now.
344 cio_cancel (struct subchannel *sch)
352 CIO_TRACE_EVENT (2, "cancelIO");
353 CIO_TRACE_EVENT (2, sch->dev.bus_id);
355 ccode = xsch (sch->schid);
357 sprintf (dbf_txt, "ccode:%d", ccode);
358 CIO_TRACE_EVENT (2, dbf_txt);
361 case 0: /* success */
362 /* Update information in scsw. */
363 stsch (sch->schid, &sch->schib);
365 case 1: /* status pending */
367 case 2: /* not applicable */
369 default: /* not oper */
375 * Function: cio_modify
376 * Issues a "Modify Subchannel" on the specified subchannel
379 cio_modify (struct subchannel *sch)
381 int ccode, retry, ret;
384 for (retry = 0; retry < 5; retry++) {
385 ccode = msch_err (sch->schid, &sch->schib);
386 if (ccode < 0) /* -EIO if msch gets a program check. */
389 case 0: /* successfull */
391 case 1: /* status pending */
394 udelay (100); /* allow for recovery */
397 case 3: /* not operational */
408 cio_enable_subchannel (struct subchannel *sch, unsigned int isc)
415 CIO_TRACE_EVENT (2, "ensch");
416 CIO_TRACE_EVENT (2, sch->dev.bus_id);
418 ccode = stsch (sch->schid, &sch->schib);
422 for (retry = 5, ret = 0; retry > 0; retry--) {
423 sch->schib.pmcw.ena = 1;
424 sch->schib.pmcw.isc = isc;
425 sch->schib.pmcw.intparm = (__u32)(unsigned long)sch;
426 ret = cio_modify(sch);
431 * Got a program check in cio_modify. Try without
432 * the concurrent sense bit the next time.
434 sch->schib.pmcw.csense = 0;
436 stsch (sch->schid, &sch->schib);
437 if (sch->schib.pmcw.ena)
442 if (tsch(sch->schid, &irb) != 0)
446 sprintf (dbf_txt, "ret:%d", ret);
447 CIO_TRACE_EVENT (2, dbf_txt);
452 * Disable subchannel.
455 cio_disable_subchannel (struct subchannel *sch)
462 CIO_TRACE_EVENT (2, "dissch");
463 CIO_TRACE_EVENT (2, sch->dev.bus_id);
465 ccode = stsch (sch->schid, &sch->schib);
466 if (ccode == 3) /* Not operational. */
469 if (sch->schib.scsw.actl != 0)
471 * the disable function must not be called while there are
472 * requests pending for completion !
476 for (retry = 5, ret = 0; retry > 0; retry--) {
477 sch->schib.pmcw.ena = 0;
478 ret = cio_modify(sch);
483 * The subchannel is busy or status pending.
484 * We'll disable when the next interrupt was delivered
485 * via the state machine.
489 stsch (sch->schid, &sch->schib);
490 if (!sch->schib.pmcw.ena)
494 sprintf (dbf_txt, "ret:%d", ret);
495 CIO_TRACE_EVENT (2, dbf_txt);
500 * cio_validate_subchannel()
502 * Find out subchannel type and initialize struct subchannel.
504 * SUBCHANNEL_TYPE_IO for a normal io subchannel
505 * SUBCHANNEL_TYPE_CHSC for a chsc subchannel
506 * SUBCHANNEL_TYPE_MESSAGE for a messaging subchannel
507 * SUBCHANNEL_TYPE_ADM for a adm(?) subchannel
508 * -ENXIO for non-defined subchannels
509 * -ENODEV for subchannels with invalid device number or blacklisted devices
512 cio_validate_subchannel (struct subchannel *sch, struct subchannel_id schid)
517 sprintf (dbf_txt, "valsch%x", schid.sch_no);
518 CIO_TRACE_EVENT (4, dbf_txt);
520 /* Nuke all fields. */
521 memset(sch, 0, sizeof(struct subchannel));
523 spin_lock_init(&sch->lock);
525 /* Set a name for the subchannel */
526 snprintf (sch->dev.bus_id, BUS_ID_SIZE, "0.%x.%04x", schid.ssid,
530 * The first subchannel that is not-operational (ccode==3)
531 * indicates that there aren't any more devices available.
532 * If stsch gets an exception, it means the current subchannel set
535 ccode = stsch_err (schid, &sch->schib);
537 return (ccode == 3) ? -ENXIO : ccode;
540 /* Copy subchannel type from path management control word. */
541 sch->st = sch->schib.pmcw.st;
544 * ... just being curious we check for non I/O subchannels
547 CIO_DEBUG(KERN_INFO, 0,
548 "Subchannel 0.%x.%04x reports "
549 "non-I/O subchannel type %04X\n",
550 sch->schid.ssid, sch->schid.sch_no, sch->st);
551 /* We stop here for non-io subchannels. */
555 /* Initialization for io subchannels. */
556 if (!sch->schib.pmcw.dnv)
557 /* io subchannel but device number is invalid. */
560 /* Devno is valid. */
561 if (is_blacklisted (sch->schid.ssid, sch->schib.pmcw.dev)) {
563 * This device must not be known to Linux. So we simply
564 * say that there is no device and return ENODEV.
566 CIO_MSG_EVENT(0, "Blacklisted device detected "
567 "at devno %04X, subchannel set %x\n",
568 sch->schib.pmcw.dev, sch->schid.ssid);
572 if (!cio_is_console(sch->schid))
573 chsc_validate_chpids(sch);
574 sch->lpm = sch->schib.pmcw.pim &
575 sch->schib.pmcw.pam &
576 sch->schib.pmcw.pom &
579 CIO_DEBUG(KERN_INFO, 0,
580 "Detected device %04x on subchannel 0.%x.%04X"
581 " - PIM = %02X, PAM = %02X, POM = %02X\n",
582 sch->schib.pmcw.dev, sch->schid.ssid,
583 sch->schid.sch_no, sch->schib.pmcw.pim,
584 sch->schib.pmcw.pam, sch->schib.pmcw.pom);
587 * We now have to initially ...
588 * ... set "interruption subclass"
589 * ... enable "concurrent sense"
590 * ... enable "multipath mode" if more than one
591 * CHPID is available. This is done regardless
592 * whether multiple paths are available for us.
594 sch->schib.pmcw.isc = 3; /* could be smth. else */
595 sch->schib.pmcw.csense = 1; /* concurrent sense */
596 sch->schib.pmcw.ena = 0;
597 if ((sch->lpm & (sch->lpm - 1)) != 0)
598 sch->schib.pmcw.mp = 1; /* multipath mode */
603 * do_IRQ() handles all normal I/O device IRQ's (the special
604 * SMP cross-CPU interrupts have their own specific
609 do_IRQ (struct pt_regs *regs)
611 struct tpi_info *tpi_info;
612 struct subchannel *sch;
616 asm volatile ("mc 0,0");
617 if (S390_lowcore.int_clock >= S390_lowcore.jiffy_timer)
619 * Make sure that the i/o interrupt did not "overtake"
620 * the last HZ timer interrupt.
624 * Get interrupt information from lowcore
626 tpi_info = (struct tpi_info *) __LC_SUBCHANNEL_ID;
627 irb = (struct irb *) __LC_IRB;
629 kstat_cpu(smp_processor_id()).irqs[IO_INTERRUPT]++;
631 * Non I/O-subchannel thin interrupts are processed differently
633 if (tpi_info->adapter_IO == 1 &&
634 tpi_info->int_type == IO_INTERRUPT_TYPE) {
638 sch = (struct subchannel *)(unsigned long)tpi_info->intparm;
640 spin_lock(&sch->lock);
641 /* Store interrupt response block to lowcore. */
642 if (tsch (tpi_info->schid, irb) == 0 && sch) {
643 /* Keep subchannel information word up to date. */
644 memcpy (&sch->schib.scsw, &irb->scsw,
646 /* Call interrupt handler if there is one. */
647 if (sch->driver && sch->driver->irq)
648 sch->driver->irq(&sch->dev);
651 spin_unlock(&sch->lock);
653 * Are more interrupts pending?
654 * If so, the tpi instruction will update the lowcore
655 * to hold the info for the next interrupt.
656 * We don't do this for VM because a tpi drops the cpu
657 * out of the sie which costs more cycles than it saves.
659 } while (!MACHINE_IS_VM && tpi (NULL) != 0);
663 #ifdef CONFIG_CCW_CONSOLE
664 static struct subchannel console_subchannel;
665 static int console_subchannel_in_use;
668 * busy wait for the next interrupt on the console
673 unsigned long cr6 __attribute__ ((aligned (8)));
674 unsigned long save_cr6 __attribute__ ((aligned (8)));
677 * before entering the spinlock we may already have
678 * processed the interrupt on a different CPU...
680 if (!console_subchannel_in_use)
683 /* disable all but isc 7 (console device) */
684 __ctl_store (save_cr6, 6, 6);
686 __ctl_load (cr6, 6, 6);
689 spin_unlock(&console_subchannel.lock);
692 spin_lock(&console_subchannel.lock);
693 } while (console_subchannel.schib.scsw.actl != 0);
695 * restore previous isc value
697 __ctl_load (save_cr6, 6, 6);
701 cio_test_for_console(struct subchannel_id schid, void *data)
703 if (stsch_err(schid, &console_subchannel.schib) != 0)
705 if (console_subchannel.schib.pmcw.dnv &&
706 console_subchannel.schib.pmcw.dev ==
708 console_irq = schid.sch_no;
709 return 1; /* found */
716 cio_get_console_sch_no(void)
718 struct subchannel_id schid;
720 init_subchannel_id(&schid);
721 if (console_irq != -1) {
722 /* VM provided us with the irq number of the console. */
723 schid.sch_no = console_irq;
724 if (stsch(schid, &console_subchannel.schib) != 0 ||
725 !console_subchannel.schib.pmcw.dnv)
727 console_devno = console_subchannel.schib.pmcw.dev;
728 } else if (console_devno != -1) {
729 /* At least the console device number is known. */
730 for_each_subchannel(cio_test_for_console, NULL);
731 if (console_irq == -1)
734 /* unlike in 2.4, we cannot autoprobe here, since
735 * the channel subsystem is not fully initialized.
736 * With some luck, the HWC console can take over */
737 printk(KERN_WARNING "No ccw console found!\n");
744 cio_probe_console(void)
747 struct subchannel_id schid;
749 if (xchg(&console_subchannel_in_use, 1) != 0)
750 return ERR_PTR(-EBUSY);
751 sch_no = cio_get_console_sch_no();
753 console_subchannel_in_use = 0;
754 return ERR_PTR(-ENODEV);
756 memset(&console_subchannel, 0, sizeof(struct subchannel));
757 init_subchannel_id(&schid);
758 schid.sch_no = sch_no;
759 ret = cio_validate_subchannel(&console_subchannel, schid);
761 console_subchannel_in_use = 0;
762 return ERR_PTR(-ENODEV);
766 * enable console I/O-interrupt subclass 7
769 console_subchannel.schib.pmcw.isc = 7;
770 console_subchannel.schib.pmcw.intparm =
771 (__u32)(unsigned long)&console_subchannel;
772 ret = cio_modify(&console_subchannel);
774 console_subchannel_in_use = 0;
777 return &console_subchannel;
781 cio_release_console(void)
783 console_subchannel.schib.pmcw.intparm = 0;
784 cio_modify(&console_subchannel);
785 ctl_clear_bit(6, 24);
786 console_subchannel_in_use = 0;
789 /* Bah... hack to catch console special sausages. */
791 cio_is_console(struct subchannel_id schid)
793 if (!console_subchannel_in_use)
795 return schid_equal(&schid, &console_subchannel.schid);
799 cio_get_console_subchannel(void)
801 if (!console_subchannel_in_use)
803 return &console_subchannel;
808 __disable_subchannel_easy(struct subchannel_id schid, struct schib *schib)
813 for (retry=0;retry<3;retry++) {
815 cc = msch(schid, schib);
817 return (cc==3?-ENODEV:-EBUSY);
819 if (!schib->pmcw.ena)
822 return -EBUSY; /* uhm... */
826 __clear_subchannel_easy(struct subchannel_id schid)
832 for (retry=0;retry<20;retry++) {
836 tsch(ti.schid, (struct irb *)__LC_IRB);
837 if (schid_equal(&ti.schid, &schid))
845 extern void do_reipl(unsigned long devno);
847 __shutdown_subchannel_easy(struct subchannel_id schid, void *data)
851 if (stsch_err(schid, &schib))
855 switch(__disable_subchannel_easy(schid, &schib)) {
859 default: /* -EBUSY */
860 if (__clear_subchannel_easy(schid))
861 break; /* give up... */
862 stsch(schid, &schib);
863 __disable_subchannel_easy(schid, &schib);
869 clear_all_subchannels(void)
872 for_each_subchannel(__shutdown_subchannel_easy, NULL);
875 /* Make sure all subchannels are quiet before we re-ipl an lpar. */
877 reipl(unsigned long devno)
879 clear_all_subchannels();