Changeset 088a1f8 in rtems-docs


Ignore:
Timestamp:
Mar 9, 2020, 7:56:56 AM (4 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
b71fb43
Parents:
41ac3da
git-author:
Sebastian Huber <sebastian.huber@…> (03/09/20 07:56:56)
git-committer:
Sebastian Huber <sebastian.huber@…> (03/12/20 09:21:51)
Message:

c-user: Move "Multiprocessing Configuration"

Update #3836.

Location:
c-user/config
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/config/index.rst

    r41ac3da r088a1f8  
    2626    scheduler-clustered
    2727    device-driver
    28 
    29 Multiprocessing Configuration
    30 =============================
    31 
    32 This section defines the multiprocessing related system configuration
    33 parameters supported by ``<rtems/confdefs.h>``.  They are only used if RTEMS
    34 was built with the ``--enable-multiprocessing`` build configuration option.
    35 The multiprocessing (MPCI) support must not be confused with the SMP support.
    36 
    37 Additionally, this class of Configuration Constants are only applicable if
    38 ``CONFIGURE_MP_APPLICATION`` is defined.
    39 
    40 .. index:: CONFIGURE_MP_APPLICATION
    41 
    42 .. _CONFIGURE_MP_APPLICATION:
    43 
    44 CONFIGURE_MP_APPLICATION
    45 ------------------------
    46 
    47 CONSTANT:
    48     ``CONFIGURE_MP_APPLICATION``
    49 
    50 DATA TYPE:
    51     Boolean feature macro.
    52 
    53 RANGE:
    54     Defined or undefined.
    55 
    56 DEFAULT VALUE:
    57     This is not defined by default.
    58 
    59 DESCRIPTION:
    60     This configuration parameter must be defined to indicate that the
    61     application intends to be part of a multiprocessing
    62     configuration. Additional configuration parameters are assumed to be
    63     provided.
    64 
    65 NOTES:
    66     This has no impact unless RTEMS was built with the
    67     ``--enable-multiprocessing`` build configuration option.
    68 
    69 .. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
    70 
    71 .. _CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS:
    72 
    73 CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
    74 -----------------------------------
    75 
    76 CONSTANT:
    77     ``CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS``
    78 
    79 DATA TYPE:
    80     Unsigned integer (``uint32_t``).
    81 
    82 RANGE:
    83     Positive.
    84 
    85 DEFAULT VALUE:
    86     The default value is 32.
    87 
    88 DESCRIPTION:
    89     ``CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS`` is the maximum number of
    90     concurrently active global objects in a multiprocessor system.
    91 
    92 NOTES:
    93     This value corresponds to the total number of objects which can be created
    94     with the ``RTEMS_GLOBAL`` attribute.
    95 
    96 .. index:: CONFIGURE_MP_MAXIMUM_NODES
    97 
    98 .. _CONFIGURE_MP_MAXIMUM_NODES:
    99 
    100 CONFIGURE_MP_MAXIMUM_NODES
    101 --------------------------
    102 
    103 CONSTANT:
    104     ``CONFIGURE_MP_MAXIMUM_NODES``
    105 
    106 DATA TYPE:
    107     Unsigned integer (``uint32_t``).
    108 
    109 RANGE:
    110     Positive.
    111 
    112 DEFAULT VALUE:
    113     The default value is 2.
    114 
    115 DESCRIPTION:
    116     ``CONFIGURE_MP_MAXIMUM_NODES`` is the maximum number of nodes in a
    117     multiprocessor system.
    118 
    119 NOTES:
    120     None.
    121 
    122 .. index:: CONFIGURE_MP_MAXIMUM_PROXIES
    123 
    124 .. _CONFIGURE_MP_MAXIMUM_PROXIES:
    125 
    126 CONFIGURE_MP_MAXIMUM_PROXIES
    127 ----------------------------
    128 
    129 CONSTANT:
    130     ``CONFIGURE_MP_MAXIMUM_PROXIES``
    131 
    132 DATA TYPE:
    133     Unsigned integer (``uint32_t``).
    134 
    135 RANGE:
    136     Undefined or positive.
    137 
    138 DEFAULT VALUE:
    139     The default value is 32.
    140 
    141 DESCRIPTION:
    142     ``CONFIGURE_MP_MAXIMUM_PROXIES`` is the maximum number of concurrently
    143     active thread/task proxies on this node in a multiprocessor system.
    144 
    145 NOTES:
    146     Since a proxy is used to represent a remote task/thread which is blocking
    147     on this node. This configuration parameter reflects the maximum number of
    148     remote tasks/threads which can be blocked on objects on this node.
    149 
    150 .. COMMENT: XXX - add xref to proxy discussion in MP chapter
    151 
    152 .. index:: CONFIGURE_MP_MPCI_TABLE_POINTER
    153 
    154 .. _CONFIGURE_MP_MPCI_TABLE_POINTER:
    155 
    156 CONFIGURE_MP_MPCI_TABLE_POINTER
    157 -------------------------------
    158 
    159 CONSTANT:
    160     ``CONFIGURE_MP_MPCI_TABLE_POINTER``
    161 
    162 DATA TYPE:
    163     pointer to ``rtems_mpci_table``
    164 
    165 RANGE:
    166     undefined or valid pointer
    167 
    168 DEFAULT VALUE:
    169     This is not defined by default.
    170 
    171 DESCRIPTION:
    172     ``CONFIGURE_MP_MPCI_TABLE_POINTER`` is the pointer to the MPCI
    173     Configuration Table.  The default value of this field is``&MPCI_table``.
    174 
    175 NOTES:
    176     RTEMS provides a Shared Memory MPCI Device Driver which can be used on any
    177     Multiprocessor System assuming the BSP provides the proper set of
    178     supporting methods.
    179 
    180 .. index:: CONFIGURE_MP_NODE_NUMBER
    181 
    182 .. _CONFIGURE_MP_NODE_NUMBER:
    183 
    184 CONFIGURE_MP_NODE_NUMBER
    185 ------------------------
    186 
    187 CONSTANT:
    188     ``CONFIGURE_MP_NODE_NUMBER``
    189 
    190 DATA TYPE:
    191     Unsigned integer (``uint32_t``).
    192 
    193 RANGE:
    194     Positive.
    195 
    196 DEFAULT VALUE:
    197     The default value is ``NODE_NUMBER``, which is assumed to be set by the
    198     compilation environment.
    199 
    200 DESCRIPTION:
    201     ``CONFIGURE_MP_NODE_NUMBER`` is the node number of this node in a
    202     multiprocessor system.
    203 
    204 NOTES:
    205     In the RTEMS Multiprocessing Test Suite, the node number is derived from
    206     the Makefile variable ``NODE_NUMBER``. The same code is compiled with the
    207     ``NODE_NUMBER`` set to different values. The test programs behave
    208     differently based upon their node number.
     28    mpci
    20929
    21030PCI Library Configuration
Note: See TracChangeset for help on using the changeset viewer.