Version 1.1 Update
[ctprof_srv/ctprof_srv.git] / RELEASE_NOTES
1 ctprof_srv  
3 Version 1.1
4 Release Date: 9/12/2013 
6 Description
7 ===========
9 Ctprof provides system level bus profiling use cases for any slave bus in
10 the device that has a CP Tracer. Ctprof is made up of two components; ctprof
11 which is the host client application, and ctprof_srv which is the target
12 server application. The client is delivered with TI's CCS emupacks (see
13 System Requirements for minimum emupack revision for this release) and can be
14 installed independent of CCS. The server is delivered as source with an example
15 application which also contains a small "C" file that can be integrated with
16 your application for coordinating ctprof_srv's trace collection activity.
18 Organization
19 ============
21 The ctools_srv project is delivered as source in three directories:
23     server
24     common
25     example_app
27 Both the server and example_app have makefiles. 
29 Make & Installation
30 ===================
32 If using SC-MCSDK 02.02.00 then ctprof_srv, ctprof_ex, and ctprof_sync.sh are
33 pre-installed in the /usr/bin directory. Otherwise, the server and example_app
34 directories contain makefiles that utilizes the CROSS_COMPILE environment
35 variable. Both release and debug versions can be made. The executable is
36 saved in the release or debug directories. 
38 Examples:
40 make with CROSS_COMPILE:
41 make clean debug install arm DESTDIR=/your/favorite/utility/dir
42 make clean release install arm DESTDIR=/your/favorite/utility/dir
44 Make with your favorite compiler:
45 make CC=target-gcc clean debug install DESTDIR=/your/favorite/utility/dir
46 make CC=target-gcc clean release install DESTDIR=/your/favorite/utility/dir
48 make all with CROSS_COMPILE:
49 make all arm DESTDIR=/your/favorite/utility/dir (same as: make clean release install
50  arm DESTDIR=/your/favorite/utility/dir)
52 System Requirements
53 ===================
55 - A Host Linux machine (Ubuntu 10.4 or higher) with emupack M8 installed.
56 - A TCI6414 EVM or equivalent target system with a working network connection
57   (TCP is used).
58 - Requires the SC-MCSDK 02.02.00 Linux image.
60 Documentation
61 =============
63 The server should simply be run in the background from the console:
65 $ctprof_srv &
67 Use -h to see options.
69 The ctprof utility is then used from a host to connect to the server and issue
70 use case commands (like measure utilized bandwidth or latency of a specific
71 slave) that are serviced by ctprof_srv through a socket interface. 
73 See http://processors.wiki.ti.com/index.php/Ctprof for documentation and
74 examples.
76 History
77 =======
79 8/21/2013 - First release
80 9/12/2013 - Version 1.1
82 Known Deficiencies
83 ==================
85 Enhancements & New Features
86 ===========================
88 Version 1.1 update                                
89 - Made minor ctprof_srv modification to eliminate pipe warning                 
90   when terminating (when using -t with ctprof_sync.sh script).
91 - Improved ctprof_ex to make it usable for all examples in wiki              
92   documentation.
94 Bug Fixes
95 =========
97 End of Document