[RFCv1 PATCH 2/5] v4l2 spec: document the new v4l2_tuner capabilities

2012-05-27 Thread Hans Verkuil
From: Hans Verkuil hans.verk...@cisco.com

Update the spec with the new capabilities and specify new error codes for
S_HW_FREQ_SEEK.

Signed-off-by: Hans Verkuil hans.verk...@cisco.com
---
 .../DocBook/media/v4l/vidioc-g-frequency.xml |6 ++
 Documentation/DocBook/media/v4l/vidioc-g-tuner.xml   |   12 
 .../DocBook/media/v4l/vidioc-s-hw-freq-seek.xml  |   18 +++---
 3 files changed, 33 insertions(+), 3 deletions(-)

diff --git a/Documentation/DocBook/media/v4l/vidioc-g-frequency.xml 
b/Documentation/DocBook/media/v4l/vidioc-g-frequency.xml
index 69c178a..40e58a4 100644
--- a/Documentation/DocBook/media/v4l/vidioc-g-frequency.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-g-frequency.xml
@@ -135,6 +135,12 @@ bounds or the value in the structfieldtype/structfield 
field is
 wrong./para
/listitem
   /varlistentry
+  varlistentry
+   termerrorcodeEBUSY/errorcode/term
+   listitem
+ paraA hardware seek is in progress./para
+   /listitem
+  /varlistentry
 /variablelist
   /refsect1
 /refentry
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml 
b/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml
index 62a1aa2..95d5371 100644
--- a/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml
@@ -276,6 +276,18 @@ can or must be switched. (B/G PAL tuners for example are 
typically not
   constantV4L2_TUNER_ANALOG_TV/constant tuners can have this 
capability./entry
  /row
  row
+   entryconstantV4L2_TUNER_CAP_HWSEEK_BOUNDED/constant/entry
+   entry0x0004/entry
+   entryIf set, then this tuner supports the hardware seek 
functionality
+   where the seek stops when it reaches the end of the frequency 
range./entry
+ /row
+ row
+   entryconstantV4L2_TUNER_CAP_HWSEEK_WRAP/constant/entry
+   entry0x0008/entry
+   entryIf set, then this tuner supports the hardware seek 
functionality
+   where the seek wraps around when it reaches the end of the 
frequency range./entry
+ /row
+ row
entryconstantV4L2_TUNER_CAP_STEREO/constant/entry
entry0x0010/entry
entryStereo audio reception is supported./entry
diff --git a/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml 
b/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml
index 407dfce..d58b648 100644
--- a/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml
@@ -58,6 +58,9 @@ To do this applications initialize the 
structfieldtuner/structfield,
 call the constantVIDIOC_S_HW_FREQ_SEEK/constant ioctl with a pointer
 to this structure./para
 
+paraIf an error is returned, then the frequency original frequency will
+be restored./para
+
 paraThis ioctl is supported if the 
constantV4L2_CAP_HW_FREQ_SEEK/constant capability is set./para
 
 table pgwide=1 frame=none id=v4l2-hw-freq-seek
@@ -87,7 +90,10 @@ field and the v4l2-tuner; structfieldindex/structfield 
field./entry
  row
entry__u32/entry
entrystructfieldwrap_around/structfield/entry
-   entryIf non-zero, wrap around when at the end of the frequency 
range, else stop seeking./entry
+   entryIf non-zero, wrap around when at the end of the frequency 
range, else stop seeking.
+   The v4l2-tuner; structfieldcapability/structfield field will 
tell you what the
+   hardware supports.
+   /entry
  /row
  row
entry__u32/entry
@@ -118,9 +124,15 @@ wrong./para
/listitem
   /varlistentry
   varlistentry
-   termerrorcodeEAGAIN/errorcode/term
+   termerrorcodeENODATA/errorcode/term
+   listitem
+ paraThe hardware seek found no channels./para
+   /listitem
+  /varlistentry
+  varlistentry
+   termerrorcodeEBUSY/errorcode/term
listitem
- paraThe ioctl timed-out. Try again./para
+ paraAnother hardware seek is already in progress./para
/listitem
   /varlistentry
 /variablelist
-- 
1.7.10

--
To unsubscribe from this list: send the line unsubscribe linux-media in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [RFCv1 PATCH 2/5] v4l2 spec: document the new v4l2_tuner capabilities

2012-05-27 Thread Hans de Goede

Small typo, see comment inline, with that fixed:

Acked-by: Hans de Goede hdego...@redhat.com

On 05/27/2012 01:50 PM, Hans Verkuil wrote:

From: Hans Verkuilhans.verk...@cisco.com

Update the spec with the new capabilities and specify new error codes for
S_HW_FREQ_SEEK.

Signed-off-by: Hans Verkuilhans.verk...@cisco.com
---
  .../DocBook/media/v4l/vidioc-g-frequency.xml |6 ++
  Documentation/DocBook/media/v4l/vidioc-g-tuner.xml   |   12 
  .../DocBook/media/v4l/vidioc-s-hw-freq-seek.xml  |   18 +++---
  3 files changed, 33 insertions(+), 3 deletions(-)

diff --git a/Documentation/DocBook/media/v4l/vidioc-g-frequency.xml 
b/Documentation/DocBook/media/v4l/vidioc-g-frequency.xml
index 69c178a..40e58a4 100644
--- a/Documentation/DocBook/media/v4l/vidioc-g-frequency.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-g-frequency.xml
@@ -135,6 +135,12 @@ bounds or the value in thestructfieldtype/structfield  
field is
  wrong./para
/listitem
/varlistentry
+varlistentry
+   termerrorcodeEBUSY/errorcode/term
+   listitem
+   paraA hardware seek is in progress./para
+   /listitem
+/varlistentry
  /variablelist
/refsect1
  /refentry
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml 
b/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml
index 62a1aa2..95d5371 100644
--- a/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-g-tuner.xml
@@ -276,6 +276,18 @@ can or must be switched. (B/G PAL tuners for example are 
typically not
constantV4L2_TUNER_ANALOG_TV/constant  tuners can have this 
capability./entry
/row
row
+   entryconstantV4L2_TUNER_CAP_HWSEEK_BOUNDED/constant/entry
+   entry0x0004/entry
+   entryIf set, then this tuner supports the hardware seek functionality
+   where the seek stops when it reaches the end of the frequency 
range./entry
+   /row
+   row
+   entryconstantV4L2_TUNER_CAP_HWSEEK_WRAP/constant/entry
+   entry0x0008/entry
+   entryIf set, then this tuner supports the hardware seek functionality
+   where the seek wraps around when it reaches the end of the frequency 
range./entry
+   /row
+   row
entryconstantV4L2_TUNER_CAP_STEREO/constant/entry
entry0x0010/entry
entryStereo audio reception is supported./entry
diff --git a/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml 
b/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml
index 407dfce..d58b648 100644
--- a/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml
@@ -58,6 +58,9 @@ To do this applications initialize 
thestructfieldtuner/structfield,
  call theconstantVIDIOC_S_HW_FREQ_SEEK/constant  ioctl with a pointer
  to this structure./para

+paraIf an error is returned, then the frequency original frequency will
+be restored./para
+


One frequency too many in that sentence :)


  paraThis ioctl is supported if theconstantV4L2_CAP_HW_FREQ_SEEK/constant  
capability is set./para

  table pgwide=1 frame=none id=v4l2-hw-freq-seek
@@ -87,7 +90,10 @@ field and thev4l2-tuner;structfieldindex/structfield  
field./entry
row
entry__u32/entry
entrystructfieldwrap_around/structfield/entry
-   entryIf non-zero, wrap around when at the end of the frequency range, else 
stop seeking./entry
+   entryIf non-zero, wrap around when at the end of the frequency range, 
else stop seeking.
+   Thev4l2-tuner;structfieldcapability/structfield  field will 
tell you what the
+   hardware supports.
+   /entry
/row
row
entry__u32/entry
@@ -118,9 +124,15 @@ wrong./para
/listitem
/varlistentry
varlistentry
-   termerrorcodeEAGAIN/errorcode/term
+   termerrorcodeENODATA/errorcode/term
+   listitem
+   paraThe hardware seek found no channels./para
+   /listitem
+/varlistentry
+varlistentry
+   termerrorcodeEBUSY/errorcode/term
listitem
-   paraThe ioctl timed-out. Try again./para
+   paraAnother hardware seek is already in progress./para
/listitem
/varlistentry
  /variablelist

--
To unsubscribe from this list: send the line unsubscribe linux-media in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html