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