Re: [REVIEWv3 PATCH 19/35] DocBook media: document VIDIOC_QUERY_EXT_CTRL.

2014-03-13 Thread Hans Verkuil
On 03/12/2014 03:13 PM, Mauro Carvalho Chehab wrote:
 Em Mon, 17 Feb 2014 10:57:34 +0100
 Hans Verkuil hverk...@xs4all.nl escreveu:
 
 From: Hans Verkuil hans.verk...@cisco.com

 Signed-off-by: Hans Verkuil hans.verk...@cisco.com
 Reviewed-by: Sylwester Nawrocki s.nawro...@samsung.com
 ---
  .../DocBook/media/v4l/vidioc-queryctrl.xml | 223 
 +
  1 file changed, 189 insertions(+), 34 deletions(-)

 diff --git a/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml 
 b/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml
 index e6645b9..da0e534 100644
 --- a/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml
 +++ b/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml
 @@ -1,11 +1,12 @@
  refentry id=vidioc-queryctrl
refmeta
 -refentrytitleioctl VIDIOC_QUERYCTRL, VIDIOC_QUERYMENU/refentrytitle
 +refentrytitleioctl VIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL, 
 VIDIOC_QUERYMENU/refentrytitle
  manvol;
/refmeta
  
refnamediv
  refnameVIDIOC_QUERYCTRL/refname
 +refnameVIDIOC_QUERY_EXT_CTRL/refname
  refnameVIDIOC_QUERYMENU/refname
  refpurposeEnumerate controls and menu control items/refpurpose
/refnamediv
 @@ -24,6 +25,14 @@
  funcdefint functionioctl/function/funcdef
  paramdefint parameterfd/parameter/paramdef
  paramdefint parameterrequest/parameter/paramdef
 +paramdefstruct v4l2_query_ext_ctrl 
 *parameterargp/parameter/paramdef
 +  /funcprototype
 +/funcsynopsis
 +funcsynopsis
 +  funcprototype
 +funcdefint functionioctl/function/funcdef
 +paramdefint parameterfd/parameter/paramdef
 +paramdefint parameterrequest/parameter/paramdef
  paramdefstruct v4l2_querymenu *parameterargp/parameter/paramdef
/funcprototype
  /funcsynopsis
 @@ -42,7 +51,7 @@
varlistentry
  termparameterrequest/parameter/term
  listitem
 -  paraVIDIOC_QUERYCTRL, VIDIOC_QUERYMENU/para
 +  paraVIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL, VIDIOC_QUERYMENU/para
  /listitem
/varlistentry
varlistentry
 @@ -91,7 +100,26 @@ prematurely end the 
 enumeration)./para/footnote/para
  constantV4L2_CTRL_FLAG_NEXT_CTRL/constant the driver returns the
  next supported control, or errorcodeEINVAL/errorcode if there is
  none. Drivers which do not support this flag yet always return
 -errorcodeEINVAL/errorcode./para
 +errorcodeEINVAL/errorcode. Hidden controls (i.e. controls
 +with the constantV4L2_CTRL_FLAG_HIDDEN/constant flag set) are
 +skipped when using the constantV4L2_CTRL_FLAG_NEXT_CTRL/constant
 +flag. Use the constantVIDIOC_QUERY_EXT_CTRL/constant for that./para
 
 I suspect that most of the things (if not all) here already commented
 on the initial patches)
 
 In this case, as already commented, I don't see any reason why
 to deny VIDIOC_QUERYCTRL to get the hidden controls if V4L2_CTRL_FLAG_HIDDEN
 is used.
 
 +
 +paraThe constantVIDIOC_QUERY_EXT_CTRL/constant ioctl was
 +introduced in order to better support controls that can use complex
 +types, and to expose additional control information that cannot be
 +returned in v4l2-queryctrl; since that structure is full./para
 
 s/complex/compound/g
 
 +
 +paraconstantVIDIOC_QUERY_EXT_CTRL/constant is used in the
 +same way as constantVIDIOC_QUERYCTRL/constant, except that the
 +structfieldreserved/structfield array must be zeroed as well.
 +In addition, the constantV4L2_CTRL_FLAG_NEXT_HIDDEN/constant flag
 +can be specified to enumerate all hidden controls (i.e. controls
 +with the constantV4L2_CTRL_FLAG_HIDDEN/constant flag set, which
 +includes all controls with complex types). Specify both
 +constantV4L2_CTRL_FLAG_NEXT_CTRL/constant and
 +constantV4L2_CTRL_FLAG_NEXT_HIDDEN/constant in order to enumerate
 +all controls, hidden or not./para
  
  paraAdditional information is required for menu controls: the
  names of the menu items. To query them applications set the
 @@ -142,38 +170,23 @@ string. This information is intended for the 
 user./entry
  entry__s32/entry
  entrystructfieldminimum/structfield/entry
  entryMinimum value, inclusive. This field gives a lower
 -bound for constantV4L2_CTRL_TYPE_INTEGER/constant controls and the
 -lowest valid index for constantV4L2_CTRL_TYPE_MENU/constant controls.
 -For constantV4L2_CTRL_TYPE_STRING/constant controls the minimum value
 -gives the minimum length of the string. This length emphasisdoes not 
 include the terminating
 -zero/emphasis. It may not be valid for any other type of control, 
 including
 -constantV4L2_CTRL_TYPE_INTEGER64/constant controls. Note that this is a
 -signed value./entry
 +bound for the control. See v4l2-ctrl-type; how the minimum value is to
 +be used for each possible control type. Note that this a signed 32-bit 
 value./entry
/row
row
  entry__s32/entry
  entrystructfieldmaximum/structfield/entry
  entryMaximum value, inclusive. This field gives an upper
 -bound for 

