c-user: Use a common phrase for pointer parameters

Mention the type of the pointer in the parameter description.  Use the
more general term "object" instead of "variable".

Update #3993.
This commit is contained in:
Sebastian Huber 2021-06-14 09:18:23 +02:00
parent 1a281869a9
commit c70715baea
15 changed files with 163 additions and 159 deletions

View File

@ -67,9 +67,9 @@ Creates a barrier.
barrier. barrier.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the created barrier will be directive call is successful, the identifier of the created barrier will be
stored in this variable. stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -175,9 +175,9 @@ Identifies a barrier by the object name.
This parameter is the object name to look up. This parameter is the object name to look up.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the object identifier of an object with the directive call is successful, the object identifier of an object with the
specified name will be stored in this variable. specified name will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -380,9 +380,10 @@ Releases the barrier.
This parameter is the barrier identifier. This parameter is the barrier identifier.
``released`` ``released``
This parameter is the pointer to an integer variable. When the directive This parameter is the pointer to an `uint32_t
call is successful, the number of released tasks will be stored in this <https://en.cppreference.com/w/c/types/integer>`_ object. When the
variable. directive call is successful, the number of released tasks will be stored
in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:

View File

@ -126,10 +126,10 @@ Gets the time of day associated with the current :term:`CLOCK_REALTIME`.
.. rubric:: PARAMETERS: .. rubric:: PARAMETERS:
``time_of_day`` ``time_of_day``
This parameter is the pointer to a RTEMS time of day variable. When the This parameter is the pointer to an :c:type:`rtems_time_of_day` object.
directive call is successful, the time of day associated with the When the directive call is successful, the time of day associated with the
:term:`CLOCK_REALTIME` at some point during the directive call will be :term:`CLOCK_REALTIME` at some point during the directive call will be
stored in this variable. stored in this object.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:
@ -179,10 +179,12 @@ current :term:`CLOCK_REALTIME`.
.. rubric:: PARAMETERS: .. rubric:: PARAMETERS:
``time_of_day`` ``time_of_day``
This parameter is the pointer to a timeval structure variable. When the This parameter is the pointer to a `struct timeval
directive call is successful, the seconds and microseconds elapsed since <https://pubs.opengroup.org/onlinepubs/009695399/basedefs/sys/time.h.html>`_
the :term:`Unix epoch` and the :term:`CLOCK_REALTIME` at some point during object. When the directive call is successful, the seconds and
the directive call will be stored in this variable. microseconds elapsed since the :term:`Unix epoch` and the
:term:`CLOCK_REALTIME` at some point during the directive call will be
stored in this object.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:
@ -234,10 +236,10 @@ Gets the seconds elapsed since the :term:`RTEMS epoch` and the current
.. rubric:: PARAMETERS: .. rubric:: PARAMETERS:
``seconds_since_rtems_epoch`` ``seconds_since_rtems_epoch``
This parameter is the pointer to an interval variable. When the directive This parameter is the pointer to an :c:type:`rtems_interval` object. When
call is successful, the seconds elapsed since the :term:`RTEMS epoch` and the directive call is successful, the seconds elapsed since the
the :term:`CLOCK_REALTIME` at some point during the directive call will be :term:`RTEMS epoch` and the :term:`CLOCK_REALTIME` at some point during the
stored in this variable. directive call will be stored in this object.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:
@ -370,11 +372,12 @@ system initialization using :term:`CLOCK_MONOTONIC`.
.. rubric:: PARAMETERS: .. rubric:: PARAMETERS:
``uptime`` ``uptime``
This parameter is the pointer to a timeval structure variable. When the This parameter is the pointer to a `struct timeval
directive call is successful, the seconds and nanoseconds elapsed since <https://pubs.opengroup.org/onlinepubs/009695399/basedefs/sys/time.h.html>`_
some time point during the system initialization and some point during the object. When the directive call is successful, the seconds and nanoseconds
directive call using :term:`CLOCK_MONOTONIC` will be stored in this elapsed since some time point during the system initialization and some
variable. point during the directive call using :term:`CLOCK_MONOTONIC` will be
stored in this object.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:
@ -420,10 +423,11 @@ system initialization using :term:`CLOCK_MONOTONIC`.
.. rubric:: PARAMETERS: .. rubric:: PARAMETERS:
``uptime`` ``uptime``
This parameter is the pointer to a timeval structure variable. The seconds This parameter is the pointer to a `struct timeval
and microseconds elapsed since some time point during the system <https://pubs.opengroup.org/onlinepubs/009695399/basedefs/sys/time.h.html>`_
initialization and some point during the directive call using object. The seconds and microseconds elapsed since some time point during
:term:`CLOCK_MONOTONIC` will be stored in this variable. The pointer shall the system initialization and some point during the directive call using
:term:`CLOCK_MONOTONIC` will be stored in this object. The pointer shall
be valid, otherwise the behaviour is undefined. be valid, otherwise the behaviour is undefined.
.. rubric:: CONSTRAINTS: .. rubric:: CONSTRAINTS:

