initial commit
[processor-sdk/omap5-sgx-ddk-um-linux-x11-experimental.git] / README
1 *********************************************************************
2 *                         TABLE OF CONTENTS                         *
3 *********************************************************************
5 INTRODUCTION
6    Highlights
7    Limitations
8    Package Contents
9 TARGET SETUP
10 INSTALL
11 LOAD
12 TEST
15 *********************************************************************
16 *                            INTRODUCTION                           *
17 *********************************************************************
19 This is the Texas Instruments Inc (TI) Driver Development Kit (DDK)
20 for the SGX graphics cores X11 image on TI Linux platforms. 
22 This package contains the user mode libraries and binaries for SGX. These
23 user mode libraries are developed by Imagination Technologies (IMG). TI 
24 provides additional enhancements and integration for Linux OMAP.
26 The kernel mode drivers for SGX are available at:
27 https://git.ti.com/graphics/omap5-xsgx-ddk-linux
29 ----------
30 Highlights
31 ----------
33 This is version 1.15 of the TI DDK based on IMG's RTM4564147 delivery to TI.
35 This release supports X11 TBD
37 DDK dependencies: TBD: libdrm 2.4.66, libgbm 10.0.0, Wayland 1.9
39 -----------
40 Limitations
41 -----------
43 ----------------
44 Package Contents
45 ----------------
47 targetfs/
48 ---------
50 The 'targetfs' folder contains the user mode modules of SGX DDK for TI
51 platforms.
54 *********************************************************************
55 *                         TARGET SETUP                              *
56 *********************************************************************
58 Consult the TI base system setup documentation for instructions on
59 setting up your target device including boot loader, kernel, and
60 Arago filesystem. 
63 *********************************************************************
64 *                         INSTALL                                   *
65 *********************************************************************
67 The procedure to install the DDK user mode libraries is given below.
68 Refer to the README in https://git.ti.com/graphics/omap5-xsgx-ddk-linux
69 for building and installing the kernel mode driver.
71 Untar the package and run the following commands on the host with the 
72 target filesystem mounted:
74 host $ export DISCIMAGE=<path_to_target_root_filesystem>
75 host $ export TARGET_PRODUCT=<SoC value>
76        # allowed values are: 
77        # ti335x = All AM33x derivatives
78        # ti437x = All AM43x derivatives
79        # jacinto6evm = All DRA7xx / AM57x derivatives
80 host $ cd <path_to_package>
81 host $ sudo -E make install
83 *********************************************************************
84 *                         LOAD                                      *
85 *********************************************************************
87 The procedure to load the DDK kernel drivers is given below. 
89 --------
90 OMAP DRM
91 --------
93 The pvrsrvkm driver is expected to be loaded before an OpenGLES 
94 application can be exercised. The rc.pvr handles the loading of the 
95 necessary DRM driver.
97 target $ /etc/init.d/rc.pvr start
100 *********************************************************************
101 *                         TEST                                      *
102 *********************************************************************
104 The DDK has been verified using the kmscube test application that has 
105 been included with the SDK file system. This application uses DRM/KMS
106 and GBM to render a rotating cube on the screen.
108 Set the LD_LIBRARY_PATH to point to the X11 libraries such as /usr/local/XSGX/lib
110 target $ gles2test1 -f 500