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