blob: 517b0cdc53bdc385c5c6c0246f36f8bd5585e611 (
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
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Shuts down the RTEMS environment.
copyrights:
- Copyright (C) 2015, 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
definition:
default:
body: null
params:
- ${/if/c/uint32_t:/name} ${.:/params[0]/name}
return: ${/if/rtems/basedefs/no-return:/name} void
variants: []
description: |
The invocation of this directive results in the RTEMS environment being
shutdown and multitasking halted. The system is terminated with a fatal
source of RTEMS_FATAL_SOURCE_EXIT and the specified result code.
enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
name: rtems_shutdown_executive
notes: |
This directive does not return to the caller.
params:
- description: is the result code.
dir: null
name: result
return:
return: null
return-values: []
type: interface
|
