[linux-2.6-block.git] / include / scsi / scsi_transport_sas.h

#ifndef SCSI_TRANSPORT_SAS_H
#define SCSI_TRANSPORT_SAS_H

#include <linux/transport_class.h>
#include <linux/types.h>
#include <linux/mutex.h>

struct scsi_transport_template;
struct sas_rphy;
struct request;

enum sas_device_type {
	SAS_PHY_UNUSED,
	SAS_END_DEVICE,
	SAS_EDGE_EXPANDER_DEVICE,
	SAS_FANOUT_EXPANDER_DEVICE,
};

enum sas_protocol {
	SAS_PROTOCOL_SATA		= 0x01,
	SAS_PROTOCOL_SMP		= 0x02,
	SAS_PROTOCOL_STP		= 0x04,
	SAS_PROTOCOL_SSP		= 0x08,
};

static inline int sas_protocol_ata(enum sas_protocol proto)
{
	return ((proto & SAS_PROTOCOL_SATA) ||
		(proto & SAS_PROTOCOL_STP))? 1 : 0;
}

enum sas_linkrate {
	/* These Values are defined in the SAS standard */
	SAS_LINK_RATE_UNKNOWN = 0,
	SAS_PHY_DISABLED = 1,
	SAS_PHY_RESET_PROBLEM = 2,
	SAS_SATA_SPINUP_HOLD = 3,
	SAS_SATA_PORT_SELECTOR = 4,
	SAS_PHY_RESET_IN_PROGRESS = 5,
	SAS_LINK_RATE_1_5_GBPS = 8,
	SAS_LINK_RATE_G1 = SAS_LINK_RATE_1_5_GBPS,
	SAS_LINK_RATE_3_0_GBPS = 9,
	SAS_LINK_RATE_G2 = SAS_LINK_RATE_3_0_GBPS,
	SAS_LINK_RATE_6_0_GBPS = 10,
	/* These are virtual to the transport class and may never
	 * be signalled normally since the standard defined field
	 * is only 4 bits */
	SAS_LINK_RATE_FAILED = 0x10,
	SAS_PHY_VIRTUAL = 0x11,
};

struct sas_identify {
	enum sas_device_type	device_type;
	enum sas_protocol	initiator_port_protocols;
	enum sas_protocol	target_port_protocols;
	u64			sas_address;
	u8			phy_identifier;
};

struct sas_phy {
	struct device		dev;
	int			number;
	int			enabled;

	/* phy identification */
	struct sas_identify	identify;

	/* phy attributes */
	enum sas_linkrate	negotiated_linkrate;
	enum sas_linkrate	minimum_linkrate_hw;
	enum sas_linkrate	minimum_linkrate;
	enum sas_linkrate	maximum_linkrate_hw;
	enum sas_linkrate	maximum_linkrate;

	/* link error statistics */
	u32			invalid_dword_count;
	u32			running_disparity_error_count;
	u32			loss_of_dword_sync_count;
	u32			phy_reset_problem_count;

	/* for the list of phys belonging to a port */
	struct list_head	port_siblings;

	struct work_struct      reset_work;
};

#define dev_to_phy(d) \
	container_of((d), struct sas_phy, dev)
#define transport_class_to_phy(cdev) \
	dev_to_phy((cdev)->dev)
#define phy_to_shost(phy) \
	dev_to_shost((phy)->dev.parent)

struct request_queue;
struct sas_rphy {
	struct device		dev;
	struct sas_identify	identify;
	struct list_head	list;
	struct request_queue	*q;
	u32			scsi_target_id;
};

#define dev_to_rphy(d) \
	container_of((d), struct sas_rphy, dev)
#define transport_class_to_rphy(cdev) \
	dev_to_rphy((cdev)->dev)
#define rphy_to_shost(rphy) \
	dev_to_shost((rphy)->dev.parent)
#define target_to_rphy(targ) \
	dev_to_rphy((targ)->dev.parent)

struct sas_end_device {
	struct sas_rphy		rphy;
	/* flags */
	unsigned		ready_led_meaning:1;
	/* parameters */
	u16			I_T_nexus_loss_timeout;
	u16			initiator_response_timeout;
};
#define rphy_to_end_device(r) \
	container_of((r), struct sas_end_device, rphy)

struct sas_expander_device {
	int    level;
	int    next_port_id;

	#define SAS_EXPANDER_VENDOR_ID_LEN	8
	char   vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
	#define SAS_EXPANDER_PRODUCT_ID_LEN	16
	char   product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
	#define SAS_EXPANDER_PRODUCT_REV_LEN	4
	char   product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
	#define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN	8
	char   component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
	u16    component_id;
	u8     component_revision_id;

