xref: /kernel/linux/linux-5.10/drivers/s390/cio/cio.h (revision 8c2ecf20)
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef S390_CIO_H
3#define S390_CIO_H
4
5#include <linux/mutex.h>
6#include <linux/device.h>
7#include <linux/mod_devicetable.h>
8#include <asm/chpid.h>
9#include <asm/cio.h>
10#include <asm/fcx.h>
11#include <asm/schid.h>
12#include "chsc.h"
13
14/*
15 * path management control word
16 */
17struct pmcw {
18	u32 intparm;		/* interruption parameter */
19	u32 qf	 : 1;		/* qdio facility */
20	u32 w	 : 1;
21	u32 isc  : 3;		/* interruption sublass */
22	u32 res5 : 3;		/* reserved zeros */
23	u32 ena  : 1;		/* enabled */
24	u32 lm	 : 2;		/* limit mode */
25	u32 mme  : 2;		/* measurement-mode enable */
26	u32 mp	 : 1;		/* multipath mode */
27	u32 tf	 : 1;		/* timing facility */
28	u32 dnv  : 1;		/* device number valid */
29	u32 dev  : 16;		/* device number */
30	u8  lpm;		/* logical path mask */
31	u8  pnom;		/* path not operational mask */
32	u8  lpum;		/* last path used mask */
33	u8  pim;		/* path installed mask */
34	u16 mbi;		/* measurement-block index */
35	u8  pom;		/* path operational mask */
36	u8  pam;		/* path available mask */
37	u8  chpid[8];		/* CHPID 0-7 (if available) */
38	u32 unused1 : 8;	/* reserved zeros */
39	u32 st	    : 3;	/* subchannel type */
40	u32 unused2 : 18;	/* reserved zeros */
41	u32 mbfc    : 1;	/* measurement block format control */
42	u32 xmwme   : 1;	/* extended measurement word mode enable */
43	u32 csense  : 1;	/* concurrent sense; can be enabled ...*/
44				/*  ... per MSCH, however, if facility */
45				/*  ... is not installed, this results */
46				/*  ... in an operand exception.       */
47} __attribute__ ((packed));
48
49/* I/O-Interruption Code as stored by TEST PENDING INTERRUPTION (TPI). */
50struct tpi_info {
51	struct subchannel_id schid;
52	u32 intparm;
53	u32 adapter_IO:1;
54	u32 directed_irq:1;
55	u32 isc:3;
56	u32 :27;
57	u32 type:3;
58	u32 :12;
59} __packed __aligned(4);
60
61/* Target SCHIB configuration. */
62struct schib_config {
63	u64 mba;
64	u32 intparm;
65	u16 mbi;
66	u32 isc:3;
67	u32 ena:1;
68	u32 mme:2;
69	u32 mp:1;
70	u32 csense:1;
71	u32 mbfc:1;
72} __attribute__ ((packed));
73
74/*
75 * subchannel information block
76 */
77struct schib {
78	struct pmcw pmcw;	 /* path management control word */
79	union scsw scsw;	 /* subchannel status word */
80	__u64 mba;               /* measurement block address */
81	__u8 mda[4];		 /* model dependent area */
82} __attribute__ ((packed,aligned(4)));
83
84/*
85 * When rescheduled, todo's with higher values will overwrite those
86 * with lower values.
87 */
88enum sch_todo {
89	SCH_TODO_NOTHING,
90	SCH_TODO_EVAL,
91	SCH_TODO_UNREG,
92};
93
94/* subchannel data structure used by I/O subroutines */
95struct subchannel {
96	struct subchannel_id schid;
97	spinlock_t *lock;	/* subchannel lock */
98	struct mutex reg_mutex;
99	enum {
100		SUBCHANNEL_TYPE_IO = 0,
101		SUBCHANNEL_TYPE_CHSC = 1,
102		SUBCHANNEL_TYPE_MSG = 2,
103		SUBCHANNEL_TYPE_ADM = 3,
104	} st;			/* subchannel type */
105	__u8 vpm;		/* verified path mask */
106	__u8 lpm;		/* logical path mask */
107	__u8 opm;               /* operational path mask */
108	struct schib schib;	/* subchannel information block */
109	int isc; /* desired interruption subclass */
110	struct chsc_ssd_info ssd_info;	/* subchannel description */
111	struct device dev;	/* entry in device tree */
112	struct css_driver *driver;
113	enum sch_todo todo;
114	struct work_struct todo_work;
115	struct schib_config config;
116	u64 dma_mask;
117	char *driver_override; /* Driver name to force a match */
118} __attribute__ ((aligned(8)));
119
120DECLARE_PER_CPU_ALIGNED(struct irb, cio_irb);
121
122#define to_subchannel(n) container_of(n, struct subchannel, dev)
123
124extern int cio_enable_subchannel(struct subchannel *, u32);
125extern int cio_disable_subchannel (struct subchannel *);
126extern int cio_cancel (struct subchannel *);
127extern int cio_clear (struct subchannel *);
128extern int cio_cancel_halt_clear(struct subchannel *, int *);
129extern int cio_resume (struct subchannel *);
130extern int cio_halt (struct subchannel *);
131extern int cio_start (struct subchannel *, struct ccw1 *, __u8);
132extern int cio_start_key (struct subchannel *, struct ccw1 *, __u8, __u8);
133extern int cio_set_options (struct subchannel *, int);
134extern int cio_update_schib(struct subchannel *sch);
135extern int cio_commit_config(struct subchannel *sch);
136
137int cio_tm_start_key(struct subchannel *sch, struct tcw *tcw, u8 lpm, u8 key);
138int cio_tm_intrg(struct subchannel *sch);
139
140extern int __init airq_init(void);
141
142/* Use with care. */
143#ifdef CONFIG_CCW_CONSOLE
144extern struct subchannel *cio_probe_console(void);
145extern int cio_is_console(struct subchannel_id);
146extern void cio_register_early_subchannels(void);
147extern void cio_tsch(struct subchannel *sch);
148#else
149#define cio_is_console(schid) 0
150static inline void cio_register_early_subchannels(void) {}
151#endif
152
153#endif
154