xref: /linux/include/scsi/scsi_transport_sas.h (revision 858259cf7d1c443c836a2022b78cb281f0a9b95e)
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,
33 	SAS_LINK_VIRTUAL,
34 };
35 
36 struct sas_identify {
37 	enum sas_device_type	device_type;
38 	enum sas_protocol	initiator_port_protocols;
39 	enum sas_protocol	target_port_protocols;
40 	u64			sas_address;
41 	u8			phy_identifier;
42 };
43 
44 struct sas_phy {
45 	struct device		dev;
46 	int			number;
47 
48 	/* phy identification */
49 	struct sas_identify	identify;
50 
51 	/* phy attributes */
52 	enum sas_linkrate	negotiated_linkrate;
53 	enum sas_linkrate	minimum_linkrate_hw;
54 	enum sas_linkrate	minimum_linkrate;
55 	enum sas_linkrate	maximum_linkrate_hw;
56 	enum sas_linkrate	maximum_linkrate;
57 	u8			port_identifier;
58 
59 	/* internal state */
60 	unsigned int		local_attached : 1;
61 
62 	/* link error statistics */
63 	u32			invalid_dword_count;
64 	u32			running_disparity_error_count;
65 	u32			loss_of_dword_sync_count;
66 	u32			phy_reset_problem_count;
67 
68 	/* the other end of the link */
69 	struct sas_rphy		*rphy;
70 };
71 
72 #define dev_to_phy(d) \
73 	container_of((d), struct sas_phy, dev)
74 #define transport_class_to_phy(cdev) \
75 	dev_to_phy((cdev)->dev)
76 #define phy_to_shost(phy) \
77 	dev_to_shost((phy)->dev.parent)
78 
79 struct sas_rphy {
80 	struct device		dev;
81 	struct sas_identify	identify;
82 	struct list_head	list;
83 	u32			scsi_target_id;
84 };
85 
86 #define dev_to_rphy(d) \
87 	container_of((d), struct sas_rphy, dev)
88 #define transport_class_to_rphy(cdev) \
89 	dev_to_rphy((cdev)->dev)
90 #define rphy_to_shost(rphy) \
91 	dev_to_shost((rphy)->dev.parent)
92 
93 
94 /* The functions by which the transport class and the driver communicate */
95 struct sas_function_template {
96 	int (*get_linkerrors)(struct sas_phy *);
97 	int (*phy_reset)(struct sas_phy *, int);
98 };
99 
100 
101 extern void sas_remove_host(struct Scsi_Host *);
102 
103 extern struct sas_phy *sas_phy_alloc(struct device *, int);
104 extern void sas_phy_free(struct sas_phy *);
105 extern int sas_phy_add(struct sas_phy *);
106 extern void sas_phy_delete(struct sas_phy *);
107 extern int scsi_is_sas_phy(const struct device *);
108 
109 extern struct sas_rphy *sas_rphy_alloc(struct sas_phy *);
110 void sas_rphy_free(struct sas_rphy *);
111 extern int sas_rphy_add(struct sas_rphy *);
112 extern void sas_rphy_delete(struct sas_rphy *);
113 extern int scsi_is_sas_rphy(const struct device *);
114 
115 extern struct scsi_transport_template *
116 sas_attach_transport(struct sas_function_template *);
117 extern void sas_release_transport(struct scsi_transport_template *);
118 
119 #endif /* SCSI_TRANSPORT_SAS_H */
120