rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-06-01 16:23:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

c-user: Generate API type documentation

Browse Source 
Close #4901.
This commit is contained in:
Sebastian Huber 2023-05-09 12:53:20 +02:00
parent 9c2498a728
commit e33eae15a7
19 changed files with 1735 additions and 326 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
c-user/barrier/directives.rst
View File

@ -67,9 +67,9 @@ Creates a barrier.
barrier.
``id``
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
stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the created barrier
will be stored in this object.
.. rubric:: DESCRIPTION:
@ -175,9 +175,9 @@ Identifies a barrier by the object name.
This parameter is the object name to look up.
``id``
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
specified name will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the object identifier of an object with
the specified name will be stored in this object.
.. rubric:: DESCRIPTION:

6
c-user/clock/directives.rst
View File

@ -137,7 +137,7 @@ Gets the time of day associated with the current :term:`CLOCK_REALTIME`.
.. rubric:: PARAMETERS:
``time_of_day``
This parameter is the pointer to an :c:type:`rtems_time_of_day` object.
This parameter is the pointer to an :ref:`InterfaceRtemsTimeOfDay` object.
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
stored in this object.
@ -1086,8 +1086,8 @@ Gets the seconds elapsed since the :term:`RTEMS epoch` and the current
.. rubric:: PARAMETERS:
``seconds_since_rtems_epoch``
This parameter is the pointer to an :c:type:`rtems_interval` object. When
the directive call is successful, the seconds elapsed since the
This parameter is the pointer to an :ref:`InterfaceRtemsInterval` object.
When the directive call is successful, the seconds elapsed since the
:term:`RTEMS epoch` and the :term:`CLOCK_REALTIME` at some point during the
directive call will be stored in this object.

2
c-user/config/classic-init-task.rst
View File

@ -59,7 +59,7 @@ API initialization task.
.. rubric:: CONSTRAINTS:
The value of the configuration option shall be convertible to an integer of
type :c:type:`rtems_task_argument`.
type :ref:`InterfaceRtemsTaskArgument`.
.. Generated from spec:/acfg/if/init-task-attributes

4
c-user/config/device-driver.rst
View File

@ -114,7 +114,7 @@ placement of application device driver initializers.
.. rubric:: CONSTRAINTS:
The value of the configuration option shall be a list of initializers for
structures of type :c:type:`rtems_driver_address_table`.
structures of type :ref:`InterfaceRtemsDriverAddressTable`.
.. Generated from spec:/acfg/if/appl-needs-ata-driver
@ -718,7 +718,7 @@ of application device driver initializers.
.. rubric:: CONSTRAINTS:
The value of the configuration option shall be a list of initializers for
structures of type :c:type:`rtems_driver_address_table`.
structures of type :ref:`InterfaceRtemsDriverAddressTable`.
.. Generated from spec:/acfg/if/ata-driver-task-priority

2
c-user/config/general.rst
View File

@ -328,7 +328,7 @@ initial user extensions.
.. rubric:: CONSTRAINTS:
The value of the configuration option shall be a list of initializers for
structures of type :c:type:`rtems_extensions_table`.
structures of type :ref:`InterfaceRtemsExtensionsTable`.
.. Generated from spec:/acfg/if/interrupt-stack-size

12
c-user/dual-ported-memory/directives.rst
View File

@ -71,9 +71,9 @@ Creates a port.
This parameter is the length in bytes of the memory area.
``id``
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
stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the created port will
be stored in this object.
.. rubric:: DESCRIPTION:
@ -158,9 +158,9 @@ Identifies a port by the object name.
This parameter is the object name to look up.
``id``
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
specified name will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the object identifier of an object with
the specified name will be stored in this object.
.. rubric:: DESCRIPTION:

28
c-user/interrupt/directives.rst
View File

