blob: 5c6a0eb8a2b8da59ffc9ee1a70af50815fda6cf4 (
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
Directives
==========
This section details the user extension manager's directives. A subsection is
dedicated to each of this manager's directives and describes the calling
sequence, related constants, usage, and status codes.
.. raw:: latex
\clearpage
.. index:: create an extension set
.. index:: rtems_extension_create
.. _rtems_extension_create:
EXTENSION_CREATE - Create a extension set
-----------------------------------------
CALLING SEQUENCE:
.. code-block:: c
rtems_status_code rtems_extension_create(
rtems_name name,
const rtems_extensions_table *table,
rtems_id *id
);
DIRECTIVE STATUS CODES:
.. list-table::
:class: rtems-table
* - ``RTEMS_SUCCESSFUL``
- extension set created successfully
* - ``RTEMS_INVALID_ADDRESS``
- ``table`` or ``id`` are NULL
* - ``RTEMS_INVALID_NAME``
- invalid extension set name
* - ``RTEMS_TOO_MANY``
- too many extension sets created
DESCRIPTION:
This directive creates an extension set object and initializes it using the
specified extension set table. The assigned extension set identifier is
returned in :c:data:`id`. This identifier is used to access the extension
set with other user extension manager directives. For control and
maintenance of the extension set, RTEMS allocates an Extension Set Control
Block (ESCB) from the local ESCB free pool and initializes it. The
user-specified :c:data:`name` is assigned to the ESCB and may be used to
identify the extension set via
:ref:`rtems_extension_ident() <rtems_extension_ident>`. The extension set
specified by :c:data:`table` is copied to the ESCB.
NOTES:
This directive may cause the calling task to be preempted due to an
obtain and release of the object allocator mutex.
.. raw:: latex
\clearpage
.. index:: get ID of an extension set
.. index:: obtain ID of an extension set
.. index:: rtems_extension_ident
.. _rtems_extension_ident:
EXTENSION_IDENT - Get ID of a extension set
-------------------------------------------
CALLING SEQUENCE:
.. code-block:: c
rtems_status_code rtems_extension_ident(
rtems_name name,
rtems_id *id
);
DIRECTIVE STATUS CODES:
.. list-table::
:class: rtems-table
* - ``RTEMS_SUCCESSFUL``
- extension set identified successfully
* - ``RTEMS_INVALID_NAME``
- extension set name not found
DESCRIPTION:
This directive obtains the extension set identifier associated with the
extension set :c:data:`name` to be acquired and returns it in :c:data:`id`.
If the extension set name is not unique, then the extension set identifier
will match one of the extension sets with that name. However, this
extension set identifier is not guaranteed to correspond to the desired
extension set. The extension set identifier is used to access this
extension set in other extension set related directives.
NOTES:
This directive will not cause the running task to be preempted.
.. raw:: latex
\clearpage
.. index:: delete an extension set
.. index:: rtems_extension_delete
.. _rtems_extension_delete:
EXTENSION_DELETE - Delete a extension set
-----------------------------------------
CALLING SEQUENCE:
.. code-block:: c
rtems_status_code rtems_extension_delete(
rtems_id id
);
DIRECTIVE STATUS CODES:
.. list-table::
:class: rtems-table
* - ``RTEMS_SUCCESSFUL``
- extension set deleted successfully
* - ``RTEMS_INVALID_ID``
- invalid extension set id
DESCRIPTION:
This directive deletes the extension set specified by :c:data:`id`. If the
extension set is running, it is automatically canceled. The ESCB for the
deleted extension set is reclaimed by RTEMS.
NOTES:
This directive may cause the calling task to be preempted due to an
obtain and release of the object allocator mutex.
A extension set can be deleted by a task other than the task which created
the extension set.
|
