Changeset f517010 in rtems-docs


Ignore:
Timestamp:
Dec 19, 2016, 2:06:37 PM (4 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
e7f40f0
Parents:
7b0db6a
Message:

Document CPUINFO

Close #2723.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • shell/rtems_specific_commands.rst

    r7b0db6a rf517010  
    1515- shutdown_ - Shutdown the system
    1616
     17- cpuinfo_ - print per-processor information
     18
    1719- cpuuse_ - print or reset per thread cpu usage
    1820
     
    109111
    110112        extern rtems_shell_cmd_t rtems_shell_SHUTDOWN_Command;
     113
     114.. raw:: latex
     115
     116   \clearpage
     117
     118.. _cpuinfo:
     119
     120cpuinfo - print per-processor information
     121--------------------------------------------
     122.. index:: cpuinfo
     123
     124SYNOPSYS:
     125    .. code-block:: shell
     126
     127        cpuinfo
     128
     129DESCRIPTION:
     130    This command may be used to print per-processor information.
     131
     132EXIT STATUS:
     133    This command returns 0 on success and non-zero if an error is encountered.
     134
     135EXAMPLES:
     136    The following is an example of how to use ``cpuinfo``:
     137
     138    .. code-block:: shell
     139
     140        SHLL [/] $ cpuinfo
     141        -------------------------------------------------------------------------------
     142                                    PER PROCESSOR INFORMATION
     143        -------+--------+--------------+-----------------------------------------------
     144         INDEX | ONLINE | SCHEDULER ID | SCHEDULER NAME
     145        -------+--------+--------------+-----------------------------------------------
     146             0 |      1 |   0x0f010001 | UPD
     147
     148    In the above example, the system has only one processor.  This processor
     149    has the index zero and is online.  It is owned by the scheduler with the
     150    identifier ``0x0f010001`` and name ``UPD``.
     151
     152.. index:: CONFIGURE_SHELL_NO_COMMAND_CPUINFO
     153.. index:: CONFIGURE_SHELL_COMMAND_CPUINFO
     154
     155CONFIGURATION:
     156    This command is included in the default shell command set.  When building a
     157    custom command set, define ``CONFIGURE_SHELL_COMMAND_CPUINFO`` to have this
     158    command included.
     159
     160    This command can be excluded from the shell command set by defining
     161    ``CONFIGURE_SHELL_NO_COMMAND_CPUINFO`` when all shell commands have been
     162    configured.
     163
     164.. index:: rtems_shell_rtems_main_cpuinfo
     165
     166PROGRAMMING INFORMATION:
     167    The ``cpuinfo`` is implemented by a C language function which has the following
     168    prototype:
     169
     170    .. code-block:: c
     171
     172        int rtems_cpu_info_report(
     173            const rtems_printer *printer
     174        );
     175
     176    The configuration structure for the ``cpuinfo`` has the following prototype:
     177
     178    .. code-block:: c
     179
     180        extern rtems_shell_cmd_t rtems_shell_CPUINFO_Command;
    111181
    112182.. raw:: latex
Note: See TracChangeset for help on using the changeset viewer.