Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit c53c2549 authored by Hans de Goede's avatar Hans de Goede Committed by Mauro Carvalho Chehab
Browse files

[media] v4l2-event: Add v4l2_subscribed_event_ops 



Just like with ctrl events, drivers may want to get called back on
listener add / remove for other event types too. Rather then special
casing all of this in subscribe / unsubscribe event it is better to
use ops for this.

Signed-off-by: default avatarHans de Goede <hdegoede@redhat.com>
Acked-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent a22d85fe

Documentation/video4linux/v4l2-framework.txt

+21 −7
Original line number Original line Diff line number Diff line
@@ -945,21 +945,35 @@ fast. 




Useful functions:

Useful functions:





- v4l2_event_queue()

void v4l2_event_queue(struct video_device *vdev, const struct v4l2_event *ev)





  Queue events to video device. The driver's only responsibility is to fill

  Queue events to video device. The driver's only responsibility is to fill

  in the type and the data fields. The other fields will be filled in by

  in the type and the data fields. The other fields will be filled in by

  V4L2.

  V4L2.





- v4l2_event_subscribe()

int v4l2_event_subscribe(struct v4l2_fh *fh,

			 struct v4l2_event_subscription *sub, unsigned elems,

			 const struct v4l2_subscribed_event_ops *ops)





  The video_device->ioctl_ops->vidioc_subscribe_event must check the driver

  The video_device->ioctl_ops->vidioc_subscribe_event must check the driver

  is able to produce events with specified event id. Then it calls

  is able to produce events with specified event id. Then it calls

  v4l2_event_subscribe() to subscribe the event. The last argument is the

  v4l2_event_subscribe() to subscribe the event.

  size of the event queue for this event. If it is 0, then the framework

  will fill in a default value (this depends on the event type).





- v4l2_event_unsubscribe()

  The elems argument is the size of the event queue for this event. If it is 0,

  then the framework will fill in a default value (this depends on the event

  type).



  The ops argument allows the driver to specify a number of callbacks:

  * add:     called when a new listener gets added (subscribing to the same

             event twice will only cause this callback to get called once)

  * del:     called when a listener stops listening

  * replace: replace event 'old' with event 'new'.

  * merge:   merge event 'old' into event 'new'.

  All 4 callbacks are optional, if you don't want to specify any callbacks

  the ops argument itself maybe NULL.



int v4l2_event_unsubscribe(struct v4l2_fh *fh,

			   struct v4l2_event_subscription *sub)





  vidioc_unsubscribe_event in struct v4l2_ioctl_ops. A driver may use

  vidioc_unsubscribe_event in struct v4l2_ioctl_ops. A driver may use

  v4l2_event_unsubscribe() directly unless it wants to be involved in

  v4l2_event_unsubscribe() directly unless it wants to be involved in
@@ -968,7 +982,7 @@ Useful functions: 
  The special type V4L2_EVENT_ALL may be used to unsubscribe all events. The

  The special type V4L2_EVENT_ALL may be used to unsubscribe all events. The

  drivers may want to handle this in a special way.

  drivers may want to handle this in a special way.





- v4l2_event_pending()

int v4l2_event_pending(struct v4l2_fh *fh)





  Returns the number of pending events. Useful when implementing poll.

  Returns the number of pending events. Useful when implementing poll.

drivers/media/video/ivtv/ivtv-ioctl.c

+1 −1
Original line number Original line Diff line number Diff line
@@ -1469,7 +1469,7 @@ static int ivtv_subscribe_event(struct v4l2_fh *fh, struct v4l2_event_subscripti 
	case V4L2_EVENT_VSYNC:

	case V4L2_EVENT_VSYNC:

	case V4L2_EVENT_EOS:

	case V4L2_EVENT_EOS:

	case V4L2_EVENT_CTRL:

	case V4L2_EVENT_CTRL:

		return v4l2_event_subscribe(fh, sub, 0);

		return v4l2_event_subscribe(fh, sub, 0, NULL);

	default:

	default:

		return -EINVAL;

		return -EINVAL;

	}

	}

drivers/media/video/omap3isp/ispccdc.c

+1 −1
Original line number Original line Diff line number Diff line
@@ -1703,7 +1703,7 @@ static int ccdc_subscribe_event(struct v4l2_subdev *sd, struct v4l2_fh *fh, 
	if (sub->id != 0)

	if (sub->id != 0)

		return -EINVAL;

		return -EINVAL;





	return v4l2_event_subscribe(fh, sub, OMAP3ISP_CCDC_NEVENTS);

	return v4l2_event_subscribe(fh, sub, OMAP3ISP_CCDC_NEVENTS, NULL);

}

}





static int ccdc_unsubscribe_event(struct v4l2_subdev *sd, struct v4l2_fh *fh,

static int ccdc_unsubscribe_event(struct v4l2_subdev *sd, struct v4l2_fh *fh,

drivers/media/video/omap3isp/ispstat.c

+1 −1
Original line number Original line Diff line number Diff line
@@ -1032,7 +1032,7 @@ int omap3isp_stat_subscribe_event(struct v4l2_subdev *subdev, 
	if (sub->type != stat->event_type)

	if (sub->type != stat->event_type)

		return -EINVAL;

		return -EINVAL;





	return v4l2_event_subscribe(fh, sub, STAT_NEVENTS);

	return v4l2_event_subscribe(fh, sub, STAT_NEVENTS, NULL);

}

}





int omap3isp_stat_unsubscribe_event(struct v4l2_subdev *subdev,

int omap3isp_stat_unsubscribe_event(struct v4l2_subdev *subdev,

drivers/media/video/v4l2-ctrls.c

+1 −1
Original line number Original line Diff line number Diff line
@@ -2468,7 +2468,7 @@ int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh, 
				struct v4l2_event_subscription *sub)

				struct v4l2_event_subscription *sub)

{

{

	if (sub->type == V4L2_EVENT_CTRL)

	if (sub->type == V4L2_EVENT_CTRL)

		return v4l2_event_subscribe(fh, sub, 0);

		return v4l2_event_subscribe(fh, sub, 0, NULL);

	return -EINVAL;

	return -EINVAL;

}

}

EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);

EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);