xref: /openbmc/linux/drivers/s390/cio/device.h (revision 4800cd83)
1 #ifndef S390_DEVICE_H
2 #define S390_DEVICE_H
3 
4 #include <asm/ccwdev.h>
5 #include <asm/atomic.h>
6 #include <linux/wait.h>
7 #include <linux/notifier.h>
8 #include "io_sch.h"
9 
10 /*
11  * states of the device statemachine
12  */
13 enum dev_state {
14 	DEV_STATE_NOT_OPER,
15 	DEV_STATE_SENSE_PGID,
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 	dev_jumptable[cdev->private->state][dev_event](cdev, dev_event);
60 }
61 
62 /*
63  * Delivers 1 if the device state is final.
64  */
65 static inline int
66 dev_fsm_final_state(struct ccw_device *cdev)
67 {
68 	return (cdev->private->state == DEV_STATE_NOT_OPER ||
69 		cdev->private->state == DEV_STATE_OFFLINE ||
70 		cdev->private->state == DEV_STATE_ONLINE ||
71 		cdev->private->state == DEV_STATE_BOXED);
72 }
73 
74 extern wait_queue_head_t ccw_device_init_wq;
75 extern atomic_t ccw_device_init_count;
76 int __init io_subchannel_init(void);
77 
78 void io_subchannel_recog_done(struct ccw_device *cdev);
79 void io_subchannel_init_config(struct subchannel *sch);
80 
81 int ccw_device_cancel_halt_clear(struct ccw_device *);
82 
83 int ccw_device_is_orphan(struct ccw_device *);
84 
85 void ccw_device_recognition(struct ccw_device *);
86 int ccw_device_online(struct ccw_device *);
87 int ccw_device_offline(struct ccw_device *);
88 void ccw_device_update_sense_data(struct ccw_device *);
89 int ccw_device_test_sense_data(struct ccw_device *);
90 void ccw_device_schedule_sch_unregister(struct ccw_device *);
91 int ccw_purge_blacklisted(void);
92 void ccw_device_sched_todo(struct ccw_device *cdev, enum cdev_todo todo);
93 
94 /* Function prototypes for device status and basic sense stuff. */
95 void ccw_device_accumulate_irb(struct ccw_device *, struct irb *);
96 void ccw_device_accumulate_basic_sense(struct ccw_device *, struct irb *);
97 int ccw_device_accumulate_and_sense(struct ccw_device *, struct irb *);
98 int ccw_device_do_sense(struct ccw_device *, struct irb *);
99 
100 /* Function prototype for internal request handling. */
101 int lpm_adjust(int lpm, int mask);
102 void ccw_request_start(struct ccw_device *);
103 int ccw_request_cancel(struct ccw_device *cdev);
104 void ccw_request_handler(struct ccw_device *cdev);
105 void ccw_request_timeout(struct ccw_device *cdev);
106 void ccw_request_notoper(struct ccw_device *cdev);
107 
108 /* Function prototypes for sense id stuff. */
109 void ccw_device_sense_id_start(struct ccw_device *);
110 void ccw_device_sense_id_done(struct ccw_device *, int);
111 
112 /* Function prototypes for path grouping stuff. */
113 void ccw_device_verify_start(struct ccw_device *);
114 void ccw_device_verify_done(struct ccw_device *, int);
115 
116 void ccw_device_disband_start(struct ccw_device *);
117 void ccw_device_disband_done(struct ccw_device *, int);
118 
119 void ccw_device_stlck_start(struct ccw_device *, void *, void *, void *);
120 void ccw_device_stlck_done(struct ccw_device *, void *, int);
121 
122 int ccw_device_call_handler(struct ccw_device *);
123 
124 int ccw_device_stlck(struct ccw_device *);
125 
126 /* Helper function for machine check handling. */
127 void ccw_device_trigger_reprobe(struct ccw_device *);
128 void ccw_device_kill_io(struct ccw_device *);
129 int ccw_device_notify(struct ccw_device *, int);
130 void ccw_device_set_disconnected(struct ccw_device *cdev);
131 void ccw_device_set_notoper(struct ccw_device *cdev);
132 
133 /* qdio needs this. */
134 void ccw_device_set_timeout(struct ccw_device *, int);
135 extern struct subchannel_id ccw_device_get_subchannel_id(struct ccw_device *);
136 extern struct bus_type ccw_bus_type;
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 int ccw_set_cmf(struct ccw_device *cdev, int enable);
143 extern struct device_attribute dev_attr_cmb_enable;
144 #endif
145