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;
158 /* ---------- SATA device ---------- */
159 enum ata_command_set {
161 ATAPI_COMMAND_SET = 1,
165 enum ata_command_set command_set;
166 struct smp_resp rps_resp; /* report_phy_sata_resp */
167 u8 port_no; /* port number, if this is a PM (Port) */
168 struct list_head children; /* PM Ports if this is a PM */
171 struct ata_host ata_host;
172 struct ata_taskfile tf;
180 struct domain_device {
181 enum sas_dev_type dev_type;
183 enum sas_linkrate linkrate;
184 enum sas_linkrate min_linkrate;
185 enum sas_linkrate max_linkrate;
189 struct domain_device *parent;
190 struct list_head siblings; /* devices on the same level */
191 struct asd_sas_port *port; /* shortcut to root of the tree */
193 struct list_head dev_list_node;
194 struct list_head disco_list_node; /* awaiting probe or destruct */
196 enum sas_protocol iproto;
197 enum sas_protocol tproto;
199 struct sas_rphy *rphy;
201 u8 sas_addr[SAS_ADDR_SIZE];
202 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
207 struct expander_device ex_dev;
208 struct sata_device sata_dev; /* STP & directly attached */
216 struct sas_discovery_event {
217 struct work_struct work;
218 struct asd_sas_port *port;
221 struct sas_discovery {
222 struct sas_discovery_event disc_work[DISC_NUM_EVENTS];
223 unsigned long pending;
224 u8 fanout_sas_addr[8];
230 /* The port struct is Class:RW, driver:RO */
231 struct asd_sas_port {
233 struct completion port_gone_completion;
235 struct sas_discovery disc;
236 struct domain_device *port_dev;
237 spinlock_t dev_list_lock;
238 struct list_head dev_list;
239 struct list_head disco_list;
240 struct list_head destroy_list;
241 enum sas_linkrate linkrate;
244 struct work_struct work;
249 enum sas_class class;
250 u8 sas_addr[SAS_ADDR_SIZE];
251 u8 attached_sas_addr[SAS_ADDR_SIZE];
252 enum sas_protocol iproto;
253 enum sas_protocol tproto;
255 enum sas_oob_mode oob_mode;
257 spinlock_t phy_list_lock;
258 struct list_head phy_list;
262 struct sas_ha_struct *ha;
264 struct sas_port *port;
266 void *lldd_port; /* not touched by the sas class code */
269 struct asd_sas_event {
270 struct work_struct work;
271 struct asd_sas_phy *phy;
274 /* The phy pretty much is controlled by the LLDD.
275 * The class only reads those fields.
279 struct asd_sas_event port_events[PORT_NUM_EVENTS];
280 struct asd_sas_event phy_events[PHY_NUM_EVENTS];
282 unsigned long port_events_pending;
283 unsigned long phy_events_pending;
290 /* The following are class:RO, driver:R/W */
291 int enabled; /* must be set */
293 int id; /* must be set */
294 enum sas_class class;
295 enum sas_protocol iproto;
296 enum sas_protocol tproto;
298 enum sas_phy_type type;
299 enum sas_phy_role role;
300 enum sas_oob_mode oob_mode;
301 enum sas_linkrate linkrate;
303 u8 *sas_addr; /* must be set */
304 u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
306 spinlock_t frame_rcvd_lock;
307 u8 *frame_rcvd; /* must be set */
310 spinlock_t sas_prim_lock;
313 struct list_head port_phy_el; /* driver:RO */
314 struct asd_sas_port *port; /* Class:RW, driver: RO */
316 struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
318 void *lldd_phy; /* not touched by the sas_class_code */
322 struct Scsi_Host *shost;
324 spinlock_t task_queue_lock;
325 struct list_head task_queue;
328 struct task_struct *queue_thread;
331 struct sas_ha_event {
332 struct work_struct work;
333 struct sas_ha_struct *ha;
339 SAS_HA_ATA_EH_ACTIVE,
342 struct sas_ha_struct {
344 struct sas_ha_event ha_events[HA_NUM_EVENTS];
345 unsigned long pending;
347 struct list_head defer_q; /* work queued while draining */
348 struct mutex drain_mutex;
350 spinlock_t state_lock;
352 struct mutex disco_mutex;
354 struct scsi_core core;
358 struct device *dev; /* should be set */
359 struct module *lldd_module; /* should be set */
361 u8 *sas_addr; /* must be set */
362 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
364 spinlock_t phy_port_lock;
365 struct asd_sas_phy **sas_phy; /* array of valid pointers, must be set */
366 struct asd_sas_port **sas_port; /* array of valid pointers, must be set */
367 int num_phys; /* must be set, gt 0, static */
369 /* The class calls this to send a task for execution. */
370 int lldd_max_execute_num;
372 int strict_wide_ports; /* both sas_addr and attached_sas_addr must match
373 * their siblings when forming wide ports */
375 /* LLDD calls these to notify the class of an event. */
376 void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event);
377 void (*notify_port_event)(struct asd_sas_phy *, enum port_event);
378 void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event);
380 void *lldd_ha; /* not touched by sas class code */
382 struct list_head eh_done_q;
385 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
387 static inline struct domain_device *
388 starget_to_domain_dev(struct scsi_target *starget) {
389 return starget->hostdata;
392 static inline struct domain_device *
393 sdev_to_domain_dev(struct scsi_device *sdev) {
394 return starget_to_domain_dev(sdev->sdev_target);
397 static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev)
399 return &dev->sata_dev.ap->link.device[0];
402 static inline struct domain_device *
403 cmd_to_domain_dev(struct scsi_cmnd *cmd)
405 return sdev_to_domain_dev(cmd->device);
408 void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
410 /* Before calling a notify event, LLDD should use this function
411 * when the link is severed (possibly from its tasklet).
412 * The idea is that the Class only reads those, while the LLDD,
413 * can R/W these (thus avoiding a race).
415 static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
417 phy->oob_mode = OOB_NOT_CONNECTED;
418 phy->linkrate = SAS_LINK_RATE_UNKNOWN;
421 static inline unsigned int to_sas_gpio_od(int device, int bit)
423 return 3 * device + bit;
426 #ifdef CONFIG_SCSI_SAS_HOST_SMP
427 int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count);
429 static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count)
435 /* ---------- Tasks ---------- */
437 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
439 ---------------------+---------------------+-----------------------+
441 DEV_NO_RESPONSE | X | X |
444 DEVICE_UNKNOWN | | X |
446 ---------------------+---------------------+-----------------------+
449 enum service_response {
451 SAS_TASK_UNDELIVERED = -1,
455 /* The SAM_STAT_.. codes fit in the lower 6 bits */
457 SAS_DEV_NO_RESPONSE = 0x80,
473 /* When a task finishes with a response, the LLDD examines the
475 * - For an ATA task task_status_struct::stat is set to
476 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
477 * contents of struct ata_task_resp.
478 * - For SSP tasks, if no data is present or status/TMF response
479 * is valid, task_status_struct::stat is set. If data is present
480 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
481 * task_status_struct::buf_valid_size, and task_status_struct::stat is
482 * set to SAM_CHECK_COND.
484 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
487 * "frame_len" is the total frame length, which could be more or less
488 * than actually copied.
490 * Tasks ending with response, always set the residual field.
492 struct ata_task_resp {
494 u8 ending_fis[24]; /* dev to host or data-in */
497 #define SAS_STATUS_BUF_SIZE 96
499 struct task_status_struct {
500 enum service_response resp;
501 enum exec_status stat;
504 u8 buf[SAS_STATUS_BUF_SIZE];
507 enum sas_open_rej_reason open_rej_reason;
510 /* ATA and ATAPI task queuable to a SAS LLDD.
512 struct sas_ata_task {
513 struct host_to_dev_fis fis;
514 u8 atapi_packet[16]; /* 0 if not ATAPI task */
516 u8 retry_count; /* hardware retry, should be > 0 */
518 u8 dma_xfer:1; /* PIO:0 or DMA:1 */
523 u8 device_control_reg_update:1;
526 struct sas_smp_task {
527 struct scatterlist smp_req;
528 struct scatterlist smp_resp;
531 enum task_attribute {
532 TASK_ATTR_SIMPLE = 0,
534 TASK_ATTR_ORDERED= 2,
538 struct sas_ssp_task {
539 u8 retry_count; /* hardware retry, should be > 0 */
542 u8 enable_first_burst:1;
543 enum task_attribute task_attr;
549 struct domain_device *dev;
550 struct list_head list;
552 spinlock_t task_state_lock;
553 unsigned task_state_flags;
555 enum sas_protocol task_proto;
557 /* Used by the discovery code. */
558 struct timer_list timer;
559 struct completion completion;
562 struct sas_ata_task ata_task;
563 struct sas_smp_task smp_task;
564 struct sas_ssp_task ssp_task;
567 struct scatterlist *scatter;
570 u8 data_dir:2; /* Use PCI_DMA_... */
572 struct task_status_struct task_status;
573 void (*task_done)(struct sas_task *);
575 void *lldd_task; /* for use by LLDDs */
578 struct work_struct abort_work;
581 #define SAS_TASK_STATE_PENDING 1
582 #define SAS_TASK_STATE_DONE 2
583 #define SAS_TASK_STATE_ABORTED 4
584 #define SAS_TASK_NEED_DEV_RESET 8
585 #define SAS_TASK_AT_INITIATOR 16
587 extern struct sas_task *sas_alloc_task(gfp_t flags);
588 extern void sas_free_task(struct sas_task *task);
590 struct sas_domain_function_template {
591 /* The class calls these to notify the LLDD of an event. */
592 void (*lldd_port_formed)(struct asd_sas_phy *);
593 void (*lldd_port_deformed)(struct asd_sas_phy *);
595 /* The class calls these when a device is found or gone. */
596 int (*lldd_dev_found)(struct domain_device *);
597 void (*lldd_dev_gone)(struct domain_device *);
599 int (*lldd_execute_task)(struct sas_task *, int num,
602 /* Task Management Functions. Must be called from process context. */
603 int (*lldd_abort_task)(struct sas_task *);
604 int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
605 int (*lldd_clear_aca)(struct domain_device *, u8 *lun);
606 int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
607 int (*lldd_I_T_nexus_reset)(struct domain_device *);
608 int (*lldd_ata_soft_reset)(struct domain_device *);
609 void (*lldd_ata_set_dmamode)(struct domain_device *);
610 int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
611 int (*lldd_query_task)(struct sas_task *);
613 /* Port and Adapter management */
614 int (*lldd_clear_nexus_port)(struct asd_sas_port *);
615 int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
618 int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
621 int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type,
622 u8 reg_index, u8 reg_count, u8 *write_data);
625 extern int sas_register_ha(struct sas_ha_struct *);
626 extern int sas_unregister_ha(struct sas_ha_struct *);
628 int sas_set_phy_speed(struct sas_phy *phy,
629 struct sas_phy_linkrates *rates);
630 int sas_phy_enable(struct sas_phy *phy, int enabled);
631 int sas_phy_reset(struct sas_phy *phy, int hard_reset);
632 int sas_queue_up(struct sas_task *task);
633 extern int sas_queuecommand(struct Scsi_Host * ,struct scsi_cmnd *);
634 extern int sas_target_alloc(struct scsi_target *);
635 extern int sas_slave_alloc(struct scsi_device *);
636 extern int sas_slave_configure(struct scsi_device *);
637 extern int sas_change_queue_depth(struct scsi_device *, int new_depth,
639 extern int sas_change_queue_type(struct scsi_device *, int qt);
640 extern int sas_bios_param(struct scsi_device *,
641 struct block_device *,
642 sector_t capacity, int *hsc);
643 extern struct scsi_transport_template *
644 sas_domain_attach_transport(struct sas_domain_function_template *);
645 extern void sas_domain_release_transport(struct scsi_transport_template *);
647 int sas_discover_root_expander(struct domain_device *);
649 void sas_init_ex_attr(void);
651 int sas_ex_revalidate_domain(struct domain_device *);
653 void sas_unregister_domain_devices(struct asd_sas_port *port);
654 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
655 int sas_discover_event(struct asd_sas_port *, enum discover_event ev);
657 int sas_discover_sata(struct domain_device *);
658 int sas_discover_end_dev(struct domain_device *);
660 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
662 void sas_init_dev(struct domain_device *);
664 void sas_task_abort(struct sas_task *);
665 int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
666 int sas_eh_bus_reset_handler(struct scsi_cmnd *cmd);
668 extern void sas_target_destroy(struct scsi_target *);
669 extern int sas_slave_alloc(struct scsi_device *);
670 extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg);
671 extern int sas_drain_work(struct sas_ha_struct *ha);
673 extern int sas_smp_handler(struct Scsi_Host *shost, struct sas_rphy *rphy,
674 struct request *req);
676 extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
677 struct ssp_response_iu *iu);
678 struct sas_phy *sas_find_local_phy(struct domain_device *dev);
680 int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
682 #endif /* _SASLIB_H_ */