[mirror_ubuntu-bionic-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;

enum sas_device_type {
	SAS_PHY_UNUSED = 0,
	SAS_END_DEVICE = 1,
	SAS_EDGE_EXPANDER_DEVICE = 2,
	SAS_FANOUT_EXPANDER_DEVICE = 3,
};

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;

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

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