drivers/staging/media/go7007/go7007.txt

   1 This is a driver for the WIS GO7007SB multi-format video encoder.
   2
   3 Pete Eberlein <pete@sensoray.com>
   4
   5 The driver was originally released under the GPL and is currently hosted at:
   6 http://nikosapi.org/wiki/index.php/WIS_Go7007_Linux_driver
   7 The go7007 firmware can be acquired from the package on the site above.
   8
   9 I've modified the driver to support the following Video4Linux2 MPEG
  10 controls, with acceptable values:
  11
  12 V4L2_CID_MPEG_STREAM_TYPE       V4L2_MPEG_STREAM_TYPE_MPEG2_DVD
  13                                 V4L2_MPEG_STREAM_TYPE_MPEG_ELEM
  14 V4L2_CID_MPEG_VIDEO_ENCODING    V4L2_MPEG_VIDEO_ENCODING_MPEG_1
  15                                 V4L2_MPEG_VIDEO_ENCODING_MPEG_2
  16                                 V4L2_MPEG_VIDEO_ENCODING_MPEG_4
  17 V4L2_CID_MPEG_VIDEO_ASPECT      V4L2_MPEG_VIDEO_ASPECT_1x1
  18                                 V4L2_MPEG_VIDEO_ASPECT_4x3
  19                                 V4L2_MPEG_VIDEO_ASPECT_16x9
  20 V4L2_CID_MPEG_VIDEO_GOP_SIZE    integer
  21 V4L2_CID_MPEG_VIDEO_BITRATE     64000 .. 10000000
  22
  23 These should be used instead of the non-standard GO7007 ioctls described
  24 below.
  25
  26
  27 The README files from the orignal package appear below:
  28
  29 ---------------------------------------------------------------------------
  30                      WIS GO7007SB Public Linux Driver
  31 ---------------------------------------------------------------------------
  32
  33
  34 *** Please see the file RELEASE-NOTES for important last-minute updates ***
  35
  36
  37   0. OVERVIEW AND LICENSING/DISCLAIMER
  38
  39
  40 This driver kit contains Linux drivers for the WIS GO7007SB multi-format
  41 video encoder.  Only kernel version 2.6.x is supported.  The video stream
  42 is available through the Video4Linux2 API and the audio stream is available
  43 through the ALSA API (or the OSS emulation layer of the ALSA system).
  44
  45 The files in kernel/ and hotplug/ are licensed under the GNU General Public
  46 License Version 2 from the Free Software Foundation.  A copy of the license
  47 is included in the file COPYING.
  48
  49 The example applications in apps/ and C header files in include/ are
  50 licensed under a permissive license included in the source files which
  51 allows copying, modification and redistribution for any purpose without
  52 attribution.
  53
  54 The firmware files included in the firmware/ directory may be freely
  55 redistributed only in conjunction with this document; but modification,
  56 tampering and reverse engineering are prohibited.
  57
  58 MICRONAS USA, INC., MAKES NO WARRANTIES TO ANY PERSON OR ENTITY WITH
  59 RESPECT TO THE SOFTWARE OR ANY DERIVATIVES THEREOF OR ANY SERVICES OR
  60 LICENSES AND DISCLAIMS ALL IMPLIED WARRANTIES, INCLUDING WITHOUT LIMITATION
  61 WARRANTIES OF MERCHANTABILITY, SUPPORT, AND FITNESS FOR A PARTICULAR
  62 PURPOSE AND NON-INFRINGEMENT.
  63
  64
  65   1. SYSTEM REQUIREMENTS
  66
  67
  68 This driver requires Linux kernel 2.6.  Kernel 2.4 is not supported.  Using
  69 kernel 2.6.10 or later is recommended, as earlier kernels are known to have
  70 unstable USB 2.0 support.
  71
  72 A fully built kernel source tree must be available.  Typically this will be
  73 linked from "/lib/modules/<KERNEL VERSION>/build" for convenience.  If this
  74 link does not exist, an extra parameter will need to be passed to the
  75 `make` command.
  76
  77 All vendor-built kernels should already be configured properly.  However,
  78 for custom-built kernels, the following options need to be enabled in the
  79 kernel as built-in or modules:
  80
  81         CONFIG_MODULES           - Enable loadable module support
  82         CONFIG_FW_LOADER         - Hotplug firmware loading support
  83         CONFIG_I2C               - I2C support
  84         CONFIG_VIDEO_DEV         - Video For Linux
  85         CONFIG_SOUND             - Sound card support
  86         CONFIG_SND               - Advanced Linux Sound Architecture
  87         CONFIG_USB               - Support for Host-side USB
  88         CONFIG_USB_EHCI_HCD      - EHCI HCD (USB 2.0) support
  89
  90 Additionally, to use the example application, the following options need to
  91 be enabled in the ALSA section:
  92
  93         CONFIG_SND_MIXER_OSS     - OSS Mixer API
  94         CONFIG_SND_PCM_OSS       - OSS PCM (digital audio) API
  95
  96 The hotplug scripts, along with the fxload utility, must also be installed.
  97 These scripts can be obtained from <http://linux-hotplug.sourceforge.net/>.
  98 Hotplugging is used for loading firmware into the Cypruss EZ-USB chip using
  99 fxload and for loading firmware into the driver using the firmware agent.
 100
 101
 102   2. COMPILING AND INSTALLING THE DRIVER
 103
 104
 105 Most users should be able to compile the driver by simply running:
 106
 107         $ make
 108
 109 in the top-level directory of the driver kit.  First the kernel modules
 110 will be built, followed by the example applications.
 111
 112 If the build system is unable to locate the kernel source tree for the
 113 currently-running kernel, or if the module should be built for a kernel
 114 other than the currently-running kernel, an additional parameter will need
 115 to be passed to make to specify the appropriate kernel source directory:
 116
 117         $ make KERNELSRC=/usr/src/linux-2.6.10-custom3
 118
 119 Once the compile completes, the driver and firmware files should be
 120 installed by running:
 121
 122         $ make install
 123
 124 The kernel modules will be placed in "/lib/modules/<KERNEL VERSION>/extra"
 125 and the firmware files will be placed in the appropriate hotplug firmware
 126 directory, usually /lib/firmware.  In addition, USB maps and scripts will
 127 be placed in /etc/hotplug/usb to enable fxload to initialize the EZ-USB
 128 control chip when the device is connected.
 129
 130
 131   3. PAL/SECAM TUNER CONFIGURATION (TV402U-EU only)
 132
 133
 134 The PAL model of the Plextor ConvertX TV402U may require additional
 135 configuration to correctly select the appropriate TV frequency band and
 136 audio subchannel.
 137
 138 Users with a device other than the Plextor ConvertX TV402U-EU should skip
 139 this section.
 140
 141 The wide variety of PAL TV systems used in Europe requires that additional
 142 information about the local TV standards be passed to the driver in order
 143 to properly tune TV channels.  The two necessary parameters are (a) the PAL
 144 TV band, and (b) the audio subchannel format in use.
 145
 146 In many cases, the appropriate TV band selection is passed to the driver
 147 from applications.  However, in some cases, the application only specifies
 148 that the driver should use PAL but not the specific information about the
 149 appropriate TV band.  To work around this issue, the correct TV band may be
 150 specified in the "force_band" parameter to the wis-sony-tuner module:
 151
 152      TV band           force_band
 153      -------           ----------
 154      PAL B/G                B
 155      PAL I                  I
 156      PAL D/K                D
 157      SECAM L                L
 158
 159 If the "force_band" parameter is specified, the driver will ignore any TV
 160 band specified by applications and will always use the band provided in the
 161 module parameter.
 162
 163 The other parameter that can be specified is the audio subchannel format.
 164 There are several stereo audio carrier systems in use, including NICAM and
 165 three varieties of A2.  To receive audio broadcast on one of these stereo
 166 carriers, the "force_mpx_mode" parameter must be specified to the
 167 wis-sony-tuner module.
 168
 169      TV band           Audio subcarrier       force_mpx_mode
 170      -------           ----------------       --------------
 171      PAL B/G            Mono (default)               1
 172      PAL B/G                  A2                     2
 173      PAL B/G                 NICAM                   3
 174      PAL I              Mono (default)               4
 175      PAL I                   NICAM                   5
 176      PAL D/K            Mono (default)               6
 177      PAL D/K                 A2 (1)                  7
 178      PAL D/K                 A2 (2)                  8
 179      PAL D/K                 A2 (3)                  9
 180      PAL D/K                 NICAM                  10
 181      SECAM L            Mono (default)              11
 182      SECAM L                 NICAM                  12
 183
 184 If the "force_mpx_mode" parameter is not specified, the correct mono-only
 185 mode will be chosen based on the TV band.  However, the tuner will not
 186 receive stereo audio or bilingual broadcasts correctly.
 187
 188 To pass the "force_band" or "force_mpx_mode" parameters to the
 189 wis-sony-tuner module, the following line must be added to the modprobe
 190 configuration file, which varies from one Linux distribution to another.
 191
 192      options wis-sony-tuner force_band=B force_mpx_mode=2
 193
 194 The above example would force the tuner to the PAL B/G TV band and receive
 195 stereo audio broadcasts on the A2 carrier.
 196
 197 To verify that the configuration has been placed in the correct location,
 198 execute:
 199
 200         $ modprobe -c | grep wis-sony-tuner
 201
 202 If the configuration line appears, then modprobe will pass the parameters
 203 correctly the next time the wis-sony-tuner module is loaded into the
 204 kernel.
 205
 206
 207   4. TESTING THE DRIVER
 208
 209
 210 Because few Linux applications are able to correctly capture from
 211 Video4Linux2 devices with only compressed formats supported, the new driver
 212 should be tested with the "gorecord" application in the apps/ directory.
 213
 214 First connect a video source to the device, such as a DVD player or VCR.
 215 This will be captured to a file for testing the driver.  If an input source
 216 is unavailable, a test file can still be captured, but the video will be
 217 black and the audio will be silent.
 218
 219 This application will auto-detect the V4L2 and ALSA/OSS device names of the
 220 hardware and will record video and audio to an AVI file for a specified
 221 number of seconds.  For example:
 222
 223         $ apps/gorecord -duration 60 capture.avi
 224
 225 If this application does not successfully record an AVI file, the error
 226 messages produced by gorecord and recorded in the system log (usually in
 227 /var/log/messages) should provide information to help resolve the problem.
 228
 229 Supplying no parameters to gorecord will cause it to probe the available
 230 devices and exit.  Use the -help flag for usage information.
 231
 232
 233   5. USING THE DRIVER
 234
 235
 236 The V4L2 device implemented by the driver provides a standard compressed
 237 format API, within the following criteria:
 238
 239   * Applications that only support the original Video4Linux1 API will not
 240     be able to communicate with this driver at all.
 241
 242   * No raw video modes are supported, so applications like xawtv that
 243     expect only uncompressed video will not function.
 244
 245   * Supported compression formats are: Motion-JPEG, MPEG1, MPEG2 and MPEG4.
 246
 247   * MPEG video formats are delivered as Video Elementary Streams only.
 248     Program Stream (PS), Transport Stream (TS) and Packetized Elementary
 249     Stream (PES) formats are not supported.
 250
 251   * Video parameters such as format and input port may not be changed while
 252     the encoder is active.
 253
 254   * The audio capture device only functions when the video encoder is
 255     actively capturing video.  Attempts to read from the audio device when
 256     the encoder is inactive will result in an I/O error.
 257
 258   * The native format of the audio device is 48Khz 2-channel 16-bit
 259     little-endian PCM, delivered through the ALSA system.  No audio
 260     compression is implemented in the hardware.  ALSA may convert to other
 261     uncompressed formats on the fly.
 262
 263 The include/ directory contains a C header file describing non-standard
 264 features of the GO7007SB encoder, which are described below:
 265
 266
 267   GO7007IOC_S_COMP_PARAMS, GO7007IOC_G_COMP_PARAMS
 268
 269     These ioctls are used to negotiate general compression parameters.
 270
 271     To query the current parameters, call the GO7007IOC_G_COMP_PARAMS ioctl
 272     with a pointer to a struct go7007_comp_params.  If the driver is not
 273     set to MPEG format, the EINVAL error code will be returned.
 274
 275     To change the current parameters, initialize all fields of a struct
 276     go7007_comp_params and call the GO7007_IOC_S_COMP_PARAMS ioctl with a
 277     pointer to this structure.  The driver will return the current
 278     parameters with any necessary changes to conform to the limitations of
 279     the hardware or current compression mode.  Any or all fields can be set
 280     to zero to request a reasonable default value.  If the driver is not
 281     set to MPEG format, the EINVAL error code will be returned.  When I/O
 282     is in progress, the EBUSY error code will be returned.
 283
 284     Fields in struct go7007_comp_params:
 285
 286         __u32                        The maximum number of frames in each
 287           gop_size                   Group Of Pictures; i.e. the maximum
 288                                      number of frames minus one between
 289                                      each key frame.
 290
 291         __u32                        The maximum number of sequential
 292           max_b_frames               bidirectionally-predicted frames.
 293                                      (B-frames are not yet supported.)
 294
 295         enum go7007_aspect_ratio     The aspect ratio to be encoded in the
 296           aspect_ratio               meta-data of the compressed format.
 297
 298                                      Choices are:
 299                                         GO7007_ASPECT_RATIO_1_1
 300                                         GO7007_ASPECT_RATIO_4_3_NTSC
 301                                         GO7007_ASPECT_RATIO_4_3_PAL
 302                                         GO7007_ASPECT_RATIO_16_9_NTSC
 303                                         GO7007_ASPECT_RATIO_16_9_PAL
 304
 305         __u32                        Bit-wise OR of control flags (below)
 306           flags
 307
 308     Flags in struct go7007_comp_params:
 309
 310         GO7007_COMP_CLOSED_GOP       Only produce self-contained GOPs, used
 311                                      to produce streams appropriate for
 312                                      random seeking.
 313
 314         GO7007_COMP_OMIT_SEQ_HEADER  Omit the stream sequence header.
 315
 316
 317   GO7007IOC_S_MPEG_PARAMS, GO7007IOC_G_MPEG_PARAMS
 318
 319     These ioctls are used to negotiate MPEG-specific stream parameters when
 320     the pixelformat has been set to V4L2_PIX_FMT_MPEG.
 321
 322     To query the current parameters, call the GO7007IOC_G_MPEG_PARAMS ioctl
 323     with a pointer to a struct go7007_mpeg_params.  If the driver is not
 324     set to MPEG format, the EINVAL error code will be returned.
 325
 326     To change the current parameters, initialize all fields of a struct
 327     go7007_mpeg_params and call the GO7007_IOC_S_MPEG_PARAMS ioctl with a
 328     pointer to this structure.  The driver will return the current
 329     parameters with any necessary changes to conform to the limitations of
 330     the hardware or selected MPEG mode.  Any or all fields can be set to
 331     zero to request a reasonable default value.  If the driver is not set
 332     to MPEG format, the EINVAL error code will be returned.  When I/O is in
 333     progress, the EBUSY error code will be returned.
 334
 335     Fields in struct go7007_mpeg_params:
 336
 337         enum go7007_mpeg_video_standard
 338           mpeg_video_standard        The MPEG video standard in which to
 339                                      compress the video.
 340
 341                                      Choices are:
 342                                         GO7007_MPEG_VIDEO_MPEG1
 343                                         GO7007_MPEG_VIDEO_MPEG2
 344                                         GO7007_MPEG_VIDEO_MPEG4
 345
 346         __u32                        Bit-wise OR of control flags (below)
 347           flags
 348
 349         __u32                        The profile and level indication to be
 350           pali                       stored in the sequence header.  This
 351                                      is only used as an indicator to the
 352                                      decoder, and does not affect the MPEG
 353                                      features used in the video stream.
 354                                      Not valid for MPEG1.
 355
 356                                      Choices for MPEG2 are:
 357                                         GO7007_MPEG2_PROFILE_MAIN_MAIN
 358
 359                                      Choices for MPEG4 are:
 360                                         GO7007_MPEG4_PROFILE_S_L0
 361                                         GO7007_MPEG4_PROFILE_S_L1
 362                                         GO7007_MPEG4_PROFILE_S_L2
 363                                         GO7007_MPEG4_PROFILE_S_L3
 364                                         GO7007_MPEG4_PROFILE_ARTS_L1
 365                                         GO7007_MPEG4_PROFILE_ARTS_L2
 366                                         GO7007_MPEG4_PROFILE_ARTS_L3
 367                                         GO7007_MPEG4_PROFILE_ARTS_L4
 368                                         GO7007_MPEG4_PROFILE_AS_L0
 369                                         GO7007_MPEG4_PROFILE_AS_L1
 370                                         GO7007_MPEG4_PROFILE_AS_L2
 371                                         GO7007_MPEG4_PROFILE_AS_L3
 372                                         GO7007_MPEG4_PROFILE_AS_L4
 373                                         GO7007_MPEG4_PROFILE_AS_L5
 374
 375     Flags in struct go7007_mpeg_params:
 376
 377         GO7007_MPEG_FORCE_DVD_MODE   Force all compression parameters and
 378                                      bitrate control settings to comply
 379                                      with DVD MPEG2 stream requirements.
 380                                      This overrides most compression and
 381                                      bitrate settings!
 382
 383         GO7007_MPEG_OMIT_GOP_HEADER  Omit the GOP header.
 384
 385         GO7007_MPEG_REPEAT_SEQHEADER Repeat the MPEG sequence header at
 386                                      the start of each GOP.
 387
 388
 389   GO7007IOC_S_BITRATE, GO7007IOC_G_BITRATE
 390
 391     These ioctls are used to set and query the target bitrate value for the
 392     compressed video stream.  The bitrate may be selected by storing the
 393     target bits per second in an int and calling GO7007IOC_S_BITRATE with a
 394     pointer to the int.  The bitrate may be queried by calling
 395     GO7007IOC_G_BITRATE with a pointer to an int where the current bitrate
 396     will be stored.
 397
 398     Note that this is the primary means of controlling the video quality
 399     for all compression modes, including V4L2_PIX_FMT_MJPEG.  The
 400     VIDIOC_S_JPEGCOMP ioctl is not supported.
 401
 402
 403 ----------------------------------------------------------------------------
 404                    Installing the WIS PCI Voyager Driver
 405 ---------------------------------------------------------------------------
 406
 407 The WIS PCI Voyager driver requires several patches to the Linux 2.6.11.x
 408 kernel source tree before compiling the driver.  These patches update the
 409 in-kernel SAA7134 driver to the newest development version and patch bugs
 410 in the TDA8290/TDA8275 tuner driver.
 411
 412 The following patches must be downloaded from Gerd Knorr's website and
 413 applied in the order listed:
 414
 415         http://dl.bytesex.org/patches/2.6.11-2/i2c-tuner
 416         http://dl.bytesex.org/patches/2.6.11-2/i2c-tuner2
 417         http://dl.bytesex.org/patches/2.6.11-2/v4l2-api-mpeg
 418         http://dl.bytesex.org/patches/2.6.11-2/saa7134-update
 419
 420 The following patches are included with this SDK and can be applied in any
 421 order:
 422
 423         patches/2.6.11/saa7134-voyager.diff
 424         patches/2.6.11/tda8275-newaddr.diff
 425         patches/2.6.11/tda8290-ntsc.diff
 426
 427 Check to make sure the CONFIG_VIDEO_SAA7134 option is enabled in the kernel
 428 configuration, and build and install the kernel.
 429
 430 After rebooting into the new kernel, the GO7007 driver can be compiled and
 431 installed:
 432
 433         $ make SAA7134_BUILD=y
 434         $ make install
 435         $ modprobe saa7134-go7007
 436
 437 There will be two V4L video devices associated with the PCI Voyager.  The
 438 first device (most likely /dev/video0) provides access to the raw video
 439 capture mode of the SAA7133 device and is used to configure the source
 440 video parameters and tune the TV tuner.  This device can be used with xawtv
 441 or other V4L(2) video software as a standard uncompressed device.
 442
 443 The second device (most likely /dev/video1) provides access to the
 444 compression functions of the GO7007.  It can be tested using the gorecord
 445 application in the apps/ directory of this SDK:
 446
 447         $ apps/gorecord -vdevice /dev/video1 -noaudio test.avi
 448
 449 Currently the frame resolution is fixed at 720x480 (NTSC) or 720x576 (PAL),
 450 and the video standard must be specified to both the raw and the compressed
 451 video devices (xawtv and gorecord, for example).
 452
 453
 454 --------------------------------------------------------------------------
 455 RELEASE NOTES FOR WIS GO7007SB LINUX DRIVER
 456 ---------------------------------------------------------------------------
 457
 458 Last updated: 5 November 2005
 459
 460  - Release 0.9.7 includes new support for using udev to run fxload.  The
 461    install script should automatically detect whether the old hotplug
 462    scripts or the new udev rules should be used.  To force the use of
 463    hotplug, run "make install USE_UDEV=n".  To force the use of udev, run
 464    "make install USE_UDEV=y".
 465
 466  - Motion detection is supported but undocumented.  Try the `modet` app
 467    for a demonstration of how to use the facility.
 468
 469  - Using USB2.0 devices such as the TV402U with USB1.1 HCDs or hubs can
 470    cause buffer overruns and frame drops, even at low framerates, due to
 471    inconsistency in the bitrate control mechanism.
 472
 473  - On devices with an SAA7115, including the Plextor ConvertX, video height
 474    values of 96, 128, 160, 192, 256, 320, and 384 do not work in NTSC mode.
 475    All valid heights up to 512 work correctly in PAL mode.
 476
 477  - The WIS Star Trek and PCI Voyager boards have no support yet for audio
 478    or the TV tuner.