xref: /linux/drivers/s390/cio/css.h (revision 827634added7f38b7d724cab1dccdb2b004c13c3)
1 #ifndef _CSS_H
2 #define _CSS_H
3 
4 #include <linux/mutex.h>
5 #include <linux/wait.h>
6 #include <linux/workqueue.h>
7 #include <linux/device.h>
8 #include <linux/types.h>
9 
10 #include <asm/cio.h>
11 #include <asm/chpid.h>
12 #include <asm/schid.h>
13 
14 #include "cio.h"
15 
16 /*
17  * path grouping stuff
18  */
19 #define SPID_FUNC_SINGLE_PATH	   0x00
20 #define SPID_FUNC_MULTI_PATH	   0x80
21 #define SPID_FUNC_ESTABLISH	   0x00
22 #define SPID_FUNC_RESIGN	   0x40
23 #define SPID_FUNC_DISBAND	   0x20
24 
25 #define SNID_STATE1_RESET	   0
26 #define SNID_STATE1_UNGROUPED	   2
27 #define SNID_STATE1_GROUPED	   3
28 
29 #define SNID_STATE2_NOT_RESVD	   0
30 #define SNID_STATE2_RESVD_ELSE	   2
31 #define SNID_STATE2_RESVD_SELF	   3
32 
33 #define SNID_STATE3_MULTI_PATH	   1
34 #define SNID_STATE3_SINGLE_PATH	   0
35 
36 struct path_state {
37 	__u8  state1 : 2;	/* path state value 1 */
38 	__u8  state2 : 2;	/* path state value 2 */
39 	__u8  state3 : 1;	/* path state value 3 */
40 	__u8  resvd  : 3;	/* reserved */
41 } __attribute__ ((packed));
42 
43 struct extended_cssid {
44 	u8 version;
45 	u8 cssid;
46 } __attribute__ ((packed));
47 
48 struct pgid {
49 	union {
50 		__u8 fc;   	/* SPID function code */
51 		struct path_state ps;	/* SNID path state */
52 	} __attribute__ ((packed)) inf;
53 	union {
54 		__u32 cpu_addr	: 16;	/* CPU address */
55 		struct extended_cssid ext_cssid;
56 	} __attribute__ ((packed)) pgid_high;
57 	__u32 cpu_id	: 24;	/* CPU identification */
58 	__u32 cpu_model : 16;	/* CPU model */
59 	__u32 tod_high;		/* high word TOD clock */
60 } __attribute__ ((packed));
61 
62 struct subchannel;
63 struct chp_link;
64 /**
65  * struct css_driver - device driver for subchannels
66  * @subchannel_type: subchannel type supported by this driver
67  * @drv: embedded device driver structure
68  * @irq: called on interrupts
69  * @chp_event: called for events affecting a channel path
70  * @sch_event: called for events affecting the subchannel
71  * @probe: function called on probe
72  * @remove: function called on remove
73  * @shutdown: called at device shutdown
74  * @prepare: prepare for pm state transition
75  * @complete: undo work done in @prepare
76  * @freeze: callback for freezing during hibernation snapshotting
77  * @thaw: undo work done in @freeze
78  * @restore: callback for restoring after hibernation
79  * @settle: wait for asynchronous work to finish
80  */
81 struct css_driver {
82 	struct css_device_id *subchannel_type;
83 	struct device_driver drv;
84 	void (*irq)(struct subchannel *);
85 	int (*chp_event)(struct subchannel *, struct chp_link *, int);
86 	int (*sch_event)(struct subchannel *, int);
87 	int (*probe)(struct subchannel *);
88 	int (*remove)(struct subchannel *);
89 	void (*shutdown)(struct subchannel *);
90 	int (*prepare) (struct subchannel *);
91 	void (*complete) (struct subchannel *);
92 	int (*freeze)(struct subchannel *);
93 	int (*thaw) (struct subchannel *);
94 	int (*restore)(struct subchannel *);
95 	int (*settle)(void);
96 };
97 
98 #define to_cssdriver(n) container_of(n, struct css_driver, drv)
99 
100 extern int css_driver_register(struct css_driver *);
101 extern void css_driver_unregister(struct css_driver *);
102 
103 extern void css_sch_device_unregister(struct subchannel *);
104 extern int css_register_subchannel(struct subchannel *);
105 extern struct subchannel *css_alloc_subchannel(struct subchannel_id);
106 extern struct subchannel *get_subchannel_by_schid(struct subchannel_id);
107 extern int css_init_done;
108 extern int max_ssid;
109 int for_each_subchannel_staged(int (*fn_known)(struct subchannel *, void *),
110 			       int (*fn_unknown)(struct subchannel_id,
111 			       void *), void *data);
112 extern int for_each_subchannel(int(*fn)(struct subchannel_id, void *), void *);
113 void css_update_ssd_info(struct subchannel *sch);
114 
115 struct channel_subsystem {
116 	u8 cssid;
117 	int valid;
118 	struct channel_path *chps[__MAX_CHPID + 1];
119 	struct device device;
120 	struct pgid global_pgid;
121 	struct mutex mutex;
122 	/* channel measurement related */
123 	int cm_enabled;
124 	void *cub_addr1;
125 	void *cub_addr2;
126 	/* for orphaned ccw devices */
127 	struct subchannel *pseudo_subchannel;
128 };
129 #define to_css(dev) container_of(dev, struct channel_subsystem, device)
130 
131 extern struct channel_subsystem *channel_subsystems[];
132 
133 /* Helper functions to build lists for the slow path. */
134 void css_schedule_eval(struct subchannel_id schid);
135 void css_schedule_eval_all(void);
136 void css_schedule_eval_all_unreg(unsigned long delay);
137 int css_complete_work(void);
138 
139 int sch_is_pseudo_sch(struct subchannel *);
140 struct schib;
141 int css_sch_is_valid(struct schib *);
142 
143 extern struct workqueue_struct *cio_work_q;
144 void css_wait_for_slow_path(void);
145 void css_sched_sch_todo(struct subchannel *sch, enum sch_todo todo);
146 #endif
147