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

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

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

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

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


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_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;
	10
	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
	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;
c3ee74c4 CH	57
c3ee74c4 CH	58	/* phy identification */
c7ebbbce	59	struct sas_identify identify;
c3ee74c4 CH	60
c3ee74c4 CH	61	/* phy attributes */
c7ebbbce CH	62	enum sas_linkrate negotiated_linkrate;
	63	enum sas_linkrate minimum_linkrate_hw;
	64	enum sas_linkrate minimum_linkrate;
	65	enum sas_linkrate maximum_linkrate_hw;
	66	enum sas_linkrate maximum_linkrate;
c3ee74c4 CH	67
	68	/* link error statistics */
	69	u32 invalid_dword_count;
	70	u32 running_disparity_error_count;
	71	u32 loss_of_dword_sync_count;
	72	u32 phy_reset_problem_count;
	73
65c92b09 JB	74	/* for the list of phys belonging to a port */
65c92b09 JB	75	struct list_head port_siblings;
c7ebbbce CH	76	};
	77
	78	#define dev_to_phy(d) \
	79	container_of((d), struct sas_phy, dev)
	80	#define transport_class_to_phy(cdev) \
	81	dev_to_phy((cdev)->dev)
	82	#define phy_to_shost(phy) \
	83	dev_to_shost((phy)->dev.parent)
	84
	85	struct sas_rphy {
	86	struct device dev;
	87	struct sas_identify identify;
	88	struct list_head list;
	89	u32 scsi_target_id;
	90	};
	91
	92	#define dev_to_rphy(d) \
	93	container_of((d), struct sas_rphy, dev)
	94	#define transport_class_to_rphy(cdev) \
	95	dev_to_rphy((cdev)->dev)
	96	#define rphy_to_shost(rphy) \
	97	dev_to_shost((rphy)->dev.parent)
42ab0360 JB	98	#define target_to_rphy(targ) \
	99	dev_to_rphy((targ)->dev.parent)
	100
	101	struct sas_end_device {
	102	struct sas_rphy rphy;
	103	/* flags */
	104	unsigned ready_led_meaning:1;
	105	/* parameters */
	106	u16 I_T_nexus_loss_timeout;
	107	u16 initiator_response_timeout;
	108	};
	109	#define rphy_to_end_device(r) \
	110	container_of((r), struct sas_end_device, rphy)
c7ebbbce	111
79cb1819 JB	112	struct sas_expander_device {
79cb1819 JB	113	int level;
c9fefeb2	114	int next_port_id;
79cb1819 JB	115
	116	#define SAS_EXPANDER_VENDOR_ID_LEN 8
	117	char vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
	118	#define SAS_EXPANDER_PRODUCT_ID_LEN 16
	119	char product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
	120	#define SAS_EXPANDER_PRODUCT_REV_LEN 4
	121	char product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
	122	#define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN 8
	123	char component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
	124	u16 component_id;
	125	u8 component_revision_id;
	126
	127	struct sas_rphy rphy;
	128
	129	};
	130	#define rphy_to_expander_device(r) \
	131	container_of((r), struct sas_expander_device, rphy)
c3ee74c4	132
65c92b09 JB	133	struct sas_port {
	134	struct device dev;
	135
c9fefeb2	136	int port_identifier;
65c92b09	137	int num_phys;
a0e1b6ef JB	138	/* port flags */
a0e1b6ef JB	139	unsigned int is_backlink:1;
65c92b09 JB	140
	141	/* the other end of the link */
	142	struct sas_rphy *rphy;
	143
	144	struct mutex phy_list_mutex;
	145	struct list_head phy_list;
	146	};
	147
	148	#define dev_to_sas_port(d) \
	149	container_of((d), struct sas_port, dev)
	150	#define transport_class_to_sas_port(cdev) \
	151	dev_to_sas_port((cdev)->dev)
	152
c3ee74c4 CH	153	/* The functions by which the transport class and the driver communicate */
	154	struct sas_function_template {
	155	int (get_linkerrors)(struct sas_phy );
a0125641 CH	156	int (get_enclosure_identifier)(struct sas_rphy , u64 *);
a0125641 CH	157	int (get_bay_identifier)(struct sas_rphy );
07ba3a95	158	int (phy_reset)(struct sas_phy , int);
c3ee74c4 CH	159	};
	160
	161
65c92b09	162	void sas_remove_children(struct device *);
c7ebbbce CH	163	extern void sas_remove_host(struct Scsi_Host *);
	164
	165	extern struct sas_phy sas_phy_alloc(struct device , int);
	166	extern void sas_phy_free(struct sas_phy *);
	167	extern int sas_phy_add(struct sas_phy *);
	168	extern void sas_phy_delete(struct sas_phy *);
	169	extern int scsi_is_sas_phy(const struct device *);
	170
65c92b09 JB	171	extern struct sas_rphy sas_end_device_alloc(struct sas_port );
65c92b09 JB	172	extern struct sas_rphy sas_expander_alloc(struct sas_port , enum sas_device_type);
c7ebbbce CH	173	void sas_rphy_free(struct sas_rphy *);
	174	extern int sas_rphy_add(struct sas_rphy *);
	175	extern void sas_rphy_delete(struct sas_rphy *);
	176	extern int scsi_is_sas_rphy(const struct device *);
	177
65c92b09	178	struct sas_port sas_port_alloc(struct device , int);
c9fefeb2	179	struct sas_port sas_port_alloc_num(struct device );
65c92b09 JB	180	int sas_port_add(struct sas_port *);
	181	void sas_port_free(struct sas_port *);
	182	void sas_port_delete(struct sas_port *);
	183	void sas_port_add_phy(struct sas_port , struct sas_phy );
	184	void sas_port_delete_phy(struct sas_port , struct sas_phy );
a0e1b6ef	185	void sas_port_mark_backlink(struct sas_port *);
65c92b09 JB	186	int scsi_is_sas_port(const struct device *);
65c92b09 JB	187
c7ebbbce CH	188	extern struct scsi_transport_template *
	189	sas_attach_transport(struct sas_function_template *);
	190	extern void sas_release_transport(struct scsi_transport_template *);
42ab0360	191	int sas_read_port_mode_page(struct scsi_device *);
c7ebbbce	192
79cb1819 JB	193	static inline int
	194	scsi_is_sas_expander_device(struct device *dev)
	195	{
	196	struct sas_rphy *rphy;
	197	if (!scsi_is_sas_rphy(dev))
	198	return 0;
	199	rphy = dev_to_rphy(dev);
	200	return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE \|\|
	201	rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
	202	}
	203
f4ad7b58 JB	204	#define scsi_is_sas_phy_local(phy) scsi_is_host_device((phy)->dev.parent)
f4ad7b58 JB	205
c7ebbbce	206	#endif /* SCSI_TRANSPORT_SAS_H */