README

   1 .. SPDX-License-Identifier: CC-BY-SA-4.0
   2 .. SPDX-FileCopyrightText: 2016-2019 Renesas Electronics Corporation
   3
   4 vsp-tests
   5 ---------
   6
   7 Test suite for the Renesas R-Car VSP1 and VSP2 video processing engines.
   8
   9 You can find the latest version of vsp-tests in the project's git tree at
  10
  11         git://git.ideasonboard.com/renesas/vsp-tests.git
  12         http://git.ideasonboard.com/renesas/vsp-tests.git
  13
  14
  15 --------
  16 Building
  17 --------
  18
  19 The vsp-tests suite requires the following tools to be installed on the host
  20 to generate the test scripts, applications and data.
  21
  22 * gcc
  23 * make
  24 * python
  25
  26 After installing the needed packages, you can build the test suite by running
  27
  28         make
  29
  30 in the vsp-tests root directory. Then, to install the test suite, run
  31
  32         make install INSTALL_DIR=/path/to/target/directory
  33
  34 This will copy the test scripts and applications to the target directory to be
  35 copied or exported to the host.
  36
  37
  38 --------------------
  39 Runtime Dependencies
  40 --------------------
  41
  42 The tests scripts require the following tools to be installed on the target
  43 system in a directory included in $PATH.
  44
  45 * compare (part of ImageMagick)
  46 * killall (available from the psmisc package)
  47 * media-ctl (part of v4l-utils, available at git://linuxtv.org/v4l-utils.git)
  48 * raw2rgbpnm (available at git://git.retiisi.org.uk/~sailus/raw2rgbpnm.git)
  49 * yavta (available at git://git.ideasonboard.org/yavta.git)
  50
  51 The following tool is additionally required to run some of the tests. If the
  52 tool is not available the corresponding tests will be skipped.
  53
  54 * stress (available at http://people.seas.harvard.edu/~apw/stress/)
  55
  56
  57 -----------------
  58 Running the Tests
  59 -----------------
  60
  61 The test scripts are named vsp-unit-test-[0-9]*.sh. They can be run directly
  62 from the test suite root directory.
  63
  64 Test options:
  65
  66 - VSP_KEEP_FRAMES: When the VSP_KEEP_FRAMES environment variable is set to 1,
  67   all frame files will be preserved regardless of the tests results. Otherwise
  68   frame files for successful tests are removed.
  69