[deliverable/linux.git] / drivers / s390 / cio / css.h

#ifndef _CSS_H
#define _CSS_H

#include <linux/mutex.h>
#include <linux/wait.h>
#include <linux/workqueue.h>
#include <linux/device.h>

#include <asm/cio.h>

#include "schid.h"

/*
 * path grouping stuff
 */
#define SPID_FUNC_SINGLE_PATH	   0x00
#define SPID_FUNC_MULTI_PATH	   0x80
#define SPID_FUNC_ESTABLISH	   0x00
#define SPID_FUNC_RESIGN	   0x40
#define SPID_FUNC_DISBAND	   0x20

#define SNID_STATE1_RESET	   0
#define SNID_STATE1_UNGROUPED	   2
#define SNID_STATE1_GROUPED	   3

#define SNID_STATE2_NOT_RESVD	   0
#define SNID_STATE2_RESVD_ELSE	   2
#define SNID_STATE2_RESVD_SELF	   3

#define SNID_STATE3_MULTI_PATH	   1
#define SNID_STATE3_SINGLE_PATH	   0

struct path_state {
	__u8  state1 : 2;	/* path state value 1 */
	__u8  state2 : 2;	/* path state value 2 */
	__u8  state3 : 1;	/* path state value 3 */
	__u8  resvd  : 3;	/* reserved */
} __attribute__ ((packed));

struct extended_cssid {
	u8 version;
	u8 cssid;
} __attribute__ ((packed));

struct pgid {
	union {
		__u8 fc;   	/* SPID function code */
		struct path_state ps;	/* SNID path state */
	} __attribute__ ((packed)) inf;
	union {
		__u32 cpu_addr	: 16;	/* CPU address */
		struct extended_cssid ext_cssid;
	} __attribute__ ((packed)) pgid_high;
	__u32 cpu_id	: 24;	/* CPU identification */
	__u32 cpu_model : 16;	/* CPU model */
	__u32 tod_high;		/* high word TOD clock */
} __attribute__ ((packed));

#define MAX_CIWS 8

/*
 * sense-id response buffer layout
 */
struct senseid {
	/* common part */
	__u8  reserved;     	/* always 0x'FF' */
	__u16 cu_type;	     	/* control unit type */
	__u8  cu_model;     	/* control unit model */
	__u16 dev_type;     	/* device type */
	__u8  dev_model;    	/* device model */
	__u8  unused;	     	/* padding byte */
	/* extended part */
	struct ciw ciw[MAX_CIWS];	/* variable # of CIWs */
}  __attribute__ ((packed,aligned(4)));

struct ccw_device_private {
	struct ccw_device *cdev;
	struct subchannel *sch;
	int state;		/* device state */
	atomic_t onoff;
	unsigned long registered;
	struct ccw_dev_id dev_id;	/* device id */
	struct subchannel_id schid;	/* subchannel number */
	__u8 imask;		/* lpm mask for SNID/SID/SPGID */
	int iretry;		/* retry counter SNID/SID/SPGID */
	struct {
		unsigned int fast:1;	/* post with "channel end" */
		unsigned int repall:1;	/* report every interrupt status */
		unsigned int pgroup:1;  /* do path grouping */
		unsigned int force:1;   /* allow forced online */
	} __attribute__ ((packed)) options;
	struct {
		unsigned int pgid_single:1; /* use single path for Set PGID */
		unsigned int esid:1;        /* Ext. SenseID supported by HW */
		unsigned int dosense:1;	    /* delayed SENSE required */
		unsigned int doverify:1;    /* delayed path verification */
		unsigned int donotify:1;    /* call notify function */
		unsigned int recog_done:1;  /* dev. recog. complete */
		unsigned int fake_irb:1;    /* deliver faked irb */
		unsigned int intretry:1;    /* retry internal operation */
	} __attribute__((packed)) flags;
	unsigned long intparm;	/* user interruption parameter */
	struct qdio_irq *qdio_data;
	struct irb irb;		/* device status */
	struct senseid senseid;	/* SenseID info */
	struct pgid pgid[8];	/* path group IDs per chpid*/
	struct ccw1 iccws[2];	/* ccws for SNID/SID/SPGID commands */
	struct work_struct kick_work;
	wait_queue_head_t wait_q;
	struct timer_list timer;
	void *cmb;			/* measurement information */
	struct list_head cmb_list;	/* list of measured devices */
	u64 cmb_start_time;		/* clock value of cmb reset */
	void *cmb_wait;			/* deferred cmb enable/disable */
};

