[S390] cio: Base message subchannel handling.
[linux-2.6] / drivers / s390 / cio / cio.h
1 #ifndef S390_CIO_H
2 #define S390_CIO_H
3
4 #include <linux/mutex.h>
5 #include <linux/device.h>
6 #include <linux/mod_devicetable.h>
7 #include <asm/chpid.h>
8 #include "chsc.h"
9 #include "schid.h"
10
11 /*
12  * path management control word
13  */
14 struct pmcw {
15         u32 intparm;            /* interruption parameter */
16         u32 qf   : 1;           /* qdio facility */
17         u32 w    : 1;
18         u32 isc  : 3;           /* interruption sublass */
19         u32 res5 : 3;           /* reserved zeros */
20         u32 ena  : 1;           /* enabled */
21         u32 lm   : 2;           /* limit mode */
22         u32 mme  : 2;           /* measurement-mode enable */
23         u32 mp   : 1;           /* multipath mode */
24         u32 tf   : 1;           /* timing facility */
25         u32 dnv  : 1;           /* device number valid */
26         u32 dev  : 16;          /* device number */
27         u8  lpm;                /* logical path mask */
28         u8  pnom;               /* path not operational mask */
29         u8  lpum;               /* last path used mask */
30         u8  pim;                /* path installed mask */
31         u16 mbi;                /* measurement-block index */
32         u8  pom;                /* path operational mask */
33         u8  pam;                /* path available mask */
34         u8  chpid[8];           /* CHPID 0-7 (if available) */
35         u32 unused1 : 8;        /* reserved zeros */
36         u32 st      : 3;        /* subchannel type */
37         u32 unused2 : 18;       /* reserved zeros */
38         u32 mbfc    : 1;        /* measurement block format control */
39         u32 xmwme   : 1;        /* extended measurement word mode enable */
40         u32 csense  : 1;        /* concurrent sense; can be enabled ...*/
41                                 /*  ... per MSCH, however, if facility */
42                                 /*  ... is not installed, this results */
43                                 /*  ... in an operand exception.       */
44 } __attribute__ ((packed));
45
46 /*
47  * subchannel information block
48  */
49 struct schib {
50         struct pmcw pmcw;        /* path management control word */
51         struct scsw scsw;        /* subchannel status word */
52         __u64 mba;               /* measurement block address */
53         __u8 mda[4];             /* model dependent area */
54 } __attribute__ ((packed,aligned(4)));
55
56 /* subchannel data structure used by I/O subroutines */
57 struct subchannel {
58         struct subchannel_id schid;
59         spinlock_t *lock;       /* subchannel lock */
60         struct mutex reg_mutex;
61         enum {
62                 SUBCHANNEL_TYPE_IO = 0,
63                 SUBCHANNEL_TYPE_CHSC = 1,
64                 SUBCHANNEL_TYPE_MSG = 2,
65                 SUBCHANNEL_TYPE_ADM = 3,
66         } st;                   /* subchannel type */
67
68         struct {
69                 unsigned int suspend:1; /* allow suspend */
70                 unsigned int prefetch:1;/* deny prefetch */
71                 unsigned int inter:1;   /* suppress intermediate interrupts */
72         } __attribute__ ((packed)) options;
73
74         __u8 vpm;               /* verified path mask */
75         __u8 lpm;               /* logical path mask */
76         __u8 opm;               /* operational path mask */
77         struct schib schib;     /* subchannel information block */
78         int isc; /* desired interruption subclass */
79         struct chsc_ssd_info ssd_info;  /* subchannel description */
80         struct device dev;      /* entry in device tree */
81         struct css_driver *driver;
82         void *private; /* private per subchannel type data */
83 } __attribute__ ((aligned(8)));
84
85 #define IO_INTERRUPT_TYPE          0 /* I/O interrupt type */
86
87 #define to_subchannel(n) container_of(n, struct subchannel, dev)
88
89 extern int cio_validate_subchannel (struct subchannel *, struct subchannel_id);
90 extern int cio_enable_subchannel(struct subchannel *, u32);
91 extern int cio_disable_subchannel (struct subchannel *);
92 extern int cio_cancel (struct subchannel *);
93 extern int cio_clear (struct subchannel *);
94 extern int cio_resume (struct subchannel *);
95 extern int cio_halt (struct subchannel *);
96 extern int cio_start (struct subchannel *, struct ccw1 *, __u8);
97 extern int cio_start_key (struct subchannel *, struct ccw1 *, __u8, __u8);
98 extern int cio_cancel (struct subchannel *);
99 extern int cio_set_options (struct subchannel *, int);
100 extern int cio_get_options (struct subchannel *);
101 extern int cio_modify (struct subchannel *);
102
103 int cio_create_sch_lock(struct subchannel *);
104 void do_adapter_IO(void);
105 void do_IRQ(struct pt_regs *);
106
107 /* Use with care. */
108 #ifdef CONFIG_CCW_CONSOLE
109 extern struct subchannel *cio_probe_console(void);
110 extern void cio_release_console(void);
111 extern int cio_is_console(struct subchannel_id);
112 extern struct subchannel *cio_get_console_subchannel(void);
113 extern spinlock_t * cio_get_console_lock(void);
114 extern void *cio_get_console_priv(void);
115 #else
116 #define cio_is_console(schid) 0
117 #define cio_get_console_subchannel() NULL
118 #define cio_get_console_lock() NULL
119 #define cio_get_console_priv() NULL
120 #endif
121
122 #endif