[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 <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 */
	} inf;
	union {
		__u32 cpu_addr	: 16;	/* CPU address */
		struct extended_cssid ext_cssid;
	} 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 {
	int state;		/* device state */
	atomic_t onoff;
	unsigned long registered;
	__u16 devno;		/* device number */
	__u16 sch_no;		/* subchannel number */
	__u8 ssid;              /* subchannel set id */
	__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 */
	} __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;	/* path group ID */
	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 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 *);

#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;
};
#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_set_waiting(struct subchannel *);

/* 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;

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