/*
 * A css driver handles all subchannels of one type.
 * Currently, we only care about I/O subchannels (type 0), these
 * have a ccw_device connected to them.
 */
struct subchannel;
struct css_driver {
	unsigned int subchannel_type;
	struct device_driver drv;
	void (*irq)(struct device *);
	int (*notify)(struct device *, int);
	void (*verify)(struct device *);
	void (*termination)(struct device *);
	int (*probe)(struct subchannel *);
	int (*remove)(struct subchannel *);
	void (*shutdown)(struct subchannel *);
};

/*
 * all css_drivers have the css_bus_type
 */
extern struct bus_type css_bus_type;
extern struct css_driver io_subchannel_driver;

extern int css_probe_device(struct subchannel_id);
extern int css_sch_device_register(struct subchannel *);
extern void css_sch_device_unregister(struct subchannel *);
extern struct subchannel * get_subchannel_by_schid(struct subchannel_id);
extern int css_init_done;
extern int for_each_subchannel(int(*fn)(struct subchannel_id, void *), void *);
extern int css_process_crw(int, int);
extern void css_reiterate_subchannels(void);

#define __MAX_SUBCHANNEL 65535
#define __MAX_SSID 3
#define __MAX_CHPID 255
#define __MAX_CSSID 0

struct channel_subsystem {
	u8 cssid;
	int valid;
	struct channel_path *chps[__MAX_CHPID + 1];
	struct device device;
	struct pgid global_pgid;
	struct mutex mutex;
	/* channel measurement related */
	int cm_enabled;
	void *cub_addr1;
	void *cub_addr2;
	/* for orphaned ccw devices */
	struct subchannel *pseudo_subchannel;
};
#define to_css(dev) container_of(dev, struct channel_subsystem, device)

extern struct bus_type css_bus_type;
extern struct channel_subsystem *css[];

/* Some helper functions for disconnected state. */
int device_is_disconnected(struct subchannel *);
void device_set_disconnected(struct subchannel *);
void device_trigger_reprobe(struct subchannel *);

/* Helper functions for vary on/off. */
int device_is_online(struct subchannel *);
void device_kill_io(struct subchannel *);
void device_set_intretry(struct subchannel *sch);
int device_trigger_verify(struct subchannel *sch);

/* Machine check helper function. */
void device_kill_pending_timer(struct subchannel *);

/* Helper functions to build lists for the slow path. */
extern int css_enqueue_subchannel_slow(struct subchannel_id schid);
void css_walk_subchannel_slow_list(void (*fn)(unsigned long));
void css_clear_subchannel_slow_list(void);
int css_slow_subchannels_exist(void);
extern int need_rescan;

int sch_is_pseudo_sch(struct subchannel *);

extern struct workqueue_struct *slow_path_wq;
extern struct work_struct slow_path_work;

int subchannel_add_files (struct device *);
extern struct attribute_group *subch_attr_groups[];
#endif
Commit	Line	Data
1da177e4 LT	1	#ifndef _CSS_H
	2	#define _CSS_H
	3
495a5b45	4	#include <linux/mutex.h>
1da177e4 LT	5	#include <linux/wait.h>
1da177e4 LT	6	#include <linux/workqueue.h>
e6b6e10a	7	#include <linux/device.h>
1da177e4 LT	8
	9	#include <asm/cio.h>
	10
a8237fc4 CH	11	#include "schid.h"
a8237fc4 CH	12
1da177e4 LT	13	/*
	14	* path grouping stuff
	15	*/
	16	#define SPID_FUNC_SINGLE_PATH 0x00
	17	#define SPID_FUNC_MULTI_PATH 0x80
	18	#define SPID_FUNC_ESTABLISH 0x00
	19	#define SPID_FUNC_RESIGN 0x40
	20	#define SPID_FUNC_DISBAND 0x20
	21
	22	#define SNID_STATE1_RESET 0
	23	#define SNID_STATE1_UNGROUPED 2
	24	#define SNID_STATE1_GROUPED 3
	25
	26	#define SNID_STATE2_NOT_RESVD 0
	27	#define SNID_STATE2_RESVD_ELSE 2
	28	#define SNID_STATE2_RESVD_SELF 3
	29
	30	#define SNID_STATE3_MULTI_PATH 1
	31	#define SNID_STATE3_SINGLE_PATH 0
	32
	33	struct path_state {
	34	__u8 state1 : 2; /* path state value 1 */
	35	__u8 state2 : 2; /* path state value 2 */
	36	__u8 state3 : 1; /* path state value 3 */
	37	__u8 resvd : 3; /* reserved */
	38	} __attribute__ ((packed));
	39
