1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * SAS host prototypes and structures header file
5 * Copyright (C) 2005 Adaptec, Inc. All rights reserved.
6 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
13 #include <linux/timer.h>
14 #include <linux/pci.h>
16 #include <linux/libata.h>
17 #include <linux/list.h>
18 #include <scsi/scsi_device.h>
19 #include <scsi/scsi_cmnd.h>
20 #include <scsi/scsi_transport_sas.h>
21 #include <linux/scatterlist.h>
22 #include <linux/slab.h>
33 PHY_ROLE_TARGET = 0x40,
34 PHY_ROLE_INITIATOR = 0x80,
42 /* The events are mnemonically described in sas_dump.c
43 * so when updating/adding events here, please also
44 * update the other file too.
47 PORTE_BYTES_DMAED = 0U,
56 PHYE_LOSS_OF_SIGNAL = 0U,
59 PHYE_SPINUP_HOLD, /* hot plug SATA, no COMWAKE sent */
66 DISCE_DISCOVER_DOMAIN = 0U,
67 DISCE_REVALIDATE_DOMAIN,
73 /* ---------- Expander Devices ---------- */
75 #define to_dom_device(_obj) container_of(_obj, struct domain_device, dev_obj)
76 #define to_dev_attr(_attr) container_of(_attr, struct domain_dev_attribute,\
79 enum routing_attribute {
95 enum ex_phy_state phy_state;
97 enum sas_device_type attached_dev_type;
98 enum sas_linkrate linkrate;
100 u8 attached_sata_host:1;
101 u8 attached_sata_dev:1;
102 u8 attached_sata_ps:1;
104 enum sas_protocol attached_tproto;
105 enum sas_protocol attached_iproto;
107 u8 attached_sas_addr[SAS_ADDR_SIZE];
110 int phy_change_count;
111 enum routing_attribute routing_attr;
117 struct sas_port *port;
120 struct expander_device {
121 struct list_head children;
124 u16 max_route_indexes;
129 u8 conf_route_table:1;
131 u8 enclosure_logical_id[8];
133 struct ex_phy *ex_phy;
134 struct sas_port *parent_port;
136 struct mutex cmd_mutex;
139 /* ---------- SATA device ---------- */
140 #define ATA_RESP_FIS_SIZE 24
144 u8 port_no; /* port number, if this is a PM (Port) */
147 struct ata_host *ata_host;
148 struct smp_resp rps_resp ____cacheline_aligned; /* report_phy_sata_resp */
149 u8 fis[ATA_RESP_FIS_SIZE];
153 struct list_head eh_list_node; /* pending a user requested eh action */
154 struct scsi_lun reset_lun;
159 SAS_DEV_FOUND, /* device notified to lldd */
166 struct domain_device {
167 spinlock_t done_lock;
168 enum sas_device_type dev_type;
170 enum sas_linkrate linkrate;
171 enum sas_linkrate min_linkrate;
172 enum sas_linkrate max_linkrate;
176 struct domain_device *parent;
177 struct list_head siblings; /* devices on the same level */
178 struct asd_sas_port *port; /* shortcut to root of the tree */
181 struct list_head dev_list_node;
182 struct list_head disco_list_node; /* awaiting probe or destruct */
184 enum sas_protocol iproto;
185 enum sas_protocol tproto;
187 struct sas_rphy *rphy;
189 u8 sas_addr[SAS_ADDR_SIZE];
190 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
195 struct expander_device ex_dev;
196 struct sata_device sata_dev; /* STP & directly attached */
197 struct ssp_device ssp_dev;
206 struct list_head drain_node;
207 struct work_struct work;
210 /* Lots of code duplicates this in the SCSI tree, which can be factored out */
211 static inline bool sas_dev_type_is_expander(enum sas_device_type type)
213 return type == SAS_EDGE_EXPANDER_DEVICE ||
214 type == SAS_FANOUT_EXPANDER_DEVICE;
217 static inline void INIT_SAS_WORK(struct sas_work *sw, void (*fn)(struct work_struct *))
219 INIT_WORK(&sw->work, fn);
220 INIT_LIST_HEAD(&sw->drain_node);
223 struct sas_discovery_event {
224 struct sas_work work;
225 struct asd_sas_port *port;
228 static inline struct sas_discovery_event *to_sas_discovery_event(struct work_struct *work)
230 struct sas_discovery_event *ev = container_of(work, typeof(*ev), work.work);
235 struct sas_discovery {
236 struct sas_discovery_event disc_work[DISC_NUM_EVENTS];
237 unsigned long pending;
238 u8 fanout_sas_addr[SAS_ADDR_SIZE];
239 u8 eeds_a[SAS_ADDR_SIZE];
240 u8 eeds_b[SAS_ADDR_SIZE];
244 /* The port struct is Class:RW, driver:RO */
245 struct asd_sas_port {
247 struct sas_discovery disc;
248 struct domain_device *port_dev;
249 spinlock_t dev_list_lock;
250 struct list_head dev_list;
251 struct list_head disco_list;
252 struct list_head destroy_list;
253 struct list_head sas_port_del_list;
254 enum sas_linkrate linkrate;
256 struct sas_work work;
262 enum sas_class class;
263 u8 sas_addr[SAS_ADDR_SIZE];
264 u8 attached_sas_addr[SAS_ADDR_SIZE];
265 enum sas_protocol iproto;
266 enum sas_protocol tproto;
268 enum sas_oob_mode oob_mode;
270 spinlock_t phy_list_lock;
271 struct list_head phy_list;
275 struct sas_ha_struct *ha;
277 struct sas_port *port;
279 void *lldd_port; /* not touched by the sas class code */
282 struct asd_sas_event {
283 struct sas_work work;
284 struct asd_sas_phy *phy;
288 static inline struct asd_sas_event *to_asd_sas_event(struct work_struct *work)
290 struct asd_sas_event *ev = container_of(work, typeof(*ev), work.work);
295 static inline void INIT_SAS_EVENT(struct asd_sas_event *ev,
296 void (*fn)(struct work_struct *),
297 struct asd_sas_phy *phy, int event)
299 INIT_SAS_WORK(&ev->work, fn);
304 #define SAS_PHY_SHUTDOWN_THRES 1024
306 /* The phy pretty much is controlled by the LLDD.
307 * The class only reads those fields.
319 /* The following are class:RO, driver:R/W */
320 int enabled; /* must be set */
322 int id; /* must be set */
323 enum sas_class class;
324 enum sas_protocol iproto;
325 enum sas_protocol tproto;
327 enum sas_phy_type type;
328 enum sas_phy_role role;
329 enum sas_oob_mode oob_mode;
330 enum sas_linkrate linkrate;
332 u8 *sas_addr; /* must be set */
333 u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
335 spinlock_t frame_rcvd_lock;
336 u8 *frame_rcvd; /* must be set */
339 spinlock_t sas_prim_lock;
342 struct list_head port_phy_el; /* driver:RO */
343 struct asd_sas_port *port; /* Class:RW, driver: RO */
345 struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
347 void *lldd_phy; /* not touched by the sas_class_code */
351 struct Scsi_Host *shost;
358 SAS_HA_ATA_EH_ACTIVE,
362 struct sas_ha_struct {
364 struct list_head defer_q; /* work queued while draining */
365 struct mutex drain_mutex;
369 wait_queue_head_t eh_wait_q;
370 struct list_head eh_dev_q;
372 struct mutex disco_mutex;
374 struct scsi_core core;
378 struct device *dev; /* should be set */
379 struct module *lldd_module; /* should be set */
381 struct workqueue_struct *event_q;
382 struct workqueue_struct *disco_q;
384 u8 *sas_addr; /* must be set */
385 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
387 spinlock_t phy_port_lock;
388 struct asd_sas_phy **sas_phy; /* array of valid pointers, must be set */
389 struct asd_sas_port **sas_port; /* array of valid pointers, must be set */
390 int num_phys; /* must be set, gt 0, static */
392 int strict_wide_ports; /* both sas_addr and attached_sas_addr must match
393 * their siblings when forming wide ports */
395 /* LLDD calls these to notify the class of an event. */
396 int (*notify_port_event)(struct asd_sas_phy *, enum port_event);
397 int (*notify_phy_event)(struct asd_sas_phy *, enum phy_event);
399 void *lldd_ha; /* not touched by sas class code */
401 struct list_head eh_done_q; /* complete via scsi_eh_flush_done_q */
402 struct list_head eh_ata_q; /* scmds to promote from sas to ata eh */
407 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
409 static inline struct domain_device *
410 starget_to_domain_dev(struct scsi_target *starget) {
411 return starget->hostdata;
414 static inline struct domain_device *
415 sdev_to_domain_dev(struct scsi_device *sdev) {
416 return starget_to_domain_dev(sdev->sdev_target);
419 static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev)
421 return &dev->sata_dev.ap->link.device[0];
424 static inline struct domain_device *
425 cmd_to_domain_dev(struct scsi_cmnd *cmd)
427 return sdev_to_domain_dev(cmd->device);
430 void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
432 /* Before calling a notify event, LLDD should use this function
433 * when the link is severed (possibly from its tasklet).
434 * The idea is that the Class only reads those, while the LLDD,
435 * can R/W these (thus avoiding a race).
437 static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
439 phy->oob_mode = OOB_NOT_CONNECTED;
440 phy->linkrate = SAS_LINK_RATE_UNKNOWN;
443 static inline unsigned int to_sas_gpio_od(int device, int bit)
445 return 3 * device + bit;
448 static inline void sas_put_local_phy(struct sas_phy *phy)
450 put_device(&phy->dev);
453 #ifdef CONFIG_SCSI_SAS_HOST_SMP
454 int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count);
456 static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count)
462 /* ---------- Tasks ---------- */
464 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
466 ---------------------+---------------------+-----------------------+
468 DEV_NO_RESPONSE | X | X |
471 DEVICE_UNKNOWN | | X |
473 ---------------------+---------------------+-----------------------+
476 enum service_response {
478 SAS_TASK_UNDELIVERED = -1,
482 /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of
483 * them here to silence 'case value not in enumerated type' warnings
485 __SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION,
487 SAS_DEV_NO_RESPONSE = 0x80,
503 /* When a task finishes with a response, the LLDD examines the
505 * - For an ATA task task_status_struct::stat is set to
506 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
507 * contents of struct ata_task_resp.
508 * - For SSP tasks, if no data is present or status/TMF response
509 * is valid, task_status_struct::stat is set. If data is present
510 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
511 * task_status_struct::buf_valid_size, and task_status_struct::stat is
512 * set to SAM_CHECK_COND.
514 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
517 * "frame_len" is the total frame length, which could be more or less
518 * than actually copied.
520 * Tasks ending with response, always set the residual field.
522 struct ata_task_resp {
524 u8 ending_fis[ATA_RESP_FIS_SIZE]; /* dev to host or data-in */
527 #define SAS_STATUS_BUF_SIZE 96
529 struct task_status_struct {
530 enum service_response resp;
531 enum exec_status stat;
534 u8 buf[SAS_STATUS_BUF_SIZE];
537 enum sas_open_rej_reason open_rej_reason;
540 /* ATA and ATAPI task queuable to a SAS LLDD.
542 struct sas_ata_task {
543 struct host_to_dev_fis fis;
544 u8 atapi_packet[16]; /* 0 if not ATAPI task */
546 u8 retry_count; /* hardware retry, should be > 0 */
548 u8 dma_xfer:1; /* PIO:0 or DMA:1 */
553 u8 device_control_reg_update:1;
556 struct sas_smp_task {
557 struct scatterlist smp_req;
558 struct scatterlist smp_resp;
561 enum task_attribute {
562 TASK_ATTR_SIMPLE = 0,
564 TASK_ATTR_ORDERED= 2,
568 struct sas_ssp_task {
569 u8 retry_count; /* hardware retry, should be > 0 */
572 u8 enable_first_burst:1;
573 enum task_attribute task_attr;
575 struct scsi_cmnd *cmd;
579 struct domain_device *dev;
581 spinlock_t task_state_lock;
582 unsigned task_state_flags;
584 enum sas_protocol task_proto;
587 struct sas_ata_task ata_task;
588 struct sas_smp_task smp_task;
589 struct sas_ssp_task ssp_task;
592 struct scatterlist *scatter;
595 u8 data_dir:2; /* Use PCI_DMA_... */
597 struct task_status_struct task_status;
598 void (*task_done)(struct sas_task *);
600 void *lldd_task; /* for use by LLDDs */
602 struct sas_task_slow *slow_task;
605 struct sas_task_slow {
606 /* standard/extra infrastructure for slow path commands (SMP and
607 * internal lldd commands
609 struct timer_list timer;
610 struct completion completion;
611 struct sas_task *task;
614 #define SAS_TASK_STATE_PENDING 1
615 #define SAS_TASK_STATE_DONE 2
616 #define SAS_TASK_STATE_ABORTED 4
617 #define SAS_TASK_NEED_DEV_RESET 8
618 #define SAS_TASK_AT_INITIATOR 16
620 extern struct sas_task *sas_alloc_task(gfp_t flags);
621 extern struct sas_task *sas_alloc_slow_task(gfp_t flags);
622 extern void sas_free_task(struct sas_task *task);
624 struct sas_domain_function_template {
625 /* The class calls these to notify the LLDD of an event. */
626 void (*lldd_port_formed)(struct asd_sas_phy *);
627 void (*lldd_port_deformed)(struct asd_sas_phy *);
629 /* The class calls these when a device is found or gone. */
630 int (*lldd_dev_found)(struct domain_device *);
631 void (*lldd_dev_gone)(struct domain_device *);
633 int (*lldd_execute_task)(struct sas_task *, gfp_t gfp_flags);
635 /* Task Management Functions. Must be called from process context. */
636 int (*lldd_abort_task)(struct sas_task *);
637 int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
638 int (*lldd_clear_aca)(struct domain_device *, u8 *lun);
639 int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
640 int (*lldd_I_T_nexus_reset)(struct domain_device *);
641 int (*lldd_ata_check_ready)(struct domain_device *);
642 void (*lldd_ata_set_dmamode)(struct domain_device *);
643 int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
644 int (*lldd_query_task)(struct sas_task *);
646 /* Port and Adapter management */
647 int (*lldd_clear_nexus_port)(struct asd_sas_port *);
648 int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
651 int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
654 int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type,
655 u8 reg_index, u8 reg_count, u8 *write_data);
658 extern int sas_register_ha(struct sas_ha_struct *);
659 extern int sas_unregister_ha(struct sas_ha_struct *);
660 extern void sas_prep_resume_ha(struct sas_ha_struct *sas_ha);
661 extern void sas_resume_ha(struct sas_ha_struct *sas_ha);
662 extern void sas_suspend_ha(struct sas_ha_struct *sas_ha);
664 int sas_set_phy_speed(struct sas_phy *phy, struct sas_phy_linkrates *rates);
665 int sas_phy_reset(struct sas_phy *phy, int hard_reset);
666 extern int sas_queuecommand(struct Scsi_Host *, struct scsi_cmnd *);
667 extern int sas_target_alloc(struct scsi_target *);
668 extern int sas_slave_configure(struct scsi_device *);
669 extern int sas_change_queue_depth(struct scsi_device *, int new_depth);
670 extern int sas_bios_param(struct scsi_device *, struct block_device *,
671 sector_t capacity, int *hsc);
672 extern struct scsi_transport_template *
673 sas_domain_attach_transport(struct sas_domain_function_template *);
674 extern struct device_attribute dev_attr_phy_event_threshold;
676 int sas_discover_root_expander(struct domain_device *);
678 void sas_init_ex_attr(void);
680 int sas_ex_revalidate_domain(struct domain_device *);
682 void sas_unregister_domain_devices(struct asd_sas_port *port, int gone);
683 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
684 int sas_discover_event(struct asd_sas_port *, enum discover_event ev);
686 int sas_discover_sata(struct domain_device *);
687 int sas_discover_end_dev(struct domain_device *);
689 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
691 void sas_init_dev(struct domain_device *);
693 void sas_task_abort(struct sas_task *);
694 int sas_eh_abort_handler(struct scsi_cmnd *cmd);
695 int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
696 int sas_eh_target_reset_handler(struct scsi_cmnd *cmd);
698 extern void sas_target_destroy(struct scsi_target *);
699 extern int sas_slave_alloc(struct scsi_device *);
700 extern int sas_ioctl(struct scsi_device *sdev, unsigned int cmd,
702 extern int sas_drain_work(struct sas_ha_struct *ha);
704 extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
705 struct ssp_response_iu *iu);
706 struct sas_phy *sas_get_local_phy(struct domain_device *dev);
708 int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
710 #endif /* _SASLIB_H_ */