1 #ifndef SCSI_TRANSPORT_SAS_H
2 #define SCSI_TRANSPORT_SAS_H
4 #include <linux/transport_class.h>
5 #include <linux/types.h>
6 #include <linux/mutex.h>
8 struct scsi_transport_template;
12 enum sas_device_type {
15 SAS_EDGE_EXPANDER_DEVICE,
16 SAS_FANOUT_EXPANDER_DEVICE,
20 SAS_PROTOCOL_SATA = 0x01,
21 SAS_PROTOCOL_SMP = 0x02,
22 SAS_PROTOCOL_STP = 0x04,
23 SAS_PROTOCOL_SSP = 0x08,
26 static inline int sas_protocol_ata(enum sas_protocol proto)
28 return ((proto & SAS_PROTOCOL_SATA) ||
29 (proto & SAS_PROTOCOL_STP))? 1 : 0;
33 /* These Values are defined in the SAS standard */
34 SAS_LINK_RATE_UNKNOWN = 0,
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
48 SAS_LINK_RATE_FAILED = 0x10,
49 SAS_PHY_VIRTUAL = 0x11,
53 enum sas_device_type device_type;
54 enum sas_protocol initiator_port_protocols;
55 enum sas_protocol target_port_protocols;
65 /* phy identification */
66 struct sas_identify identify;
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;
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;
81 /* for the list of phys belonging to a port */
82 struct list_head port_siblings;
84 struct work_struct reset_work;
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)
96 struct sas_identify identify;
97 struct list_head list;
101 #define dev_to_rphy(d) \
102 container_of((d), struct sas_rphy, dev)
103 #define transport_class_to_rphy(cdev) \
104 dev_to_rphy((cdev)->dev)
105 #define rphy_to_shost(rphy) \
106 dev_to_shost((rphy)->dev.parent)
107 #define target_to_rphy(targ) \
108 dev_to_rphy((targ)->dev.parent)
110 struct sas_end_device {
111 struct sas_rphy rphy;
113 unsigned ready_led_meaning:1;
115 u16 I_T_nexus_loss_timeout;
116 u16 initiator_response_timeout;
118 #define rphy_to_end_device(r) \
119 container_of((r), struct sas_end_device, rphy)
121 struct sas_expander_device {
125 #define SAS_EXPANDER_VENDOR_ID_LEN 8
126 char vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
127 #define SAS_EXPANDER_PRODUCT_ID_LEN 16
128 char product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
129 #define SAS_EXPANDER_PRODUCT_REV_LEN 4
130 char product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
131 #define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN 8
132 char component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
134 u8 component_revision_id;
136 struct sas_rphy rphy;
139 #define rphy_to_expander_device(r) \
140 container_of((r), struct sas_expander_device, rphy)
148 unsigned int is_backlink:1;
150 /* the other end of the link */
151 struct sas_rphy *rphy;
153 struct mutex phy_list_mutex;
154 struct list_head phy_list;
157 #define dev_to_sas_port(d) \
158 container_of((d), struct sas_port, dev)
159 #define transport_class_to_sas_port(cdev) \
160 dev_to_sas_port((cdev)->dev)
162 struct sas_phy_linkrates {
163 enum sas_linkrate maximum_linkrate;
164 enum sas_linkrate minimum_linkrate;
167 /* The functions by which the transport class and the driver communicate */
168 struct sas_function_template {
169 int (*get_linkerrors)(struct sas_phy *);
170 int (*get_enclosure_identifier)(struct sas_rphy *, u64 *);
171 int (*get_bay_identifier)(struct sas_rphy *);
172 int (*phy_reset)(struct sas_phy *, int);
173 int (*phy_enable)(struct sas_phy *, int);
174 int (*set_phy_speed)(struct sas_phy *, struct sas_phy_linkrates *);
175 int (*smp_handler)(struct Scsi_Host *, struct sas_rphy *, struct request *);
179 void sas_remove_children(struct device *);
180 extern void sas_remove_host(struct Scsi_Host *);
182 extern struct sas_phy *sas_phy_alloc(struct device *, int);
183 extern void sas_phy_free(struct sas_phy *);
184 extern int sas_phy_add(struct sas_phy *);
185 extern void sas_phy_delete(struct sas_phy *);
186 extern int scsi_is_sas_phy(const struct device *);
188 extern struct sas_rphy *sas_end_device_alloc(struct sas_port *);
189 extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type);
190 void sas_rphy_free(struct sas_rphy *);
191 extern int sas_rphy_add(struct sas_rphy *);
192 extern void sas_rphy_remove(struct sas_rphy *);
193 extern void sas_rphy_delete(struct sas_rphy *);
194 extern int scsi_is_sas_rphy(const struct device *);
196 struct sas_port *sas_port_alloc(struct device *, int);
197 struct sas_port *sas_port_alloc_num(struct device *);
198 int sas_port_add(struct sas_port *);
199 void sas_port_free(struct sas_port *);
200 void sas_port_delete(struct sas_port *);
201 void sas_port_add_phy(struct sas_port *, struct sas_phy *);
202 void sas_port_delete_phy(struct sas_port *, struct sas_phy *);
203 void sas_port_mark_backlink(struct sas_port *);
204 int scsi_is_sas_port(const struct device *);
206 extern struct scsi_transport_template *
207 sas_attach_transport(struct sas_function_template *);
208 extern void sas_release_transport(struct scsi_transport_template *);
209 int sas_read_port_mode_page(struct scsi_device *);
212 scsi_is_sas_expander_device(struct device *dev)
214 struct sas_rphy *rphy;
215 if (!scsi_is_sas_rphy(dev))
217 rphy = dev_to_rphy(dev);
218 return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE ||
219 rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
222 #define scsi_is_sas_phy_local(phy) scsi_is_host_device((phy)->dev.parent)
224 #endif /* SCSI_TRANSPORT_SAS_H */