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