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