[mirror_ubuntu-artful-kernel.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>
#include <scsi/sas.h>

struct scsi_transport_template;
struct sas_rphy;
struct request;

#if !IS_ENABLED(CONFIG_SCSI_SAS_ATTRS)
static inline int scsi_is_sas_rphy(const struct device *sdev)
{
	return 0;
}
#else
extern int scsi_is_sas_rphy(const struct device *);
#endif

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,
	SAS_LINK_RATE_12_0_GBPS = 11,
	/* 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;

	/* available to the lldd */
	void			*hostdata;
};

#define dev_to_phy(d) \
	container_of((d), struct sas_phy, dev)
#define transport_class_to_phy(dev) \
	dev_to_phy((dev)->parent)
#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(dev) \
	dev_to_rphy((dev)->parent)
#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;
	unsigned		tlr_supported:1;
	unsigned		tlr_enabled: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(dev) \
	dev_to_sas_port((dev)->parent)

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 (*phy_setup)(struct sas_phy *);
	void (*phy_release)(struct sas_phy *);
	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 *);

u64 sas_get_address(struct scsi_device *);
unsigned int sas_tlr_supported(struct scsi_device *);
unsigned int sas_is_tlr_enabled(struct scsi_device *);
void sas_disable_tlr(struct scsi_device *);
void sas_enable_tlr(struct scsi_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 void sas_rphy_unlink(struct sas_rphy *);

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 *);
struct sas_phy *sas_port_get_phy(struct sas_port *port);
static inline void sas_port_put_phy(struct sas_phy *phy)
{
	if (phy)
		put_device(&phy->dev);
}

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>
5929faf3	7	#include <scsi/sas.h>
c7ebbbce CH	8
	9	struct scsi_transport_template;
	10	struct sas_rphy;
7aa68e80	11	struct request;
c7ebbbce	12
3b91d09c	13	#if !IS_ENABLED(CONFIG_SCSI_SAS_ATTRS)
c1a23f6d JT	14	static inline int scsi_is_sas_rphy(const struct device *sdev)
	15	{
	16	return 0;
	17	}
3b91d09c	18	#else
c1a23f6d	19	extern int scsi_is_sas_rphy(const struct device *);
3b91d09c JB	20	#endif
3b91d09c JB	21
0f05df8b JB	22	static inline int sas_protocol_ata(enum sas_protocol proto)
	23	{
	24	return ((proto & SAS_PROTOCOL_SATA) \|\|
	25	(proto & SAS_PROTOCOL_STP))? 1 : 0;
	26	}
	27
c7ebbbce	28	enum sas_linkrate {
88edf746 JB	29	/* These Values are defined in the SAS standard */
	30	SAS_LINK_RATE_UNKNOWN = 0,
	31	SAS_PHY_DISABLED = 1,
	32	SAS_PHY_RESET_PROBLEM = 2,
	33	SAS_SATA_SPINUP_HOLD = 3,
	34	SAS_SATA_PORT_SELECTOR = 4,
	35	SAS_PHY_RESET_IN_PROGRESS = 5,
	36	SAS_LINK_RATE_1_5_GBPS = 8,
	37	SAS_LINK_RATE_G1 = SAS_LINK_RATE_1_5_GBPS,
	38	SAS_LINK_RATE_3_0_GBPS = 9,
	39	SAS_LINK_RATE_G2 = SAS_LINK_RATE_3_0_GBPS,
	40	SAS_LINK_RATE_6_0_GBPS = 10,
d84fd392	41	SAS_LINK_RATE_12_0_GBPS = 11,
88edf746 JB	42	/* These are virtual to the transport class and may never
	43	* be signalled normally since the standard defined field
	44	* is only 4 bits */
	45	SAS_LINK_RATE_FAILED = 0x10,
	46	SAS_PHY_VIRTUAL = 0x11,
c7ebbbce CH	47	};
	48
	49	struct sas_identify {
	50	enum sas_device_type device_type;
	51	enum sas_protocol initiator_port_protocols;
	52	enum sas_protocol target_port_protocols;
	53	u64 sas_address;
	54	u8 phy_identifier;
	55	};
	56
c7ebbbce CH	57	struct sas_phy {
	58	struct device dev;
	59	int number;
acbf167d	60	int enabled;
c3ee74c4 CH	61
c3ee74c4 CH	62	/* phy identification */
c7ebbbce	63	struct sas_identify identify;
c3ee74c4 CH	64
c3ee74c4 CH	65	/* phy attributes */
c7ebbbce CH	66	enum sas_linkrate negotiated_linkrate;
	67	enum sas_linkrate minimum_linkrate_hw;
	68	enum sas_linkrate minimum_linkrate;
	69	enum sas_linkrate maximum_linkrate_hw;
	70	enum sas_linkrate maximum_linkrate;
c3ee74c4 CH	71
	72	/* link error statistics */
	73	u32 invalid_dword_count;
	74	u32 running_disparity_error_count;
	75	u32 loss_of_dword_sync_count;
	76	u32 phy_reset_problem_count;
	77
65c92b09 JB	78	/* for the list of phys belonging to a port */
65c92b09 JB	79	struct list_head port_siblings;
dea22214	80
0b3e09da DW	81	/* available to the lldd */
0b3e09da DW	82	void *hostdata;
c7ebbbce CH	83	};
	84
	85	#define dev_to_phy(d) \
	86	container_of((d), struct sas_phy, dev)
