source: rtems-central/spec/rtems/userext/if/create.yml

Last change on this file was 6ee44e1, checked in by Sebastian Huber <sebastian.huber@…>, on Jun 11, 2021 at 7:20:23 AM

spec: Use a common phrase for pointer parameters

  • Property mode set to 100644
File size: 3.2 KB
Line 
1SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
2brief: |
3  Creates an extension set.
4copyrights:
5- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
6- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
7definition:
8  default:
9    attributes: null
10    body: null
11    params:
12    - ${../../type/if/name:/name} ${.:/params[0]/name}
13    - const ${table:/name} *${.:/params[1]/name}
14    - ${../../type/if/id:/name} *${.:/params[2]/name}
15    return: ${../../status/if/code:/name}
16  variants: []
17description: |
18  This directive creates an extension set which resides on the local node.  The
19  extension set has the user-defined object name specified in
20  ${.:/params[0]/name}.  The assigned object identifier is returned in
21  ${.:/params[2]/name}.  This identifier is used to access the extension set
22  with other extension set related directives.
23
24  The extension set is initialized using the extension table specified in
25  ${.:/params[1]/name}.
26enabled-by: true
27index-entries:
28- create an extension set
29interface-type: function
30links:
31- role: interface-placement
32  uid: header
33- role: interface-ingroup
34  uid: group
35- role: constraint
36  uid: /constraint/directive-ctx-devinit
37- role: constraint
38  uid: /constraint/directive-ctx-task
39- role: constraint
40  uid: /constraint/object-allocator
41- role: constraint
42  uid: ../constraint/max
43name: rtems_extension_create
44notes: |
45  The user-provided extension set table is not used after the return of the
46  directive.
47
48  Newly created extension sets are immediately installed and are invoked upon
49  the next system event supporting an extension.
50
51  An alternative to dynamically created extension sets are initial extensions,
52  see ${/acfg/if/initial-extensions:/name}.  Initial extensions are recommended
53  for extension sets which provide a fatal error extension.
54
55  For control and maintenance of the extension set, RTEMS allocates a
56  ${/glossary/escb:/term} from the local ESCB free pool and initializes it.
57params:
58- description: |
59    is the object name of the extension set.
60  dir: null
61  name: name
62- description: |
63    is the table with the extensions to be used by the extension set.
64  dir: null
65  name: extension_table
66- description: |
67    is the pointer to an ${../../type/if/id:/name} object.  When the directive
68    call is successful, the identifier of the created extension set will be
69    stored in this object.
70  dir: out
71  name: id
72return:
73  return: null
74  return-values:
75  - description: |
76      The requested operation was successful.
77    value: ${../../status/if/successful:/name}
78  - description: |
79      The ${.:/params[0]/name} parameter was invalid.
80    value: ${../../status/if/invalid-name:/name}
81  - description: |
82      The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
83    value: ${../../status/if/invalid-address:/name}
84  - description: |
85      The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
86    value: ${../../status/if/invalid-address:/name}
87  - description: |
88      There was no inactive object available to create an extension set.  The
89      number of extension sets available to the application is configured
90      through the ${/acfg/if/max-user-extensions:/name} application
91      configuration option.
92    value: ${../../status/if/too-many:/name}
93type: interface
Note: See TracBrowser for help on using the repository browser.