summaryrefslogtreecommitdiffstats
path: root/spec/if/rtems/config/api-table.yml
blob: 17997e1952bae1bcdf2892918631e142dd4f80c1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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)
definition:
- default:
    brief: |
      This field contains the maximum number of Classic API Tasks which are
      configured for this application.
    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:/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:/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:/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:/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:/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:/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:/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:/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:/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:/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 ${../tasks/initialization-table:/name} *${.:name}
    description: null
    kind: member
    name: User_initialization_tasks_table
  variants: []
definition-kind: typedef-only
description: |
  Use ${get-api-configuration:/name} to get the configuration table.
enabled-by: true
interface-type: struct
links:
- role: interface-placement
  uid: header-2
- role: interface-ingroup
  uid: group
name: rtems_api_configuration_table
notes: null
type: interface