summaryrefslogtreecommitdiffstats
path: root/spec/rtems/fatal
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/fatal')
-rw-r--r--spec/rtems/fatal/if/assert-context.yml50
-rw-r--r--spec/rtems/fatal/if/error-occurred.yml30
-rw-r--r--spec/rtems/fatal/if/exception-frame-print.yml31
-rw-r--r--spec/rtems/fatal/if/exception-frame.yml19
-rw-r--r--spec/rtems/fatal/if/fatal.yml35
-rw-r--r--spec/rtems/fatal/if/group.yml21
-rw-r--r--spec/rtems/fatal/if/header.yml12
-rw-r--r--spec/rtems/fatal/if/internal-error-text.yml30
-rw-r--r--spec/rtems/fatal/if/panic.yml35
-rw-r--r--spec/rtems/fatal/if/source-text.yml30
10 files changed, 293 insertions, 0 deletions
diff --git a/spec/rtems/fatal/if/assert-context.yml b/spec/rtems/fatal/if/assert-context.yml
new file mode 100644
index 00000000..9fb89b87
--- /dev/null
+++ b/spec/rtems/fatal/if/assert-context.yml
@@ -0,0 +1,50 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+- default:
+ brief: |
+ This member is
+ definition: const char *${.:name}
+ description: '%'
+ kind: member
+ name: file
+ variants: []
+- default:
+ brief: |
+ This member is
+ definition: int ${.:name}
+ description: '%'
+ kind: member
+ name: line
+ variants: []
+- default:
+ brief: |
+ This member is
+ definition: const char *${.:name}
+ description: '%'
+ kind: member
+ name: function
+ variants: []
+- default:
+ brief: |
+ This member is
+ definition: const char *${.:name}
+ description: '%'
+ kind: member
+ name: failed_expression
+ variants: []
+definition-kind: typedef-only
+description: null
+enabled-by: true
+interface-type: struct
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_assert_context
+notes: null
+type: interface
diff --git a/spec/rtems/fatal/if/error-occurred.yml b/spec/rtems/fatal/if/error-occurred.yml
new file mode 100644
index 00000000..a0e8c6df
--- /dev/null
+++ b/spec/rtems/fatal/if/error-occurred.yml
@@ -0,0 +1,30 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${/c/if/uint32_t:/name} ${.:/params[0]/name}
+ return: ${../../basedefs/if/no-return:/name} void
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_fatal_error_occurred
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: the_error
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/fatal/if/exception-frame-print.yml b/spec/rtems/fatal/if/exception-frame-print.yml
new file mode 100644
index 00000000..d65187b9
--- /dev/null
+++ b/spec/rtems/fatal/if/exception-frame-print.yml
@@ -0,0 +1,31 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: |
+ ${/score/cpu/if/exception-frame-print:/name}( ${.:/params[0]/name} );
+ params:
+ - const ${exception-frame:/name} *${.:/params[0]/name}
+ return: void
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_exception_frame_print
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: frame
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/fatal/if/exception-frame.yml b/spec/rtems/fatal/if/exception-frame.yml
new file mode 100644
index 00000000..43aa120b
--- /dev/null
+++ b/spec/rtems/fatal/if/exception-frame.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default: ${/score/cpu/if/exception-frame:/name} ${.:/name}
+ variants: []
+description: null
+enabled-by: true
+interface-type: typedef
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_exception_frame
+notes: null
+type: interface
diff --git a/spec/rtems/fatal/if/fatal.yml b/spec/rtems/fatal/if/fatal.yml
new file mode 100644
index 00000000..10fdaad4
--- /dev/null
+++ b/spec/rtems/fatal/if/fatal.yml
@@ -0,0 +1,35 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: |
+ ${/score/interr/if/terminate:/name}( ${.:/params[0]/name}, ${.:/params[1]/name} );
+ params:
+ - ${../../userext/if/fatal-source:/name} ${.:/params[0]/name}
+ - ${../../userext/if/fatal-code:/name} ${.:/params[1]/name}
+ return: ${../../basedefs/if/no-return:/name} void
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_fatal
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: fatal_source
+- description: '%'
+ dir: null
+ name: error_code
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/fatal/if/group.yml b/spec/rtems/fatal/if/group.yml
new file mode 100644
index 00000000..e3a05303
--- /dev/null
+++ b/spec/rtems/fatal/if/group.yml
@@ -0,0 +1,21 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ The Fatal Error Manager processes all fatal or irrecoverable errors and other
+ sources of system termination (for example after ``exit()``). Fatal errors
+ are identified by the fatal source and error code pair.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: null
+enabled-by: true
+identifier: RTEMSAPIClassicFatal
+interface-type: group
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: ../../if/group
+name: Fatal Error Manager
+text: |
+ The Classic API shall provide an interface to the Fatal Error Manager.
+type: interface
diff --git a/spec/rtems/fatal/if/header.yml b/spec/rtems/fatal/if/header.yml
new file mode 100644
index 00000000..77f8e0c0
--- /dev/null
+++ b/spec/rtems/fatal/if/header.yml
@@ -0,0 +1,12 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Fatal Error Manager API.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+interface-type: header-file
+links:
+- role: interface-placement
+ uid: /if/domain
+path: rtems/fatal.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/rtems/fatal/if/internal-error-text.yml b/spec/rtems/fatal/if/internal-error-text.yml
new file mode 100644
index 00000000..8c55cc07
--- /dev/null
+++ b/spec/rtems/fatal/if/internal-error-text.yml
@@ -0,0 +1,30 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${../../userext/if/fatal-code:/name} ${.:/params[0]/name}
+ return: const char *
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_internal_error_text
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: error
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/fatal/if/panic.yml b/spec/rtems/fatal/if/panic.yml
new file mode 100644
index 00000000..18511f87
--- /dev/null
+++ b/spec/rtems/fatal/if/panic.yml
@@ -0,0 +1,35 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - const char *${.:/params[0]/name}
+ - '...'
+ return: |
+ ${../../basedefs/if/no-return:/name} ${../../basedefs/if/printflike:/name}( 1, 2 ) void
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_panic
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: fmt
+- description: '%'
+ dir: null
+ name: '...'
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/fatal/if/source-text.yml b/spec/rtems/fatal/if/source-text.yml
new file mode 100644
index 00000000..ae97ebbd
--- /dev/null
+++ b/spec/rtems/fatal/if/source-text.yml
@@ -0,0 +1,30 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+ default:
+ body: null
+ params:
+ - ${../../userext/if/fatal-source:/name} ${.:/params[0]/name}
+ return: const char *
+ variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_fatal_source_text
+notes: null
+params:
+- description: '%'
+ dir: null
+ name: source
+return:
+ return: null
+ return-values: []
+type: interface