README.md 3.46 KB
Newer Older
Patrick Titiano's avatar
Patrick Titiano committed
1
2
3
4
5
6
###############################################################################
#                                                                             #
#                                  OMAPCONF                                   #
#                                                                             #
#      A Powerful Diagnostic Tool for Texas Instruments OMAP Processors       #
###############################################################################
TI OMAPCONF's avatar
TI OMAPCONF committed
7

Patrick Titiano's avatar
Patrick Titiano committed
8
9
10
11
12
13
14
15


ABOUT:
------

OMAPCONF is a Linux user-space standalone application designed to provide a
quick'n easy way to diagnose (monitor/debug/audit...) TI OMAP configuration/status
dynamically at runtime, in any situation:
16
17
18
19
20
 * Any Linux distribution (Ubuntu, ...)
 * Any Android release (Froyo, GingerBread, HoneyComb, Ice-Cream Sandwich, Jelly Bean, ...)
 * TI official platforms (blaze, panda, ...),
 * Custom OMAP platforms, etc.
 * With no single kernel recompilation needed
Patrick Titiano's avatar
Patrick Titiano committed
21
22
23
24
25
26
27
28
29

OMAPCONF leverages "/dev/mem" special device to directly access complete
TI OMAP memory space (registers, ...).



SUPPORT:
--------

30
OMAPCONF CURRENTLY SUPPORTS TI AM335x, AM437x, OMAP44XX AND OMAP54XX DEVICES.
Patrick Titiano's avatar
Patrick Titiano committed
31
32
33
34
35
36
37
38
39
40
41
42
LEGACY TI OMAP PLATFORMS (OMAP[1-2-3]) ARE NOT SUPPORTED.

THIS SOFTWARE IS PROVIDED AS IS, WITH NO SUPPORT OR MAINTENANCE COMMITMENT FROM
TEXAS INSTRUMENTS INCORPORATED.



Build instructions (Ubuntu):
----------------------------

OMAPCONF is available as a Ubuntu package.
To proceed with package installation type the following:
43

Patrick Titiano's avatar
Patrick Titiano committed
44
45
46
	# sudo apt-get install tiomapconf

Once package is installed, you can check which omapconf version you are using:
47

Patrick Titiano's avatar
Patrick Titiano committed
48
49
50
	# dpkg -l tiomapconf

Package is available via TI OMAP4 Ubuntu PPA.
51
See [the OMAPpedia page](http://www.omappedia.org/wiki/PandaBoard_Ubuntu_PPA "Your mouse is hovering over this link") for further instructions.
Patrick Titiano's avatar
Patrick Titiano committed
52
53
54
55
56
57
58
59



Build instructions (other Linux Distributions):
-----------------------------------------------
To only build the output binary file:
	# make CROSS_COMPILE=arm-none-linux-gnueabi- omapconf

60
61
62
63
64
65
66
NB:
	- CROSS_COMPILE variable must be set to point to the correct compiler.
	- By default, omapconf is statically built, to ease sharing.
	  In case it is not needed or size matters, it is possible to build it dynamically, by setting variable STATIC_BUILD to "".
	  # export STATIC_BUILD=
	  or
	  # make CROSS_COMPILE=arm-none-linux-gnueabi- STATIC_BUILD= omapconf
Patrick Titiano's avatar
Patrick Titiano committed
67
68

To build and install ompaconf:
69

Patrick Titiano's avatar
Patrick Titiano committed
70
71
72
73
74
	# make CROSS_COMPILE=arm-none-linux-gnueabi- DESTDIR=YOUR_DIR install

YOUR_DIR is a destination directory where omapconf output binary file will be
copied (e.g. ubuntu/android filesystem)

75
That's it!
Patrick Titiano's avatar
Patrick Titiano committed
76
77
78
79
80
81



Build instructions and installation via ADB (Android):
------------------------------------------------------
Make sure your Android device is connected to host via ADB:
82

Patrick Titiano's avatar
Patrick Titiano committed
83
84
85
86
87
88
89
90
91
	# adb kill-server
	# adb devices
	* daemon not running. starting it now *
	* daemon started successfully *
	List of devices attached
	 emulator-5554	device
	# adb root

To build and install ompaconf for Android via ADB:
92
93

	# make CROSS_COMPILE=arm-none-linux-gnueabi- install_android
Patrick Titiano's avatar
Patrick Titiano committed
94
95
96
97
98
99
100
101
102
103
104
105
106

OMAPCONF binary will be copied to /data directory (known writable directory)
on your Android device. You may get it copied to a different directory by
updating Makefile at your convenience.



Help:
-----

Type "./omapconf --help" to get complete list of available commands and options.
Note that in case of incorrect command/option, help will also be displayed.

107
A dedicated wiki page is available [here](https://github.com/omapconf/omapconf/wiki "Github Wiki").