[mirror_ubuntu-hirsute-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>

struct scsi_transport_template;
struct sas_rphy;


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,
};

enum sas_linkrate {
	SAS_LINK_RATE_UNKNOWN,
	SAS_PHY_DISABLED,
	SAS_LINK_RATE_FAILED,
	SAS_SATA_SPINUP_HOLD,
	SAS_SATA_PORT_SELECTOR,
	SAS_LINK_RATE_1_5_GBPS,
	SAS_LINK_RATE_3_0_GBPS,
	SAS_LINK_RATE_6_0_GBPS,
	SAS_LINK_VIRTUAL,
};

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;

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

	/* internal state */
	unsigned int		local_attached : 1;

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

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

#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 sas_rphy {
	struct device		dev;
	struct sas_identify	identify;
	struct list_head	list;
	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;

	#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)

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


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_phy *);
extern struct sas_rphy *sas_expander_alloc(struct sas_phy *, enum sas_device_type);
void sas_rphy_free(struct sas_rphy *);
extern int sas_rphy_add(struct sas_rphy *);
extern void sas_rphy_delete(struct sas_rphy *);
extern int scsi_is_sas_rphy(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;
}

#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>
	6
	7	struct scsi_transport_template;
	8	struct sas_rphy;
	9
	10
	11	enum sas_device_type {
	12	SAS_PHY_UNUSED,
	13	SAS_END_DEVICE,
	14	SAS_EDGE_EXPANDER_DEVICE,
	15	SAS_FANOUT_EXPANDER_DEVICE,
	16	};
	17
	18	enum sas_protocol {
	19	SAS_PROTOCOL_SATA = 0x01,
	20	SAS_PROTOCOL_SMP = 0x02,
	21	SAS_PROTOCOL_STP = 0x04,
	22	SAS_PROTOCOL_SSP = 0x08,
	23	};
	24
	25	enum sas_linkrate {
	26	SAS_LINK_RATE_UNKNOWN,
	27	SAS_PHY_DISABLED,
	28	SAS_LINK_RATE_FAILED,
	29	SAS_SATA_SPINUP_HOLD,
	30	SAS_SATA_PORT_SELECTOR,
	31	SAS_LINK_RATE_1_5_GBPS,
	32	SAS_LINK_RATE_3_0_GBPS,
7e6dff62	33	SAS_LINK_RATE_6_0_GBPS,
c7ebbbce CH	34	SAS_LINK_VIRTUAL,
	35	};
	36
	37	struct sas_identify {
	38	enum sas_device_type device_type;
	39	enum sas_protocol initiator_port_protocols;
	40	enum sas_protocol target_port_protocols;
	41	u64 sas_address;
	42	u8 phy_identifier;
	43	};
	44
c7ebbbce CH	45	struct sas_phy {
	46	struct device dev;
	47	int number;
c3ee74c4 CH	48
c3ee74c4 CH	49	/* phy identification */
c7ebbbce	50	struct sas_identify identify;
c3ee74c4 CH	51
c3ee74c4 CH	52	/* phy attributes */
c7ebbbce CH	53	enum sas_linkrate negotiated_linkrate;
	54	enum sas_linkrate minimum_linkrate_hw;
	55	enum sas_linkrate minimum_linkrate;
	56	enum sas_linkrate maximum_linkrate_hw;
	57	enum sas_linkrate maximum_linkrate;
	58	u8 port_identifier;
c3ee74c4	59
ac01bbbd CH	60	/* internal state */
	61	unsigned int local_attached : 1;
	62
c3ee74c4 CH	63	/* link error statistics */
	64	u32 invalid_dword_count;
	65	u32 running_disparity_error_count;
	66	u32 loss_of_dword_sync_count;
	67	u32 phy_reset_problem_count;
	68
	69	/* the other end of the link */
c7ebbbce CH	70	struct sas_rphy *rphy;
	71	};
	72
	73	#define dev_to_phy(d) \
	74	container_of((d), struct sas_phy, dev)
	75	#define transport_class_to_phy(cdev) \
	76	dev_to_phy((cdev)->dev)
	77	#define phy_to_shost(phy) \
	78	dev_to_shost((phy)->dev.parent)
	79
	80	struct sas_rphy {
	81	struct device dev;
	82	struct sas_identify identify;
	83	struct list_head list;
	84	u32 scsi_target_id;
	85	};
	86
	87	#define dev_to_rphy(d) \
	88	container_of((d), struct sas_rphy, dev)
	89	#define transport_class_to_rphy(cdev) \
	90	dev_to_rphy((cdev)->dev)
	91	#define rphy_to_shost(rphy) \
	92	dev_to_shost((rphy)->dev.parent)