Re: [REVIEWv3 PATCH 19/35] DocBook media: document VIDIOC_QUERY_EXT_CTRL.

2014-03-12 Thread Mauro Carvalho Chehab
Em Mon, 17 Feb 2014 10:57:34 +0100
Hans Verkuil hverk...@xs4all.nl escreveu:

 From: Hans Verkuil hans.verk...@cisco.com
 
 Signed-off-by: Hans Verkuil hans.verk...@cisco.com
 Reviewed-by: Sylwester Nawrocki s.nawro...@samsung.com
 ---
  .../DocBook/media/v4l/vidioc-queryctrl.xml | 223 
 +
  1 file changed, 189 insertions(+), 34 deletions(-)
 
 diff --git a/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml 
 b/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml
 index e6645b9..da0e534 100644
 --- a/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml
 +++ b/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml
 @@ -1,11 +1,12 @@
  refentry id=vidioc-queryctrl
refmeta
 -refentrytitleioctl VIDIOC_QUERYCTRL, VIDIOC_QUERYMENU/refentrytitle
 +refentrytitleioctl VIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL, 
 VIDIOC_QUERYMENU/refentrytitle
  manvol;
/refmeta
  
refnamediv
  refnameVIDIOC_QUERYCTRL/refname
 +refnameVIDIOC_QUERY_EXT_CTRL/refname
  refnameVIDIOC_QUERYMENU/refname
  refpurposeEnumerate controls and menu control items/refpurpose
/refnamediv
 @@ -24,6 +25,14 @@
   funcdefint functionioctl/function/funcdef
   paramdefint parameterfd/parameter/paramdef
   paramdefint parameterrequest/parameter/paramdef
 + paramdefstruct v4l2_query_ext_ctrl 
 *parameterargp/parameter/paramdef
 +  /funcprototype
 +/funcsynopsis
 +funcsynopsis
 +  funcprototype
 + funcdefint functionioctl/function/funcdef
 + paramdefint parameterfd/parameter/paramdef
 + paramdefint parameterrequest/parameter/paramdef
   paramdefstruct v4l2_querymenu *parameterargp/parameter/paramdef
/funcprototype
  /funcsynopsis
 @@ -42,7 +51,7 @@
varlistentry
   termparameterrequest/parameter/term
   listitem
 -   paraVIDIOC_QUERYCTRL, VIDIOC_QUERYMENU/para
 +   paraVIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL, VIDIOC_QUERYMENU/para
   /listitem
/varlistentry
varlistentry
 @@ -91,7 +100,26 @@ prematurely end the enumeration)./para/footnote/para
  constantV4L2_CTRL_FLAG_NEXT_CTRL/constant the driver returns the
  next supported control, or errorcodeEINVAL/errorcode if there is
  none. Drivers which do not support this flag yet always return
 -errorcodeEINVAL/errorcode./para
 +errorcodeEINVAL/errorcode. Hidden controls (i.e. controls
 +with the constantV4L2_CTRL_FLAG_HIDDEN/constant flag set) are
 +skipped when using the constantV4L2_CTRL_FLAG_NEXT_CTRL/constant
 +flag. Use the constantVIDIOC_QUERY_EXT_CTRL/constant for that./para

I suspect that most of the things (if not all) here already commented
on the initial patches)

In this case, as already commented, I don't see any reason why
to deny VIDIOC_QUERYCTRL to get the hidden controls if V4L2_CTRL_FLAG_HIDDEN
is used.

 +
 +paraThe constantVIDIOC_QUERY_EXT_CTRL/constant ioctl was
 +introduced in order to better support controls that can use complex
 +types, and to expose additional control information that cannot be
 +returned in v4l2-queryctrl; since that structure is full./para

s/complex/compound/g

 +
 +paraconstantVIDIOC_QUERY_EXT_CTRL/constant is used in the
 +same way as constantVIDIOC_QUERYCTRL/constant, except that the
 +structfieldreserved/structfield array must be zeroed as well.
 +In addition, the constantV4L2_CTRL_FLAG_NEXT_HIDDEN/constant flag
 +can be specified to enumerate all hidden controls (i.e. controls
 +with the constantV4L2_CTRL_FLAG_HIDDEN/constant flag set, which
 +includes all controls with complex types). Specify both
 +constantV4L2_CTRL_FLAG_NEXT_CTRL/constant and
 +constantV4L2_CTRL_FLAG_NEXT_HIDDEN/constant in order to enumerate
 +all controls, hidden or not./para
  
  paraAdditional information is required for menu controls: the
  names of the menu items. To query them applications set the
 @@ -142,38 +170,23 @@ string. This information is intended for the 
 user./entry
   entry__s32/entry
   entrystructfieldminimum/structfield/entry
   entryMinimum value, inclusive. This field gives a lower
 -bound for constantV4L2_CTRL_TYPE_INTEGER/constant controls and the
 -lowest valid index for constantV4L2_CTRL_TYPE_MENU/constant controls.
 -For constantV4L2_CTRL_TYPE_STRING/constant controls the minimum value
 -gives the minimum length of the string. This length emphasisdoes not 
 include the terminating
 -zero/emphasis. It may not be valid for any other type of control, including
 -constantV4L2_CTRL_TYPE_INTEGER64/constant controls. Note that this is a
 -signed value./entry
 +bound for the control. See v4l2-ctrl-type; how the minimum value is to
 +be used for each possible control type. Note that this a signed 32-bit 
 value./entry
 /row
 row
   entry__s32/entry
   entrystructfieldmaximum/structfield/entry
   entryMaximum value, inclusive. This field gives an upper
 -bound for constantV4L2_CTRL_TYPE_INTEGER/constant controls and the