usb.h 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Driver for USB Mass Storage compliant devices
  4. * Main Header File
  5. *
  6. * Current development and maintenance by:
  7. * (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
  8. *
  9. * Initial work by:
  10. * (c) 1999 Michael Gee (michael@linuxspecific.com)
  11. *
  12. * This driver is based on the 'USB Mass Storage Class' document. This
  13. * describes in detail the protocol used to communicate with such
  14. * devices. Clearly, the designers had SCSI and ATAPI commands in
  15. * mind when they created this document. The commands are all very
  16. * similar to commands in the SCSI-II and ATAPI specifications.
  17. *
  18. * It is important to note that in a number of cases this class
  19. * exhibits class-specific exemptions from the USB specification.
  20. * Notably the usage of NAK, STALL and ACK differs from the norm, in
  21. * that they are used to communicate wait, failed and OK on commands.
  22. *
  23. * Also, for certain devices, the interrupt endpoint is used to convey
  24. * status of a command.
  25. */
  26. #ifndef _USB_H_
  27. #define _USB_H_
  28. #include <linux/usb.h>
  29. #include <linux/usb_usual.h>
  30. #include <linux/blkdev.h>
  31. #include <linux/completion.h>
  32. #include <linux/mutex.h>
  33. #include <linux/workqueue.h>
  34. #include <scsi/scsi_host.h>
  35. struct us_data;
  36. struct scsi_cmnd;
  37. /*
  38. * Unusual device list definitions
  39. */
  40. struct us_unusual_dev {
  41. const char* vendorName;
  42. const char* productName;
  43. __u8 useProtocol;
  44. __u8 useTransport;
  45. int (*initFunction)(struct us_data *);
  46. };
  47. /* Dynamic bitflag definitions (us->dflags): used in set_bit() etc. */
  48. #define US_FLIDX_URB_ACTIVE 0 /* current_urb is in use */
  49. #define US_FLIDX_SG_ACTIVE 1 /* current_sg is in use */
  50. #define US_FLIDX_ABORTING 2 /* abort is in progress */
  51. #define US_FLIDX_DISCONNECTING 3 /* disconnect in progress */
  52. #define US_FLIDX_RESETTING 4 /* device reset in progress */
  53. #define US_FLIDX_TIMED_OUT 5 /* SCSI midlayer timed out */
  54. #define US_FLIDX_SCAN_PENDING 6 /* scanning not yet done */
  55. #define US_FLIDX_REDO_READ10 7 /* redo READ(10) command */
  56. #define US_FLIDX_READ10_WORKED 8 /* previous READ(10) succeeded */
  57. #define USB_STOR_STRING_LEN 32
  58. /*
  59. * We provide a DMA-mapped I/O buffer for use with small USB transfers.
  60. * It turns out that CB[I] needs a 12-byte buffer and Bulk-only needs a
  61. * 31-byte buffer. But Freecom needs a 64-byte buffer, so that's the
  62. * size we'll allocate.
  63. */
  64. #define US_IOBUF_SIZE 64 /* Size of the DMA-mapped I/O buffer */
  65. #define US_SENSE_SIZE 18 /* Size of the autosense data buffer */
  66. typedef int (*trans_cmnd)(struct scsi_cmnd *, struct us_data*);
  67. typedef int (*trans_reset)(struct us_data*);
  68. typedef void (*proto_cmnd)(struct scsi_cmnd*, struct us_data*);
  69. typedef void (*extra_data_destructor)(void *); /* extra data destructor */
  70. typedef void (*pm_hook)(struct us_data *, int); /* power management hook */
  71. #define US_SUSPEND 0
  72. #define US_RESUME 1
  73. /* we allocate one of these for every device that we remember */
  74. struct us_data {
  75. /*
  76. * The device we're working with
  77. * It's important to note:
  78. * (o) you must hold dev_mutex to change pusb_dev
  79. */
  80. struct mutex dev_mutex; /* protect pusb_dev */
  81. struct usb_device *pusb_dev; /* this usb_device */
  82. struct usb_interface *pusb_intf; /* this interface */
  83. struct us_unusual_dev *unusual_dev; /* device-filter entry */
  84. unsigned long fflags; /* fixed flags from filter */
  85. unsigned long dflags; /* dynamic atomic bitflags */
  86. unsigned int send_bulk_pipe; /* cached pipe values */
  87. unsigned int recv_bulk_pipe;
  88. unsigned int send_ctrl_pipe;
  89. unsigned int recv_ctrl_pipe;
  90. unsigned int recv_intr_pipe;
  91. /* information about the device */
  92. char *transport_name;
  93. char *protocol_name;
  94. __le32 bcs_signature;
  95. u8 subclass;
  96. u8 protocol;
  97. u8 max_lun;
  98. u8 ifnum; /* interface number */
  99. u8 ep_bInterval; /* interrupt interval */
  100. /* function pointers for this device */
  101. trans_cmnd transport; /* transport function */
  102. trans_reset transport_reset; /* transport device reset */
  103. proto_cmnd proto_handler; /* protocol handler */
  104. /* SCSI interfaces */
  105. struct scsi_cmnd *srb; /* current srb */
  106. unsigned int tag; /* current dCBWTag */
  107. char scsi_name[32]; /* scsi_host name */
  108. /* control and bulk communications data */
  109. struct urb *current_urb; /* USB requests */
  110. struct usb_ctrlrequest *cr; /* control requests */
  111. struct usb_sg_request current_sg; /* scatter-gather req. */
  112. unsigned char *iobuf; /* I/O buffer */
  113. dma_addr_t iobuf_dma; /* buffer DMA addresses */
  114. struct task_struct *ctl_thread; /* the control thread */
  115. /* mutual exclusion and synchronization structures */
  116. struct completion cmnd_ready; /* to sleep thread on */
  117. struct completion notify; /* thread begin/end */
  118. wait_queue_head_t delay_wait; /* wait during reset */
  119. struct delayed_work scan_dwork; /* for async scanning */
  120. /* subdriver information */
  121. void *extra; /* Any extra data */
  122. extra_data_destructor extra_destructor;/* extra data destructor */
  123. #ifdef CONFIG_PM
  124. pm_hook suspend_resume_hook;
  125. #endif
  126. /* hacks for READ CAPACITY bug handling */
  127. int use_last_sector_hacks;
  128. int last_sector_retries;
  129. };
  130. /* Convert between us_data and the corresponding Scsi_Host */
  131. static inline struct Scsi_Host *us_to_host(struct us_data *us) {
  132. return container_of((void *) us, struct Scsi_Host, hostdata);
  133. }
  134. static inline struct us_data *host_to_us(struct Scsi_Host *host) {
  135. return (struct us_data *) host->hostdata;
  136. }
  137. /* Function to fill an inquiry response. See usb.c for details */
  138. extern void fill_inquiry_response(struct us_data *us,
  139. unsigned char *data, unsigned int data_len);
  140. /*
  141. * The scsi_lock() and scsi_unlock() macros protect the sm_state and the
  142. * single queue element srb for write access
  143. */
  144. #define scsi_unlock(host) spin_unlock_irq(host->host_lock)
  145. #define scsi_lock(host) spin_lock_irq(host->host_lock)
  146. /* General routines provided by the usb-storage standard core */
  147. #ifdef CONFIG_PM
  148. extern int usb_stor_suspend(struct usb_interface *iface, pm_message_t message);
  149. extern int usb_stor_resume(struct usb_interface *iface);
  150. extern int usb_stor_reset_resume(struct usb_interface *iface);
  151. #else
  152. #define usb_stor_suspend NULL
  153. #define usb_stor_resume NULL
  154. #define usb_stor_reset_resume NULL
  155. #endif
  156. extern int usb_stor_pre_reset(struct usb_interface *iface);
  157. extern int usb_stor_post_reset(struct usb_interface *iface);
  158. extern int usb_stor_probe1(struct us_data **pus,
  159. struct usb_interface *intf,
  160. const struct usb_device_id *id,
  161. struct us_unusual_dev *unusual_dev,
  162. struct scsi_host_template *sht);
  163. extern int usb_stor_probe2(struct us_data *us);
  164. extern void usb_stor_disconnect(struct usb_interface *intf);
  165. extern void usb_stor_adjust_quirks(struct usb_device *dev,
  166. unsigned long *fflags);
  167. #define module_usb_stor_driver(__driver, __sht, __name) \
  168. static int __init __driver##_init(void) \
  169. { \
  170. usb_stor_host_template_init(&(__sht), __name, THIS_MODULE); \
  171. return usb_register(&(__driver)); \
  172. } \
  173. module_init(__driver##_init); \
  174. static void __exit __driver##_exit(void) \
  175. { \
  176. usb_deregister(&(__driver)); \
  177. } \
  178. module_exit(__driver##_exit)
  179. #endif