1 /*
2 V4L2 sub-device support header.
3
4 Copyright (C) 2008 Hans Verkuil <hverkuil@xs4all.nl>
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
21 #ifndef _V4L2_SUBDEV_H
22 #define _V4L2_SUBDEV_H
23
24 #include <linux/v4l2-subdev.h>
25 #include <media/media-entity.h>
26 #include <media/v4l2-common.h>
27 #include <media/v4l2-dev.h>
28 #include <media/v4l2-fh.h>
29 #include <media/v4l2-mediabus.h>
30
31 /* generic v4l2_device notify callback notification values */
32 #define V4L2_SUBDEV_IR_RX_NOTIFY _IOW('v', 0, u32)
33 #define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ 0x00000001
34 #define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED 0x00000002
35 #define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN 0x00000004
36 #define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN 0x00000008
37
38 #define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32)
39 #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001
40
41 struct v4l2_device;
42 struct v4l2_ctrl_handler;
43 struct v4l2_event_subscription;
44 struct v4l2_fh;
45 struct v4l2_subdev;
46 struct v4l2_subdev_fh;
47 struct tuner_setup;
48
49 /* decode_vbi_line */
50 struct v4l2_decode_vbi_line {
51 u32 is_second_field; /* Set to 0 for the first (odd) field,
52 set to 1 for the second (even) field. */
53 u8 *p; /* Pointer to the sliced VBI data from the decoder.
54 On exit points to the start of the payload. */
55 u32 line; /* Line number of the sliced VBI data (1-23) */
56 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */
57 };
58
59 /* Sub-devices are devices that are connected somehow to the main bridge
60 device. These devices are usually audio/video muxers/encoders/decoders or
61 sensors and webcam controllers.
62
63 Usually these devices are controlled through an i2c bus, but other busses
64 may also be used.
65
66 The v4l2_subdev struct provides a way of accessing these devices in a
67 generic manner. Most operations that these sub-devices support fall in
68 a few categories: core ops, audio ops, video ops and tuner ops.
69
70 More categories can be added if needed, although this should remain a
71 limited set (no more than approx. 8 categories).
72
73 Each category has its own set of ops that subdev drivers can implement.
74
75 A subdev driver can leave the pointer to the category ops NULL if
76 it does not implement them (e.g. an audio subdev will generally not
77 implement the video category ops). The exception is the core category:
78 this must always be present.
79
80 These ops are all used internally so it is no problem to change, remove
81 or add ops or move ops from one to another category. Currently these
82 ops are based on the original ioctls, but since ops are not limited to
83 one argument there is room for improvement here once all i2c subdev
84 drivers are converted to use these ops.
85 */
86
87 /* Core ops: it is highly recommended to implement at least these ops:
88
89 g_chip_ident
90 log_status
91 g_register
92 s_register
93
94 This provides basic debugging support.
95
96 The ioctl ops is meant for generic ioctl-like commands. Depending on
97 the use-case it might be better to use subdev-specific ops (currently
98 not yet implemented) since ops provide proper type-checking.
99 */
100
101 /* Subdevice external IO pin configuration */
102 #define V4L2_SUBDEV_IO_PIN_DISABLE (1 << 0) /* ENABLE assumed */
103 #define V4L2_SUBDEV_IO_PIN_OUTPUT (1 << 1)
104 #define V4L2_SUBDEV_IO_PIN_INPUT (1 << 2)
105 #define V4L2_SUBDEV_IO_PIN_SET_VALUE (1 << 3) /* Set output value */
106 #define V4L2_SUBDEV_IO_PIN_ACTIVE_LOW (1 << 4) /* ACTIVE HIGH assumed */
107
108 struct v4l2_subdev_io_pin_config {
109 u32 flags; /* V4L2_SUBDEV_IO_PIN_* flags for this pin's config */
110 u8 pin; /* Chip external IO pin to configure */
111 u8 function; /* Internal signal pad/function to route to IO pin */
112 u8 value; /* Initial value for pin - e.g. GPIO output value */
113 u8 strength; /* Pin drive strength */
114 };
115
116 /*
117 s_io_pin_config: configure one or more chip I/O pins for chips that
118 multiplex different internal signal pads out to IO pins. This function
119 takes a pointer to an array of 'n' pin configuration entries, one for
120 each pin being configured. This function could be called at times
121 other than just subdevice initialization.
122
123 init: initialize the sensor registors to some sort of reasonable default
124 values. Do not use for new drivers and should be removed in existing
125 drivers.
126
127 load_fw: load firmware.
128
129 reset: generic reset command. The argument selects which subsystems to
130 reset. Passing 0 will always reset the whole chip. Do not use for new
131 drivers without discussing this first on the linux-media mailinglist.
132 There should be no reason normally to reset a device.
133
134 s_gpio: set GPIO pins. Very simple right now, might need to be extended with
135 a direction argument if needed.
136
137 s_power: puts subdevice in power saving mode (on == 0) or normal operation
138 mode (on == 1).
139
140 interrupt_service_routine: Called by the bridge chip's interrupt service
141 handler, when an interrupt status has be raised due to this subdev,
142 so that this subdev can handle the details. It may schedule work to be
143 performed later. It must not sleep. *Called from an IRQ context*.
144 */
145 struct v4l2_subdev_core_ops {
146 int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip);
147 int (*log_status)(struct v4l2_subdev *sd);
148 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,
149 struct v4l2_subdev_io_pin_config *pincfg);
150 int (*init)(struct v4l2_subdev *sd, u32 val);
151 int (*load_fw)(struct v4l2_subdev *sd);
152 int (*reset)(struct v4l2_subdev *sd, u32 val);
153 int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
154 int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
155 int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
156 int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
157 int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
158 int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
159 int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
160 int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
161 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
162 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
163 #ifdef CONFIG_VIDEO_ADV_DEBUG
164 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
165 int (*s_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
166 #endif
167 int (*s_power)(struct v4l2_subdev *sd, int on);
168 int (*interrupt_service_routine)(struct v4l2_subdev *sd,
169 u32 status, bool *handled);
170 int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
171 struct v4l2_event_subscription *sub);
172 int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,
173 struct v4l2_event_subscription *sub);
174 };
175
176 /* s_mode: switch the tuner to a specific tuner mode. Replacement of s_radio.
177
178 s_radio: v4l device was opened in Radio mode, to be replaced by s_mode.
179
180 s_type_addr: sets tuner type and its I2C addr.
181
182 s_config: sets tda9887 specific stuff, like port1, port2 and qss
183 */
184 struct v4l2_subdev_tuner_ops {
185 int (*s_mode)(struct v4l2_subdev *sd, enum v4l2_tuner_type);
186 int (*s_radio)(struct v4l2_subdev *sd);
187 int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
188 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
189 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
190 int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
191 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
192 int (*s_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
193 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
194 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
195 };
196
197 /* s_clock_freq: set the frequency (in Hz) of the audio clock output.
198 Used to slave an audio processor to the video decoder, ensuring that
199 audio and video remain synchronized. Usual values for the frequency
200 are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
201 -EINVAL is returned.
202
203 s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
204 way to select I2S clock used by driving digital audio streams at some
205 board designs. Usual values for the frequency are 1024000 and 2048000.
206 If the frequency is not supported, then -EINVAL is returned.
207
208 s_routing: used to define the input and/or output pins of an audio chip,
209 and any additional configuration data.
210 Never attempt to use user-level input IDs (e.g. Composite, S-Video,
211 Tuner) at this level. An i2c device shouldn't know about whether an
212 input pin is connected to a Composite connector, become on another
213 board or platform it might be connected to something else entirely.
214 The calling driver is responsible for mapping a user-level input to
215 the right pins on the i2c device.
216 */
217 struct v4l2_subdev_audio_ops {
218 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
219 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
220 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
221 int (*s_stream)(struct v4l2_subdev *sd, int enable);
222 };
223
224 /*
225 s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
226 video input devices.
227
228 s_crystal_freq: sets the frequency of the crystal used to generate the
229 clocks in Hz. An extra flags field allows device specific configuration
230 regarding clock frequency dividers, etc. If not used, then set flags
231 to 0. If the frequency is not supported, then -EINVAL is returned.
232
233 g_input_status: get input status. Same as the status field in the v4l2_input
234 struct.
235
236 s_routing: see s_routing in audio_ops, except this version is for video
237 devices.
238
239 s_dv_preset: set dv (Digital Video) preset in the sub device. Similar to
240 s_std()
241
242 query_dv_preset: query dv preset in the sub device. This is similar to
243 querystd()
244
245 s_dv_timings(): Set custom dv timings in the sub device. This is used
246 when sub device is capable of setting detailed timing information
247 in the hardware to generate/detect the video signal.
248
249 g_dv_timings(): Get custom dv timings in the sub device.
250
251 enum_mbus_fmt: enumerate pixel formats, provided by a video data source
252
253 g_mbus_fmt: get the current pixel format, provided by a video data source
254
255 try_mbus_fmt: try to set a pixel format on a video data source
256
257 s_mbus_fmt: set a pixel format on a video data source
258 */
259 struct v4l2_subdev_video_ops {
260 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
261 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
262 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
263 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
264 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
265 int (*s_stream)(struct v4l2_subdev *sd, int enable);
266 int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
267 int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
268 int (*s_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
269 int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
270 int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
271 int (*g_frame_interval)(struct v4l2_subdev *sd,
272 struct v4l2_subdev_frame_interval *interval);
273 int (*s_frame_interval)(struct v4l2_subdev *sd,
274 struct v4l2_subdev_frame_interval *interval);
275 int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize);
276 int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival);
277 int (*enum_dv_presets) (struct v4l2_subdev *sd,
278 struct v4l2_dv_enum_preset *preset);
279 int (*s_dv_preset)(struct v4l2_subdev *sd,
280 struct v4l2_dv_preset *preset);
281 int (*query_dv_preset)(struct v4l2_subdev *sd,
282 struct v4l2_dv_preset *preset);
283 int (*s_dv_timings)(struct v4l2_subdev *sd,
284 struct v4l2_dv_timings *timings);
285 int (*g_dv_timings)(struct v4l2_subdev *sd,
286 struct v4l2_dv_timings *timings);
287 int (*enum_mbus_fmt)(struct v4l2_subdev *sd, unsigned int index,
288 enum v4l2_mbus_pixelcode *code);
289 int (*enum_mbus_fsizes)(struct v4l2_subdev *sd,
290 struct v4l2_frmsizeenum *fsize);
291 int (*g_mbus_fmt)(struct v4l2_subdev *sd,
292 struct v4l2_mbus_framefmt *fmt);
293 int (*try_mbus_fmt)(struct v4l2_subdev *sd,
294 struct v4l2_mbus_framefmt *fmt);
295 int (*s_mbus_fmt)(struct v4l2_subdev *sd,
296 struct v4l2_mbus_framefmt *fmt);
297 };
298
299 /*
300 decode_vbi_line: video decoders that support sliced VBI need to implement
301 this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
302 start of the VBI data that was generated by the decoder. The driver
303 then parses the sliced VBI data and sets the other fields in the
304 struct accordingly. The pointer p is updated to point to the start of
305 the payload which can be copied verbatim into the data field of the
306 v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
307 type field is set to 0 on return.
308
309 s_vbi_data: used to generate VBI signals on a video signal.
310 v4l2_sliced_vbi_data is filled with the data packets that should be
311 output. Note that if you set the line field to 0, then that VBI signal
312 is disabled. If no valid VBI data was found, then the type field is
313 set to 0 on return.
314
315 g_vbi_data: used to obtain the sliced VBI packet from a readback register.
316 Not all video decoders support this. If no data is available because
317 the readback register contains invalid or erroneous data -EIO is
318 returned. Note that you must fill in the 'id' member and the 'field'
319 member (to determine whether CC data from the first or second field
320 should be obtained).
321
322 s_raw_fmt: setup the video encoder/decoder for raw VBI.
323
324 g_sliced_fmt: retrieve the current sliced VBI settings.
325
326 s_sliced_fmt: setup the sliced VBI settings.
327 */
328 struct v4l2_subdev_vbi_ops {
329 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
330 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
331 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
332 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
333 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
334 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
335 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
336 };
337
338 /**
339 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
340 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
341 * This is needed for some sensors, which always corrupt
342 * several top lines of the output image, or which send their
343 * metadata in them.
344 * @g_skip_frames: number of frames to skip at stream start. This is needed for
345 * buggy sensors that generate faulty frames when they are
346 * turned on.
347 */
348 struct v4l2_subdev_sensor_ops {
349 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
350 int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames);
351 };
352
353 /*
354 [rt]x_g_parameters: Get the current operating parameters and state of the
355 the IR receiver or transmitter.
356
357 [rt]x_s_parameters: Set the current operating parameters and state of the
358 the IR receiver or transmitter. It is recommended to call
359 [rt]x_g_parameters first to fill out the current state, and only change
360 the fields that need to be changed. Upon return, the actual device
361 operating parameters and state will be returned. Note that hardware
362 limitations may prevent the actual settings from matching the requested
363 settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
364 was requested. An exception is when the shutdown parameter is true.
365 The last used operational parameters will be returned, but the actual
366 state of the hardware be different to minimize power consumption and
367 processing when shutdown is true.
368
369 rx_read: Reads received codes or pulse width data.
370 The semantics are similar to a non-blocking read() call.
371
372 tx_write: Writes codes or pulse width data for transmission.
373 The semantics are similar to a non-blocking write() call.
374 */
375
376 enum v4l2_subdev_ir_mode {
377 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */
378 };
379
380 struct v4l2_subdev_ir_parameters {
381 /* Either Rx or Tx */
382 unsigned int bytes_per_data_element; /* of data in read or write call */
383 enum v4l2_subdev_ir_mode mode;
384
385 bool enable;
386 bool interrupt_enable;
387 bool shutdown; /* true: set hardware to low/no power, false: normal */
388
389 bool modulation; /* true: uses carrier, false: baseband */
390 u32 max_pulse_width; /* ns, valid only for baseband signal */
391 unsigned int carrier_freq; /* Hz, valid only for modulated signal*/
392 unsigned int duty_cycle; /* percent, valid only for modulated signal*/
393 bool invert_level; /* invert signal level */
394
395 /* Tx only */
396 bool invert_carrier_sense; /* Send 0/space as a carrier burst */
397
398 /* Rx only */
399 u32 noise_filter_min_width; /* ns, min time of a valid pulse */
400 unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
401 unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
402 u32 resolution; /* ns */
403 };
404
405 struct v4l2_subdev_ir_ops {
406 /* Receiver */
407 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
408 ssize_t *num);
409
410 int (*rx_g_parameters)(struct v4l2_subdev *sd,
411 struct v4l2_subdev_ir_parameters *params);
412 int (*rx_s_parameters)(struct v4l2_subdev *sd,
413 struct v4l2_subdev_ir_parameters *params);
414
415 /* Transmitter */
416 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
417 ssize_t *num);
418
419 int (*tx_g_parameters)(struct v4l2_subdev *sd,
420 struct v4l2_subdev_ir_parameters *params);
421 int (*tx_s_parameters)(struct v4l2_subdev *sd,
422 struct v4l2_subdev_ir_parameters *params);
423 };
424
425 struct v4l2_subdev_pad_ops {
426 int (*enum_mbus_code)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
427 struct v4l2_subdev_mbus_code_enum *code);
428 int (*enum_frame_size)(struct v4l2_subdev *sd,
429 struct v4l2_subdev_fh *fh,
430 struct v4l2_subdev_frame_size_enum *fse);
431 int (*enum_frame_interval)(struct v4l2_subdev *sd,
432 struct v4l2_subdev_fh *fh,
433 struct v4l2_subdev_frame_interval_enum *fie);
434 int (*get_fmt)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
435 struct v4l2_subdev_format *format);
436 int (*set_fmt)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
437 struct v4l2_subdev_format *format);
438 int (*set_crop)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
439 struct v4l2_subdev_crop *crop);
440 int (*get_crop)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh,
441 struct v4l2_subdev_crop *crop);
442 };
443
444 struct v4l2_subdev_ops {
445 const struct v4l2_subdev_core_ops *core;
446 const struct v4l2_subdev_tuner_ops *tuner;
447 const struct v4l2_subdev_audio_ops *audio;
448 const struct v4l2_subdev_video_ops *video;
449 const struct v4l2_subdev_vbi_ops *vbi;
450 const struct v4l2_subdev_ir_ops *ir;
451 const struct v4l2_subdev_sensor_ops *sensor;
452 const struct v4l2_subdev_pad_ops *pad;
453 };
454
455 /*
456 * Internal ops. Never call this from drivers, only the v4l2 framework can call
457 * these ops.
458 *
459 * registered: called when this subdev is registered. When called the v4l2_dev
460 * field is set to the correct v4l2_device.
461 *
462 * unregistered: called when this subdev is unregistered. When called the
463 * v4l2_dev field is still set to the correct v4l2_device.
464 *
465 * open: called when the subdev device node is opened by an application.
466 *
467 * close: called when the subdev device node is closed.
468 */
469 struct v4l2_subdev_internal_ops {
470 int (*registered)(struct v4l2_subdev *sd);
471 void (*unregistered)(struct v4l2_subdev *sd);
472 int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
473 int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh);
474 };
475
476 #define V4L2_SUBDEV_NAME_SIZE 32
477
478 /* Set this flag if this subdev is a i2c device. */
479 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
480 /* Set this flag if this subdev is a spi device. */
481 #define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
482 /* Set this flag if this subdev needs a device node. */
483 #define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2)
484 /* Set this flag if this subdev generates events. */
485 #define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3)
486
487 /* Each instance of a subdev driver should create this struct, either
488 stand-alone or embedded in a larger struct.
489 */
490 struct v4l2_subdev {
491 #if defined(CONFIG_MEDIA_CONTROLLER)
492 struct media_entity entity;
493 #endif
494 struct list_head list;
495 struct module *owner;
496 u32 flags;
497 struct v4l2_device *v4l2_dev;
498 const struct v4l2_subdev_ops *ops;
499 /* Never call these internal ops from within a driver! */
500 const struct v4l2_subdev_internal_ops *internal_ops;
501 /* The control handler of this subdev. May be NULL. */
502 struct v4l2_ctrl_handler *ctrl_handler;
503 /* name must be unique */
504 char name[V4L2_SUBDEV_NAME_SIZE];
505 /* can be used to group similar subdevs, value is driver-specific */
506 u32 grp_id;
507 /* pointer to private data */
508 void *dev_priv;
509 void *host_priv;
510 /* subdev device node */
511 struct video_device devnode;
512 /* number of events to be allocated on open */
513 unsigned int nevents;
514 };
515
516 #define media_entity_to_v4l2_subdev(ent) \
517 container_of(ent, struct v4l2_subdev, entity)
518 #define vdev_to_v4l2_subdev(vdev) \
519 container_of(vdev, struct v4l2_subdev, devnode)
520
521 /*
522 * Used for storing subdev information per file handle
523 */
524 struct v4l2_subdev_fh {
525 struct v4l2_fh vfh;
526 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
527 struct v4l2_mbus_framefmt *try_fmt;
528 struct v4l2_rect *try_crop;
529 #endif
530 };
531
532 #define to_v4l2_subdev_fh(fh) \
533 container_of(fh, struct v4l2_subdev_fh, vfh)
534
535 #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
536 static inline struct v4l2_mbus_framefmt *
v4l2_subdev_get_try_format(struct v4l2_subdev_fh * fh,unsigned int pad)537 v4l2_subdev_get_try_format(struct v4l2_subdev_fh *fh, unsigned int pad)
538 {
539 return &fh->try_fmt[pad];
540 }
541
542 static inline struct v4l2_rect *
v4l2_subdev_get_try_crop(struct v4l2_subdev_fh * fh,unsigned int pad)543 v4l2_subdev_get_try_crop(struct v4l2_subdev_fh *fh, unsigned int pad)
544 {
545 return &fh->try_crop[pad];
546 }
547 #endif
548
549 extern const struct v4l2_file_operations v4l2_subdev_fops;
550
v4l2_set_subdevdata(struct v4l2_subdev * sd,void * p)551 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
552 {
553 sd->dev_priv = p;
554 }
555
v4l2_get_subdevdata(const struct v4l2_subdev * sd)556 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
557 {
558 return sd->dev_priv;
559 }
560
v4l2_set_subdev_hostdata(struct v4l2_subdev * sd,void * p)561 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
562 {
563 sd->host_priv = p;
564 }
565
v4l2_get_subdev_hostdata(const struct v4l2_subdev * sd)566 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
567 {
568 return sd->host_priv;
569 }
570
571 void v4l2_subdev_init(struct v4l2_subdev *sd,
572 const struct v4l2_subdev_ops *ops);
573
574 /* Call an ops of a v4l2_subdev, doing the right checks against
575 NULL pointers.
576
577 Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip);
578 */
579 #define v4l2_subdev_call(sd, o, f, args...) \
580 (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \
581 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
582
583 /* Send a notification to v4l2_device. */
584 #define v4l2_subdev_notify(sd, notification, arg) \
585 ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \
586 (sd)->v4l2_dev->notify((sd), (notification), (arg)))
587
588 #endif
589