1 | .. comment SPDX-License-Identifier: CC-BY-SA-4.0 |
---|
2 | |
---|
3 | .. COMMENT: Copyright 2015 embedded brains GmbH |
---|
4 | .. COMMENT: All rights reserved. |
---|
5 | |
---|
6 | Directive Status Codes |
---|
7 | ###################### |
---|
8 | |
---|
9 | Introduction |
---|
10 | ============ |
---|
11 | |
---|
12 | The directive status code directives are: |
---|
13 | |
---|
14 | - rtems_status_text_ - Return the name for the status code |
---|
15 | |
---|
16 | Directives |
---|
17 | ========== |
---|
18 | |
---|
19 | The directives are: |
---|
20 | |
---|
21 | .. list-table:: |
---|
22 | :class: rtems-table |
---|
23 | |
---|
24 | * - ``RTEMS_SUCCESSFUL`` |
---|
25 | - successful completion |
---|
26 | * - ``RTEMS_TASK_EXITTED`` |
---|
27 | - returned from a task |
---|
28 | * - ``RTEMS_MP_NOT_CONFIGURED`` |
---|
29 | - multiprocessing not configured |
---|
30 | * - ``RTEMS_INVALID_NAME`` |
---|
31 | - invalid object name |
---|
32 | * - ``RTEMS_INVALID_ID`` |
---|
33 | - invalid object id |
---|
34 | * - ``RTEMS_TOO_MANY`` |
---|
35 | - too many |
---|
36 | * - ``RTEMS_TIMEOUT`` |
---|
37 | - timed out waiting |
---|
38 | * - ``RTEMS_OBJECT_WAS_DELETED`` |
---|
39 | - object was deleted while waiting |
---|
40 | * - ``RTEMS_INVALID_SIZE`` |
---|
41 | - invalid specified size |
---|
42 | * - ``RTEMS_INVALID_ADDRESS`` |
---|
43 | - invalid address specified |
---|
44 | * - ``RTEMS_INVALID_NUMBER`` |
---|
45 | - number was invalid |
---|
46 | * - ``RTEMS_NOT_DEFINED`` |
---|
47 | - item not initialized |
---|
48 | * - ``RTEMS_RESOURCE_IN_USE`` |
---|
49 | - resources outstanding |
---|
50 | * - ``RTEMS_UNSATISFIED`` |
---|
51 | - request not satisfied |
---|
52 | * - ``RTEMS_INCORRECT_STATE`` |
---|
53 | - task is in wrong state |
---|
54 | * - ``RTEMS_ALREADY_SUSPENDED`` |
---|
55 | - task already in state |
---|
56 | * - ``RTEMS_ILLEGAL_ON_SELF`` |
---|
57 | - illegal for calling task |
---|
58 | * - ``RTEMS_ILLEGAL_ON_REMOTE_OBJECT`` |
---|
59 | - illegal for remote object |
---|
60 | * - ``RTEMS_CALLED_FROM_ISR`` |
---|
61 | - invalid environment |
---|
62 | * - ``RTEMS_INVALID_PRIORITY`` |
---|
63 | - invalid task priority |
---|
64 | * - ``RTEMS_INVALID_CLOCK`` |
---|
65 | - invalid time buffer |
---|
66 | * - ``RTEMS_INVALID_NODE`` |
---|
67 | - invalid node id |
---|
68 | * - ``RTEMS_NOT_CONFIGURED`` |
---|
69 | - directive not configured |
---|
70 | * - ``RTEMS_NOT_OWNER_OF_RESOURCE`` |
---|
71 | - not owner of resource |
---|
72 | * - ``RTEMS_NOT_IMPLEMENTED`` |
---|
73 | - directive not implemented |
---|
74 | * - ``RTEMS_INTERNAL_ERROR`` |
---|
75 | - RTEMS inconsistency detected |
---|
76 | * - ``RTEMS_NO_MEMORY`` |
---|
77 | - could not get enough memory |
---|
78 | |
---|
79 | .. _rtems_status_text: |
---|
80 | |
---|
81 | STATUS_TEXT - Returns the enumeration name for a status code |
---|
82 | ------------------------------------------------------------ |
---|
83 | |
---|
84 | **CALLING SEQUENCE:** |
---|
85 | |
---|
86 | .. index:: rtems_status_text |
---|
87 | |
---|
88 | .. code-block:: c |
---|
89 | |
---|
90 | const char *rtems_status_text( |
---|
91 | rtems_status_code code |
---|
92 | ); |
---|
93 | |
---|
94 | **DIRECTIVE STATUS CODES** |
---|
95 | |
---|
96 | The status code enumeration name or "?" in case the status code is invalid. |
---|
97 | |
---|
98 | **DESCRIPTION:** |
---|
99 | |
---|
100 | Returns the enumeration name for the specified status code. |
---|