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