summaryrefslogtreecommitdiffstats
path: root/spec/if/rtems/config/api-table.yml
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/api-table.yml
parentspec: Add specification of interface group items (diff)
downloadrtems-central-8821c7d4313148585caaf6f93e85346537746587.tar.bz2
Rename interface attributes
Diffstat (limited to 'spec/if/rtems/config/api-table.yml')
-rw-r--r--spec/if/rtems/config/api-table.yml54
1 files changed, 33 insertions, 21 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