summaryrefslogtreecommitdiffstats
path: root/spec/if/rtems/config/api-table.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-14 08:29:58 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:38:23 +0200
commitcae542a3541dc5e34d4cf36bc37967e09d0661e2 (patch)
tree3a26a37619a4248460e80e0bbaa7e7d90eb05440 /spec/if/rtems/config/api-table.yml
parentspec: Add specification of glossary items (diff)
downloadrtems-central-cae542a3541dc5e34d4cf36bc37967e09d0661e2.tar.bz2
spec: Add more interface specification items
Diffstat (limited to 'spec/if/rtems/config/api-table.yml')
-rw-r--r--spec/if/rtems/config/api-table.yml117
1 files changed, 117 insertions, 0 deletions
diff --git a/spec/if/rtems/config/api-table.yml b/spec/if/rtems/config/api-table.yml
new file mode 100644
index 00000000..74eccb12
--- /dev/null
+++ b/spec/if/rtems/config/api-table.yml
@@ -0,0 +1,117 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+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:
+- 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
+ description: null
+ kind: member
+ 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
+ description: null
+ kind: member
+ 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
+ description: null
+ kind: member
+ 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
+ description: null
+ kind: member
+ 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
+ description: null
+ kind: member
+ 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
+ description: null
+ kind: member
+ 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
+ description: null
+ kind: member
+ 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
+ description: null
+ kind: member
+ 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
+ description: null
+ kind: member
+ 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
+ description: null
+ kind: member
+ 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
+ description: null
+ kind: member
+ 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
+ description: null
+ kind: member
+ variants: []
+interface-definition-kind: typedef-only
+interface-description: |
+ Use ${get-api-configuration:/interface-name}() to get the configuration
+ table.
+interface-name: rtems_api_configuration_table
+interface-notes: null
+interface-type: struct
+links:
+- role: interface-placement
+ uid: header-2
+- role: interface-ingroup
+ uid: /groups/api/config
+type: interface