diff options
author | Joel Sherrill <joel@rtems.org> | 2016-10-28 11:42:35 -0500 |
---|---|---|
committer | Joel Sherrill <joel@rtems.org> | 2016-10-28 11:43:49 -0500 |
commit | 154f3dc68b8e5d5ed4bc5d5b0720fb2a73236d77 (patch) | |
tree | 4d0408f93aef0242e3ad2c40a46e9399aecdc283 /c_user | |
parent | bsp_howto: Fix ASCII figure. (diff) | |
download | rtems-docs-154f3dc68b8e5d5ed4bc5d5b0720fb2a73236d77.tar.bz2 |
object_services.rst: Add _rtems_object_id_api_minimum_class and _rtems_object_id_api_maximum_class
Diffstat (limited to 'c_user')
-rw-r--r-- | c_user/object_services.rst | 66 | ||||
-rw-r--r-- | c_user/rate_monotonic_manager.rst | 2 |
2 files changed, 67 insertions, 1 deletions
diff --git a/c_user/object_services.rst b/c_user/object_services.rst index f2ae49a..f4b388a 100644 --- a/c_user/object_services.rst +++ b/c_user/object_services.rst @@ -601,6 +601,70 @@ for the specified ``api``. This directive is strictly local and does not impact task scheduling. +.. _rtems_object_id_api_minimum_class: + +OBJECT_ID_API_MINIMUM_CLASS - Obtain Minimum Class Value for an API +------------------------------------------------------------------- +.. index:: obtain minimum class value for an API + +**CALLING SEQUENCE:** + +.. index:: rtems_object_id_api_minimum_class + +.. code-block:: c + + int rtems_object_get_id_api_minimum_class( + int api + ); + +**DIRECTIVE STATUS CODES** + +If ``api`` is not valid, -1 is returned. + +If successful, this service returns the index corresponding to the first +object class of the specified ``api``. + +**DESCRIPTION:** + +This service returns the index for the first object class associated with +the specified ``api``. + +**NOTES:** + +This directive is strictly local and does not impact task scheduling. + +.. _rtems_object_id_api_maximum_class: + +OBJECT_ID_API_MAXIMUM_CLASS - Obtain Maximum Class Value for an API +------------------------------------------------------------------- +.. index:: obtain maximum class value for an API + +**CALLING SEQUENCE:** + +.. index:: rtems_object_id_api_maximum_class + +.. code-block:: c + + int rtems_object_get_api_maximum_class( + int api + ); + +**DIRECTIVE STATUS CODES** + +If ``api`` is not valid, -1 is returned. + +If successful, this service returns the index corresponding to the last +object class of the specified ``api``. + +**DESCRIPTION:** + +This service returns the index for the last object class associated with +the specified ``api``. + +**NOTES:** + +This directive is strictly local and does not impact task scheduling. + .. _rtems_object_get_api_name: OBJECT_GET_API_NAME - Obtain API Name @@ -671,6 +735,8 @@ This directive is strictly local and does not impact task scheduling. The string returned is from constant space. Do not modify or free it. +.. _rtems_object_get_class_information: + OBJECT_GET_CLASS_INFORMATION - Obtain Class Information ------------------------------------------------------- .. index:: obtain class information diff --git a/c_user/rate_monotonic_manager.rst b/c_user/rate_monotonic_manager.rst index 0a5ab5c..e0fc66b 100644 --- a/c_user/rate_monotonic_manager.rst +++ b/c_user/rate_monotonic_manager.rst @@ -865,7 +865,7 @@ RATE_MONOTONIC_GET_STATUS - Obtain status from a period rtems_status_code rtems_rate_monotonic_get_status( rtems_id id, - rtems_rate_monotonic_period_status \status + rtems_rate_monotonic_period_status *status ); **DIRECTIVE STATUS CODES:** |