IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


Command shell: RTOS commands


DATE [day.month.year]: Display/Set date
This command can set or display the current date of the RTOS and the onboard RTC.
Example:
date            <- display RTOS and RTC date
date 02.01.2009 <- set RTOS date
date getRTC     <- get RTC date and set RTOS date accordingly
date setRTC     <- get RTOS date and set RTC date accordingly
Since:
SC2x3 V1.00


MEM: Display memory map
Displays a memory map, including the name of the task owning the memory. The size indicated is the actual usable size.

The RTOS kernel object, message envelope and file system resource usage is also displayed.

Any global data entries found in the RTX_Publish() registry will also be listed.
Example:
mem
See also:
RTX_Count_Resources()      RTX_Publish()
Since:
SC2x3 V1.00


ERRORS [A] [D] [H] [R]: Display detected errors

See further details concerning this command's console output.

Command Line Arguments

The following case insensitive command line arguments can be used with the ERRORS shell command. Only the first letter of these arguments needs to be entered and this is all that is inspected (no spelling test here). A space must be present between the arguments.

Examples:
errors
errors Ack Dump History Reset
errors A D H R
errors A
Since:
SC2x3 V1.00


KILL DOSn: Kill an application program

This command removes a program's process from the system. All @CHIP-RTOS-PPC resources owned by that program will be released and the process address space will vanish.

The command line argument which specifies which program is to be killed can specify either the DOS program index that is indicated on the TASKS command console output or the program's process number.

The DOS program number designations above program number 9 use an extended hexadecimal notation which matches the name assignments of their main() tasks. These names are DOS1 .. DOS9, DOSA ... DOSG to cover the maximum of 16 programs supported by this system.

The three letters "DOS" can be left out for a short hand notation which uses only the extended hexadecimal number, 1..G.

A final method of specifying a program is by process number. A 'P' precedes the process number. (This method is not expected to be used very often, but has the advantage that process numbers are unique where as DOS program numbers are recycled on subsequent launches.)

Examples:
KILL DOS1
KILL 1
KILL P235
See also:
RTX_GetProcessNum()     RTX_Kill_Program()
Since:
SC2x3 V1.00


TASKS: Display list of tasks

Displays a lists of all tasks, including the CPU load caused by the task, the task status and the stack space usage. This command activates the task monitor.

The kernel task scheduler reads the start/stop times from the system's timebase for each task to track the CPU usage. At 10 second intervals the task monitor samples each task's timing statistics to determine the percentage of total CPU time used by the task over the past 10 seconds. A kernel timer is used to control this 10 second data collection.

Notes concerning Task Load and CPU Duty Cycle indications.
  • The time spent within interrupt service routines is scored as time within what ever task was interrupted. If no task was executing at the time of the interrupt, then the idle time accumulator will be credited for this service time which results in a lower slightly erroneous duty cycle indication.
  • When operating in BPM_SLEEP low power mode, the system timebase does not tick during the idle periods. Consequently the elapsed time between display updates used in the loading calculations is only an estimate when in this power save mode.

The task monitor causes a slight performance penalty due to the 10 second data collection performed in the top priority AMXK kernel task. The UTASKS command can be used to to shut off this task monitoring and release the kernel timer that was used.

The listed task state is only a one moment snapshot. The task state bit field is a 16 bit hexadecimal value.

The set of system tasks are listed here.
Example:
tasks
Since:
SC2x3 V1.00


TIME [hh:mm:ss]: Display/Set time
This command can set or display the current time of the RTOS and the onboard RTC.
Example:
time           <- display RTOS and RTC time
time 14:25:30  <- set RTOS time
time getRTC    <- get RTC time and set RTOS time accordingly
time setRTC    <- get RTOS time and set RTC time accordingly
Since:
SC2x3 V1.00


UTASKS: Disables the Task Monitor
Disables the Task Monitor which was installed using TASKS command. If you do not need the Task Monitor anymore, you should disable it using this command because the Task Monitor has a performance penalty.
Example:
utasks
Since:
SC2x3 V1.00


VER: Display @CHIP-RTOS-PPC Version
Output the IPC@CHIP® serial number, @CHIP-RTOS-PPC version and build date.
Example:
ver
Since:
SC2x3 V1.00





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:35 2017 by Doxygen 1.6.1