	struct sas_rphy		rphy;

};
#define rphy_to_expander_device(r) \
	container_of((r), struct sas_expander_device, rphy)

struct sas_port {
	struct device		dev;

	int			port_identifier;
	int			num_phys;
	/* port flags */
	unsigned int		is_backlink:1;

	/* the other end of the link */
	struct sas_rphy		*rphy;

	struct mutex		phy_list_mutex;
	struct list_head	phy_list;
};

#define dev_to_sas_port(d) \
	container_of((d), struct sas_port, dev)
#define transport_class_to_sas_port(cdev) \
	dev_to_sas_port((cdev)->dev)

struct sas_phy_linkrates {
	enum sas_linkrate maximum_linkrate;
	enum sas_linkrate minimum_linkrate;
};

/* The functions by which the transport class and the driver communicate */
struct sas_function_template {
	int (*get_linkerrors)(struct sas_phy *);
	int (*get_enclosure_identifier)(struct sas_rphy *, u64 *);
	int (*get_bay_identifier)(struct sas_rphy *);
	int (*phy_reset)(struct sas_phy *, int);
	int (*phy_enable)(struct sas_phy *, int);
	int (*set_phy_speed)(struct sas_phy *, struct sas_phy_linkrates *);
	int (*smp_handler)(struct Scsi_Host *, struct sas_rphy *, struct request *);
};


void sas_remove_children(struct device *);
extern void sas_remove_host(struct Scsi_Host *);

extern struct sas_phy *sas_phy_alloc(struct device *, int);
extern void sas_phy_free(struct sas_phy *);
extern int sas_phy_add(struct sas_phy *);
extern void sas_phy_delete(struct sas_phy *);
extern int scsi_is_sas_phy(const struct device *);

extern struct sas_rphy *sas_end_device_alloc(struct sas_port *);
extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type);
void sas_rphy_free(struct sas_rphy *);
extern int sas_rphy_add(struct sas_rphy *);
extern void sas_rphy_remove(struct sas_rphy *);
extern void sas_rphy_delete(struct sas_rphy *);
extern int scsi_is_sas_rphy(const struct device *);

struct sas_port *sas_port_alloc(struct device *, int);
struct sas_port *sas_port_alloc_num(struct device *);
int sas_port_add(struct sas_port *);
void sas_port_free(struct sas_port *);
void sas_port_delete(struct sas_port *);
void sas_port_add_phy(struct sas_port *, struct sas_phy *);
void sas_port_delete_phy(struct sas_port *, struct sas_phy *);
void sas_port_mark_backlink(struct sas_port *);
int scsi_is_sas_port(const struct device *);

extern struct scsi_transport_template *
sas_attach_transport(struct sas_function_template *);
extern void sas_release_transport(struct scsi_transport_template *);
int sas_read_port_mode_page(struct scsi_device *);

static inline int
scsi_is_sas_expander_device(struct device *dev)
{
	struct sas_rphy *rphy;
	if (!scsi_is_sas_rphy(dev))
		return 0;
	rphy = dev_to_rphy(dev);
	return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE ||
		rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
}

#define scsi_is_sas_phy_local(phy)	scsi_is_host_device((phy)->dev.parent)

#endif /* SCSI_TRANSPORT_SAS_H */
Commit	Line	Data
c7ebbbce CH	1	#ifndef SCSI_TRANSPORT_SAS_H
	2	#define SCSI_TRANSPORT_SAS_H
	3
	4	#include <linux/transport_class.h>
	5	#include <linux/types.h>
65c92b09	6	#include <linux/mutex.h>
c7ebbbce CH	7
	8	struct scsi_transport_template;
	9	struct sas_rphy;
7aa68e80	10	struct request;
c7ebbbce CH	11
	12	enum sas_device_type {
	13	SAS_PHY_UNUSED,
	14	SAS_END_DEVICE,
	15	SAS_EDGE_EXPANDER_DEVICE,
	16	SAS_FANOUT_EXPANDER_DEVICE,
	17	};
	18
	19	enum sas_protocol {
	20	SAS_PROTOCOL_SATA = 0x01,
	21	SAS_PROTOCOL_SMP = 0x02,
	22	SAS_PROTOCOL_STP = 0x04,
	23	SAS_PROTOCOL_SSP = 0x08,
	24	};
	25
0f05df8b JB	26	static inline int sas_protocol_ata(enum sas_protocol proto)
	27	{
	28	return ((proto & SAS_PROTOCOL_SATA) \|\|
	29	(proto & SAS_PROTOCOL_STP))? 1 : 0;
	30	}
	31
