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