@ -63,9 +63,10 @@ Establishes an interrupt service routine.
This parameter is the interrupt vector number.
``old_isr_handler``
This parameter is the pointer to an :c:type:`rtems_isr_entry` object. When
the directive call is successful, the previous interrupt service routine
established for this interrupt vector will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsIsrEntry` object.
When the directive call is successful, the previous interrupt service
routine established for this interrupt vector will be stored in this
object.
.. rubric:: DESCRIPTION:
@ -133,8 +134,8 @@ Disables the maskable interrupts on the current processor.
.. rubric:: PARAMETERS:
``isr_cookie``
This parameter is a variable of type :c:type:`rtems_interrupt_level` which
will be used to save the previous interrupt level.
This parameter is a variable of type :ref:`InterfaceRtemsInterruptLevel`
which will be used to save the previous interrupt level.
.. rubric:: DESCRIPTION:
@ -343,8 +344,8 @@ Disables the maskable interrupts on the current processor.
.. rubric:: PARAMETERS:
``isr_cookie``
This parameter is a variable of type :c:type:`rtems_interrupt_level` which
will be used to save the previous interrupt level.
This parameter is a variable of type :ref:`InterfaceRtemsInterruptLevel`
which will be used to save the previous interrupt level.
.. rubric:: DESCRIPTION:
@ -2188,9 +2189,10 @@ Gets the attributes of the interrupt vector.
This parameter is the interrupt vector number.
``attributes``
This parameter is the pointer to an :c:type:`rtems_interrupt_attributes`
object. When the directive call is successful, the attributes of the
interrupt vector will be stored in this object.
This parameter is the pointer to an
:ref:`InterfaceRtemsInterruptAttributes` object. When the directive call
is successful, the attributes of the interrupt vector will be stored in
this object.
.. rubric:: RETURN VALUES:
@ -2418,9 +2420,9 @@ Creates an interrupt server.
``control``
This parameter is the pointer to an
:c:type:`rtems_interrupt_server_control` object. When the directive call
was successful, the ownership of the object was transferred from the caller
of the directive to the interrupt server management.
:ref:`InterfaceRtemsInterruptServerControl` object. When the directive
call was successful, the ownership of the object was transferred from the
caller of the directive to the interrupt server management.
``config``
This parameter is the interrupt server configuration.

2
c-user/io/directives.rst
View File

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

19
c-user/message/directives.rst
View File

@ -72,9 +72,9 @@ Creates a message queue.
This parameter is the attribute set of the message queue.
``id``
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
will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the created message
queue will be stored in this object.
.. rubric:: DESCRIPTION:
@ -230,11 +230,12 @@ Constructs a message queue from the specified the message queue configuration.
.. rubric:: PARAMETERS:
``config``
This parameter is the message queue configuration.
This parameter is the pointer to an :ref:`InterfaceRtemsMessageQueueConfig`
object. It configures the message queue.
``id``
This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the constructed message
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the constructed message
queue will be stored in this object.
.. rubric:: RETURN VALUES:
@ -361,9 +362,9 @@ Identifies a message queue by the object name.
This parameter is the node or node set to search for a matching object.
``id``
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
specified name will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the object identifier of an object with
the specified name will be stored in this object.
.. rubric:: DESCRIPTION:

8
c-user/object-services/directives.rst
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.
``name``
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
identifier will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsName` object. When
the directive call is successful, the object name associated with the
object identifier will be stored in this object.
.. rubric:: RETURN VALUES:
@ -802,7 +802,7 @@ Gets the object class information of the object class of the object API.
``info``
This parameter is the pointer to an
:c:type:`rtems_object_api_class_information` object. When the directive
:ref:`InterfaceRtemsObjectApiClassInformation` object. When the directive
call is successful, the object class information of the class of the API
will be stored in this object.

12
c-user/partition/directives.rst
View File

@ -76,9 +76,9 @@ Creates a partition.
This parameter is the attribute set of the partition.
``id``
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
be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the created partition
will be stored in this object.
.. 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.
``id``
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
specified name will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the object identifier of an object with
the specified name will be stored in this object.
.. rubric:: DESCRIPTION:

16
c-user/rate-monotonic/directives.rst
View File

@ -56,9 +56,9 @@ Creates a period.
This parameter is the object name of the period.
``id``
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
stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the created period will
be stored in this object.
.. rubric:: DESCRIPTION:
@ -133,9 +133,9 @@ Identifies a period by the object name.
This parameter is the object name to look up.
``id``
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
specified name will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the object identifier of an object with
the specified name will be stored in this object.
.. rubric:: DESCRIPTION:
@ -413,7 +413,7 @@ Gets the detailed status of the period.
``status``
This parameter is the pointer to an
:c:type:`rtems_rate_monotonic_period_status` object. When the directive
:ref:`InterfaceRtemsRateMonotonicPeriodStatus` object. When the directive
call is successful, the detailed period status will be stored in this
object.
@ -496,7 +496,7 @@ Gets the statistics of the period.
``status``
This parameter is the pointer to an
:c:type:`rtems_rate_monotonic_period_statistics` object. When the
:ref:`InterfaceRtemsRateMonotonicPeriodStatistics` object. When the
directive call is successful, the period statistics will be stored in this
object.

12
c-user/region/directives.rst
View File

@ -77,9 +77,9 @@ Creates a region.
This parameter is the attribute set of the region.
``id``
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
stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the created region will
be stored in this object.
.. rubric:: DESCRIPTION:
@ -193,9 +193,9 @@ Identifies a region by the object name.
This parameter is the object name to look up.
``id``
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
specified name will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the object identifier of an object with
the specified name will be stored in this object.
.. rubric:: DESCRIPTION:

1814
c-user/rtems_data_types.rst
View File