c7ebbbce	32	enum sas_linkrate {
88edf746 JB	33	/* These Values are defined in the SAS standard */
	34	SAS_LINK_RATE_UNKNOWN = 0,
	35	SAS_PHY_DISABLED = 1,
	36	SAS_PHY_RESET_PROBLEM = 2,
	37	SAS_SATA_SPINUP_HOLD = 3,
	38	SAS_SATA_PORT_SELECTOR = 4,
	39	SAS_PHY_RESET_IN_PROGRESS = 5,
	40	SAS_LINK_RATE_1_5_GBPS = 8,
	41	SAS_LINK_RATE_G1 = SAS_LINK_RATE_1_5_GBPS,
	42	SAS_LINK_RATE_3_0_GBPS = 9,
	43	SAS_LINK_RATE_G2 = SAS_LINK_RATE_3_0_GBPS,
	44	SAS_LINK_RATE_6_0_GBPS = 10,
	45	/* These are virtual to the transport class and may never
	46	* be signalled normally since the standard defined field
	47	* is only 4 bits */
	48	SAS_LINK_RATE_FAILED = 0x10,
	49	SAS_PHY_VIRTUAL = 0x11,
c7ebbbce CH	50	};
	51
	52	struct sas_identify {
	53	enum sas_device_type device_type;
	54	enum sas_protocol initiator_port_protocols;
	55	enum sas_protocol target_port_protocols;
	56	u64 sas_address;
	57	u8 phy_identifier;
	58	};
	59
c7ebbbce CH	60	struct sas_phy {
	61	struct device dev;
	62	int number;
acbf167d	63	int enabled;
c3ee74c4 CH	64
c3ee74c4 CH	65	/* phy identification */
c7ebbbce	66	struct sas_identify identify;
c3ee74c4 CH	67
c3ee74c4 CH	68	/* phy attributes */
c7ebbbce CH	69	enum sas_linkrate negotiated_linkrate;
	70	enum sas_linkrate minimum_linkrate_hw;
	71	enum sas_linkrate minimum_linkrate;
	72	enum sas_linkrate maximum_linkrate_hw;
	73	enum sas_linkrate maximum_linkrate;
c3ee74c4 CH	74
	75	/* link error statistics */
	76	u32 invalid_dword_count;
	77	u32 running_disparity_error_count;
	78	u32 loss_of_dword_sync_count;
	79	u32 phy_reset_problem_count;
	80
65c92b09 JB	81	/* for the list of phys belonging to a port */
65c92b09 JB	82	struct list_head port_siblings;
dea22214 DW	83
dea22214 DW	84	struct work_struct reset_work;
c7ebbbce CH	85	};
	86
	87	#define dev_to_phy(d) \
	88	container_of((d), struct sas_phy, dev)
	89	#define transport_class_to_phy(cdev) \
	90	dev_to_phy((cdev)->dev)
	91	#define phy_to_shost(phy) \
	92	dev_to_shost((phy)->dev.parent)
	93
b6aff669	94	struct request_queue;
c7ebbbce CH	95	struct sas_rphy {
	96	struct device dev;
	97	struct sas_identify identify;
	98	struct list_head list;
b6aff669	99	struct request_queue *q;
c7ebbbce CH	100	u32 scsi_target_id;
	101	};
	102
	103	#define dev_to_rphy(d) \
	104	container_of((d), struct sas_rphy, dev)
	105	#define transport_class_to_rphy(cdev) \
	106	dev_to_rphy((cdev)->dev)
	107	#define rphy_to_shost(rphy) \
	108	dev_to_shost((rphy)->dev.parent)
42ab0360 JB	109	#define target_to_rphy(targ) \
	110	dev_to_rphy((targ)->dev.parent)
	111
	112	struct sas_end_device {
	113	struct sas_rphy rphy;
	114	/* flags */
	115	unsigned ready_led_meaning:1;
	116	/* parameters */
	117	u16 I_T_nexus_loss_timeout;
	118	u16 initiator_response_timeout;
	119	};
	120	#define rphy_to_end_device(r) \
	121	container_of((r), struct sas_end_device, rphy)
c7ebbbce	122
79cb1819 JB	123	struct sas_expander_device {
79cb1819 JB	124	int level;
c9fefeb2	125	int next_port_id;
79cb1819 JB	126
	127	#define SAS_EXPANDER_VENDOR_ID_LEN 8
	128	char vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
	129	#define SAS_EXPANDER_PRODUCT_ID_LEN 16
	130	char product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
	131	#define SAS_EXPANDER_PRODUCT_REV_LEN 4
	132	char product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
	133	#define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN 8
	134	char component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
	135	u16 component_id;
	136	u8 component_revision_id;
	137
	138	struct sas_rphy rphy;
	139
	140	};
	141	#define rphy_to_expander_device(r) \
	142	container_of((r), struct sas_expander_device, rphy)
