blob: 56b2dba7d9112f5e6b69b552d4493448e7d2615b [file] [log] [blame]
James Bottomley2908d772006-08-29 09:22:51 -05001/*
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>
Darrick J. Wongfa1c1e82006-08-10 19:19:47 -070033#include <linux/libata.h>
James Bottomley2908d772006-08-29 09:22:51 -050034#include <linux/list.h>
James Bottomley2908d772006-08-29 09:22:51 -050035#include <scsi/scsi_device.h>
36#include <scsi/scsi_cmnd.h>
37#include <scsi/scsi_transport_sas.h>
Adrian Bunk87ae9af2007-10-30 10:35:04 +010038#include <linux/scatterlist.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090039#include <linux/slab.h>
James Bottomley2908d772006-08-29 09:22:51 -050040
41struct block_device;
42
43enum sas_class {
44 SAS,
45 EXPANDER
46};
47
48enum sas_phy_role {
49 PHY_ROLE_NONE = 0,
50 PHY_ROLE_TARGET = 0x40,
51 PHY_ROLE_INITIATOR = 0x80,
52};
53
54enum sas_phy_type {
John Garryff525b62019-01-05 00:01:26 +080055 PHY_TYPE_PHYSICAL,
56 PHY_TYPE_VIRTUAL
James Bottomley2908d772006-08-29 09:22:51 -050057};
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 */
James Bottomley2908d772006-08-29 09:22:51 -050063enum port_event {
64 PORTE_BYTES_DMAED = 0U,
Jason Yan0d78f962017-09-06 17:15:05 +080065 PORTE_BROADCAST_RCVD,
66 PORTE_LINK_RESET_ERR,
67 PORTE_TIMER_EVENT,
68 PORTE_HARD_RESET,
69 PORT_NUM_EVENTS,
James Bottomley2908d772006-08-29 09:22:51 -050070};
71
72enum phy_event {
73 PHYE_LOSS_OF_SIGNAL = 0U,
Jason Yan0d78f962017-09-06 17:15:05 +080074 PHYE_OOB_DONE,
75 PHYE_OOB_ERROR,
76 PHYE_SPINUP_HOLD, /* hot plug SATA, no COMWAKE sent */
77 PHYE_RESUME_TIMEOUT,
Jason Yanf12486e2017-12-08 17:42:05 +080078 PHYE_SHUTDOWN,
Jason Yan0d78f962017-09-06 17:15:05 +080079 PHY_NUM_EVENTS,
James Bottomley2908d772006-08-29 09:22:51 -050080};
81
82enum discover_event {
83 DISCE_DISCOVER_DOMAIN = 0U,
Jason Yan0d78f962017-09-06 17:15:05 +080084 DISCE_REVALIDATE_DOMAIN,
Jason Yan0d78f962017-09-06 17:15:05 +080085 DISCE_SUSPEND,
86 DISCE_RESUME,
Jason Yan0d78f962017-09-06 17:15:05 +080087 DISC_NUM_EVENTS,
James Bottomley2908d772006-08-29 09:22:51 -050088};
89
90/* ---------- Expander Devices ---------- */
91
James Bottomley2908d772006-08-29 09:22:51 -050092#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,\
John Garryff525b62019-01-05 00:01:26 +080094 attr)
James Bottomley2908d772006-08-29 09:22:51 -050095
96enum routing_attribute {
97 DIRECT_ROUTING,
98 SUBTRACTIVE_ROUTING,
99 TABLE_ROUTING,
100};
101
102enum ex_phy_state {
103 PHY_EMPTY,
104 PHY_VACANT,
105 PHY_NOT_PRESENT,
106 PHY_DEVICE_DISCOVERED
107};
108
109struct ex_phy {
110 int phy_id;
111
112 enum ex_phy_state phy_state;
113
James Bottomleyaa9f8322013-05-07 14:44:06 -0700114 enum sas_device_type attached_dev_type;
James Bottomley88edf742006-09-06 17:36:13 -0500115 enum sas_linkrate linkrate;
James Bottomley2908d772006-08-29 09:22:51 -0500116
117 u8 attached_sata_host:1;
118 u8 attached_sata_dev:1;
119 u8 attached_sata_ps:1;
120
Darrick J. Wong5929faf2007-11-05 11:51:17 -0800121 enum sas_protocol attached_tproto;
122 enum sas_protocol attached_iproto;
James Bottomley2908d772006-08-29 09:22:51 -0500123
124 u8 attached_sas_addr[SAS_ADDR_SIZE];
125 u8 attached_phy_id;
126
Dan Williams303694e2012-06-21 23:41:51 -0700127 int phy_change_count;
James Bottomley2908d772006-08-29 09:22:51 -0500128 enum routing_attribute routing_attr;
129 u8 virtual:1;
130
131 int last_da_index;
132
133 struct sas_phy *phy;
134 struct sas_port *port;
135};
136
137struct expander_device {
138 struct list_head children;
139
Dan Williams303694e2012-06-21 23:41:51 -0700140 int ex_change_count;
James Bottomley2908d772006-08-29 09:22:51 -0500141 u16 max_route_indexes;
142 u8 num_phys;
Luben Tuikovffaac8f2011-09-22 09:41:36 -0700143
144 u8 t2t_supp:1;
James Bottomley2908d772006-08-29 09:22:51 -0500145 u8 configuring:1;
146 u8 conf_route_table:1;
Luben Tuikovffaac8f2011-09-22 09:41:36 -0700147
James Bottomley2908d772006-08-29 09:22:51 -0500148 u8 enclosure_logical_id[8];
149
150 struct ex_phy *ex_phy;
151 struct sas_port *parent_port;
Jeff Skirvin89d3cf62011-11-16 09:44:13 +0000152
153 struct mutex cmd_mutex;
James Bottomley2908d772006-08-29 09:22:51 -0500154};
155
156/* ---------- SATA device ---------- */
Dan Williams6ef1b512012-06-22 10:52:34 -0700157#define ATA_RESP_FIS_SIZE 24
158
James Bottomley2908d772006-08-29 09:22:51 -0500159struct sata_device {
Hannes Reinecke1cbd7722014-11-05 13:08:20 +0100160 unsigned int class;
Hannes Reinecke1cbd7722014-11-05 13:08:20 +0100161 u8 port_no; /* port number, if this is a PM (Port) */
Darrick J. Wongfa1c1e82006-08-10 19:19:47 -0700162
163 struct ata_port *ap;
Jason Yan2fa4a322018-05-10 11:05:16 +0800164 struct ata_host *ata_host;
Huacai Chenc2e8fbf2017-11-21 14:23:39 +0100165 struct smp_resp rps_resp ____cacheline_aligned; /* report_phy_sata_resp */
Dan Williams6ef1b512012-06-22 10:52:34 -0700166 u8 fis[ATA_RESP_FIS_SIZE];
James Bottomley2908d772006-08-29 09:22:51 -0500167};
168
Dan Williams5db45bd2012-06-21 23:30:48 -0700169struct ssp_device {
170 struct list_head eh_list_node; /* pending a user requested eh action */
171 struct scsi_lun reset_lun;
172};
173
Dan Williamse1399422012-01-07 08:52:39 +0000174enum {
175 SAS_DEV_GONE,
Dan Williams303694e2012-06-21 23:41:51 -0700176 SAS_DEV_FOUND, /* device notified to lldd */
Dan Williams87c83312011-11-17 17:59:51 -0800177 SAS_DEV_DESTROY,
Dan Williamse4a9c372012-06-21 23:25:27 -0700178 SAS_DEV_EH_PENDING,
Dan Williams5db45bd2012-06-21 23:30:48 -0700179 SAS_DEV_LU_RESET,
180 SAS_DEV_RESET,
Dan Williamse1399422012-01-07 08:52:39 +0000181};
182
James Bottomley2908d772006-08-29 09:22:51 -0500183struct domain_device {
Dan Williams9095a642011-11-28 11:29:20 -0800184 spinlock_t done_lock;
James Bottomleyaa9f8322013-05-07 14:44:06 -0700185 enum sas_device_type dev_type;
James Bottomley2908d772006-08-29 09:22:51 -0500186
John Garryff525b62019-01-05 00:01:26 +0800187 enum sas_linkrate linkrate;
188 enum sas_linkrate min_linkrate;
189 enum sas_linkrate max_linkrate;
James Bottomley2908d772006-08-29 09:22:51 -0500190
John Garryff525b62019-01-05 00:01:26 +0800191 int pathways;
James Bottomley2908d772006-08-29 09:22:51 -0500192
John Garryff525b62019-01-05 00:01:26 +0800193 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 */
Dan Williamsf41a0c42011-12-21 21:33:17 -0800196 struct sas_phy *phy;
James Bottomley2908d772006-08-29 09:22:51 -0500197
John Garryff525b62019-01-05 00:01:26 +0800198 struct list_head dev_list_node;
Dan Williams87c83312011-11-17 17:59:51 -0800199 struct list_head disco_list_node; /* awaiting probe or destruct */
James Bottomley2908d772006-08-29 09:22:51 -0500200
John Garryff525b62019-01-05 00:01:26 +0800201 enum sas_protocol iproto;
202 enum sas_protocol tproto;
James Bottomley2908d772006-08-29 09:22:51 -0500203
John Garryff525b62019-01-05 00:01:26 +0800204 struct sas_rphy *rphy;
James Bottomley2908d772006-08-29 09:22:51 -0500205
John Garryff525b62019-01-05 00:01:26 +0800206 u8 sas_addr[SAS_ADDR_SIZE];
207 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
James Bottomley2908d772006-08-29 09:22:51 -0500208
John Garryff525b62019-01-05 00:01:26 +0800209 u8 frame_rcvd[32];
James Bottomley2908d772006-08-29 09:22:51 -0500210
John Garryff525b62019-01-05 00:01:26 +0800211 union {
212 struct expander_device ex_dev;
213 struct sata_device sata_dev; /* STP & directly attached */
Dan Williams5db45bd2012-06-21 23:30:48 -0700214 struct ssp_device ssp_dev;
John Garryff525b62019-01-05 00:01:26 +0800215 };
James Bottomley2908d772006-08-29 09:22:51 -0500216
John Garryff525b62019-01-05 00:01:26 +0800217 void *lldd_dev;
Dan Williamse1399422012-01-07 08:52:39 +0000218 unsigned long state;
Dan Williams735f7d22011-11-17 17:59:47 -0800219 struct kref kref;
James Bottomley2908d772006-08-29 09:22:51 -0500220};
221
Dan Williams22b91532012-03-09 11:00:06 -0800222struct sas_work {
223 struct list_head drain_node;
David Howellsc4028952006-11-22 14:57:56 +0000224 struct work_struct work;
Dan Williams22b91532012-03-09 11:00:06 -0800225};
226
227static inline void INIT_SAS_WORK(struct sas_work *sw, void (*fn)(struct work_struct *))
228{
229 INIT_WORK(&sw->work, fn);
230 INIT_LIST_HEAD(&sw->drain_node);
231}
232
233struct sas_discovery_event {
234 struct sas_work work;
David Howellsc4028952006-11-22 14:57:56 +0000235 struct asd_sas_port *port;
236};
237
Dan Williams22b91532012-03-09 11:00:06 -0800238static inline struct sas_discovery_event *to_sas_discovery_event(struct work_struct *work)
239{
240 struct sas_discovery_event *ev = container_of(work, typeof(*ev), work.work);
241
242 return ev;
243}
244
James Bottomley2908d772006-08-29 09:22:51 -0500245struct sas_discovery {
David Howellsc4028952006-11-22 14:57:56 +0000246 struct sas_discovery_event disc_work[DISC_NUM_EVENTS];
James Bottomley2908d772006-08-29 09:22:51 -0500247 unsigned long pending;
248 u8 fanout_sas_addr[8];
249 u8 eeds_a[8];
250 u8 eeds_b[8];
251 int max_level;
252};
253
James Bottomley2908d772006-08-29 09:22:51 -0500254/* The port struct is Class:RW, driver:RO */
255struct asd_sas_port {
256/* private: */
James Bottomley2908d772006-08-29 09:22:51 -0500257 struct sas_discovery disc;
258 struct domain_device *port_dev;
259 spinlock_t dev_list_lock;
260 struct list_head dev_list;
Dan Williams87c83312011-11-17 17:59:51 -0800261 struct list_head disco_list;
262 struct list_head destroy_list;
Jason Yan0558f332017-12-08 17:42:09 +0800263 struct list_head sas_port_del_list;
James Bottomley88edf742006-09-06 17:36:13 -0500264 enum sas_linkrate linkrate;
James Bottomley2908d772006-08-29 09:22:51 -0500265
Dan Williams22b91532012-03-09 11:00:06 -0800266 struct sas_work work;
Dan Williams303694e2012-06-21 23:41:51 -0700267 int suspended;
James Bottomley2908d772006-08-29 09:22:51 -0500268
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];
Darrick J. Wong5929faf2007-11-05 11:51:17 -0800275 enum sas_protocol iproto;
276 enum sas_protocol tproto;
James Bottomley2908d772006-08-29 09:22:51 -0500277
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
David Howellsc4028952006-11-22 14:57:56 +0000292struct asd_sas_event {
Dan Williams22b91532012-03-09 11:00:06 -0800293 struct sas_work work;
David Howellsc4028952006-11-22 14:57:56 +0000294 struct asd_sas_phy *phy;
Jason Yan1c393b92017-12-08 17:42:04 +0800295 int event;
David Howellsc4028952006-11-22 14:57:56 +0000296};
297
Dan Williams22b91532012-03-09 11:00:06 -0800298static inline struct asd_sas_event *to_asd_sas_event(struct work_struct *work)
299{
300 struct asd_sas_event *ev = container_of(work, typeof(*ev), work.work);
301
302 return ev;
303}
304
Jason Yan1c393b92017-12-08 17:42:04 +0800305static inline void INIT_SAS_EVENT(struct asd_sas_event *ev,
306 void (*fn)(struct work_struct *),
307 struct asd_sas_phy *phy, int event)
308{
309 INIT_SAS_WORK(&ev->work, fn);
310 ev->phy = phy;
311 ev->event = event;
312}
313
Jason Yanf12486e2017-12-08 17:42:05 +0800314#define SAS_PHY_SHUTDOWN_THRES 1024
Jason Yan1c393b92017-12-08 17:42:04 +0800315
James Bottomley2908d772006-08-29 09:22:51 -0500316/* The phy pretty much is controlled by the LLDD.
317 * The class only reads those fields.
318 */
319struct asd_sas_phy {
320/* private: */
Jason Yanf12486e2017-12-08 17:42:05 +0800321 atomic_t event_nr;
322 int in_shutdown;
James Bottomley2908d772006-08-29 09:22:51 -0500323 int error;
Dan Williams303694e2012-06-21 23:41:51 -0700324 int suspended;
James Bottomley2908d772006-08-29 09:22:51 -0500325
326 struct sas_phy *phy;
327
328/* public: */
329 /* The following are class:RO, driver:R/W */
330 int enabled; /* must be set */
331
332 int id; /* must be set */
333 enum sas_class class;
Darrick J. Wong5929faf2007-11-05 11:51:17 -0800334 enum sas_protocol iproto;
335 enum sas_protocol tproto;
James Bottomley2908d772006-08-29 09:22:51 -0500336
337 enum sas_phy_type type;
338 enum sas_phy_role role;
339 enum sas_oob_mode oob_mode;
James Bottomley88edf742006-09-06 17:36:13 -0500340 enum sas_linkrate linkrate;
James Bottomley2908d772006-08-29 09:22:51 -0500341
342 u8 *sas_addr; /* must be set */
343 u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
344
345 spinlock_t frame_rcvd_lock;
346 u8 *frame_rcvd; /* must be set */
347 int frame_rcvd_size;
348
349 spinlock_t sas_prim_lock;
350 u32 sas_prim;
351
352 struct list_head port_phy_el; /* driver:RO */
353 struct asd_sas_port *port; /* Class:RW, driver: RO */
354
355 struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
356
357 void *lldd_phy; /* not touched by the sas_class_code */
358};
359
360struct scsi_core {
361 struct Scsi_Host *shost;
362
James Bottomley2908d772006-08-29 09:22:51 -0500363};
364
Darrick J. Wong6b0efb82007-01-11 14:15:43 -0800365enum sas_ha_state {
366 SAS_HA_REGISTERED,
Dan Williamsb1124cd2011-12-19 16:42:34 -0800367 SAS_HA_DRAINING,
Dan Williams87c83312011-11-17 17:59:51 -0800368 SAS_HA_ATA_EH_ACTIVE,
Dan Williams9095a642011-11-28 11:29:20 -0800369 SAS_HA_FROZEN,
Darrick J. Wong6b0efb82007-01-11 14:15:43 -0800370};
371
James Bottomley2908d772006-08-29 09:22:51 -0500372struct sas_ha_struct {
373/* private: */
Dan Williamsb1124cd2011-12-19 16:42:34 -0800374 struct list_head defer_q; /* work queued while draining */
375 struct mutex drain_mutex;
Dan Williamsf8daa6e2011-12-19 17:02:25 -0800376 unsigned long state;
Dan Williamse4a9c372012-06-21 23:25:27 -0700377 spinlock_t lock;
378 int eh_active;
Dan Williams5db45bd2012-06-21 23:30:48 -0700379 wait_queue_head_t eh_wait_q;
380 struct list_head eh_dev_q;
Darrick J. Wong6b0efb82007-01-11 14:15:43 -0800381
Dan Williams87c83312011-11-17 17:59:51 -0800382 struct mutex disco_mutex;
383
James Bottomley2908d772006-08-29 09:22:51 -0500384 struct scsi_core core;
385
386/* public: */
387 char *sas_ha_name;
Jeff Garzik1d1bbee2007-07-26 09:28:37 -0400388 struct device *dev; /* should be set */
James Bottomley2908d772006-08-29 09:22:51 -0500389 struct module *lldd_module; /* should be set */
390
Jason Yan93bdbd02017-12-08 17:42:07 +0800391 struct workqueue_struct *event_q;
392 struct workqueue_struct *disco_q;
393
James Bottomley2908d772006-08-29 09:22:51 -0500394 u8 *sas_addr; /* must be set */
395 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
396
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 */
401
Dan Williams00f02542010-10-01 13:55:52 -0700402 int strict_wide_ports; /* both sas_addr and attached_sas_addr must match
403 * their siblings when forming wide ports */
James Bottomley2908d772006-08-29 09:22:51 -0500404
405 /* LLDD calls these to notify the class of an event. */
Johannes Thumshirn6d311fa2017-06-14 13:52:43 +0200406 int (*notify_port_event)(struct asd_sas_phy *, enum port_event);
407 int (*notify_phy_event)(struct asd_sas_phy *, enum phy_event);
James Bottomley2908d772006-08-29 09:22:51 -0500408
409 void *lldd_ha; /* not touched by sas class code */
Darrick J. Wongf4563932006-10-30 15:18:39 -0800410
Dan Williams3944f502011-11-29 12:08:50 -0800411 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 */
Jason Yanf12486e2017-12-08 17:42:05 +0800413
414 int event_thres;
James Bottomley2908d772006-08-29 09:22:51 -0500415};
416
417#define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
418
419static inline struct domain_device *
420starget_to_domain_dev(struct scsi_target *starget) {
421 return starget->hostdata;
422}
423
424static inline struct domain_device *
425sdev_to_domain_dev(struct scsi_device *sdev) {
426 return starget_to_domain_dev(sdev->sdev_target);
427}
428
Dan Williamsb50102d2011-09-30 18:52:19 -0700429static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev)
430{
431 return &dev->sata_dev.ap->link.device[0];
432}
433
James Bottomley2908d772006-08-29 09:22:51 -0500434static inline struct domain_device *
435cmd_to_domain_dev(struct scsi_cmnd *cmd)
436{
437 return sdev_to_domain_dev(cmd->device);
438}
439
440void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
441
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).
446 */
447static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
448{
449 phy->oob_mode = OOB_NOT_CONNECTED;
James Bottomley88edf742006-09-06 17:36:13 -0500450 phy->linkrate = SAS_LINK_RATE_UNKNOWN;
James Bottomley2908d772006-08-29 09:22:51 -0500451}
452
Dan Williams8ec65522011-09-01 21:18:20 -0700453static inline unsigned int to_sas_gpio_od(int device, int bit)
454{
455 return 3 * device + bit;
456}
457
Dan Williamsf41a0c42011-12-21 21:33:17 -0800458static inline void sas_put_local_phy(struct sas_phy *phy)
459{
460 put_device(&phy->dev);
461}
462
Dan Williamsd9624802011-09-23 16:43:45 -0700463#ifdef CONFIG_SCSI_SAS_HOST_SMP
Dan Williams8ec65522011-09-01 21:18:20 -0700464int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count);
Dan Williamsd9624802011-09-23 16:43:45 -0700465#else
466static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count)
467{
468 return -1;
469}
470#endif
Dan Williams8ec65522011-09-01 21:18:20 -0700471
James Bottomley2908d772006-08-29 09:22:51 -0500472/* ---------- Tasks ---------- */
473/*
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 ---------------------+---------------------+-----------------------+
484 */
485
486enum service_response {
487 SAS_TASK_COMPLETE,
488 SAS_TASK_UNDELIVERED = -1,
489};
490
491enum exec_status {
Dan Williamsa3a14252011-12-06 23:24:42 -0800492 /* 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
494 */
495 __SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION,
James Bottomley2908d772006-08-29 09:22:51 -0500496
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,
511};
512
513/* When a task finishes with a response, the LLDD examines the
514 * response:
John Garryff525b62019-01-05 00:01:26 +0800515 * - For an ATA task task_status_struct::stat is set to
James Bottomley2908d772006-08-29 09:22:51 -0500516 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
517 * contents of struct ata_task_resp.
John Garryff525b62019-01-05 00:01:26 +0800518 * - For SSP tasks, if no data is present or status/TMF response
James Bottomley2908d772006-08-29 09:22:51 -0500519 * 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.
523 *
524 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
525 * for ATA task.
526 *
527 * "frame_len" is the total frame length, which could be more or less
528 * than actually copied.
529 *
530 * Tasks ending with response, always set the residual field.
531 */
532struct ata_task_resp {
533 u16 frame_len;
Dan Williams6ef1b512012-06-22 10:52:34 -0700534 u8 ending_fis[ATA_RESP_FIS_SIZE]; /* dev to host or data-in */
James Bottomley2908d772006-08-29 09:22:51 -0500535};
536
537#define SAS_STATUS_BUF_SIZE 96
538
539struct task_status_struct {
540 enum service_response resp;
541 enum exec_status stat;
542 int buf_valid_size;
543
544 u8 buf[SAS_STATUS_BUF_SIZE];
545
546 u32 residual;
547 enum sas_open_rej_reason open_rej_reason;
548};
549
550/* ATA and ATAPI task queuable to a SAS LLDD.
551 */
552struct sas_ata_task {
553 struct host_to_dev_fis fis;
554 u8 atapi_packet[16]; /* 0 if not ATAPI task */
555
556 u8 retry_count; /* hardware retry, should be > 0 */
557
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;
562
563 u8 device_control_reg_update:1;
564};
565
566struct sas_smp_task {
567 struct scatterlist smp_req;
568 struct scatterlist smp_resp;
569};
570
571enum task_attribute {
572 TASK_ATTR_SIMPLE = 0,
573 TASK_ATTR_HOQ = 1,
574 TASK_ATTR_ORDERED= 2,
575 TASK_ATTR_ACA = 4,
576};
577
578struct sas_ssp_task {
579 u8 retry_count; /* hardware retry, should be > 0 */
580
581 u8 LUN[8];
582 u8 enable_first_burst:1;
583 enum task_attribute task_attr;
584 u8 task_prio;
James Bottomleye73823f72013-05-07 15:38:18 -0700585 struct scsi_cmnd *cmd;
James Bottomley2908d772006-08-29 09:22:51 -0500586};
587
588struct sas_task {
589 struct domain_device *dev;
James Bottomley2908d772006-08-29 09:22:51 -0500590
591 spinlock_t task_state_lock;
592 unsigned task_state_flags;
593
Darrick J. Wong5929faf2007-11-05 11:51:17 -0800594 enum sas_protocol task_proto;
James Bottomley2908d772006-08-29 09:22:51 -0500595
James Bottomley2908d772006-08-29 09:22:51 -0500596 union {
597 struct sas_ata_task ata_task;
598 struct sas_smp_task smp_task;
599 struct sas_ssp_task ssp_task;
600 };
601
602 struct scatterlist *scatter;
603 int num_scatter;
604 u32 total_xfer_len;
605 u8 data_dir:2; /* Use PCI_DMA_... */
606
607 struct task_status_struct task_status;
608 void (*task_done)(struct sas_task *);
609
610 void *lldd_task; /* for use by LLDDs */
611 void *uldd_task;
Dan Williamsf0bf7502012-06-21 23:36:30 -0700612 struct sas_task_slow *slow_task;
613};
Darrick J. Wong79a5eb62006-10-30 15:18:50 -0800614
Dan Williamsf0bf7502012-06-21 23:36:30 -0700615struct sas_task_slow {
616 /* standard/extra infrastructure for slow path commands (SMP and
617 * internal lldd commands
618 */
619 struct timer_list timer;
620 struct completion completion;
Kees Cook77570ee2017-08-22 16:05:14 -0700621 struct sas_task *task;
James Bottomley2908d772006-08-29 09:22:51 -0500622};
623
Darrick J. Wongf4563932006-10-30 15:18:39 -0800624#define SAS_TASK_STATE_PENDING 1
625#define SAS_TASK_STATE_DONE 2
626#define SAS_TASK_STATE_ABORTED 4
Darrick J. Wong3ebf6922007-01-11 14:15:17 -0800627#define SAS_TASK_NEED_DEV_RESET 8
Darrick J. Wongb218a0d2007-01-11 14:14:55 -0800628#define SAS_TASK_AT_INITIATOR 16
James Bottomley2908d772006-08-29 09:22:51 -0500629
Dan Williams4fcf8122011-07-29 17:26:39 -0700630extern struct sas_task *sas_alloc_task(gfp_t flags);
Dan Williamsf0bf7502012-06-21 23:36:30 -0700631extern struct sas_task *sas_alloc_slow_task(gfp_t flags);
Dan Williams4fcf8122011-07-29 17:26:39 -0700632extern void sas_free_task(struct sas_task *task);
James Bottomley2908d772006-08-29 09:22:51 -0500633
634struct 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 *);
638
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 *);
642
Christoph Hellwig79855d12014-11-05 10:36:28 +0100643 int (*lldd_execute_task)(struct sas_task *, gfp_t gfp_flags);
James Bottomley2908d772006-08-29 09:22:51 -0500644
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 *);
Dan Williams36a39942011-11-17 17:59:54 -0800651 int (*lldd_ata_check_ready)(struct domain_device *);
Dan Williamsb91bb292011-11-17 17:59:52 -0800652 void (*lldd_ata_set_dmamode)(struct domain_device *);
James Bottomley2908d772006-08-29 09:22:51 -0500653 int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
654 int (*lldd_query_task)(struct sas_task *);
655
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 *);
659
660 /* Phy management */
James Bottomleya01e70e2006-09-06 19:28:07 -0500661 int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
Dan Williams8ec65522011-09-01 21:18:20 -0700662
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);
James Bottomley2908d772006-08-29 09:22:51 -0500666};
667
668extern int sas_register_ha(struct sas_ha_struct *);
669extern int sas_unregister_ha(struct sas_ha_struct *);
Dan Williams303694e2012-06-21 23:41:51 -0700670extern void sas_prep_resume_ha(struct sas_ha_struct *sas_ha);
671extern void sas_resume_ha(struct sas_ha_struct *sas_ha);
672extern void sas_suspend_ha(struct sas_ha_struct *sas_ha);
James Bottomley2908d772006-08-29 09:22:51 -0500673
John Garryff525b62019-01-05 00:01:26 +0800674int sas_set_phy_speed(struct sas_phy *phy, struct sas_phy_linkrates *rates);
Darrick J. Wongdea22212006-11-07 17:28:55 -0800675int sas_phy_reset(struct sas_phy *phy, int hard_reset);
John Garryff525b62019-01-05 00:01:26 +0800676extern int sas_queuecommand(struct Scsi_Host *, struct scsi_cmnd *);
James Bottomley2908d772006-08-29 09:22:51 -0500677extern int sas_target_alloc(struct scsi_target *);
James Bottomley2908d772006-08-29 09:22:51 -0500678extern int sas_slave_configure(struct scsi_device *);
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100679extern int sas_change_queue_depth(struct scsi_device *, int new_depth);
John Garryff525b62019-01-05 00:01:26 +0800680extern int sas_bios_param(struct scsi_device *, struct block_device *,
James Bottomley2908d772006-08-29 09:22:51 -0500681 sector_t capacity, int *hsc);
682extern struct scsi_transport_template *
683sas_domain_attach_transport(struct sas_domain_function_template *);
Jason Yan8eea9dd2017-12-08 17:42:06 +0800684extern struct device_attribute dev_attr_phy_event_threshold;
James Bottomley2908d772006-08-29 09:22:51 -0500685
686int sas_discover_root_expander(struct domain_device *);
687
688void sas_init_ex_attr(void);
689
690int sas_ex_revalidate_domain(struct domain_device *);
691
Dan Williams7d059192012-01-10 14:39:13 -0800692void sas_unregister_domain_devices(struct asd_sas_port *port, int gone);
James Bottomley2908d772006-08-29 09:22:51 -0500693void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
694int sas_discover_event(struct asd_sas_port *, enum discover_event ev);
695
696int sas_discover_sata(struct domain_device *);
697int sas_discover_end_dev(struct domain_device *);
698
Dan Williams1a34c062011-09-21 22:05:34 -0700699void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
James Bottomley2908d772006-08-29 09:22:51 -0500700
701void sas_init_dev(struct domain_device *);
702
Darrick J. Wong396819f2007-01-11 14:15:20 -0800703void sas_task_abort(struct sas_task *);
Dan Williams9524c682012-06-21 23:30:53 -0700704int sas_eh_abort_handler(struct scsi_cmnd *cmd);
Darrick J. Wongad689232007-01-26 14:08:52 -0800705int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
Hannes Reineckecc199e72017-08-25 13:57:02 +0200706int sas_eh_target_reset_handler(struct scsi_cmnd *cmd);
Darrick J. Wong79a5eb62006-10-30 15:18:50 -0800707
Darrick J. Wongfa1c1e82006-08-10 19:19:47 -0700708extern void sas_target_destroy(struct scsi_target *);
709extern int sas_slave_alloc(struct scsi_device *);
Nathan Chancellor6f4e6262019-02-07 09:07:20 -0700710extern int sas_ioctl(struct scsi_device *sdev, unsigned int cmd,
711 void __user *arg);
Dan Williamsb1124cd2011-12-19 16:42:34 -0800712extern int sas_drain_work(struct sas_ha_struct *ha);
Darrick J. Wongfa1c1e82006-08-10 19:19:47 -0700713
James Bottomley366ca512008-01-18 10:47:01 -0600714extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
715 struct ssp_response_iu *iu);
Dan Williamsf41a0c42011-12-21 21:33:17 -0800716struct sas_phy *sas_get_local_phy(struct domain_device *dev);
James Bottomley366ca512008-01-18 10:47:01 -0600717
Darrick J. Wong45e6cdf2008-02-19 10:49:40 -0800718int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
719
James Bottomley2908d772006-08-29 09:22:51 -0500720#endif /* _SASLIB_H_ */