xref: /utopia/UTPA2-700.0.x/modules/usb/drv/usb_ecos/newhost/drvBus.c (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 //#include <MsCommon.h> // NUSED
80 //#include "include/drvPorts.h" // NUSED
81 //#include "include/drvConfig.h" // NUSED
82 //#include "include/drvCompiler.h" // NUSED
83 //#include "include/drvList.h" // NUSED
84 #include "include/drvKernel.h"
85 #include "drvUsbHostConfig.h"
86 
87 /**
88      * @brief               binding generic device to driver
89      *
90      * @param           struct device_s * ms_gdev
91      *
92      * @return          none
93      */
ms_device_bind_driver(struct device_s * ms_gdev)94 void ms_device_bind_driver(struct device_s * ms_gdev)
95 {
96     ms_usbhost_debug("bound device '%s' to driver '%s'\n",
97         ms_gdev->bus_id,ms_gdev->driver->name);
98     ms_insert_list_before(&ms_gdev->driver_list,&ms_gdev->driver->devices);
99 }
100 
101 /**
102      * @brief               generic device and driver matching
103      *
104      * @param           struct device_s * ms_gdev
105      * @param           struct device_driver * ms_drv
106      *
107      * @return          error code
108      */
ms_bus_match(struct device_s * ms_gdev,struct device_driver * ms_drv)109 static int ms_bus_match(struct device_s * ms_gdev, struct device_driver * ms_drv)
110 {
111     int ms_err = -ENODEV;
112 
113     // Call BUS provided match function to match device ID witch specific comparing method
114     if (ms_gdev->bus_type->match_func(ms_gdev,ms_drv))
115     {
116         ms_gdev->driver = ms_drv;
117         // Match device ==> call driver's probe function
118         if (ms_drv->probe)
119         {
120             if ((ms_err = ms_drv->probe(ms_gdev)))
121             {
122                 ms_gdev->driver = NULL;
123                 return ms_err;
124             }
125         }
126         ms_device_bind_driver(ms_gdev);
127         ms_err = 0;
128     }
129 
130     return ms_err;
131 }
132 
133 /**
134      * @brief               generic device attaching to bus
135      *
136      * @param           struct device_s * ms_gdev
137      *
138      * @return          error code
139      */
ms_device_attach(struct device_s * ms_gdev)140 static int ms_device_attach(struct device_s * ms_gdev)
141 {
142     struct ms_bus_type * ms_bus = ms_gdev->bus_type;
143     struct list_head * entry;
144     struct device_driver  * ms_drv;
145     struct list_head *_mtr;
146 
147     if (ms_gdev->driver)
148     {
149         ms_device_bind_driver(ms_gdev);
150         return 1;
151     }
152 
153     if (ms_bus->match_func)
154     {
155         list_for_loop(entry,&ms_bus->drivers_list)
156         {
157         _mtr = entry ;
158         ms_drv = (struct device_driver *)((char *)_mtr - (char *)offsetof(struct device_driver, bus_list) );
159         if (!ms_bus_match(ms_gdev,ms_drv))
160             return 1;
161         }
162     }
163 
164     return 0;
165 }
166 
167 /**
168      * @brief               generic driver attaching to bus
169      *
170      * @param           struct device_driver * ms_drv
171      *
172      * @return          none
173      */
ms_driver_attach(struct device_driver * ms_drv)174 void ms_driver_attach(struct device_driver * ms_drv)
175 {
176     struct ms_bus_type * ms_bus = ms_drv->bus;
177     struct list_head * entry;
178     struct device_s * ms_gdev;
179     const struct list_head *_mtr;
180 
181     if (!ms_bus->match_func)
182         return;
183 
184     list_for_loop(entry,&ms_bus->devices_list)
185     {
186         _mtr = entry ;
187         ms_gdev = (struct device_s *)((char *)_mtr - (char *)offsetof(struct device_s, bus_list) );
188         if (!ms_gdev->driver)
189         {
190             ms_bus_match(ms_gdev,ms_drv);
191         }
192     }
193 }
194 
195 /**
196      * @brief               generic device release its driver
197      *
198      * @param           struct device_s * ms_gdev
199      *
200      * @return          none
201      */
ms_device_release_driver(struct device_s * ms_gdev)202 void ms_device_release_driver(struct device_s * ms_gdev)
203 {
204     struct device_driver * ms_drv = ms_gdev->driver;
205 
206     if (ms_drv)
207     {
208         ms_list_remove_and_init(&ms_gdev->driver_list);
209         if (ms_drv->remove)
210             ms_drv->remove(ms_gdev);
211         ms_gdev->driver = NULL;
212     }
213 }
214 
215 /**
216      * @brief               generic driver release its binding device
217      *
218      * @param           struct device_driver * ms_drv
219      *
220      * @return          none
221      */
ms_driver_detach(struct device_driver * ms_drv)222 static void ms_driver_detach(struct device_driver * ms_drv)
223 {
224     struct list_head * entry, * next;
225     struct device_s *ms_gdev;
226     struct list_head *_mptr;
227 
228     list_for_loop_ex(entry,next,&ms_drv->devices)
229     {
230         // struct device * dev = container_of(entry,struct device,driver_list);
231         _mptr = entry;
232         ms_gdev = (struct device_s *)( (char *)_mptr - (char *)offsetof(struct device_s, driver_list) );
233         ms_device_release_driver(ms_gdev);
234     }
235 }
236 
237 /**
238      * @brief               adding generic device to bus
239      *
240      * @param           struct device_s * ms_gdev
241      *
242      * @return          error code
243      */
ms_bus_add_device(struct device_s * ms_gdev)244 int ms_bus_add_device(struct device_s * ms_gdev)
245 {
246     int ms_err = 0;
247 
248     if (ms_gdev->bus_type)
249     {
250         ms_usbhost_debug("bus USB: add device %s\n",ms_gdev->bus_id);
251         ms_insert_list_before(&ms_gdev->bus_list,&ms_gdev->bus_type->devices_list);
252         ms_device_attach(ms_gdev);
253     }
254     return ms_err;
255 }
256 
257 /**
258      * @brief               generic device removing from bus
259      *
260      * @param           struct device_s * ms_gdev
261      *
262      * @return          none
263      */
ms_bus_remove_device(struct device_s * ms_gdev)264 void ms_bus_remove_device(struct device_s * ms_gdev)
265 {
266     if (ms_gdev->bus_type)
267     {
268         ms_usbhost_debug("bus USB: remove device %s\n",ms_gdev->bus_id);
269         ms_device_release_driver(ms_gdev);
270         ms_list_remove_and_init(&ms_gdev->bus_list);
271     }
272 }
273 
274 /**
275      * @brief               adding generic driver to bus
276      *
277      * @param           struct device_driver * ms_drv
278      *
279      * @return          error code
280      */
ms_bus_add_driver(struct device_driver * ms_drv)281 int ms_bus_add_driver(struct device_driver * ms_drv)
282 {
283     struct ms_bus_type * ms_bus = ms_drv->bus;
284     int ms_err = 0;
285 
286     if (ms_bus)
287     {
288         ms_usbhost_debug("bus USB: add driver %s\n",ms_drv->name);
289 
290         // Add driver to bus driver list
291         ms_insert_list_before(&ms_drv->bus_list,&ms_bus->drivers_list);
292         ms_driver_attach(ms_drv);
293     }
294     return ms_err;
295 }
296 
297 /**
298      * @brief               generic driver removing from bus
299      *
300      * @param           struct device_driver * ms_drv
301      *
302      * @return          none
303      */
ms_bus_remove_driver(struct device_driver * ms_drv)304 void ms_bus_remove_driver(struct device_driver * ms_drv)
305 {
306     if (ms_drv->bus)
307     {
308         ms_usbhost_debug("bus USB: remove driver %s\n",ms_drv->name);
309         ms_driver_detach(ms_drv);
310         ms_list_remove_and_init(&ms_drv->bus_list);
311     }
312 }
313 
314