xref: /utopia/UTPA2-700.0.x/modules/usb/drv/usb_ecos/newhost/drvMSC.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 //<MStar Software>
78 
79 
80 #ifndef SCSI_H
81 #define SCSI_H
82 
83 #include "include/drvTypes.h"
84 #include <drvUsbcommon.h> // public include
85 
86 #define MAX_COMMAND_SIZE	16
87 #define SCSI_SENSE_BUFFERSIZE    64
88 
89 #define MAX_USTOR  8 // maximux mass storage device per root hub port
90 #define TEST_UNIT_READY         0x00
91 #define REQUEST_SENSE           0x03
92 #define INQUIRY                 0x12
93 #define MODE_SENSE              0x5a
94 #define MODE_SENSE6             0x1a
95 #define READ_CAPACITY           0x25
96 #define READ_10                 0x28
97 #define WRITE_10                0x2a
98 
99 #define TYPE_ROM                0x05
100 #define TYPE_SES                0x0d
101 
102 #define SUCCESS         0x2002
103 #define FAILED          0x2003
104 
105 #define IDENTIFY_BASE       0x80
106 #define IDENTIFY(can_disconnect, lun)   (IDENTIFY_BASE |\
107                 ((can_disconnect) ?  0x40 : 0) |\
108                 ((lun) & 0x07))
109 
110 #define DID_NO_CONNECT  0x01
111 #define DID_BAD_TARGET  0x04
112 #define DID_ABORT       0x05
113 #define DID_ERROR       0x07
114 
115 #define SCSI_DATA_UNKNOWN       0
116 #define SCSI_DATA_WRITE         1
117 #define SCSI_DATA_READ          2
118 #define SCSI_DATA_NONE          3
119 
120 #define MS_STAT_GOOD            0x00
121 #define MS_STAT_CHECK_CONDITION 0x02
122 
123 #define CB_LENGTH_TEST_UNIT_READY   0x06
124 #define CB_LENGTH_REQUEST_SENSE     0x06
125 #define CB_LENGTH_INQUIRY           0x06
126 #define CB_LENGTH_MODE_SENSE        0x06
127 #define CB_LENGTH_READ_CAPACITY     0x0A
128 #define CB_LENGTH_READ_10           0x0A
129 #define CB_LENGTH_WRITE_10          0x0A
130 
131 #define DATA_LENGTH_INQUIRY         36
132 #define DATA_LENGTH_MODE_SENSE      192
133 #define DATA_LENGTH_REQUEST_SENSE   18
134 #define DATA_LENGTH_READ_CAPACITY   8
135 
136 typedef struct ScsiDevice
137 {
138 	// Get by INQUIRY command
139 	unsigned char u8DeviceType;
140 	unsigned char u8VendorID[8];
141 	unsigned char u8ProductID[16];
142 	unsigned char u8ProductVer[4];
143 } Scsi_Device;
144 
145 struct scMsc_cmd
146 {
147     U32 serial_number;
148     unsigned char lun;
149     unsigned char cmd_len;
150     unsigned char sc_data_direction;
151     unsigned char cmnd[MAX_COMMAND_SIZE];
152     U32 req_buf_len;
153     void *req_buf;
154     int resid;
155     unsigned char sense_buffer[SCSI_SENSE_BUFFERSIZE];
156     //U32 flags; // NUSED
157     void (*scsi_done) (struct scMsc_cmd *);
158     int result;
159     //unsigned char tag; // NUSED
160 };
161 
162 typedef struct scMsc_cmd stCmd_scsi;
163 
164 #define MS_MSC_WAIT_MUTEX_TIMEOUT  3000  //3sec
165 
166 //extern BOOL ms_bSCSI_INQUIRY(U8 uPort, unsigned char uLunNum, unsigned char *pIngBuf);
167 //extern BOOL ms_bSCSI_READ_CAPACITY(U8 uPort, unsigned char uLunNum, U32 *pTotalBlks, U32 *pBlkSize);
168 //extern BOOL ms_bSCSI_TEST_UNIT_READY(U8 uPort, unsigned char uLunNum, BOOL CheckCBI);
169 //extern BOOL ms_bInit_USB_Disk(U8 uPort);
170 extern BOOL ms_bSCSI_Read_10(U8 uPort, unsigned char uLunNum, U32 u32BlockAddr, U32 u32BlockNum, unsigned char *u8Buffer);
171 extern BOOL ms_bSCSI_Write_10(U8 uPort, unsigned char uLunNum, U32 u32BlockAddr, U32 u32BlockNum, unsigned char *u8Buffer);
172 //extern BOOL ms_bSCSI_Read_10_512(U8 uPort, unsigned char uLunNum, U32 u32BlockAddr, U32 u32BlockNum, unsigned char *u8Buffer);
173 //extern BOOL ms_bSCSI_Write_10_512(U8 uPort, unsigned char uLunNum, U32 u32BlockAddr, U32 u32BlockNum, unsigned char *u8Buffer);
174 //extern BOOL ms_bIsDevValid(U8 uPort, unsigned char LunNum);
175 //extern unsigned char ms_u8GetDevType(U8 uPort, unsigned char LunNum);
176 //extern void ms_vRemove_DISK_LUNs(U8 uPort); // NUSED
177 extern void ms_MSC_fast_device_disconnect(MS_U8 uDevS, MS_U8 uDevE);
178 extern void ms_MSC_device_inquiry(MS_U8 uDevS, MS_U8 uDevE);
179 
180 #endif
181 
182