zephyr

History

Allan Stephens e3108813cc Revise misleading instructions in sample project README.txt files Removes the instruction directing users to issue "make pristine" before building a sample project, as this should be unnecessary under normal circumstances and can cause the user to unexpectedly lose their current configuration information. In its place, a section on troubleshooting is added that describes how to rebuild a project using the desired configuration. Change-Id: I4eaace2888000c3ec5d101c27a38c74c2987312e Signed-off-by: Allan Stephens <allan.stephens@windriver.com>		2016-02-05 20:14:14 -05:00
..
generic_pc	Kbuild: metrics config dependency resolved	2016-02-05 20:14:08 -05:00
quark	Kbuild: Fix sanity checks for quark	2016-02-05 20:14:08 -05:00
src	Eliminate obsolete coding convention comments	2016-02-05 20:14:14 -05:00
Makefile	Kbuild: Changing build parameter CONF_OVERLAY to CONF_FILE	2016-02-05 20:14:09 -05:00
prj.vpf	First commit	2015-04-10 16:44:37 -07:00
README.txt	Revise misleading instructions in sample project README.txt files	2016-02-05 20:14:14 -05:00

README.txt

Title:  BootTime

Description:

BootTime measures the time:
   a) from system reset to kernel start (crt0.s's __start)
   b) from kernel start to begin of main()
   c) from kernel start to begin of first task
   d) from kernel start to when microkernel's main task goes immediately idle

The project can be built using one of the following three configurations:

best
-------
 - Disables most features
 - Provides best case boot measurement

default
-------
 - Default configuration options
 - Provides typical boot measurement

worst
-------
 - Enables most features.
 - Provides worst case boot measurement

--------------------------------------------------------------------------------

Building and Running Project:

This microkernel project outputs to the console.  It can be built and executed
on QEMU in three possibile configurations as follows:

    make BOOTTIME_QUALIFIER=best microkernel.qemu

    make BOOTTIME_QUALIFIER=default microkernel.qemu

    make BOOTTIME_QUALIFIER=worst microkernel.qemu

--------------------------------------------------------------------------------

Troubleshooting:

Problems caused by out-dated project information can be addressed by
issuing one of the following commands then rebuilding the project:

    make clean          # discard results of previous builds
                        # but keep existing configuration info
or
    make pristine       # discard results of previous builds
                        # and restore pre-defined configuration info

--------------------------------------------------------------------------------

Sample Output:

tc_start() - Boot Time Measurement
MicroKernel Boot Result: Clock Frequency: 20 MHz
__start       : 377787 cycles, 18889 us
_start->main(): 3915 cycles, 195 us
_start->task  : 5898 cycles, 294 us
_start->idle  : 6399 cycles, 319 us
Boot Time Measurement finished
===================================================================
PASS - bootTimeTask.
===================================================================
VXMICRO PROJECT EXECUTION SUCCESSFUL