]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/scsi/libsas.h
Merge tag 'kvm-ppc-fixes-4.15-3' of git://git.kernel.org/pub/scm/linux/kernel/git...
[mirror_ubuntu-bionic-kernel.git] / include / scsi / libsas.h
1 /*
2 * SAS host prototypes and structures header file
3 *
4 * Copyright (C) 2005 Adaptec, Inc. All rights reserved.
5 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
6 *
7 * This file is licensed under GPLv2.
8 *
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.
13 *
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.
18 *
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
23 *
24 */
25
26 #ifndef _LIBSAS_H_
27 #define _LIBSAS_H_
28
29
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>
40
41 struct block_device;
42
43 enum sas_class {
44 SAS,
45 EXPANDER
46 };
47
48 enum sas_phy_role {
49 PHY_ROLE_NONE = 0,
50 PHY_ROLE_TARGET = 0x40,
51 PHY_ROLE_INITIATOR = 0x80,
52 };
53
54 enum sas_phy_type {
55 PHY_TYPE_PHYSICAL,
56 PHY_TYPE_VIRTUAL
57 };
58
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.
62 */
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,
70 };
71
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 PHY_NUM_EVENTS,
79 };
80
81 enum discover_event {
82 DISCE_DISCOVER_DOMAIN = 0U,
83 DISCE_REVALIDATE_DOMAIN,
84 DISCE_PROBE,
85 DISCE_SUSPEND,
86 DISCE_RESUME,
87 DISCE_DESTRUCT,
88 DISC_NUM_EVENTS,
89 };
90
91 /* ---------- Expander Devices ---------- */
92
93 #define to_dom_device(_obj) container_of(_obj, struct domain_device, dev_obj)
94 #define to_dev_attr(_attr) container_of(_attr, struct domain_dev_attribute,\
95 attr)
96
97 enum routing_attribute {
98 DIRECT_ROUTING,
99 SUBTRACTIVE_ROUTING,
100 TABLE_ROUTING,
101 };
102
103 enum ex_phy_state {
104 PHY_EMPTY,
105 PHY_VACANT,
106 PHY_NOT_PRESENT,
107 PHY_DEVICE_DISCOVERED
108 };
109
110 struct ex_phy {
111 int phy_id;
112
113 enum ex_phy_state phy_state;
114
115 enum sas_device_type attached_dev_type;
116 enum sas_linkrate linkrate;
117
118 u8 attached_sata_host:1;
119 u8 attached_sata_dev:1;
120 u8 attached_sata_ps:1;
121
122 enum sas_protocol attached_tproto;
123 enum sas_protocol attached_iproto;
124
125 u8 attached_sas_addr[SAS_ADDR_SIZE];
126 u8 attached_phy_id;
127
128 int phy_change_count;
129 enum routing_attribute routing_attr;
130 u8 virtual:1;
131
132 int last_da_index;
133
134 struct sas_phy *phy;
135 struct sas_port *port;
136 };
137
138 struct expander_device {
139 struct list_head children;
140
141 int ex_change_count;
142 u16 max_route_indexes;
143 u8 num_phys;
144
145 u8 t2t_supp:1;
146 u8 configuring:1;
147 u8 conf_route_table:1;
148
149 u8 enclosure_logical_id[8];
150
151 struct ex_phy *ex_phy;
152 struct sas_port *parent_port;
153
154 struct mutex cmd_mutex;
155 };
156
157 /* ---------- SATA device ---------- */
158 #define ATA_RESP_FIS_SIZE 24
159
160 struct sata_device {
161 unsigned int class;
162 u8 port_no; /* port number, if this is a PM (Port) */
163
164 struct ata_port *ap;
165 struct ata_host ata_host;
166 struct smp_resp rps_resp ____cacheline_aligned; /* report_phy_sata_resp */
167 u8 fis[ATA_RESP_FIS_SIZE];
168 };
169
170 struct ssp_device {
171 struct list_head eh_list_node; /* pending a user requested eh action */
172 struct scsi_lun reset_lun;
173 };
174
175 enum {
176 SAS_DEV_GONE,
177 SAS_DEV_FOUND, /* device notified to lldd */
178 SAS_DEV_DESTROY,
179 SAS_DEV_EH_PENDING,
180 SAS_DEV_LU_RESET,
181 SAS_DEV_RESET,
182 };
183
184 struct domain_device {
185 spinlock_t done_lock;
186 enum sas_device_type dev_type;
187
188 enum sas_linkrate linkrate;
189 enum sas_linkrate min_linkrate;
190 enum sas_linkrate max_linkrate;
191
192 int pathways;
193
194 struct domain_device *parent;
195 struct list_head siblings; /* devices on the same level */
196 struct asd_sas_port *port; /* shortcut to root of the tree */
197 struct sas_phy *phy;
198
199 struct list_head dev_list_node;
200 struct list_head disco_list_node; /* awaiting probe or destruct */
201
202 enum sas_protocol iproto;
203 enum sas_protocol tproto;
204
205 struct sas_rphy *rphy;
206
207 u8 sas_addr[SAS_ADDR_SIZE];
208 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
209
210 u8 frame_rcvd[32];
211
212 union {
213 struct expander_device ex_dev;
214 struct sata_device sata_dev; /* STP & directly attached */
215 struct ssp_device ssp_dev;
216 };
217
218 void *lldd_dev;
219 unsigned long state;
220 struct kref kref;
221 };
222
223 struct sas_work {
224 struct list_head drain_node;
225 struct work_struct work;
226 };
227
228 static inline void INIT_SAS_WORK(struct sas_work *sw, void (*fn)(struct work_struct *))
229 {
230 INIT_WORK(&sw->work, fn);
231 INIT_LIST_HEAD(&sw->drain_node);
232 }
233
234 struct sas_discovery_event {
235 struct sas_work work;
236 struct asd_sas_port *port;
237 };
238
239 static inline struct sas_discovery_event *to_sas_discovery_event(struct work_struct *work)
240 {
241 struct sas_discovery_event *ev = container_of(work, typeof(*ev), work.work);
242
243 return ev;
244 }
245
246 struct sas_discovery {
247 struct sas_discovery_event disc_work[DISC_NUM_EVENTS];
248 unsigned long pending;
249 u8 fanout_sas_addr[8];
250 u8 eeds_a[8];
251 u8 eeds_b[8];
252 int max_level;
253 };
254
255 /* The port struct is Class:RW, driver:RO */
256 struct asd_sas_port {
257 /* private: */
258 struct sas_discovery disc;
259 struct domain_device *port_dev;
260 spinlock_t dev_list_lock;
261 struct list_head dev_list;
262 struct list_head disco_list;
263 struct list_head destroy_list;
264 enum sas_linkrate linkrate;
265
266 struct sas_work work;
267 int suspended;
268
269 /* public: */
270 int id;
271
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;
277
278 enum sas_oob_mode oob_mode;
279
280 spinlock_t phy_list_lock;
281 struct list_head phy_list;
282 int num_phys;
283 u32 phy_mask;
284
285 struct sas_ha_struct *ha;
286
287 struct sas_port *port;
288
289 void *lldd_port; /* not touched by the sas class code */
290 };
291
292 struct asd_sas_event {
293 struct sas_work work;
294 struct asd_sas_phy *phy;
295 };
296
297 static inline struct asd_sas_event *to_asd_sas_event(struct work_struct *work)
298 {
299 struct asd_sas_event *ev = container_of(work, typeof(*ev), work.work);
300
301 return ev;
302 }
303
304 /* The phy pretty much is controlled by the LLDD.
305 * The class only reads those fields.
306 */
307 struct asd_sas_phy {
308 /* private: */
309 struct asd_sas_event port_events[PORT_NUM_EVENTS];
310 struct asd_sas_event phy_events[PHY_NUM_EVENTS];
311
312 unsigned long port_events_pending;
313 unsigned long phy_events_pending;
314
315 int error;
316 int suspended;
317
318 struct sas_phy *phy;
319
320 /* public: */
321 /* The following are class:RO, driver:R/W */
322 int enabled; /* must be set */
323
324 int id; /* must be set */
325 enum sas_class class;
326 enum sas_protocol iproto;
327 enum sas_protocol tproto;
328
329 enum sas_phy_type type;
330 enum sas_phy_role role;
331 enum sas_oob_mode oob_mode;
332 enum sas_linkrate linkrate;
333
334 u8 *sas_addr; /* must be set */
335 u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
336
337 spinlock_t frame_rcvd_lock;
338 u8 *frame_rcvd; /* must be set */
339 int frame_rcvd_size;
340
341 spinlock_t sas_prim_lock;
342 u32 sas_prim;
343
344 struct list_head port_phy_el; /* driver:RO */
345 struct asd_sas_port *port; /* Class:RW, driver: RO */
346
347 struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
348
349 void *lldd_phy; /* not touched by the sas_class_code */
350 };
351
352 struct scsi_core {
353 struct Scsi_Host *shost;
354
355 };
356
357 enum sas_ha_state {
358 SAS_HA_REGISTERED,
359 SAS_HA_DRAINING,
360 SAS_HA_ATA_EH_ACTIVE,
361 SAS_HA_FROZEN,
362 };
363
364 struct sas_ha_struct {
365 /* private: */
366 struct list_head defer_q; /* work queued while draining */
367 struct mutex drain_mutex;
368 unsigned long state;
369 spinlock_t lock;
370 int eh_active;
371 wait_queue_head_t eh_wait_q;
372 struct list_head eh_dev_q;
373
374 struct mutex disco_mutex;
375
376 struct scsi_core core;
377
378 /* public: */
379 char *sas_ha_name;
380 struct device *dev; /* should be set */
381 struct module *lldd_module; /* should be set */
382
383 u8 *sas_addr; /* must be set */
384 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
385
386 spinlock_t phy_port_lock;
387 struct asd_sas_phy **sas_phy; /* array of valid pointers, must be set */
388 struct asd_sas_port **sas_port; /* array of valid pointers, must be set */
389 int num_phys; /* must be set, gt 0, static */
390
391 int strict_wide_ports; /* both sas_addr and attached_sas_addr must match
392 * their siblings when forming wide ports */
393
394 /* LLDD calls these to notify the class of an event. */
395 int (*notify_port_event)(struct asd_sas_phy *, enum port_event);
396 int (*notify_phy_event)(struct asd_sas_phy *, enum phy_event);
397
398 void *lldd_ha; /* not touched by sas class code */
399
400 struct list_head eh_done_q; /* complete via scsi_eh_flush_done_q */
401 struct list_head eh_ata_q; /* scmds to promote from sas to ata eh */
402 };
403
404 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
405
406 static inline struct domain_device *
407 starget_to_domain_dev(struct scsi_target *starget) {
408 return starget->hostdata;
409 }
410
411 static inline struct domain_device *
412 sdev_to_domain_dev(struct scsi_device *sdev) {
413 return starget_to_domain_dev(sdev->sdev_target);
414 }
415
416 static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev)
417 {
418 return &dev->sata_dev.ap->link.device[0];
419 }
420
421 static inline struct domain_device *
422 cmd_to_domain_dev(struct scsi_cmnd *cmd)
423 {
424 return sdev_to_domain_dev(cmd->device);
425 }
426
427 void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
428
429 /* Before calling a notify event, LLDD should use this function
430 * when the link is severed (possibly from its tasklet).
431 * The idea is that the Class only reads those, while the LLDD,
432 * can R/W these (thus avoiding a race).
433 */
434 static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
435 {
436 phy->oob_mode = OOB_NOT_CONNECTED;
437 phy->linkrate = SAS_LINK_RATE_UNKNOWN;
438 }
439
440 static inline unsigned int to_sas_gpio_od(int device, int bit)
441 {
442 return 3 * device + bit;
443 }
444
445 static inline void sas_put_local_phy(struct sas_phy *phy)
446 {
447 put_device(&phy->dev);
448 }
449
450 #ifdef CONFIG_SCSI_SAS_HOST_SMP
451 int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count);
452 #else
453 static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count)
454 {
455 return -1;
456 }
457 #endif
458
459 /* ---------- Tasks ---------- */
460 /*
461 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
462 exec_status | | |
463 ---------------------+---------------------+-----------------------+
464 SAM_... | X | |
465 DEV_NO_RESPONSE | X | X |
466 INTERRUPTED | X | |
467 QUEUE_FULL | | X |
468 DEVICE_UNKNOWN | | X |
469 SG_ERR | | X |
470 ---------------------+---------------------+-----------------------+
471 */
472
473 enum service_response {
474 SAS_TASK_COMPLETE,
475 SAS_TASK_UNDELIVERED = -1,
476 };
477
478 enum exec_status {
479 /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of
480 * them here to silence 'case value not in enumerated type' warnings
481 */
482 __SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION,
483
484 SAS_DEV_NO_RESPONSE = 0x80,
485 SAS_DATA_UNDERRUN,
486 SAS_DATA_OVERRUN,
487 SAS_INTERRUPTED,
488 SAS_QUEUE_FULL,
489 SAS_DEVICE_UNKNOWN,
490 SAS_SG_ERR,
491 SAS_OPEN_REJECT,
492 SAS_OPEN_TO,
493 SAS_PROTO_RESPONSE,
494 SAS_PHY_DOWN,
495 SAS_NAK_R_ERR,
496 SAS_PENDING,
497 SAS_ABORTED_TASK,
498 };
499
500 /* When a task finishes with a response, the LLDD examines the
501 * response:
502 * - For an ATA task task_status_struct::stat is set to
503 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
504 * contents of struct ata_task_resp.
505 * - For SSP tasks, if no data is present or status/TMF response
506 * is valid, task_status_struct::stat is set. If data is present
507 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
508 * task_status_struct::buf_valid_size, and task_status_struct::stat is
509 * set to SAM_CHECK_COND.
510 *
511 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
512 * for ATA task.
513 *
514 * "frame_len" is the total frame length, which could be more or less
515 * than actually copied.
516 *
517 * Tasks ending with response, always set the residual field.
518 */
519 struct ata_task_resp {
520 u16 frame_len;
521 u8 ending_fis[ATA_RESP_FIS_SIZE]; /* dev to host or data-in */
522 };
523
524 #define SAS_STATUS_BUF_SIZE 96
525
526 struct task_status_struct {
527 enum service_response resp;
528 enum exec_status stat;
529 int buf_valid_size;
530
531 u8 buf[SAS_STATUS_BUF_SIZE];
532
533 u32 residual;
534 enum sas_open_rej_reason open_rej_reason;
535 };
536
537 /* ATA and ATAPI task queuable to a SAS LLDD.
538 */
539 struct sas_ata_task {
540 struct host_to_dev_fis fis;
541 u8 atapi_packet[16]; /* 0 if not ATAPI task */
542
543 u8 retry_count; /* hardware retry, should be > 0 */
544
545 u8 dma_xfer:1; /* PIO:0 or DMA:1 */
546 u8 use_ncq:1;
547 u8 set_affil_pol:1;
548 u8 stp_affil_pol:1;
549
550 u8 device_control_reg_update:1;
551 };
552
553 struct sas_smp_task {
554 struct scatterlist smp_req;
555 struct scatterlist smp_resp;
556 };
557
558 enum task_attribute {
559 TASK_ATTR_SIMPLE = 0,
560 TASK_ATTR_HOQ = 1,
561 TASK_ATTR_ORDERED= 2,
562 TASK_ATTR_ACA = 4,
563 };
564
565 struct sas_ssp_task {
566 u8 retry_count; /* hardware retry, should be > 0 */
567
568 u8 LUN[8];
569 u8 enable_first_burst:1;
570 enum task_attribute task_attr;
571 u8 task_prio;
572 struct scsi_cmnd *cmd;
573 };
574
575 struct sas_task {
576 struct domain_device *dev;
577
578 spinlock_t task_state_lock;
579 unsigned task_state_flags;
580
581 enum sas_protocol task_proto;
582
583 union {
584 struct sas_ata_task ata_task;
585 struct sas_smp_task smp_task;
586 struct sas_ssp_task ssp_task;
587 };
588
589 struct scatterlist *scatter;
590 int num_scatter;
591 u32 total_xfer_len;
592 u8 data_dir:2; /* Use PCI_DMA_... */
593
594 struct task_status_struct task_status;
595 void (*task_done)(struct sas_task *);
596
597 void *lldd_task; /* for use by LLDDs */
598 void *uldd_task;
599 struct sas_task_slow *slow_task;
600 };
601
602 struct sas_task_slow {
603 /* standard/extra infrastructure for slow path commands (SMP and
604 * internal lldd commands
605 */
606 struct timer_list timer;
607 struct completion completion;
608 struct sas_task *task;
609 };
610
611 #define SAS_TASK_STATE_PENDING 1
612 #define SAS_TASK_STATE_DONE 2
613 #define SAS_TASK_STATE_ABORTED 4
614 #define SAS_TASK_NEED_DEV_RESET 8
615 #define SAS_TASK_AT_INITIATOR 16
616
617 extern struct sas_task *sas_alloc_task(gfp_t flags);
618 extern struct sas_task *sas_alloc_slow_task(gfp_t flags);
619 extern void sas_free_task(struct sas_task *task);
620
621 struct sas_domain_function_template {
622 /* The class calls these to notify the LLDD of an event. */
623 void (*lldd_port_formed)(struct asd_sas_phy *);
624 void (*lldd_port_deformed)(struct asd_sas_phy *);
625
626 /* The class calls these when a device is found or gone. */
627 int (*lldd_dev_found)(struct domain_device *);
628 void (*lldd_dev_gone)(struct domain_device *);
629
630 int (*lldd_execute_task)(struct sas_task *, gfp_t gfp_flags);
631
632 /* Task Management Functions. Must be called from process context. */
633 int (*lldd_abort_task)(struct sas_task *);
634 int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
635 int (*lldd_clear_aca)(struct domain_device *, u8 *lun);
636 int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
637 int (*lldd_I_T_nexus_reset)(struct domain_device *);
638 int (*lldd_ata_check_ready)(struct domain_device *);
639 void (*lldd_ata_set_dmamode)(struct domain_device *);
640 int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
641 int (*lldd_query_task)(struct sas_task *);
642
643 /* Port and Adapter management */
644 int (*lldd_clear_nexus_port)(struct asd_sas_port *);
645 int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
646
647 /* Phy management */
648 int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
649
650 /* GPIO support */
651 int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type,
652 u8 reg_index, u8 reg_count, u8 *write_data);
653 };
654
655 extern int sas_register_ha(struct sas_ha_struct *);
656 extern int sas_unregister_ha(struct sas_ha_struct *);
657 extern void sas_prep_resume_ha(struct sas_ha_struct *sas_ha);
658 extern void sas_resume_ha(struct sas_ha_struct *sas_ha);
659 extern void sas_suspend_ha(struct sas_ha_struct *sas_ha);
660
661 int sas_set_phy_speed(struct sas_phy *phy,
662 struct sas_phy_linkrates *rates);
663 int sas_phy_reset(struct sas_phy *phy, int hard_reset);
664 extern int sas_queuecommand(struct Scsi_Host * ,struct scsi_cmnd *);
665 extern int sas_target_alloc(struct scsi_target *);
666 extern int sas_slave_configure(struct scsi_device *);
667 extern int sas_change_queue_depth(struct scsi_device *, int new_depth);
668 extern int sas_bios_param(struct scsi_device *,
669 struct block_device *,
670 sector_t capacity, int *hsc);
671 extern struct scsi_transport_template *
672 sas_domain_attach_transport(struct sas_domain_function_template *);
673
674 int sas_discover_root_expander(struct domain_device *);
675
676 void sas_init_ex_attr(void);
677
678 int sas_ex_revalidate_domain(struct domain_device *);
679
680 void sas_unregister_domain_devices(struct asd_sas_port *port, int gone);
681 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
682 int sas_discover_event(struct asd_sas_port *, enum discover_event ev);
683
684 int sas_discover_sata(struct domain_device *);
685 int sas_discover_end_dev(struct domain_device *);
686
687 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
688
689 void sas_init_dev(struct domain_device *);
690
691 void sas_task_abort(struct sas_task *);
692 int sas_eh_abort_handler(struct scsi_cmnd *cmd);
693 int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
694 int sas_eh_target_reset_handler(struct scsi_cmnd *cmd);
695
696 extern void sas_target_destroy(struct scsi_target *);
697 extern int sas_slave_alloc(struct scsi_device *);
698 extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg);
699 extern int sas_drain_work(struct sas_ha_struct *ha);
700
701 extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
702 struct ssp_response_iu *iu);
703 struct sas_phy *sas_get_local_phy(struct domain_device *dev);
704
705 int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
706
707 #endif /* _SASLIB_H_ */