[mirror_ubuntu-zesty-kernel.git] / drivers / s390 / cio / device.h

#ifndef S390_DEVICE_H
#define S390_DEVICE_H

#include <asm/ccwdev.h>
#include <linux/atomic.h>
#include <linux/wait.h>
#include <linux/notifier.h>
#include <linux/kernel_stat.h>
#include "io_sch.h"

/*
 * states of the device statemachine
 */
enum dev_state {
	DEV_STATE_NOT_OPER,
	DEV_STATE_SENSE_PGID,
	DEV_STATE_SENSE_ID,
	DEV_STATE_OFFLINE,
	DEV_STATE_VERIFY,
	DEV_STATE_ONLINE,
	DEV_STATE_W4SENSE,
	DEV_STATE_DISBAND_PGID,
	DEV_STATE_BOXED,
	/* states to wait for i/o completion before doing something */
	DEV_STATE_TIMEOUT_KILL,
	DEV_STATE_QUIESCE,
	/* special states for devices gone not operational */
	DEV_STATE_DISCONNECTED,
	DEV_STATE_DISCONNECTED_SENSE_ID,
	DEV_STATE_CMFCHANGE,
	DEV_STATE_CMFUPDATE,
	DEV_STATE_STEAL_LOCK,
	/* last element! */
	NR_DEV_STATES
};

/*
 * asynchronous events of the device statemachine
 */
enum dev_event {
	DEV_EVENT_NOTOPER,
	DEV_EVENT_INTERRUPT,
	DEV_EVENT_TIMEOUT,
	DEV_EVENT_VERIFY,
	/* last element! */
	NR_DEV_EVENTS
};

struct ccw_device;

/*
 * action called through jumptable
 */
typedef void (fsm_func_t)(struct ccw_device *, enum dev_event);
extern fsm_func_t *dev_jumptable[NR_DEV_STATES][NR_DEV_EVENTS];

static inline void
dev_fsm_event(struct ccw_device *cdev, enum dev_event dev_event)
{
	int state = cdev->private->state;

	if (dev_event == DEV_EVENT_INTERRUPT) {
		if (state == DEV_STATE_ONLINE)
			inc_irq_stat(cdev->private->int_class);
		else if (state != DEV_STATE_CMFCHANGE &&
			 state != DEV_STATE_CMFUPDATE)
			inc_irq_stat(IRQIO_CIO);
	}
	dev_jumptable[state][dev_event](cdev, dev_event);
}

/*
 * Delivers 1 if the device state is final.
 */
static inline int
dev_fsm_final_state(struct ccw_device *cdev)
{
	return (cdev->private->state == DEV_STATE_NOT_OPER ||
		cdev->private->state == DEV_STATE_OFFLINE ||
		cdev->private->state == DEV_STATE_ONLINE ||
		cdev->private->state == DEV_STATE_BOXED);
}

int __init io_subchannel_init(void);

void io_subchannel_recog_done(struct ccw_device *cdev);
void io_subchannel_init_config(struct subchannel *sch);

int ccw_device_cancel_halt_clear(struct ccw_device *);

int ccw_device_is_orphan(struct ccw_device *);

void ccw_device_recognition(struct ccw_device *);
int ccw_device_online(struct ccw_device *);
int ccw_device_offline(struct ccw_device *);
void ccw_device_update_sense_data(struct ccw_device *);
int ccw_device_test_sense_data(struct ccw_device *);
void ccw_device_schedule_sch_unregister(struct ccw_device *);
int ccw_purge_blacklisted(void);
void ccw_device_sched_todo(struct ccw_device *cdev, enum cdev_todo todo);
struct ccw_device *get_ccwdev_by_dev_id(struct ccw_dev_id *dev_id);

/* Function prototypes for device status and basic sense stuff. */
void ccw_device_accumulate_irb(struct ccw_device *, struct irb *);
void ccw_device_accumulate_basic_sense(struct ccw_device *, struct irb *);
int ccw_device_accumulate_and_sense(struct ccw_device *, struct irb *);
int ccw_device_do_sense(struct ccw_device *, struct irb *);

/* Function prototype for internal request handling. */
int lpm_adjust(int lpm, int mask);
void ccw_request_start(struct ccw_device *);
int ccw_request_cancel(struct ccw_device *cdev);
void ccw_request_handler(struct ccw_device *cdev);
void ccw_request_timeout(struct ccw_device *cdev);
void ccw_request_notoper(struct ccw_device *cdev);

/* Function prototypes for sense id stuff. */
void ccw_device_sense_id_start(struct ccw_device *);
void ccw_device_sense_id_done(struct ccw_device *, int);

/* Function prototypes for path grouping stuff. */
void ccw_device_verify_start(struct ccw_device *);
void ccw_device_verify_done(struct ccw_device *, int);

void ccw_device_disband_start(struct ccw_device *);
void ccw_device_disband_done(struct ccw_device *, int);

int ccw_device_stlck(struct ccw_device *);

/* Helper function for machine check handling. */
void ccw_device_trigger_reprobe(struct ccw_device *);
void ccw_device_kill_io(struct ccw_device *);
int ccw_device_notify(struct ccw_device *, int);
void ccw_device_set_disconnected(struct ccw_device *cdev);
void ccw_device_set_notoper(struct ccw_device *cdev);

void ccw_device_set_timeout(struct ccw_device *, int);

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