scsi_device.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356
  1. #ifndef _SCSI_SCSI_DEVICE_H
  2. #define _SCSI_SCSI_DEVICE_H
  3. #include <linux/device.h>
  4. #include <linux/list.h>
  5. #include <linux/spinlock.h>
  6. #include <linux/workqueue.h>
  7. #include <asm/atomic.h>
  8. struct request_queue;
  9. struct scsi_cmnd;
  10. struct scsi_lun;
  11. struct scsi_sense_hdr;
  12. struct scsi_mode_data {
  13. __u32 length;
  14. __u16 block_descriptor_length;
  15. __u8 medium_type;
  16. __u8 device_specific;
  17. __u8 header_length;
  18. __u8 longlba:1;
  19. };
  20. /*
  21. * sdev state: If you alter this, you also need to alter scsi_sysfs.c
  22. * (for the ascii descriptions) and the state model enforcer:
  23. * scsi_lib:scsi_device_set_state().
  24. */
  25. enum scsi_device_state {
  26. SDEV_CREATED = 1, /* device created but not added to sysfs
  27. * Only internal commands allowed (for inq) */
  28. SDEV_RUNNING, /* device properly configured
  29. * All commands allowed */
  30. SDEV_CANCEL, /* beginning to delete device
  31. * Only error handler commands allowed */
  32. SDEV_DEL, /* device deleted
  33. * no commands allowed */
  34. SDEV_QUIESCE, /* Device quiescent. No block commands
  35. * will be accepted, only specials (which
  36. * originate in the mid-layer) */
  37. SDEV_OFFLINE, /* Device offlined (by error handling or
  38. * user request */
  39. SDEV_BLOCK, /* Device blocked by scsi lld. No scsi
  40. * commands from user or midlayer should be issued
  41. * to the scsi lld. */
  42. };
  43. struct scsi_device {
  44. struct Scsi_Host *host;
  45. struct request_queue *request_queue;
  46. /* the next two are protected by the host->host_lock */
  47. struct list_head siblings; /* list of all devices on this host */
  48. struct list_head same_target_siblings; /* just the devices sharing same target id */
  49. /* this is now protected by the request_queue->queue_lock */
  50. unsigned int device_busy; /* commands actually active on
  51. * low-level. protected by queue_lock. */
  52. spinlock_t list_lock;
  53. struct list_head cmd_list; /* queue of in use SCSI Command structures */
  54. struct list_head starved_entry;
  55. struct scsi_cmnd *current_cmnd; /* currently active command */
  56. unsigned short queue_depth; /* How deep of a queue we want */
  57. unsigned short last_queue_full_depth; /* These two are used by */
  58. unsigned short last_queue_full_count; /* scsi_track_queue_full() */
  59. unsigned long last_queue_full_time;/* don't let QUEUE_FULLs on the same
  60. jiffie count on our counter, they
  61. could all be from the same event. */
  62. unsigned int id, lun, channel;
  63. unsigned int manufacturer; /* Manufacturer of device, for using
  64. * vendor-specific cmd's */
  65. unsigned sector_size; /* size in bytes */
  66. void *hostdata; /* available to low-level driver */
  67. char type;
  68. char scsi_level;
  69. char inq_periph_qual; /* PQ from INQUIRY data */
  70. unsigned char inquiry_len; /* valid bytes in 'inquiry' */
  71. unsigned char * inquiry; /* INQUIRY response data */
  72. const char * vendor; /* [back_compat] point into 'inquiry' ... */
  73. const char * model; /* ... after scan; point to static string */
  74. const char * rev; /* ... "nullnullnullnull" before scan */
  75. unsigned char current_tag; /* current tag */
  76. struct scsi_target *sdev_target; /* used only for single_lun */
  77. unsigned int sdev_bflags; /* black/white flags as also found in
  78. * scsi_devinfo.[hc]. For now used only to
  79. * pass settings from slave_alloc to scsi
  80. * core. */
  81. unsigned writeable:1;
  82. unsigned removable:1;
  83. unsigned changed:1; /* Data invalid due to media change */
  84. unsigned busy:1; /* Used to prevent races */
  85. unsigned lockable:1; /* Able to prevent media removal */
  86. unsigned locked:1; /* Media removal disabled */
  87. unsigned borken:1; /* Tell the Seagate driver to be
  88. * painfully slow on this device */
  89. unsigned disconnect:1; /* can disconnect */
  90. unsigned soft_reset:1; /* Uses soft reset option */
  91. unsigned sdtr:1; /* Device supports SDTR messages */
  92. unsigned wdtr:1; /* Device supports WDTR messages */
  93. unsigned ppr:1; /* Device supports PPR messages */
  94. unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
  95. unsigned simple_tags:1; /* simple queue tag messages are enabled */
  96. unsigned ordered_tags:1;/* ordered queue tag messages are enabled */
  97. unsigned single_lun:1; /* Indicates we should only allow I/O to
  98. * one of the luns for the device at a
  99. * time. */
  100. unsigned was_reset:1; /* There was a bus reset on the bus for
  101. * this device */
  102. unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
  103. * because we did a bus reset. */
  104. unsigned use_10_for_rw:1; /* first try 10-byte read / write */
  105. unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
  106. unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
  107. unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
  108. unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
  109. unsigned no_start_on_add:1; /* do not issue start on add */
  110. unsigned allow_restart:1; /* issue START_UNIT in error handler */
  111. unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
  112. unsigned select_no_atn:1;
  113. unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
  114. unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
  115. unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
  116. unsigned int device_blocked; /* Device returned QUEUE_FULL. */
  117. unsigned int max_device_blocked; /* what device_blocked counts down from */
  118. #define SCSI_DEFAULT_DEVICE_BLOCKED 3
  119. atomic_t iorequest_cnt;
  120. atomic_t iodone_cnt;
  121. atomic_t ioerr_cnt;
  122. int timeout;
  123. struct device sdev_gendev;
  124. struct class_device sdev_classdev;
  125. struct execute_work ew; /* used to get process context on put */
  126. enum scsi_device_state sdev_state;
  127. unsigned long sdev_data[0];
  128. } __attribute__((aligned(sizeof(unsigned long))));
  129. #define to_scsi_device(d) \
  130. container_of(d, struct scsi_device, sdev_gendev)
  131. #define class_to_sdev(d) \
  132. container_of(d, struct scsi_device, sdev_classdev)
  133. #define transport_class_to_sdev(class_dev) \
  134. to_scsi_device(class_dev->dev)
  135. #define sdev_printk(prefix, sdev, fmt, a...) \
  136. dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
  137. #define scmd_printk(prefix, scmd, fmt, a...) \
  138. dev_printk(prefix, &(scmd)->device->sdev_gendev, fmt, ##a)
  139. enum scsi_target_state {
  140. STARGET_RUNNING = 1,
  141. STARGET_DEL,
  142. };
  143. /*
  144. * scsi_target: representation of a scsi target, for now, this is only
  145. * used for single_lun devices. If no one has active IO to the target,
  146. * starget_sdev_user is NULL, else it points to the active sdev.
  147. */
  148. struct scsi_target {
  149. struct scsi_device *starget_sdev_user;
  150. struct list_head siblings;
  151. struct list_head devices;
  152. struct device dev;
  153. unsigned int reap_ref; /* protected by the host lock */
  154. unsigned int channel;
  155. unsigned int id; /* target id ... replace
  156. * scsi_device.id eventually */
  157. unsigned int create:1; /* signal that it needs to be added */
  158. unsigned int pdt_1f_for_no_lun; /* PDT = 0x1f */
  159. /* means no lun present */
  160. char scsi_level;
  161. struct execute_work ew;
  162. enum scsi_target_state state;
  163. void *hostdata; /* available to low-level driver */
  164. unsigned long starget_data[0]; /* for the transport */
  165. /* starget_data must be the last element!!!! */
  166. } __attribute__((aligned(sizeof(unsigned long))));
  167. #define to_scsi_target(d) container_of(d, struct scsi_target, dev)
  168. static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
  169. {
  170. return to_scsi_target(sdev->sdev_gendev.parent);
  171. }
  172. #define transport_class_to_starget(class_dev) \
  173. to_scsi_target(class_dev->dev)
  174. #define starget_printk(prefix, starget, fmt, a...) \
  175. dev_printk(prefix, &(starget)->dev, fmt, ##a)
  176. extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
  177. uint, uint, uint, void *hostdata);
  178. extern int scsi_add_device(struct Scsi_Host *host, uint channel,
  179. uint target, uint lun);
  180. extern void scsi_remove_device(struct scsi_device *);
  181. extern int scsi_device_cancel(struct scsi_device *, int);
  182. extern int scsi_device_get(struct scsi_device *);
  183. extern void scsi_device_put(struct scsi_device *);
  184. extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
  185. uint, uint, uint);
  186. extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
  187. uint, uint, uint);
  188. extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
  189. uint);
  190. extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
  191. uint);
  192. extern void starget_for_each_device(struct scsi_target *, void *,
  193. void (*fn)(struct scsi_device *, void *));
  194. /* only exposed to implement shost_for_each_device */
  195. extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
  196. struct scsi_device *);
  197. /**
  198. * shost_for_each_device - iterate over all devices of a host
  199. * @sdev: the &struct scsi_device to use as a cursor
  200. * @shost: the &struct scsi_host to iterate over
  201. *
  202. * Iterator that returns each device attached to @shost. This loop
  203. * takes a reference on each device and releases it at the end. If
  204. * you break out of the loop, you must call scsi_device_put(sdev).
  205. */
  206. #define shost_for_each_device(sdev, shost) \
  207. for ((sdev) = __scsi_iterate_devices((shost), NULL); \
  208. (sdev); \
  209. (sdev) = __scsi_iterate_devices((shost), (sdev)))
  210. /**
  211. * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
  212. * @sdev: the &struct scsi_device to use as a cursor
  213. * @shost: the &struct scsi_host to iterate over
  214. *
  215. * Iterator that returns each device attached to @shost. It does _not_
  216. * take a reference on the scsi_device, so the whole loop must be
  217. * protected by shost->host_lock.
  218. *
  219. * Note: The only reason to use this is because you need to access the
  220. * device list in interrupt context. Otherwise you really want to use
  221. * shost_for_each_device instead.
  222. */
  223. #define __shost_for_each_device(sdev, shost) \
  224. list_for_each_entry((sdev), &((shost)->__devices), siblings)
  225. extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
  226. extern int scsi_track_queue_full(struct scsi_device *, int);
  227. extern int scsi_set_medium_removal(struct scsi_device *, char);
  228. extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
  229. unsigned char *buffer, int len, int timeout,
  230. int retries, struct scsi_mode_data *data,
  231. struct scsi_sense_hdr *);
  232. extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
  233. int modepage, unsigned char *buffer, int len,
  234. int timeout, int retries,
  235. struct scsi_mode_data *data,
  236. struct scsi_sense_hdr *);
  237. extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
  238. int retries);
  239. extern int scsi_device_set_state(struct scsi_device *sdev,
  240. enum scsi_device_state state);
  241. extern int scsi_device_quiesce(struct scsi_device *sdev);
  242. extern void scsi_device_resume(struct scsi_device *sdev);
  243. extern void scsi_target_quiesce(struct scsi_target *);
  244. extern void scsi_target_resume(struct scsi_target *);
  245. extern void scsi_scan_target(struct device *parent, unsigned int channel,
  246. unsigned int id, unsigned int lun, int rescan);
  247. extern void scsi_target_reap(struct scsi_target *);
  248. extern void scsi_target_block(struct device *);
  249. extern void scsi_target_unblock(struct device *);
  250. extern void scsi_remove_target(struct device *);
  251. extern void int_to_scsilun(unsigned int, struct scsi_lun *);
  252. extern const char *scsi_device_state_name(enum scsi_device_state);
  253. extern int scsi_is_sdev_device(const struct device *);
  254. extern int scsi_is_target_device(const struct device *);
  255. extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
  256. int data_direction, void *buffer, unsigned bufflen,
  257. unsigned char *sense, int timeout, int retries,
  258. int flag);
  259. extern int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
  260. int data_direction, void *buffer, unsigned bufflen,
  261. struct scsi_sense_hdr *, int timeout, int retries);
  262. extern int scsi_execute_async(struct scsi_device *sdev,
  263. const unsigned char *cmd, int cmd_len, int data_direction,
  264. void *buffer, unsigned bufflen, int use_sg,
  265. int timeout, int retries, void *privdata,
  266. void (*done)(void *, char *, int, int),
  267. gfp_t gfp);
  268. static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
  269. {
  270. return device_reprobe(&sdev->sdev_gendev);
  271. }
  272. static inline unsigned int sdev_channel(struct scsi_device *sdev)
  273. {
  274. return sdev->channel;
  275. }
  276. static inline unsigned int sdev_id(struct scsi_device *sdev)
  277. {
  278. return sdev->id;
  279. }
  280. #define scmd_id(scmd) sdev_id((scmd)->device)
  281. #define scmd_channel(scmd) sdev_channel((scmd)->device)
  282. static inline int scsi_device_online(struct scsi_device *sdev)
  283. {
  284. return sdev->sdev_state != SDEV_OFFLINE;
  285. }
  286. /* accessor functions for the SCSI parameters */
  287. static inline int scsi_device_sync(struct scsi_device *sdev)
  288. {
  289. return sdev->sdtr;
  290. }
  291. static inline int scsi_device_wide(struct scsi_device *sdev)
  292. {
  293. return sdev->wdtr;
  294. }
  295. static inline int scsi_device_dt(struct scsi_device *sdev)
  296. {
  297. return sdev->ppr;
  298. }
  299. static inline int scsi_device_dt_only(struct scsi_device *sdev)
  300. {
  301. if (sdev->inquiry_len < 57)
  302. return 0;
  303. return (sdev->inquiry[56] & 0x0c) == 0x04;
  304. }
  305. static inline int scsi_device_ius(struct scsi_device *sdev)
  306. {
  307. if (sdev->inquiry_len < 57)
  308. return 0;
  309. return sdev->inquiry[56] & 0x01;
  310. }
  311. static inline int scsi_device_qas(struct scsi_device *sdev)
  312. {
  313. if (sdev->inquiry_len < 57)
  314. return 0;
  315. return sdev->inquiry[56] & 0x02;
  316. }
  317. #endif /* _SCSI_SCSI_DEVICE_H */