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,
166 #define ATA_RESP_FIS_SIZE 24
169 enum ata_command_set command_set;
170 struct smp_resp rps_resp; /* report_phy_sata_resp */
171 u8 port_no; /* port number, if this is a PM (Port) */
172 struct list_head children; /* PM Ports if this is a PM */
175 struct ata_host ata_host;
176 u8 fis[ATA_RESP_FIS_SIZE];
180 struct list_head eh_list_node; /* pending a user requested eh action */
181 struct scsi_lun reset_lun;
192 struct domain_device {
193 spinlock_t done_lock;
194 enum sas_dev_type dev_type;
196 enum sas_linkrate linkrate;
197 enum sas_linkrate min_linkrate;
198 enum sas_linkrate max_linkrate;
202 struct domain_device *parent;
203 struct list_head siblings; /* devices on the same level */
204 struct asd_sas_port *port; /* shortcut to root of the tree */
207 struct list_head dev_list_node;
208 struct list_head disco_list_node; /* awaiting probe or destruct */
210 enum sas_protocol iproto;
211 enum sas_protocol tproto;
213 struct sas_rphy *rphy;
215 u8 sas_addr[SAS_ADDR_SIZE];
216 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
221 struct expander_device ex_dev;
222 struct sata_device sata_dev; /* STP & directly attached */
223 struct ssp_device ssp_dev;
232 struct list_head drain_node;
233 struct work_struct work;
236 static inline void INIT_SAS_WORK(struct sas_work *sw, void (*fn)(struct work_struct *))
238 INIT_WORK(&sw->work, fn);
239 INIT_LIST_HEAD(&sw->drain_node);
242 struct sas_discovery_event {
243 struct sas_work work;
244 struct asd_sas_port *port;
247 static inline struct sas_discovery_event *to_sas_discovery_event(struct work_struct *work)
249 struct sas_discovery_event *ev = container_of(work, typeof(*ev), work.work);
254 struct sas_discovery {
255 struct sas_discovery_event disc_work[DISC_NUM_EVENTS];
256 unsigned long pending;
257 u8 fanout_sas_addr[8];
263 /* The port struct is Class:RW, driver:RO */
264 struct asd_sas_port {
266 struct completion port_gone_completion;
268 struct sas_discovery disc;
269 struct domain_device *port_dev;
270 spinlock_t dev_list_lock;
271 struct list_head dev_list;
272 struct list_head disco_list;
273 struct list_head destroy_list;
274 enum sas_linkrate linkrate;
276 struct sas_work work;
281 enum sas_class class;
282 u8 sas_addr[SAS_ADDR_SIZE];
283 u8 attached_sas_addr[SAS_ADDR_SIZE];
284 enum sas_protocol iproto;
285 enum sas_protocol tproto;
287 enum sas_oob_mode oob_mode;
289 spinlock_t phy_list_lock;
290 struct list_head phy_list;
294 struct sas_ha_struct *ha;
296 struct sas_port *port;
298 void *lldd_port; /* not touched by the sas class code */
301 struct asd_sas_event {
302 struct sas_work work;
303 struct asd_sas_phy *phy;
306 static inline struct asd_sas_event *to_asd_sas_event(struct work_struct *work)
308 struct asd_sas_event *ev = container_of(work, typeof(*ev), work.work);
313 /* The phy pretty much is controlled by the LLDD.
314 * The class only reads those fields.
318 struct asd_sas_event port_events[PORT_NUM_EVENTS];
319 struct asd_sas_event phy_events[PHY_NUM_EVENTS];
321 unsigned long port_events_pending;
322 unsigned long phy_events_pending;
329 /* The following are class:RO, driver:R/W */
330 int enabled; /* must be set */
332 int id; /* must be set */
333 enum sas_class class;
334 enum sas_protocol iproto;
335 enum sas_protocol tproto;
337 enum sas_phy_type type;
338 enum sas_phy_role role;
339 enum sas_oob_mode oob_mode;
340 enum sas_linkrate linkrate;
342 u8 *sas_addr; /* must be set */
343 u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
345 spinlock_t frame_rcvd_lock;
346 u8 *frame_rcvd; /* must be set */
349 spinlock_t sas_prim_lock;
352 struct list_head port_phy_el; /* driver:RO */
353 struct asd_sas_port *port; /* Class:RW, driver: RO */
355 struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
357 void *lldd_phy; /* not touched by the sas_class_code */
361 struct Scsi_Host *shost;
363 struct mutex task_queue_flush;
364 spinlock_t task_queue_lock;
365 struct list_head task_queue;
368 struct task_struct *queue_thread;
371 struct sas_ha_event {
372 struct sas_work work;
373 struct sas_ha_struct *ha;
376 static inline struct sas_ha_event *to_sas_ha_event(struct work_struct *work)
378 struct sas_ha_event *ev = container_of(work, typeof(*ev), work.work);
386 SAS_HA_ATA_EH_ACTIVE,
390 struct sas_ha_struct {
392 struct sas_ha_event ha_events[HA_NUM_EVENTS];
393 unsigned long pending;
395 struct list_head defer_q; /* work queued while draining */
396 struct mutex drain_mutex;
400 wait_queue_head_t eh_wait_q;
401 struct list_head eh_dev_q;
403 struct mutex disco_mutex;
405 struct scsi_core core;
409 struct device *dev; /* should be set */
410 struct module *lldd_module; /* should be set */
412 u8 *sas_addr; /* must be set */
413 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
415 spinlock_t phy_port_lock;
416 struct asd_sas_phy **sas_phy; /* array of valid pointers, must be set */
417 struct asd_sas_port **sas_port; /* array of valid pointers, must be set */
418 int num_phys; /* must be set, gt 0, static */
420 /* The class calls this to send a task for execution. */
421 int lldd_max_execute_num;
423 int strict_wide_ports; /* both sas_addr and attached_sas_addr must match
424 * their siblings when forming wide ports */
426 /* LLDD calls these to notify the class of an event. */
427 void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event);
428 void (*notify_port_event)(struct asd_sas_phy *, enum port_event);
429 void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event);
431 void *lldd_ha; /* not touched by sas class code */
433 struct list_head eh_done_q; /* complete via scsi_eh_flush_done_q */
434 struct list_head eh_ata_q; /* scmds to promote from sas to ata eh */
437 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
439 static inline struct domain_device *
440 starget_to_domain_dev(struct scsi_target *starget) {
441 return starget->hostdata;
444 static inline struct domain_device *
445 sdev_to_domain_dev(struct scsi_device *sdev) {
446 return starget_to_domain_dev(sdev->sdev_target);
449 static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev)
451 return &dev->sata_dev.ap->link.device[0];
454 static inline struct domain_device *
455 cmd_to_domain_dev(struct scsi_cmnd *cmd)
457 return sdev_to_domain_dev(cmd->device);
460 void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
462 /* Before calling a notify event, LLDD should use this function
463 * when the link is severed (possibly from its tasklet).
464 * The idea is that the Class only reads those, while the LLDD,
465 * can R/W these (thus avoiding a race).
467 static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
469 phy->oob_mode = OOB_NOT_CONNECTED;
470 phy->linkrate = SAS_LINK_RATE_UNKNOWN;
473 static inline unsigned int to_sas_gpio_od(int device, int bit)
475 return 3 * device + bit;
478 static inline void sas_put_local_phy(struct sas_phy *phy)
480 put_device(&phy->dev);
483 #ifdef CONFIG_SCSI_SAS_HOST_SMP
484 int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count);
486 static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count)
492 /* ---------- Tasks ---------- */
494 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
496 ---------------------+---------------------+-----------------------+
498 DEV_NO_RESPONSE | X | X |
501 DEVICE_UNKNOWN | | X |
503 ---------------------+---------------------+-----------------------+
506 enum service_response {
508 SAS_TASK_UNDELIVERED = -1,
512 /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of
513 * them here to silence 'case value not in enumerated type' warnings
515 __SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION,
517 SAS_DEV_NO_RESPONSE = 0x80,
533 /* When a task finishes with a response, the LLDD examines the
535 * - For an ATA task task_status_struct::stat is set to
536 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
537 * contents of struct ata_task_resp.
538 * - For SSP tasks, if no data is present or status/TMF response
539 * is valid, task_status_struct::stat is set. If data is present
540 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
541 * task_status_struct::buf_valid_size, and task_status_struct::stat is
542 * set to SAM_CHECK_COND.
544 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
547 * "frame_len" is the total frame length, which could be more or less
548 * than actually copied.
550 * Tasks ending with response, always set the residual field.
552 struct ata_task_resp {
554 u8 ending_fis[ATA_RESP_FIS_SIZE]; /* dev to host or data-in */
557 #define SAS_STATUS_BUF_SIZE 96
559 struct task_status_struct {
560 enum service_response resp;
561 enum exec_status stat;
564 u8 buf[SAS_STATUS_BUF_SIZE];
567 enum sas_open_rej_reason open_rej_reason;
570 /* ATA and ATAPI task queuable to a SAS LLDD.
572 struct sas_ata_task {
573 struct host_to_dev_fis fis;
574 u8 atapi_packet[16]; /* 0 if not ATAPI task */
576 u8 retry_count; /* hardware retry, should be > 0 */
578 u8 dma_xfer:1; /* PIO:0 or DMA:1 */
583 u8 device_control_reg_update:1;
586 struct sas_smp_task {
587 struct scatterlist smp_req;
588 struct scatterlist smp_resp;
591 enum task_attribute {
592 TASK_ATTR_SIMPLE = 0,
594 TASK_ATTR_ORDERED= 2,
598 struct sas_ssp_task {
599 u8 retry_count; /* hardware retry, should be > 0 */
602 u8 enable_first_burst:1;
603 enum task_attribute task_attr;
609 struct domain_device *dev;
610 struct list_head list;
612 spinlock_t task_state_lock;
613 unsigned task_state_flags;
615 enum sas_protocol task_proto;
617 /* Used by the discovery code. */
618 struct timer_list timer;
619 struct completion completion;
622 struct sas_ata_task ata_task;
623 struct sas_smp_task smp_task;
624 struct sas_ssp_task ssp_task;
627 struct scatterlist *scatter;
630 u8 data_dir:2; /* Use PCI_DMA_... */
632 struct task_status_struct task_status;
633 void (*task_done)(struct sas_task *);
635 void *lldd_task; /* for use by LLDDs */
638 struct work_struct abort_work;
641 #define SAS_TASK_STATE_PENDING 1
642 #define SAS_TASK_STATE_DONE 2
643 #define SAS_TASK_STATE_ABORTED 4
644 #define SAS_TASK_NEED_DEV_RESET 8
645 #define SAS_TASK_AT_INITIATOR 16
647 extern struct sas_task *sas_alloc_task(gfp_t flags);
648 extern void sas_free_task(struct sas_task *task);
650 struct sas_domain_function_template {
651 /* The class calls these to notify the LLDD of an event. */
652 void (*lldd_port_formed)(struct asd_sas_phy *);
653 void (*lldd_port_deformed)(struct asd_sas_phy *);
655 /* The class calls these when a device is found or gone. */
656 int (*lldd_dev_found)(struct domain_device *);
657 void (*lldd_dev_gone)(struct domain_device *);
659 int (*lldd_execute_task)(struct sas_task *, int num,
662 /* Task Management Functions. Must be called from process context. */
663 int (*lldd_abort_task)(struct sas_task *);
664 int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
665 int (*lldd_clear_aca)(struct domain_device *, u8 *lun);
666 int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
667 int (*lldd_I_T_nexus_reset)(struct domain_device *);
668 int (*lldd_ata_check_ready)(struct domain_device *);
669 void (*lldd_ata_set_dmamode)(struct domain_device *);
670 int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
671 int (*lldd_query_task)(struct sas_task *);
673 /* Port and Adapter management */
674 int (*lldd_clear_nexus_port)(struct asd_sas_port *);
675 int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
678 int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
681 int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type,
682 u8 reg_index, u8 reg_count, u8 *write_data);
685 extern int sas_register_ha(struct sas_ha_struct *);
686 extern int sas_unregister_ha(struct sas_ha_struct *);
688 int sas_set_phy_speed(struct sas_phy *phy,
689 struct sas_phy_linkrates *rates);
690 int sas_phy_reset(struct sas_phy *phy, int hard_reset);
691 int sas_queue_up(struct sas_task *task);
692 extern int sas_queuecommand(struct Scsi_Host * ,struct scsi_cmnd *);
693 extern int sas_target_alloc(struct scsi_target *);
694 extern int sas_slave_configure(struct scsi_device *);
695 extern int sas_change_queue_depth(struct scsi_device *, int new_depth,
697 extern int sas_change_queue_type(struct scsi_device *, int qt);
698 extern int sas_bios_param(struct scsi_device *,
699 struct block_device *,
700 sector_t capacity, int *hsc);
701 extern struct scsi_transport_template *
702 sas_domain_attach_transport(struct sas_domain_function_template *);
703 extern void sas_domain_release_transport(struct scsi_transport_template *);
705 int sas_discover_root_expander(struct domain_device *);
707 void sas_init_ex_attr(void);
709 int sas_ex_revalidate_domain(struct domain_device *);
711 void sas_unregister_domain_devices(struct asd_sas_port *port, int gone);
712 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
713 int sas_discover_event(struct asd_sas_port *, enum discover_event ev);
715 int sas_discover_sata(struct domain_device *);
716 int sas_discover_end_dev(struct domain_device *);
718 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
720 void sas_init_dev(struct domain_device *);
722 void sas_task_abort(struct sas_task *);
723 int sas_eh_abort_handler(struct scsi_cmnd *cmd);
724 int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
725 int sas_eh_bus_reset_handler(struct scsi_cmnd *cmd);
727 extern void sas_target_destroy(struct scsi_target *);
728 extern int sas_slave_alloc(struct scsi_device *);
729 extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg);
730 extern int sas_drain_work(struct sas_ha_struct *ha);
732 extern int sas_smp_handler(struct Scsi_Host *shost, struct sas_rphy *rphy,
733 struct request *req);
735 extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
736 struct ssp_response_iu *iu);
737 struct sas_phy *sas_get_local_phy(struct domain_device *dev);
739 int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
741 #endif /* _SASLIB_H_ */