2008-11-30 03:36:58 +03:00
/*
V4L2 device support header .
Copyright ( C ) 2008 Hans Verkuil < hverkuil @ xs4all . nl >
This program is free software ; you can redistribute it and / or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation ; either version 2 of the License , or
( at your option ) any later version .
This program is distributed in the hope that it will be useful ,
but WITHOUT ANY WARRANTY ; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
GNU General Public License for more details .
You should have received a copy of the GNU General Public License
along with this program ; if not , write to the Free Software
Foundation , Inc . , 59 Temple Place , Suite 330 , Boston , MA 02111 - 1307 USA
*/
# ifndef _V4L2_DEVICE_H
# define _V4L2_DEVICE_H
# include <media/v4l2-subdev.h>
/* Each instance of a V4L2 device should create the v4l2_device struct,
either stand - alone or embedded in a larger struct .
It allows easy access to sub - devices ( see v4l2 - subdev . h ) and provides
basic V4L2 device - level support .
*/
2009-04-16 20:30:38 +04:00
# define V4L2_DEVICE_NAME_SIZE (20 + 16)
2008-11-30 03:36:58 +03:00
2010-08-01 21:32:42 +04:00
struct v4l2_ctrl_handler ;
2008-11-30 03:36:58 +03:00
struct v4l2_device {
2009-02-14 17:54:23 +03:00
/* dev->driver_data points to this struct.
Note : dev might be NULL if there is no parent device
as is the case with e . g . ISA devices . */
2008-11-30 03:36:58 +03:00
struct device * dev ;
/* used to keep track of the registered subdevs */
struct list_head subdevs ;
/* lock this struct; can be used by the driver as well if this
struct is embedded into a larger struct . */
spinlock_t lock ;
/* unique device name, by default the driver name + bus ID */
char name [ V4L2_DEVICE_NAME_SIZE ] ;
2009-03-08 23:02:10 +03:00
/* notify callback called by some sub-devices. */
void ( * notify ) ( struct v4l2_subdev * sd ,
unsigned int notification , void * arg ) ;
2010-08-01 21:32:42 +04:00
/* The control handler. May be NULL. */
struct v4l2_ctrl_handler * ctrl_handler ;
2010-11-26 12:47:28 +03:00
/* BKL replacement mutex. Temporary solution only. */
struct mutex ioctl_lock ;
2008-11-30 03:36:58 +03:00
} ;
2009-02-14 17:54:23 +03:00
/* Initialize v4l2_dev and make dev->driver_data point to v4l2_dev.
dev may be NULL in rare cases ( ISA devices ) . In that case you
must fill in the v4l2_dev - > name field before calling this function . */
2008-11-30 03:36:58 +03:00
int __must_check v4l2_device_register ( struct device * dev , struct v4l2_device * v4l2_dev ) ;
2009-05-02 17:12:50 +04:00
/* Optional function to initialize the name field of struct v4l2_device using
the driver name and a driver - global atomic_t instance .
This function will increment the instance counter and returns the instance
value used in the name .
Example :
static atomic_t drv_instance = ATOMIC_INIT ( 0 ) ;
. . .
instance = v4l2_device_set_name ( & v4l2_dev , " foo " , & drv_instance ) ;
The first time this is called the name field will be set to foo0 and
this function returns 0. If the name ends with a digit ( e . g . cx18 ) ,
then the name will be set to cx18 - 0 since cx180 looks really odd . */
int v4l2_device_set_name ( struct v4l2_device * v4l2_dev , const char * basename ,
atomic_t * instance ) ;
2009-03-14 14:28:45 +03:00
/* Set v4l2_dev->dev to NULL. Call when the USB parent disconnects.
Since the parent disappears this ensures that v4l2_dev doesn ' t have an
invalid parent pointer . */
void v4l2_device_disconnect ( struct v4l2_device * v4l2_dev ) ;
2009-05-02 17:12:50 +04:00
2009-03-14 14:28:45 +03:00
/* Unregister all sub-devices and any other resources related to v4l2_dev. */
2008-11-30 03:36:58 +03:00
void v4l2_device_unregister ( struct v4l2_device * v4l2_dev ) ;
/* Register a subdev with a v4l2 device. While registered the subdev module
is marked as in - use . An error is returned if the module is no longer
loaded when you attempt to register it . */
2009-02-14 17:54:23 +03:00
int __must_check v4l2_device_register_subdev ( struct v4l2_device * v4l2_dev ,
struct v4l2_subdev * sd ) ;
2008-11-30 03:36:58 +03:00
/* Unregister a subdev with a v4l2 device. Can also be called if the subdev
wasn ' t registered . In that case it will do nothing . */
void v4l2_device_unregister_subdev ( struct v4l2_subdev * sd ) ;
/* Iterate over all subdevs. */
2009-02-14 17:54:23 +03:00
# define v4l2_device_for_each_subdev(sd, v4l2_dev) \
list_for_each_entry ( sd , & ( v4l2_dev ) - > subdevs , list )
2008-11-30 03:36:58 +03:00
/* Call the specified callback for all subdevs matching the condition.
Ignore any errors . Note that you cannot add or delete a subdev
while walking the subdevs list . */
2010-08-13 00:16:00 +04:00
# define __v4l2_device_call_subdevs_p(v4l2_dev, sd, cond, o, f, args...) \
2008-11-30 03:36:58 +03:00
do { \
2010-08-13 00:16:00 +04:00
list_for_each_entry ( ( sd ) , & ( v4l2_dev ) - > subdevs , list ) \
if ( ( cond ) & & ( sd ) - > ops - > o & & ( sd ) - > ops - > o - > f ) \
( sd ) - > ops - > o - > f ( ( sd ) , # # args ) ; \
} while ( 0 )
# define __v4l2_device_call_subdevs(v4l2_dev, cond, o, f, args...) \
do { \
struct v4l2_subdev * __sd ; \
2008-11-30 03:36:58 +03:00
\
2010-08-13 00:16:00 +04:00
__v4l2_device_call_subdevs_p ( v4l2_dev , __sd , cond , o , \
f , # # args ) ; \
2008-11-30 03:36:58 +03:00
} while ( 0 )
/* Call the specified callback for all subdevs matching the condition.
If the callback returns an error other than 0 or - ENOIOCTLCMD , then
return with that error code . Note that you cannot add or delete a
subdev while walking the subdevs list . */
2010-08-13 00:16:00 +04:00
# define __v4l2_device_call_subdevs_until_err_p(v4l2_dev, sd, cond, o, f, args...) \
2008-11-30 03:36:58 +03:00
( { \
2010-08-13 00:16:00 +04:00
long __err = 0 ; \
2008-11-30 03:36:58 +03:00
\
2010-08-13 00:16:00 +04:00
list_for_each_entry ( ( sd ) , & ( v4l2_dev ) - > subdevs , list ) { \
if ( ( cond ) & & ( sd ) - > ops - > o & & ( sd ) - > ops - > o - > f ) \
__err = ( sd ) - > ops - > o - > f ( ( sd ) , # # args ) ; \
if ( __err & & __err ! = - ENOIOCTLCMD ) \
2008-11-30 03:36:58 +03:00
break ; \
} \
2010-08-13 00:16:00 +04:00
( __err = = - ENOIOCTLCMD ) ? 0 : __err ; \
} )
# define __v4l2_device_call_subdevs_until_err(v4l2_dev, cond, o, f, args...) \
( { \
struct v4l2_subdev * __sd ; \
__v4l2_device_call_subdevs_until_err_p ( v4l2_dev , __sd , cond , o , \
f , args . . . ) ; \
2008-11-30 03:36:58 +03:00
} )
/* Call the specified callback for all subdevs matching grp_id (if 0, then
match them all ) . Ignore any errors . Note that you cannot add or delete
a subdev while walking the subdevs list . */
2010-08-13 00:16:00 +04:00
# define v4l2_device_call_all(v4l2_dev, grpid, o, f, args...) \
do { \
struct v4l2_subdev * __sd ; \
\
__v4l2_device_call_subdevs_p ( v4l2_dev , __sd , \
! ( grpid ) | | __sd - > grp_id = = ( grpid ) , o , f , \
# #args); \
} while ( 0 )
2008-11-30 03:36:58 +03:00
/* Call the specified callback for all subdevs matching grp_id (if 0, then
match them all ) . If the callback returns an error other than 0 or
- ENOIOCTLCMD , then return with that error code . Note that you cannot
add or delete a subdev while walking the subdevs list . */
2009-02-14 17:54:23 +03:00
# define v4l2_device_call_until_err(v4l2_dev, grpid, o, f, args...) \
2010-08-13 00:16:00 +04:00
( { \
struct v4l2_subdev * __sd ; \
__v4l2_device_call_subdevs_until_err_p ( v4l2_dev , __sd , \
! ( grpid ) | | __sd - > grp_id = = ( grpid ) , o , f , \
# #args); \
} )
2008-11-30 03:36:58 +03:00
# endif