File diff suppressed because it is too large Load Diff

26
c-user/scheduling-concepts/directives.rst
View File

@ -54,8 +54,8 @@ Identifies a scheduler by the object name.
This parameter is the scheduler name to look up.
``id``
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
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the scheduler will be
stored in this object.
.. rubric:: DESCRIPTION:
@ -120,8 +120,8 @@ Identifies a scheduler by the processor index.
This parameter is the processor index to identify the scheduler.
``id``
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
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the scheduler will be
stored in this object.
.. rubric:: RETURN VALUES:
@ -184,8 +184,8 @@ Identifies a scheduler by the processor set.
processor set will be used to identify the scheduler.
``id``
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
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the scheduler will be
stored in this object.
.. rubric:: DESCRIPTION:
@ -254,9 +254,9 @@ Gets the maximum task priority of the scheduler.
This parameter is the scheduler identifier.
``priority``
This parameter is the pointer to an :c:type:`rtems_task_priority` object.
When the directive the maximum priority of the scheduler will be stored in
this object.
This parameter is the pointer to an :ref:`InterfaceRtemsTaskPriority`
object. When the directive the maximum priority of the scheduler will be
stored in this object.
.. rubric:: RETURN VALUES:
@ -375,10 +375,10 @@ Maps a POSIX thread priority to the corresponding Classic API task priority.
This parameter is the POSIX thread priority to map.
``priority``
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
corresponding to the specified POSIX thread priority value will be stored
in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsTaskPriority`
object. When the directive call is successful, the Classic API task
priority value corresponding to the specified POSIX thread priority value
will be stored in this object.
.. rubric:: RETURN VALUES:

19
c-user/semaphore/directives.rst
View File

@ -75,9 +75,9 @@ Creates a semaphore.
the attribute set.
``id``
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
be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the created semaphore
will be stored in this object.
.. 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.
``id``
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
specified name will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the object identifier of an object with
the specified name will be stored in this object.
.. rubric:: DESCRIPTION:
@ -862,9 +862,10 @@ Sets the priority by scheduler for the semaphore.
scheduler.
``old_priority``
This parameter is the pointer to an :c:type:`rtems_task_priority` object.
When the directive call is successful, the old priority of the semaphore
corresponding to the specified scheduler will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsTaskPriority`
object. When the directive call is successful, the old priority of the
semaphore corresponding to the specified scheduler will be stored in this
object.
.. rubric:: DESCRIPTION:

41
c-user/task/directives.rst
View File

@ -74,9 +74,9 @@ Creates a task.
This parameter is the attribute set of the task.
``id``
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
stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the created task will
be stored in this object.
.. rubric:: DESCRIPTION:
@ -332,12 +332,13 @@ Constructs a task from the specified task configuration.
.. rubric:: PARAMETERS:
``config``
This parameter is the task configuration.
This parameter is the pointer to an :ref:`InterfaceRtemsTaskConfig` object.
It configures the task.
``id``
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
be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the constructed task
will be stored in this object.
.. rubric:: RETURN VALUES:
@ -475,9 +476,9 @@ Identifies a task by the object name.
This parameter is the node or node set to search for a matching object.
``id``
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
specified name will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the object identifier of an object with
the specified name will be stored in this object.
.. rubric:: DESCRIPTION:
@ -1162,10 +1163,10 @@ Sets the real priority or gets the current priority of the task.
:c:macro:`RTEMS_CURRENT_PRIORITY` to get the current priority.
``old_priority``
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
the task with respect to its :term:`home scheduler` will be stored in this
object.
This parameter is the pointer to an :ref:`InterfaceRtemsTaskPriority`
object. 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 object.
.. rubric:: DESCRIPTION:
@ -1261,9 +1262,9 @@ Gets the current priority of the task with respect to the scheduler.
This parameter is the scheduler identifier.
``priority``
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
with respect to the specified scheduler will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsTaskPriority`
object. When the directive call is successful, the current priority of the
task with respect to the specified scheduler will be stored in this object.
.. rubric:: DESCRIPTION:
@ -1630,9 +1631,9 @@ Gets the home scheduler of the task.
may be used to specify the calling task.
``scheduler_id``
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`
of the task will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the :term:`home
scheduler` of the task will be stored in this object.
.. rubric:: DESCRIPTION:

14
c-user/timer/directives.rst
View File

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

12
c-user/user-extensions/directives.rst
View File

@ -64,9 +64,9 @@ Creates an extension set.
set.
``id``
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
will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the created extension
set will be stored in this object.
.. rubric:: DESCRIPTION:
@ -219,9 +219,9 @@ Identifies an extension set by the object name.
This parameter is the object name to look up.
``id``
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
specified name will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the object identifier of an object with
the specified name will be stored in this object.
.. rubric:: DESCRIPTION: