xref: /OK3568_Linux_fs/kernel/drivers/usb/storage/protocol.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0+ */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Driver for USB Mass Storage compliant devices
4*4882a593Smuzhiyun  * Protocol Functions Header File
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Current development and maintenance by:
7*4882a593Smuzhiyun  *   (c) 1999, 2000 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * This driver is based on the 'USB Mass Storage Class' document. This
10*4882a593Smuzhiyun  * describes in detail the protocol used to communicate with such
11*4882a593Smuzhiyun  * devices.  Clearly, the designers had SCSI and ATAPI commands in
12*4882a593Smuzhiyun  * mind when they created this document.  The commands are all very
13*4882a593Smuzhiyun  * similar to commands in the SCSI-II and ATAPI specifications.
14*4882a593Smuzhiyun  *
15*4882a593Smuzhiyun  * It is important to note that in a number of cases this class
16*4882a593Smuzhiyun  * exhibits class-specific exemptions from the USB specification.
17*4882a593Smuzhiyun  * Notably the usage of NAK, STALL and ACK differs from the norm, in
18*4882a593Smuzhiyun  * that they are used to communicate wait, failed and OK on commands.
19*4882a593Smuzhiyun  *
20*4882a593Smuzhiyun  * Also, for certain devices, the interrupt endpoint is used to convey
21*4882a593Smuzhiyun  * status of a command.
22*4882a593Smuzhiyun  */
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun #ifndef _PROTOCOL_H_
25*4882a593Smuzhiyun #define _PROTOCOL_H_
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun /* Protocol handling routines */
28*4882a593Smuzhiyun extern void usb_stor_pad12_command(struct scsi_cmnd*, struct us_data*);
29*4882a593Smuzhiyun extern void usb_stor_ufi_command(struct scsi_cmnd*, struct us_data*);
30*4882a593Smuzhiyun extern void usb_stor_transparent_scsi_command(struct scsi_cmnd*,
31*4882a593Smuzhiyun 		struct us_data*);
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun /* struct scsi_cmnd transfer buffer access utilities */
34*4882a593Smuzhiyun enum xfer_buf_dir	{TO_XFER_BUF, FROM_XFER_BUF};
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun extern unsigned int usb_stor_access_xfer_buf(unsigned char *buffer,
37*4882a593Smuzhiyun 	unsigned int buflen, struct scsi_cmnd *srb, struct scatterlist **,
38*4882a593Smuzhiyun 	unsigned int *offset, enum xfer_buf_dir dir);
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun extern void usb_stor_set_xfer_buf(unsigned char *buffer,
41*4882a593Smuzhiyun 	unsigned int buflen, struct scsi_cmnd *srb);
42*4882a593Smuzhiyun #endif
43