View File

@ -71,9 +71,9 @@ Creates a port.
This parameter is the length in bytes of the memory area. This parameter is the length in bytes of the memory area.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the created port will be directive call is successful, the identifier of the created port will be
stored in this variable. stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -158,9 +158,9 @@ Identifies a port by the object name.
This parameter is the object name to look up. This parameter is the object name to look up.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the object identifier of an object with the directive call is successful, the object identifier of an object with the
specified name will be stored in this variable. specified name will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -297,9 +297,9 @@ Converts the external address to the internal address.
This parameter is the external address to convert. This parameter is the external address to convert.
``internal`` ``internal``
This parameter is the pointer to a pointer variable. When the directive This parameter is the pointer to a ``void`` pointer object. When the
call is successful, the external address associated with the internal directive call is successful, the external address associated with the
address will be stored in this variable. internal address will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -367,9 +367,9 @@ Converts the internal address to the external address.
This parameter is the internal address to convert. This parameter is the internal address to convert.
``external`` ``external``
This parameter is the pointer to a pointer variable. When the directive This parameter is the pointer to a ``void`` pointer object. When the
call is successful, the external address associated with the internal directive call is successful, the external address associated with the
address will be stored in this variable. internal address will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:

View File

@ -63,10 +63,9 @@ Establishes an interrupt service routine.
This parameter is the interrupt vector number. This parameter is the interrupt vector number.
``old_isr_handler`` ``old_isr_handler``
This parameter is the pointer to an :c:type:`rtems_isr_entry` variable. This parameter is the pointer to an :c:type:`rtems_isr_entry` object. When
When the directive call is successful, the previous interrupt service the directive call is successful, the previous interrupt service routine
routine established for this interrupt vector will be stored in this established for this interrupt vector will be stored in this object.
variable.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:

View File

@ -64,9 +64,9 @@ table and device major number in the Device Driver Table.
This parameter is the device driver address table. This parameter is the device driver address table.
``registered_major`` ``registered_major``
This parameter is the pointer to a device major number variable. When the This parameter is the pointer to an :c:type:`rtems_device_major_number`
directive call is successful, the device major number of the registered object. When the directive call is successful, the device major number of
device will be stored in this variable. the registered device will be stored in this object.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:

View File

@ -72,9 +72,9 @@ Creates a message queue.
This parameter is the attribute set of the message queue. This parameter is the attribute set of the message queue.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the created message queue directive call is successful, the identifier of the created message queue
will be stored in this variable. will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -233,9 +233,9 @@ Constructs a message queue from the specified the message queue configuration.
This parameter is the message queue configuration. This parameter is the message queue configuration.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the constructed message directive call is successful, the identifier of the constructed message
queue will be stored in this variable. queue will be stored in this object.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:
@ -361,9 +361,9 @@ Identifies a message queue by the object name.
This parameter is the node or node set to search for a matching object. This parameter is the node or node set to search for a matching object.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the object identifier of an object with the directive call is successful, the object identifier of an object with the
specified name will be stored in this variable. specified name will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -719,9 +719,9 @@ Broadcasts the messages to the tasks waiting at the queue.
``count`` ``count``
This parameter is the pointer to an `uint32_t This parameter is the pointer to an `uint32_t
<https://en.cppreference.com/w/c/types/integer>`_ variable. When the <https://en.cppreference.com/w/c/types/integer>`_ object. When the
directive call is successful, the number of unblocked tasks will be stored directive call is successful, the number of unblocked tasks will be stored
in this variable. in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -815,9 +815,9 @@ Receives a message from the queue.
``size`` ``size``
This parameter is the pointer to a `size_t This parameter is the pointer to a `size_t
<https://en.cppreference.com/w/c/types/size_t>`_ variable. When the <https://en.cppreference.com/w/c/types/size_t>`_ object. When the
directive call is successful, the size in bytes of the received messages directive call is successful, the size in bytes of the received messages
will be stored in this variable. This parameter cannot be used to specify will be stored in this object. This parameter cannot be used to specify
the size of the buffer. the size of the buffer.
``option_set`` ``option_set``
@ -954,9 +954,9 @@ Gets the number of messages pending on the queue.
``count`` ``count``
This parameter is the pointer to an `uint32_t This parameter is the pointer to an `uint32_t
<https://en.cppreference.com/w/c/types/integer>`_ variable. When the <https://en.cppreference.com/w/c/types/integer>`_ object. When the
directive call is successful, the number of pending messages will be stored directive call is successful, the number of pending messages will be stored
in this variable. in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -1017,9 +1017,9 @@ Flushes all messages on the queue.
``count`` ``count``
This parameter is the pointer to an `uint32_t This parameter is the pointer to an `uint32_t
<https://en.cppreference.com/w/c/types/integer>`_ variable. When the <https://en.cppreference.com/w/c/types/integer>`_ object. When the
directive call is successful, the number of unblocked tasks will be stored directive call is successful, the number of unblocked tasks will be stored
in this variable. in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:

