summaryrefslogtreecommitdiff
path: root/spec/if/rtems/config
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-25 09:52:00 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:38:23 +0200
commit8821c7d4313148585caaf6f93e85346537746587 (patch)
tree6eedae16d1e957de7a3628d78c4e053d92ea1ec7 /spec/if/rtems/config
parent37d648b805563bc20bc296414ed3f086da190306 (diff)
Rename interface attributes
Diffstat (limited to 'spec/if/rtems/config')
-rw-r--r--spec/if/rtems/config/api-table.yml54
-rw-r--r--spec/if/rtems/config/get-api-configuration.yml22
-rw-r--r--spec/if/rtems/config/get-do-zero-of-workspace.yml26
-rw-r--r--spec/if/rtems/config/get-idle-task-stack-size.yml24
-rw-r--r--spec/if/rtems/config/get-idle-task.yml24
-rw-r--r--spec/if/rtems/config/get-interrupt-stack-size.yml24
-rw-r--r--spec/if/rtems/config/get-maximum-barriers.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-extensions.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-message-queues.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-partitions.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-periods.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-ports.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-processors.yml34
-rw-r--r--spec/if/rtems/config/get-maximum-regions.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-semaphores.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-tasks.yml26
-rw-r--r--spec/if/rtems/config/get-maximum-timers.yml26
-rw-r--r--spec/if/rtems/config/get-microseconds-per-tick.yml24
-rw-r--r--spec/if/rtems/config/get-milliseconds-per-tick.yml24
-rw-r--r--spec/if/rtems/config/get-nanoseconds-per-tick.yml24
-rw-r--r--spec/if/rtems/config/get-number-of-initial-extensions.yml24
-rw-r--r--spec/if/rtems/config/get-stack-allocate-hook.yml24
-rw-r--r--spec/if/rtems/config/get-stack-allocate-init-hook.yml24
-rw-r--r--spec/if/rtems/config/get-stack-allocator-avoids-work-space.yml26
-rw-r--r--spec/if/rtems/config/get-stack-free-hook.yml24
-rw-r--r--spec/if/rtems/config/get-stack-space-size.yml26
-rw-r--r--spec/if/rtems/config/get-ticks-per-timeslice.yml24
-rw-r--r--spec/if/rtems/config/get-unified-work-area.yml26
-rw-r--r--spec/if/rtems/config/get-user-extension-table.yml26
-rw-r--r--spec/if/rtems/config/get-user-multiprocessing-table.yml30
-rw-r--r--spec/if/rtems/config/get-work-space-size.yml28
-rw-r--r--spec/if/rtems/config/header-2.yml6
-rw-r--r--spec/if/rtems/config/header.yml6
-rw-r--r--spec/if/rtems/config/resource-is-unlimited.yml30
-rw-r--r--spec/if/rtems/config/resource-maximum-per-allocation.yml30
-rw-r--r--spec/if/rtems/config/resource-unlimited.yml30
-rw-r--r--spec/if/rtems/config/stack-allocate-hook.yml16
-rw-r--r--spec/if/rtems/config/stack-allocate-init-hook.yml16
-rw-r--r--spec/if/rtems/config/stack-free-hook.yml16
-rw-r--r--spec/if/rtems/config/unlimited-objects.yml16
40 files changed, 500 insertions, 488 deletions
diff --git a/spec/if/rtems/config/api-table.yml b/spec/if/rtems/config/api-table.yml
index 74eccb12..32f1eb06 100644
--- a/spec/if/rtems/config/api-table.yml
+++ b/spec/if/rtems/config/api-table.yml
@@ -1,117 +1,129 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This structure contains a summary of the Classic API configuration.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
-enabled-by: true
-interface-brief: |
- This structure contains a summary of the Classic API configuration.
-interface-definition:
+definition:
- default:
brief: |
This field contains the maximum number of Classic API Tasks which are
configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_tasks
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_tasks
variants: []
- default:
brief: |
This field indicates if Classic API Notepads are enabled or disabled for
this application.
- definition: ${/if/c/bool:/interface-name} notepads_enabled
+ definition: ${/if/c/bool:/name} ${.:name}
description: null
kind: member
+ name: notepads_enabled
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Timers which are
configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_timers
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_timers
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Semaphores which
are configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_semaphores
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_semaphores
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Message Queues
which are configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_message_queues
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_message_queues
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Partitions which
are configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_partitions
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_partitions
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Regions which are
configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_regions
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_regions
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Dual Ported Memory
Areas which are configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_ports
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_ports
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Rate Monotonic
Periods which are configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_periods
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_periods
variants: []
- default:
brief: |
This field contains the maximum number of Classic API Barriers which are
configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} maximum_barriers
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: maximum_barriers
variants: []
- default:
brief: |
This field contains the number of Classic API Initialization
Tasks which are configured for this application.
- definition: ${/if/c/uint32_t:/interface-name} number_of_initialization_tasks
+ definition: ${/if/c/uint32_t:/name} ${.:name}
description: null
kind: member
+ name: number_of_initialization_tasks
variants: []
- default:
brief: |
This field contains the pointer to Classic API Initialization Tasks Table
of this application.
- definition: const rtems_initialization_tasks_table *User_initialization_tasks_table
+ definition: const rtems_initialization_tasks_table *${.:name}
description: null
kind: member
+ name: User_initialization_tasks_table
variants: []
-interface-definition-kind: typedef-only
-interface-description: |
- Use ${get-api-configuration:/interface-name}() to get the configuration
+definition-kind: typedef-only
+description: |
+ Use ${get-api-configuration:/name}() to get the configuration
table.
-interface-name: rtems_api_configuration_table
-interface-notes: null
+enabled-by: true
interface-type: struct
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_api_configuration_table
+notes: null
type: interface
diff --git a/spec/if/rtems/config/get-api-configuration.yml b/spec/if/rtems/config/get-api-configuration.yml
index 077a84d2..4f6ce3a7 100644
--- a/spec/if/rtems/config/get-api-configuration.yml
+++ b/spec/if/rtems/config/get-api-configuration.yml
@@ -1,25 +1,25 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the pointer to the Classic API Configuration Table of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the pointer to the Classic API Configuration Table of this application.
-interface-definition:
+definition:
default:
params: []
return: const rtems_api_configuration_table *
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_rtems_api_configuration
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_rtems_api_configuration
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-do-zero-of-workspace.yml b/spec/if/rtems/config/get-do-zero-of-workspace.yml
index 22d92764..d3e4e29b 100644
--- a/spec/if/rtems/config/get-do-zero-of-workspace.yml
+++ b/spec/if/rtems/config/get-do-zero-of-workspace.yml
@@ -1,24 +1,24 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns true, if the workspace is zeroed during system initialization,
otherwise returns false.
-interface-definition:
- default: ${/if/impl/memory/zero-before-use:/interface-name}
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default: ${/if/impl/memory/zero-before-use:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_do_zero_of_workspace
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_do_zero_of_workspace
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-idle-task-stack-size.yml b/spec/if/rtems/config/get-idle-task-stack-size.yml
index 57ba76c3..04618bf2 100644
--- a/spec/if/rtems/config/get-idle-task-stack-size.yml
+++ b/spec/if/rtems/config/get-idle-task-stack-size.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the configured IDLE task stack size in bytes of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the configured IDLE task stack size in bytes of this application.
-interface-definition:
- default: ${/if/impl/thread/idle-stack-size:/interface-name}
+definition:
+ default: ${/if/impl/thread/idle-stack-size:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_idle_task_stack_size
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_idle_task_stack_size
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-idle-task.yml b/spec/if/rtems/config/get-idle-task.yml
index 560d264c..5ad43ab7 100644
--- a/spec/if/rtems/config/get-idle-task.yml
+++ b/spec/if/rtems/config/get-idle-task.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the configured IDLE task entry of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the configured IDLE task entry of this application.
-interface-definition:
- default: ${/if/impl/thread/idle-body:/interface-name}
+definition:
+ default: ${/if/impl/thread/idle-body:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_idle_task
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_idle_task
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-interrupt-stack-size.yml b/spec/if/rtems/config/get-interrupt-stack-size.yml
index ca6bbaff..06e0c275 100644
--- a/spec/if/rtems/config/get-interrupt-stack-size.yml
+++ b/spec/if/rtems/config/get-interrupt-stack-size.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the configured interrupt stack size in bytes of this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the configured interrupt stack size in bytes of this application.
-interface-definition:
- default: ((${/if/c/size_t:/interface-name}) ${/if/impl/isr/stack-size:/interface-name})
+definition:
+ default: ((${/if/c/size_t:/name}) ${/if/impl/isr/stack-size:/name})
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_interrupt_stack_size
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_interrupt_stack_size
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-barriers.yml b/spec/if/rtems/config/get-maximum-barriers.yml
index 6b400041..ef4a519f 100644
--- a/spec/if/rtems/config/get-maximum-barriers.yml
+++ b/spec/if/rtems/config/get-maximum-barriers.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the maximum number of Classic API Barriers which are configured for
this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_barriers
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_barriers
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-extensions.yml b/spec/if/rtems/config/get-maximum-extensions.yml
index be808032..dcfc17bb 100644
--- a/spec/if/rtems/config/get-maximum-extensions.yml
+++ b/spec/if/rtems/config/get-maximum-extensions.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the maximum number of Classic API User Extensions which are
configured for this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_extensions
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_extensions
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-message-queues.yml b/spec/if/rtems/config/get-maximum-message-queues.yml
index dd2d367c..1eeb35f7 100644
--- a/spec/if/rtems/config/get-maximum-message-queues.yml
+++ b/spec/if/rtems/config/get-maximum-message-queues.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the maximum number of Classic API Message Queues which are configured
for this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_message_queues
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_message_queues
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-partitions.yml b/spec/if/rtems/config/get-maximum-partitions.yml
index faa960b0..1d2c5e8c 100644
--- a/spec/if/rtems/config/get-maximum-partitions.yml
+++ b/spec/if/rtems/config/get-maximum-partitions.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the maximum number of Classic API Partitions which are configured for
this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_partitions
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_partitions
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-periods.yml b/spec/if/rtems/config/get-maximum-periods.yml
index 5b569cb6..2a66e63c 100644
--- a/spec/if/rtems/config/get-maximum-periods.yml
+++ b/spec/if/rtems/config/get-maximum-periods.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the maximum number of Classic API Rate Monotonic Periods which are
configured for this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_periods
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_periods
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-ports.yml b/spec/if/rtems/config/get-maximum-ports.yml
index 792deb79..ccc0a8f5 100644
--- a/spec/if/rtems/config/get-maximum-ports.yml
+++ b/spec/if/rtems/config/get-maximum-ports.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the maximum number of Classic API Dual Ported Memory Areas which are
configured for this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_ports
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_ports
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-processors.yml b/spec/if/rtems/config/get-maximum-processors.yml
index a52a6e23..594fece3 100644
--- a/spec/if/rtems/config/get-maximum-processors.yml
+++ b/spec/if/rtems/config/get-maximum-processors.yml
@@ -1,29 +1,29 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the maximum number of processors which are configured for this
application.
-interface-definition:
- default: ${/if/impl/smp/processor-configured-maximum:/interface-name}
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default: ${/if/impl/smp/processor-configured-maximum:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_processors
-interface-notes: |
+description: null
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/config
+name: rtems_configuration_get_maximum_processors
+notes: |
The actual number of processors available for the application will be less
than or equal to the configured maximum number of processors.
On uniprocessor configurations this macro is a compile time constant which
evaluates to one.
-interface-params: []
-interface-return:
+params: []
+return:
return: null
return-values: []
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: /groups/api/config
type: interface
diff --git a/spec/if/rtems/config/get-maximum-regions.yml b/spec/if/rtems/config/get-maximum-regions.yml
index efd251d2..4f5d8715 100644
--- a/spec/if/rtems/config/get-maximum-regions.yml
+++ b/spec/if/rtems/config/get-maximum-regions.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the maximum number of Classic API Regions which are configured for
this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_regions
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_regions
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-semaphores.yml b/spec/if/rtems/config/get-maximum-semaphores.yml
index 46fbec45..f0506c50 100644
--- a/spec/if/rtems/config/get-maximum-semaphores.yml
+++ b/spec/if/rtems/config/get-maximum-semaphores.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the maximum number of Classic API Semaphores which are configured for
this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_semaphores
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_semaphores
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-tasks.yml b/spec/if/rtems/config/get-maximum-tasks.yml
index 6f855d9e..4e027e0f 100644
--- a/spec/if/rtems/config/get-maximum-tasks.yml
+++ b/spec/if/rtems/config/get-maximum-tasks.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the maximum number of Classic API Tasks which are configured for this
application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_tasks
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_tasks
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-maximum-timers.yml b/spec/if/rtems/config/get-maximum-timers.yml
index 43700c8e..1961ed63 100644
--- a/spec/if/rtems/config/get-maximum-timers.yml
+++ b/spec/if/rtems/config/get-maximum-timers.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the maximum number of Classic API Timers which are configured for
this application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uint32_t:/interface-name}
+ return: ${/if/c/uint32_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_maximum_timers
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header-2
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_maximum_timers
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-microseconds-per-tick.yml b/spec/if/rtems/config/get-microseconds-per-tick.yml
index bce672f7..8ddf1636 100644
--- a/spec/if/rtems/config/get-microseconds-per-tick.yml
+++ b/spec/if/rtems/config/get-microseconds-per-tick.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the number of microseconds per tick configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the number of microseconds per tick configured for this application.
-interface-definition:
- default: ${/if/impl/watchdog/microseconds-per-tick:/interface-name}
+definition:
+ default: ${/if/impl/watchdog/microseconds-per-tick:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_microseconds_per_tick
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_microseconds_per_tick
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-milliseconds-per-tick.yml b/spec/if/rtems/config/get-milliseconds-per-tick.yml
index 207d1a6b..3a5a5b15 100644
--- a/spec/if/rtems/config/get-milliseconds-per-tick.yml
+++ b/spec/if/rtems/config/get-milliseconds-per-tick.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the number of milliseconds per tick configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the number of milliseconds per tick configured for this application.
-interface-definition:
- default: (${/if/impl/watchdog/microseconds-per-tick:/interface-name} / 1000)
+definition:
+ default: (${/if/impl/watchdog/microseconds-per-tick:/name} / 1000)
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_milliseconds_per_tick
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_milliseconds_per_tick
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-nanoseconds-per-tick.yml b/spec/if/rtems/config/get-nanoseconds-per-tick.yml
index abca907a..63155fd6 100644
--- a/spec/if/rtems/config/get-nanoseconds-per-tick.yml
+++ b/spec/if/rtems/config/get-nanoseconds-per-tick.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the number of microseconds per tick configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the number of microseconds per tick configured for this application.
-interface-definition:
- default: ${/if/impl/watchdog/nanoseconds-per-tick:/interface-name}
+definition:
+ default: ${/if/impl/watchdog/nanoseconds-per-tick:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_nanoseconds_per_tick
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_nanoseconds_per_tick
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-number-of-initial-extensions.yml b/spec/if/rtems/config/get-number-of-initial-extensions.yml
index 283caa7d..9a3d84f1 100644
--- a/spec/if/rtems/config/get-number-of-initial-extensions.yml
+++ b/spec/if/rtems/config/get-number-of-initial-extensions.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the number of initial extensions configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the number of initial extensions configured for this application.
-interface-definition:
- default: ((${/if/c/uint32_t:/interface-name}) ${/if/impl/userext/initial-count:/interface-name})
+definition:
+ default: ((${/if/c/uint32_t:/name}) ${/if/impl/userext/initial-count:/name})
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_number_of_initial_extensions
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_number_of_initial_extensions
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-stack-allocate-hook.yml b/spec/if/rtems/config/get-stack-allocate-hook.yml
index 9ad0dbdc..0a6b236b 100644
--- a/spec/if/rtems/config/get-stack-allocate-hook.yml
+++ b/spec/if/rtems/config/get-stack-allocate-hook.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the thread stack allocator allocate hook.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the thread stack allocator allocate hook.
-interface-definition:
- default: ${/if/impl/stack/allocator-allocate:/interface-name}
+definition:
+ default: ${/if/impl/stack/allocator-allocate:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_stack_allocate_hook
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_stack_allocate_hook
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-stack-allocate-init-hook.yml b/spec/if/rtems/config/get-stack-allocate-init-hook.yml
index 35519031..ddf7dc98 100644
--- a/spec/if/rtems/config/get-stack-allocate-init-hook.yml
+++ b/spec/if/rtems/config/get-stack-allocate-init-hook.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the thread stack allocator initialization hook.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the thread stack allocator initialization hook.
-interface-definition:
- default: ${/if/impl/stack/allocator-initialize:/interface-name}
+definition:
+ default: ${/if/impl/stack/allocator-initialize:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_stack_allocate_init_hook
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_stack_allocate_init_hook
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-stack-allocator-avoids-work-space.yml b/spec/if/rtems/config/get-stack-allocator-avoids-work-space.yml
index e8cd8554..9e40c8fb 100644
--- a/spec/if/rtems/config/get-stack-allocator-avoids-work-space.yml
+++ b/spec/if/rtems/config/get-stack-allocator-avoids-work-space.yml
@@ -1,24 +1,24 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns true, if the thread stack allocator avoids the workspace, otherwise
returns false.
-interface-definition:
- default: ${/if/impl/stack/allocator-avoids-workspace:/interface-name}
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default: ${/if/impl/stack/allocator-avoids-workspace:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_stack_allocator_avoids_work_space
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_stack_allocator_avoids_work_space
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-stack-free-hook.yml b/spec/if/rtems/config/get-stack-free-hook.yml
index 70bd32e0..112428ab 100644
--- a/spec/if/rtems/config/get-stack-free-hook.yml
+++ b/spec/if/rtems/config/get-stack-free-hook.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the thread stack allocator free hook.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the thread stack allocator free hook.
-interface-definition:
- default: ${/if/impl/stack/allocator-free:/interface-name}
+definition:
+ default: ${/if/impl/stack/allocator-free:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_stack_free_hook
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_stack_free_hook
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-stack-space-size.yml b/spec/if/rtems/config/get-stack-space-size.yml
index 98b5b457..5b17cbea 100644
--- a/spec/if/rtems/config/get-stack-space-size.yml
+++ b/spec/if/rtems/config/get-stack-space-size.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the thread stack space size in bytes of configured for this
application.
-interface-definition:
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
default:
params: []
- return: ${/if/c/uintptr_t:/interface-name}
+ return: ${/if/c/uintptr_t:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_stack_space_size
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_stack_space_size
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-ticks-per-timeslice.yml b/spec/if/rtems/config/get-ticks-per-timeslice.yml
index 02c606b5..84d05311 100644
--- a/spec/if/rtems/config/get-ticks-per-timeslice.yml
+++ b/spec/if/rtems/config/get-ticks-per-timeslice.yml
@@ -1,23 +1,23 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the ticks per timeslice configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the ticks per timeslice configured for this application.
-interface-definition:
- default: ${/if/impl/watchdog/ticks-per-timeslice:/interface-name}
+definition:
+ default: ${/if/impl/watchdog/ticks-per-timeslice:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_ticks_per_timeslice
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_ticks_per_timeslice
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-unified-work-area.yml b/spec/if/rtems/config/get-unified-work-area.yml
index c8e2a42c..fcc0e323 100644
--- a/spec/if/rtems/config/get-unified-work-area.yml
+++ b/spec/if/rtems/config/get-unified-work-area.yml
@@ -1,24 +1,24 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns true, if the RTEMS Workspace and C Program Heap are unified,
otherwise returns false.
-interface-definition:
- default: ${/if/impl/wkspace/is-unified:/interface-name}
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default: ${/if/impl/wkspace/is-unified:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_unified_work_area
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_unified_work_area
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-user-extension-table.yml b/spec/if/rtems/config/get-user-extension-table.yml
index 6dfda766..79d53048 100644
--- a/spec/if/rtems/config/get-user-extension-table.yml
+++ b/spec/if/rtems/config/get-user-extension-table.yml
@@ -1,24 +1,24 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the pointer to the initial extensions table configured for this
application.
-interface-definition:
- default: ${/if/impl/userext/initial-extensions:/interface-name}
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default: ${/if/impl/userext/initial-extensions:/name}
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_user_extension_table
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_user_extension_table
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-user-multiprocessing-table.yml b/spec/if/rtems/config/get-user-multiprocessing-table.yml
index c1f73588..f08a7da7 100644
--- a/spec/if/rtems/config/get-user-multiprocessing-table.yml
+++ b/spec/if/rtems/config/get-user-multiprocessing-table.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
+brief: |
Returns the pointer to the MPCI configuration table configured for this
application.
-interface-definition:
- default: ${/if/c/null:/interface-name}
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default: ${/if/c/null:/name}
variants:
- - definition: ${/if/impl/mpci/configuration:/interface-name}
- enabled-by: defined(${/if/build-options/multiprocessing:/interface-name})
-interface-description: null
-interface-name: rtems_configuration_get_user_multiprocessing_table
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+ - definition: ${/if/impl/mpci/configuration:/name}
+ enabled-by: defined(${/if/build-options/multiprocessing:/name})
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_user_multiprocessing_table
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/get-work-space-size.yml b/spec/if/rtems/config/get-work-space-size.yml
index 47b7c6dd..fbadf78c 100644
--- a/spec/if/rtems/config/get-work-space-size.yml
+++ b/spec/if/rtems/config/get-work-space-size.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the RTEMS Workspace size in bytes configured for this application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the RTEMS Workspace size in bytes configured for this application.
-interface-definition:
+definition:
default: |
- (${/if/impl/wkspace/size:/interface-name} +
- (${get-stack-allocator-avoids-work-space:/interface-name}() ?
- 0 : ${get-stack-space-size:/interface-name}()))
+ (${/if/impl/wkspace/size:/name} +
+ (${get-stack-allocator-avoids-work-space:/name}() ?
+ 0 : ${get-stack-space-size:/name}()))
variants: []
-interface-description: null
-interface-name: rtems_configuration_get_work_space_size
-interface-notes: null
-interface-params: []
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_configuration_get_work_space_size
+notes: null
+params: []
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/header-2.yml b/spec/if/rtems/config/header-2.yml
index 0e8757c9..22e77a43 100644
--- a/spec/if/rtems/config/header-2.yml
+++ b/spec/if/rtems/config/header-2.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: rtems
enabled-by: true
-interface-domain: rtems
-interface-path: rtems/rtems/config.h
-interface-prefix: cpukit/include
interface-type: header-file
links: []
+path: rtems/rtems/config.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/rtems/config/header.yml b/spec/if/rtems/config/header.yml
index 8cd66f2f..1e1041d6 100644
--- a/spec/if/rtems/config/header.yml
+++ b/spec/if/rtems/config/header.yml
@@ -1,10 +1,8 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+domain: rtems
enabled-by: true
-interface-domain: rtems
-interface-path: rtems/config.h
-interface-prefix: cpukit/include
interface-type: header-file
links:
- enabled-by: RTEMS_MULTIPROCESSING
@@ -13,4 +11,6 @@ links:
- enabled-by: RTEMS_MULTIPROCESSING
role: interface-include
uid: /if/rtems/types/header
+path: rtems/config.h
+prefix: cpukit/include
type: interface
diff --git a/spec/if/rtems/config/resource-is-unlimited.yml b/spec/if/rtems/config/resource-is-unlimited.yml
index b703e460..8bf0b34f 100644
--- a/spec/if/rtems/config/resource-is-unlimited.yml
+++ b/spec/if/rtems/config/resource-is-unlimited.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns true, if the resource is unlimited, otherwise returns false.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns true, if the resource is unlimited, otherwise returns false.
-interface-definition:
- default: ${/if/impl/object/is-unlimited:/interface-name}(${.:/interface-params[0]/name})
+definition:
+ default: ${/if/impl/object/is-unlimited:/name}(${.:/params[0]/name})
variants: []
-interface-description: null
-interface-name: rtems_resource_is_unlimited
-interface-notes: null
-interface-params:
-- description: is the resource number.
- dir: null
- name: _resource
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_resource_is_unlimited
+notes: null
+params:
+- description: is the resource number.
+ dir: null
+ name: _resource
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/resource-maximum-per-allocation.yml b/spec/if/rtems/config/resource-maximum-per-allocation.yml
index 0e140ab2..5af1e5f7 100644
--- a/spec/if/rtems/config/resource-maximum-per-allocation.yml
+++ b/spec/if/rtems/config/resource-maximum-per-allocation.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the resource maximum number per allocation.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the resource maximum number per allocation.
-interface-definition:
- default: ${/if/impl/object/maximum-per-allocation:/interface-name}(${.:/interface-params[0]/name})
+definition:
+ default: ${/if/impl/object/maximum-per-allocation:/name}(${.:/params[0]/name})
variants: []
-interface-description: null
-interface-name: rtems_resource_maximum_per_allocation
-interface-notes: null
-interface-params:
-- description: is the resource number.
- dir: null
- name: _resource
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_resource_maximum_per_allocation
+notes: null
+params:
+- description: is the resource number.
+ dir: null
+ name: _resource
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/resource-unlimited.yml b/spec/if/rtems/config/resource-unlimited.yml
index 43f5be14..c0f36e0d 100644
--- a/spec/if/rtems/config/resource-unlimited.yml
+++ b/spec/if/rtems/config/resource-unlimited.yml
@@ -1,26 +1,26 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Returns the specified resource number configured for unlimited resources.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- Returns the specified resource number configured for unlimited resources.
-interface-definition:
- default: ((${.:/interface-params[0]/name}) | ${unlimited-objects:/interface-name})
+definition:
+ default: ((${.:/params[0]/name}) | ${unlimited-objects:/name})
variants: []
-interface-description: null
-interface-name: rtems_resource_unlimited
-interface-notes: null
-interface-params:
-- description: is the resource number.
- dir: null
- name: _resource
-interface-return:
- return: null
- return-values: []
+description: null
+enabled-by: true
interface-type: macro
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_resource_unlimited
+notes: null
+params:
+- description: is the resource number.
+ dir: null
+ name: _resource
+return:
+ return: null
+ return-values: []
type: interface
diff --git a/spec/if/rtems/config/stack-allocate-hook.yml b/spec/if/rtems/config/stack-allocate-hook.yml
index d4b980b5..66147d2e 100644
--- a/spec/if/rtems/config/stack-allocate-hook.yml
+++ b/spec/if/rtems/config/stack-allocate-hook.yml
@@ -1,19 +1,19 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ The thread stack allocator allocate handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- The thread stack allocator allocate handler.
-interface-definition:
- default: ${/if/impl/stack/allocator-allocate-type:/interface-name} ${.:/interface-name}
+definition:
+ default: ${/if/impl/stack/allocator-allocate-type:/name} ${.:/name}
variants: []
-interface-description: null
-interface-name: rtems_stack_allocate_hook
-interface-notes: null
+description: null
+enabled-by: true
interface-type: typedef
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_stack_allocate_hook
+notes: null
type: interface
diff --git a/spec/if/rtems/config/stack-allocate-init-hook.yml b/spec/if/rtems/config/stack-allocate-init-hook.yml
index 18abd6d7..a762d99e 100644
--- a/spec/if/rtems/config/stack-allocate-init-hook.yml
+++ b/spec/if/rtems/config/stack-allocate-init-hook.yml
@@ -1,19 +1,19 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ The thread stack allocator initialization handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- The thread stack allocator initialization handler.
-interface-definition:
- default: ${/if/impl/stack/allocator-initialize-type:/interface-name} ${.:/interface-name}
+definition:
+ default: ${/if/impl/stack/allocator-initialize-type:/name} ${.:/name}
variants: []
-interface-description: null
-interface-name: rtems_stack_allocate_init_hook
-interface-notes: null
+description: null
+enabled-by: true
interface-type: typedef
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_stack_allocate_init_hook
+notes: null
type: interface
diff --git a/spec/if/rtems/config/stack-free-hook.yml b/spec/if/rtems/config/stack-free-hook.yml
index 5b15e4f2..d67e9ec1 100644
--- a/spec/if/rtems/config/stack-free-hook.yml
+++ b/spec/if/rtems/config/stack-free-hook.yml
@@ -1,19 +1,19 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ The thread stack allocator free handler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- The thread stack allocator free handler.
-interface-definition:
- default: ${/if/impl/stack/allocator-free-type:/interface-name} ${.:/interface-name}
+definition:
+ default: ${/if/impl/stack/allocator-free-type:/name} ${.:/name}
variants: []
-interface-description: null
-interface-name: rtems_stack_free_hook
-interface-notes: null
+description: null
+enabled-by: true
interface-type: typedef
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: rtems_stack_free_hook
+notes: null
type: interface
diff --git a/spec/if/rtems/config/unlimited-objects.yml b/spec/if/rtems/config/unlimited-objects.yml
index ac92cec1..779f16d9 100644
--- a/spec/if/rtems/config/unlimited-objects.yml
+++ b/spec/if/rtems/config/unlimited-objects.yml
@@ -1,19 +1,19 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This flag is used in resource numbers to indicate an unlimited resource.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-enabled-by: true
-interface-brief: |
- This flag is used in resource numbers to indicate an unlimited resource.
-interface-definition:
- default: ${/if/impl/object/unlimited-objects:/interface-name}
+definition:
+ default: ${/if/impl/object/unlimited-objects:/name}
variants: []
-interface-description: null
-interface-name: RTEMS_UNLIMITED_OBJECTS
-interface-notes: null
+description: null
+enabled-by: true
interface-type: define
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: /groups/api/config
+name: RTEMS_UNLIMITED_OBJECTS
+notes: null
type: interface