42ab0360 JB	93	#define target_to_rphy(targ) \
	94	dev_to_rphy((targ)->dev.parent)
	95
	96	struct sas_end_device {
	97	struct sas_rphy rphy;
	98	/* flags */
	99	unsigned ready_led_meaning:1;
	100	/* parameters */
	101	u16 I_T_nexus_loss_timeout;
	102	u16 initiator_response_timeout;
	103	};
	104	#define rphy_to_end_device(r) \
	105	container_of((r), struct sas_end_device, rphy)
c7ebbbce	106
79cb1819 JB	107	struct sas_expander_device {
	108	int level;
	109
	110	#define SAS_EXPANDER_VENDOR_ID_LEN 8
	111	char vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
	112	#define SAS_EXPANDER_PRODUCT_ID_LEN 16
	113	char product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
	114	#define SAS_EXPANDER_PRODUCT_REV_LEN 4
	115	char product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
	116	#define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN 8
	117	char component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
	118	u16 component_id;
	119	u8 component_revision_id;
	120
	121	struct sas_rphy rphy;
	122
	123	};
	124	#define rphy_to_expander_device(r) \
	125	container_of((r), struct sas_expander_device, rphy)
c3ee74c4 CH	126
	127	/* The functions by which the transport class and the driver communicate */
	128	struct sas_function_template {
	129	int (get_linkerrors)(struct sas_phy );
a0125641 CH	130	int (get_enclosure_identifier)(struct sas_rphy , u64 *);
a0125641 CH	131	int (get_bay_identifier)(struct sas_rphy );
07ba3a95	132	int (phy_reset)(struct sas_phy , int);
c3ee74c4 CH	133	};
	134
	135
c7ebbbce CH	136	extern void sas_remove_host(struct Scsi_Host *);
	137
	138	extern struct sas_phy sas_phy_alloc(struct device , int);
	139	extern void sas_phy_free(struct sas_phy *);
	140	extern int sas_phy_add(struct sas_phy *);
	141	extern void sas_phy_delete(struct sas_phy *);
	142	extern int scsi_is_sas_phy(const struct device *);
	143
42ab0360	144	extern struct sas_rphy sas_end_device_alloc(struct sas_phy );
79cb1819	145	extern struct sas_rphy sas_expander_alloc(struct sas_phy , enum sas_device_type);
c7ebbbce CH	146	void sas_rphy_free(struct sas_rphy *);
	147	extern int sas_rphy_add(struct sas_rphy *);
	148	extern void sas_rphy_delete(struct sas_rphy *);
	149	extern int scsi_is_sas_rphy(const struct device *);
	150
	151	extern struct scsi_transport_template *
	152	sas_attach_transport(struct sas_function_template *);
	153	extern void sas_release_transport(struct scsi_transport_template *);
42ab0360	154	int sas_read_port_mode_page(struct scsi_device *);
c7ebbbce	155
79cb1819 JB	156	static inline int
	157	scsi_is_sas_expander_device(struct device *dev)
	158	{
	159	struct sas_rphy *rphy;
	160	if (!scsi_is_sas_rphy(dev))
	161	return 0;
	162	rphy = dev_to_rphy(dev);
	163	return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE \|\|
	164	rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
	165	}
	166
c7ebbbce	167	#endif /* SCSI_TRANSPORT_SAS_H */