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