summaryrefslogtreecommitdiffstats
path: root/spec/rtems/fatal/if/panic.yml
blob: fe51e7317dce86edb9d0e44d8a440b4f06e98459 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Prints the message and invokes the fatal error handler.
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
  default:
    attributes: |
      ${../../basedefs/if/no-return:/name} ${../../basedefs/if/printflike:/name}( 1, 2 )
    body: null
    params:
    - const char *${.:/params[0]/name}
    - '...'
    return: void
  variants: []
description: |
  This directive prints a message via ${../../io/if/printk:/name} specified by
  the ${.:/params[0]/name} parameter and optional parameters and then invokes
  the fatal error handler.  The fatal source is set to
  ${/score/interr/if/source-panic:/name}.  The fatal code is set to the value
  of the ${.:/params[0]/name} parameter value.
enabled-by: true
index-entries:
- panic
interface-type: function
links:
- role: interface-placement
  uid: 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_panic
notes: null
params:
- description: |
    is the message format.
  dir: null
  name: fmt
- description: |
    is a list of optional parameters required by the message format.
  dir: null
  name: '...'
return: null
type: interface