2 * SAS host prototypes and structures header file
4 * Copyright (C) 2005 Adaptec, Inc. All rights reserved.
5 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
7 * This file is licensed under GPLv2.
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.
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.
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
30 #include <linux/timer.h>
31 #include <linux/pci.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>
50 PHY_ROLE_TARGET = 0x40,
51 PHY_ROLE_INITIATOR = 0x80,
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.
69 PORTE_BYTES_DMAED = 0U,
70 PORTE_BROADCAST_RCVD = 1,
71 PORTE_LINK_RESET_ERR = 2,
72 PORTE_TIMER_EVENT = 3,
78 PHYE_LOSS_OF_SIGNAL = 0U,
81 PHYE_SPINUP_HOLD = 3, /* hot plug SATA, no COMWAKE sent */
86 DISCE_DISCOVER_DOMAIN = 0U,
87 DISCE_REVALIDATE_DOMAIN = 1,
94 /* ---------- Expander Devices ---------- */
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,\
100 enum routing_attribute {
110 PHY_DEVICE_DISCOVERED
116 enum ex_phy_state phy_state;
118 enum sas_dev_type attached_dev_type;
119 enum sas_linkrate linkrate;
121 u8 attached_sata_host:1;
122 u8 attached_sata_dev:1;
123 u8 attached_sata_ps:1;
125 enum sas_protocol attached_tproto;
126 enum sas_protocol attached_iproto;
128 u8 attached_sas_addr[SAS_ADDR_SIZE];
132 enum routing_attribute routing_attr;
138 struct sas_port *port;
141 struct expander_device {
142 struct list_head children;
145 u16 max_route_indexes;
150 u8 conf_route_table:1;
152 u8 enclosure_logical_id[8];
154 struct ex_phy *ex_phy;
155 struct sas_port *parent_port;
157 struct mutex cmd_mutex;
160 /* ---------- SATA device ---------- */
161 enum ata_command_set {
163 ATAPI_COMMAND_SET = 1,
167 enum ata_command_set command_set;
168 struct smp_resp rps_resp; /* report_phy_sata_resp */
169 u8 port_no; /* port number, if this is a PM (Port) */
170 struct list_head children; /* PM Ports if this is a PM */
173 struct ata_host ata_host;
174 struct ata_taskfile tf;
182 struct domain_device {
183 spinlock_t done_lock;
184 enum sas_dev_type dev_type;
186 enum sas_linkrate linkrate;
187 enum sas_linkrate min_linkrate;
188 enum sas_linkrate max_linkrate;
192 struct domain_device *parent;
193 struct list_head siblings; /* devices on the same level */
194 struct asd_sas_port *port; /* shortcut to root of the tree */
197 struct list_head dev_list_node;
198 struct list_head disco_list_node; /* awaiting probe or destruct */
200 enum sas_protocol iproto;
201 enum sas_protocol tproto;
203 struct sas_rphy *rphy;
205 u8 sas_addr[SAS_ADDR_SIZE];
206 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
211 struct expander_device ex_dev;
212 struct sata_device sata_dev; /* STP & directly attached */
221 struct list_head drain_node;
222 struct work_struct work;
225 static inline void INIT_SAS_WORK(struct sas_work *sw, void (*fn)(struct work_struct *))
227 INIT_WORK(&sw->work, fn);
228 INIT_LIST_HEAD(&sw->drain_node);
231 struct sas_discovery_event {
232 struct sas_work work;
233 struct asd_sas_port *port;
236 static inline struct sas_discovery_event *to_sas_discovery_event(struct work_struct *work)
238 struct sas_discovery_event *ev = container_of(work, typeof(*ev), work.work);
243 struct sas_discovery {
244 struct sas_discovery_event disc_work[DISC_NUM_EVENTS];
245 unsigned long pending;
246 u8 fanout_sas_addr[8];
252 /* The port struct is Class:RW, driver:RO */
253 struct asd_sas_port {
255 struct completion port_gone_completion;
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 enum sas_linkrate linkrate;
265 struct sas_work work;
270 enum sas_class class;
271 u8 sas_addr[SAS_ADDR_SIZE];
272 u8 attached_sas_addr[SAS_ADDR_SIZE];
273 enum sas_protocol iproto;
274 enum sas_protocol tproto;
276 enum sas_oob_mode oob_mode;
278 spinlock_t phy_list_lock;
279 struct list_head phy_list;
283 struct sas_ha_struct *ha;
285 struct sas_port *port;
287 void *lldd_port; /* not touched by the sas class code */
290 struct asd_sas_event {
291 struct sas_work work;
292 struct asd_sas_phy *phy;
295 static inline struct asd_sas_event *to_asd_sas_event(struct work_struct *work)
297 struct asd_sas_event *ev = container_of(work, typeof(*ev), work.work);
302 /* The phy pretty much is controlled by the LLDD.
303 * The class only reads those fields.
307 struct asd_sas_event port_events[PORT_NUM_EVENTS];
308 struct asd_sas_event phy_events[PHY_NUM_EVENTS];
310 unsigned long port_events_pending;
311 unsigned long phy_events_pending;
318 /* The following are class:RO, driver:R/W */
319 int enabled; /* must be set */
321 int id; /* must be set */
322 enum sas_class class;
323 enum sas_protocol iproto;
324 enum sas_protocol tproto;
326 enum sas_phy_type type;
327 enum sas_phy_role role;
328 enum sas_oob_mode oob_mode;
329 enum sas_linkrate linkrate;
331 u8 *sas_addr; /* must be set */
332 u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
334 spinlock_t frame_rcvd_lock;
335 u8 *frame_rcvd; /* must be set */
338 spinlock_t sas_prim_lock;
341 struct list_head port_phy_el; /* driver:RO */
342 struct asd_sas_port *port; /* Class:RW, driver: RO */
344 struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
346 void *lldd_phy; /* not touched by the sas_class_code */
350 struct Scsi_Host *shost;
352 struct mutex task_queue_flush;
353 spinlock_t task_queue_lock;
354 struct list_head task_queue;
357 struct task_struct *queue_thread;
360 struct sas_ha_event {
361 struct sas_work work;
362 struct sas_ha_struct *ha;
365 static inline struct sas_ha_event *to_sas_ha_event(struct work_struct *work)
367 struct sas_ha_event *ev = container_of(work, typeof(*ev), work.work);
375 SAS_HA_ATA_EH_ACTIVE,
379 struct sas_ha_struct {
381 struct sas_ha_event ha_events[HA_NUM_EVENTS];
382 unsigned long pending;
384 struct list_head defer_q; /* work queued while draining */
385 struct mutex drain_mutex;
387 spinlock_t state_lock;
389 struct mutex disco_mutex;
391 struct scsi_core core;
395 struct device *dev; /* should be set */
396 struct module *lldd_module; /* should be set */
398 u8 *sas_addr; /* must be set */
399 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
401 spinlock_t phy_port_lock;
402 struct asd_sas_phy **sas_phy; /* array of valid pointers, must be set */
403 struct asd_sas_port **sas_port; /* array of valid pointers, must be set */
404 int num_phys; /* must be set, gt 0, static */
406 /* The class calls this to send a task for execution. */
407 int lldd_max_execute_num;
409 int strict_wide_ports; /* both sas_addr and attached_sas_addr must match
410 * their siblings when forming wide ports */
412 /* LLDD calls these to notify the class of an event. */
413 void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event);
414 void (*notify_port_event)(struct asd_sas_phy *, enum port_event);
415 void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event);
417 void *lldd_ha; /* not touched by sas class code */
419 struct list_head eh_done_q; /* complete via scsi_eh_flush_done_q */
420 struct list_head eh_ata_q; /* scmds to promote from sas to ata eh */
423 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
425 static inline struct domain_device *
426 starget_to_domain_dev(struct scsi_target *starget) {
427 return starget->hostdata;
430 static inline struct domain_device *
431 sdev_to_domain_dev(struct scsi_device *sdev) {
432 return starget_to_domain_dev(sdev->sdev_target);
435 static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev)
437 return &dev->sata_dev.ap->link.device[0];
440 static inline struct domain_device *
441 cmd_to_domain_dev(struct scsi_cmnd *cmd)
443 return sdev_to_domain_dev(cmd->device);
446 void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
448 /* Before calling a notify event, LLDD should use this function
449 * when the link is severed (possibly from its tasklet).
450 * The idea is that the Class only reads those, while the LLDD,
451 * can R/W these (thus avoiding a race).
453 static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
455 phy->oob_mode = OOB_NOT_CONNECTED;
456 phy->linkrate = SAS_LINK_RATE_UNKNOWN;
459 static inline unsigned int to_sas_gpio_od(int device, int bit)
461 return 3 * device + bit;
464 static inline void sas_put_local_phy(struct sas_phy *phy)
466 put_device(&phy->dev);
469 #ifdef CONFIG_SCSI_SAS_HOST_SMP
470 int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count);
472 static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count)
478 /* ---------- Tasks ---------- */
480 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
482 ---------------------+---------------------+-----------------------+
484 DEV_NO_RESPONSE | X | X |
487 DEVICE_UNKNOWN | | X |
489 ---------------------+---------------------+-----------------------+
492 enum service_response {
494 SAS_TASK_UNDELIVERED = -1,
498 /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of
499 * them here to silence 'case value not in enumerated type' warnings
501 __SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION,
503 SAS_DEV_NO_RESPONSE = 0x80,
519 /* When a task finishes with a response, the LLDD examines the
521 * - For an ATA task task_status_struct::stat is set to
522 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
523 * contents of struct ata_task_resp.
524 * - For SSP tasks, if no data is present or status/TMF response
525 * is valid, task_status_struct::stat is set. If data is present
526 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
527 * task_status_struct::buf_valid_size, and task_status_struct::stat is
528 * set to SAM_CHECK_COND.
530 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
533 * "frame_len" is the total frame length, which could be more or less
534 * than actually copied.
536 * Tasks ending with response, always set the residual field.
538 struct ata_task_resp {
540 u8 ending_fis[24]; /* dev to host or data-in */
543 #define SAS_STATUS_BUF_SIZE 96
545 struct task_status_struct {
546 enum service_response resp;
547 enum exec_status stat;
550 u8 buf[SAS_STATUS_BUF_SIZE];
553 enum sas_open_rej_reason open_rej_reason;
556 /* ATA and ATAPI task queuable to a SAS LLDD.
558 struct sas_ata_task {
559 struct host_to_dev_fis fis;
560 u8 atapi_packet[16]; /* 0 if not ATAPI task */
562 u8 retry_count; /* hardware retry, should be > 0 */
564 u8 dma_xfer:1; /* PIO:0 or DMA:1 */
569 u8 device_control_reg_update:1;
572 struct sas_smp_task {
573 struct scatterlist smp_req;
574 struct scatterlist smp_resp;
577 enum task_attribute {
578 TASK_ATTR_SIMPLE = 0,
580 TASK_ATTR_ORDERED= 2,
584 struct sas_ssp_task {
585 u8 retry_count; /* hardware retry, should be > 0 */
588 u8 enable_first_burst:1;
589 enum task_attribute task_attr;
595 struct domain_device *dev;
596 struct list_head list;
598 spinlock_t task_state_lock;
599 unsigned task_state_flags;
601 enum sas_protocol task_proto;
603 /* Used by the discovery code. */
604 struct timer_list timer;
605 struct completion completion;
608 struct sas_ata_task ata_task;
609 struct sas_smp_task smp_task;
610 struct sas_ssp_task ssp_task;
613 struct scatterlist *scatter;
616 u8 data_dir:2; /* Use PCI_DMA_... */
618 struct task_status_struct task_status;
619 void (*task_done)(struct sas_task *);
621 void *lldd_task; /* for use by LLDDs */
624 struct work_struct abort_work;
627 #define SAS_TASK_STATE_PENDING 1
628 #define SAS_TASK_STATE_DONE 2
629 #define SAS_TASK_STATE_ABORTED 4
630 #define SAS_TASK_NEED_DEV_RESET 8
631 #define SAS_TASK_AT_INITIATOR 16
633 extern struct sas_task *sas_alloc_task(gfp_t flags);
634 extern void sas_free_task(struct sas_task *task);
636 struct sas_domain_function_template {
637 /* The class calls these to notify the LLDD of an event. */
638 void (*lldd_port_formed)(struct asd_sas_phy *);
639 void (*lldd_port_deformed)(struct asd_sas_phy *);
641 /* The class calls these when a device is found or gone. */
642 int (*lldd_dev_found)(struct domain_device *);
643 void (*lldd_dev_gone)(struct domain_device *);
645 int (*lldd_execute_task)(struct sas_task *, int num,
648 /* Task Management Functions. Must be called from process context. */
649 int (*lldd_abort_task)(struct sas_task *);
650 int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
651 int (*lldd_clear_aca)(struct domain_device *, u8 *lun);
652 int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
653 int (*lldd_I_T_nexus_reset)(struct domain_device *);
654 int (*lldd_ata_check_ready)(struct domain_device *);
655 void (*lldd_ata_set_dmamode)(struct domain_device *);
656 int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
657 int (*lldd_query_task)(struct sas_task *);
659 /* Port and Adapter management */
660 int (*lldd_clear_nexus_port)(struct asd_sas_port *);
661 int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
664 int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
667 int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type,
668 u8 reg_index, u8 reg_count, u8 *write_data);
671 extern int sas_register_ha(struct sas_ha_struct *);
672 extern int sas_unregister_ha(struct sas_ha_struct *);
674 int sas_set_phy_speed(struct sas_phy *phy,
675 struct sas_phy_linkrates *rates);
676 int sas_phy_reset(struct sas_phy *phy, int hard_reset);
677 int sas_queue_up(struct sas_task *task);
678 extern int sas_queuecommand(struct Scsi_Host * ,struct scsi_cmnd *);
679 extern int sas_target_alloc(struct scsi_target *);
680 extern int sas_slave_configure(struct scsi_device *);
681 extern int sas_change_queue_depth(struct scsi_device *, int new_depth,
683 extern int sas_change_queue_type(struct scsi_device *, int qt);
684 extern int sas_bios_param(struct scsi_device *,
685 struct block_device *,
686 sector_t capacity, int *hsc);
687 extern struct scsi_transport_template *
688 sas_domain_attach_transport(struct sas_domain_function_template *);
689 extern void sas_domain_release_transport(struct scsi_transport_template *);
691 int sas_discover_root_expander(struct domain_device *);
693 void sas_init_ex_attr(void);
695 int sas_ex_revalidate_domain(struct domain_device *);
697 void sas_unregister_domain_devices(struct asd_sas_port *port, int gone);
698 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
699 int sas_discover_event(struct asd_sas_port *, enum discover_event ev);
701 int sas_discover_sata(struct domain_device *);
702 int sas_discover_end_dev(struct domain_device *);
704 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
706 void sas_init_dev(struct domain_device *);
708 void sas_task_abort(struct sas_task *);
709 int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
710 int sas_eh_bus_reset_handler(struct scsi_cmnd *cmd);
712 extern void sas_target_destroy(struct scsi_target *);
713 extern int sas_slave_alloc(struct scsi_device *);
714 extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg);
715 extern int sas_drain_work(struct sas_ha_struct *ha);
717 extern int sas_smp_handler(struct Scsi_Host *shost, struct sas_rphy *rphy,
718 struct request *req);
720 extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
721 struct ssp_response_iu *iu);
722 struct sas_phy *sas_get_local_phy(struct domain_device *dev);
724 int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
726 #endif /* _SASLIB_H_ */