11a59d1b8SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */
22a1fcdf0SHans Verkuil /*
32a1fcdf0SHans Verkuil V4L2 device support header.
42a1fcdf0SHans Verkuil
52a1fcdf0SHans Verkuil Copyright (C) 2008 Hans Verkuil <hverkuil@xs4all.nl>
62a1fcdf0SHans Verkuil
72a1fcdf0SHans Verkuil */
82a1fcdf0SHans Verkuil
92a1fcdf0SHans Verkuil #ifndef _V4L2_DEVICE_H
102a1fcdf0SHans Verkuil #define _V4L2_DEVICE_H
112a1fcdf0SHans Verkuil
1295db3a60SLaurent Pinchart #include <media/media-device.h>
132a1fcdf0SHans Verkuil #include <media/v4l2-subdev.h>
140f62fd6aSHans Verkuil #include <media/v4l2-dev.h>
152a1fcdf0SHans Verkuil
161351a58cSKay Sievers #define V4L2_DEVICE_NAME_SIZE (20 + 16)
172a1fcdf0SHans Verkuil
180996517cSHans Verkuil struct v4l2_ctrl_handler;
190996517cSHans Verkuil
20575f9308SMauro Carvalho Chehab /**
21575f9308SMauro Carvalho Chehab * struct v4l2_device - main struct to for V4L2 device drivers
22575f9308SMauro Carvalho Chehab *
23575f9308SMauro Carvalho Chehab * @dev: pointer to struct device.
24acd14c18SHans Verkuil * @mdev: pointer to struct media_device, may be NULL.
25575f9308SMauro Carvalho Chehab * @subdevs: used to keep track of the registered subdevs
26575f9308SMauro Carvalho Chehab * @lock: lock this struct; can be used by the driver as well
27575f9308SMauro Carvalho Chehab * if this struct is embedded into a larger struct.
28575f9308SMauro Carvalho Chehab * @name: unique device name, by default the driver name + bus ID
29d651ff91SMauro Carvalho Chehab * @notify: notify operation called by some sub-devices.
3065d7aba0SMauro Carvalho Chehab * @ctrl_handler: The control handler. May be %NULL.
31575f9308SMauro Carvalho Chehab * @prio: Device's priority state
32575f9308SMauro Carvalho Chehab * @ref: Keep track of the references to this struct.
33575f9308SMauro Carvalho Chehab * @release: Release function that is called when the ref count
34575f9308SMauro Carvalho Chehab * goes to 0.
35575f9308SMauro Carvalho Chehab *
36575f9308SMauro Carvalho Chehab * Each instance of a V4L2 device should create the v4l2_device struct,
37575f9308SMauro Carvalho Chehab * either stand-alone or embedded in a larger struct.
38575f9308SMauro Carvalho Chehab *
39575f9308SMauro Carvalho Chehab * It allows easy access to sub-devices (see v4l2-subdev.h) and provides
40575f9308SMauro Carvalho Chehab * basic V4L2 device-level support.
41575f9308SMauro Carvalho Chehab *
42575f9308SMauro Carvalho Chehab * .. note::
43575f9308SMauro Carvalho Chehab *
4465d7aba0SMauro Carvalho Chehab * #) @dev->driver_data points to this struct.
4565d7aba0SMauro Carvalho Chehab * #) @dev might be %NULL if there is no parent device
46575f9308SMauro Carvalho Chehab */
472a1fcdf0SHans Verkuil struct v4l2_device {
482a1fcdf0SHans Verkuil struct device *dev;
4995db3a60SLaurent Pinchart struct media_device *mdev;
502a1fcdf0SHans Verkuil struct list_head subdevs;
512a1fcdf0SHans Verkuil spinlock_t lock;
522a1fcdf0SHans Verkuil char name[V4L2_DEVICE_NAME_SIZE];
5398ec6339SHans Verkuil void (*notify)(struct v4l2_subdev *sd,
5498ec6339SHans Verkuil unsigned int notification, void *arg);
550996517cSHans Verkuil struct v4l2_ctrl_handler *ctrl_handler;
560f62fd6aSHans Verkuil struct v4l2_prio_state prio;
57bedf8bcfSHans Verkuil struct kref ref;
58bedf8bcfSHans Verkuil void (*release)(struct v4l2_device *v4l2_dev);
592a1fcdf0SHans Verkuil };
602a1fcdf0SHans Verkuil
61575f9308SMauro Carvalho Chehab /**
62575f9308SMauro Carvalho Chehab * v4l2_device_get - gets a V4L2 device reference
63575f9308SMauro Carvalho Chehab *
6465d7aba0SMauro Carvalho Chehab * @v4l2_dev: pointer to struct &v4l2_device
65575f9308SMauro Carvalho Chehab *
66575f9308SMauro Carvalho Chehab * This is an ancillary routine meant to increment the usage for the
6765d7aba0SMauro Carvalho Chehab * struct &v4l2_device pointed by @v4l2_dev.
68575f9308SMauro Carvalho Chehab */
v4l2_device_get(struct v4l2_device * v4l2_dev)69bedf8bcfSHans Verkuil static inline void v4l2_device_get(struct v4l2_device *v4l2_dev)
70bedf8bcfSHans Verkuil {
71bedf8bcfSHans Verkuil kref_get(&v4l2_dev->ref);
72bedf8bcfSHans Verkuil }
73bedf8bcfSHans Verkuil
74575f9308SMauro Carvalho Chehab /**
75b95182a6SHans Verkuil * v4l2_device_put - puts a V4L2 device reference
76575f9308SMauro Carvalho Chehab *
7765d7aba0SMauro Carvalho Chehab * @v4l2_dev: pointer to struct &v4l2_device
78575f9308SMauro Carvalho Chehab *
79575f9308SMauro Carvalho Chehab * This is an ancillary routine meant to decrement the usage for the
8065d7aba0SMauro Carvalho Chehab * struct &v4l2_device pointed by @v4l2_dev.
81575f9308SMauro Carvalho Chehab */
82bedf8bcfSHans Verkuil int v4l2_device_put(struct v4l2_device *v4l2_dev);
83bedf8bcfSHans Verkuil
84575f9308SMauro Carvalho Chehab /**
8565d7aba0SMauro Carvalho Chehab * v4l2_device_register - Initialize v4l2_dev and make @dev->driver_data
8665d7aba0SMauro Carvalho Chehab * point to @v4l2_dev.
87575f9308SMauro Carvalho Chehab *
8865d7aba0SMauro Carvalho Chehab * @dev: pointer to struct &device
8965d7aba0SMauro Carvalho Chehab * @v4l2_dev: pointer to struct &v4l2_device
90575f9308SMauro Carvalho Chehab *
91575f9308SMauro Carvalho Chehab * .. note::
9265d7aba0SMauro Carvalho Chehab * @dev may be %NULL in rare cases (ISA devices).
9365d7aba0SMauro Carvalho Chehab * In such case the caller must fill in the @v4l2_dev->name field
94575f9308SMauro Carvalho Chehab * before calling this function.
95575f9308SMauro Carvalho Chehab */
96575f9308SMauro Carvalho Chehab int __must_check v4l2_device_register(struct device *dev,
97575f9308SMauro Carvalho Chehab struct v4l2_device *v4l2_dev);
98102e7813SHans Verkuil
99575f9308SMauro Carvalho Chehab /**
100575f9308SMauro Carvalho Chehab * v4l2_device_set_name - Optional function to initialize the
10165d7aba0SMauro Carvalho Chehab * name field of struct &v4l2_device
102575f9308SMauro Carvalho Chehab *
10365d7aba0SMauro Carvalho Chehab * @v4l2_dev: pointer to struct &v4l2_device
104575f9308SMauro Carvalho Chehab * @basename: base name for the device name
105575f9308SMauro Carvalho Chehab * @instance: pointer to a static atomic_t var with the instance usage for
106575f9308SMauro Carvalho Chehab * the device driver.
107575f9308SMauro Carvalho Chehab *
10865d7aba0SMauro Carvalho Chehab * v4l2_device_set_name() initializes the name field of struct &v4l2_device
109575f9308SMauro Carvalho Chehab * using the driver name and a driver-global atomic_t instance.
110575f9308SMauro Carvalho Chehab *
111575f9308SMauro Carvalho Chehab * This function will increment the instance counter and returns the
112575f9308SMauro Carvalho Chehab * instance value used in the name.
113575f9308SMauro Carvalho Chehab *
114575f9308SMauro Carvalho Chehab * Example:
115575f9308SMauro Carvalho Chehab *
116575f9308SMauro Carvalho Chehab * static atomic_t drv_instance = ATOMIC_INIT(0);
117575f9308SMauro Carvalho Chehab *
118575f9308SMauro Carvalho Chehab * ...
119575f9308SMauro Carvalho Chehab *
12065d7aba0SMauro Carvalho Chehab * instance = v4l2_device_set_name(&\ v4l2_dev, "foo", &\ drv_instance);
121575f9308SMauro Carvalho Chehab *
122575f9308SMauro Carvalho Chehab * The first time this is called the name field will be set to foo0 and
123575f9308SMauro Carvalho Chehab * this function returns 0. If the name ends with a digit (e.g. cx18),
124575f9308SMauro Carvalho Chehab * then the name will be set to cx18-0 since cx180 would look really odd.
125575f9308SMauro Carvalho Chehab */
126102e7813SHans Verkuil int v4l2_device_set_name(struct v4l2_device *v4l2_dev, const char *basename,
127102e7813SHans Verkuil atomic_t *instance);
128102e7813SHans Verkuil
129575f9308SMauro Carvalho Chehab /**
130575f9308SMauro Carvalho Chehab * v4l2_device_disconnect - Change V4L2 device state to disconnected.
131575f9308SMauro Carvalho Chehab *
132575f9308SMauro Carvalho Chehab * @v4l2_dev: pointer to struct v4l2_device
133575f9308SMauro Carvalho Chehab *
134575f9308SMauro Carvalho Chehab * Should be called when the USB parent disconnects.
13565d7aba0SMauro Carvalho Chehab * Since the parent disappears, this ensures that @v4l2_dev doesn't have
136575f9308SMauro Carvalho Chehab * an invalid parent pointer.
137575f9308SMauro Carvalho Chehab *
13865d7aba0SMauro Carvalho Chehab * .. note:: This function sets @v4l2_dev->dev to NULL.
139575f9308SMauro Carvalho Chehab */
140ae6cfaacSHans Verkuil void v4l2_device_disconnect(struct v4l2_device *v4l2_dev);
141102e7813SHans Verkuil
142575f9308SMauro Carvalho Chehab /**
143575f9308SMauro Carvalho Chehab * v4l2_device_unregister - Unregister all sub-devices and any other
14465d7aba0SMauro Carvalho Chehab * resources related to @v4l2_dev.
145575f9308SMauro Carvalho Chehab *
146575f9308SMauro Carvalho Chehab * @v4l2_dev: pointer to struct v4l2_device
147575f9308SMauro Carvalho Chehab */
1482a1fcdf0SHans Verkuil void v4l2_device_unregister(struct v4l2_device *v4l2_dev);
1492a1fcdf0SHans Verkuil
150575f9308SMauro Carvalho Chehab /**
151575f9308SMauro Carvalho Chehab * v4l2_device_register_subdev - Registers a subdev with a v4l2 device.
152575f9308SMauro Carvalho Chehab *
15365d7aba0SMauro Carvalho Chehab * @v4l2_dev: pointer to struct &v4l2_device
154d651ff91SMauro Carvalho Chehab * @sd: pointer to &struct v4l2_subdev
155575f9308SMauro Carvalho Chehab *
156575f9308SMauro Carvalho Chehab * While registered, the subdev module is marked as in-use.
157575f9308SMauro Carvalho Chehab *
158575f9308SMauro Carvalho Chehab * An error is returned if the module is no longer loaded on any attempts
159575f9308SMauro Carvalho Chehab * to register it.
160575f9308SMauro Carvalho Chehab */
1613a63e449SHans Verkuil int __must_check v4l2_device_register_subdev(struct v4l2_device *v4l2_dev,
1623a63e449SHans Verkuil struct v4l2_subdev *sd);
163575f9308SMauro Carvalho Chehab
164575f9308SMauro Carvalho Chehab /**
165575f9308SMauro Carvalho Chehab * v4l2_device_unregister_subdev - Unregisters a subdev with a v4l2 device.
166575f9308SMauro Carvalho Chehab *
167d651ff91SMauro Carvalho Chehab * @sd: pointer to &struct v4l2_subdev
168575f9308SMauro Carvalho Chehab *
169575f9308SMauro Carvalho Chehab * .. note ::
170575f9308SMauro Carvalho Chehab *
171575f9308SMauro Carvalho Chehab * Can also be called if the subdev wasn't registered. In such
172575f9308SMauro Carvalho Chehab * case, it will do nothing.
173575f9308SMauro Carvalho Chehab */
1742a1fcdf0SHans Verkuil void v4l2_device_unregister_subdev(struct v4l2_subdev *sd);
1752a1fcdf0SHans Verkuil
176575f9308SMauro Carvalho Chehab /**
177*b0649455SMauro Carvalho Chehab * __v4l2_device_register_subdev_nodes - Registers device nodes for
178f75c431eSJacopo Mondi * all subdevs of the v4l2 device that are marked with the
179f75c431eSJacopo Mondi * %V4L2_SUBDEV_FL_HAS_DEVNODE flag.
180f75c431eSJacopo Mondi *
181f75c431eSJacopo Mondi * @v4l2_dev: pointer to struct v4l2_device
182f75c431eSJacopo Mondi * @read_only: subdevices read-only flag. True to register the subdevices
183f75c431eSJacopo Mondi * device nodes in read-only mode, false to allow full access to the
184f75c431eSJacopo Mondi * subdevice userspace API.
185f75c431eSJacopo Mondi */
186f75c431eSJacopo Mondi int __must_check
187f75c431eSJacopo Mondi __v4l2_device_register_subdev_nodes(struct v4l2_device *v4l2_dev,
188f75c431eSJacopo Mondi bool read_only);
189f75c431eSJacopo Mondi
190f75c431eSJacopo Mondi /**
191f75c431eSJacopo Mondi * v4l2_device_register_subdev_nodes - Registers subdevices device nodes with
192f75c431eSJacopo Mondi * unrestricted access to the subdevice userspace operations
193f75c431eSJacopo Mondi *
194f75c431eSJacopo Mondi * Internally calls __v4l2_device_register_subdev_nodes(). See its documentation
195f75c431eSJacopo Mondi * for more details.
196575f9308SMauro Carvalho Chehab *
197575f9308SMauro Carvalho Chehab * @v4l2_dev: pointer to struct v4l2_device
1982096a5dcSLaurent Pinchart */
199f75c431eSJacopo Mondi static inline int __must_check
v4l2_device_register_subdev_nodes(struct v4l2_device * v4l2_dev)200f75c431eSJacopo Mondi v4l2_device_register_subdev_nodes(struct v4l2_device *v4l2_dev)
201f75c431eSJacopo Mondi {
202f75c431eSJacopo Mondi #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
203f75c431eSJacopo Mondi return __v4l2_device_register_subdev_nodes(v4l2_dev, false);
204f75c431eSJacopo Mondi #else
205f75c431eSJacopo Mondi return 0;
206f75c431eSJacopo Mondi #endif
207f75c431eSJacopo Mondi }
208f75c431eSJacopo Mondi
209f75c431eSJacopo Mondi /**
210f75c431eSJacopo Mondi * v4l2_device_register_ro_subdev_nodes - Registers subdevices device nodes
211f75c431eSJacopo Mondi * in read-only mode
212f75c431eSJacopo Mondi *
213f75c431eSJacopo Mondi * Internally calls __v4l2_device_register_subdev_nodes(). See its documentation
214f75c431eSJacopo Mondi * for more details.
215f75c431eSJacopo Mondi *
216f75c431eSJacopo Mondi * @v4l2_dev: pointer to struct v4l2_device
217f75c431eSJacopo Mondi */
218f75c431eSJacopo Mondi static inline int __must_check
v4l2_device_register_ro_subdev_nodes(struct v4l2_device * v4l2_dev)219f75c431eSJacopo Mondi v4l2_device_register_ro_subdev_nodes(struct v4l2_device *v4l2_dev)
220f75c431eSJacopo Mondi {
221f75c431eSJacopo Mondi #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API)
222f75c431eSJacopo Mondi return __v4l2_device_register_subdev_nodes(v4l2_dev, true);
223f75c431eSJacopo Mondi #else
224f75c431eSJacopo Mondi return 0;
225f75c431eSJacopo Mondi #endif
226f75c431eSJacopo Mondi }
2272096a5dcSLaurent Pinchart
228575f9308SMauro Carvalho Chehab /**
229575f9308SMauro Carvalho Chehab * v4l2_subdev_notify - Sends a notification to v4l2_device.
230575f9308SMauro Carvalho Chehab *
231d651ff91SMauro Carvalho Chehab * @sd: pointer to &struct v4l2_subdev
232575f9308SMauro Carvalho Chehab * @notification: type of notification. Please notice that the notification
233575f9308SMauro Carvalho Chehab * type is driver-specific.
234575f9308SMauro Carvalho Chehab * @arg: arguments for the notification. Those are specific to each
235575f9308SMauro Carvalho Chehab * notification type.
236575f9308SMauro Carvalho Chehab */
v4l2_subdev_notify(struct v4l2_subdev * sd,unsigned int notification,void * arg)237ba76a6e6SHans Verkuil static inline void v4l2_subdev_notify(struct v4l2_subdev *sd,
238ba76a6e6SHans Verkuil unsigned int notification, void *arg)
239ba76a6e6SHans Verkuil {
240ba76a6e6SHans Verkuil if (sd && sd->v4l2_dev && sd->v4l2_dev->notify)
241ba76a6e6SHans Verkuil sd->v4l2_dev->notify(sd, notification, arg);
242ba76a6e6SHans Verkuil }
243ba76a6e6SHans Verkuil
24493a9d900SHans Verkuil /**
24593a9d900SHans Verkuil * v4l2_device_supports_requests - Test if requests are supported.
24693a9d900SHans Verkuil *
24793a9d900SHans Verkuil * @v4l2_dev: pointer to struct v4l2_device
24893a9d900SHans Verkuil */
v4l2_device_supports_requests(struct v4l2_device * v4l2_dev)24993a9d900SHans Verkuil static inline bool v4l2_device_supports_requests(struct v4l2_device *v4l2_dev)
25093a9d900SHans Verkuil {
25193a9d900SHans Verkuil return v4l2_dev->mdev && v4l2_dev->mdev->ops &&
25293a9d900SHans Verkuil v4l2_dev->mdev->ops->req_queue;
25393a9d900SHans Verkuil }
25493a9d900SHans Verkuil
255d651ff91SMauro Carvalho Chehab /* Helper macros to iterate over all subdevs. */
256d651ff91SMauro Carvalho Chehab
257d651ff91SMauro Carvalho Chehab /**
258d651ff91SMauro Carvalho Chehab * v4l2_device_for_each_subdev - Helper macro that interates over all
259d651ff91SMauro Carvalho Chehab * sub-devices of a given &v4l2_device.
260d651ff91SMauro Carvalho Chehab *
261d651ff91SMauro Carvalho Chehab * @sd: pointer that will be filled by the macro with all
262d651ff91SMauro Carvalho Chehab * &struct v4l2_subdev pointer used as an iterator by the loop.
263d651ff91SMauro Carvalho Chehab * @v4l2_dev: &struct v4l2_device owning the sub-devices to iterate over.
264d651ff91SMauro Carvalho Chehab *
265d651ff91SMauro Carvalho Chehab * This macro iterates over all sub-devices owned by the @v4l2_dev device.
266d651ff91SMauro Carvalho Chehab * It acts as a for loop iterator and executes the next statement with
267d651ff91SMauro Carvalho Chehab * the @sd variable pointing to each sub-device in turn.
268d651ff91SMauro Carvalho Chehab */
2693a63e449SHans Verkuil #define v4l2_device_for_each_subdev(sd, v4l2_dev) \
2703a63e449SHans Verkuil list_for_each_entry(sd, &(v4l2_dev)->subdevs, list)
2712a1fcdf0SHans Verkuil
272d651ff91SMauro Carvalho Chehab /**
273d651ff91SMauro Carvalho Chehab * __v4l2_device_call_subdevs_p - Calls the specified operation for
274d651ff91SMauro Carvalho Chehab * all subdevs matching the condition.
275d651ff91SMauro Carvalho Chehab *
276d651ff91SMauro Carvalho Chehab * @v4l2_dev: &struct v4l2_device owning the sub-devices to iterate over.
277d651ff91SMauro Carvalho Chehab * @sd: pointer that will be filled by the macro with all
278d651ff91SMauro Carvalho Chehab * &struct v4l2_subdev pointer used as an iterator by the loop.
279d651ff91SMauro Carvalho Chehab * @cond: condition to be match
280d651ff91SMauro Carvalho Chehab * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
281d651ff91SMauro Carvalho Chehab * Each element there groups a set of operations functions.
282d651ff91SMauro Carvalho Chehab * @f: operation function that will be called if @cond matches.
283d651ff91SMauro Carvalho Chehab * The operation functions are defined in groups, according to
284d651ff91SMauro Carvalho Chehab * each element at &struct v4l2_subdev_ops.
28560d70d75SJonathan Neuschäfer * @args: arguments for @f.
286d651ff91SMauro Carvalho Chehab *
287d651ff91SMauro Carvalho Chehab * Ignore any errors.
288d651ff91SMauro Carvalho Chehab *
289d651ff91SMauro Carvalho Chehab * Note: subdevs cannot be added or deleted while walking
290d651ff91SMauro Carvalho Chehab * the subdevs list.
291d651ff91SMauro Carvalho Chehab */
2926c2d4dd1SGuennadi Liakhovetski #define __v4l2_device_call_subdevs_p(v4l2_dev, sd, cond, o, f, args...) \
2936c2d4dd1SGuennadi Liakhovetski do { \
2946c2d4dd1SGuennadi Liakhovetski list_for_each_entry((sd), &(v4l2_dev)->subdevs, list) \
2956c2d4dd1SGuennadi Liakhovetski if ((cond) && (sd)->ops->o && (sd)->ops->o->f) \
2966c2d4dd1SGuennadi Liakhovetski (sd)->ops->o->f((sd) , ##args); \
2976c2d4dd1SGuennadi Liakhovetski } while (0)
2986c2d4dd1SGuennadi Liakhovetski
299d651ff91SMauro Carvalho Chehab /**
300d651ff91SMauro Carvalho Chehab * __v4l2_device_call_subdevs - Calls the specified operation for
301d651ff91SMauro Carvalho Chehab * all subdevs matching the condition.
302d651ff91SMauro Carvalho Chehab *
303d651ff91SMauro Carvalho Chehab * @v4l2_dev: &struct v4l2_device owning the sub-devices to iterate over.
304d651ff91SMauro Carvalho Chehab * @cond: condition to be match
305d651ff91SMauro Carvalho Chehab * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
306d651ff91SMauro Carvalho Chehab * Each element there groups a set of operations functions.
307d651ff91SMauro Carvalho Chehab * @f: operation function that will be called if @cond matches.
308d651ff91SMauro Carvalho Chehab * The operation functions are defined in groups, according to
309d651ff91SMauro Carvalho Chehab * each element at &struct v4l2_subdev_ops.
31060d70d75SJonathan Neuschäfer * @args: arguments for @f.
311d651ff91SMauro Carvalho Chehab *
312d651ff91SMauro Carvalho Chehab * Ignore any errors.
313d651ff91SMauro Carvalho Chehab *
314d651ff91SMauro Carvalho Chehab * Note: subdevs cannot be added or deleted while walking
315d651ff91SMauro Carvalho Chehab * the subdevs list.
316d651ff91SMauro Carvalho Chehab */
3173a63e449SHans Verkuil #define __v4l2_device_call_subdevs(v4l2_dev, cond, o, f, args...) \
3182a1fcdf0SHans Verkuil do { \
3196c2d4dd1SGuennadi Liakhovetski struct v4l2_subdev *__sd; \
3202a1fcdf0SHans Verkuil \
3216c2d4dd1SGuennadi Liakhovetski __v4l2_device_call_subdevs_p(v4l2_dev, __sd, cond, o, \
3226c2d4dd1SGuennadi Liakhovetski f , ##args); \
3232a1fcdf0SHans Verkuil } while (0)
3242a1fcdf0SHans Verkuil
325d651ff91SMauro Carvalho Chehab /**
326d651ff91SMauro Carvalho Chehab * __v4l2_device_call_subdevs_until_err_p - Calls the specified operation for
327d651ff91SMauro Carvalho Chehab * all subdevs matching the condition.
328d651ff91SMauro Carvalho Chehab *
329d651ff91SMauro Carvalho Chehab * @v4l2_dev: &struct v4l2_device owning the sub-devices to iterate over.
330d651ff91SMauro Carvalho Chehab * @sd: pointer that will be filled by the macro with all
331d651ff91SMauro Carvalho Chehab * &struct v4l2_subdev sub-devices associated with @v4l2_dev.
332d651ff91SMauro Carvalho Chehab * @cond: condition to be match
333d651ff91SMauro Carvalho Chehab * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
334d651ff91SMauro Carvalho Chehab * Each element there groups a set of operations functions.
335d651ff91SMauro Carvalho Chehab * @f: operation function that will be called if @cond matches.
336d651ff91SMauro Carvalho Chehab * The operation functions are defined in groups, according to
337d651ff91SMauro Carvalho Chehab * each element at &struct v4l2_subdev_ops.
33860d70d75SJonathan Neuschäfer * @args: arguments for @f.
339d651ff91SMauro Carvalho Chehab *
340d651ff91SMauro Carvalho Chehab * Return:
341d651ff91SMauro Carvalho Chehab *
342d651ff91SMauro Carvalho Chehab * If the operation returns an error other than 0 or ``-ENOIOCTLCMD``
343d651ff91SMauro Carvalho Chehab * for any subdevice, then abort and return with that error code, zero
344d651ff91SMauro Carvalho Chehab * otherwise.
345d651ff91SMauro Carvalho Chehab *
346d651ff91SMauro Carvalho Chehab * Note: subdevs cannot be added or deleted while walking
347d651ff91SMauro Carvalho Chehab * the subdevs list.
348d651ff91SMauro Carvalho Chehab */
3496c2d4dd1SGuennadi Liakhovetski #define __v4l2_device_call_subdevs_until_err_p(v4l2_dev, sd, cond, o, f, args...) \
3502a1fcdf0SHans Verkuil ({ \
3516c2d4dd1SGuennadi Liakhovetski long __err = 0; \
3522a1fcdf0SHans Verkuil \
3536c2d4dd1SGuennadi Liakhovetski list_for_each_entry((sd), &(v4l2_dev)->subdevs, list) { \
3546c2d4dd1SGuennadi Liakhovetski if ((cond) && (sd)->ops->o && (sd)->ops->o->f) \
3556c2d4dd1SGuennadi Liakhovetski __err = (sd)->ops->o->f((sd) , ##args); \
3566c2d4dd1SGuennadi Liakhovetski if (__err && __err != -ENOIOCTLCMD) \
3572a1fcdf0SHans Verkuil break; \
3582a1fcdf0SHans Verkuil } \
3596c2d4dd1SGuennadi Liakhovetski (__err == -ENOIOCTLCMD) ? 0 : __err; \
3606c2d4dd1SGuennadi Liakhovetski })
3616c2d4dd1SGuennadi Liakhovetski
362d651ff91SMauro Carvalho Chehab /**
363d651ff91SMauro Carvalho Chehab * __v4l2_device_call_subdevs_until_err - Calls the specified operation for
364d651ff91SMauro Carvalho Chehab * all subdevs matching the condition.
365d651ff91SMauro Carvalho Chehab *
366d651ff91SMauro Carvalho Chehab * @v4l2_dev: &struct v4l2_device owning the sub-devices to iterate over.
367d651ff91SMauro Carvalho Chehab * @cond: condition to be match
368d651ff91SMauro Carvalho Chehab * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
369d651ff91SMauro Carvalho Chehab * Each element there groups a set of operations functions.
370d651ff91SMauro Carvalho Chehab * @f: operation function that will be called if @cond matches.
371d651ff91SMauro Carvalho Chehab * The operation functions are defined in groups, according to
372d651ff91SMauro Carvalho Chehab * each element at &struct v4l2_subdev_ops.
37360d70d75SJonathan Neuschäfer * @args: arguments for @f.
374d651ff91SMauro Carvalho Chehab *
375d651ff91SMauro Carvalho Chehab * Return:
376d651ff91SMauro Carvalho Chehab *
377d651ff91SMauro Carvalho Chehab * If the operation returns an error other than 0 or ``-ENOIOCTLCMD``
378d651ff91SMauro Carvalho Chehab * for any subdevice, then abort and return with that error code,
379d651ff91SMauro Carvalho Chehab * zero otherwise.
380d651ff91SMauro Carvalho Chehab *
381d651ff91SMauro Carvalho Chehab * Note: subdevs cannot be added or deleted while walking
382d651ff91SMauro Carvalho Chehab * the subdevs list.
383d651ff91SMauro Carvalho Chehab */
3846c2d4dd1SGuennadi Liakhovetski #define __v4l2_device_call_subdevs_until_err(v4l2_dev, cond, o, f, args...) \
3856c2d4dd1SGuennadi Liakhovetski ({ \
3866c2d4dd1SGuennadi Liakhovetski struct v4l2_subdev *__sd; \
3876c2d4dd1SGuennadi Liakhovetski __v4l2_device_call_subdevs_until_err_p(v4l2_dev, __sd, cond, o, \
388c6c73544SGuennadi Liakhovetski f , ##args); \
3892a1fcdf0SHans Verkuil })
3902a1fcdf0SHans Verkuil
391d651ff91SMauro Carvalho Chehab /**
392d651ff91SMauro Carvalho Chehab * v4l2_device_call_all - Calls the specified operation for
393d651ff91SMauro Carvalho Chehab * all subdevs matching the &v4l2_subdev.grp_id, as assigned
394d651ff91SMauro Carvalho Chehab * by the bridge driver.
395d651ff91SMauro Carvalho Chehab *
396d651ff91SMauro Carvalho Chehab * @v4l2_dev: &struct v4l2_device owning the sub-devices to iterate over.
397d651ff91SMauro Carvalho Chehab * @grpid: &struct v4l2_subdev->grp_id group ID to match.
398d651ff91SMauro Carvalho Chehab * Use 0 to match them all.
399d651ff91SMauro Carvalho Chehab * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
400d651ff91SMauro Carvalho Chehab * Each element there groups a set of operations functions.
401d651ff91SMauro Carvalho Chehab * @f: operation function that will be called if @cond matches.
402d651ff91SMauro Carvalho Chehab * The operation functions are defined in groups, according to
403d651ff91SMauro Carvalho Chehab * each element at &struct v4l2_subdev_ops.
40460d70d75SJonathan Neuschäfer * @args: arguments for @f.
405d651ff91SMauro Carvalho Chehab *
406d651ff91SMauro Carvalho Chehab * Ignore any errors.
407d651ff91SMauro Carvalho Chehab *
408d651ff91SMauro Carvalho Chehab * Note: subdevs cannot be added or deleted while walking
409d651ff91SMauro Carvalho Chehab * the subdevs list.
410d651ff91SMauro Carvalho Chehab */
4113a63e449SHans Verkuil #define v4l2_device_call_all(v4l2_dev, grpid, o, f, args...) \
4126c2d4dd1SGuennadi Liakhovetski do { \
4136c2d4dd1SGuennadi Liakhovetski struct v4l2_subdev *__sd; \
4146c2d4dd1SGuennadi Liakhovetski \
4156c2d4dd1SGuennadi Liakhovetski __v4l2_device_call_subdevs_p(v4l2_dev, __sd, \
416afb34781SNathan Chancellor (grpid) == 0 || __sd->grp_id == (grpid), o, f , \
4176c2d4dd1SGuennadi Liakhovetski ##args); \
4186c2d4dd1SGuennadi Liakhovetski } while (0)
4192a1fcdf0SHans Verkuil
420d651ff91SMauro Carvalho Chehab /**
421d651ff91SMauro Carvalho Chehab * v4l2_device_call_until_err - Calls the specified operation for
422d651ff91SMauro Carvalho Chehab * all subdevs matching the &v4l2_subdev.grp_id, as assigned
423d651ff91SMauro Carvalho Chehab * by the bridge driver, until an error occurs.
424d651ff91SMauro Carvalho Chehab *
425d651ff91SMauro Carvalho Chehab * @v4l2_dev: &struct v4l2_device owning the sub-devices to iterate over.
426d651ff91SMauro Carvalho Chehab * @grpid: &struct v4l2_subdev->grp_id group ID to match.
427d651ff91SMauro Carvalho Chehab * Use 0 to match them all.
428d651ff91SMauro Carvalho Chehab * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
429d651ff91SMauro Carvalho Chehab * Each element there groups a set of operations functions.
430d651ff91SMauro Carvalho Chehab * @f: operation function that will be called if @cond matches.
431d651ff91SMauro Carvalho Chehab * The operation functions are defined in groups, according to
432d651ff91SMauro Carvalho Chehab * each element at &struct v4l2_subdev_ops.
43360d70d75SJonathan Neuschäfer * @args: arguments for @f.
434d651ff91SMauro Carvalho Chehab *
435d651ff91SMauro Carvalho Chehab * Return:
436d651ff91SMauro Carvalho Chehab *
437d651ff91SMauro Carvalho Chehab * If the operation returns an error other than 0 or ``-ENOIOCTLCMD``
438d651ff91SMauro Carvalho Chehab * for any subdevice, then abort and return with that error code,
439d651ff91SMauro Carvalho Chehab * zero otherwise.
440d651ff91SMauro Carvalho Chehab *
441d651ff91SMauro Carvalho Chehab * Note: subdevs cannot be added or deleted while walking
442d651ff91SMauro Carvalho Chehab * the subdevs list.
443d651ff91SMauro Carvalho Chehab */
4443a63e449SHans Verkuil #define v4l2_device_call_until_err(v4l2_dev, grpid, o, f, args...) \
4456c2d4dd1SGuennadi Liakhovetski ({ \
4466c2d4dd1SGuennadi Liakhovetski struct v4l2_subdev *__sd; \
4476c2d4dd1SGuennadi Liakhovetski __v4l2_device_call_subdevs_until_err_p(v4l2_dev, __sd, \
448afb34781SNathan Chancellor (grpid) == 0 || __sd->grp_id == (grpid), o, f , \
4496c2d4dd1SGuennadi Liakhovetski ##args); \
4506c2d4dd1SGuennadi Liakhovetski })
4512a1fcdf0SHans Verkuil
452d651ff91SMauro Carvalho Chehab /**
453d651ff91SMauro Carvalho Chehab * v4l2_device_mask_call_all - Calls the specified operation for
454d651ff91SMauro Carvalho Chehab * all subdevices where a group ID matches a specified bitmask.
455d651ff91SMauro Carvalho Chehab *
456d651ff91SMauro Carvalho Chehab * @v4l2_dev: &struct v4l2_device owning the sub-devices to iterate over.
457d651ff91SMauro Carvalho Chehab * @grpmsk: bitmask to be checked against &struct v4l2_subdev->grp_id
458d651ff91SMauro Carvalho Chehab * group ID to be matched. Use 0 to match them all.
459d651ff91SMauro Carvalho Chehab * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
460d651ff91SMauro Carvalho Chehab * Each element there groups a set of operations functions.
461d651ff91SMauro Carvalho Chehab * @f: operation function that will be called if @cond matches.
462d651ff91SMauro Carvalho Chehab * The operation functions are defined in groups, according to
463d651ff91SMauro Carvalho Chehab * each element at &struct v4l2_subdev_ops.
46460d70d75SJonathan Neuschäfer * @args: arguments for @f.
465d651ff91SMauro Carvalho Chehab *
466d651ff91SMauro Carvalho Chehab * Ignore any errors.
467d651ff91SMauro Carvalho Chehab *
468d651ff91SMauro Carvalho Chehab * Note: subdevs cannot be added or deleted while walking
469d651ff91SMauro Carvalho Chehab * the subdevs list.
47096655553SHans Verkuil */
47196655553SHans Verkuil #define v4l2_device_mask_call_all(v4l2_dev, grpmsk, o, f, args...) \
47296655553SHans Verkuil do { \
47396655553SHans Verkuil struct v4l2_subdev *__sd; \
47496655553SHans Verkuil \
47596655553SHans Verkuil __v4l2_device_call_subdevs_p(v4l2_dev, __sd, \
476afb34781SNathan Chancellor (grpmsk) == 0 || (__sd->grp_id & (grpmsk)), o, \
477afb34781SNathan Chancellor f , ##args); \
47896655553SHans Verkuil } while (0)
47996655553SHans Verkuil
480d651ff91SMauro Carvalho Chehab /**
481d651ff91SMauro Carvalho Chehab * v4l2_device_mask_call_until_err - Calls the specified operation for
482d651ff91SMauro Carvalho Chehab * all subdevices where a group ID matches a specified bitmask.
483d651ff91SMauro Carvalho Chehab *
484d651ff91SMauro Carvalho Chehab * @v4l2_dev: &struct v4l2_device owning the sub-devices to iterate over.
485d651ff91SMauro Carvalho Chehab * @grpmsk: bitmask to be checked against &struct v4l2_subdev->grp_id
486d651ff91SMauro Carvalho Chehab * group ID to be matched. Use 0 to match them all.
487d651ff91SMauro Carvalho Chehab * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
488d651ff91SMauro Carvalho Chehab * Each element there groups a set of operations functions.
489d651ff91SMauro Carvalho Chehab * @f: operation function that will be called if @cond matches.
490d651ff91SMauro Carvalho Chehab * The operation functions are defined in groups, according to
491d651ff91SMauro Carvalho Chehab * each element at &struct v4l2_subdev_ops.
49260d70d75SJonathan Neuschäfer * @args: arguments for @f.
493d651ff91SMauro Carvalho Chehab *
494d651ff91SMauro Carvalho Chehab * Return:
495d651ff91SMauro Carvalho Chehab *
496d651ff91SMauro Carvalho Chehab * If the operation returns an error other than 0 or ``-ENOIOCTLCMD``
497d651ff91SMauro Carvalho Chehab * for any subdevice, then abort and return with that error code,
498d651ff91SMauro Carvalho Chehab * zero otherwise.
499d651ff91SMauro Carvalho Chehab *
500d651ff91SMauro Carvalho Chehab * Note: subdevs cannot be added or deleted while walking
501d651ff91SMauro Carvalho Chehab * the subdevs list.
50296655553SHans Verkuil */
50396655553SHans Verkuil #define v4l2_device_mask_call_until_err(v4l2_dev, grpmsk, o, f, args...) \
50496655553SHans Verkuil ({ \
50596655553SHans Verkuil struct v4l2_subdev *__sd; \
50696655553SHans Verkuil __v4l2_device_call_subdevs_until_err_p(v4l2_dev, __sd, \
507afb34781SNathan Chancellor (grpmsk) == 0 || (__sd->grp_id & (grpmsk)), o, \
508afb34781SNathan Chancellor f , ##args); \
50996655553SHans Verkuil })
51096655553SHans Verkuil
511d651ff91SMauro Carvalho Chehab
512d651ff91SMauro Carvalho Chehab /**
513d651ff91SMauro Carvalho Chehab * v4l2_device_has_op - checks if any subdev with matching grpid has a
514d651ff91SMauro Carvalho Chehab * given ops.
515d651ff91SMauro Carvalho Chehab *
516d651ff91SMauro Carvalho Chehab * @v4l2_dev: &struct v4l2_device owning the sub-devices to iterate over.
517d651ff91SMauro Carvalho Chehab * @grpid: &struct v4l2_subdev->grp_id group ID to match.
518d651ff91SMauro Carvalho Chehab * Use 0 to match them all.
519d651ff91SMauro Carvalho Chehab * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
520d651ff91SMauro Carvalho Chehab * Each element there groups a set of operations functions.
521d651ff91SMauro Carvalho Chehab * @f: operation function that will be called if @cond matches.
522d651ff91SMauro Carvalho Chehab * The operation functions are defined in groups, according to
523d651ff91SMauro Carvalho Chehab * each element at &struct v4l2_subdev_ops.
52496655553SHans Verkuil */
52596655553SHans Verkuil #define v4l2_device_has_op(v4l2_dev, grpid, o, f) \
5262180f92dSHans Verkuil ({ \
5272180f92dSHans Verkuil struct v4l2_subdev *__sd; \
5282180f92dSHans Verkuil bool __result = false; \
5292180f92dSHans Verkuil list_for_each_entry(__sd, &(v4l2_dev)->subdevs, list) { \
53096655553SHans Verkuil if ((grpid) && __sd->grp_id != (grpid)) \
53196655553SHans Verkuil continue; \
53296655553SHans Verkuil if (v4l2_subdev_has_op(__sd, o, f)) { \
53396655553SHans Verkuil __result = true; \
53496655553SHans Verkuil break; \
53596655553SHans Verkuil } \
53696655553SHans Verkuil } \
53796655553SHans Verkuil __result; \
53896655553SHans Verkuil })
53996655553SHans Verkuil
540d651ff91SMauro Carvalho Chehab /**
541d651ff91SMauro Carvalho Chehab * v4l2_device_mask_has_op - checks if any subdev with matching group
542d651ff91SMauro Carvalho Chehab * mask has a given ops.
543d651ff91SMauro Carvalho Chehab *
544d651ff91SMauro Carvalho Chehab * @v4l2_dev: &struct v4l2_device owning the sub-devices to iterate over.
545d651ff91SMauro Carvalho Chehab * @grpmsk: bitmask to be checked against &struct v4l2_subdev->grp_id
546d651ff91SMauro Carvalho Chehab * group ID to be matched. Use 0 to match them all.
547d651ff91SMauro Carvalho Chehab * @o: name of the element at &struct v4l2_subdev_ops that contains @f.
548d651ff91SMauro Carvalho Chehab * Each element there groups a set of operations functions.
549d651ff91SMauro Carvalho Chehab * @f: operation function that will be called if @cond matches.
550d651ff91SMauro Carvalho Chehab * The operation functions are defined in groups, according to
551d651ff91SMauro Carvalho Chehab * each element at &struct v4l2_subdev_ops.
55296655553SHans Verkuil */
55396655553SHans Verkuil #define v4l2_device_mask_has_op(v4l2_dev, grpmsk, o, f) \
55496655553SHans Verkuil ({ \
55596655553SHans Verkuil struct v4l2_subdev *__sd; \
55696655553SHans Verkuil bool __result = false; \
55796655553SHans Verkuil list_for_each_entry(__sd, &(v4l2_dev)->subdevs, list) { \
55896655553SHans Verkuil if ((grpmsk) && !(__sd->grp_id & (grpmsk))) \
55996655553SHans Verkuil continue; \
5602180f92dSHans Verkuil if (v4l2_subdev_has_op(__sd, o, f)) { \
5612180f92dSHans Verkuil __result = true; \
5622180f92dSHans Verkuil break; \
5632180f92dSHans Verkuil } \
5642180f92dSHans Verkuil } \
5652180f92dSHans Verkuil __result; \
5662180f92dSHans Verkuil })
5672180f92dSHans Verkuil
5682a1fcdf0SHans Verkuil #endif
569