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 #ifndef U16
92 #define U16 MS_U16
93 #endif
94
95
96 struct device_s;
97
98 struct device_driver {
99 char name[DEVICE_NAME_SIZE];
100 struct bus_type * bus;
101
102 struct list_head bus_list; // driver's bus's drivers list, added by Pliauo
103 struct list_head devices; // driver's devices
104
105 int (*probe) (struct device_s * dev);
106 int (*remove) (struct device_s * dev);
107 void (*shutdown) (struct device_s * dev);
108 int (*suspend) (struct device_s * dev, U32 state, U32 level);
109 int (*resume) (struct device_s * dev, U32 level);
110 };
111
112 // FIXME:
113 struct device_s {
114
115 struct list_head node; // node in device's parent's children list
116 struct list_head bus_list; // node in device's bus's list
117 struct list_head driver_list; // Node in device's driver's list
118 struct list_head children; // List of child devices
119
120
121 struct device_s * parent;
122
123 //only reserve refcount in kobj
124 int refcount;
125 char name[DEVICE_NAME_SIZE]; /* descriptive ascii string */
126 char bus_id[BUS_ID_SIZE]; /* position on parent bus */
127
128 struct bus_type * bus; /* type of bus device is on */
129 struct device_driver *driver; /* which driver has allocated this device */
130 void *driver_data; /* data private to the driver */
131
132 unsigned char *saved_state; /* saved device state */
133 cyg_uint64 *dma_mask; /* dma mask (if dma'able device) */
134
135 void (*release)(struct device_s * dev);
136 };
137
138 static __inline__ void
dev_set_drvdata(struct device_s * dev,void * data)139 dev_set_drvdata (struct device_s *dev, void *data)
140 {
141 dev->driver_data = data;
142 }
143
144 static __inline__ void *
dev_get_drvdata(struct device_s * dev)145 dev_get_drvdata (struct device_s *dev)
146 {
147 return dev->driver_data;
148 }
149
150 extern void device_initialize(struct device_s *dev);
151
152 /* debugging and troubleshooting/diagnostic helpers. */
153 #define dev_printk(level, dev, format, ...) \
154 printk(format, __VA_ARGS__)
155
156 #ifdef DEV_DBG
157 #define dev_dbg(dev, format, ...) \
158 dev_printk("KERN_DBG", dev , format , __VA_ARGS__)
159 #else
160 #define dev_dbg(dev, format, ...) do {} while (0)
161 #endif
162
163 #ifdef DEV_ERR
164 #define dev_err(dev, format, ...) \
165 dev_printk("KERN_ERR" , dev , format , __VA_ARGS__)
166 #else
167 #define dev_err(dev, format, ...) do {} while (0)
168 #endif
169
170 #ifdef DEV_INFO
171 #define dev_info(dev, format, ...) \
172 dev_printk("KERN_INFO" , dev , format , __VA_ARGS__)
173 #else
174 #define dev_info(dev, format, ...) do {} while (0)
175 #endif
176
177 #ifdef DEV_WARM
178 #define dev_warn(dev, format, ...) \
179 dev_printk("KERN_WARNING" , dev , format , __VA_ARGS__)
180 #else
181 #define dev_warn(dev, format, ...) do {} while (0)
182 #endif
183
184 //#define get_device(dev_ptr) dev_ptr->refcount++;dev_ptr // Just return the passed pointer back
get_device(struct device_s * dev_ptr)185 static __inline__ struct device_s *get_device(struct device_s *dev_ptr)
186 {
187 atomic_inc(&dev_ptr->refcount);
188 return dev_ptr;
189 }
190 #define put_device(dev_ptr)
191
192
193 struct usb_device_id {
194 /* which fields to match against? */
195 U16 match_flags;
196
197 /* Used for product specific matches; range is inclusive */
198 U16 idVendor;
199 U16 idProduct;
200 U16 bcdDevice_lo;
201 U16 bcdDevice_hi;
202
203 /* Used for device class matches */
204 unsigned char bDeviceClass;
205 unsigned char bDeviceSubClass;
206 unsigned char bDeviceProtocol;
207
208 /* Used for interface class matches */
209 unsigned char bInterfaceClass;
210 unsigned char bInterfaceSubClass;
211 unsigned char bInterfaceProtocol;
212
213 /* not matched against */
214 U32 driver_info;
215 };
216
217 struct bus_type {
218 char name[24];
219
220 struct list_head drivers_list;
221 struct list_head devices_list;
222
223 int (*match)(struct device_s * dev, struct device_driver * drv);
224
225 int (*hotplug) (struct device_s *dev, char **envp,
226 int num_envp, char *buffer, int buffer_size);
227 };
228
229
230 /* Some useful macros to use to create struct usb_device_id */
231 #define USB_DEVICE_ID_MATCH_VENDOR 0x0001
232 #define USB_DEVICE_ID_MATCH_PRODUCT 0x0002
233 #define USB_DEVICE_ID_MATCH_DEV_LO 0x0004
234 #define USB_DEVICE_ID_MATCH_DEV_HI 0x0008
235 #define USB_DEVICE_ID_MATCH_DEV_CLASS 0x0010
236 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS 0x0020
237 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL 0x0040
238 #define USB_DEVICE_ID_MATCH_INT_CLASS 0x0080
239 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS 0x0100
240 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL 0x0200
241
242 extern int driver_register(struct device_driver * drv);
243 extern void driver_unregister(struct device_driver * drv);
244 extern void device_unregister(struct device_s * dev);
245 extern int device_add(struct device_s *dev);
246 extern int bus_register(struct bus_type * bus);
247 extern int bus_add_device(struct device_s * dev);
248 extern int bus_add_driver(struct device_driver * drv);
249 extern void bus_remove_driver(struct device_driver * drv);
250 extern void bus_unregister(struct bus_type * bus);
251 extern void bus_remove_device(struct device_s * dev);
252 #endif
253
254