Add gen-image tool
[renesas/vsp-tests.git] / README
1 vsp-tests
2 ---------
3
4 Test suite for the Renesas R-Car VSP1 and VSP2 video processing engines.
5
6 You can find the latest version of vsp-tests in the project's git tree at
7
8         git://git.ideasonboard.com/renesas/vsp-tests.git
9         http://git.ideasonboard.com/renesas/vsp-tests.git
10
11
12 --------
13 Building
14 --------
15
16 The vsp-tests suite requires the following tools to be installed on the host
17 to generate the test script and test data.
18
19 * make
20 * python
21
22 After installing the needed packages, you can build the test suite by running
23
24         make
25
26 in the vsp-tests root directory. Then, to install the test suite, run
27
28         make install INSTALL_DIR=/path/to/target/directory
29
30 This will copy the test scripts and data to the target directory to be copied
31 or exported to the host. As test data take more than 200MB of disk space usage
32 of nfsroot is recommended to run the tests.
33
34
35 --------------------
36 Runtime Dependencies
37 --------------------
38
39 The tests scripts require the following tools to be installed on the target
40 system in a directory included in $PATH.
41
42 * compare (part of ImageMagick)
43 * media-ctl (part of v4l-utils, available at git://linuxtv.org/v4l-utils.git)
44 * raw2rgbpnm (available at git://git.retiisi.org.uk/~sailus/raw2rgbpnm.git)
45 * yavta (available at git://git.ideasonboard.org/yavta.git)
46
47 All but the HGO test can be run with the latest version of these tools. To
48 test the HGO, the 'metadata' branch of 'yavta' is currently needed.
49
50
51 -----------------
52 Running the Tests
53 -----------------
54
55 The test scripts are named vsp-unit-test-[0-9]*.sh. They can be run directly
56 from the test suite root directory.
57