View File

@ -168,9 +168,9 @@ Gets the object name associated with the object identifier.
This parameter is the object identifier to get the name. This parameter is the object identifier to get the name.
``name`` ``name``
This parameter is the pointer to an object name variable. When the This parameter is the pointer to an :c:type:`rtems_name` object. When the
directive call is successful, the object name associated with the object directive call is successful, the object name associated with the object
identifier will be stored in this variable. identifier will be stored in this object.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:
@ -801,9 +801,10 @@ Gets the object class information of the object class of the object API.
information. information.
``info`` ``info``
This parameter is the pointer to an object class information variable. This parameter is the pointer to an
When the directive call is successful, the object class information of the :c:type:`rtems_object_api_class_information` object. When the directive
class of the API will be stored in this variable. call is successful, the object class information of the class of the API
will be stored in this object.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:

View File

@ -76,9 +76,9 @@ Creates a partition.
This parameter is the attribute set of the partition. This parameter is the attribute set of the partition.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the created partition will directive call is successful, the identifier of the created partition will
be stored in this variable. be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -241,9 +241,9 @@ Identifies a partition by the object name.
This parameter is the node or node set to search for a matching object. This parameter is the node or node set to search for a matching object.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the object identifier of an object with the directive call is successful, the object identifier of an object with the
specified name will be stored in this variable. specified name will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -415,9 +415,9 @@ Tries to get a buffer from the partition.
This parameter is the partition identifier. This parameter is the partition identifier.
``buffer`` ``buffer``
This parameter is the pointer to a buffer pointer variable. When the This parameter is the pointer to a ``void`` pointer object. When the
directive call is successful, the pointer to the allocated buffer will be directive call is successful, the pointer to the allocated buffer will be
stored in this variable. stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:

View File

@ -56,9 +56,9 @@ Creates a period.
This parameter is the object name of the period. This parameter is the object name of the period.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the created period will be directive call is successful, the identifier of the created period will be
stored in this variable. stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -133,9 +133,9 @@ Identifies a period by the object name.
This parameter is the object name to look up. This parameter is the object name to look up.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the object identifier of an object with the directive call is successful, the object identifier of an object with the
specified name will be stored in this variable. specified name will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -407,10 +407,10 @@ Gets the detailed status of the period.
This parameter is the rate monotonic period identifier. This parameter is the rate monotonic period identifier.
``status`` ``status``
This parameter is the pointer to a This parameter is the pointer to an
:c:type:`rtems_rate_monotonic_period_status` variable. When the directive :c:type:`rtems_rate_monotonic_period_status` object. When the directive
call is successful, the detailed period status will be stored in this call is successful, the detailed period status will be stored in this
variable. object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -494,10 +494,10 @@ Gets the statistics of the period.
This parameter is the rate monotonic period identifier. This parameter is the rate monotonic period identifier.
``status`` ``status``
This parameter is the pointer to a This parameter is the pointer to an
:c:type:`rtems_rate_monotonic_period_statistics` variable. When the :c:type:`rtems_rate_monotonic_period_statistics` object. When the
directive call is successful, the period statistics will be stored in this directive call is successful, the period statistics will be stored in this
variable. object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:

View File

