Changeset 2a761cf in rtems-docs


Ignore:
Timestamp:
Mar 9, 2020, 7:48:51 AM (4 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
bdd17e5
Parents:
16b0d3f
git-author:
Sebastian Huber <sebastian.huber@…> (03/09/20 07:48:51)
git-committer:
Sebastian Huber <sebastian.huber@…> (03/12/20 09:17:06)
Message:

c-user: Move "POSIX Initialization Thread Configuration"

Update #3836.

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

Legend:

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

    r16b0d3f r2a761cf  
    1717    classic-init-task
    1818    posix-api
    19 
    20 POSIX Initialization Thread Configuration
    21 =========================================
    22 
    23 The ``<rtems/confdefs.h>`` configuration system can automatically generate a
    24 POSIX Initialization Threads Table named ``POSIX_Initialization_threads`` with
    25 a single entry.  The following parameters control the generation of that table.
    26 
    27 .. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
    28 
    29 .. _CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT:
    30 
    31 CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
    32 ---------------------------------------
    33 
    34 CONSTANT:
    35     ``CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT``
    36 
    37 DATA TYPE:
    38     POSIX thread function pointer (``void *(*entry_point)(void *)``).
    39 
    40 RANGE:
    41     Undefined or a valid POSIX thread function pointer.
    42 
    43 DEFAULT VALUE:
    44     The default value is ``POSIX_Init``.
    45 
    46 DESCRIPTION:
    47     ``CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT`` is the entry point
    48     (a.k.a. function name) of the single initialization thread defined by the
    49     POSIX API Initialization Threads Table.
    50 
    51 NOTES:
    52     The user must implement the function ``POSIX_Init`` or the function name
    53     provided in this configuration parameter.
    54 
    55 .. index:: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
    56 
    57 .. _CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE:
    58 
    59 CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
    60 --------------------------------------
    61 
    62 CONSTANT:
    63     ``CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE``
    64 
    65 DATA TYPE:
    66     Unsigned integer (``size_t``).
    67 
    68 RANGE:
    69     Zero or positive.
    70 
    71 DEFAULT VALUE:
    72     The default value is 2 \* RTEMS_MINIMUM_STACK_SIZE.
    73 
    74 DESCRIPTION:
    75     ``CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE`` is the stack size of the single
    76     initialization thread defined by the POSIX API Initialization Threads
    77     Table.
    78 
    79 NOTES:
    80     If the stack size specified is greater than the configured minimum, it must
    81     be accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``.  See :ref:`Reserve
    82     Task/Thread Stack Memory Above Minimum` for more information about
    83     ``CONFIGURE_EXTRA_TASK_STACKS``.
    84 
    85 .. index:: CONFIGURE_POSIX_INIT_THREAD_TABLE
    86 
    87 .. _CONFIGURE_POSIX_INIT_THREAD_TABLE:
    88 
    89 CONFIGURE_POSIX_INIT_THREAD_TABLE
    90 ---------------------------------
    91 
    92 CONSTANT:
    93     ``CONFIGURE_POSIX_INIT_THREAD_TABLE``
    94 
    95 DATA TYPE:
    96     Boolean feature macro.
    97 
    98 RANGE:
    99     Defined or undefined.
    100 
    101 DEFAULT VALUE:
    102     This field is not defined by default, as the user MUST select their own API
    103     for initialization tasks.
    104 
    105 DESCRIPTION:
    106     ``CONFIGURE_POSIX_INIT_THREAD_TABLE`` is defined if the user wishes to use
    107     a POSIX API Initialization Threads Table.  The table built by
    108     ``<rtems/confdefs.h>`` specifies the parameters for a single thread. This
    109     is sufficient for applications which initialization the system from a
    110     single task.
    111 
    112     By default, this field is not defined as the user MUST select their own API
    113     for initialization tasks.
    114 
    115 NOTES:
    116     The application may choose to use the initialization tasks or threads table
    117     from another API.
    118 
    119     A compile time error will be generated if the user does not configure any
    120     initialization tasks or threads.
     19    posix-init-thread
    12120
    12221Task Stack Allocator Configuration
Note: See TracChangeset for help on using the changeset viewer.