xref: /openbmc/linux/drivers/s390/cio/device.h (revision e6dec923) 
1 #ifndef S390_DEVICE_H
2 #define S390_DEVICE_H
3 
4 #include <asm/ccwdev.h>
5 #include <linux/atomic.h>
6 #include <linux/wait.h>
7 #include <linux/notifier.h>
8 #include <linux/kernel_stat.h>
9 #include "io_sch.h"
10 
11 /*
12  * states of the device statemachine
13  */
14 enum dev_state {
15 	DEV_STATE_NOT_OPER,
16 	DEV_STATE_SENSE_ID,
17 	DEV_STATE_OFFLINE,
18 	DEV_STATE_VERIFY,
19 	DEV_STATE_ONLINE,
20 	DEV_STATE_W4SENSE,
21 	DEV_STATE_DISBAND_PGID,
22 	DEV_STATE_BOXED,
23 	/* states to wait for i/o completion before doing something */
24 	DEV_STATE_TIMEOUT_KILL,
25 	DEV_STATE_QUIESCE,
26 	/* special states for devices gone not operational */
27 	DEV_STATE_DISCONNECTED,
28 	DEV_STATE_DISCONNECTED_SENSE_ID,
29 	DEV_STATE_CMFCHANGE,
30 	DEV_STATE_CMFUPDATE,
31 	DEV_STATE_STEAL_LOCK,
32 	/* last element! */
33 	NR_DEV_STATES
34 };
35 
36 /*
37  * asynchronous events of the device statemachine
38  */
39 enum dev_event {
40 	DEV_EVENT_NOTOPER,
41 	DEV_EVENT_INTERRUPT,
42 	DEV_EVENT_TIMEOUT,
43 	DEV_EVENT_VERIFY,
44 	/* last element! */
45 	NR_DEV_EVENTS
46 };
47 
48 struct ccw_device;
49 
50 /*
51  * action called through jumptable
52  */
53 typedef void (fsm_func_t)(struct ccw_device *, enum dev_event);
54 extern fsm_func_t *dev_jumptable[NR_DEV_STATES][NR_DEV_EVENTS];
55 
56 static inline void
57 dev_fsm_event(struct ccw_device *cdev, enum dev_event dev_event)
58 {
59 	int state = cdev->private->state;
60 
61 	if (dev_event == DEV_EVENT_INTERRUPT) {
62 		if (state == DEV_STATE_ONLINE)
63 			inc_irq_stat(cdev->private->int_class);
64 		else if (state != DEV_STATE_CMFCHANGE &&
65 			 state != DEV_STATE_CMFUPDATE)
66 			inc_irq_stat(IRQIO_CIO);
67 	}
68 	dev_jumptable[state][dev_event](cdev, dev_event);
69 }
70 
71 /*
72  * Delivers 1 if the device state is final.
73  */
74 static inline int
75 dev_fsm_final_state(struct ccw_device *cdev)
76 {
77 	return (cdev->private->state == DEV_STATE_NOT_OPER ||
78 		cdev->private->state == DEV_STATE_OFFLINE ||
79 		cdev->private->state == DEV_STATE_ONLINE ||
80 		cdev->private->state == DEV_STATE_BOXED);
81 }
82 
83 int __init io_subchannel_init(void);
84 
85 void io_subchannel_recog_done(struct ccw_device *cdev);
86 void io_subchannel_init_config(struct subchannel *sch);
87 
88 int ccw_device_cancel_halt_clear(struct ccw_device *);
89 
90 int ccw_device_is_orphan(struct ccw_device *);
91 
92 void ccw_device_recognition(struct ccw_device *);
93 int ccw_device_online(struct ccw_device *);
94 int ccw_device_offline(struct ccw_device *);
95 void ccw_device_update_sense_data(struct ccw_device *);
96 int ccw_device_test_sense_data(struct ccw_device *);
97 void ccw_device_schedule_sch_unregister(struct ccw_device *);
98 int ccw_purge_blacklisted(void);
99 void ccw_device_sched_todo(struct ccw_device *cdev, enum cdev_todo todo);
100 struct ccw_device *get_ccwdev_by_dev_id(struct ccw_dev_id *dev_id);
101 
102 /* Function prototypes for device status and basic sense stuff. */
103 void ccw_device_accumulate_irb(struct ccw_device *, struct irb *);
104 void ccw_device_accumulate_basic_sense(struct ccw_device *, struct irb *);
105 int ccw_device_accumulate_and_sense(struct ccw_device *, struct irb *);
106 int ccw_device_do_sense(struct ccw_device *, struct irb *);
107 
108 /* Function prototype for internal request handling. */
109 int lpm_adjust(int lpm, int mask);
110 void ccw_request_start(struct ccw_device *);
111 int ccw_request_cancel(struct ccw_device *cdev);
112 void ccw_request_handler(struct ccw_device *cdev);
113 void ccw_request_timeout(struct ccw_device *cdev);
114 void ccw_request_notoper(struct ccw_device *cdev);
115 
116 /* Function prototypes for sense id stuff. */
117 void ccw_device_sense_id_start(struct ccw_device *);
118 void ccw_device_sense_id_done(struct ccw_device *, int);
119 
120 /* Function prototypes for path grouping stuff. */
121 void ccw_device_verify_start(struct ccw_device *);
122 void ccw_device_verify_done(struct ccw_device *, int);
123 
124 void ccw_device_disband_start(struct ccw_device *);
125 void ccw_device_disband_done(struct ccw_device *, int);
126 
127 int ccw_device_stlck(struct ccw_device *);
128 
129 /* Helper function for machine check handling. */
130 void ccw_device_trigger_reprobe(struct ccw_device *);
131 void ccw_device_kill_io(struct ccw_device *);
132 int ccw_device_notify(struct ccw_device *, int);
133 void ccw_device_set_disconnected(struct ccw_device *cdev);
134 void ccw_device_set_notoper(struct ccw_device *cdev);
135 
136 void ccw_device_set_timeout(struct ccw_device *, int);
137 
138 /* Channel measurement facility related */
139 void retry_set_schib(struct ccw_device *cdev);
140 void cmf_retry_copy_block(struct ccw_device *);
141 int cmf_reenable(struct ccw_device *);
142 void cmf_reactivate(void);
143 int ccw_set_cmf(struct ccw_device *cdev, int enable);
144 extern struct device_attribute dev_attr_cmb_enable;
145 #endif
146