Commit | Line | Data |
---|---|---|
2908d778 JB |
1 | /* |
2 | * SAS host prototypes and structures header file | |
3 | * | |
4 | * Copyright (C) 2005 Adaptec, Inc. All rights reserved. | |
5 | * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com> | |
6 | * | |
7 | * This file is licensed under GPLv2. | |
8 | * | |
9 | * This program is free software; you can redistribute it and/or | |
10 | * modify it under the terms of the GNU General Public License as | |
11 | * published by the Free Software Foundation; either version 2 of the | |
12 | * License, or (at your option) any later version. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, but | |
15 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
17 | * General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License | |
20 | * along with this program; if not, write to the Free Software | |
21 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 | |
22 | * USA | |
23 | * | |
24 | */ | |
25 | ||
26 | #ifndef _LIBSAS_H_ | |
27 | #define _LIBSAS_H_ | |
28 | ||
29 | ||
30 | #include <linux/timer.h> | |
31 | #include <linux/pci.h> | |
32 | #include <scsi/sas.h> | |
fa1c1e8f | 33 | #include <linux/libata.h> |
2908d778 | 34 | #include <linux/list.h> |
2908d778 JB |
35 | #include <scsi/scsi_device.h> |
36 | #include <scsi/scsi_cmnd.h> | |
37 | #include <scsi/scsi_transport_sas.h> | |
87ae9afd | 38 | #include <linux/scatterlist.h> |
5a0e3ad6 | 39 | #include <linux/slab.h> |
2908d778 JB |
40 | |
41 | struct block_device; | |
42 | ||
43 | enum sas_class { | |
44 | SAS, | |
45 | EXPANDER | |
46 | }; | |
47 | ||
48 | enum sas_phy_role { | |
49 | PHY_ROLE_NONE = 0, | |
50 | PHY_ROLE_TARGET = 0x40, | |
51 | PHY_ROLE_INITIATOR = 0x80, | |
52 | }; | |
53 | ||
54 | enum sas_phy_type { | |
55 | PHY_TYPE_PHYSICAL, | |
56 | PHY_TYPE_VIRTUAL | |
57 | }; | |
58 | ||
59 | /* The events are mnemonically described in sas_dump.c | |
60 | * so when updating/adding events here, please also | |
61 | * update the other file too. | |
62 | */ | |
63 | enum ha_event { | |
64 | HAE_RESET = 0U, | |
65 | HA_NUM_EVENTS = 1, | |
66 | }; | |
67 | ||
68 | enum port_event { | |
69 | PORTE_BYTES_DMAED = 0U, | |
70 | PORTE_BROADCAST_RCVD = 1, | |
71 | PORTE_LINK_RESET_ERR = 2, | |
72 | PORTE_TIMER_EVENT = 3, | |
73 | PORTE_HARD_RESET = 4, | |
74 | PORT_NUM_EVENTS = 5, | |
75 | }; | |
76 | ||
77 | enum phy_event { | |
78 | PHYE_LOSS_OF_SIGNAL = 0U, | |
79 | PHYE_OOB_DONE = 1, | |
80 | PHYE_OOB_ERROR = 2, | |
81 | PHYE_SPINUP_HOLD = 3, /* hot plug SATA, no COMWAKE sent */ | |
303694ee DW |
82 | PHYE_RESUME_TIMEOUT = 4, |
83 | PHY_NUM_EVENTS = 5, | |
2908d778 JB |
84 | }; |
85 | ||
86 | enum discover_event { | |
87 | DISCE_DISCOVER_DOMAIN = 0U, | |
88 | DISCE_REVALIDATE_DOMAIN = 1, | |
89 | DISCE_PORT_GONE = 2, | |
87c8331f | 90 | DISCE_PROBE = 3, |
303694ee DW |
91 | DISCE_SUSPEND = 4, |
92 | DISCE_RESUME = 5, | |
93 | DISCE_DESTRUCT = 6, | |
94 | DISC_NUM_EVENTS = 7, | |
2908d778 JB |
95 | }; |
96 | ||
97 | /* ---------- Expander Devices ---------- */ | |
98 | ||
2908d778 JB |
99 | #define to_dom_device(_obj) container_of(_obj, struct domain_device, dev_obj) |
100 | #define to_dev_attr(_attr) container_of(_attr, struct domain_dev_attribute,\ | |
101 | attr) | |
102 | ||
103 | enum routing_attribute { | |
104 | DIRECT_ROUTING, | |
105 | SUBTRACTIVE_ROUTING, | |
106 | TABLE_ROUTING, | |
107 | }; | |
108 | ||
109 | enum ex_phy_state { | |
110 | PHY_EMPTY, | |
111 | PHY_VACANT, | |
112 | PHY_NOT_PRESENT, | |
113 | PHY_DEVICE_DISCOVERED | |
114 | }; | |
115 | ||
116 | struct ex_phy { | |
117 | int phy_id; | |
118 | ||
119 | enum ex_phy_state phy_state; | |
120 | ||
aa9f8328 | 121 | enum sas_device_type attached_dev_type; |
88edf746 | 122 | enum sas_linkrate linkrate; |
2908d778 JB |
123 | |
124 | u8 attached_sata_host:1; | |
125 | u8 attached_sata_dev:1; | |
126 | u8 attached_sata_ps:1; | |
127 | ||
5929faf3 DW |
128 | enum sas_protocol attached_tproto; |
129 | enum sas_protocol attached_iproto; | |
2908d778 JB |
130 | |
131 | u8 attached_sas_addr[SAS_ADDR_SIZE]; | |
132 | u8 attached_phy_id; | |
133 | ||
303694ee | 134 | int phy_change_count; |
2908d778 JB |
135 | enum routing_attribute routing_attr; |
136 | u8 virtual:1; | |
137 | ||
138 | int last_da_index; | |
139 | ||
140 | struct sas_phy *phy; | |
141 | struct sas_port *port; | |
142 | }; | |
143 | ||
144 | struct expander_device { | |
145 | struct list_head children; | |
146 | ||
303694ee | 147 | int ex_change_count; |
2908d778 JB |
148 | u16 max_route_indexes; |
149 | u8 num_phys; | |
ffaac8f4 LT |
150 | |
151 | u8 t2t_supp:1; | |
2908d778 JB |
152 | u8 configuring:1; |
153 | u8 conf_route_table:1; | |
ffaac8f4 | 154 | |
2908d778 JB |
155 | u8 enclosure_logical_id[8]; |
156 | ||
157 | struct ex_phy *ex_phy; | |
158 | struct sas_port *parent_port; | |
89d3cf6a JS |
159 | |
160 | struct mutex cmd_mutex; | |
2908d778 JB |
161 | }; |
162 | ||
163 | /* ---------- SATA device ---------- */ | |
164 | enum ata_command_set { | |
165 | ATA_COMMAND_SET = 0, | |
166 | ATAPI_COMMAND_SET = 1, | |
167 | }; | |
168 | ||
6ef1b512 DW |
169 | #define ATA_RESP_FIS_SIZE 24 |
170 | ||
2908d778 JB |
171 | struct sata_device { |
172 | enum ata_command_set command_set; | |
173 | struct smp_resp rps_resp; /* report_phy_sata_resp */ | |
2908d778 | 174 | u8 port_no; /* port number, if this is a PM (Port) */ |
fa1c1e8f DW |
175 | |
176 | struct ata_port *ap; | |
177 | struct ata_host ata_host; | |
6ef1b512 | 178 | u8 fis[ATA_RESP_FIS_SIZE]; |
2908d778 JB |
179 | }; |
180 | ||
5db45bdc DW |
181 | struct ssp_device { |
182 | struct list_head eh_list_node; /* pending a user requested eh action */ | |
183 | struct scsi_lun reset_lun; | |
184 | }; | |
185 | ||
e139942d DW |
186 | enum { |
187 | SAS_DEV_GONE, | |
303694ee | 188 | SAS_DEV_FOUND, /* device notified to lldd */ |
87c8331f | 189 | SAS_DEV_DESTROY, |
e4a9c373 | 190 | SAS_DEV_EH_PENDING, |
5db45bdc DW |
191 | SAS_DEV_LU_RESET, |
192 | SAS_DEV_RESET, | |
e139942d DW |
193 | }; |
194 | ||
2908d778 | 195 | struct domain_device { |
9095a64a | 196 | spinlock_t done_lock; |
aa9f8328 | 197 | enum sas_device_type dev_type; |
2908d778 | 198 | |
88edf746 JB |
199 | enum sas_linkrate linkrate; |
200 | enum sas_linkrate min_linkrate; | |
201 | enum sas_linkrate max_linkrate; | |
2908d778 JB |
202 | |
203 | int pathways; | |
204 | ||
205 | struct domain_device *parent; | |
206 | struct list_head siblings; /* devices on the same level */ | |
207 | struct asd_sas_port *port; /* shortcut to root of the tree */ | |
f41a0c44 | 208 | struct sas_phy *phy; |
2908d778 JB |
209 | |
210 | struct list_head dev_list_node; | |
87c8331f | 211 | struct list_head disco_list_node; /* awaiting probe or destruct */ |
2908d778 | 212 | |
5929faf3 DW |
213 | enum sas_protocol iproto; |
214 | enum sas_protocol tproto; | |
2908d778 JB |
215 | |
216 | struct sas_rphy *rphy; | |
217 | ||
218 | u8 sas_addr[SAS_ADDR_SIZE]; | |
219 | u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE]; | |
220 | ||
221 | u8 frame_rcvd[32]; | |
222 | ||
223 | union { | |
224 | struct expander_device ex_dev; | |
225 | struct sata_device sata_dev; /* STP & directly attached */ | |
5db45bdc | 226 | struct ssp_device ssp_dev; |
2908d778 JB |
227 | }; |
228 | ||
229 | void *lldd_dev; | |
e139942d | 230 | unsigned long state; |
735f7d2f | 231 | struct kref kref; |
2908d778 JB |
232 | }; |
233 | ||
22b9153f DW |
234 | struct sas_work { |
235 | struct list_head drain_node; | |
c4028958 | 236 | struct work_struct work; |
22b9153f DW |
237 | }; |
238 | ||
239 | static inline void INIT_SAS_WORK(struct sas_work *sw, void (*fn)(struct work_struct *)) | |
240 | { | |
241 | INIT_WORK(&sw->work, fn); | |
242 | INIT_LIST_HEAD(&sw->drain_node); | |
243 | } | |
244 | ||
245 | struct sas_discovery_event { | |
246 | struct sas_work work; | |
c4028958 DH |
247 | struct asd_sas_port *port; |
248 | }; | |
249 | ||
22b9153f DW |
250 | static inline struct sas_discovery_event *to_sas_discovery_event(struct work_struct *work) |
251 | { | |
252 | struct sas_discovery_event *ev = container_of(work, typeof(*ev), work.work); | |
253 | ||
254 | return ev; | |
255 | } | |
256 | ||
2908d778 | 257 | struct sas_discovery { |
c4028958 | 258 | struct sas_discovery_event disc_work[DISC_NUM_EVENTS]; |
2908d778 JB |
259 | unsigned long pending; |
260 | u8 fanout_sas_addr[8]; | |
261 | u8 eeds_a[8]; | |
262 | u8 eeds_b[8]; | |
263 | int max_level; | |
264 | }; | |
265 | ||
2908d778 JB |
266 | /* The port struct is Class:RW, driver:RO */ |
267 | struct asd_sas_port { | |
268 | /* private: */ | |
269 | struct completion port_gone_completion; | |
270 | ||
271 | struct sas_discovery disc; | |
272 | struct domain_device *port_dev; | |
273 | spinlock_t dev_list_lock; | |
274 | struct list_head dev_list; | |
87c8331f DW |
275 | struct list_head disco_list; |
276 | struct list_head destroy_list; | |
88edf746 | 277 | enum sas_linkrate linkrate; |
2908d778 | 278 | |
22b9153f | 279 | struct sas_work work; |
303694ee | 280 | int suspended; |
2908d778 JB |
281 | |
282 | /* public: */ | |
283 | int id; | |
284 | ||
285 | enum sas_class class; | |
286 | u8 sas_addr[SAS_ADDR_SIZE]; | |
287 | u8 attached_sas_addr[SAS_ADDR_SIZE]; | |
5929faf3 DW |
288 | enum sas_protocol iproto; |
289 | enum sas_protocol tproto; | |
2908d778 JB |
290 | |
291 | enum sas_oob_mode oob_mode; | |
292 | ||
293 | spinlock_t phy_list_lock; | |
294 | struct list_head phy_list; | |
295 | int num_phys; | |
296 | u32 phy_mask; | |
297 | ||
298 | struct sas_ha_struct *ha; | |
299 | ||
300 | struct sas_port *port; | |
301 | ||
302 | void *lldd_port; /* not touched by the sas class code */ | |
303 | }; | |
304 | ||
c4028958 | 305 | struct asd_sas_event { |
22b9153f | 306 | struct sas_work work; |
c4028958 DH |
307 | struct asd_sas_phy *phy; |
308 | }; | |
309 | ||
22b9153f DW |
310 | static inline struct asd_sas_event *to_asd_sas_event(struct work_struct *work) |
311 | { | |
312 | struct asd_sas_event *ev = container_of(work, typeof(*ev), work.work); | |
313 | ||
314 | return ev; | |
315 | } | |
316 | ||
2908d778 JB |
317 | /* The phy pretty much is controlled by the LLDD. |
318 | * The class only reads those fields. | |
319 | */ | |
320 | struct asd_sas_phy { | |
321 | /* private: */ | |
c4028958 DH |
322 | struct asd_sas_event port_events[PORT_NUM_EVENTS]; |
323 | struct asd_sas_event phy_events[PHY_NUM_EVENTS]; | |
2908d778 JB |
324 | |
325 | unsigned long port_events_pending; | |
326 | unsigned long phy_events_pending; | |
327 | ||
328 | int error; | |
303694ee | 329 | int suspended; |
2908d778 JB |
330 | |
331 | struct sas_phy *phy; | |
332 | ||
333 | /* public: */ | |
334 | /* The following are class:RO, driver:R/W */ | |
335 | int enabled; /* must be set */ | |
336 | ||
337 | int id; /* must be set */ | |
338 | enum sas_class class; | |
5929faf3 DW |
339 | enum sas_protocol iproto; |
340 | enum sas_protocol tproto; | |
2908d778 JB |
341 | |
342 | enum sas_phy_type type; | |
343 | enum sas_phy_role role; | |
344 | enum sas_oob_mode oob_mode; | |
88edf746 | 345 | enum sas_linkrate linkrate; |
2908d778 JB |
346 | |
347 | u8 *sas_addr; /* must be set */ | |
348 | u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */ | |
349 | ||
350 | spinlock_t frame_rcvd_lock; | |
351 | u8 *frame_rcvd; /* must be set */ | |
352 | int frame_rcvd_size; | |
353 | ||
354 | spinlock_t sas_prim_lock; | |
355 | u32 sas_prim; | |
356 | ||
357 | struct list_head port_phy_el; /* driver:RO */ | |
358 | struct asd_sas_port *port; /* Class:RW, driver: RO */ | |
359 | ||
360 | struct sas_ha_struct *ha; /* may be set; the class sets it anyway */ | |
361 | ||
362 | void *lldd_phy; /* not touched by the sas_class_code */ | |
363 | }; | |
364 | ||
365 | struct scsi_core { | |
366 | struct Scsi_Host *shost; | |
367 | ||
2908d778 JB |
368 | }; |
369 | ||
c4028958 | 370 | struct sas_ha_event { |
22b9153f | 371 | struct sas_work work; |
c4028958 DH |
372 | struct sas_ha_struct *ha; |
373 | }; | |
374 | ||
22b9153f DW |
375 | static inline struct sas_ha_event *to_sas_ha_event(struct work_struct *work) |
376 | { | |
377 | struct sas_ha_event *ev = container_of(work, typeof(*ev), work.work); | |
378 | ||
379 | return ev; | |
380 | } | |
381 | ||
6b0efb85 DW |
382 | enum sas_ha_state { |
383 | SAS_HA_REGISTERED, | |
b1124cd3 | 384 | SAS_HA_DRAINING, |
87c8331f | 385 | SAS_HA_ATA_EH_ACTIVE, |
9095a64a | 386 | SAS_HA_FROZEN, |
6b0efb85 DW |
387 | }; |
388 | ||
2908d778 JB |
389 | struct sas_ha_struct { |
390 | /* private: */ | |
c4028958 | 391 | struct sas_ha_event ha_events[HA_NUM_EVENTS]; |
2908d778 JB |
392 | unsigned long pending; |
393 | ||
b1124cd3 DW |
394 | struct list_head defer_q; /* work queued while draining */ |
395 | struct mutex drain_mutex; | |
f8daa6e6 | 396 | unsigned long state; |
e4a9c373 DW |
397 | spinlock_t lock; |
398 | int eh_active; | |
5db45bdc DW |
399 | wait_queue_head_t eh_wait_q; |
400 | struct list_head eh_dev_q; | |
6b0efb85 | 401 | |
87c8331f DW |
402 | struct mutex disco_mutex; |
403 | ||
2908d778 JB |
404 | struct scsi_core core; |
405 | ||
406 | /* public: */ | |
407 | char *sas_ha_name; | |
1d1bbee6 | 408 | struct device *dev; /* should be set */ |
2908d778 JB |
409 | struct module *lldd_module; /* should be set */ |
410 | ||
411 | u8 *sas_addr; /* must be set */ | |
412 | u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE]; | |
413 | ||
414 | spinlock_t phy_port_lock; | |
415 | struct asd_sas_phy **sas_phy; /* array of valid pointers, must be set */ | |
416 | struct asd_sas_port **sas_port; /* array of valid pointers, must be set */ | |
417 | int num_phys; /* must be set, gt 0, static */ | |
418 | ||
00f0254e DW |
419 | int strict_wide_ports; /* both sas_addr and attached_sas_addr must match |
420 | * their siblings when forming wide ports */ | |
2908d778 JB |
421 | |
422 | /* LLDD calls these to notify the class of an event. */ | |
423 | void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event); | |
424 | void (*notify_port_event)(struct asd_sas_phy *, enum port_event); | |
425 | void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event); | |
426 | ||
427 | void *lldd_ha; /* not touched by sas class code */ | |
f456393e | 428 | |
3944f509 DW |
429 | struct list_head eh_done_q; /* complete via scsi_eh_flush_done_q */ |
430 | struct list_head eh_ata_q; /* scmds to promote from sas to ata eh */ | |
2908d778 JB |
431 | }; |
432 | ||
433 | #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata) | |
434 | ||
435 | static inline struct domain_device * | |
436 | starget_to_domain_dev(struct scsi_target *starget) { | |
437 | return starget->hostdata; | |
438 | } | |
439 | ||
440 | static inline struct domain_device * | |
441 | sdev_to_domain_dev(struct scsi_device *sdev) { | |
442 | return starget_to_domain_dev(sdev->sdev_target); | |
443 | } | |
444 | ||
b50102d3 DW |
445 | static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev) |
446 | { | |
447 | return &dev->sata_dev.ap->link.device[0]; | |
448 | } | |
449 | ||
2908d778 JB |
450 | static inline struct domain_device * |
451 | cmd_to_domain_dev(struct scsi_cmnd *cmd) | |
452 | { | |
453 | return sdev_to_domain_dev(cmd->device); | |
454 | } | |
455 | ||
456 | void sas_hash_addr(u8 *hashed, const u8 *sas_addr); | |
457 | ||
458 | /* Before calling a notify event, LLDD should use this function | |
459 | * when the link is severed (possibly from its tasklet). | |
460 | * The idea is that the Class only reads those, while the LLDD, | |
461 | * can R/W these (thus avoiding a race). | |
462 | */ | |
463 | static inline void sas_phy_disconnected(struct asd_sas_phy *phy) | |
464 | { | |
465 | phy->oob_mode = OOB_NOT_CONNECTED; | |
88edf746 | 466 | phy->linkrate = SAS_LINK_RATE_UNKNOWN; |
2908d778 JB |
467 | } |
468 | ||
8ec6552f DW |
469 | static inline unsigned int to_sas_gpio_od(int device, int bit) |
470 | { | |
471 | return 3 * device + bit; | |
472 | } | |
473 | ||
f41a0c44 DW |
474 | static inline void sas_put_local_phy(struct sas_phy *phy) |
475 | { | |
476 | put_device(&phy->dev); | |
477 | } | |
478 | ||
d962480e | 479 | #ifdef CONFIG_SCSI_SAS_HOST_SMP |
8ec6552f | 480 | int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count); |
d962480e DW |
481 | #else |
482 | static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count) | |
483 | { | |
484 | return -1; | |
485 | } | |
486 | #endif | |
8ec6552f | 487 | |
2908d778 JB |
488 | /* ---------- Tasks ---------- */ |
489 | /* | |
490 | service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED | | |
491 | exec_status | | | | |
492 | ---------------------+---------------------+-----------------------+ | |
493 | SAM_... | X | | | |
494 | DEV_NO_RESPONSE | X | X | | |
495 | INTERRUPTED | X | | | |
496 | QUEUE_FULL | | X | | |
497 | DEVICE_UNKNOWN | | X | | |
498 | SG_ERR | | X | | |
499 | ---------------------+---------------------+-----------------------+ | |
500 | */ | |
501 | ||
502 | enum service_response { | |
503 | SAS_TASK_COMPLETE, | |
504 | SAS_TASK_UNDELIVERED = -1, | |
505 | }; | |
506 | ||
507 | enum exec_status { | |
a3a14252 DW |
508 | /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of |
509 | * them here to silence 'case value not in enumerated type' warnings | |
510 | */ | |
511 | __SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION, | |
2908d778 JB |
512 | |
513 | SAS_DEV_NO_RESPONSE = 0x80, | |
514 | SAS_DATA_UNDERRUN, | |
515 | SAS_DATA_OVERRUN, | |
516 | SAS_INTERRUPTED, | |
517 | SAS_QUEUE_FULL, | |
518 | SAS_DEVICE_UNKNOWN, | |
519 | SAS_SG_ERR, | |
520 | SAS_OPEN_REJECT, | |
521 | SAS_OPEN_TO, | |
522 | SAS_PROTO_RESPONSE, | |
523 | SAS_PHY_DOWN, | |
524 | SAS_NAK_R_ERR, | |
525 | SAS_PENDING, | |
526 | SAS_ABORTED_TASK, | |
527 | }; | |
528 | ||
529 | /* When a task finishes with a response, the LLDD examines the | |
530 | * response: | |
531 | * - For an ATA task task_status_struct::stat is set to | |
532 | * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the | |
533 | * contents of struct ata_task_resp. | |
534 | * - For SSP tasks, if no data is present or status/TMF response | |
535 | * is valid, task_status_struct::stat is set. If data is present | |
536 | * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets | |
537 | * task_status_struct::buf_valid_size, and task_status_struct::stat is | |
538 | * set to SAM_CHECK_COND. | |
539 | * | |
540 | * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp | |
541 | * for ATA task. | |
542 | * | |
543 | * "frame_len" is the total frame length, which could be more or less | |
544 | * than actually copied. | |
545 | * | |
546 | * Tasks ending with response, always set the residual field. | |
547 | */ | |
548 | struct ata_task_resp { | |
549 | u16 frame_len; | |
6ef1b512 | 550 | u8 ending_fis[ATA_RESP_FIS_SIZE]; /* dev to host or data-in */ |
2908d778 JB |
551 | }; |
552 | ||
553 | #define SAS_STATUS_BUF_SIZE 96 | |
554 | ||
555 | struct task_status_struct { | |
556 | enum service_response resp; | |
557 | enum exec_status stat; | |
558 | int buf_valid_size; | |
559 | ||
560 | u8 buf[SAS_STATUS_BUF_SIZE]; | |
561 | ||
562 | u32 residual; | |
563 | enum sas_open_rej_reason open_rej_reason; | |
564 | }; | |
565 | ||
566 | /* ATA and ATAPI task queuable to a SAS LLDD. | |
567 | */ | |
568 | struct sas_ata_task { | |
569 | struct host_to_dev_fis fis; | |
570 | u8 atapi_packet[16]; /* 0 if not ATAPI task */ | |
571 | ||
572 | u8 retry_count; /* hardware retry, should be > 0 */ | |
573 | ||
574 | u8 dma_xfer:1; /* PIO:0 or DMA:1 */ | |
575 | u8 use_ncq:1; | |
576 | u8 set_affil_pol:1; | |
577 | u8 stp_affil_pol:1; | |
578 | ||
579 | u8 device_control_reg_update:1; | |
580 | }; | |
581 | ||
582 | struct sas_smp_task { | |
583 | struct scatterlist smp_req; | |
584 | struct scatterlist smp_resp; | |
585 | }; | |
586 | ||
587 | enum task_attribute { | |
588 | TASK_ATTR_SIMPLE = 0, | |
589 | TASK_ATTR_HOQ = 1, | |
590 | TASK_ATTR_ORDERED= 2, | |
591 | TASK_ATTR_ACA = 4, | |
592 | }; | |
593 | ||
594 | struct sas_ssp_task { | |
595 | u8 retry_count; /* hardware retry, should be > 0 */ | |
596 | ||
597 | u8 LUN[8]; | |
598 | u8 enable_first_burst:1; | |
599 | enum task_attribute task_attr; | |
600 | u8 task_prio; | |
e73823f7 | 601 | struct scsi_cmnd *cmd; |
2908d778 JB |
602 | }; |
603 | ||
604 | struct sas_task { | |
605 | struct domain_device *dev; | |
2908d778 JB |
606 | |
607 | spinlock_t task_state_lock; | |
608 | unsigned task_state_flags; | |
609 | ||
5929faf3 | 610 | enum sas_protocol task_proto; |
2908d778 | 611 | |
2908d778 JB |
612 | union { |
613 | struct sas_ata_task ata_task; | |
614 | struct sas_smp_task smp_task; | |
615 | struct sas_ssp_task ssp_task; | |
616 | }; | |
617 | ||
618 | struct scatterlist *scatter; | |
619 | int num_scatter; | |
620 | u32 total_xfer_len; | |
621 | u8 data_dir:2; /* Use PCI_DMA_... */ | |
622 | ||
623 | struct task_status_struct task_status; | |
624 | void (*task_done)(struct sas_task *); | |
625 | ||
626 | void *lldd_task; /* for use by LLDDs */ | |
627 | void *uldd_task; | |
f0bf750c DW |
628 | struct sas_task_slow *slow_task; |
629 | }; | |
79a5eb60 | 630 | |
f0bf750c DW |
631 | struct sas_task_slow { |
632 | /* standard/extra infrastructure for slow path commands (SMP and | |
633 | * internal lldd commands | |
634 | */ | |
635 | struct timer_list timer; | |
636 | struct completion completion; | |
2908d778 JB |
637 | }; |
638 | ||
f456393e DW |
639 | #define SAS_TASK_STATE_PENDING 1 |
640 | #define SAS_TASK_STATE_DONE 2 | |
641 | #define SAS_TASK_STATE_ABORTED 4 | |
3ebf6922 | 642 | #define SAS_TASK_NEED_DEV_RESET 8 |
b218a0d8 | 643 | #define SAS_TASK_AT_INITIATOR 16 |
2908d778 | 644 | |
4fcf812c | 645 | extern struct sas_task *sas_alloc_task(gfp_t flags); |
f0bf750c | 646 | extern struct sas_task *sas_alloc_slow_task(gfp_t flags); |
4fcf812c | 647 | extern void sas_free_task(struct sas_task *task); |
2908d778 JB |
648 | |
649 | struct sas_domain_function_template { | |
650 | /* The class calls these to notify the LLDD of an event. */ | |
651 | void (*lldd_port_formed)(struct asd_sas_phy *); | |
652 | void (*lldd_port_deformed)(struct asd_sas_phy *); | |
653 | ||
654 | /* The class calls these when a device is found or gone. */ | |
655 | int (*lldd_dev_found)(struct domain_device *); | |
656 | void (*lldd_dev_gone)(struct domain_device *); | |
657 | ||
79855d17 | 658 | int (*lldd_execute_task)(struct sas_task *, gfp_t gfp_flags); |
2908d778 JB |
659 | |
660 | /* Task Management Functions. Must be called from process context. */ | |
661 | int (*lldd_abort_task)(struct sas_task *); | |
662 | int (*lldd_abort_task_set)(struct domain_device *, u8 *lun); | |
663 | int (*lldd_clear_aca)(struct domain_device *, u8 *lun); | |
664 | int (*lldd_clear_task_set)(struct domain_device *, u8 *lun); | |
665 | int (*lldd_I_T_nexus_reset)(struct domain_device *); | |
36a39947 | 666 | int (*lldd_ata_check_ready)(struct domain_device *); |
b91bb296 | 667 | void (*lldd_ata_set_dmamode)(struct domain_device *); |
2908d778 JB |
668 | int (*lldd_lu_reset)(struct domain_device *, u8 *lun); |
669 | int (*lldd_query_task)(struct sas_task *); | |
670 | ||
671 | /* Port and Adapter management */ | |
672 | int (*lldd_clear_nexus_port)(struct asd_sas_port *); | |
673 | int (*lldd_clear_nexus_ha)(struct sas_ha_struct *); | |
674 | ||
675 | /* Phy management */ | |
a01e70e5 | 676 | int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *); |
8ec6552f DW |
677 | |
678 | /* GPIO support */ | |
679 | int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type, | |
680 | u8 reg_index, u8 reg_count, u8 *write_data); | |
2908d778 JB |
681 | }; |
682 | ||
683 | extern int sas_register_ha(struct sas_ha_struct *); | |
684 | extern int sas_unregister_ha(struct sas_ha_struct *); | |
303694ee DW |
685 | extern void sas_prep_resume_ha(struct sas_ha_struct *sas_ha); |
686 | extern void sas_resume_ha(struct sas_ha_struct *sas_ha); | |
687 | extern void sas_suspend_ha(struct sas_ha_struct *sas_ha); | |
2908d778 | 688 | |
acbf167d DW |
689 | int sas_set_phy_speed(struct sas_phy *phy, |
690 | struct sas_phy_linkrates *rates); | |
dea22214 | 691 | int sas_phy_reset(struct sas_phy *phy, int hard_reset); |
f281233d | 692 | extern int sas_queuecommand(struct Scsi_Host * ,struct scsi_cmnd *); |
2908d778 | 693 | extern int sas_target_alloc(struct scsi_target *); |
2908d778 | 694 | extern int sas_slave_configure(struct scsi_device *); |
db5ed4df | 695 | extern int sas_change_queue_depth(struct scsi_device *, int new_depth); |
2908d778 JB |
696 | extern int sas_change_queue_type(struct scsi_device *, int qt); |
697 | extern int sas_bios_param(struct scsi_device *, | |
698 | struct block_device *, | |
699 | sector_t capacity, int *hsc); | |
700 | extern struct scsi_transport_template * | |
701 | sas_domain_attach_transport(struct sas_domain_function_template *); | |
702 | extern void sas_domain_release_transport(struct scsi_transport_template *); | |
703 | ||
704 | int sas_discover_root_expander(struct domain_device *); | |
705 | ||
706 | void sas_init_ex_attr(void); | |
707 | ||
708 | int sas_ex_revalidate_domain(struct domain_device *); | |
709 | ||
7d05919a | 710 | void sas_unregister_domain_devices(struct asd_sas_port *port, int gone); |
2908d778 JB |
711 | void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *); |
712 | int sas_discover_event(struct asd_sas_port *, enum discover_event ev); | |
713 | ||
714 | int sas_discover_sata(struct domain_device *); | |
715 | int sas_discover_end_dev(struct domain_device *); | |
716 | ||
1a34c064 | 717 | void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *); |
2908d778 JB |
718 | |
719 | void sas_init_dev(struct domain_device *); | |
720 | ||
396819fb | 721 | void sas_task_abort(struct sas_task *); |
9524c682 | 722 | int sas_eh_abort_handler(struct scsi_cmnd *cmd); |
ad689233 | 723 | int sas_eh_device_reset_handler(struct scsi_cmnd *cmd); |
a9344e68 | 724 | int sas_eh_bus_reset_handler(struct scsi_cmnd *cmd); |
79a5eb60 | 725 | |
fa1c1e8f DW |
726 | extern void sas_target_destroy(struct scsi_target *); |
727 | extern int sas_slave_alloc(struct scsi_device *); | |
728 | extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg); | |
b1124cd3 | 729 | extern int sas_drain_work(struct sas_ha_struct *ha); |
fa1c1e8f | 730 | |
ba1fc175 FT |
731 | extern int sas_smp_handler(struct Scsi_Host *shost, struct sas_rphy *rphy, |
732 | struct request *req); | |
366ca51f JB |
733 | |
734 | extern void sas_ssp_task_response(struct device *dev, struct sas_task *task, | |
735 | struct ssp_response_iu *iu); | |
f41a0c44 | 736 | struct sas_phy *sas_get_local_phy(struct domain_device *dev); |
366ca51f | 737 | |
45e6cdf4 DW |
738 | int sas_request_addr(struct Scsi_Host *shost, u8 *addr); |
739 | ||
2908d778 | 740 | #endif /* _SASLIB_H_ */ |