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 #ifndef _Device_H_
80 #define _Device_H_
81
82 #include <MsCommon.h>
83 #include "drvOSAPI.h"
84 #include "drvTypes.h"
85 #include "drvList.h"
86 #include "drvPorts.h"
87
88 #define DEVICE_NAME_SIZE 24
89 #define BUS_ID_SIZE 24
90
91 struct device_s;
92
93 struct device_driver {
94 char name[DEVICE_NAME_SIZE];
95 struct ms_bus_type * bus;
96
97 struct list_head bus_list; // driver's bus's drivers list, added by Pliauo
98 struct list_head devices; // driver's devices
99
100 int (*probe) (struct device_s * dev);
101 int (*remove) (struct device_s * dev);
102 };
103
104 // FIXME:
105 struct device_s {
106
107 struct list_head node; // node in device's parent's children list
108 struct list_head bus_list; // node in device's bus's list
109 struct list_head driver_list; // node in device's driver's list
110 struct list_head children; // list of child devices
111
112 struct device_s * parent;
113
114 int dev_refcnt;
115 char dev_name[DEVICE_NAME_SIZE];
116 char bus_id[BUS_ID_SIZE]; // position on parent bus
117
118 struct ms_bus_type * bus_type; // type of device bus
119 struct device_driver *driver; // this device allocated driver
120 void *driver_data;
121
122 cyg_uint64 *dma_mask; // for support dma device
123
124 void (*release_func)(struct device_s * dev);
125 };
126
127 static __inline__ void
ms_dev_set_drvdata(struct device_s * dev,void * data)128 ms_dev_set_drvdata (struct device_s *dev, void *data)
129 {
130 dev->driver_data = data;
131 }
132
133 static __inline__ void *
ms_dev_get_drvdata(struct device_s * dev)134 ms_dev_get_drvdata (struct device_s *dev)
135 {
136 return dev->driver_data;
137 }
138
139 extern void ms_device_initialize(struct device_s *dev);
140
ms_get_device(struct device_s * dev_ptr)141 static __inline__ struct device_s *ms_get_device(struct device_s *dev_ptr)
142 {
143 osapi_atomic_inc(&dev_ptr->dev_refcnt);
144 return dev_ptr;
145 }
146
147 struct usb_device_id {
148 MS_U16 match_id_flags;
149
150 MS_U16 idVendor;
151 MS_U16 idProduct;
152 MS_U16 bcdDevice_lo;
153 MS_U16 bcdDevice_hi;
154
155 MS_U8 bDeviceClass;
156 MS_U8 bDeviceSubClass;
157 MS_U8 bDeviceProtocol;
158
159 MS_U8 bInterfaceClass;
160 MS_U8 bInterfaceSubClass;
161 MS_U8 bInterfaceProtocol;
162
163 MS_U32 match_id_info;
164 };
165
166 struct ms_bus_type {
167 struct list_head drivers_list;
168 struct list_head devices_list;
169
170 int (*match_func)(struct device_s * dev, struct device_driver * drv);
171 };
172
173 #define USBDEV_MATCH_ID_VENDOR 0x0001
174 #define USBDEV_MATCH_ID_PRODUCT 0x0002
175 #define USBDEV_MATCH_ID_DEV_LO 0x0004
176 #define USBDEV_MATCH_ID_DEV_HI 0x0008
177 #define USBDEV_MATCH_ID_DEV_CLASS 0x0010
178 #define USBDEV_MATCH_ID_DEV_SUBCLASS 0x0020
179 #define USBDEV_MATCH_ID_DEV_PROTOCOL 0x0040
180 #define USBDEV_MATCH_ID_INT_CLASS 0x0080
181 #define USBDEV_MATCH_ID_INT_SUBCLASS 0x0100
182 #define USBDEV_MATCH_ID_INT_PROTOCOL 0x0200
183
184 extern int ms_driver_register(struct device_driver * drv);
185 extern void ms_driver_unregister(struct device_driver * drv);
186 extern void ms_device_unregister(struct device_s * dev);
187 extern int ms_device_add(struct device_s *dev);
188 extern int ms_bus_add_device(struct device_s * dev);
189 extern int ms_bus_add_driver(struct device_driver * drv);
190 extern void ms_bus_remove_driver(struct device_driver * drv);
191 extern void ms_bus_remove_device(struct device_s * dev);
192 #endif
193
194