[rtems-central commit] spec: Improve /rtems/config/if/* documentation
Sebastian Huber
sebh at rtems.org
Tue Oct 4 08:18:01 UTC 2022
Module: rtems-central
Branch: master
Commit: e2b5c0e012c8e7d6d7dcc7c236d38e3d408d266d
Changeset: http://git.rtems.org/rtems-central/commit/?id=e2b5c0e012c8e7d6d7dcc7c236d38e3d408d266d
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Fri Sep 30 16:14:29 2022 +0200
spec: Improve /rtems/config/if/* documentation
---
spec/rtems/config/if/get-api-configuration.yml | 6 +++++-
spec/rtems/config/if/get-build-label.yml | 6 ++++--
spec/rtems/config/if/get-copyright-notice.yml | 6 +++++-
spec/rtems/config/if/get-do-zero-of-workspace.yml | 7 ++++++-
spec/rtems/config/if/get-idle-task-stack-size.yml | 7 ++++++-
spec/rtems/config/if/get-idle-task.yml | 11 ++++++++---
spec/rtems/config/if/get-interrupt-stack-size.yml | 7 ++++++-
spec/rtems/config/if/get-maximum-barriers.yml | 16 +++++++++++-----
spec/rtems/config/if/get-maximum-extensions.yml | 16 +++++++++++-----
spec/rtems/config/if/get-maximum-message-queues.yml | 16 +++++++++++-----
spec/rtems/config/if/get-maximum-partitions.yml | 16 +++++++++++-----
spec/rtems/config/if/get-maximum-periods.yml | 16 +++++++++++-----
spec/rtems/config/if/get-maximum-ports.yml | 16 +++++++++++-----
spec/rtems/config/if/get-maximum-processors.yml | 4 ++++
spec/rtems/config/if/get-maximum-regions.yml | 16 +++++++++++-----
spec/rtems/config/if/get-maximum-semaphores.yml | 16 +++++++++++-----
spec/rtems/config/if/get-maximum-tasks.yml | 16 +++++++++++-----
spec/rtems/config/if/get-maximum-timers.yml | 16 +++++++++++-----
spec/rtems/config/if/get-microseconds-per-tick.yml | 7 ++++++-
spec/rtems/config/if/get-milliseconds-per-tick.yml | 7 ++++++-
spec/rtems/config/if/get-nanoseconds-per-tick.yml | 7 ++++++-
.../rtems/config/if/get-number-of-initial-extensions.yml | 8 +++++++-
.../rtems/config/if/get-stack-allocate-for-idle-hook.yml | 12 +++++++++---
spec/rtems/config/if/get-stack-allocate-hook.yml | 12 ++++++++----
spec/rtems/config/if/get-stack-allocate-init-hook.yml | 11 ++++++++---
.../config/if/get-stack-allocator-avoids-work-space.yml | 11 ++++++++---
spec/rtems/config/if/get-stack-free-hook.yml | 11 ++++++++---
spec/rtems/config/if/get-stack-space-size.yml | 15 +++++++++++----
spec/rtems/config/if/get-target-hash.yml | 5 +++--
spec/rtems/config/if/get-ticks-per-timeslice.yml | 7 ++++++-
spec/rtems/config/if/get-unified-work-area.yml | 7 ++++++-
spec/rtems/config/if/get-user-extension-table.yml | 6 +++++-
spec/rtems/config/if/get-user-multiprocessing-table.yml | 10 +++++++---
spec/rtems/config/if/get-version-string.yml | 10 ++++++++--
spec/rtems/config/if/get-work-space-size.yml | 4 ++++
spec/rtems/config/if/resource-is-unlimited.yml | 11 +++++++----
spec/rtems/config/if/resource-maximum-per-allocation.yml | 11 +++++++----
spec/rtems/config/if/resource-unlimited.yml | 11 ++++++++---
spec/rtems/config/if/stack-allocate-init-hook.yml | 2 +-
spec/rtems/config/if/stack-free-hook.yml | 2 +-
40 files changed, 294 insertions(+), 107 deletions(-)
diff --git a/spec/rtems/config/if/get-api-configuration.yml b/spec/rtems/config/if/get-api-configuration.yml
index e4652b96..0a39cb35 100644
--- a/spec/rtems/config/if/get-api-configuration.yml
+++ b/spec/rtems/config/if/get-api-configuration.yml
@@ -21,12 +21,16 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_rtems_api_configuration
notes: null
params: []
return:
return: |
- Returns the pointer to the Classic API Configuration Table of this
+ Returns a pointer to the Classic API Configuration Table of this
application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-build-label.yml b/spec/rtems/config/if/get-build-label.yml
index 048538dc..51937ece 100644
--- a/spec/rtems/config/if/get-build-label.yml
+++ b/spec/rtems/config/if/get-build-label.yml
@@ -11,7 +11,9 @@ definition:
return: const char *
variants: []
description: |
- The build label is a user-provided string defined by the build configuration.
+ The build label is a user-provided string defined by the build configuration
+ through the ``RTEMS_BUILD_LABEL`` build option. The format of the string is
+ completely user-defined.
enabled-by: true
index-entries: []
interface-type: function
@@ -37,6 +39,6 @@ notes: |
params: []
return:
return: |
- Returns the pointer to the RTEMS build label.
+ Returns a pointer to the RTEMS build label.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-copyright-notice.yml b/spec/rtems/config/if/get-copyright-notice.yml
index cbba3be0..4e5d56fa 100644
--- a/spec/rtems/config/if/get-copyright-notice.yml
+++ b/spec/rtems/config/if/get-copyright-notice.yml
@@ -21,11 +21,15 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_get_copyright_notice
notes: null
params: []
return:
return: |
- Returns the pointer to the RTEMS copyright notice.
+ Returns a pointer to the RTEMS copyright notice.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-do-zero-of-workspace.yml b/spec/rtems/config/if/get-do-zero-of-workspace.yml
index a2afe84a..6aa45bd9 100644
--- a/spec/rtems/config/if/get-do-zero-of-workspace.yml
+++ b/spec/rtems/config/if/get-do-zero-of-workspace.yml
@@ -22,9 +22,14 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_do_zero_of_workspace
notes: |
- See ${/acfg/if/zero-workspace-automatically:/name}.
+ The setting is defined by the ${/acfg/if/zero-workspace-automatically:/name}
+ application configuration option.
params: []
return:
return: |
diff --git a/spec/rtems/config/if/get-idle-task-stack-size.yml b/spec/rtems/config/if/get-idle-task-stack-size.yml
index 5d7058a4..1c8892d6 100644
--- a/spec/rtems/config/if/get-idle-task-stack-size.yml
+++ b/spec/rtems/config/if/get-idle-task-stack-size.yml
@@ -19,9 +19,14 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_idle_task_stack_size
notes: |
- See ${/acfg/if/idle-task-stack-size:/name}.
+ The IDLE task stack size is defined by the
+ ${/acfg/if/idle-task-stack-size:/name} application configuration option.
params: []
return:
return: |
diff --git a/spec/rtems/config/if/get-idle-task.yml b/spec/rtems/config/if/get-idle-task.yml
index f03cdd25..c889870c 100644
--- a/spec/rtems/config/if/get-idle-task.yml
+++ b/spec/rtems/config/if/get-idle-task.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the IDLE task entry of this application.
+ Gets the IDLE task body of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -19,12 +19,17 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_idle_task
notes: |
- See ${/acfg/if/idle-task-body:/name}.
+ The IDLE task body is defined by the ${/acfg/if/idle-task-body:/name}
+ application configuration option.
params: []
return:
return: |
- Returns the IDLE task entry of this application.
+ Returns the IDLE task body of this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-interrupt-stack-size.yml b/spec/rtems/config/if/get-interrupt-stack-size.yml
index 4a73f25d..6c382d30 100644
--- a/spec/rtems/config/if/get-interrupt-stack-size.yml
+++ b/spec/rtems/config/if/get-interrupt-stack-size.yml
@@ -19,9 +19,14 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_interrupt_stack_size
notes: |
- See ${/acfg/if/interrupt-stack-size:/name}.
+ The interrupt stack size is defined by the
+ ${/acfg/if/interrupt-stack-size:/name} application configuration option.
params: []
return:
return: |
diff --git a/spec/rtems/config/if/get-maximum-barriers.yml b/spec/rtems/config/if/get-maximum-barriers.yml
index a974e933..4d27cd8b 100644
--- a/spec/rtems/config/if/get-maximum-barriers.yml
+++ b/spec/rtems/config/if/get-maximum-barriers.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the maximum number of Classic API Barriers configured for
- this application.
+ Gets the resource number of ${/rtems/barrier/if/group:/name} objects
+ configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -20,13 +20,19 @@ links:
uid: header-2
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_maximum_barriers
notes: |
- See ${/acfg/if/max-barriers:/name}.
+ The resource number is defined by the ${/acfg/if/max-barriers:/name}
+ application configuration option. See also ${resource-is-unlimited:/name}
+ and ${resource-maximum-per-allocation:/name}.
params: []
return:
return: |
- Returns the maximum number of Classic API Barriers configured for
- this application.
+ Returns the resource number of ${/rtems/barrier/if/group:/name} objects
+ configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-extensions.yml b/spec/rtems/config/if/get-maximum-extensions.yml
index 8ade16bb..68f18bdd 100644
--- a/spec/rtems/config/if/get-maximum-extensions.yml
+++ b/spec/rtems/config/if/get-maximum-extensions.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the maximum number of Classic API User Extensions configured for this
- application.
+ Gets the resource number of ${/rtems/userext/if/group:/name} objects
+ configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -20,13 +20,19 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_maximum_extensions
notes: |
- See ${/acfg/if/max-user-extensions:/name}.
+ The resource number is defined by the ${/acfg/if/max-user-extensions:/name}
+ application configuration option. See also ${resource-is-unlimited:/name}
+ and ${resource-maximum-per-allocation:/name}.
params: []
return:
return: |
- Returns the maximum number of Classic API User Extensions configured for
- this application.
+ Returns the resource number of ${/rtems/userext/if/group:/name} objects
+ configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-message-queues.yml b/spec/rtems/config/if/get-maximum-message-queues.yml
index 5a8f8ea0..5d56f975 100644
--- a/spec/rtems/config/if/get-maximum-message-queues.yml
+++ b/spec/rtems/config/if/get-maximum-message-queues.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the maximum number of Classic API Message Queues configured
- for this application.
+ Gets the resource number of ${/rtems/message/if/group:/name} objects
+ configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -20,13 +20,19 @@ links:
uid: header-2
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_maximum_message_queues
notes: |
- See ${/acfg/if/max-message-queues:/name}.
+ The resource number is defined by the ${/acfg/if/max-message-queues:/name}
+ application configuration option. See also ${resource-is-unlimited:/name}
+ and ${resource-maximum-per-allocation:/name}.
params: []
return:
return: |
- Returns the maximum number of Classic API Message Queues configured for
- this application.
+ Returns the resource number of ${/rtems/message/if/group:/name} objects
+ configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-partitions.yml b/spec/rtems/config/if/get-maximum-partitions.yml
index bda6fd06..224fed8a 100644
--- a/spec/rtems/config/if/get-maximum-partitions.yml
+++ b/spec/rtems/config/if/get-maximum-partitions.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the maximum number of Classic API Partitions configured for
- this application.
+ Gets the resource number of ${/rtems/part/if/group:/name} objects configured
+ for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -20,13 +20,19 @@ links:
uid: header-2
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_maximum_partitions
notes: |
- See ${/acfg/if/max-partitions:/name}.
+ The resource number is defined by the ${/acfg/if/max-partitions:/name}
+ application configuration option. See also ${resource-is-unlimited:/name}
+ and ${resource-maximum-per-allocation:/name}.
params: []
return:
return: |
- Returns the maximum number of Classic API Partitions configured
- for this application.
+ Returns the resource number of ${/rtems/part/if/group:/name} objects
+ configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-periods.yml b/spec/rtems/config/if/get-maximum-periods.yml
index 55bbe23e..28f8794c 100644
--- a/spec/rtems/config/if/get-maximum-periods.yml
+++ b/spec/rtems/config/if/get-maximum-periods.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the maximum number of Classic API Rate Monotonic Periods configured for
- this application.
+ Gets the resource number of ${/rtems/ratemon/if/group:/name} objects
+ configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -20,13 +20,19 @@ links:
uid: header-2
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_maximum_periods
notes: |
- See ${/acfg/if/max-periods:/name}.
+ The resource number is defined by the ${/acfg/if/max-periods:/name}
+ application configuration option. See also ${resource-is-unlimited:/name}
+ and ${resource-maximum-per-allocation:/name}.
params: []
return:
return: |
- Returns the maximum number of Classic API Rate Monotonic Periods configured
- for this application.
+ Returns the resource number of ${/rtems/ratemon/if/group:/name} objects
+ configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-ports.yml b/spec/rtems/config/if/get-maximum-ports.yml
index fad700da..babc7abf 100644
--- a/spec/rtems/config/if/get-maximum-ports.yml
+++ b/spec/rtems/config/if/get-maximum-ports.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the maximum number of Classic API Dual-Ported Memories configured for
- this application.
+ Gets the resource number of ${/rtems/dpmem/if/group:/name} objects configured
+ for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -20,13 +20,19 @@ links:
uid: header-2
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_maximum_ports
notes: |
- See ${/acfg/if/max-ports:/name}.
+ The resource number is defined by the ${/acfg/if/max-ports:/name}
+ application configuration option. See also ${resource-is-unlimited:/name}
+ and ${resource-maximum-per-allocation:/name}.
params: []
return:
return: |
- Returns the maximum number of Classic API Dual-Ported Memories configured
- for this application.
+ Returns the resource number of ${/rtems/dpmem/if/group:/name} objects
+ configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-processors.yml b/spec/rtems/config/if/get-maximum-processors.yml
index 289ab87b..745e373d 100644
--- a/spec/rtems/config/if/get-maximum-processors.yml
+++ b/spec/rtems/config/if/get-maximum-processors.yml
@@ -19,6 +19,10 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_maximum_processors
notes: |
The actual number of processors available to the application is returned by
diff --git a/spec/rtems/config/if/get-maximum-regions.yml b/spec/rtems/config/if/get-maximum-regions.yml
index 422882e2..af287244 100644
--- a/spec/rtems/config/if/get-maximum-regions.yml
+++ b/spec/rtems/config/if/get-maximum-regions.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the maximum number of Classic API Regions configured for this
- application.
+ Gets the resource number of ${/rtems/region/if/group:/name} objects
+ configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -20,13 +20,19 @@ links:
uid: header-2
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_maximum_regions
notes: |
- See ${/acfg/if/max-regions:/name}.
+ The resource number is defined by the ${/acfg/if/max-regions:/name}
+ application configuration option. See also ${resource-is-unlimited:/name}
+ and ${resource-maximum-per-allocation:/name}.
params: []
return:
return: |
- Returns the maximum number of Classic API Regions configured for this
- application.
+ Returns the resource number of ${/rtems/region/if/group:/name} objects
+ configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-semaphores.yml b/spec/rtems/config/if/get-maximum-semaphores.yml
index 55d6c2ff..87b9073c 100644
--- a/spec/rtems/config/if/get-maximum-semaphores.yml
+++ b/spec/rtems/config/if/get-maximum-semaphores.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the maximum number of Classic API Semaphores configured for
- this application.
+ Gets the resource number of ${/rtems/sem/if/group:/name} objects configured
+ for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -20,13 +20,19 @@ links:
uid: header-2
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_maximum_semaphores
notes: |
- See ${/acfg/if/max-semaphores:/name}.
+ The resource number is defined by the ${/acfg/if/max-semaphores:/name}
+ application configuration option. See also ${resource-is-unlimited:/name}
+ and ${resource-maximum-per-allocation:/name}.
params: []
return:
return: |
- Returns the maximum number of Classic API Semaphores configured for this
- application.
+ Returns the resource number of ${/rtems/sem/if/group:/name} objects
+ configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-tasks.yml b/spec/rtems/config/if/get-maximum-tasks.yml
index 56bc6eb9..2185f124 100644
--- a/spec/rtems/config/if/get-maximum-tasks.yml
+++ b/spec/rtems/config/if/get-maximum-tasks.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the maximum number of Classic API Tasks configured for this
- application.
+ Gets the resource number of ${/rtems/task/if/group:/name} objects configured
+ for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -20,13 +20,19 @@ links:
uid: header-2
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_maximum_tasks
notes: |
- See ${/acfg/if/max-tasks:/name}.
+ The resource number is defined by the ${/acfg/if/max-tasks:/name}
+ application configuration option. See also ${resource-is-unlimited:/name}
+ and ${resource-maximum-per-allocation:/name}.
params: []
return:
return: |
- Returns the maximum number of Classic API Tasks configured for this
- application.
+ Returns the resource number of ${/rtems/task/if/group:/name} objects
+ configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-maximum-timers.yml b/spec/rtems/config/if/get-maximum-timers.yml
index 8d7e7b97..f4e8b507 100644
--- a/spec/rtems/config/if/get-maximum-timers.yml
+++ b/spec/rtems/config/if/get-maximum-timers.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the maximum number of Classic API Timers configured for
- this application.
+ Gets the resource number of ${/rtems/timer/if/group:/name} objects configured
+ for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -20,13 +20,19 @@ links:
uid: header-2
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_maximum_timers
notes: |
- See ${/acfg/if/max-timers:/name}.
+ The resource number is defined by the ${/acfg/if/max-timers:/name}
+ application configuration option. See also ${resource-is-unlimited:/name}
+ and ${resource-maximum-per-allocation:/name}.
params: []
return:
return: |
- Returns the maximum number of Classic API Timers configured for
- this application.
+ Returns the resource number of ${/rtems/timer/if/group:/name} objects
+ configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-microseconds-per-tick.yml b/spec/rtems/config/if/get-microseconds-per-tick.yml
index a41e8b70..ecdd64f7 100644
--- a/spec/rtems/config/if/get-microseconds-per-tick.yml
+++ b/spec/rtems/config/if/get-microseconds-per-tick.yml
@@ -20,9 +20,14 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_microseconds_per_tick
notes: |
- See ${/acfg/if/microseconds-per-tick:/name}.
+ The number of microseconds per ${/glossary/clock-tick:/term} is defined by
+ the ${/acfg/if/microseconds-per-tick:/name} application configuration option.
params: []
return:
return: |
diff --git a/spec/rtems/config/if/get-milliseconds-per-tick.yml b/spec/rtems/config/if/get-milliseconds-per-tick.yml
index 01ce2f63..f41df422 100644
--- a/spec/rtems/config/if/get-milliseconds-per-tick.yml
+++ b/spec/rtems/config/if/get-milliseconds-per-tick.yml
@@ -20,9 +20,14 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_milliseconds_per_tick
notes: |
- See ${/acfg/if/microseconds-per-tick:/name}.
+ The number of milliseconds per ${/glossary/clock-tick:/term} is defined by
+ the ${/acfg/if/microseconds-per-tick:/name} application configuration option.
params: []
return:
return: |
diff --git a/spec/rtems/config/if/get-nanoseconds-per-tick.yml b/spec/rtems/config/if/get-nanoseconds-per-tick.yml
index 71e779a7..cf193792 100644
--- a/spec/rtems/config/if/get-nanoseconds-per-tick.yml
+++ b/spec/rtems/config/if/get-nanoseconds-per-tick.yml
@@ -20,9 +20,14 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_nanoseconds_per_tick
notes: |
- See ${/acfg/if/microseconds-per-tick:/name}.
+ The number of nanoseconds per ${/glossary/clock-tick:/term} is defined by
+ the ${/acfg/if/microseconds-per-tick:/name} application configuration option.
params: []
return:
return: |
diff --git a/spec/rtems/config/if/get-number-of-initial-extensions.yml b/spec/rtems/config/if/get-number-of-initial-extensions.yml
index d33b35d0..e859d113 100644
--- a/spec/rtems/config/if/get-number-of-initial-extensions.yml
+++ b/spec/rtems/config/if/get-number-of-initial-extensions.yml
@@ -21,9 +21,15 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_number_of_initial_extensions
notes: |
- See ${/acfg/if/initial-extensions:/name}.
+ The number of initial extensions is defined by the
+ ${/acfg/if/initial-extensions:/name} application configuration option and
+ related options.
params: []
return:
return: |
diff --git a/spec/rtems/config/if/get-stack-allocate-for-idle-hook.yml b/spec/rtems/config/if/get-stack-allocate-for-idle-hook.yml
index 1ab43036..178bc721 100644
--- a/spec/rtems/config/if/get-stack-allocate-for-idle-hook.yml
+++ b/spec/rtems/config/if/get-stack-allocate-for-idle-hook.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the thread stack allocator allocate hook used to allocate the stack of
+ Gets the task stack allocator allocate hook used to allocate the stack of
each ${/glossary/idletask:/term} configured for this application.
copyrights:
- Copyright (C) 2021 On-Line Applications Research Corporation (OAR)
@@ -20,13 +20,19 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_stack_allocate_for_idle_hook
notes: |
- See ${/acfg/if/task-stack-allocator-for-idle:/name}.
+ The task stack allocator allocate hook for idle tasks is defined by the
+ ${/acfg/if/task-stack-allocator-for-idle:/name} application configuration
+ option.
params: []
return:
return: |
- Returns the thread stack allocator allocate hook used to allocate the stack
+ Returns the task stack allocator allocate hook used to allocate the stack
of each ${/glossary/idletask:/term} configured for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-stack-allocate-hook.yml b/spec/rtems/config/if/get-stack-allocate-hook.yml
index 18f27680..8b45b009 100644
--- a/spec/rtems/config/if/get-stack-allocate-hook.yml
+++ b/spec/rtems/config/if/get-stack-allocate-hook.yml
@@ -1,7 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the thread stack allocator allocate hook configured for this
- application.
+ Gets the task stack allocator allocate hook configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -20,13 +19,18 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_stack_allocate_hook
notes: |
- See ${/acfg/if/task-stack-allocator:/name}.
+ The task stack allocator allocate hook is defined by the
+ ${/acfg/if/task-stack-allocator:/name} application configuration option.
params: []
return:
return: |
- Returns the thread stack allocator allocate hook configured for this
+ Returns the task stack allocator allocate hook configured for this
application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-stack-allocate-init-hook.yml b/spec/rtems/config/if/get-stack-allocate-init-hook.yml
index 808d7ac4..9a9fc592 100644
--- a/spec/rtems/config/if/get-stack-allocate-init-hook.yml
+++ b/spec/rtems/config/if/get-stack-allocate-init-hook.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the thread stack allocator initialization hook configured for this
+ Gets the task stack allocator initialization hook configured for this
application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -22,13 +22,18 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_stack_allocate_init_hook
notes: |
- See ${/acfg/if/task-stack-allocator-init:/name}.
+ The task stack allocator initialization hook is defined by the
+ ${/acfg/if/task-stack-allocator-init:/name} application configuration option.
params: []
return:
return: |
- Returns the thread stack allocator initialization hook configured for this
+ Returns the task stack allocator initialization hook configured for this
application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-stack-allocator-avoids-work-space.yml b/spec/rtems/config/if/get-stack-allocator-avoids-work-space.yml
index ae0b0619..22ac8cc1 100644
--- a/spec/rtems/config/if/get-stack-allocator-avoids-work-space.yml
+++ b/spec/rtems/config/if/get-stack-allocator-avoids-work-space.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Indicates if the thread stack allocator is configured to avoid the RTEMS
+ Indicates if the task stack allocator is configured to avoid the RTEMS
Workspace for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -20,13 +20,18 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_stack_allocator_avoids_work_space
notes: |
- See ${/acfg/if/task-stack-no-workspace:/name}.
+ The setting is defined by the ${/acfg/if/task-stack-no-workspace:/name}
+ application configuration option.
params: []
return:
return: |
- Returns true, if the thread stack allocator is configured to avoid the
+ Returns true, if the task stack allocator is configured to avoid the
RTEMS Workspace for this application, otherwise false.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-stack-free-hook.yml b/spec/rtems/config/if/get-stack-free-hook.yml
index f3cd15b0..61673bc3 100644
--- a/spec/rtems/config/if/get-stack-free-hook.yml
+++ b/spec/rtems/config/if/get-stack-free-hook.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the thread stack allocator free hook configured for this application.
+ Gets the task stack allocator free hook configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -19,13 +19,18 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_stack_free_hook
notes: |
- See ${/acfg/if/task-stack-deallocator:/name}.
+ The task stack allocator free hook is defined by the
+ ${/acfg/if/task-stack-deallocator:/name} application configuration option.
params: []
return:
return: |
- Returns the thread stack allocator free hook configured for this
+ Returns the task stack allocator free hook configured for this
application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-stack-space-size.yml b/spec/rtems/config/if/get-stack-space-size.yml
index 01916d24..c5dc39e1 100644
--- a/spec/rtems/config/if/get-stack-space-size.yml
+++ b/spec/rtems/config/if/get-stack-space-size.yml
@@ -1,6 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Gets the thread stack space size in bytes of configured for this application.
+ Gets the configured size in bytes of the memory space used to allocate thread
+ stacks for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
@@ -21,12 +22,18 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_stack_space_size
-notes: null
+notes: |
+ The size takes only threads and tasks into account with are known at the
+ application configuration time.
params: []
return:
return: |
- Returns the thread stack space size in bytes of configured for this
- application.
+ Returns the configured size in bytes of the memory space used to allocate
+ thread stacks for this application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-target-hash.yml b/spec/rtems/config/if/get-target-hash.yml
index 6e3d63da..457ac7be 100644
--- a/spec/rtems/config/if/get-target-hash.yml
+++ b/spec/rtems/config/if/get-target-hash.yml
@@ -12,7 +12,8 @@ definition:
variants: []
description: |
The target hash is calculated from BSP-specific values which characterize a
- target system.
+ target system. The target hash is encoded as a base64url string. The target
+ hash algorithm is unspecified.
enabled-by: true
index-entries: []
interface-type: function
@@ -38,6 +39,6 @@ notes: |
params: []
return:
return: |
- Returns the pointer to the RTEMS target hash.
+ Returns a pointer to the RTEMS target hash.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-ticks-per-timeslice.yml b/spec/rtems/config/if/get-ticks-per-timeslice.yml
index 33a2db10..b89520b0 100644
--- a/spec/rtems/config/if/get-ticks-per-timeslice.yml
+++ b/spec/rtems/config/if/get-ticks-per-timeslice.yml
@@ -19,9 +19,14 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_ticks_per_timeslice
notes: |
- See ${/acfg/if/ticks-per-time-slice:/name}.
+ The ${/glossary/clock-tick:/plural} per timeslice is defined by the
+ ${/acfg/if/ticks-per-time-slice:/name} application configuration option.
params: []
return:
return: |
diff --git a/spec/rtems/config/if/get-unified-work-area.yml b/spec/rtems/config/if/get-unified-work-area.yml
index cb919f06..a6839ccb 100644
--- a/spec/rtems/config/if/get-unified-work-area.yml
+++ b/spec/rtems/config/if/get-unified-work-area.yml
@@ -22,9 +22,14 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_unified_work_area
notes: |
- See ${/acfg/if/unified-work-areas:/name}.
+ The setting is defined by the ${/acfg/if/unified-work-areas:/name}
+ application configuration option.
params: []
return:
return: |
diff --git a/spec/rtems/config/if/get-user-extension-table.yml b/spec/rtems/config/if/get-user-extension-table.yml
index b0fa22ad..ef47b394 100644
--- a/spec/rtems/config/if/get-user-extension-table.yml
+++ b/spec/rtems/config/if/get-user-extension-table.yml
@@ -21,12 +21,16 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_user_extension_table
notes: null
params: []
return:
return: |
- Returns the pointer to the initial extensions table configured for this
+ Returns a pointer to the initial extensions table configured for this
application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-user-multiprocessing-table.yml b/spec/rtems/config/if/get-user-multiprocessing-table.yml
index a40d15f3..1ed81316 100644
--- a/spec/rtems/config/if/get-user-multiprocessing-table.yml
+++ b/spec/rtems/config/if/get-user-multiprocessing-table.yml
@@ -8,13 +8,13 @@ definition:
attributes: null
body: ${/c/if/null:/name}
params: []
- return: const ${score/mpci/if/configuration-type:/name} *
+ return: const ${/score/mpci/if/configuration-type:/name} *
variants:
- definition:
attributes: null
body: ( &${/score/mpci/if/configuration:/name} )
params: []
- return: const ${score/mpci/if/configuration-type:/name} *
+ return: const ${/score/mpci/if/configuration-type:/name} *
enabled-by: defined(${/build-options/if/multiprocessing:/name})
description: null
enabled-by: true
@@ -27,12 +27,16 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_user_multiprocessing_table
notes: null
params: []
return:
return: |
- Returns the pointer to the MPCI configuration table configured for this
+ Returns a pointer to the MPCI configuration table configured for this
application.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-version-string.yml b/spec/rtems/config/if/get-version-string.yml
index 0490e7f6..0555d238 100644
--- a/spec/rtems/config/if/get-version-string.yml
+++ b/spec/rtems/config/if/get-version-string.yml
@@ -21,11 +21,17 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_get_version_string
-notes: null
+notes: |
+ The version string has no particular format. Parsing the string may break
+ across RTEMS releases.
params: []
return:
return: |
- Returns the pointer to the RTEMS version string.
+ Returns a pointer to the RTEMS version string.
return-values: []
type: interface
diff --git a/spec/rtems/config/if/get-work-space-size.yml b/spec/rtems/config/if/get-work-space-size.yml
index 4da87bd3..6a89c8e2 100644
--- a/spec/rtems/config/if/get-work-space-size.yml
+++ b/spec/rtems/config/if/get-work-space-size.yml
@@ -24,6 +24,10 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_configuration_get_work_space_size
notes: null
params: []
diff --git a/spec/rtems/config/if/resource-is-unlimited.yml b/spec/rtems/config/if/resource-is-unlimited.yml
index b2adbf23..6fb8e9ae 100644
--- a/spec/rtems/config/if/resource-is-unlimited.yml
+++ b/spec/rtems/config/if/resource-is-unlimited.yml
@@ -7,7 +7,8 @@ definition:
default:
attributes: null
body: ${/score/object/if/is-unlimited:/name}( ${.:/params[0]/name} )
- params: []
+ params:
+ - ${/c/if/uint32_t:/name} ${.:/params[0]/name}
return: ${/c/if/bool:/name}
variants: []
description: null
@@ -21,10 +22,12 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-const
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_resource_is_unlimited
-notes: |
- This function is implemented as a macro and can be used to define compile
- time constants.
+notes: null
params:
- description: is the resource number.
dir: null
diff --git a/spec/rtems/config/if/resource-maximum-per-allocation.yml b/spec/rtems/config/if/resource-maximum-per-allocation.yml
index 8613c126..64f125d5 100644
--- a/spec/rtems/config/if/resource-maximum-per-allocation.yml
+++ b/spec/rtems/config/if/resource-maximum-per-allocation.yml
@@ -8,7 +8,8 @@ definition:
attributes: null
body: |
${/score/object/if/maximum-per-allocation:/name}( ${.:/params[0]/name} )
- params: []
+ params:
+ - ${/c/if/uint32_t:/name} ${.:/params[0]/name}
return: ${/c/if/uint32_t:/name}
variants: []
description: null
@@ -22,10 +23,12 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-const
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_resource_maximum_per_allocation
-notes: |
- This function is implemented as a macro and can be used to define compile
- time constants.
+notes: null
params:
- description: is the resource number.
dir: null
diff --git a/spec/rtems/config/if/resource-unlimited.yml b/spec/rtems/config/if/resource-unlimited.yml
index a573edc7..c19807a3 100644
--- a/spec/rtems/config/if/resource-unlimited.yml
+++ b/spec/rtems/config/if/resource-unlimited.yml
@@ -7,7 +7,8 @@ definition:
default:
attributes: null
body: ( ( ${.:/params[0]/name} ) | ${unlimited-objects:/name} )
- params: []
+ params:
+ - ${/c/if/uint32_t:/name} ${.:/params[0]/name}
return: ${/c/if/uint32_t:/name}
variants: []
description: null
@@ -21,10 +22,14 @@ links:
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
+- role: constraint
+ uid: /constraint/directive-ctx-const
+- role: constraint
+ uid: /constraint/directive-no-preempt
name: rtems_resource_unlimited
notes: |
- This function is implemented as a macro and can be used to define compile
- time constants.
+ This directive should be used to configure unlimited objects, see
+ ${/doc/if/config-unlimited-objects:/name}.
params:
- description: is the resource number to augment.
dir: null
diff --git a/spec/rtems/config/if/stack-allocate-init-hook.yml b/spec/rtems/config/if/stack-allocate-init-hook.yml
index fa5fbba7..965e30b7 100644
--- a/spec/rtems/config/if/stack-allocate-init-hook.yml
+++ b/spec/rtems/config/if/stack-allocate-init-hook.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- A thread stack allocator initialization handler shall have this type.
+ A task stack allocator initialization handler shall have this type.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
diff --git a/spec/rtems/config/if/stack-free-hook.yml b/spec/rtems/config/if/stack-free-hook.yml
index 0c38224b..14125a5a 100644
--- a/spec/rtems/config/if/stack-free-hook.yml
+++ b/spec/rtems/config/if/stack-free-hook.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- A thread stack allocator free handler shall have this type.
+ A task stack allocator free handler shall have this type.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
More information about the vc
mailing list