[mirror_ubuntu-bionic-kernel.git] / include / scsi / scsi_transport_sas.h

/* SPDX-License-Identifier: GPL-2.0 */
#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>
#include <linux/bsg-lib.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;
	struct list_head	del_list; /* libsas only */
};

#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 *);
	void (*smp_handler)(struct bsg_job *, struct Scsi_Host *,
			struct sas_rphy *);
};


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