a28c6944 CH	40	struct extended_cssid {
	41	u8 version;
	42	u8 cssid;
	43	} __attribute__ ((packed));
	44
1da177e4 LT	45	struct pgid {
	46	union {
	47	__u8 fc; /* SPID function code */
	48	struct path_state ps; /* SNID path state */
4ae9538d	49	} __attribute__ ((packed)) inf;
a28c6944 CH	50	union {
	51	__u32 cpu_addr : 16; /* CPU address */
	52	struct extended_cssid ext_cssid;
4ae9538d	53	} __attribute__ ((packed)) pgid_high;
1da177e4 LT	54	__u32 cpu_id : 24; /* CPU identification */
	55	__u32 cpu_model : 16; /* CPU model */
	56	__u32 tod_high; /* high word TOD clock */
	57	} __attribute__ ((packed));
	58
1da177e4 LT	59	#define MAX_CIWS 8
	60
	61	/*
	62	* sense-id response buffer layout
	63	*/
	64	struct senseid {
	65	/* common part */
	66	__u8 reserved; /* always 0x'FF' */
	67	__u16 cu_type; /* control unit type */
	68	__u8 cu_model; /* control unit model */
	69	__u16 dev_type; /* device type */
	70	__u8 dev_model; /* device model */
	71	__u8 unused; /* padding byte */
	72	/* extended part */
	73	struct ciw ciw[MAX_CIWS]; /* variable # of CIWs */
	74	} __attribute__ ((packed,aligned(4)));
	75
	76	struct ccw_device_private {
c1637532 MS	77	struct ccw_device *cdev;
c1637532 MS	78	struct subchannel *sch;
1da177e4 LT	79	int state; /* device state */
	80	atomic_t onoff;
	81	unsigned long registered;
78964268 CH	82	struct ccw_dev_id dev_id; /* device id */
78964268 CH	83	struct subchannel_id schid; /* subchannel number */
1da177e4 LT	84	__u8 imask; /* lpm mask for SNID/SID/SPGID */
	85	int iretry; /* retry counter SNID/SID/SPGID */
	86	struct {
	87	unsigned int fast:1; /* post with "channel end" */
	88	unsigned int repall:1; /* report every interrupt status */
	89	unsigned int pgroup:1; /* do path grouping */
	90	unsigned int force:1; /* allow forced online */
	91	} __attribute__ ((packed)) options;
	92	struct {
	93	unsigned int pgid_single:1; /* use single path for Set PGID */
	94	unsigned int esid:1; /* Ext. SenseID supported by HW */
	95	unsigned int dosense:1; /* delayed SENSE required */
	96	unsigned int doverify:1; /* delayed path verification */
	97	unsigned int donotify:1; /* call notify function */
	98	unsigned int recog_done:1; /* dev. recog. complete */
	99	unsigned int fake_irb:1; /* deliver faked irb */
d23861ff	100	unsigned int intretry:1; /* retry internal operation */
1da177e4 LT	101	} __attribute__((packed)) flags;
	102	unsigned long intparm; /* user interruption parameter */
	103	struct qdio_irq *qdio_data;
	104	struct irb irb; /* device status */
	105	struct senseid senseid; /* SenseID info */
7e560814	106	struct pgid pgid[8]; /* path group IDs per chpid*/
1da177e4 LT	107	struct ccw1 iccws[2]; /* ccws for SNID/SID/SPGID commands */
	108	struct work_struct kick_work;
	109	wait_queue_head_t wait_q;
	110	struct timer_list timer;
	111	void cmb; / measurement information */
	112	struct list_head cmb_list; /* list of measured devices */
	113	u64 cmb_start_time; /* clock value of cmb reset */
	114	void cmb_wait; / deferred cmb enable/disable */
	115	};
	116
	117	/*
	118	* A css driver handles all subchannels of one type.
	119	* Currently, we only care about I/O subchannels (type 0), these
	120	* have a ccw_device connected to them.
	121	*/
