summaryrefslogtreecommitdiffstats
path: root/spec/rtems/fatal/if/shutdown-executive.yml
blob: 19afa27912a08733481bda6fe7d88bb2213c2edc (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Invokes the fatal error handler.
copyrights:
- Copyright (C) 2015, 2021 embedded brains GmbH & Co. KG
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
definition:
  default:
    attributes: ${../../basedefs/if/no-return:/name}
    body: null
    params:
    - ${/c/if/uint32_t:/name} ${.:/params[0]/name}
    return: void
  variants: []
description: |
  This directive processes fatal errors.  The fatal source is set to
  ${/score/interr/if/source-exit:/name}.  The fatal code is set to the value of
  the ${.:/params[0]/name} parameter.
enabled-by: true
index-entries:
- shutdown RTEMS
interface-type: function
links:
- role: interface-placement
  uid: ../../init/if/header
- role: interface-ingroup
  uid: group
- role: constraint
  uid: /constraint/directive-not-pre-qualified
- role: constraint
  uid: /constraint/directive-ctx-any
- role: constraint
  uid: /constraint/directive-no-return
- role: constraint
  uid: /constraint/extensions-fatal
- role: constraint
  uid: /constraint/no-atexit
- role: constraint
  uid: /constraint/terminate
name: rtems_shutdown_executive
notes: null
params:
- description: |
    is the fatal code.
  dir: null
  name: fatal_code
return: null
type: interface