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