8bbace7e	122	struct subchannel;
1da177e4 LT	123	struct css_driver {
	124	unsigned int subchannel_type;
	125	struct device_driver drv;
	126	void (irq)(struct device );
	127	int (notify)(struct device , int);
	128	void (verify)(struct device );
	129	void (termination)(struct device );
8bbace7e CH	130	int (probe)(struct subchannel );
	131	int (remove)(struct subchannel );
	132	void (shutdown)(struct subchannel );
1da177e4 LT	133	};
	134
	135	/*
	136	* all css_drivers have the css_bus_type
	137	*/
	138	extern struct bus_type css_bus_type;
	139	extern struct css_driver io_subchannel_driver;
	140
a8237fc4	141	extern int css_probe_device(struct subchannel_id);
6ab4879a CH	142	extern int css_sch_device_register(struct subchannel *);
6ab4879a CH	143	extern void css_sch_device_unregister(struct subchannel *);
a8237fc4	144	extern struct subchannel * get_subchannel_by_schid(struct subchannel_id);
1da177e4	145	extern int css_init_done;
f97a56fb	146	extern int for_each_subchannel(int(fn)(struct subchannel_id, void ), void *);
2b67fc46 HC	147	extern int css_process_crw(int, int);
2b67fc46 HC	148	extern void css_reiterate_subchannels(void);
1da177e4	149
a8237fc4	150	#define __MAX_SUBCHANNEL 65535
fb6958a5	151	#define __MAX_SSID 3
a28c6944 CH	152	#define __MAX_CHPID 255
	153	#define __MAX_CSSID 0
	154
	155	struct channel_subsystem {
	156	u8 cssid;
	157	int valid;
871931c1	158	struct channel_path *chps[__MAX_CHPID + 1];
a28c6944 CH	159	struct device device;
a28c6944 CH	160	struct pgid global_pgid;
495a5b45 CH	161	struct mutex mutex;
	162	/* channel measurement related */
	163	int cm_enabled;
	164	void *cub_addr1;
	165	void *cub_addr2;
d7b5a4c9 CH	166	/* for orphaned ccw devices */
d7b5a4c9 CH	167	struct subchannel *pseudo_subchannel;
a28c6944 CH	168	};
a28c6944 CH	169	#define to_css(dev) container_of(dev, struct channel_subsystem, device)
1da177e4 LT	170
1da177e4 LT	171	extern struct bus_type css_bus_type;
a28c6944	172	extern struct channel_subsystem *css[];
1da177e4 LT	173
	174	/* Some helper functions for disconnected state. */
	175	int device_is_disconnected(struct subchannel *);
	176	void device_set_disconnected(struct subchannel *);
	177	void device_trigger_reprobe(struct subchannel *);
	178
	179	/* Helper functions for vary on/off. */
	180	int device_is_online(struct subchannel *);
e7769b48	181	void device_kill_io(struct subchannel *);
d23861ff	182	void device_set_intretry(struct subchannel *sch);
24cb5b48	183	int device_trigger_verify(struct subchannel *sch);
1da177e4 LT	184
	185	/* Machine check helper function. */
	186	void device_kill_pending_timer(struct subchannel *);
	187
	188	/* Helper functions to build lists for the slow path. */
a8237fc4	189	extern int css_enqueue_subchannel_slow(struct subchannel_id schid);
1da177e4 LT	190	void css_walk_subchannel_slow_list(void (*fn)(unsigned long));
	191	void css_clear_subchannel_slow_list(void);
	192	int css_slow_subchannels_exist(void);
	193	extern int need_rescan;
	194
d7b5a4c9 CH	195	int sch_is_pseudo_sch(struct subchannel *);
d7b5a4c9 CH	196
1da177e4 LT	197	extern struct workqueue_struct *slow_path_wq;
1da177e4 LT	198	extern struct work_struct slow_path_work;
7674da77 CH	199
7674da77 CH	200	int subchannel_add_files (struct device *);
529192f3	201	extern struct attribute_group *subch_attr_groups[];
1da177e4	202	#endif