@ -77,9 +77,9 @@ Creates a region.
This parameter is the attribute set of the region. This parameter is the attribute set of the region.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the created region will be directive call is successful, the identifier of the created region will be
stored in this variable. stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -193,9 +193,9 @@ Identifies a region by the object name.
This parameter is the object name to look up. This parameter is the object name to look up.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the object identifier of an object with the directive call is successful, the object identifier of an object with the
specified name will be stored in this variable. specified name will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -427,9 +427,9 @@ Gets a segment from the region.
wait potentially forever. wait potentially forever.
``segment`` ``segment``
This parameter is the pointer to a void pointer variable. When the This parameter is the pointer to a ``void`` pointer object. When the
directive call is successful, the begin address of the allocated segment directive call is successful, the begin address of the allocated segment
will be stored in this variable. will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -635,9 +635,9 @@ Changes the size of the segment.
``old_size`` ``old_size``
This parameter is the pointer to an `uintptr_t This parameter is the pointer to an `uintptr_t
<https://en.cppreference.com/w/c/types/integer>`_ variable. When the <https://en.cppreference.com/w/c/types/integer>`_ object. When the
directive call is successful, the old size of the segment will be stored in directive call is successful, the old size of the segment will be stored in
this variable. this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -713,9 +713,9 @@ Gets the region information.
This parameter is the region identifier. This parameter is the region identifier.
``the_info`` ``the_info``
This parameter is the pointer to a Heap_Information_block variable. When This parameter is the pointer to a Heap_Information_block object. When the
the directive call is successful, the information of the region will be directive call is successful, the information of the region will be stored
stored in this variable. in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -788,9 +788,9 @@ Gets the region free information.
This parameter is the region identifier. This parameter is the region identifier.
``the_info`` ``the_info``
This parameter is the pointer to a Heap_Information_block variable. When This parameter is the pointer to a Heap_Information_block object. When the
the directive call is successful, the free information of the region will directive call is successful, the free information of the region will be
be stored in this variable. stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -871,9 +871,9 @@ Gets the size of the region segment.
``size`` ``size``
This parameter is the pointer to a `uintptr_t This parameter is the pointer to a `uintptr_t
<https://en.cppreference.com/w/c/types/integer>`_ variable. When the <https://en.cppreference.com/w/c/types/integer>`_ object. When the
directive call is successful, the size of the segment in bytes will be directive call is successful, the size of the segment in bytes will be
stored in this variable. stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:

View File

@ -54,9 +54,9 @@ Identifies a scheduler by the object name.
This parameter is the scheduler name to look up. This parameter is the scheduler name to look up.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the scheduler will be directive call is successful, the identifier of the scheduler will be
stored in this variable. stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -120,9 +120,9 @@ Identifies a scheduler by the processor index.
This parameter is the processor index to identify the scheduler. This parameter is the processor index to identify the scheduler.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the scheduler will be directive call is successful, the identifier of the scheduler will be
stored in this variable. stored in this object.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:
@ -176,17 +176,17 @@ Identifies a scheduler by the processor set.
.. rubric:: PARAMETERS: .. rubric:: PARAMETERS:
``cpusetsize`` ``cpusetsize``
This parameter is the size of the referenced processor set variable in This parameter is the size of the processor set referenced by ``cpuset`` in
bytes. This value shall be positive. bytes. The size shall be positive.
``cpuset`` ``cpuset``
This parameter is the pointer to a processor set variable. The referenced This parameter is the pointer to a :c:type:`cpu_set_t`. The referenced
processor set will be used to identify the scheduler. processor set will be used to identify the scheduler.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the scheduler will be directive call is successful, the identifier of the scheduler will be
stored in this variable. stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -254,9 +254,9 @@ Gets the maximum task priority of the scheduler.
This parameter is the scheduler identifier. This parameter is the scheduler identifier.
``priority`` ``priority``
This parameter is the pointer to a task priority variable. The maximum This parameter is the pointer to an :c:type:`rtems_task_priority` object.
priority of the scheduler will be stored in this variable, if the operation When the directive the maximum priority of the scheduler will be stored in
is successful. this object.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:
@ -313,10 +313,9 @@ Maps a Classic API task priority to the corresponding POSIX thread priority.
This parameter is the Classic API task priority to map. This parameter is the Classic API task priority to map.
``posix_priority`` ``posix_priority``
This parameter is the pointer to a POSIX thread priority variable. When This parameter is the pointer to an ``int`` object. When the directive
the directive call is successful, the POSIX thread priority value call is successful, the POSIX thread priority value corresponding to the
corresponding to the specified Classic API task priority value will be specified Classic API task priority value will be stored in this object.
stored in this variable.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:
@ -376,10 +375,10 @@ Maps a POSIX thread priority to the corresponding Classic API task priority.
This parameter is the POSIX thread priority to map. This parameter is the POSIX thread priority to map.
``priority`` ``priority``
This parameter is the pointer to a Classic API task priority variable. This parameter is the pointer to an :c:type:`rtems_task_priority` object.
When the directive call is successful, the Classic API task priority value When the directive call is successful, the Classic API task priority value
corresponding to the specified POSIX thread priority value will be stored corresponding to the specified POSIX thread priority value will be stored
in this variable. in this object.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:
@ -532,13 +531,13 @@ Gets the set of processors owned by the scheduler.
This parameter is the scheduler identifier. This parameter is the scheduler identifier.
``cpusetsize`` ``cpusetsize``
This parameter is the size of the referenced processor set variable in This parameter is the size of the processor set referenced by ``cpuset`` in
bytes. bytes.
``cpuset`` ``cpuset``
This parameter is the pointer to a processor set variable. When the This parameter is the pointer to a :c:type:`cpu_set_t` object. When the
directive call is successful, the processor set of the scheduler will be directive call is successful, the processor set of the scheduler will be
stored in this variable. A set bit in the processor set means that the stored in this object. A set bit in the processor set means that the
corresponding processor is owned by the scheduler, otherwise the bit is corresponding processor is owned by the scheduler, otherwise the bit is
cleared. cleared.

