/* SPDX-License-Identifier: GPL-2.0-or-later *//* *  V4L2 sub-device support header. * *  Copyright (C) 2008  Hans Verkuil <hverkuil@kernel.org> */ #ifndef _V4L2_SUBDEV_H#define _V4L2_SUBDEV_H #include <linux/types.h>#include <linux/v4l2-subdev.h>#include <media/media-entity.h>#include <media/v4l2-async.h>#include <media/v4l2-common.h>#include <media/v4l2-dev.h>#include <media/v4l2-fh.h>#include <media/v4l2-mediabus.h> /* generic v4l2_device notify callback notification values */#define V4L2_SUBDEV_IR_RX_NOTIFY		_IOW('v', 0, u32)#define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ	0x00000001#define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED	0x00000002#define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN	0x00000004#define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN	0x00000008 #define V4L2_SUBDEV_IR_TX_NOTIFY		_IOW('v', 1, u32)#define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ	0x00000001 #define	V4L2_DEVICE_NOTIFY_EVENT		_IOW('v', 2, struct v4l2_event) struct v4l2_device;struct v4l2_ctrl_handler;struct v4l2_event;struct v4l2_event_subscription;struct v4l2_fh;struct v4l2_subdev;struct v4l2_subdev_fh;struct v4l2_subdev_stream_config;struct tuner_setup;struct v4l2_mbus_frame_desc;struct led_classdev; /** * struct v4l2_decode_vbi_line - used to decode_vbi_line * * @is_second_field: Set to 0 for the first (odd) field; *	set to 1 for the second (even) field. * @p: Pointer to the sliced VBI data from the decoder. On exit, points to *	the start of the payload. * @line: Line number of the sliced VBI data (1-23) * @type: VBI service type (V4L2_SLICED_*). 0 if no service found */struct v4l2_decode_vbi_line {	u32 is_second_field;	u8 *p;	u32 line;	u32 type;}; /* * Sub-devices are devices that are connected somehow to the main bridge * device. These devices are usually audio/video muxers/encoders/decoders or * sensors and webcam controllers. * * Usually these devices are controlled through an i2c bus, but other buses * may also be used. * * The v4l2_subdev struct provides a way of accessing these devices in a * generic manner. Most operations that these sub-devices support fall in * a few categories: core ops, audio ops, video ops and tuner ops. * * More categories can be added if needed, although this should remain a * limited set (no more than approx. 8 categories). * * Each category has its own set of ops that subdev drivers can implement. * * A subdev driver can leave the pointer to the category ops NULL if * it does not implement them (e.g. an audio subdev will generally not * implement the video category ops). The exception is the core category: * this must always be present. * * These ops are all used internally so it is no problem to change, remove * or add ops or move ops from one to another category. Currently these * ops are based on the original ioctls, but since ops are not limited to * one argument there is room for improvement here once all i2c subdev * drivers are converted to use these ops. */ /* * Core ops: it is highly recommended to implement at least these ops: * * log_status * g_register * s_register * * This provides basic debugging support. * * The ioctl ops is meant for generic ioctl-like commands. Depending on * the use-case it might be better to use subdev-specific ops (currently * not yet implemented) since ops provide proper type-checking. */ /** * enum v4l2_subdev_io_pin_bits - Subdevice external IO pin configuration *	bits * * @V4L2_SUBDEV_IO_PIN_DISABLE: disables a pin config. ENABLE assumed. * @V4L2_SUBDEV_IO_PIN_OUTPUT: set it if pin is an output. * @V4L2_SUBDEV_IO_PIN_INPUT: set it if pin is an input. * @V4L2_SUBDEV_IO_PIN_SET_VALUE: to set the output value via *				  &struct v4l2_subdev_io_pin_config->value. * @V4L2_SUBDEV_IO_PIN_ACTIVE_LOW: pin active is bit 0. *				   Otherwise, ACTIVE HIGH is assumed. */enum v4l2_subdev_io_pin_bits {	V4L2_SUBDEV_IO_PIN_DISABLE	= 0,	V4L2_SUBDEV_IO_PIN_OUTPUT	= 1,	V4L2_SUBDEV_IO_PIN_INPUT	= 2,	V4L2_SUBDEV_IO_PIN_SET_VALUE	= 3,	V4L2_SUBDEV_IO_PIN_ACTIVE_LOW	= 4,}; /** * struct v4l2_subdev_io_pin_config - Subdevice external IO pin configuration * * @flags: bitmask with flags for this pin's config, whose bits are defined by *	   &enum v4l2_subdev_io_pin_bits. * @pin: Chip external IO pin to configure * @function: Internal signal pad/function to route to IO pin * @value: Initial value for pin - e.g. GPIO output value * @strength: Pin drive strength */struct v4l2_subdev_io_pin_config {	u32 flags;	u8 pin;	u8 function;	u8 value;	u8 strength;}; /** * struct v4l2_subdev_core_ops - Define core ops callbacks for subdevs * * @log_status: callback for VIDIOC_LOG_STATUS() ioctl handler code. * * @s_io_pin_config: configure one or more chip I/O pins for chips that *	multiplex different internal signal pads out to IO pins.  This function *	takes a pointer to an array of 'n' pin configuration entries, one for *	each pin being configured.  This function could be called at times *	other than just subdevice initialization. * * @init: initialize the sensor registers to some sort of reasonable default *	values. Do not use for new drivers and should be removed in existing *	drivers. * * @load_fw: load firmware. * * @reset: generic reset command. The argument selects which subsystems to *	reset. Passing 0 will always reset the whole chip. Do not use for new *	drivers without discussing this first on the linux-media mailinglist. *	There should be no reason normally to reset a device. * * @s_gpio: set GPIO pins. Very simple right now, might need to be extended with *	a direction argument if needed. * * @command: called by in-kernel drivers in order to call functions internal *	   to subdev drivers driver that have a separate callback. * * @ioctl: called at the end of ioctl() syscall handler at the V4L2 core. *	   used to provide support for private ioctls used on the driver. * * @compat_ioctl32: called when a 32 bits application uses a 64 bits Kernel, *		    in order to fix data passed from/to userspace. * * @g_register: callback for VIDIOC_DBG_G_REGISTER() ioctl handler code. * * @s_register: callback for VIDIOC_DBG_S_REGISTER() ioctl handler code. * * @s_power: puts subdevice in power saving mode (on == 0) or normal operation *	mode (on == 1). DEPRECATED. See *	Documentation/driver-api/media/camera-sensor.rst . pre_streamon and *	post_streamoff callbacks can be used for e.g. setting the bus to LP-11 *	mode before s_stream is called. * * @interrupt_service_routine: Called by the bridge chip's interrupt service *	handler, when an interrupt status has be raised due to this subdev, *	so that this subdev can handle the details.  It may schedule work to be *	performed later.  It must not sleep. **Called from an IRQ context**. * * @subscribe_event: used by the drivers to request the control framework that *		     for it to be warned when the value of a control changes. * * @unsubscribe_event: remove event subscription from the control framework. */struct v4l2_subdev_core_ops {	int (*log_status)(struct v4l2_subdev *sd);	int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n,				      struct v4l2_subdev_io_pin_config *pincfg);	int (*init)(struct v4l2_subdev *sd, u32 val);	int (*load_fw)(struct v4l2_subdev *sd);	int (*reset)(struct v4l2_subdev *sd, u32 val);	int (*s_gpio)(struct v4l2_subdev *sd, u32 val);	long (*command)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);	long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);#ifdef CONFIG_COMPAT	long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd,			       unsigned long arg);#endif#ifdef CONFIG_VIDEO_ADV_DEBUG	int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);	int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg);#endif	int (*s_power)(struct v4l2_subdev *sd, int on);	int (*interrupt_service_routine)(struct v4l2_subdev *sd,						u32 status, bool *handled);	int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,			       struct v4l2_event_subscription *sub);	int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh,				 struct v4l2_event_subscription *sub);}; /** * struct v4l2_subdev_tuner_ops - Callbacks used when v4l device was opened *	in radio mode. * * @standby: puts the tuner in standby mode. It will be woken up *	     automatically the next time it is used. * * @s_radio: callback that switches the tuner to radio mode. *	     drivers should explicitly call it when a tuner ops should *	     operate on radio mode, before being able to handle it. *	     Used on devices that have both AM/FM radio receiver and TV. * * @s_frequency: callback for VIDIOC_S_FREQUENCY() ioctl handler code. * * @g_frequency: callback for VIDIOC_G_FREQUENCY() ioctl handler code. *		 freq->type must be filled in. Normally done by video_ioctl2() *		 or the bridge driver. * * @enum_freq_bands: callback for VIDIOC_ENUM_FREQ_BANDS() ioctl handler code. * * @g_tuner: callback for VIDIOC_G_TUNER() ioctl handler code. * * @s_tuner: callback for VIDIOC_S_TUNER() ioctl handler code. @vt->type must be *	     filled in. Normally done by video_ioctl2 or the *	     bridge driver. * * @g_modulator: callback for VIDIOC_G_MODULATOR() ioctl handler code. * * @s_modulator: callback for VIDIOC_S_MODULATOR() ioctl handler code. * * @s_type_addr: sets tuner type and its I2C addr. * * @s_config: sets tda9887 specific stuff, like port1, port2 and qss * * .. note:: * *	On devices that have both AM/FM and TV, it is up to the driver *	to explicitly call s_radio when the tuner should be switched to *	radio mode, before handling other &struct v4l2_subdev_tuner_ops *	that would require it. An example of such usage is:: * *	  static void s_frequency(void *priv, const struct v4l2_frequency *f) *	  { *		... *		if (f.type == V4L2_TUNER_RADIO) *			v4l2_device_call_all(v4l2_dev, 0, tuner, s_radio); *		... *		v4l2_device_call_all(v4l2_dev, 0, tuner, s_frequency); *	  } */struct v4l2_subdev_tuner_ops {	int (*standby)(struct v4l2_subdev *sd);	int (*s_radio)(struct v4l2_subdev *sd);	int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq);	int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);	int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band);	int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);	int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt);	int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);	int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm);	int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);	int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);}; /** * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings * * @s_clock_freq: set the frequency (in Hz) of the audio clock output. *	Used to slave an audio processor to the video decoder, ensuring that *	audio and video remain synchronized. Usual values for the frequency *	are 48000, 44100 or 32000 Hz. If the frequency is not supported, then *	-EINVAL is returned. * * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard *	way to select I2S clock used by driving digital audio streams at some *	board designs. Usual values for the frequency are 1024000 and 2048000. *	If the frequency is not supported, then %-EINVAL is returned. * * @s_routing: used to define the input and/or output pins of an audio chip, *	and any additional configuration data. *	Never attempt to use user-level input IDs (e.g. Composite, S-Video, *	Tuner) at this level. An i2c device shouldn't know about whether an *	input pin is connected to a Composite connector, become on another *	board or platform it might be connected to something else entirely. *	The calling driver is responsible for mapping a user-level input to *	the right pins on the i2c device. * * @s_stream: used to notify the audio code that stream will start or has *	stopped. */struct v4l2_subdev_audio_ops {	int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);	int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);	int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);	int (*s_stream)(struct v4l2_subdev *sd, int enable);}; /** * struct v4l2_mbus_frame_desc_entry_csi2 * * @vc: CSI-2 virtual channel * @dt: CSI-2 data type ID */struct v4l2_mbus_frame_desc_entry_csi2 {	u8 vc;	u8 dt;}; /** * enum v4l2_mbus_frame_desc_flags - media bus frame description flags * * @V4L2_MBUS_FRAME_DESC_FL_LEN_MAX: *	Indicates that &struct v4l2_mbus_frame_desc_entry->length field *	specifies maximum data length. * @V4L2_MBUS_FRAME_DESC_FL_BLOB: *	Indicates that the format does not have line offsets, i.e. *	the receiver should use 1D DMA. */enum v4l2_mbus_frame_desc_flags {	V4L2_MBUS_FRAME_DESC_FL_LEN_MAX	= BIT(0),	V4L2_MBUS_FRAME_DESC_FL_BLOB	= BIT(1),}; /** * struct v4l2_mbus_frame_desc_entry - media bus frame description structure * * @flags:	bitmask flags, as defined by &enum v4l2_mbus_frame_desc_flags. * @stream:	stream in routing configuration * @pixelcode:	media bus pixel code, valid if @flags *		%FRAME_DESC_FL_BLOB is not set. * @length:	number of octets per frame, valid if @flags *		%V4L2_MBUS_FRAME_DESC_FL_LEN_MAX is set. * @bus:	Bus-specific frame descriptor parameters * @bus.csi2:	CSI-2-specific bus configuration */struct v4l2_mbus_frame_desc_entry {	enum v4l2_mbus_frame_desc_flags flags;	u32 stream;	u32 pixelcode;	u32 length;	union {		struct v4l2_mbus_frame_desc_entry_csi2 csi2;	} bus;};  /*  * If this number is too small, it should be dropped altogether and the  * API switched to a dynamic number of frame descriptor entries.  */#define V4L2_FRAME_DESC_ENTRY_MAX	8 /** * enum v4l2_mbus_frame_desc_type - media bus frame description type * * @V4L2_MBUS_FRAME_DESC_TYPE_UNDEFINED: *	Undefined frame desc type. Drivers should not use this, it is *	for backwards compatibility. * @V4L2_MBUS_FRAME_DESC_TYPE_PARALLEL: *	Parallel media bus. * @V4L2_MBUS_FRAME_DESC_TYPE_CSI2: *	CSI-2 media bus. Frame desc parameters must be set in *	&struct v4l2_mbus_frame_desc_entry->csi2. */enum v4l2_mbus_frame_desc_type {	V4L2_MBUS_FRAME_DESC_TYPE_UNDEFINED = 0,	V4L2_MBUS_FRAME_DESC_TYPE_PARALLEL,	V4L2_MBUS_FRAME_DESC_TYPE_CSI2,}; /** * struct v4l2_mbus_frame_desc - media bus data frame description * @type: type of the bus (enum v4l2_mbus_frame_desc_type) * @entry: frame descriptors array * @num_entries: number of entries in @entry array */struct v4l2_mbus_frame_desc {	enum v4l2_mbus_frame_desc_type type;	struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX];	unsigned short num_entries;}; /** * enum v4l2_subdev_pre_streamon_flags - Flags for pre_streamon subdev core op * * @V4L2_SUBDEV_PRE_STREAMON_FL_MANUAL_LP: Set the transmitter to either LP-11 *	or LP-111 mode before call to s_stream(). */enum v4l2_subdev_pre_streamon_flags {	V4L2_SUBDEV_PRE_STREAMON_FL_MANUAL_LP = BIT(0),}; /** * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened *				  in video mode. * * @s_routing: see s_routing in audio_ops, except this version is for video *	devices. * * @s_crystal_freq: sets the frequency of the crystal used to generate the *	clocks in Hz. An extra flags field allows device specific configuration *	regarding clock frequency dividers, etc. If not used, then set flags *	to 0. If the frequency is not supported, then -EINVAL is returned. * * @g_std: callback for VIDIOC_G_STD() ioctl handler code. * * @s_std: callback for VIDIOC_S_STD() ioctl handler code. * * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by *	video input devices. * * @g_std_output: get current standard for video OUTPUT devices. This is ignored *	by video input devices. * * @querystd: callback for VIDIOC_QUERYSTD() ioctl handler code. * * @g_tvnorms: get &v4l2_std_id with all standards supported by the video *	CAPTURE device. This is ignored by video output devices. * * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video *	OUTPUT device. This is ignored by video capture devices. * * @g_input_status: get input status. Same as the status field in the *	&struct v4l2_input * * @s_stream: start (enabled == 1) or stop (enabled == 0) streaming on the *	sub-device. Failure on stop will remove any resources acquired in *	streaming start, while the error code is still returned by the driver. *	The caller shall track the subdev state, and shall not start or stop an *	already started or stopped subdev. Also see call_s_stream wrapper in *	v4l2-subdev.c. * *	This callback is DEPRECATED. New drivers should instead implement *	&v4l2_subdev_pad_ops.enable_streams and *	&v4l2_subdev_pad_ops.disable_streams operations, and use *	v4l2_subdev_s_stream_helper for the &v4l2_subdev_video_ops.s_stream *	operation to support legacy users. * *	Drivers should also not call the .s_stream() subdev operation directly, *	but use the v4l2_subdev_enable_streams() and *	v4l2_subdev_disable_streams() helpers. * * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev *	can adjust @size to a lower value and must not write more data to the *	buffer starting at @data than the original value of @size. * * @pre_streamon: May be called before streaming is actually started, to help *	initialising the bus. Current usage is to set a CSI-2 transmitter to *	LP-11 or LP-111 mode before streaming. See &enum *	v4l2_subdev_pre_streamon_flags. * *	pre_streamon shall return error if it cannot perform the operation as *	indicated by the flags argument. In particular, -EACCES indicates lack *	of support for the operation. The caller shall call post_streamoff for *	each successful call of pre_streamon. * * @post_streamoff: Called after streaming is stopped, but if and only if *	pre_streamon was called earlier. */struct v4l2_subdev_video_ops {	int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);	int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);	int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm);	int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);	int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);	int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std);	int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);	int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std);	int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std);	int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);	int (*s_stream)(struct v4l2_subdev *sd, int enable);	int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf,			   unsigned int *size);	int (*pre_streamon)(struct v4l2_subdev *sd, u32 flags);	int (*post_streamoff)(struct v4l2_subdev *sd);}; /** * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened

Lines 1–500 of 2054. Load more