xref: /openbmc/linux/drivers/s390/cio/device.h (revision 64c70b1c)
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 
8 /*
9  * states of the device statemachine
10  */
11 enum dev_state {
12 	DEV_STATE_NOT_OPER,
13 	DEV_STATE_SENSE_PGID,
14 	DEV_STATE_SENSE_ID,
15 	DEV_STATE_OFFLINE,
16 	DEV_STATE_VERIFY,
17 	DEV_STATE_ONLINE,
18 	DEV_STATE_W4SENSE,
19 	DEV_STATE_DISBAND_PGID,
20 	DEV_STATE_BOXED,
21 	/* states to wait for i/o completion before doing something */
22 	DEV_STATE_CLEAR_VERIFY,
23 	DEV_STATE_TIMEOUT_KILL,
24 	DEV_STATE_QUIESCE,
25 	/* special states for devices gone not operational */
26 	DEV_STATE_DISCONNECTED,
27 	DEV_STATE_DISCONNECTED_SENSE_ID,
28 	DEV_STATE_CMFCHANGE,
29 	DEV_STATE_CMFUPDATE,
30 	/* last element! */
31 	NR_DEV_STATES
32 };
33 
34 /*
35  * asynchronous events of the device statemachine
36  */
37 enum dev_event {
38 	DEV_EVENT_NOTOPER,
39 	DEV_EVENT_INTERRUPT,
40 	DEV_EVENT_TIMEOUT,
41 	DEV_EVENT_VERIFY,
42 	/* last element! */
43 	NR_DEV_EVENTS
44 };
45 
46 struct ccw_device;
47 
48 /*
49  * action called through jumptable
50  */
51 typedef void (fsm_func_t)(struct ccw_device *, enum dev_event);
52 extern fsm_func_t *dev_jumptable[NR_DEV_STATES][NR_DEV_EVENTS];
53 
54 static inline void
55 dev_fsm_event(struct ccw_device *cdev, enum dev_event dev_event)
56 {
57 	dev_jumptable[cdev->private->state][dev_event](cdev, dev_event);
58 }
59 
60 /*
61  * Delivers 1 if the device state is final.
62  */
63 static inline int
64 dev_fsm_final_state(struct ccw_device *cdev)
65 {
66 	return (cdev->private->state == DEV_STATE_NOT_OPER ||
67 		cdev->private->state == DEV_STATE_OFFLINE ||
68 		cdev->private->state == DEV_STATE_ONLINE ||
69 		cdev->private->state == DEV_STATE_BOXED);
70 }
71 
72 extern struct workqueue_struct *ccw_device_work;
73 extern struct workqueue_struct *ccw_device_notify_work;
74 extern wait_queue_head_t ccw_device_init_wq;
75 extern atomic_t ccw_device_init_count;
76 
77 void io_subchannel_irq (struct device *pdev);
78 void io_subchannel_recog_done(struct ccw_device *cdev);
79 
80 int ccw_device_cancel_halt_clear(struct ccw_device *);
81 
82 void ccw_device_do_unreg_rereg(struct work_struct *);
83 void ccw_device_call_sch_unregister(struct work_struct *);
84 void ccw_device_move_to_orphanage(struct work_struct *);
85 int ccw_device_is_orphan(struct ccw_device *);
86 
87 int ccw_device_recognition(struct ccw_device *);
88 int ccw_device_online(struct ccw_device *);
89 int ccw_device_offline(struct ccw_device *);
90 
91 /* Function prototypes for device status and basic sense stuff. */
92 void ccw_device_accumulate_irb(struct ccw_device *, struct irb *);
93 void ccw_device_accumulate_basic_sense(struct ccw_device *, struct irb *);
94 int ccw_device_accumulate_and_sense(struct ccw_device *, struct irb *);
95 int ccw_device_do_sense(struct ccw_device *, struct irb *);
96 
97 /* Function prototypes for sense id stuff. */
98 void ccw_device_sense_id_start(struct ccw_device *);
99 void ccw_device_sense_id_irq(struct ccw_device *, enum dev_event);
100 void ccw_device_sense_id_done(struct ccw_device *, int);
101 
102 /* Function prototypes for path grouping stuff. */
103 void ccw_device_sense_pgid_start(struct ccw_device *);
104 void ccw_device_sense_pgid_irq(struct ccw_device *, enum dev_event);
105 void ccw_device_sense_pgid_done(struct ccw_device *, int);
106 
107 void ccw_device_verify_start(struct ccw_device *);
108 void ccw_device_verify_irq(struct ccw_device *, enum dev_event);
109 void ccw_device_verify_done(struct ccw_device *, int);
110 
111 void ccw_device_disband_start(struct ccw_device *);
112 void ccw_device_disband_irq(struct ccw_device *, enum dev_event);
113 void ccw_device_disband_done(struct ccw_device *, int);
114 
115 int ccw_device_call_handler(struct ccw_device *);
116 
117 int ccw_device_stlck(struct ccw_device *);
118 
119 /* qdio needs this. */
120 void ccw_device_set_timeout(struct ccw_device *, int);
121 extern struct subchannel_id ccw_device_get_subchannel_id(struct ccw_device *);
122 extern struct bus_type ccw_bus_type;
123 
124 /* Channel measurement facility related */
125 void retry_set_schib(struct ccw_device *cdev);
126 void cmf_retry_copy_block(struct ccw_device *);
127 int cmf_reenable(struct ccw_device *);
128 #endif
129