View File

@ -75,9 +75,9 @@ Creates a semaphore.
the attribute set. the attribute set.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the created semaphore will directive call is successful, the identifier of the created semaphore will
be stored in this variable. be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -278,9 +278,9 @@ Identifies a semaphore by the object name.
This parameter is the node or node set to search for a matching object. This parameter is the node or node set to search for a matching object.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the object identifier of an object with the directive call is successful, the object identifier of an object with the
specified name will be stored in this variable. specified name will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -862,9 +862,9 @@ Sets the priority by scheduler for the semaphore.
scheduler. scheduler.
``old_priority`` ``old_priority``
This parameter is the pointer to a task priority variable. When the This parameter is the pointer to an :c:type:`rtems_task_priority` object.
directive call is successful, the old priority of the semaphore When the directive call is successful, the old priority of the semaphore
corresponding to the specified scheduler will be stored in this variable. corresponding to the specified scheduler will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:

View File

@ -74,9 +74,9 @@ Creates a task.
This parameter is the attribute set of the task. This parameter is the attribute set of the task.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the created task will be directive call is successful, the identifier of the created task will be
stored in this variable. stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -335,9 +335,9 @@ Constructs a task from the specified task configuration.
This parameter is the task configuration. This parameter is the task configuration.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the constructed task will directive call is successful, the identifier of the constructed task will
be stored in this variable. be stored in this object.
.. rubric:: RETURN VALUES: .. rubric:: RETURN VALUES:
@ -475,9 +475,9 @@ Identifies a task by the object name.
This parameter is the node or node set to search for a matching object. This parameter is the node or node set to search for a matching object.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the object identifier of an object with the directive call is successful, the object identifier of an object with the
specified name will be stored in this variable. specified name will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -1147,10 +1147,10 @@ Sets the real priority or gets the current priority of the task.
:c:macro:`RTEMS_CURRENT_PRIORITY` to get the current priority. :c:macro:`RTEMS_CURRENT_PRIORITY` to get the current priority.
``old_priority`` ``old_priority``
This parameter is the pointer to an :c:type:`rtems_task_priority` variable. This parameter is the pointer to an :c:type:`rtems_task_priority` object.
When the directive call is successful, the current or previous priority of When the directive call is successful, the current or previous priority of
the task with respect to its :term:`home scheduler` will be stored in this the task with respect to its :term:`home scheduler` will be stored in this
variable. object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -1246,9 +1246,9 @@ Gets the current priority of the task with respect to the scheduler.
This parameter is the scheduler identifier. This parameter is the scheduler identifier.
``priority`` ``priority``
This parameter is the pointer to an :c:type:`rtems_task_priority` variable. This parameter is the pointer to an :c:type:`rtems_task_priority` object.
When the directive call is successful, the current priority of the task When the directive call is successful, the current priority of the task
with respect to the specified scheduler will be stored in this variable. with respect to the specified scheduler will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -1340,9 +1340,9 @@ Gets and optionally sets the mode of the calling task.
:c:macro:`RTEMS_CURRENT_MODE`, the mode of the calling task is not changed. :c:macro:`RTEMS_CURRENT_MODE`, the mode of the calling task is not changed.
``previous_mode_set`` ``previous_mode_set``
This parameter is the pointer to a mode variable. When the directive call This parameter is the pointer to an :c:type:`rtems_mode` object. When the
is successful, the mode of the task before any mode changes done by the directive call is successful, the mode of the task before any mode changes
directive call will be stored in this variable. done by the directive call will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -1615,9 +1615,9 @@ Gets the home scheduler of the task.
may be used to specify the calling task. may be used to specify the calling task.
``scheduler_id`` ``scheduler_id``
This parameter is the pointer to an :c:type:`rtems_id` variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the :term:`home scheduler` directive call is successful, the identifier of the :term:`home scheduler`
of the task will be stored in this variable. of the task will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -1779,13 +1779,13 @@ Gets the processor affinity of the task.
may be used to specify the calling task. may be used to specify the calling task.
``cpusetsize`` ``cpusetsize``
This parameter is the size of the referenced processor set variable in This parameter is the size of the processor set referenced by ``cpuset`` in
bytes. bytes.
``cpuset`` ``cpuset``
This parameter is the pointer to a processor set variable. When the This parameter is the pointer to a :c:type:`cpu_set_t` object. When the
directive call is successful, the processor affinity set of the task will directive call is successful, the processor affinity set of the task will
be stored in this variable. A set bit in the processor set means that the be stored in this object. A set bit in the processor set means that the
corresponding processor is in the processor affinity set of the task, corresponding processor is in the processor affinity set of the task,
otherwise the bit is cleared. otherwise the bit is cleared.
@ -1807,8 +1807,8 @@ task specified by ``id``.
There was no task associated with the identifier specified by ``id``. There was no task associated with the identifier specified by ``id``.
:c:macro:`RTEMS_INVALID_SIZE` :c:macro:`RTEMS_INVALID_SIZE`
The provided processor set was too small for the processor affinity set of The size specified by ``cpusetsize`` of the processor set was too small for
the task. the processor affinity set of the task.
:c:macro:`RTEMS_ILLEGAL_ON_REMOTE_OBJECT` :c:macro:`RTEMS_ILLEGAL_ON_REMOTE_OBJECT`
The task resided on a remote node. The task resided on a remote node.
@ -1857,14 +1857,14 @@ Sets the processor affinity of the task.
may be used to specify the calling task. may be used to specify the calling task.
``cpusetsize`` ``cpusetsize``
This parameter is the size of the referenced processor set variable in This parameter is the size of the processor set referenced by ``cpuset`` in
bytes. bytes.
``cpuset`` ``cpuset``
This parameter is the pointer to a processor set variable. The processor This parameter is the pointer to a :c:type:`cpu_set_t` object. The
set defines the new processor affinity set of the task. A set bit in the processor set defines the new processor affinity set of the task. A set
processor set means that the corresponding processor shall be in the bit in the processor set means that the corresponding processor shall be in
processor affinity set of the task, otherwise the bit shall be cleared. the processor affinity set of the task, otherwise the bit shall be cleared.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:

