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