[PATCH 8/8] c-user: Generate user extensions manager docs
Sebastian Huber
sebastian.huber at embedded-brains.de
Tue Feb 9 09:43:28 UTC 2021
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup. The documentation was
transfered to interface specification items. The documentation source
files were generated from the items by a script.
Update #3993.
---
c-user/user-extensions/directives.rst | 326 ++++++++++++++++--------
c-user/user-extensions/introduction.rst | 36 ++-
2 files changed, 251 insertions(+), 111 deletions(-)
diff --git a/c-user/user-extensions/directives.rst b/c-user/user-extensions/directives.rst
index 5c6a0eb..89d7204 100644
--- a/c-user/user-extensions/directives.rst
+++ b/c-user/user-extensions/directives.rst
@@ -1,143 +1,257 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+.. This file is part of the RTEMS quality process and was automatically
+.. generated. If you find something that needs to be fixed or
+.. worded better please post a report or patch to an RTEMS mailing list
+.. or raise a bug report:
+..
+.. https://www.rtems.org/bugs.html
+..
+.. For information on updating and regenerating please refer to the How-To
+.. section in the Software Requirements Engineering chapter of the
+.. RTEMS Software Engineering manual. The manual is provided as a part of
+.. a release. For development sources please refer to the online
+.. documentation at:
+..
+.. https://docs.rtems.org
+
+.. _UserExtensionsManagerDirectives:
+
Directives
==========
-This section details the user extension manager's directives. A subsection is
-dedicated to each of this manager's directives and describes the calling
-sequence, related constants, usage, and status codes.
+This section details the directives of the User Extensions Manager. A
+subsection is dedicated to each of this manager's directives and lists the
+calling sequence, parameters, description, return values, and notes of the
+directive.
+
+.. Generated from spec:/rtems/userext/if/create
.. raw:: latex
- \clearpage
+ \clearpage
+.. index:: rtems_extension_create()
.. index:: create an extension set
-.. index:: rtems_extension_create
-
-.. _rtems_extension_create:
-
-EXTENSION_CREATE - Create a extension set
------------------------------------------
-
-CALLING SEQUENCE:
- .. code-block:: c
-
- rtems_status_code rtems_extension_create(
- rtems_name name,
- const rtems_extensions_table *table,
- rtems_id *id
- );
-
-DIRECTIVE STATUS CODES:
- .. list-table::
- :class: rtems-table
-
- * - ``RTEMS_SUCCESSFUL``
- - extension set created successfully
- * - ``RTEMS_INVALID_ADDRESS``
- - ``table`` or ``id`` are NULL
- * - ``RTEMS_INVALID_NAME``
- - invalid extension set name
- * - ``RTEMS_TOO_MANY``
- - too many extension sets created
-
-DESCRIPTION:
-
- This directive creates an extension set object and initializes it using the
- specified extension set table. The assigned extension set identifier is
- returned in :c:data:`id`. This identifier is used to access the extension
- set with other user extension manager directives. For control and
- maintenance of the extension set, RTEMS allocates an Extension Set Control
- Block (ESCB) from the local ESCB free pool and initializes it. The
- user-specified :c:data:`name` is assigned to the ESCB and may be used to
- identify the extension set via
- :ref:`rtems_extension_ident() <rtems_extension_ident>`. The extension set
- specified by :c:data:`table` is copied to the ESCB.
-
-NOTES:
- This directive may cause the calling task to be preempted due to an
- obtain and release of the object allocator mutex.
-.. raw:: latex
+.. _InterfaceRtemsExtensionCreate:
+
+rtems_extension_create()
+------------------------
+
+Creates an extension set.
+
+.. rubric:: CALLING SEQUENCE:
+
+.. code-block:: c
+
+ rtems_status_code rtems_extension_create(
+ rtems_name name,
+ const rtems_extensions_table *extension_table,
+ rtems_id *id
+ );
+
+.. rubric:: PARAMETERS:
+
+``name``
+ This parameter is the object name of the extension set.
+
+``id``
+ This parameter is the pointer to an object identifier variable. The
+ identifier of the created extension set will be stored in this variable, in
+ case of a successful operation.
+
+.. rubric:: DESCRIPTION:
+
+This directive creates an extension set which resides on the local node. The
+extension set has the user-defined object name specified in ``name``. The
+assigned object identifier is returned in ``id``. This identifier is used to
+access the extension set with other extension set related directives.
+
+The extension set is initialized using the extension table specified in
+``extension_table``.
+
+.. rubric:: RETURN VALUES:
+
+:c:macro:`RTEMS_SUCCESSFUL`
+ The requested operation was successful.
- \clearpage
+:c:macro:`RTEMS_INVALID_NAME`
+ The ``name`` parameter was invalid.
-.. index:: get ID of an extension set
-.. index:: obtain ID of an extension set
-.. index:: rtems_extension_ident
+:c:macro:`RTEMS_INVALID_ADDRESS`
+ The ``extension_table`` parameter was `NULL
+ <https://en.cppreference.com/w/c/types/NULL>`_.
-.. _rtems_extension_ident:
+:c:macro:`RTEMS_INVALID_ADDRESS`
+ The ``id`` parameter was `NULL
+ <https://en.cppreference.com/w/c/types/NULL>`_.
-EXTENSION_IDENT - Get ID of a extension set
--------------------------------------------
+:c:macro:`RTEMS_TOO_MANY`
+ There was no inactive object available to create an extension set. The
+ number of extension sets available to the application is configured through
+ the :ref:`CONFIGURE_MAXIMUM_USER_EXTENSIONS` application configuration
+ option.
-CALLING SEQUENCE:
- .. code-block:: c
+.. rubric:: NOTES:
- rtems_status_code rtems_extension_ident(
- rtems_name name,
- rtems_id *id
- );
+The user-provided extension set table is not used after the return of the
+directive.
-DIRECTIVE STATUS CODES:
- .. list-table::
- :class: rtems-table
+Newly created extension sets are immediately installed and are invoked upon the
+next system event supporting an extension.
- * - ``RTEMS_SUCCESSFUL``
- - extension set identified successfully
- * - ``RTEMS_INVALID_NAME``
- - extension set name not found
+An alternative to dynamically created extension sets are initial extensions,
+see :ref:`CONFIGURE_INITIAL_EXTENSIONS`. Initial extensions are recommended
+for extension sets which provide a fatal error extension.
-DESCRIPTION:
- This directive obtains the extension set identifier associated with the
- extension set :c:data:`name` to be acquired and returns it in :c:data:`id`.
- If the extension set name is not unique, then the extension set identifier
- will match one of the extension sets with that name. However, this
- extension set identifier is not guaranteed to correspond to the desired
- extension set. The extension set identifier is used to access this
- extension set in other extension set related directives.
+For control and maintenance of the extension set, RTEMS allocates a
+:term:`ESCB` from the local ESCB free pool and initializes it.
-NOTES:
- This directive will not cause the running task to be preempted.
+.. rubric:: CONSTRAINTS:
+
+The following constraints apply to this directive:
+
+* The directive may be called from within device driver initialization context.
+
+* The directive may be called from within task context.
+
+* The directive may obtain and release the object allocator mutex. This may
+ cause the calling task to be preempted.
+
+* The number of extension sets available to the application is configured
+ through the :ref:`CONFIGURE_MAXIMUM_USER_EXTENSIONS` application
+ configuration option.
+
+.. Generated from spec:/rtems/userext/if/delete
.. raw:: latex
- \clearpage
+ \clearpage
+.. index:: rtems_extension_delete()
.. index:: delete an extension set
-.. index:: rtems_extension_delete
-.. _rtems_extension_delete:
+.. _InterfaceRtemsExtensionDelete:
+
+rtems_extension_delete()
+------------------------
+
+Deletes the extension set.
+
+.. rubric:: CALLING SEQUENCE:
+
+.. code-block:: c
+
+ rtems_status_code rtems_extension_delete( rtems_id id );
+
+.. rubric:: PARAMETERS:
+
+``id``
+ This parameter is the extension set identifier.
+
+.. rubric:: DESCRIPTION:
+
+This directive deletes the extension set specified by ``id``.
+
+.. rubric:: RETURN VALUES:
+
+:c:macro:`RTEMS_SUCCESSFUL`
+ The requested operation was successful.
+
+:c:macro:`RTEMS_INVALID_ID`
+ There was no extension set associated with the identifier specified by
+ ``id``.
+
+.. rubric:: NOTES:
+
+The :term:`ESCB` for the deleted extension set is reclaimed by RTEMS.
+
+.. rubric:: CONSTRAINTS:
+
+The following constraints apply to this directive:
+
+* The directive may be called from within device driver initialization context.
+
+* The directive may be called from within task context.
+
+* The directive may obtain and release the object allocator mutex. This may
+ cause the calling task to be preempted.
+
+* The calling task does not have to be the task that created the object. Any
+ local task that knows the object identifier can delete the object.
+
+.. Generated from spec:/rtems/userext/if/ident
+
+.. raw:: latex
+
+ \clearpage
+
+.. index:: rtems_extension_ident()
+
+.. _InterfaceRtemsExtensionIdent:
+
+rtems_extension_ident()
+-----------------------
+
+Identifies an extension set by the object name.
+
+.. rubric:: CALLING SEQUENCE:
+
+.. code-block:: c
+
+ rtems_status_code rtems_extension_ident( rtems_name name, rtems_id *id );
+
+.. rubric:: PARAMETERS:
+
+``name``
+ This parameter is the object name to look up.
+
+``id``
+ This parameter is the pointer to an object identifier variable. The object
+ identifier of an object with the specified name will be stored in this
+ variable, in case of a successful operation.
+
+.. rubric:: DESCRIPTION:
+
+This directive obtains an extension set identifier associated with the
+extension set name specified in ``name``.
+
+.. rubric:: RETURN VALUES:
+
+:c:macro:`RTEMS_SUCCESSFUL`
+ The requested operation was successful.
+
+:c:macro:`RTEMS_INVALID_ADDRESS`
+ The ``id`` parameter was `NULL
+ <https://en.cppreference.com/w/c/types/NULL>`_.
+
+:c:macro:`RTEMS_INVALID_NAME`
+ The ``name`` parameter was 0.
+
+:c:macro:`RTEMS_INVALID_NAME`
+ There was no object with the specified name on the local node.
-EXTENSION_DELETE - Delete a extension set
------------------------------------------
+.. rubric:: NOTES:
-CALLING SEQUENCE:
- .. code-block:: c
+If the extension set name is not unique, then the extension set identifier will
+match the first extension set with that name in the search order. However, this
+extension set identifier is not guaranteed to correspond to the desired
+extension set.
- rtems_status_code rtems_extension_delete(
- rtems_id id
- );
+The objects are searched from lowest to the highest index. Only the local node
+is searched.
-DIRECTIVE STATUS CODES:
- .. list-table::
- :class: rtems-table
+The extension set identifier is used with other extension related directives to
+access the extension set.
- * - ``RTEMS_SUCCESSFUL``
- - extension set deleted successfully
- * - ``RTEMS_INVALID_ID``
- - invalid extension set id
+.. rubric:: CONSTRAINTS:
-DESCRIPTION:
- This directive deletes the extension set specified by :c:data:`id`. If the
- extension set is running, it is automatically canceled. The ESCB for the
- deleted extension set is reclaimed by RTEMS.
+The following constraints apply to this directive:
-NOTES:
- This directive may cause the calling task to be preempted due to an
- obtain and release of the object allocator mutex.
+* The directive may be called from within device driver initialization context.
- A extension set can be deleted by a task other than the task which created
- the extension set.
+* The directive will not cause the calling task to be preempted.
diff --git a/c-user/user-extensions/introduction.rst b/c-user/user-extensions/introduction.rst
index b567c36..6284242 100644
--- a/c-user/user-extensions/introduction.rst
+++ b/c-user/user-extensions/introduction.rst
@@ -1,17 +1,43 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
+.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+.. This file is part of the RTEMS quality process and was automatically
+.. generated. If you find something that needs to be fixed or
+.. worded better please post a report or patch to an RTEMS mailing list
+.. or raise a bug report:
+..
+.. https://www.rtems.org/bugs.html
+..
+.. For information on updating and regenerating please refer to the How-To
+.. section in the Software Requirements Engineering chapter of the
+.. RTEMS Software Engineering manual. The manual is provided as a part of
+.. a release. For development sources please refer to the online
+.. documentation at:
+..
+.. https://docs.rtems.org
+
+.. Generated from spec:/rtems/userext/if/group
+
+.. _UserExtensionsManagerIntroduction:
+
Introduction
============
-The user extensions manager allows the application developer to augment the
+.. The following list was generated from:
+.. spec:/rtems/userext/if/create
+.. spec:/rtems/userext/if/delete
+.. spec:/rtems/userext/if/ident
+
+The User Extensions Manager allows the application developer to augment the
executive by allowing them to supply extension routines which are invoked at
-critical system events. The directives provided by the user extensions manager
+critical system events. The directives provided by the User Extensions Manager
are:
-- :ref:`rtems_extension_create`
+* :ref:`InterfaceRtemsExtensionCreate` - Creates an extension set.
-- :ref:`rtems_extension_ident`
+* :ref:`InterfaceRtemsExtensionDelete` - Deletes the extension set.
-- :ref:`rtems_extension_delete`
+* :ref:`InterfaceRtemsExtensionIdent` - Identifies an extension set by the
+ object name.
--
2.26.2
More information about the devel
mailing list