xref: /utopia/UTPA2-700.0.x/modules/usb/drv/usb_ecos/usbhost/drvDriver.c (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1*53ee8cc1Swenshuai.xi //<MStar Software>
2*53ee8cc1Swenshuai.xi //******************************************************************************
3*53ee8cc1Swenshuai.xi // MStar Software
4*53ee8cc1Swenshuai.xi // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5*53ee8cc1Swenshuai.xi // All software, firmware and related documentation herein ("MStar Software") are
6*53ee8cc1Swenshuai.xi // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7*53ee8cc1Swenshuai.xi // law, including, but not limited to, copyright law and international treaties.
8*53ee8cc1Swenshuai.xi // Any use, modification, reproduction, retransmission, or republication of all
9*53ee8cc1Swenshuai.xi // or part of MStar Software is expressly prohibited, unless prior written
10*53ee8cc1Swenshuai.xi // permission has been granted by MStar.
11*53ee8cc1Swenshuai.xi //
12*53ee8cc1Swenshuai.xi // By accessing, browsing and/or using MStar Software, you acknowledge that you
13*53ee8cc1Swenshuai.xi // have read, understood, and agree, to be bound by below terms ("Terms") and to
14*53ee8cc1Swenshuai.xi // comply with all applicable laws and regulations:
15*53ee8cc1Swenshuai.xi //
16*53ee8cc1Swenshuai.xi // 1. MStar shall retain any and all right, ownership and interest to MStar
17*53ee8cc1Swenshuai.xi //    Software and any modification/derivatives thereof.
18*53ee8cc1Swenshuai.xi //    No right, ownership, or interest to MStar Software and any
19*53ee8cc1Swenshuai.xi //    modification/derivatives thereof is transferred to you under Terms.
20*53ee8cc1Swenshuai.xi //
21*53ee8cc1Swenshuai.xi // 2. You understand that MStar Software might include, incorporate or be
22*53ee8cc1Swenshuai.xi //    supplied together with third party`s software and the use of MStar
23*53ee8cc1Swenshuai.xi //    Software may require additional licenses from third parties.
24*53ee8cc1Swenshuai.xi //    Therefore, you hereby agree it is your sole responsibility to separately
25*53ee8cc1Swenshuai.xi //    obtain any and all third party right and license necessary for your use of
26*53ee8cc1Swenshuai.xi //    such third party`s software.
27*53ee8cc1Swenshuai.xi //
28*53ee8cc1Swenshuai.xi // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29*53ee8cc1Swenshuai.xi //    MStar`s confidential information and you agree to keep MStar`s
30*53ee8cc1Swenshuai.xi //    confidential information in strictest confidence and not disclose to any
31*53ee8cc1Swenshuai.xi //    third party.
32*53ee8cc1Swenshuai.xi //
33*53ee8cc1Swenshuai.xi // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34*53ee8cc1Swenshuai.xi //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35*53ee8cc1Swenshuai.xi //    without limitation, any warranties of merchantability, non-infringement of
36*53ee8cc1Swenshuai.xi //    intellectual property rights, fitness for a particular purpose, error free
37*53ee8cc1Swenshuai.xi //    and in conformity with any international standard.  You agree to waive any
38*53ee8cc1Swenshuai.xi //    claim against MStar for any loss, damage, cost or expense that you may
39*53ee8cc1Swenshuai.xi //    incur related to your use of MStar Software.
40*53ee8cc1Swenshuai.xi //    In no event shall MStar be liable for any direct, indirect, incidental or
41*53ee8cc1Swenshuai.xi //    consequential damages, including without limitation, lost of profit or
42*53ee8cc1Swenshuai.xi //    revenues, lost or damage of data, and unauthorized system use.
43*53ee8cc1Swenshuai.xi //    You agree that this Section 4 shall still apply without being affected
44*53ee8cc1Swenshuai.xi //    even if MStar Software has been modified by MStar in accordance with your
45*53ee8cc1Swenshuai.xi //    request or instruction for your use, except otherwise agreed by both
46*53ee8cc1Swenshuai.xi //    parties in writing.
47*53ee8cc1Swenshuai.xi //
48*53ee8cc1Swenshuai.xi // 5. If requested, MStar may from time to time provide technical supports or
49*53ee8cc1Swenshuai.xi //    services in relation with MStar Software to you for your use of
50*53ee8cc1Swenshuai.xi //    MStar Software in conjunction with your or your customer`s product
51*53ee8cc1Swenshuai.xi //    ("Services").
52*53ee8cc1Swenshuai.xi //    You understand and agree that, except otherwise agreed by both parties in
53*53ee8cc1Swenshuai.xi //    writing, Services are provided on an "AS IS" basis and the warranty
54*53ee8cc1Swenshuai.xi //    disclaimer set forth in Section 4 above shall apply.
55*53ee8cc1Swenshuai.xi //
56*53ee8cc1Swenshuai.xi // 6. Nothing contained herein shall be construed as by implication, estoppels
57*53ee8cc1Swenshuai.xi //    or otherwise:
58*53ee8cc1Swenshuai.xi //    (a) conferring any license or right to use MStar name, trademark, service
59*53ee8cc1Swenshuai.xi //        mark, symbol or any other identification;
60*53ee8cc1Swenshuai.xi //    (b) obligating MStar or any of its affiliates to furnish any person,
61*53ee8cc1Swenshuai.xi //        including without limitation, you and your customers, any assistance
62*53ee8cc1Swenshuai.xi //        of any kind whatsoever, or any information; or
63*53ee8cc1Swenshuai.xi //    (c) conferring any license or right under any intellectual property right.
64*53ee8cc1Swenshuai.xi //
65*53ee8cc1Swenshuai.xi // 7. These terms shall be governed by and construed in accordance with the laws
66*53ee8cc1Swenshuai.xi //    of Taiwan, R.O.C., excluding its conflict of law rules.
67*53ee8cc1Swenshuai.xi //    Any and all dispute arising out hereof or related hereto shall be finally
68*53ee8cc1Swenshuai.xi //    settled by arbitration referred to the Chinese Arbitration Association,
69*53ee8cc1Swenshuai.xi //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70*53ee8cc1Swenshuai.xi //    Rules of the Association by three (3) arbitrators appointed in accordance
71*53ee8cc1Swenshuai.xi //    with the said Rules.
72*53ee8cc1Swenshuai.xi //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73*53ee8cc1Swenshuai.xi //    be English.
74*53ee8cc1Swenshuai.xi //    The arbitration award shall be final and binding to both parties.
75*53ee8cc1Swenshuai.xi //
76*53ee8cc1Swenshuai.xi //******************************************************************************
77*53ee8cc1Swenshuai.xi //<MStar Software>
78*53ee8cc1Swenshuai.xi 
79*53ee8cc1Swenshuai.xi 
80*53ee8cc1Swenshuai.xi #undef DEBUG
81*53ee8cc1Swenshuai.xi 
82*53ee8cc1Swenshuai.xi #include <MsCommon.h>
83*53ee8cc1Swenshuai.xi #include "include/drvKernel.h"
84*53ee8cc1Swenshuai.xi #include "drvBase.h"
85*53ee8cc1Swenshuai.xi #include "include/drvDevice.h"
86*53ee8cc1Swenshuai.xi 
87*53ee8cc1Swenshuai.xi /*
88*53ee8cc1Swenshuai.xi #define to_dev(node) container_of(node,struct device,driver_list)
89*53ee8cc1Swenshuai.xi #define to_drv(obj) container_of(obj,struct device_driver,kobj)
90*53ee8cc1Swenshuai.xi */
91*53ee8cc1Swenshuai.xi 
92*53ee8cc1Swenshuai.xi LIST_HEAD(global_driver_list);
93*53ee8cc1Swenshuai.xi 
94*53ee8cc1Swenshuai.xi /**
95*53ee8cc1Swenshuai.xi  *  driver_register - register driver with bus
96*53ee8cc1Swenshuai.xi  *  @drv:  driver to register
97*53ee8cc1Swenshuai.xi  *
98*53ee8cc1Swenshuai.xi  *  We pass off most of the work to the bus_add_driver() call,
99*53ee8cc1Swenshuai.xi  *  since most of the things we have to do deal with the bus
100*53ee8cc1Swenshuai.xi  *  structures.
101*53ee8cc1Swenshuai.xi  *
102*53ee8cc1Swenshuai.xi  *  The one interesting aspect is that we initialize @drv->unload_sem
103*53ee8cc1Swenshuai.xi  *  to a locked state here. It will be unlocked when the driver
104*53ee8cc1Swenshuai.xi  *  reference count reaches 0.
105*53ee8cc1Swenshuai.xi  */
106*53ee8cc1Swenshuai.xi 
107*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
108*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
109*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
110*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
111*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
112*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
113*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
114*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
115*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
116*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
117*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
118*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
119*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
120*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
121*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
122*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
123*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
124*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
125*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
126*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
127*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
128*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
129*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
130*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
131*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
132*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
133*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
134*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
135*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
136*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
137*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
138*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
139*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
140*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
141*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
142*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
143*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
144*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
145*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
146*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
147*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
148*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
149*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
150*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
151*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
152*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
153*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
154*53ee8cc1Swenshuai.xi /*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
driver_register(struct device_driver * m_drv)155*53ee8cc1Swenshuai.xi int driver_register(struct device_driver * m_drv)
156*53ee8cc1Swenshuai.xi {
157*53ee8cc1Swenshuai.xi   INIT_LIST_HEAD(&m_drv->devices);
158*53ee8cc1Swenshuai.xi   init_MUTEX_LOCKED(&m_drv->unload_sem);
159*53ee8cc1Swenshuai.xi   return bus_add_driver(m_drv);
160*53ee8cc1Swenshuai.xi }
161*53ee8cc1Swenshuai.xi 
162*53ee8cc1Swenshuai.xi 
163*53ee8cc1Swenshuai.xi /**
164*53ee8cc1Swenshuai.xi  *  driver_unregister - remove driver from system.
165*53ee8cc1Swenshuai.xi  *  @drv:  driver.
166*53ee8cc1Swenshuai.xi  *
167*53ee8cc1Swenshuai.xi  *  Again, we pass off most of the work to the bus-level call.
168*53ee8cc1Swenshuai.xi  *
169*53ee8cc1Swenshuai.xi  *  Though, once that is done, we attempt to take @drv->unload_sem.
170*53ee8cc1Swenshuai.xi  *  This will block until the driver refcount reaches 0, and it is
171*53ee8cc1Swenshuai.xi  *  released. Only modular drivers will call this function, and we
172*53ee8cc1Swenshuai.xi  *  have to guarantee that it won't complete, letting the driver
173*53ee8cc1Swenshuai.xi  *  unload until all references are gone.
174*53ee8cc1Swenshuai.xi  */
175*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
176*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
177*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
178*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
179*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
180*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
181*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
182*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
183*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
184*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
185*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
186*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
187*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
188*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
189*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
190*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
191*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
192*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
193*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
194*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
195*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
196*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
197*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
198*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
199*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
200*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
201*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
202*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
203*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
204*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
205*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
206*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
207*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
208*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
209*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
210*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
211*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
212*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
213*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
214*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
215*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
216*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
217*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
218*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
219*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
220*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
221*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
222*53ee8cc1Swenshuai.xi 	/*USB HOST USB HOST USB HOST USB HOST USB HOST USB HOST*/
223*53ee8cc1Swenshuai.xi 
driver_unregister(struct device_driver * m_drv)224*53ee8cc1Swenshuai.xi void driver_unregister(struct device_driver * m_drv)
225*53ee8cc1Swenshuai.xi {
226*53ee8cc1Swenshuai.xi   bus_remove_driver(m_drv);
227*53ee8cc1Swenshuai.xi   down(&m_drv->unload_sem);
228*53ee8cc1Swenshuai.xi   up(&m_drv->unload_sem);
229*53ee8cc1Swenshuai.xi }
230*53ee8cc1Swenshuai.xi 
231