ee959b00 TJ	87	#define transport_class_to_phy(dev) \
ee959b00 TJ	88	dev_to_phy((dev)->parent)
c7ebbbce CH	89	#define phy_to_shost(phy) \
	90	dev_to_shost((phy)->dev.parent)
	91
b6aff669	92	struct request_queue;
c7ebbbce CH	93	struct sas_rphy {
	94	struct device dev;
	95	struct sas_identify identify;
	96	struct list_head list;
b6aff669	97	struct request_queue *q;
c7ebbbce CH	98	u32 scsi_target_id;
	99	};
	100
	101	#define dev_to_rphy(d) \
	102	container_of((d), struct sas_rphy, dev)
ee959b00 TJ	103	#define transport_class_to_rphy(dev) \
ee959b00 TJ	104	dev_to_rphy((dev)->parent)
c7ebbbce CH	105	#define rphy_to_shost(rphy) \
c7ebbbce CH	106	dev_to_shost((rphy)->dev.parent)
42ab0360 JB	107	#define target_to_rphy(targ) \
	108	dev_to_rphy((targ)->dev.parent)
	109
	110	struct sas_end_device {
	111	struct sas_rphy rphy;
	112	/* flags */
	113	unsigned ready_led_meaning:1;
0f88009d JB	114	unsigned tlr_supported:1;
0f88009d JB	115	unsigned tlr_enabled:1;
42ab0360 JB	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)
ee959b00 TJ	161	#define transport_class_to_sas_port(dev) \
ee959b00 TJ	162	dev_to_sas_port((dev)->parent)
65c92b09	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);
0b3e09da DW	176	int (phy_setup)(struct sas_phy );
0b3e09da DW	177	void (phy_release)(struct sas_phy );
d24e1eeb	178	int (set_phy_speed)(struct sas_phy , struct sas_phy_linkrates *);
7aa68e80	179	int (smp_handler)(struct Scsi_Host , struct sas_rphy , struct request );
c3ee74c4 CH	180	};
	181
	182
65c92b09	183	void sas_remove_children(struct device *);
c7ebbbce CH	184	extern void sas_remove_host(struct Scsi_Host *);
	185
	186	extern struct sas_phy sas_phy_alloc(struct device , int);
	187	extern void sas_phy_free(struct sas_phy *);
	188	extern int sas_phy_add(struct sas_phy *);
	189	extern void sas_phy_delete(struct sas_phy *);
	190	extern int scsi_is_sas_phy(const struct device *);
	191
bcf508c1	192	u64 sas_get_address(struct scsi_device *);
0f88009d JB	193	unsigned int sas_tlr_supported(struct scsi_device *);
	194	unsigned int sas_is_tlr_enabled(struct scsi_device *);
	195	void sas_disable_tlr(struct scsi_device *);
	196	void sas_enable_tlr(struct scsi_device *);
	197
65c92b09 JB	198	extern struct sas_rphy sas_end_device_alloc(struct sas_port );
65c92b09 JB	199	extern struct sas_rphy sas_expander_alloc(struct sas_port , enum sas_device_type);
c7ebbbce CH	200	void sas_rphy_free(struct sas_rphy *);
c7ebbbce CH	201	extern int sas_rphy_add(struct sas_rphy *);
6f63caae	202	extern void sas_rphy_remove(struct sas_rphy *);
c7ebbbce	203	extern void sas_rphy_delete(struct sas_rphy *);
87c8331f	204	extern void sas_rphy_unlink(struct sas_rphy *);
c7ebbbce	205
65c92b09	206	struct sas_port sas_port_alloc(struct device , int);
c9fefeb2	207	struct sas_port sas_port_alloc_num(struct device );
65c92b09 JB	208	int sas_port_add(struct sas_port *);
	209	void sas_port_free(struct sas_port *);
	210	void sas_port_delete(struct sas_port *);
	211	void sas_port_add_phy(struct sas_port , struct sas_phy );
	212	void sas_port_delete_phy(struct sas_port , struct sas_phy );
a0e1b6ef	213	void sas_port_mark_backlink(struct sas_port *);
65c92b09	214	int scsi_is_sas_port(const struct device *);
f41a0c44 DW	215	struct sas_phy sas_port_get_phy(struct sas_port port);
	216	static inline void sas_port_put_phy(struct sas_phy *phy)
	217	{
	218	if (phy)
	219	put_device(&phy->dev);
	220	}
65c92b09	221
c7ebbbce CH	222	extern struct scsi_transport_template *
	223	sas_attach_transport(struct sas_function_template *);
	224	extern void sas_release_transport(struct scsi_transport_template *);
42ab0360	225	int sas_read_port_mode_page(struct scsi_device *);
c7ebbbce	226
79cb1819 JB	227	static inline int
	228	scsi_is_sas_expander_device(struct device *dev)
	229	{
	230	struct sas_rphy *rphy;
	231	if (!scsi_is_sas_rphy(dev))
	232	return 0;
	233	rphy = dev_to_rphy(dev);
	234	return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE \|\|
	235	rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
	236	}
	237
f4ad7b58 JB	238	#define scsi_is_sas_phy_local(phy) scsi_is_host_device((phy)->dev.parent)
f4ad7b58 JB	239
c7ebbbce	240	#endif /* SCSI_TRANSPORT_SAS_H */