| NUC472_NUC442_BSP V3.04.000 The Board Support Package for NUC472/NUC442

UmasProtocol.h
Go to the documentation of this file.
1/* Driver for USB Mass Storage compliant devices
2 * Protocol Functions Header File
3 *
4 * $Id: protocol.h,v 1.3 2000/08/25 00:13:51 mdharm Exp $
5 *
6 * Current development and maintenance by:
7 * (c) 1999, 2000 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
8 *
9 * This driver is based on the 'USB Mass Storage Class' document. This
10 * describes in detail the protocol used to communicate with such
11 * devices. Clearly, the designers had SCSI and ATAPI commands in
12 * mind when they created this document. The commands are all very
13 * similar to commands in the SCSI-II and ATAPI specifications.
14 *
15 * It is important to note that in a number of cases this class
16 * exhibits class-specific exemptions from the USB specification.
17 * Notably the usage of NAK, STALL and ACK differs from the norm, in
18 * that they are used to communicate wait, failed and OK on commands.
19 *
20 * Also, for certain devices, the interrupt endpoint is used to convey
21 * status of a command.
22 *
23 * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
24 * information about this driver.
25 *
26 * This program is free software; you can redistribute it and/or modify it
27 * under the terms of the GNU General Public License as published by the
28 * Free Software Foundation; either version 2, or (at your option) any
29 * later version.
30 *
31 * This program is distributed in the hope that it will be useful, but
32 * WITHOUT ANY WARRANTY; without even the implied warranty of
33 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
34 * General Public License for more details.
35 *
36 * You should have received a copy of the GNU General Public License along
37 * with this program; if not, write to the Free Software Foundation, Inc.,
38 * 675 Mass Ave, Cambridge, MA 02139, USA.
39 */
40
41#ifndef _UMAS_PROTOCOL_H_
42#define _UMAS_PROTOCOL_H_
43
45
46/* Sub Classes */
47#define UMAS_SC_RBC 0x01 /* Typically, flash devices */
48#define UMAS_SC_8020 0x02 /* CD-ROM */
49#define UMAS_SC_QIC 0x03 /* QIC-157 Tapes */
50#define UMAS_SC_UFI 0x04 /* Floppy */
51#define UMAS_SC_8070 0x05 /* Removable media */
52#define UMAS_SC_SCSI 0x06 /* Transparent */
53#define UMAS_SC_MIN UMAS_SC_RBC
54#define UMAS_SC_MAX UMAS_SC_SCSI
55
56
57#define USB_STOR_SCSI_SENSE_HDRSZ 4
58#define USB_STOR_SCSI_SENSE_10_HDRSZ 8
59
60
61struct usb_stor_scsi_sense_hdr
62{
63 uint8_t *dataLength;
64 uint8_t *mediumType;
65 uint8_t *devSpecParms;
66 uint8_t *blkDescLength;
67};
68
69typedef struct usb_stor_scsi_sense_hdr Usb_Stor_Scsi_Sense_Hdr;
70
71union usb_stor_scsi_sense_hdr_u
72{
73 Usb_Stor_Scsi_Sense_Hdr hdr;
74 uint8_t *array[USB_STOR_SCSI_SENSE_HDRSZ];
75};
76
77
78typedef union usb_stor_scsi_sense_hdr_u Usb_Stor_Scsi_Sense_Hdr_u;
79
80struct usb_stor_scsi_sense_hdr_10
81{
82 uint8_t *dataLengthMSB;
83 uint8_t *dataLengthLSB;
84 uint8_t *mediumType;
85 uint8_t *devSpecParms;
86 uint8_t *reserved1;
87 uint8_t *reserved2;
88 uint8_t *blkDescLengthMSB;
89 uint8_t *blkDescLengthLSB;
90};
91
92typedef struct usb_stor_scsi_sense_hdr_10 Usb_Stor_Scsi_Sense_Hdr_10;
93
94union usb_stor_scsi_sense_hdr_10_u
95{
96 Usb_Stor_Scsi_Sense_Hdr_10 hdr;
97 uint8_t *array[USB_STOR_SCSI_SENSE_10_HDRSZ];
98};
99
100typedef union usb_stor_scsi_sense_hdr_10_u Usb_Stor_Scsi_Sense_Hdr_10_u;
101
102
103/*===================================================== Exported Functions ==*/
104extern void UMAS_AtapiCommand(SCSI_CMD_T *srb, UMAS_DATA_T *umas);
105extern void UMAS_Qic157Command(SCSI_CMD_T *srb, UMAS_DATA_T *umas);
106extern void UMAS_UfiCommand(SCSI_CMD_T *srb, UMAS_DATA_T *umas);
107extern void UMAS_TransparentScsiCommand(SCSI_CMD_T *srb, UMAS_DATA_T *umas);
108
110
111#endif /* _UMAS_PROTOCOL_H_ */