RTEMS 4.9.3 On-Line Library

RTEMS Specific Commands region - display information about regions

RTEMS Shell User's Guide

5.2.11: region - display information about regions

SYNOPSYS:

region [id [id ... ] ]

DESCRIPTION:

When invoked with no arguments, this command prints information on the set of Classic API Regions currently active in the system.

If invoked with a set of object ids as arguments, then just those object are included in the information printed.

EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

NOTES:

NONE

EXAMPLES:

The following is an example of using the region command on a system with no user extensions.

SHLL [/] $ region
  ID       NAME   ATTR        STARTADDR LENGTH    PAGE_SIZE USED_BLOCKS
------------------------------------------------------------------------------

CONFIGURATION:

This command is included in the default shell command set. When building a custom command set, define CONFIGURE_SHELL_COMMAND_REGION to have this command included.

This command can be excluded from the shell command set by defining CONFIGURE_SHELL_NO_COMMAND_REGION when all shell commands have been configured.

PROGRAMMING INFORMATION:

The region is implemented by a C language function which has the following prototype:

int rtems_shell_rtems_main_region(
  int    argc,
  char **argv
);

The configuration structure for the region has the following prototype:

extern rtems_shell_cmd_t rtems_shell_REGION_Command;

RTEMS Shell User's Guide