View File

@ -55,9 +55,9 @@ Creates a timer.
This parameter is the object name of the timer. This parameter is the object name of the timer.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the created timer will be directive call is successful, the identifier of the created timer will be
stored in this variable. stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -137,9 +137,9 @@ Identifies a timer by the object name.
This parameter is the object name to look up. This parameter is the object name to look up.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the object identifier of an object with the directive call is successful, the object identifier of an object with the
specified name will be stored in this variable. specified name will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -811,9 +811,9 @@ Gets information about the timer.
This parameter is the timer identifier. This parameter is the timer identifier.
``the_info`` ``the_info``
This parameter is the pointer to a timer information variable. When the This parameter is the pointer to an :c:type:`rtems_timer_information`
directive call is successful, the information about the timer will be object. When the directive call is successful, the information about the
stored in this variable. timer will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:

View File

@ -64,9 +64,9 @@ Creates an extension set.
set. set.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the created extension set directive call is successful, the identifier of the created extension set
will be stored in this variable. will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION:
@ -215,9 +215,9 @@ Identifies an extension set by the object name.
This parameter is the object name to look up. This parameter is the object name to look up.
``id`` ``id``
This parameter is the pointer to an object identifier variable. When the This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the object identifier of an object with the directive call is successful, the object identifier of an object with the
specified name will be stored in this variable. specified name will be stored in this object.
.. rubric:: DESCRIPTION: .. rubric:: DESCRIPTION: