Print this page
2976 remove useless offsetof() macros
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/uts/common/sys/usb/clients/video/usbvc/usbvc_var.h
+++ new/usr/src/uts/common/sys/usb/clients/video/usbvc/usbvc_var.h
1 1 /*
2 2 * CDDL HEADER START
3 3 *
4 4 * The contents of this file are subject to the terms of the
5 5 * Common Development and Distribution License (the "License").
6 6 * You may not use this file except in compliance with the License.
7 7 *
8 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 9 * or http://www.opensolaris.org/os/licensing.
10 10 * See the License for the specific language governing permissions
11 11 * and limitations under the License.
12 12 *
13 13 * When distributing Covered Code, include this CDDL HEADER in each
14 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 15 * If applicable, add the following below this CDDL HEADER, with the
16 16 * fields enclosed by brackets "[]" replaced with your own identifying
17 17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 18 *
19 19 * CDDL HEADER END
20 20 */
21 21 /*
22 22 * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
23 23 * Use is subject to license terms.
24 24 */
↓ open down ↓ |
24 lines elided |
↑ open up ↑ |
25 25
26 26 #ifndef _SYS_USB_USBVC_VAR_H
27 27 #define _SYS_USB_USBVC_VAR_H
28 28
29 29
30 30 #ifdef __cplusplus
31 31 extern "C" {
32 32 #endif
33 33
34 34 #include <sys/list.h>
35 +#include <sys/sysmacros.h>
35 36 #include <sys/usb/usba/usbai_private.h>
36 37 #include <sys/videodev2.h>
37 38 #include <sys/usb/clients/video/usbvc/usbvc.h>
38 39
39 40 typedef struct usbvc_state usbvc_state_t;
40 41
41 42 /*
42 43 * Power Management support
43 44 */
44 45 typedef struct usbvc_power {
45 46
46 47 void *usbvc_state; /* points back to usbvc_state */
47 48 uint8_t usbvc_pwr_states; /* bit mask of device pwr states */
48 49 int usbvc_pm_busy;
49 50
50 51 /* Wakeup and power transistion capabilites of an interface */
51 52 uint8_t usbvc_pm_capabilities;
52 53
53 54 /* flag to indicate if driver is about to raise power level */
54 55 boolean_t usbvc_raise_power;
55 56
56 57 uint8_t usbvc_current_power;
57 58 uint8_t usbvc_wakeup_enabled;
58 59 } usbvc_power_t;
59 60
60 61 /* Raw data buf from the USB cam */
61 62 typedef struct usbvc_buf
62 63 {
63 64 uchar_t *data;
64 65 uint_t len; /* the length of the allocated memory of data */
65 66 uint_t filled; /* number of bytes filled */
66 67 uint_t len_read; /* bytes read */
67 68 uchar_t status; /* empty, filling done, read done */
68 69
69 70 /* cookie used for memory mapping */
70 71 ddi_umem_cookie_t umem_cookie;
71 72 struct v4l2_buffer v4l2_buf;
72 73 list_node_t buf_node; /* list */
73 74 } usbvc_buf_t;
74 75
75 76 /* Group data buf related lists and other elements */
76 77 typedef struct usbvc_buf_grp
77 78 {
78 79 list_t uv_buf_free;
79 80 list_t uv_buf_done;
80 81 usbvc_buf_t *buf_filling;
81 82 uint_t buf_cnt;
82 83 usbvc_buf_t *buf_head;
83 84 } usbvc_buf_grp_t;
84 85
85 86 /*
86 87 * UVC Spec: one format descriptor may be followed by sererval frame
87 88 * descriptors, one still image descriptor and one color matching descriptor.
88 89 * It is called a format group. There might be several format groups follow
89 90 * one input/output header.
90 91 */
91 92 typedef struct usbvc_format_group {
92 93 usbvc_format_descr_t *format;
93 94 usbvc_frames_t *frames;
94 95 uint8_t frame_cnt;
95 96
96 97 /* bytes per pix, used to calculate bytesperline */
97 98 uint8_t v4l2_bpp;
98 99
99 100 uint8_t v4l2_color;
100 101 uint32_t v4l2_pixelformat; /* fcc, pixelformat */
101 102 usbvc_still_image_frame_t *still;
102 103 usbvc_color_matching_descr_t *color;
103 104 usbvc_frames_t *cur_frame;
104 105 } usbvc_format_group_t;
105 106
106 107 /* A stream interface may have several format groups */
107 108 typedef struct usbvc_stream_if {
108 109
109 110 /* The actual format groups we parsed for the stream interface */
110 111 uint8_t fmtgrp_cnt;
111 112
112 113 usb_if_data_t *if_descr;
113 114 usbvc_input_header_t *input_header;
114 115 usbvc_output_header_t *output_header;
115 116 usbvc_format_group_t *format_group;
116 117 usbvc_format_group_t *cur_format_group;
117 118 usbvc_vs_probe_commit_t ctrl_pc;
118 119 usb_ep_descr_t *curr_ep; /* current isoc ep descr */
119 120 usb_pipe_handle_t datain_ph; /* current isoc pipe handle */
120 121 uint_t curr_alt; /* current alternate */
121 122
122 123 /* The max payload that the isoc data EPs can support */
123 124 uint32_t max_isoc_payload;
124 125
125 126 uchar_t start_polling; /* indicate if isoc polling started */
126 127
127 128 /*
128 129 * To flag if VIDIOC_STREAMON is executed, only used by STREAM mode
129 130 * for suspend/resume. If it's non-zero, we'll have to resume the
130 131 * device's isoc polling operation after resume.
131 132 */
132 133 uint8_t stream_on;
133 134
134 135 uchar_t fid; /* the MJPEG FID bit */
135 136 usbvc_buf_grp_t buf_read; /* buf used for read I/O */
136 137 uint8_t buf_read_num; /* desired buf num for read I/O */
137 138 usbvc_buf_grp_t buf_map; /* buf used for mmap I/O */
138 139 list_node_t stream_if_node;
139 140 } usbvc_stream_if_t;
140 141
141 142 /* video interface collection */
142 143 typedef struct usbvc_vic {
143 144
144 145 /* bFirstInterface, the video control infterface num of this VIC */
145 146 uint8_t vctrl_if_num;
146 147
147 148 /*
148 149 * bInterfaceCount -1, the total number of stream interfaces
149 150 * belong to this VIC
150 151 */
151 152 uint8_t vstrm_if_cnt;
152 153 } usbvc_vic_t;
153 154
154 155 /* Macros */
155 156 #define USBVC_OPEN 0x00000001
156 157
157 158 /* For serialization. */
158 159 #define USBVC_SER_NOSIG B_FALSE
159 160 #define USBVC_SER_SIG B_TRUE
160 161
161 162 /*
162 163 * Masks for debug printing
163 164 */
164 165 #define PRINT_MASK_ATTA 0x00000001
165 166 #define PRINT_MASK_OPEN 0x00000002
↓ open down ↓ |
121 lines elided |
↑ open up ↑ |
166 167 #define PRINT_MASK_CLOSE 0x00000004
167 168 #define PRINT_MASK_READ 0x00000008
168 169 #define PRINT_MASK_IOCTL 0x00000010
169 170 #define PRINT_MASK_PM 0x00000020
170 171 #define PRINT_MASK_CB 0x00000040
171 172 #define PRINT_MASK_HOTPLUG 0x00000080
172 173 #define PRINT_MASK_DEVCTRL 0x00000100
173 174 #define PRINT_MASK_DEVMAP 0x00000200
174 175 #define PRINT_MASK_ALL 0xFFFFFFFF
175 176
176 -#define offsetof(s, m) ((size_t)(&(((s *)0)->m)))
177 -
178 177 #define USBVC_MAX_PKTS 40
179 178
180 179 #define USBVC_DEFAULT_READ_BUF_NUM 3
181 180 #define USBVC_MAX_READ_BUF_NUM 40
182 181 #define USBVC_MAX_MAP_BUF_NUM 40
183 182
184 183 /* According to UVC specs, the frame interval is in 100ns unit */
185 184 #define USBVC_FRAME_INTERVAL_DENOMINATOR 10000000
186 185
187 186 /* Only D3...D0 are writable, Table 4-6, UVC Spec */
188 187 #define USBVC_POWER_MODE_MASK 0xf0;
189 188
190 189 enum usbvc_buf_status {
191 190 USBVC_BUF_INIT = 0, /* Allocated, to be queued */
192 191 USBVC_BUF_MAPPED = 1, /* For map I/O only. Memory is mapped. */
193 192 USBVC_BUF_EMPTY = 2, /* not initialized, to be filled */
194 193
195 194 /*
196 195 * buf is filled with a full frame without any errors,
197 196 * it will be moved to full list.
198 197 */
199 198 USBVC_BUF_DONE = 4,
200 199
201 200 /*
202 201 * buf is filled to full but no EOF bit is found at the end
203 202 * of video data
204 203 */
205 204 USBVC_BUF_ERR = 8
206 205 };
207 206
208 207 /*
209 208 * This structure is used to map v4l2 controls to uvc controls. The structure
210 209 * array is addressed by (V4L2_CID_BASE - V4L2_CID_*)
211 210 */
212 211 typedef struct usbvc_v4l2_ctrl_map {
213 212 char name[32];
214 213 uint8_t selector; /* Control Selector */
215 214 uint8_t len; /* wLength, defined in uvc spec chp 4 for each ctrl */
216 215
217 216 /* The xth bit in bmControls bitmap of processing unit descriptor */
218 217 uint8_t bit;
219 218
220 219 enum v4l2_ctrl_type type;
221 220 } usbvc_v4l2_ctrl_map_t;
222 221
223 222 typedef struct usbvc_v4l2_ctrl {
224 223 uint8_t entity_id;
225 224 usbvc_v4l2_ctrl_map_t *ctrl_map;
226 225 } usbvc_v4l2_ctrl_t;
227 226
228 227
229 228 /*
230 229 * State structure
231 230 */
232 231 struct usbvc_state {
233 232 dev_info_t *usbvc_dip; /* per-device info handle */
234 233 usb_client_dev_data_t *usbvc_reg; /* registration data */
235 234 int usbvc_dev_state; /* USB device states. */
236 235 int usbvc_drv_state; /* driver states. */
237 236 kmutex_t usbvc_mutex;
238 237 kcondvar_t usbvc_serial_cv;
239 238 boolean_t usbvc_serial_inuse;
240 239 boolean_t usbvc_locks_initialized;
241 240
242 241 usbvc_power_t *usbvc_pm;
243 242
244 243 usb_log_handle_t usbvc_log_handle; /* log handle */
245 244 usb_pipe_handle_t usbvc_default_ph; /* default pipe */
246 245
247 246 /* Video ctrl interface header descriptor */
248 247 usbvc_vc_header_t *usbvc_vc_header;
249 248 list_t usbvc_term_list;
250 249 list_t usbvc_unit_list;
251 250
252 251 list_t usbvc_stream_list;
253 252 usbvc_stream_if_t *usbvc_curr_strm;
254 253 kcondvar_t usbvc_read_cv; /* wait for read buf done */
255 254 kcondvar_t usbvc_mapio_cv; /* wait for mmap I/O buf done */
256 255
257 256 /* current I/O type: read or mmap. */
258 257 uchar_t usbvc_io_type;
259 258 };
260 259
261 260
262 261 /*
263 262 * Used in ioctl entry to copy an argument from kernel space (arg_name)
264 263 * to USER space (arg)
265 264 */
266 265 #define USBVC_COPYOUT(arg_name) \
267 266 if (ddi_copyout(&arg_name, (caddr_t)arg, sizeof (arg_name), mode)) { \
268 267 rv = EFAULT; \
269 268 break; \
270 269 }
271 270
272 271 /*
273 272 * Used in ioctl entry to copy an argument from USER space (arg) to
274 273 * KERNEL space (arg_name)
275 274 */
276 275 #define USBVC_COPYIN(arg_name) \
277 276 if (ddi_copyin((caddr_t)arg, &arg_name, sizeof (arg_name), mode)) { \
278 277 rv = EFAULT; \
279 278 break; \
280 279 }
281 280
282 281 /* Turn a little endian byte array to a uint32_t */
283 282 #define LE_TO_UINT32(src, off, des) { \
284 283 uint32_t tmp; \
285 284 des = src[off + 3]; \
286 285 des = des << 24; \
287 286 tmp = src[off + 2]; \
288 287 des |= tmp << 16; \
289 288 tmp = src[off + 1]; \
290 289 des |= tmp << 8; \
291 290 des |= src[off]; \
292 291 }
293 292
294 293 /* Turn a uint32_t to a little endian byte array */
295 294 #define UINT32_TO_LE(src, off, des) { \
296 295 des[off + 0] = 0xff & src; \
297 296 des[off + 1] = 0xff & (src >> 8); \
298 297 des[off + 2] = 0xff & (src >> 16); \
299 298 des[off + 3] = 0xff & (src >> 24); \
300 299 }
301 300
302 301 /* Turn a little endian byte array to a uint16_t */
303 302 #define LE_TO_UINT16(src, off, des) \
304 303 des = src[off + 1]; \
305 304 des = des << 8; \
306 305 des |= src[off];
307 306
308 307 /* Turn a uint16_t to alittle endian byte array */
309 308 #define UINT16_TO_LE(src, off, des) { \
310 309 des[off + 0] = 0xff & src; \
311 310 des[off + 1] = 0xff & (src >> 8); \
312 311 }
313 312
314 313 #define NELEM(a) (sizeof (a) / sizeof (*(a)))
315 314
316 315 /* Minimum length of class specific descriptors */
317 316 #define USBVC_C_HEAD_LEN_MIN 12 /* ctrl header */
318 317 #define USBVC_I_TERM_LEN_MIN 8 /* input term */
319 318 #define USBVC_O_TERM_LEN_MIN 9 /* output term */
320 319 #define USBVC_P_UNIT_LEN_MIN 8 /* processing unit */
321 320 #define USBVC_S_UNIT_LEN_MIN 5 /* selector unit */
322 321 #define USBVC_E_UNIT_LEN_MIN 22 /* extension unit */
323 322 #define USBVC_FRAME_LEN_MIN 26 /* Frame descriptor */
324 323
325 324 /* Length of the Frame descriptor which has continuous frame intervals */
326 325 #define USBVC_FRAME_LEN_CON 38
327 326
328 327
329 328 /*
330 329 * According to usb2.0 spec (table 9-13), for all ep, bits 10..0 specify the
331 330 * max pkt size; for high speed ep, bits 12..11 specify the number of
332 331 * additional transaction opportunities per microframe.
333 332 */
334 333 #define HS_PKT_SIZE(pktsize) (pktsize & 0x07ff) * (1 + ((pktsize >> 11) & 3))
335 334
336 335 /*
337 336 * warlock directives
338 337 * _NOTE is an advice for locklint. Locklint checks lock use for deadlocks.
339 338 */
340 339 _NOTE(MUTEX_PROTECTS_DATA(usbvc_state_t::usbvc_mutex, usbvc_state_t))
341 340 _NOTE(DATA_READABLE_WITHOUT_LOCK(usbvc_state_t::{
342 341 usbvc_dip
343 342 usbvc_pm
344 343 usbvc_log_handle
345 344 usbvc_reg
346 345 usbvc_default_ph
347 346 usbvc_vc_header
348 347 usbvc_term_list
349 348 usbvc_unit_list
350 349 usbvc_stream_list
351 350 }))
352 351
353 352 _NOTE(SCHEME_PROTECTS_DATA("stable data", usb_pipe_policy))
354 353 _NOTE(SCHEME_PROTECTS_DATA("USBA", usbvc_stream_if::datain_ph))
355 354 _NOTE(SCHEME_PROTECTS_DATA("USBA", usbvc_stream_if::curr_alt))
356 355 _NOTE(SCHEME_PROTECTS_DATA("USBA", usbvc_stream_if::curr_ep))
357 356 _NOTE(SCHEME_PROTECTS_DATA("unshared data", usbvc_buf::umem_cookie))
358 357 _NOTE(SCHEME_PROTECTS_DATA("unshared data", usbvc_buf::data))
359 358 _NOTE(SCHEME_PROTECTS_DATA("unshared data", usbvc_v4l2_ctrl))
360 359 _NOTE(SCHEME_PROTECTS_DATA("unshared data", usbvc_v4l2_ctrl_map))
361 360 _NOTE(SCHEME_PROTECTS_DATA("unshared data", mblk_t))
362 361 _NOTE(SCHEME_PROTECTS_DATA("unshared data", buf))
363 362 _NOTE(SCHEME_PROTECTS_DATA("unshared data", usb_isoc_req))
364 363 _NOTE(SCHEME_PROTECTS_DATA("unshared data", v4l2_queryctrl))
365 364 _NOTE(SCHEME_PROTECTS_DATA("unshared data", v4l2_format))
366 365 _NOTE(SCHEME_PROTECTS_DATA("unshared data", v4l2_control))
367 366 _NOTE(SCHEME_PROTECTS_DATA("unshared data", v4l2_streamparm))
368 367
369 368 int usbvc_open_isoc_pipe(usbvc_state_t *, usbvc_stream_if_t *);
370 369 int usbvc_start_isoc_polling(usbvc_state_t *, usbvc_stream_if_t *, uchar_t);
371 370 int usbvc_vc_set_ctrl(usbvc_state_t *, uint8_t, uint8_t,
372 371 uint16_t, uint16_t, mblk_t *);
373 372 int usbvc_vc_get_ctrl(usbvc_state_t *, uint8_t, uint8_t,
374 373 uint16_t, uint16_t, mblk_t *);
375 374 int usbvc_vs_set_probe_commit(usbvc_state_t *, usbvc_stream_if_t *,
376 375 usbvc_vs_probe_commit_t *, uchar_t);
377 376 void usbvc_free_map_bufs(usbvc_state_t *, usbvc_stream_if_t *);
378 377 int usbvc_alloc_map_bufs(usbvc_state_t *, usbvc_stream_if_t *, int, int);
379 378 int usbvc_vs_get_probe(usbvc_state_t *, usbvc_stream_if_t *,
380 379 usbvc_vs_probe_commit_t *, uchar_t);
381 380
382 381 /* Functions specific for V4L2 API */
383 382 uint8_t usbvc_v4l2_colorspace(uint8_t);
384 383 uint32_t usbvc_v4l2_guid2fcc(uint8_t *);
385 384 int usbvc_v4l2_ioctl(usbvc_state_t *, int, intptr_t, int);
386 385
387 386
388 387 #ifdef __cplusplus
389 388 }
390 389 #endif
391 390
392 391 #endif /* _SYS_USB_USBVC_VAR_H */
↓ open down ↓ |
205 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX