gator: Version 5.65.6

Signed-off-by: Drew Richardson <drew.richardson@arm.com>

1 files changed, 13 insertions, 2 deletions

diff --git a/README_Streamline.txt b/README_Streamline.txt
index 2026f31..0510d71 100644
--- a/README_Streamline.txt
+++ b/README_Streamline.txt
@@ -5,10 +5,21 @@ Instructions on setting up ARM Streamline on the target.
 The gator driver and gator daemon are required to run on the ARM linux target in order for ARM Streamline to operate.

 The driver should be built as a module and the daemon must run with root permissions on the target.

 

+*** Introduction ***

+

+A linux development environment with cross compiling tools is most likely required, depending on what is already created and provided.

+-For users, the ideal environment is to be given a BSP with gatord and gator.ko already running on a properly configured kernel. In such a scenario, a development environment is not needed, root permission may or may not be needed (gatord must be executed with root permissions but can be automatically started, see below), and the user can run Streamline and profile the system without any setup.

+-The ideal development environment has the kernel source code available to be rebuilt and executed on the target. This environment allows the greatest flexibility in configuring the kernel and building the gator driver module.

+-However, it is possible that a user/developer has a kernel but does not have the source code. In this scenario it may or may not be possible to obtain a valid profile.

+	-First, check if the kernel has the proper configuration options (see below). Profiling cannot occur using a kernel that is not configured properly, a new kernel must be created.

+	-Second, given a properly configured kernel, check if the filesystem contains the kernel source/headers, which can be used to re-create the gator driver.

+	-If the kernel is not properly configured or sources/headers are not available, the developer is on their own and kernel creation is beyond the scope of this document. Note: It is possible for a module to work when compiled against a similar kernel source code, though this is not guaranteed to work due to differences in kernel structures, exported symbols and incompatible configuration parameters.

+

 *** Preparing and building the kernel ***

 

 cd into the root source dir of the linux kernel

-make ARCH=arm CROSS_COMPILE=${CROSS_TOOLS}/bin/arm-none-linux-gnueabi- <platform_defconfig> (choose the appropriate configuration for your board)

+if your target has never been configured, choose the appropriate configuration for your target

+	make ARCH=arm CROSS_COMPILE=${CROSS_TOOLS}/bin/arm-none-linux-gnueabi- <platform_defconfig>

 make ARCH=arm CROSS_COMPILE=${CROSS_TOOLS}/bin/arm-none-linux-gnueabi- menuconfig

 

 Required Kernel Changes (depending on the kernel version, the location of these configuration settings within menuconfig may be different)

@@ -66,7 +77,7 @@ make ARCH=arm CROSS_COMPILE=$(CROSS_TOOLS}/bin/arm-none-linux-gnueabi- menuconfi
 

 make -j5 ARCH=arm CROSS_COMPILE=${CROSS_TOOLS}/bin/arm-none-linux-gnueabi- uImage

 Use vmlinux as the image for debug symbols in Streamline.

-Drivers may be profiled using this method by statically linking the driver into the kernel image.

+Drivers may be profiled using this method by statically linking the driver into the kernel image or adding the module as an image.

 Note that the gator driver does not perform kernel call stack recording.

 

 *** Automatically start gator on boot (optional) ***