1 #ifndef _SCSI_SCSI_DEVICE_H 2 #define _SCSI_SCSI_DEVICE_H 3 4 #include <linux/list.h> 5 #include <linux/spinlock.h> 6 #include <linux/workqueue.h> 7 #include <linux/blkdev.h> 8 #include <scsi/scsi.h> 9 #include <linux/atomic.h> 10 11 struct device; 12 struct request_queue; 13 struct scsi_cmnd; 14 struct scsi_lun; 15 struct scsi_sense_hdr; 16 17 struct scsi_mode_data { 18 __u32 length; 19 __u16 block_descriptor_length; 20 __u8 medium_type; 21 __u8 device_specific; 22 __u8 header_length; 23 __u8 longlba:1; 24 }; 25 26 /* 27 * sdev state: If you alter this, you also need to alter scsi_sysfs.c 28 * (for the ascii descriptions) and the state model enforcer: 29 * scsi_lib:scsi_device_set_state(). 30 */ 31 enum scsi_device_state { 32 SDEV_CREATED = 1, /* device created but not added to sysfs 33 * Only internal commands allowed (for inq) */ 34 SDEV_RUNNING, /* device properly configured 35 * All commands allowed */ 36 SDEV_CANCEL, /* beginning to delete device 37 * Only error handler commands allowed */ 38 SDEV_DEL, /* device deleted 39 * no commands allowed */ 40 SDEV_QUIESCE, /* Device quiescent. No block commands 41 * will be accepted, only specials (which 42 * originate in the mid-layer) */ 43 SDEV_OFFLINE, /* Device offlined (by error handling or 44 * user request */ 45 SDEV_TRANSPORT_OFFLINE, /* Offlined by transport class error handler */ 46 SDEV_BLOCK, /* Device blocked by scsi lld. No 47 * scsi commands from user or midlayer 48 * should be issued to the scsi 49 * lld. */ 50 SDEV_CREATED_BLOCK, /* same as above but for created devices */ 51 }; 52 53 enum scsi_device_event { 54 SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */ 55 SDEV_EVT_INQUIRY_CHANGE_REPORTED, /* 3F 03 UA reported */ 56 SDEV_EVT_CAPACITY_CHANGE_REPORTED, /* 2A 09 UA reported */ 57 SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED, /* 38 07 UA reported */ 58 SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED, /* 2A 01 UA reported */ 59 SDEV_EVT_LUN_CHANGE_REPORTED, /* 3F 0E UA reported */ 60 SDEV_EVT_ALUA_STATE_CHANGE_REPORTED, /* 2A 06 UA reported */ 61 62 SDEV_EVT_FIRST = SDEV_EVT_MEDIA_CHANGE, 63 SDEV_EVT_LAST = SDEV_EVT_ALUA_STATE_CHANGE_REPORTED, 64 65 SDEV_EVT_MAXBITS = SDEV_EVT_LAST + 1 66 }; 67 68 struct scsi_event { 69 enum scsi_device_event evt_type; 70 struct list_head node; 71 72 /* put union of data structures, for non-simple event types, 73 * here 74 */ 75 }; 76 77 struct scsi_device { 78 struct Scsi_Host *host; 79 struct request_queue *request_queue; 80 81 /* the next two are protected by the host->host_lock */ 82 struct list_head siblings; /* list of all devices on this host */ 83 struct list_head same_target_siblings; /* just the devices sharing same target id */ 84 85 atomic_t device_busy; /* commands actually active on LLDD */ 86 atomic_t device_blocked; /* Device returned QUEUE_FULL. */ 87 88 spinlock_t list_lock; 89 struct list_head cmd_list; /* queue of in use SCSI Command structures */ 90 struct list_head starved_entry; 91 struct scsi_cmnd *current_cmnd; /* currently active command */ 92 unsigned short queue_depth; /* How deep of a queue we want */ 93 unsigned short max_queue_depth; /* max queue depth */ 94 unsigned short last_queue_full_depth; /* These two are used by */ 95 unsigned short last_queue_full_count; /* scsi_track_queue_full() */ 96 unsigned long last_queue_full_time; /* last queue full time */ 97 unsigned long queue_ramp_up_period; /* ramp up period in jiffies */ 98 #define SCSI_DEFAULT_RAMP_UP_PERIOD (120 * HZ) 99 100 unsigned long last_queue_ramp_up; /* last queue ramp up time */ 101 102 unsigned int id, channel; 103 u64 lun; 104 unsigned int manufacturer; /* Manufacturer of device, for using 105 * vendor-specific cmd's */ 106 unsigned sector_size; /* size in bytes */ 107 108 void *hostdata; /* available to low-level driver */ 109 char type; 110 char scsi_level; 111 char inq_periph_qual; /* PQ from INQUIRY data */ 112 struct mutex inquiry_mutex; 113 unsigned char inquiry_len; /* valid bytes in 'inquiry' */ 114 unsigned char * inquiry; /* INQUIRY response data */ 115 const char * vendor; /* [back_compat] point into 'inquiry' ... */ 116 const char * model; /* ... after scan; point to static string */ 117 const char * rev; /* ... "nullnullnullnull" before scan */ 118 119 #define SCSI_VPD_PG_LEN 255 120 int vpd_pg83_len; 121 unsigned char __rcu *vpd_pg83; 122 int vpd_pg80_len; 123 unsigned char __rcu *vpd_pg80; 124 unsigned char current_tag; /* current tag */ 125 struct scsi_target *sdev_target; /* used only for single_lun */ 126 127 unsigned int sdev_bflags; /* black/white flags as also found in 128 * scsi_devinfo.[hc]. For now used only to 129 * pass settings from slave_alloc to scsi 130 * core. */ 131 unsigned int eh_timeout; /* Error handling timeout */ 132 unsigned removable:1; 133 unsigned changed:1; /* Data invalid due to media change */ 134 unsigned busy:1; /* Used to prevent races */ 135 unsigned lockable:1; /* Able to prevent media removal */ 136 unsigned locked:1; /* Media removal disabled */ 137 unsigned borken:1; /* Tell the Seagate driver to be 138 * painfully slow on this device */ 139 unsigned disconnect:1; /* can disconnect */ 140 unsigned soft_reset:1; /* Uses soft reset option */ 141 unsigned sdtr:1; /* Device supports SDTR messages */ 142 unsigned wdtr:1; /* Device supports WDTR messages */ 143 unsigned ppr:1; /* Device supports PPR messages */ 144 unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */ 145 unsigned simple_tags:1; /* simple queue tag messages are enabled */ 146 unsigned was_reset:1; /* There was a bus reset on the bus for 147 * this device */ 148 unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN 149 * because we did a bus reset. */ 150 unsigned use_10_for_rw:1; /* first try 10-byte read / write */ 151 unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */ 152 unsigned no_report_opcodes:1; /* no REPORT SUPPORTED OPERATION CODES */ 153 unsigned no_write_same:1; /* no WRITE SAME command */ 154 unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */ 155 unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */ 156 unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */ 157 unsigned skip_vpd_pages:1; /* do not read VPD pages */ 158 unsigned try_vpd_pages:1; /* attempt to read VPD pages */ 159 unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */ 160 unsigned no_start_on_add:1; /* do not issue start on add */ 161 unsigned allow_restart:1; /* issue START_UNIT in error handler */ 162 unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */ 163 unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */ 164 unsigned no_uld_attach:1; /* disable connecting to upper level drivers */ 165 unsigned select_no_atn:1; 166 unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */ 167 unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */ 168 unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */ 169 unsigned last_sector_bug:1; /* do not use multisector accesses on 170 SD_LAST_BUGGY_SECTORS */ 171 unsigned no_read_disc_info:1; /* Avoid READ_DISC_INFO cmds */ 172 unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */ 173 unsigned try_rc_10_first:1; /* Try READ_CAPACACITY_10 first */ 174 unsigned is_visible:1; /* is the device visible in sysfs */ 175 unsigned wce_default_on:1; /* Cache is ON by default */ 176 unsigned no_dif:1; /* T10 PI (DIF) should be disabled */ 177 unsigned broken_fua:1; /* Don't set FUA bit */ 178 unsigned lun_in_cdb:1; /* Store LUN bits in CDB[1] */ 179 180 atomic_t disk_events_disable_depth; /* disable depth for disk events */ 181 182 DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */ 183 DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */ 184 struct list_head event_list; /* asserted events */ 185 struct work_struct event_work; 186 187 unsigned int max_device_blocked; /* what device_blocked counts down from */ 188 #define SCSI_DEFAULT_DEVICE_BLOCKED 3 189 190 atomic_t iorequest_cnt; 191 atomic_t iodone_cnt; 192 atomic_t ioerr_cnt; 193 194 struct device sdev_gendev, 195 sdev_dev; 196 197 struct execute_work ew; /* used to get process context on put */ 198 struct work_struct requeue_work; 199 200 struct scsi_device_handler *handler; 201 void *handler_data; 202 203 enum scsi_device_state sdev_state; 204 unsigned long sdev_data[0]; 205 } __attribute__((aligned(sizeof(unsigned long)))); 206 207 #define to_scsi_device(d) \ 208 container_of(d, struct scsi_device, sdev_gendev) 209 #define class_to_sdev(d) \ 210 container_of(d, struct scsi_device, sdev_dev) 211 #define transport_class_to_sdev(class_dev) \ 212 to_scsi_device(class_dev->parent) 213 214 #define sdev_dbg(sdev, fmt, a...) \ 215 dev_dbg(&(sdev)->sdev_gendev, fmt, ##a) 216 217 /* 218 * like scmd_printk, but the device name is passed in 219 * as a string pointer 220 */ 221 __printf(4, 5) void 222 sdev_prefix_printk(const char *, const struct scsi_device *, const char *, 223 const char *, ...); 224 225 #define sdev_printk(l, sdev, fmt, a...) \ 226 sdev_prefix_printk(l, sdev, NULL, fmt, ##a) 227 228 __printf(3, 4) void 229 scmd_printk(const char *, const struct scsi_cmnd *, const char *, ...); 230 231 #define scmd_dbg(scmd, fmt, a...) \ 232 do { \ 233 if ((scmd)->request->rq_disk) \ 234 sdev_dbg((scmd)->device, "[%s] " fmt, \ 235 (scmd)->request->rq_disk->disk_name, ##a);\ 236 else \ 237 sdev_dbg((scmd)->device, fmt, ##a); \ 238 } while (0) 239 240 enum scsi_target_state { 241 STARGET_CREATED = 1, 242 STARGET_RUNNING, 243 STARGET_DEL, 244 }; 245 246 /* 247 * scsi_target: representation of a scsi target, for now, this is only 248 * used for single_lun devices. If no one has active IO to the target, 249 * starget_sdev_user is NULL, else it points to the active sdev. 250 */ 251 struct scsi_target { 252 struct scsi_device *starget_sdev_user; 253 struct list_head siblings; 254 struct list_head devices; 255 struct device dev; 256 struct kref reap_ref; /* last put renders target invisible */ 257 unsigned int channel; 258 unsigned int id; /* target id ... replace 259 * scsi_device.id eventually */ 260 unsigned int create:1; /* signal that it needs to be added */ 261 unsigned int single_lun:1; /* Indicates we should only 262 * allow I/O to one of the luns 263 * for the device at a time. */ 264 unsigned int pdt_1f_for_no_lun:1; /* PDT = 0x1f 265 * means no lun present. */ 266 unsigned int no_report_luns:1; /* Don't use 267 * REPORT LUNS for scanning. */ 268 unsigned int expecting_lun_change:1; /* A device has reported 269 * a 3F/0E UA, other devices on 270 * the same target will also. */ 271 /* commands actually active on LLD. */ 272 atomic_t target_busy; 273 atomic_t target_blocked; 274 275 /* 276 * LLDs should set this in the slave_alloc host template callout. 277 * If set to zero then there is not limit. 278 */ 279 unsigned int can_queue; 280 unsigned int max_target_blocked; 281 #define SCSI_DEFAULT_TARGET_BLOCKED 3 282 283 char scsi_level; 284 enum scsi_target_state state; 285 void *hostdata; /* available to low-level driver */ 286 unsigned long starget_data[0]; /* for the transport */ 287 /* starget_data must be the last element!!!! */ 288 } __attribute__((aligned(sizeof(unsigned long)))); 289 290 #define to_scsi_target(d) container_of(d, struct scsi_target, dev) 291 static inline struct scsi_target *scsi_target(struct scsi_device *sdev) 292 { 293 return to_scsi_target(sdev->sdev_gendev.parent); 294 } 295 #define transport_class_to_starget(class_dev) \ 296 to_scsi_target(class_dev->parent) 297 298 #define starget_printk(prefix, starget, fmt, a...) \ 299 dev_printk(prefix, &(starget)->dev, fmt, ##a) 300 301 extern struct scsi_device *__scsi_add_device(struct Scsi_Host *, 302 uint, uint, u64, void *hostdata); 303 extern int scsi_add_device(struct Scsi_Host *host, uint channel, 304 uint target, u64 lun); 305 extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh); 306 extern void scsi_remove_device(struct scsi_device *); 307 extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh); 308 void scsi_attach_vpd(struct scsi_device *sdev); 309 310 extern int scsi_device_get(struct scsi_device *); 311 extern void scsi_device_put(struct scsi_device *); 312 extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *, 313 uint, uint, u64); 314 extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *, 315 uint, uint, u64); 316 extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *, 317 u64); 318 extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *, 319 u64); 320 extern void starget_for_each_device(struct scsi_target *, void *, 321 void (*fn)(struct scsi_device *, void *)); 322 extern void __starget_for_each_device(struct scsi_target *, void *, 323 void (*fn)(struct scsi_device *, 324 void *)); 325 326 /* only exposed to implement shost_for_each_device */ 327 extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *, 328 struct scsi_device *); 329 330 /** 331 * shost_for_each_device - iterate over all devices of a host 332 * @sdev: the &struct scsi_device to use as a cursor 333 * @shost: the &struct scsi_host to iterate over 334 * 335 * Iterator that returns each device attached to @shost. This loop 336 * takes a reference on each device and releases it at the end. If 337 * you break out of the loop, you must call scsi_device_put(sdev). 338 */ 339 #define shost_for_each_device(sdev, shost) \ 340 for ((sdev) = __scsi_iterate_devices((shost), NULL); \ 341 (sdev); \ 342 (sdev) = __scsi_iterate_devices((shost), (sdev))) 343 344 /** 345 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED) 346 * @sdev: the &struct scsi_device to use as a cursor 347 * @shost: the &struct scsi_host to iterate over 348 * 349 * Iterator that returns each device attached to @shost. It does _not_ 350 * take a reference on the scsi_device, so the whole loop must be 351 * protected by shost->host_lock. 352 * 353 * Note: The only reason to use this is because you need to access the 354 * device list in interrupt context. Otherwise you really want to use 355 * shost_for_each_device instead. 356 */ 357 #define __shost_for_each_device(sdev, shost) \ 358 list_for_each_entry((sdev), &((shost)->__devices), siblings) 359 360 extern int scsi_change_queue_depth(struct scsi_device *, int); 361 extern int scsi_track_queue_full(struct scsi_device *, int); 362 363 extern int scsi_set_medium_removal(struct scsi_device *, char); 364 365 extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage, 366 unsigned char *buffer, int len, int timeout, 367 int retries, struct scsi_mode_data *data, 368 struct scsi_sense_hdr *); 369 extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp, 370 int modepage, unsigned char *buffer, int len, 371 int timeout, int retries, 372 struct scsi_mode_data *data, 373 struct scsi_sense_hdr *); 374 extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout, 375 int retries, struct scsi_sense_hdr *sshdr); 376 extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf, 377 int buf_len); 378 extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer, 379 unsigned int len, unsigned char opcode); 380 extern int scsi_device_set_state(struct scsi_device *sdev, 381 enum scsi_device_state state); 382 extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type, 383 gfp_t gfpflags); 384 extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt); 385 extern void sdev_evt_send_simple(struct scsi_device *sdev, 386 enum scsi_device_event evt_type, gfp_t gfpflags); 387 extern int scsi_device_quiesce(struct scsi_device *sdev); 388 extern void scsi_device_resume(struct scsi_device *sdev); 389 extern void scsi_target_quiesce(struct scsi_target *); 390 extern void scsi_target_resume(struct scsi_target *); 391 extern void scsi_scan_target(struct device *parent, unsigned int channel, 392 unsigned int id, u64 lun, int rescan); 393 extern void scsi_target_reap(struct scsi_target *); 394 extern void scsi_target_block(struct device *); 395 extern void scsi_target_unblock(struct device *, enum scsi_device_state); 396 extern void scsi_remove_target(struct device *); 397 extern const char *scsi_device_state_name(enum scsi_device_state); 398 extern int scsi_is_sdev_device(const struct device *); 399 extern int scsi_is_target_device(const struct device *); 400 extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd, 401 int data_direction, void *buffer, unsigned bufflen, 402 unsigned char *sense, int timeout, int retries, 403 u64 flags, int *resid); 404 extern int scsi_execute_req_flags(struct scsi_device *sdev, 405 const unsigned char *cmd, int data_direction, void *buffer, 406 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout, 407 int retries, int *resid, u64 flags); 408 static inline int scsi_execute_req(struct scsi_device *sdev, 409 const unsigned char *cmd, int data_direction, void *buffer, 410 unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout, 411 int retries, int *resid) 412 { 413 return scsi_execute_req_flags(sdev, cmd, data_direction, buffer, 414 bufflen, sshdr, timeout, retries, resid, 0); 415 } 416 extern void sdev_disable_disk_events(struct scsi_device *sdev); 417 extern void sdev_enable_disk_events(struct scsi_device *sdev); 418 extern int scsi_vpd_lun_id(struct scsi_device *, char *, size_t); 419 extern int scsi_vpd_tpg_id(struct scsi_device *, int *); 420 421 #ifdef CONFIG_PM 422 extern int scsi_autopm_get_device(struct scsi_device *); 423 extern void scsi_autopm_put_device(struct scsi_device *); 424 #else 425 static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; } 426 static inline void scsi_autopm_put_device(struct scsi_device *d) {} 427 #endif /* CONFIG_PM */ 428 429 static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev) 430 { 431 return device_reprobe(&sdev->sdev_gendev); 432 } 433 434 static inline unsigned int sdev_channel(struct scsi_device *sdev) 435 { 436 return sdev->channel; 437 } 438 439 static inline unsigned int sdev_id(struct scsi_device *sdev) 440 { 441 return sdev->id; 442 } 443 444 #define scmd_id(scmd) sdev_id((scmd)->device) 445 #define scmd_channel(scmd) sdev_channel((scmd)->device) 446 447 /* 448 * checks for positions of the SCSI state machine 449 */ 450 static inline int scsi_device_online(struct scsi_device *sdev) 451 { 452 return (sdev->sdev_state != SDEV_OFFLINE && 453 sdev->sdev_state != SDEV_TRANSPORT_OFFLINE && 454 sdev->sdev_state != SDEV_DEL); 455 } 456 static inline int scsi_device_blocked(struct scsi_device *sdev) 457 { 458 return sdev->sdev_state == SDEV_BLOCK || 459 sdev->sdev_state == SDEV_CREATED_BLOCK; 460 } 461 static inline int scsi_device_created(struct scsi_device *sdev) 462 { 463 return sdev->sdev_state == SDEV_CREATED || 464 sdev->sdev_state == SDEV_CREATED_BLOCK; 465 } 466 467 /* accessor functions for the SCSI parameters */ 468 static inline int scsi_device_sync(struct scsi_device *sdev) 469 { 470 return sdev->sdtr; 471 } 472 static inline int scsi_device_wide(struct scsi_device *sdev) 473 { 474 return sdev->wdtr; 475 } 476 static inline int scsi_device_dt(struct scsi_device *sdev) 477 { 478 return sdev->ppr; 479 } 480 static inline int scsi_device_dt_only(struct scsi_device *sdev) 481 { 482 if (sdev->inquiry_len < 57) 483 return 0; 484 return (sdev->inquiry[56] & 0x0c) == 0x04; 485 } 486 static inline int scsi_device_ius(struct scsi_device *sdev) 487 { 488 if (sdev->inquiry_len < 57) 489 return 0; 490 return sdev->inquiry[56] & 0x01; 491 } 492 static inline int scsi_device_qas(struct scsi_device *sdev) 493 { 494 if (sdev->inquiry_len < 57) 495 return 0; 496 return sdev->inquiry[56] & 0x02; 497 } 498 static inline int scsi_device_enclosure(struct scsi_device *sdev) 499 { 500 return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1; 501 } 502 503 static inline int scsi_device_protection(struct scsi_device *sdev) 504 { 505 if (sdev->no_dif) 506 return 0; 507 508 return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0); 509 } 510 511 static inline int scsi_device_tpgs(struct scsi_device *sdev) 512 { 513 return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0; 514 } 515 516 #define MODULE_ALIAS_SCSI_DEVICE(type) \ 517 MODULE_ALIAS("scsi:t-" __stringify(type) "*") 518 #define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x" 519 520 #endif /* _SCSI_SCSI_DEVICE_H */ 521