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