c3ee74c4	143
65c92b09 JB	144	struct sas_port {
	145	struct device dev;
	146
c9fefeb2	147	int port_identifier;
65c92b09	148	int num_phys;
a0e1b6ef JB	149	/* port flags */
a0e1b6ef JB	150	unsigned int is_backlink:1;
65c92b09 JB	151
	152	/* the other end of the link */
	153	struct sas_rphy *rphy;
	154
	155	struct mutex phy_list_mutex;
	156	struct list_head phy_list;
	157	};
	158
	159	#define dev_to_sas_port(d) \
	160	container_of((d), struct sas_port, dev)
	161	#define transport_class_to_sas_port(cdev) \
	162	dev_to_sas_port((cdev)->dev)
	163
d24e1eeb JB	164	struct sas_phy_linkrates {
	165	enum sas_linkrate maximum_linkrate;
	166	enum sas_linkrate minimum_linkrate;
	167	};
	168
c3ee74c4 CH	169	/* The functions by which the transport class and the driver communicate */
	170	struct sas_function_template {
	171	int (get_linkerrors)(struct sas_phy );
a0125641 CH	172	int (get_enclosure_identifier)(struct sas_rphy , u64 *);
a0125641 CH	173	int (get_bay_identifier)(struct sas_rphy );
07ba3a95	174	int (phy_reset)(struct sas_phy , int);
acbf167d	175	int (phy_enable)(struct sas_phy , int);
d24e1eeb	176	int (set_phy_speed)(struct sas_phy , struct sas_phy_linkrates *);
7aa68e80	177	int (smp_handler)(struct Scsi_Host , struct sas_rphy , struct request );
c3ee74c4 CH	178	};
	179
	180
65c92b09	181	void sas_remove_children(struct device *);
c7ebbbce CH	182	extern void sas_remove_host(struct Scsi_Host *);
	183
	184	extern struct sas_phy sas_phy_alloc(struct device , int);
	185	extern void sas_phy_free(struct sas_phy *);
	186	extern int sas_phy_add(struct sas_phy *);
	187	extern void sas_phy_delete(struct sas_phy *);
	188	extern int scsi_is_sas_phy(const struct device *);
	189
65c92b09 JB	190	extern struct sas_rphy sas_end_device_alloc(struct sas_port );
65c92b09 JB	191	extern struct sas_rphy sas_expander_alloc(struct sas_port , enum sas_device_type);
c7ebbbce CH	192	void sas_rphy_free(struct sas_rphy *);
c7ebbbce CH	193	extern int sas_rphy_add(struct sas_rphy *);
6f63caae	194	extern void sas_rphy_remove(struct sas_rphy *);
c7ebbbce CH	195	extern void sas_rphy_delete(struct sas_rphy *);
	196	extern int scsi_is_sas_rphy(const struct device *);
	197
65c92b09	198	struct sas_port sas_port_alloc(struct device , int);
c9fefeb2	199	struct sas_port sas_port_alloc_num(struct device );
65c92b09 JB	200	int sas_port_add(struct sas_port *);
	201	void sas_port_free(struct sas_port *);
	202	void sas_port_delete(struct sas_port *);
	203	void sas_port_add_phy(struct sas_port , struct sas_phy );
	204	void sas_port_delete_phy(struct sas_port , struct sas_phy );
a0e1b6ef	205	void sas_port_mark_backlink(struct sas_port *);
65c92b09 JB	206	int scsi_is_sas_port(const struct device *);
65c92b09 JB	207
c7ebbbce CH	208	extern struct scsi_transport_template *
	209	sas_attach_transport(struct sas_function_template *);
	210	extern void sas_release_transport(struct scsi_transport_template *);
42ab0360	211	int sas_read_port_mode_page(struct scsi_device *);
c7ebbbce	212
79cb1819 JB	213	static inline int
	214	scsi_is_sas_expander_device(struct device *dev)
	215	{
	216	struct sas_rphy *rphy;
	217	if (!scsi_is_sas_rphy(dev))
	218	return 0;
	219	rphy = dev_to_rphy(dev);
	220	return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE \|\|
	221	rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
	222	}
	223
f4ad7b58 JB	224	#define scsi_is_sas_phy_local(phy) scsi_is_host_device((phy)->dev.parent)
f4ad7b58 JB	225
c7ebbbce	226	#endif /* SCSI_TRANSPORT_SAS_H */