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