James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 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> |
Darrick J. Wong | fa1c1e8 | 2006-08-10 19:19:47 -0700 | [diff] [blame] | 33 | #include <linux/libata.h> |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 34 | #include <linux/list.h> |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 35 | #include <scsi/scsi_device.h> |
| 36 | #include <scsi/scsi_cmnd.h> |
| 37 | #include <scsi/scsi_transport_sas.h> |
Adrian Bunk | 87ae9af | 2007-10-30 10:35:04 +0100 | [diff] [blame] | 38 | #include <linux/scatterlist.h> |
Tejun Heo | 5a0e3ad | 2010-03-24 17:04:11 +0900 | [diff] [blame] | 39 | #include <linux/slab.h> |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 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 ha_event { |
| 64 | HAE_RESET = 0U, |
| 65 | HA_NUM_EVENTS = 1, |
| 66 | }; |
| 67 | |
| 68 | enum port_event { |
| 69 | PORTE_BYTES_DMAED = 0U, |
| 70 | PORTE_BROADCAST_RCVD = 1, |
| 71 | PORTE_LINK_RESET_ERR = 2, |
| 72 | PORTE_TIMER_EVENT = 3, |
| 73 | PORTE_HARD_RESET = 4, |
| 74 | PORT_NUM_EVENTS = 5, |
| 75 | }; |
| 76 | |
| 77 | enum phy_event { |
| 78 | PHYE_LOSS_OF_SIGNAL = 0U, |
| 79 | PHYE_OOB_DONE = 1, |
| 80 | PHYE_OOB_ERROR = 2, |
| 81 | PHYE_SPINUP_HOLD = 3, /* hot plug SATA, no COMWAKE sent */ |
| 82 | PHY_NUM_EVENTS = 4, |
| 83 | }; |
| 84 | |
| 85 | enum discover_event { |
| 86 | DISCE_DISCOVER_DOMAIN = 0U, |
| 87 | DISCE_REVALIDATE_DOMAIN = 1, |
| 88 | DISCE_PORT_GONE = 2, |
Dan Williams | 87c8331 | 2011-11-17 17:59:51 -0800 | [diff] [blame] | 89 | DISCE_PROBE = 3, |
| 90 | DISCE_DESTRUCT = 4, |
| 91 | DISC_NUM_EVENTS = 5, |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 92 | }; |
| 93 | |
| 94 | /* ---------- Expander Devices ---------- */ |
| 95 | |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 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,\ |
| 98 | attr) |
| 99 | |
| 100 | enum routing_attribute { |
| 101 | DIRECT_ROUTING, |
| 102 | SUBTRACTIVE_ROUTING, |
| 103 | TABLE_ROUTING, |
| 104 | }; |
| 105 | |
| 106 | enum ex_phy_state { |
| 107 | PHY_EMPTY, |
| 108 | PHY_VACANT, |
| 109 | PHY_NOT_PRESENT, |
| 110 | PHY_DEVICE_DISCOVERED |
| 111 | }; |
| 112 | |
| 113 | struct ex_phy { |
| 114 | int phy_id; |
| 115 | |
| 116 | enum ex_phy_state phy_state; |
| 117 | |
| 118 | enum sas_dev_type attached_dev_type; |
James Bottomley | 88edf74 | 2006-09-06 17:36:13 -0500 | [diff] [blame] | 119 | enum sas_linkrate linkrate; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 120 | |
| 121 | u8 attached_sata_host:1; |
| 122 | u8 attached_sata_dev:1; |
| 123 | u8 attached_sata_ps:1; |
| 124 | |
Darrick J. Wong | 5929faf | 2007-11-05 11:51:17 -0800 | [diff] [blame] | 125 | enum sas_protocol attached_tproto; |
| 126 | enum sas_protocol attached_iproto; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 127 | |
| 128 | u8 attached_sas_addr[SAS_ADDR_SIZE]; |
| 129 | u8 attached_phy_id; |
| 130 | |
| 131 | u8 phy_change_count; |
| 132 | enum routing_attribute routing_attr; |
| 133 | u8 virtual:1; |
| 134 | |
| 135 | int last_da_index; |
| 136 | |
| 137 | struct sas_phy *phy; |
| 138 | struct sas_port *port; |
| 139 | }; |
| 140 | |
| 141 | struct expander_device { |
| 142 | struct list_head children; |
| 143 | |
| 144 | u16 ex_change_count; |
| 145 | u16 max_route_indexes; |
| 146 | u8 num_phys; |
Luben Tuikov | ffaac8f | 2011-09-22 09:41:36 -0700 | [diff] [blame] | 147 | |
| 148 | u8 t2t_supp:1; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 149 | u8 configuring:1; |
| 150 | u8 conf_route_table:1; |
Luben Tuikov | ffaac8f | 2011-09-22 09:41:36 -0700 | [diff] [blame] | 151 | |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 152 | u8 enclosure_logical_id[8]; |
| 153 | |
| 154 | struct ex_phy *ex_phy; |
| 155 | struct sas_port *parent_port; |
Jeff Skirvin | 89d3cf6 | 2011-11-16 09:44:13 +0000 | [diff] [blame] | 156 | |
| 157 | struct mutex cmd_mutex; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 158 | }; |
| 159 | |
| 160 | /* ---------- SATA device ---------- */ |
| 161 | enum ata_command_set { |
| 162 | ATA_COMMAND_SET = 0, |
| 163 | ATAPI_COMMAND_SET = 1, |
| 164 | }; |
| 165 | |
| 166 | struct sata_device { |
| 167 | enum ata_command_set command_set; |
| 168 | struct smp_resp rps_resp; /* report_phy_sata_resp */ |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 169 | u8 port_no; /* port number, if this is a PM (Port) */ |
| 170 | struct list_head children; /* PM Ports if this is a PM */ |
Darrick J. Wong | fa1c1e8 | 2006-08-10 19:19:47 -0700 | [diff] [blame] | 171 | |
| 172 | struct ata_port *ap; |
| 173 | struct ata_host ata_host; |
| 174 | struct ata_taskfile tf; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 175 | }; |
| 176 | |
Dan Williams | e139942 | 2012-01-07 08:52:39 +0000 | [diff] [blame] | 177 | enum { |
| 178 | SAS_DEV_GONE, |
Dan Williams | 87c8331 | 2011-11-17 17:59:51 -0800 | [diff] [blame] | 179 | SAS_DEV_DESTROY, |
Dan Williams | e139942 | 2012-01-07 08:52:39 +0000 | [diff] [blame] | 180 | }; |
| 181 | |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 182 | struct domain_device { |
Dan Williams | 9095a64 | 2011-11-28 11:29:20 -0800 | [diff] [blame] | 183 | spinlock_t done_lock; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 184 | enum sas_dev_type dev_type; |
| 185 | |
James Bottomley | 88edf74 | 2006-09-06 17:36:13 -0500 | [diff] [blame] | 186 | enum sas_linkrate linkrate; |
| 187 | enum sas_linkrate min_linkrate; |
| 188 | enum sas_linkrate max_linkrate; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 189 | |
| 190 | int pathways; |
| 191 | |
| 192 | struct domain_device *parent; |
| 193 | struct list_head siblings; /* devices on the same level */ |
| 194 | struct asd_sas_port *port; /* shortcut to root of the tree */ |
Dan Williams | f41a0c4 | 2011-12-21 21:33:17 -0800 | [diff] [blame] | 195 | struct sas_phy *phy; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 196 | |
| 197 | struct list_head dev_list_node; |
Dan Williams | 87c8331 | 2011-11-17 17:59:51 -0800 | [diff] [blame] | 198 | struct list_head disco_list_node; /* awaiting probe or destruct */ |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 199 | |
Darrick J. Wong | 5929faf | 2007-11-05 11:51:17 -0800 | [diff] [blame] | 200 | enum sas_protocol iproto; |
| 201 | enum sas_protocol tproto; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 202 | |
| 203 | struct sas_rphy *rphy; |
| 204 | |
| 205 | u8 sas_addr[SAS_ADDR_SIZE]; |
| 206 | u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE]; |
| 207 | |
| 208 | u8 frame_rcvd[32]; |
| 209 | |
| 210 | union { |
| 211 | struct expander_device ex_dev; |
| 212 | struct sata_device sata_dev; /* STP & directly attached */ |
| 213 | }; |
| 214 | |
| 215 | void *lldd_dev; |
Dan Williams | e139942 | 2012-01-07 08:52:39 +0000 | [diff] [blame] | 216 | unsigned long state; |
Dan Williams | 735f7d2 | 2011-11-17 17:59:47 -0800 | [diff] [blame] | 217 | struct kref kref; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 218 | }; |
| 219 | |
Dan Williams | 22b9153 | 2012-03-09 11:00:06 -0800 | [diff] [blame^] | 220 | struct sas_work { |
| 221 | struct list_head drain_node; |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 222 | struct work_struct work; |
Dan Williams | 22b9153 | 2012-03-09 11:00:06 -0800 | [diff] [blame^] | 223 | }; |
| 224 | |
| 225 | static inline void INIT_SAS_WORK(struct sas_work *sw, void (*fn)(struct work_struct *)) |
| 226 | { |
| 227 | INIT_WORK(&sw->work, fn); |
| 228 | INIT_LIST_HEAD(&sw->drain_node); |
| 229 | } |
| 230 | |
| 231 | struct sas_discovery_event { |
| 232 | struct sas_work work; |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 233 | struct asd_sas_port *port; |
| 234 | }; |
| 235 | |
Dan Williams | 22b9153 | 2012-03-09 11:00:06 -0800 | [diff] [blame^] | 236 | static inline struct sas_discovery_event *to_sas_discovery_event(struct work_struct *work) |
| 237 | { |
| 238 | struct sas_discovery_event *ev = container_of(work, typeof(*ev), work.work); |
| 239 | |
| 240 | return ev; |
| 241 | } |
| 242 | |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 243 | struct sas_discovery { |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 244 | struct sas_discovery_event disc_work[DISC_NUM_EVENTS]; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 245 | unsigned long pending; |
| 246 | u8 fanout_sas_addr[8]; |
| 247 | u8 eeds_a[8]; |
| 248 | u8 eeds_b[8]; |
| 249 | int max_level; |
| 250 | }; |
| 251 | |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 252 | /* The port struct is Class:RW, driver:RO */ |
| 253 | struct asd_sas_port { |
| 254 | /* private: */ |
| 255 | struct completion port_gone_completion; |
| 256 | |
| 257 | struct sas_discovery disc; |
| 258 | struct domain_device *port_dev; |
| 259 | spinlock_t dev_list_lock; |
| 260 | struct list_head dev_list; |
Dan Williams | 87c8331 | 2011-11-17 17:59:51 -0800 | [diff] [blame] | 261 | struct list_head disco_list; |
| 262 | struct list_head destroy_list; |
James Bottomley | 88edf74 | 2006-09-06 17:36:13 -0500 | [diff] [blame] | 263 | enum sas_linkrate linkrate; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 264 | |
Dan Williams | 22b9153 | 2012-03-09 11:00:06 -0800 | [diff] [blame^] | 265 | struct sas_work work; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 266 | |
| 267 | /* public: */ |
| 268 | int id; |
| 269 | |
| 270 | enum sas_class class; |
| 271 | u8 sas_addr[SAS_ADDR_SIZE]; |
| 272 | u8 attached_sas_addr[SAS_ADDR_SIZE]; |
Darrick J. Wong | 5929faf | 2007-11-05 11:51:17 -0800 | [diff] [blame] | 273 | enum sas_protocol iproto; |
| 274 | enum sas_protocol tproto; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 275 | |
| 276 | enum sas_oob_mode oob_mode; |
| 277 | |
| 278 | spinlock_t phy_list_lock; |
| 279 | struct list_head phy_list; |
| 280 | int num_phys; |
| 281 | u32 phy_mask; |
| 282 | |
| 283 | struct sas_ha_struct *ha; |
| 284 | |
| 285 | struct sas_port *port; |
| 286 | |
| 287 | void *lldd_port; /* not touched by the sas class code */ |
| 288 | }; |
| 289 | |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 290 | struct asd_sas_event { |
Dan Williams | 22b9153 | 2012-03-09 11:00:06 -0800 | [diff] [blame^] | 291 | struct sas_work work; |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 292 | struct asd_sas_phy *phy; |
| 293 | }; |
| 294 | |
Dan Williams | 22b9153 | 2012-03-09 11:00:06 -0800 | [diff] [blame^] | 295 | static inline struct asd_sas_event *to_asd_sas_event(struct work_struct *work) |
| 296 | { |
| 297 | struct asd_sas_event *ev = container_of(work, typeof(*ev), work.work); |
| 298 | |
| 299 | return ev; |
| 300 | } |
| 301 | |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 302 | /* The phy pretty much is controlled by the LLDD. |
| 303 | * The class only reads those fields. |
| 304 | */ |
| 305 | struct asd_sas_phy { |
| 306 | /* private: */ |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 307 | struct asd_sas_event port_events[PORT_NUM_EVENTS]; |
| 308 | struct asd_sas_event phy_events[PHY_NUM_EVENTS]; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 309 | |
| 310 | unsigned long port_events_pending; |
| 311 | unsigned long phy_events_pending; |
| 312 | |
| 313 | int error; |
| 314 | |
| 315 | struct sas_phy *phy; |
| 316 | |
| 317 | /* public: */ |
| 318 | /* The following are class:RO, driver:R/W */ |
| 319 | int enabled; /* must be set */ |
| 320 | |
| 321 | int id; /* must be set */ |
| 322 | enum sas_class class; |
Darrick J. Wong | 5929faf | 2007-11-05 11:51:17 -0800 | [diff] [blame] | 323 | enum sas_protocol iproto; |
| 324 | enum sas_protocol tproto; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 325 | |
| 326 | enum sas_phy_type type; |
| 327 | enum sas_phy_role role; |
| 328 | enum sas_oob_mode oob_mode; |
James Bottomley | 88edf74 | 2006-09-06 17:36:13 -0500 | [diff] [blame] | 329 | enum sas_linkrate linkrate; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 330 | |
| 331 | u8 *sas_addr; /* must be set */ |
| 332 | u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */ |
| 333 | |
| 334 | spinlock_t frame_rcvd_lock; |
| 335 | u8 *frame_rcvd; /* must be set */ |
| 336 | int frame_rcvd_size; |
| 337 | |
| 338 | spinlock_t sas_prim_lock; |
| 339 | u32 sas_prim; |
| 340 | |
| 341 | struct list_head port_phy_el; /* driver:RO */ |
| 342 | struct asd_sas_port *port; /* Class:RW, driver: RO */ |
| 343 | |
| 344 | struct sas_ha_struct *ha; /* may be set; the class sets it anyway */ |
| 345 | |
| 346 | void *lldd_phy; /* not touched by the sas_class_code */ |
| 347 | }; |
| 348 | |
| 349 | struct scsi_core { |
| 350 | struct Scsi_Host *shost; |
| 351 | |
Dan Williams | 9095a64 | 2011-11-28 11:29:20 -0800 | [diff] [blame] | 352 | struct mutex task_queue_flush; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 353 | spinlock_t task_queue_lock; |
| 354 | struct list_head task_queue; |
| 355 | int task_queue_size; |
| 356 | |
Christoph Hellwig | d7a54e3 | 2007-04-26 09:38:01 -0400 | [diff] [blame] | 357 | struct task_struct *queue_thread; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 358 | }; |
| 359 | |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 360 | struct sas_ha_event { |
Dan Williams | 22b9153 | 2012-03-09 11:00:06 -0800 | [diff] [blame^] | 361 | struct sas_work work; |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 362 | struct sas_ha_struct *ha; |
| 363 | }; |
| 364 | |
Dan Williams | 22b9153 | 2012-03-09 11:00:06 -0800 | [diff] [blame^] | 365 | static inline struct sas_ha_event *to_sas_ha_event(struct work_struct *work) |
| 366 | { |
| 367 | struct sas_ha_event *ev = container_of(work, typeof(*ev), work.work); |
| 368 | |
| 369 | return ev; |
| 370 | } |
| 371 | |
Darrick J. Wong | 6b0efb8 | 2007-01-11 14:15:43 -0800 | [diff] [blame] | 372 | enum sas_ha_state { |
| 373 | SAS_HA_REGISTERED, |
Dan Williams | b1124cd | 2011-12-19 16:42:34 -0800 | [diff] [blame] | 374 | SAS_HA_DRAINING, |
Dan Williams | 87c8331 | 2011-11-17 17:59:51 -0800 | [diff] [blame] | 375 | SAS_HA_ATA_EH_ACTIVE, |
Dan Williams | 9095a64 | 2011-11-28 11:29:20 -0800 | [diff] [blame] | 376 | SAS_HA_FROZEN, |
Darrick J. Wong | 6b0efb8 | 2007-01-11 14:15:43 -0800 | [diff] [blame] | 377 | }; |
| 378 | |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 379 | struct sas_ha_struct { |
| 380 | /* private: */ |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 381 | struct sas_ha_event ha_events[HA_NUM_EVENTS]; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 382 | unsigned long pending; |
| 383 | |
Dan Williams | b1124cd | 2011-12-19 16:42:34 -0800 | [diff] [blame] | 384 | struct list_head defer_q; /* work queued while draining */ |
| 385 | struct mutex drain_mutex; |
Dan Williams | f8daa6e | 2011-12-19 17:02:25 -0800 | [diff] [blame] | 386 | unsigned long state; |
Darrick J. Wong | 6b0efb8 | 2007-01-11 14:15:43 -0800 | [diff] [blame] | 387 | spinlock_t state_lock; |
| 388 | |
Dan Williams | 87c8331 | 2011-11-17 17:59:51 -0800 | [diff] [blame] | 389 | struct mutex disco_mutex; |
| 390 | |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 391 | struct scsi_core core; |
| 392 | |
| 393 | /* public: */ |
| 394 | char *sas_ha_name; |
Jeff Garzik | 1d1bbee | 2007-07-26 09:28:37 -0400 | [diff] [blame] | 395 | struct device *dev; /* should be set */ |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 396 | struct module *lldd_module; /* should be set */ |
| 397 | |
| 398 | u8 *sas_addr; /* must be set */ |
| 399 | u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE]; |
| 400 | |
| 401 | spinlock_t phy_port_lock; |
| 402 | struct asd_sas_phy **sas_phy; /* array of valid pointers, must be set */ |
| 403 | struct asd_sas_port **sas_port; /* array of valid pointers, must be set */ |
| 404 | int num_phys; /* must be set, gt 0, static */ |
| 405 | |
| 406 | /* The class calls this to send a task for execution. */ |
| 407 | int lldd_max_execute_num; |
| 408 | int lldd_queue_size; |
Dan Williams | 00f0254 | 2010-10-01 13:55:52 -0700 | [diff] [blame] | 409 | int strict_wide_ports; /* both sas_addr and attached_sas_addr must match |
| 410 | * their siblings when forming wide ports */ |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 411 | |
| 412 | /* LLDD calls these to notify the class of an event. */ |
| 413 | void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event); |
| 414 | void (*notify_port_event)(struct asd_sas_phy *, enum port_event); |
| 415 | void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event); |
| 416 | |
| 417 | void *lldd_ha; /* not touched by sas class code */ |
Darrick J. Wong | f456393 | 2006-10-30 15:18:39 -0800 | [diff] [blame] | 418 | |
Dan Williams | 3944f50 | 2011-11-29 12:08:50 -0800 | [diff] [blame] | 419 | struct list_head eh_done_q; /* complete via scsi_eh_flush_done_q */ |
| 420 | struct list_head eh_ata_q; /* scmds to promote from sas to ata eh */ |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 421 | }; |
| 422 | |
| 423 | #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata) |
| 424 | |
| 425 | static inline struct domain_device * |
| 426 | starget_to_domain_dev(struct scsi_target *starget) { |
| 427 | return starget->hostdata; |
| 428 | } |
| 429 | |
| 430 | static inline struct domain_device * |
| 431 | sdev_to_domain_dev(struct scsi_device *sdev) { |
| 432 | return starget_to_domain_dev(sdev->sdev_target); |
| 433 | } |
| 434 | |
Dan Williams | b50102d | 2011-09-30 18:52:19 -0700 | [diff] [blame] | 435 | static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev) |
| 436 | { |
| 437 | return &dev->sata_dev.ap->link.device[0]; |
| 438 | } |
| 439 | |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 440 | static inline struct domain_device * |
| 441 | cmd_to_domain_dev(struct scsi_cmnd *cmd) |
| 442 | { |
| 443 | return sdev_to_domain_dev(cmd->device); |
| 444 | } |
| 445 | |
| 446 | void sas_hash_addr(u8 *hashed, const u8 *sas_addr); |
| 447 | |
| 448 | /* Before calling a notify event, LLDD should use this function |
| 449 | * when the link is severed (possibly from its tasklet). |
| 450 | * The idea is that the Class only reads those, while the LLDD, |
| 451 | * can R/W these (thus avoiding a race). |
| 452 | */ |
| 453 | static inline void sas_phy_disconnected(struct asd_sas_phy *phy) |
| 454 | { |
| 455 | phy->oob_mode = OOB_NOT_CONNECTED; |
James Bottomley | 88edf74 | 2006-09-06 17:36:13 -0500 | [diff] [blame] | 456 | phy->linkrate = SAS_LINK_RATE_UNKNOWN; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 457 | } |
| 458 | |
Dan Williams | 8ec6552 | 2011-09-01 21:18:20 -0700 | [diff] [blame] | 459 | static inline unsigned int to_sas_gpio_od(int device, int bit) |
| 460 | { |
| 461 | return 3 * device + bit; |
| 462 | } |
| 463 | |
Dan Williams | f41a0c4 | 2011-12-21 21:33:17 -0800 | [diff] [blame] | 464 | static inline void sas_put_local_phy(struct sas_phy *phy) |
| 465 | { |
| 466 | put_device(&phy->dev); |
| 467 | } |
| 468 | |
Dan Williams | d962480 | 2011-09-23 16:43:45 -0700 | [diff] [blame] | 469 | #ifdef CONFIG_SCSI_SAS_HOST_SMP |
Dan Williams | 8ec6552 | 2011-09-01 21:18:20 -0700 | [diff] [blame] | 470 | int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count); |
Dan Williams | d962480 | 2011-09-23 16:43:45 -0700 | [diff] [blame] | 471 | #else |
| 472 | static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count) |
| 473 | { |
| 474 | return -1; |
| 475 | } |
| 476 | #endif |
Dan Williams | 8ec6552 | 2011-09-01 21:18:20 -0700 | [diff] [blame] | 477 | |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 478 | /* ---------- Tasks ---------- */ |
| 479 | /* |
| 480 | service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED | |
| 481 | exec_status | | | |
| 482 | ---------------------+---------------------+-----------------------+ |
| 483 | SAM_... | X | | |
| 484 | DEV_NO_RESPONSE | X | X | |
| 485 | INTERRUPTED | X | | |
| 486 | QUEUE_FULL | | X | |
| 487 | DEVICE_UNKNOWN | | X | |
| 488 | SG_ERR | | X | |
| 489 | ---------------------+---------------------+-----------------------+ |
| 490 | */ |
| 491 | |
| 492 | enum service_response { |
| 493 | SAS_TASK_COMPLETE, |
| 494 | SAS_TASK_UNDELIVERED = -1, |
| 495 | }; |
| 496 | |
| 497 | enum exec_status { |
Dan Williams | a3a1425 | 2011-12-06 23:24:42 -0800 | [diff] [blame] | 498 | /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of |
| 499 | * them here to silence 'case value not in enumerated type' warnings |
| 500 | */ |
| 501 | __SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION, |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 502 | |
| 503 | SAS_DEV_NO_RESPONSE = 0x80, |
| 504 | SAS_DATA_UNDERRUN, |
| 505 | SAS_DATA_OVERRUN, |
| 506 | SAS_INTERRUPTED, |
| 507 | SAS_QUEUE_FULL, |
| 508 | SAS_DEVICE_UNKNOWN, |
| 509 | SAS_SG_ERR, |
| 510 | SAS_OPEN_REJECT, |
| 511 | SAS_OPEN_TO, |
| 512 | SAS_PROTO_RESPONSE, |
| 513 | SAS_PHY_DOWN, |
| 514 | SAS_NAK_R_ERR, |
| 515 | SAS_PENDING, |
| 516 | SAS_ABORTED_TASK, |
| 517 | }; |
| 518 | |
| 519 | /* When a task finishes with a response, the LLDD examines the |
| 520 | * response: |
| 521 | * - For an ATA task task_status_struct::stat is set to |
| 522 | * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the |
| 523 | * contents of struct ata_task_resp. |
| 524 | * - For SSP tasks, if no data is present or status/TMF response |
| 525 | * is valid, task_status_struct::stat is set. If data is present |
| 526 | * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets |
| 527 | * task_status_struct::buf_valid_size, and task_status_struct::stat is |
| 528 | * set to SAM_CHECK_COND. |
| 529 | * |
| 530 | * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp |
| 531 | * for ATA task. |
| 532 | * |
| 533 | * "frame_len" is the total frame length, which could be more or less |
| 534 | * than actually copied. |
| 535 | * |
| 536 | * Tasks ending with response, always set the residual field. |
| 537 | */ |
| 538 | struct ata_task_resp { |
| 539 | u16 frame_len; |
| 540 | u8 ending_fis[24]; /* dev to host or data-in */ |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 541 | }; |
| 542 | |
| 543 | #define SAS_STATUS_BUF_SIZE 96 |
| 544 | |
| 545 | struct task_status_struct { |
| 546 | enum service_response resp; |
| 547 | enum exec_status stat; |
| 548 | int buf_valid_size; |
| 549 | |
| 550 | u8 buf[SAS_STATUS_BUF_SIZE]; |
| 551 | |
| 552 | u32 residual; |
| 553 | enum sas_open_rej_reason open_rej_reason; |
| 554 | }; |
| 555 | |
| 556 | /* ATA and ATAPI task queuable to a SAS LLDD. |
| 557 | */ |
| 558 | struct sas_ata_task { |
| 559 | struct host_to_dev_fis fis; |
| 560 | u8 atapi_packet[16]; /* 0 if not ATAPI task */ |
| 561 | |
| 562 | u8 retry_count; /* hardware retry, should be > 0 */ |
| 563 | |
| 564 | u8 dma_xfer:1; /* PIO:0 or DMA:1 */ |
| 565 | u8 use_ncq:1; |
| 566 | u8 set_affil_pol:1; |
| 567 | u8 stp_affil_pol:1; |
| 568 | |
| 569 | u8 device_control_reg_update:1; |
| 570 | }; |
| 571 | |
| 572 | struct sas_smp_task { |
| 573 | struct scatterlist smp_req; |
| 574 | struct scatterlist smp_resp; |
| 575 | }; |
| 576 | |
| 577 | enum task_attribute { |
| 578 | TASK_ATTR_SIMPLE = 0, |
| 579 | TASK_ATTR_HOQ = 1, |
| 580 | TASK_ATTR_ORDERED= 2, |
| 581 | TASK_ATTR_ACA = 4, |
| 582 | }; |
| 583 | |
| 584 | struct sas_ssp_task { |
| 585 | u8 retry_count; /* hardware retry, should be > 0 */ |
| 586 | |
| 587 | u8 LUN[8]; |
| 588 | u8 enable_first_burst:1; |
| 589 | enum task_attribute task_attr; |
| 590 | u8 task_prio; |
| 591 | u8 cdb[16]; |
| 592 | }; |
| 593 | |
| 594 | struct sas_task { |
| 595 | struct domain_device *dev; |
| 596 | struct list_head list; |
| 597 | |
| 598 | spinlock_t task_state_lock; |
| 599 | unsigned task_state_flags; |
| 600 | |
Darrick J. Wong | 5929faf | 2007-11-05 11:51:17 -0800 | [diff] [blame] | 601 | enum sas_protocol task_proto; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 602 | |
| 603 | /* Used by the discovery code. */ |
| 604 | struct timer_list timer; |
| 605 | struct completion completion; |
| 606 | |
| 607 | union { |
| 608 | struct sas_ata_task ata_task; |
| 609 | struct sas_smp_task smp_task; |
| 610 | struct sas_ssp_task ssp_task; |
| 611 | }; |
| 612 | |
| 613 | struct scatterlist *scatter; |
| 614 | int num_scatter; |
| 615 | u32 total_xfer_len; |
| 616 | u8 data_dir:2; /* Use PCI_DMA_... */ |
| 617 | |
| 618 | struct task_status_struct task_status; |
| 619 | void (*task_done)(struct sas_task *); |
| 620 | |
| 621 | void *lldd_task; /* for use by LLDDs */ |
| 622 | void *uldd_task; |
Darrick J. Wong | 79a5eb6 | 2006-10-30 15:18:50 -0800 | [diff] [blame] | 623 | |
| 624 | struct work_struct abort_work; |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 625 | }; |
| 626 | |
Darrick J. Wong | f456393 | 2006-10-30 15:18:39 -0800 | [diff] [blame] | 627 | #define SAS_TASK_STATE_PENDING 1 |
| 628 | #define SAS_TASK_STATE_DONE 2 |
| 629 | #define SAS_TASK_STATE_ABORTED 4 |
Darrick J. Wong | 3ebf692 | 2007-01-11 14:15:17 -0800 | [diff] [blame] | 630 | #define SAS_TASK_NEED_DEV_RESET 8 |
Darrick J. Wong | b218a0d | 2007-01-11 14:14:55 -0800 | [diff] [blame] | 631 | #define SAS_TASK_AT_INITIATOR 16 |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 632 | |
Dan Williams | 4fcf812 | 2011-07-29 17:26:39 -0700 | [diff] [blame] | 633 | extern struct sas_task *sas_alloc_task(gfp_t flags); |
| 634 | extern void sas_free_task(struct sas_task *task); |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 635 | |
| 636 | struct sas_domain_function_template { |
| 637 | /* The class calls these to notify the LLDD of an event. */ |
| 638 | void (*lldd_port_formed)(struct asd_sas_phy *); |
| 639 | void (*lldd_port_deformed)(struct asd_sas_phy *); |
| 640 | |
| 641 | /* The class calls these when a device is found or gone. */ |
| 642 | int (*lldd_dev_found)(struct domain_device *); |
| 643 | void (*lldd_dev_gone)(struct domain_device *); |
| 644 | |
| 645 | int (*lldd_execute_task)(struct sas_task *, int num, |
Al Viro | 3cc2754 | 2006-09-25 02:55:40 +0100 | [diff] [blame] | 646 | gfp_t gfp_flags); |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 647 | |
| 648 | /* Task Management Functions. Must be called from process context. */ |
| 649 | int (*lldd_abort_task)(struct sas_task *); |
| 650 | int (*lldd_abort_task_set)(struct domain_device *, u8 *lun); |
| 651 | int (*lldd_clear_aca)(struct domain_device *, u8 *lun); |
| 652 | int (*lldd_clear_task_set)(struct domain_device *, u8 *lun); |
| 653 | int (*lldd_I_T_nexus_reset)(struct domain_device *); |
Dan Williams | 36a3994 | 2011-11-17 17:59:54 -0800 | [diff] [blame] | 654 | int (*lldd_ata_check_ready)(struct domain_device *); |
Dan Williams | b91bb29 | 2011-11-17 17:59:52 -0800 | [diff] [blame] | 655 | void (*lldd_ata_set_dmamode)(struct domain_device *); |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 656 | int (*lldd_lu_reset)(struct domain_device *, u8 *lun); |
| 657 | int (*lldd_query_task)(struct sas_task *); |
| 658 | |
| 659 | /* Port and Adapter management */ |
| 660 | int (*lldd_clear_nexus_port)(struct asd_sas_port *); |
| 661 | int (*lldd_clear_nexus_ha)(struct sas_ha_struct *); |
| 662 | |
| 663 | /* Phy management */ |
James Bottomley | a01e70e | 2006-09-06 19:28:07 -0500 | [diff] [blame] | 664 | int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *); |
Dan Williams | 8ec6552 | 2011-09-01 21:18:20 -0700 | [diff] [blame] | 665 | |
| 666 | /* GPIO support */ |
| 667 | int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type, |
| 668 | u8 reg_index, u8 reg_count, u8 *write_data); |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 669 | }; |
| 670 | |
| 671 | extern int sas_register_ha(struct sas_ha_struct *); |
| 672 | extern int sas_unregister_ha(struct sas_ha_struct *); |
| 673 | |
Darrick J. Wong | acbf167 | 2007-01-11 14:14:57 -0800 | [diff] [blame] | 674 | int sas_set_phy_speed(struct sas_phy *phy, |
| 675 | struct sas_phy_linkrates *rates); |
Darrick J. Wong | dea2221 | 2006-11-07 17:28:55 -0800 | [diff] [blame] | 676 | int sas_phy_reset(struct sas_phy *phy, int hard_reset); |
Darrick J. Wong | 338ec57 | 2006-10-18 14:43:37 -0700 | [diff] [blame] | 677 | int sas_queue_up(struct sas_task *task); |
Jeff Garzik | f281233 | 2010-11-16 02:10:29 -0500 | [diff] [blame] | 678 | extern int sas_queuecommand(struct Scsi_Host * ,struct scsi_cmnd *); |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 679 | extern int sas_target_alloc(struct scsi_target *); |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 680 | extern int sas_slave_configure(struct scsi_device *); |
Mike Christie | e881a17 | 2009-10-15 17:46:39 -0700 | [diff] [blame] | 681 | extern int sas_change_queue_depth(struct scsi_device *, int new_depth, |
| 682 | int reason); |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 683 | extern int sas_change_queue_type(struct scsi_device *, int qt); |
| 684 | extern int sas_bios_param(struct scsi_device *, |
| 685 | struct block_device *, |
| 686 | sector_t capacity, int *hsc); |
| 687 | extern struct scsi_transport_template * |
| 688 | sas_domain_attach_transport(struct sas_domain_function_template *); |
| 689 | extern void sas_domain_release_transport(struct scsi_transport_template *); |
| 690 | |
| 691 | int sas_discover_root_expander(struct domain_device *); |
| 692 | |
| 693 | void sas_init_ex_attr(void); |
| 694 | |
| 695 | int sas_ex_revalidate_domain(struct domain_device *); |
| 696 | |
Dan Williams | 7d05919 | 2012-01-10 14:39:13 -0800 | [diff] [blame] | 697 | void sas_unregister_domain_devices(struct asd_sas_port *port, int gone); |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 698 | void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *); |
| 699 | int sas_discover_event(struct asd_sas_port *, enum discover_event ev); |
| 700 | |
| 701 | int sas_discover_sata(struct domain_device *); |
| 702 | int sas_discover_end_dev(struct domain_device *); |
| 703 | |
Dan Williams | 1a34c06 | 2011-09-21 22:05:34 -0700 | [diff] [blame] | 704 | void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *); |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 705 | |
| 706 | void sas_init_dev(struct domain_device *); |
| 707 | |
Darrick J. Wong | 396819f | 2007-01-11 14:15:20 -0800 | [diff] [blame] | 708 | void sas_task_abort(struct sas_task *); |
Darrick J. Wong | ad68923 | 2007-01-26 14:08:52 -0800 | [diff] [blame] | 709 | int sas_eh_device_reset_handler(struct scsi_cmnd *cmd); |
Darrick J. Wong | a9344e6 | 2007-01-29 23:48:19 -0800 | [diff] [blame] | 710 | int sas_eh_bus_reset_handler(struct scsi_cmnd *cmd); |
Darrick J. Wong | 79a5eb6 | 2006-10-30 15:18:50 -0800 | [diff] [blame] | 711 | |
Darrick J. Wong | fa1c1e8 | 2006-08-10 19:19:47 -0700 | [diff] [blame] | 712 | extern void sas_target_destroy(struct scsi_target *); |
| 713 | extern int sas_slave_alloc(struct scsi_device *); |
| 714 | extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg); |
Dan Williams | b1124cd | 2011-12-19 16:42:34 -0800 | [diff] [blame] | 715 | extern int sas_drain_work(struct sas_ha_struct *ha); |
Darrick J. Wong | fa1c1e8 | 2006-08-10 19:19:47 -0700 | [diff] [blame] | 716 | |
FUJITA Tomonori | ba1fc17 | 2007-07-09 12:52:08 +0900 | [diff] [blame] | 717 | extern int sas_smp_handler(struct Scsi_Host *shost, struct sas_rphy *rphy, |
| 718 | struct request *req); |
James Bottomley | 366ca51 | 2008-01-18 10:47:01 -0600 | [diff] [blame] | 719 | |
| 720 | extern void sas_ssp_task_response(struct device *dev, struct sas_task *task, |
| 721 | struct ssp_response_iu *iu); |
Dan Williams | f41a0c4 | 2011-12-21 21:33:17 -0800 | [diff] [blame] | 722 | struct sas_phy *sas_get_local_phy(struct domain_device *dev); |
James Bottomley | 366ca51 | 2008-01-18 10:47:01 -0600 | [diff] [blame] | 723 | |
Darrick J. Wong | 45e6cdf | 2008-02-19 10:49:40 -0800 | [diff] [blame] | 724 | int sas_request_addr(struct Scsi_Host *shost, u8 *addr); |
| 725 | |
James Bottomley | 2908d77 | 2006-08-29 09:22:51 -0500 | [diff] [blame] | 726 | #endif /* _SASLIB_H_ */ |