xref: /utopia/UTPA2-700.0.x/modules/usb/drv/usb_ecos/newhost/drvBulktran.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 _TRANSPORT_H_
81 #define _TRANSPORT_H_
82 
83 //#include <MsTypes.h> // NUSED
84 #include  "include/drvConfig.h"
85 #include "drvMassStor.h"
86 //#include "drvMSC.h" // NUSED
87 
88 /*=========Sub Classes=========*/
89 #define MS_RBC_SC       0x01    /* Typically, flash devices */
90 #define MS_ATAPI_SC     0x02    /* CD-ROM */
91 #define MS_QIC_SC       0x03    /* QIC-157 Tapes */
92 #define MS_UFI_SC       0x04    /* Floppy */
93 #define MS_SFF_SC       0x05    /* Removable media */
94 #define MS_SCSI_SC      0x06    /* Transparent */
95 #define MS_LSD_SC       0x07    /* LSD FS */
96 #define MS_DEVICE_SC    0xff    /* Use device's value */
97 /*=============================*/
98 /*==========Protocols==========*/
99 #define MS_CBI_PR       0x00    /* CBI */
100 #define MS_CB_PR        0x01    /* CB */
101 #define MS_BULK_PR      0x50    /* BOT */
102 #define MS_DEVICE_PR    0xff
103 /*=============================*/
104 
105 struct stBulk_cb
106 {
107     U32 Inscription;
108     U32 Label;
109     U32 DataLength;
110     unsigned char   Flag;
111     unsigned char   Lun;
112     unsigned char   Len;
113     unsigned char   CDB[16];
114 };
115 
116 struct stBulk_cs
117 {
118     U32 Inscription;
119     U32 Label;
120     U32 Remains;
121     unsigned char   Class;
122 };
123 
124 #define BULK_CB_WRAP_LEN    31
125 #define BULK_CB_SIGN        0x43425355
126 #define BULK_CS_WRAP_LEN    13
127 #define BULK_CS_SIGN        0x53425355
128 
129 #define BULK_CS_OLYMPUS_SIGN    0x55425355
130 #define BULK_STAT_OK            0
131 #define BULK_STAT_FAIL          1
132 #define BULK_STAT_PHASE         2
133 
134 #define BULK_RESET_REQUEST  0xff
135 #define BULK_GET_MAX_LUN    0xfe
136 
137 #define XFER_GOOD   0
138 #define XFER_SHORT  1
139 #define XFER_STALLED    2
140 #define XFER_LONG   3
141 #define XFER_ERROR  4
142 #define XFER_NO_DEV    5
143 
144 #define TRANSPORT_GOOD      0
145 #define TRANSPORT_FAILED    1
146 #define TRANSPORT_NO_SENSE  2
147 #define TRANSPORT_ERROR     3
148 #define TRANSPORT_NO_DEVICE  4
149 
150 #define MS_CBI_ADSC     0
151 
152 #if SupportOtherDevice
153 extern void ms_usb_qic157_command(stCmd_scsi*, struct ms_usdata*);
154 extern void ms_usb_ufi_command(stCmd_scsi*, struct ms_usdata*);
155 #endif
156 extern void ms_usb_transparent_scsi_command(stCmd_scsi*, struct ms_usdata*);
157 extern int ms_usb_CB_transport(stCmd_scsi*, struct ms_usdata*);
158 extern int ms_usb_CB_reset(struct ms_usdata*);
159 extern int ms_usb_bulk_transport(stCmd_scsi*, struct ms_usdata*);
160 extern int ms_usb_bulk_reset(struct ms_usdata*);
161 extern void ms_usb_invoke_transport(stCmd_scsi*, struct ms_usdata*);
162 extern int ms_usb_control_msg(struct ms_usdata *ptr, U32 pipe,
163         unsigned char req, unsigned char rt, U16 val, U16 idx, void *data, U16 len, int time_out);
164 extern int ms_usb_msc_clear_halt(struct ms_usdata *ptr, U32 pipe);
165 extern int ms_usb_bulk_transfer_buf(struct ms_usdata *ptr, U32 pipe, void *buf, U32 len, U32 *act_len);
166 #endif
167