<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML
><HEAD
><TITLE
>The Ioctl Interface</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="Video4Linux Programming"
HREF="book1.html"><LINK
REL="UP"
TITLE="Radio Devices"
HREF="c24.html"><LINK
REL="PREVIOUS"
TITLE="Opening And Closing The Radio"
HREF="x65.html"><LINK
REL="NEXT"
TITLE="Module Wrapper"
HREF="x254.html"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Video4Linux Programming</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="x65.html"
ACCESSKEY="P"
><<< Previous</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Radio Devices</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="x254.html"
ACCESSKEY="N"
>Next >>></A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="IOCTLRADIO"
></A
>The Ioctl Interface</H1
><P
> This leaves the ioctl routine, without which the driver will not be
terribly useful to anyone.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>
static int radio_ioctl(struct video_device *dev, unsigned int cmd, void *arg)
{
switch(cmd)
{
case VIDIOCGCAP:
{
struct video_capability v;
v.type = VID_TYPE_TUNER;
v.channels = 1;
v.audios = 1;
v.maxwidth = 0;
v.minwidth = 0;
v.maxheight = 0;
v.minheight = 0;
strcpy(v.name, "My Radio");
if(copy_to_user(arg, &v, sizeof(v)))
return -EFAULT;
return 0;
}
</PRE
></TD
></TR
></TABLE
><P
> VIDIOCGCAP is the first ioctl all video4linux devices must support. It
allows the applications to find out what sort of a card they have found and
to figure out what they want to do about it. The fields in the structure are
</P
><DIV
CLASS="TABLE"
><A
NAME="AEN78"
></A
><P
><B
>Table 2. struct video_capability fields</B
></P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>name</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The device text name. This is intended for the user.</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>channels</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The number of different channels you can tune on
this card. It could even by zero for a card that has
no tuning capability. For our simple FM radio it is 1.
An AM/FM radio would report 2.</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>audios</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The number of audio inputs on this device. For our
radio there is only one audio input.</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>minwidth,minheight</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The smallest size the card is capable of capturing
images in. We set these to zero. Radios do not
capture pictures</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>maxwidth,maxheight</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The largest image size the card is capable of
capturing. For our radio we report 0.
</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>type</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>This reports the capabilities of the device, and
matches the field we filled in in the struct
video_device when registering.</TD
></TR
></TBODY
></TABLE
></DIV
><P
> Having filled in the fields, we use copy_to_user to copy the structure into
the users buffer. If the copy fails we return an EFAULT to the application
so that it knows it tried to feed us garbage.
</P
><P
> The next pair of ioctl operations select which tuner is to be used and let
the application find the tuner properties. We have only a single FM band
tuner in our example device.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>
case VIDIOCGTUNER:
{
struct video_tuner v;
if(copy_from_user(&v, arg, sizeof(v))!=0)
return -EFAULT;
if(v.tuner)
return -EINVAL;
v.rangelow=(87*16000);
v.rangehigh=(108*16000);
v.flags = VIDEO_TUNER_LOW;
v.mode = VIDEO_MODE_AUTO;
v.signal = 0xFFFF;
strcpy(v.name, "FM");
if(copy_to_user(&v, arg, sizeof(v))!=0)
return -EFAULT;
return 0;
}
</PRE
></TD
></TR
></TABLE
><P
> The VIDIOCGTUNER ioctl allows applications to query a tuner. The application
sets the tuner field to the tuner number it wishes to query. The query does
not change the tuner that is being used, it merely enquires about the tuner
in question.
</P
><P
> We have exactly one tuner so after copying the user buffer to our temporary
structure we complain if they asked for a tuner other than tuner 0.
</P
><P
> The video_tuner structure has the following fields
</P
><DIV
CLASS="TABLE"
><A
NAME="AEN106"
></A
><P
><B
>Table 3. struct video_tuner fields</B
></P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>int tuner</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The number of the tuner in question</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>char name[32]</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>A text description of this tuner. "FM" will do fine.
This is intended for the application.</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>u32 flags</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Tuner capability flags</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>u16 mode</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The current reception mode</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>u16 signal</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The signal strength scaled between 0 and 65535. If
a device cannot tell the signal strength it should
report 65535. Many simple cards contain only a
signal/no signal bit. Such cards will report either
0 or 65535.</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>u32 rangelow, rangehigh</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
> The range of frequencies supported by the radio
or TV. It is scaled according to the VIDEO_TUNER_LOW
flag.</TD
></TR
></TBODY
></TABLE
></DIV
><DIV
CLASS="TABLE"
><A
NAME="AEN128"
></A
><P
><B
>Table 4. struct video_tuner flags</B
></P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_TUNER_PAL</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>A PAL TV tuner</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_TUNER_NTSC</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>An NTSC (US) TV tuner</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_TUNER_SECAM</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>A SECAM (French) TV tuner</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_TUNER_LOW</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
> The tuner frequency is scaled in 1/16th of a KHz
steps. If not it is in 1/16th of a MHz steps
</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_TUNER_NORM</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The tuner can set its format</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_TUNER_STEREO_ON</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The tuner is currently receiving a stereo signal</TD
></TR
></TBODY
></TABLE
></DIV
><DIV
CLASS="TABLE"
><A
NAME="AEN150"
></A
><P
><B
>Table 5. struct video_tuner modes</B
></P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_MODE_PAL</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>PAL Format</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_MODE_NTSC</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>NTSC Format (USA)</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_MODE_SECAM</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>French Format</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_MODE_AUTO</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>A device that does not need to do
TV format switching</TD
></TR
></TBODY
></TABLE
></DIV
><P
> The settings for the radio card are thus fairly simple. We report that we
are a tuner called "FM" for FM radio. In order to get the best tuning
resolution we report VIDEO_TUNER_LOW and select tuning to 1/16th of KHz. Its
unlikely our card can do that resolution but it is a fair bet the card can
do better than 1/16th of a MHz. VIDEO_TUNER_LOW is appropriate to almost all
radio usage.
</P
><P
> We report that the tuner automatically handles deciding what format it is
receiving - true enough as it only handles FM radio. Our example card is
also incapable of detecting stereo or signal strengths so it reports a
strength of 0xFFFF (maximum) and no stereo detected.
</P
><P
> To finish off we set the range that can be tuned to be 87-108Mhz, the normal
FM broadcast radio range. It is important to find out what the card is
actually capable of tuning. It is easy enough to simply use the FM broadcast
range. Unfortunately if you do this you will discover the FM broadcast
ranges in the USA, Europe and Japan are all subtly different and some users
cannot receive all the stations they wish.
</P
><P
> The application also needs to be able to set the tuner it wishes to use. In
our case, with a single tuner this is rather simple to arrange.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> case VIDIOCSTUNER:
{
struct video_tuner v;
if(copy_from_user(&v, arg, sizeof(v)))
return -EFAULT;
if(v.tuner != 0)
return -EINVAL;
return 0;
}
</PRE
></TD
></TR
></TABLE
><P
> We copy the user supplied structure into kernel memory so we can examine it.
If the user has selected a tuner other than zero we reject the request. If
they wanted tuner 0 then, surprisingly enough, that is the current tuner already.
</P
><P
> The next two ioctls we need to provide are to get and set the frequency of
the radio. These both use an unsigned long argument which is the frequency.
The scale of the frequency depends on the VIDEO_TUNER_LOW flag as I
mentioned earlier on. Since we have VIDEO_TUNER_LOW set this will be in
1/16ths of a KHz.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> static unsigned long current_freq;
case VIDIOCGFREQ:
if(copy_to_user(arg, &current_freq,
sizeof(unsigned long))
return -EFAULT;
return 0;
</PRE
></TD
></TR
></TABLE
><P
> Querying the frequency in our case is relatively simple. Our radio card is
too dumb to let us query the signal strength so we remember our setting if
we know it. All we have to do is copy it to the user.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>
case VIDIOCSFREQ:
{
u32 freq;
if(copy_from_user(arg, &freq,
sizeof(unsigned long))!=0)
return -EFAULT;
if(hardware_set_freq(freq)<0)
return -EINVAL;
current_freq = freq;
return 0;
}
</PRE
></TD
></TR
></TABLE
><P
> Setting the frequency is a little more complex. We begin by copying the
desired frequency into kernel space. Next we call a hardware specific routine
to set the radio up. This might be as simple as some scaling and a few
writes to an I/O port. For most radio cards it turns out a good deal more
complicated and may involve programming things like a phase locked loop on
the card. This is what documentation is for.
</P
><P
> The final set of operations we need to provide for our radio are the
volume controls. Not all radio cards can even do volume control. After all
there is a perfectly good volume control on the sound card. We will assume
our radio card has a simple 4 step volume control.
</P
><P
> There are two ioctls with audio we need to support
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> static int current_volume=0;
case VIDIOCGAUDIO:
{
struct video_audio v;
if(copy_from_user(&v, arg, sizeof(v)))
return -EFAULT;
if(v.audio != 0)
return -EINVAL;
v.volume = 16384*current_volume;
v.step = 16384;
strcpy(v.name, "Radio");
v.mode = VIDEO_SOUND_MONO;
v.balance = 0;
v.base = 0;
v.treble = 0;
if(copy_to_user(arg. &v, sizeof(v)))
return -EFAULT;
return 0;
}
</PRE
></TD
></TR
></TABLE
><P
> Much like the tuner we start by copying the user structure into kernel
space. Again we check if the user has asked for a valid audio input. We have
only input 0 and we punt if they ask for another input.
</P
><P
> Then we fill in the video_audio structure. This has the following format
</P
><DIV
CLASS="TABLE"
><A
NAME="AEN182"
></A
><P
><B
>Table 6. struct video_audio fields</B
></P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>audio</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The input the user wishes to query</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>volume</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The volume setting on a scale of 0-65535</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>base</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The base level on a scale of 0-65535</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>treble</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The treble level on a scale of 0-65535</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>flags</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The features this audio device supports
</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>name</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>A text name to display to the user. We picked
"Radio" as it explains things quite nicely.</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>mode</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The current reception mode for the audio
We report MONO because our card is too stupid to know if it is in
mono or stereo.
</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>balance</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The stereo balance on a scale of 0-65535, 32768 is
middle.</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>step</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The step by which the volume control jumps. This is
used to help make it easy for applications to set
slider behaviour.</TD
></TR
></TBODY
></TABLE
></DIV
><DIV
CLASS="TABLE"
><A
NAME="AEN213"
></A
><P
><B
>Table 7. struct video_audio flags</B
></P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_AUDIO_MUTE</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The audio is currently muted. We
could fake this in our driver but we
choose not to bother.</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_AUDIO_MUTABLE</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The input has a mute option</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_AUDIO_TREBLE</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The input has a treble control</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_AUDIO_BASS</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The input has a base control</TD
></TR
></TBODY
></TABLE
></DIV
><DIV
CLASS="TABLE"
><A
NAME="AEN229"
></A
><P
><B
>Table 8. struct video_audio modes</B
></P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_SOUND_MONO</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Mono sound</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_SOUND_STEREO</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Stereo sound</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_SOUND_LANG1</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Alternative language 1 (TV specific)</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
>VIDEO_SOUND_LANG2</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Alternative language 2 (TV specific)</TD
></TR
></TBODY
></TABLE
></DIV
><P
> Having filled in the structure we copy it back to user space.
</P
><P
> The VIDIOCSAUDIO ioctl allows the user to set the audio parameters in the
video_audio structure. The driver does its best to honour the request.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> case VIDIOCSAUDIO:
{
struct video_audio v;
if(copy_from_user(&v, arg, sizeof(v)))
return -EFAULT;
if(v.audio)
return -EINVAL;
current_volume = v/16384;
hardware_set_volume(current_volume);
return 0;
}
</PRE
></TD
></TR
></TABLE
><P
> In our case there is very little that the user can set. The volume is
basically the limit. Note that we could pretend to have a mute feature
by rewriting this to
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> case VIDIOCSAUDIO:
{
struct video_audio v;
if(copy_from_user(&v, arg, sizeof(v)))
return -EFAULT;
if(v.audio)
return -EINVAL;
current_volume = v/16384;
if(v.flags&VIDEO_AUDIO_MUTE)
hardware_set_volume(0);
else
hardware_set_volume(current_volume);
current_muted = v.flags &
VIDEO_AUDIO_MUTE;
return 0;
}
</PRE
></TD
></TR
></TABLE
><P
> This with the corresponding changes to the VIDIOCGAUDIO code to report the
state of the mute flag we save and to report the card has a mute function,
will allow applications to use a mute facility with this card. It is
questionable whether this is a good idea however. User applications can already
fake this themselves and kernel space is precious.
</P
><P
> We now have a working radio ioctl handler. So we just wrap up the function
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>
}
return -ENOIOCTLCMD;
}
</PRE
></TD
></TR
></TABLE
><P
> and pass the Video4Linux layer back an error so that it knows we did not
understand the request we got passed.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="x65.html"
ACCESSKEY="P"
><<< Previous</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="book1.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="x254.html"
ACCESSKEY="N"
>Next >>></A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Opening And Closing The Radio</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="c24.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Module Wrapper</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
