Linux 4.19.15
[linux/fpc-iii.git] / include / scsi / libsas.h
blob3de3b10da19a9eee24904a5604bb74744e8eafe9
1 /*
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
22 * USA
26 #ifndef _LIBSAS_H_
27 #define _LIBSAS_H_
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>
41 struct block_device;
43 enum sas_class {
44 SAS,
45 EXPANDER
48 enum sas_phy_role {
49 PHY_ROLE_NONE = 0,
50 PHY_ROLE_TARGET = 0x40,
51 PHY_ROLE_INITIATOR = 0x80,
54 enum sas_phy_type {
55 PHY_TYPE_PHYSICAL,
56 PHY_TYPE_VIRTUAL
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.
63 enum 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,
72 enum 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,
82 enum discover_event {
83 DISCE_DISCOVER_DOMAIN = 0U,
84 DISCE_REVALIDATE_DOMAIN,
85 DISCE_SUSPEND,
86 DISCE_RESUME,
87 DISC_NUM_EVENTS,
90 /* ---------- Expander Devices ---------- */
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)
96 enum routing_attribute {
97 DIRECT_ROUTING,
98 SUBTRACTIVE_ROUTING,
99 TABLE_ROUTING,
102 enum ex_phy_state {
103 PHY_EMPTY,
104 PHY_VACANT,
105 PHY_NOT_PRESENT,
106 PHY_DEVICE_DISCOVERED
109 struct ex_phy {
110 int phy_id;
112 enum ex_phy_state phy_state;
114 enum sas_device_type attached_dev_type;
115 enum sas_linkrate linkrate;
117 u8 attached_sata_host:1;
118 u8 attached_sata_dev:1;
119 u8 attached_sata_ps:1;
121 enum sas_protocol attached_tproto;
122 enum sas_protocol attached_iproto;
124 u8 attached_sas_addr[SAS_ADDR_SIZE];
125 u8 attached_phy_id;
127 int phy_change_count;
128 enum routing_attribute routing_attr;
129 u8 virtual:1;
131 int last_da_index;
133 struct sas_phy *phy;
134 struct sas_port *port;
137 struct expander_device {
138 struct list_head children;
140 int ex_change_count;
141 u16 max_route_indexes;
142 u8 num_phys;
144 u8 t2t_supp:1;
145 u8 configuring:1;
146 u8 conf_route_table:1;
148 u8 enclosure_logical_id[8];
150 struct ex_phy *ex_phy;
151 struct sas_port *parent_port;
153 struct mutex cmd_mutex;
156 /* ---------- SATA device ---------- */
157 #define ATA_RESP_FIS_SIZE 24
159 struct sata_device {
160 unsigned int class;
161 u8 port_no; /* port number, if this is a PM (Port) */
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];
169 struct ssp_device {
170 struct list_head eh_list_node; /* pending a user requested eh action */
171 struct scsi_lun reset_lun;
174 enum {
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,
183 struct domain_device {
184 spinlock_t done_lock;
185 enum sas_device_type dev_type;
187 enum sas_linkrate linkrate;
188 enum sas_linkrate min_linkrate;
189 enum sas_linkrate max_linkrate;
191 int pathways;
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;
198 struct list_head dev_list_node;
199 struct list_head disco_list_node; /* awaiting probe or destruct */
201 enum sas_protocol iproto;
202 enum sas_protocol tproto;
204 struct sas_rphy *rphy;
206 u8 sas_addr[SAS_ADDR_SIZE];
207 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
209 u8 frame_rcvd[32];
211 union {
212 struct expander_device ex_dev;
213 struct sata_device sata_dev; /* STP & directly attached */
214 struct ssp_device ssp_dev;
217 void *lldd_dev;
218 unsigned long state;
219 struct kref kref;
222 struct sas_work {
223 struct list_head drain_node;
224 struct work_struct work;
227 static inline void INIT_SAS_WORK(struct sas_work *sw, void (*fn)(struct work_struct *))
229 INIT_WORK(&sw->work, fn);
230 INIT_LIST_HEAD(&sw->drain_node);
233 struct sas_discovery_event {
234 struct sas_work work;
235 struct asd_sas_port *port;
238 static inline struct sas_discovery_event *to_sas_discovery_event(struct work_struct *work)
240 struct sas_discovery_event *ev = container_of(work, typeof(*ev), work.work);
242 return ev;
245 struct 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;
254 /* The port struct is Class:RW, driver:RO */
255 struct 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;
266 struct sas_work work;
267 int suspended;
269 /* public: */
270 int id;
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;
278 enum sas_oob_mode oob_mode;
280 spinlock_t phy_list_lock;
281 struct list_head phy_list;
282 int num_phys;
283 u32 phy_mask;
285 struct sas_ha_struct *ha;
287 struct sas_port *port;
289 void *lldd_port; /* not touched by the sas class code */
292 struct asd_sas_event {
293 struct sas_work work;
294 struct asd_sas_phy *phy;
295 int event;
298 static inline struct asd_sas_event *to_asd_sas_event(struct work_struct *work)
300 struct asd_sas_event *ev = container_of(work, typeof(*ev), work.work);
302 return ev;
305 static inline void INIT_SAS_EVENT(struct asd_sas_event *ev,
306 void (*fn)(struct work_struct *),
307 struct asd_sas_phy *phy, int event)
309 INIT_SAS_WORK(&ev->work, fn);
310 ev->phy = phy;
311 ev->event = event;
314 #define SAS_PHY_SHUTDOWN_THRES 1024
316 /* The phy pretty much is controlled by the LLDD.
317 * The class only reads those fields.
319 struct asd_sas_phy {
320 /* private: */
321 atomic_t event_nr;
322 int in_shutdown;
323 int error;
324 int suspended;
326 struct sas_phy *phy;
328 /* public: */
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 */
347 int frame_rcvd_size;
349 spinlock_t sas_prim_lock;
350 u32 sas_prim;
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 */
360 struct scsi_core {
361 struct Scsi_Host *shost;
365 enum sas_ha_state {
366 SAS_HA_REGISTERED,
367 SAS_HA_DRAINING,
368 SAS_HA_ATA_EH_ACTIVE,
369 SAS_HA_FROZEN,
372 struct 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;
382 struct mutex disco_mutex;
384 struct scsi_core core;
386 /* public: */
387 char *sas_ha_name;
388 struct device *dev; /* should be set */
389 struct module *lldd_module; /* should be set */
391 struct workqueue_struct *event_q;
392 struct workqueue_struct *disco_q;
394 u8 *sas_addr; /* must be set */
395 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
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 */
402 int strict_wide_ports; /* both sas_addr and attached_sas_addr must match
403 * their siblings when forming wide ports */
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);
409 void *lldd_ha; /* not touched by sas class code */
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 */
414 int event_thres;
417 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
419 static inline struct domain_device *
420 starget_to_domain_dev(struct scsi_target *starget) {
421 return starget->hostdata;
424 static inline struct domain_device *
425 sdev_to_domain_dev(struct scsi_device *sdev) {
426 return starget_to_domain_dev(sdev->sdev_target);
429 static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev)
431 return &dev->sata_dev.ap->link.device[0];
434 static inline struct domain_device *
435 cmd_to_domain_dev(struct scsi_cmnd *cmd)
437 return sdev_to_domain_dev(cmd->device);
440 void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
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).
447 static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
449 phy->oob_mode = OOB_NOT_CONNECTED;
450 phy->linkrate = SAS_LINK_RATE_UNKNOWN;
453 static inline unsigned int to_sas_gpio_od(int device, int bit)
455 return 3 * device + bit;
458 static inline void sas_put_local_phy(struct sas_phy *phy)
460 put_device(&phy->dev);
463 #ifdef CONFIG_SCSI_SAS_HOST_SMP
464 int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count);
465 #else
466 static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count)
468 return -1;
470 #endif
472 /* ---------- Tasks ---------- */
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 ---------------------+---------------------+-----------------------+
486 enum service_response {
487 SAS_TASK_COMPLETE,
488 SAS_TASK_UNDELIVERED = -1,
491 enum 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
495 __SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION,
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,
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.
524 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
525 * for ATA task.
527 * "frame_len" is the total frame length, which could be more or less
528 * than actually copied.
530 * Tasks ending with response, always set the residual field.
532 struct ata_task_resp {
533 u16 frame_len;
534 u8 ending_fis[ATA_RESP_FIS_SIZE]; /* dev to host or data-in */
537 #define SAS_STATUS_BUF_SIZE 96
539 struct task_status_struct {
540 enum service_response resp;
541 enum exec_status stat;
542 int buf_valid_size;
544 u8 buf[SAS_STATUS_BUF_SIZE];
546 u32 residual;
547 enum sas_open_rej_reason open_rej_reason;
550 /* ATA and ATAPI task queuable to a SAS LLDD.
552 struct sas_ata_task {
553 struct host_to_dev_fis fis;
554 u8 atapi_packet[16]; /* 0 if not ATAPI task */
556 u8 retry_count; /* hardware retry, should be > 0 */
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;
563 u8 device_control_reg_update:1;
566 struct sas_smp_task {
567 struct scatterlist smp_req;
568 struct scatterlist smp_resp;
571 enum task_attribute {
572 TASK_ATTR_SIMPLE = 0,
573 TASK_ATTR_HOQ = 1,
574 TASK_ATTR_ORDERED= 2,
575 TASK_ATTR_ACA = 4,
578 struct sas_ssp_task {
579 u8 retry_count; /* hardware retry, should be > 0 */
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;
588 struct sas_task {
589 struct domain_device *dev;
591 spinlock_t task_state_lock;
592 unsigned task_state_flags;
594 enum sas_protocol task_proto;
596 union {
597 struct sas_ata_task ata_task;
598 struct sas_smp_task smp_task;
599 struct sas_ssp_task ssp_task;
602 struct scatterlist *scatter;
603 int num_scatter;
604 u32 total_xfer_len;
605 u8 data_dir:2; /* Use PCI_DMA_... */
607 struct task_status_struct task_status;
608 void (*task_done)(struct sas_task *);
610 void *lldd_task; /* for use by LLDDs */
611 void *uldd_task;
612 struct sas_task_slow *slow_task;
615 struct sas_task_slow {
616 /* standard/extra infrastructure for slow path commands (SMP and
617 * internal lldd commands
619 struct timer_list timer;
620 struct completion completion;
621 struct sas_task *task;
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
630 extern struct sas_task *sas_alloc_task(gfp_t flags);
631 extern struct sas_task *sas_alloc_slow_task(gfp_t flags);
632 extern void sas_free_task(struct sas_task *task);
634 struct 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 *);
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 *);
643 int (*lldd_execute_task)(struct sas_task *, gfp_t gfp_flags);
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 *);
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 *);
660 /* Phy management */
661 int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
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);
668 extern int sas_register_ha(struct sas_ha_struct *);
669 extern int sas_unregister_ha(struct sas_ha_struct *);
670 extern void sas_prep_resume_ha(struct sas_ha_struct *sas_ha);
671 extern void sas_resume_ha(struct sas_ha_struct *sas_ha);
672 extern void sas_suspend_ha(struct sas_ha_struct *sas_ha);
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 extern int sas_queuecommand(struct Scsi_Host * ,struct scsi_cmnd *);
678 extern int sas_target_alloc(struct scsi_target *);
679 extern int sas_slave_configure(struct scsi_device *);
680 extern int sas_change_queue_depth(struct scsi_device *, int new_depth);
681 extern int sas_bios_param(struct scsi_device *,
682 struct block_device *,
683 sector_t capacity, int *hsc);
684 extern struct scsi_transport_template *
685 sas_domain_attach_transport(struct sas_domain_function_template *);
686 extern struct device_attribute dev_attr_phy_event_threshold;
688 int sas_discover_root_expander(struct domain_device *);
690 void sas_init_ex_attr(void);
692 int sas_ex_revalidate_domain(struct domain_device *);
694 void sas_unregister_domain_devices(struct asd_sas_port *port, int gone);
695 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
696 int sas_discover_event(struct asd_sas_port *, enum discover_event ev);
698 int sas_discover_sata(struct domain_device *);
699 int sas_discover_end_dev(struct domain_device *);
701 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
703 void sas_init_dev(struct domain_device *);
705 void sas_task_abort(struct sas_task *);
706 int sas_eh_abort_handler(struct scsi_cmnd *cmd);
707 int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
708 int sas_eh_target_reset_handler(struct scsi_cmnd *cmd);
710 extern void sas_target_destroy(struct scsi_target *);
711 extern int sas_slave_alloc(struct scsi_device *);
712 extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg);
713 extern int sas_drain_work(struct sas_ha_struct *ha);
715 extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
716 struct ssp_response_iu *iu);
717 struct sas_phy *sas_get_local_phy(struct domain_device *dev);
719 int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
721 #endif /* _SASLIB_H_ */