summaryrefslogtreecommitdiffstats
path: root/spec/rtems/init
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/init')
-rw-r--r--spec/rtems/init/if/group.yml20
-rw-r--r--spec/rtems/init/if/header.yml12
-rw-r--r--spec/rtems/init/if/initialize-executive.yml32
-rw-r--r--spec/rtems/init/if/shutdown-executive.yml35
4 files changed, 99 insertions, 0 deletions
diff --git a/spec/rtems/init/if/group.yml b/spec/rtems/init/if/group.yml
new file mode 100644
index 00000000..89104bf3
--- /dev/null
+++ b/spec/rtems/init/if/group.yml
@@ -0,0 +1,20 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This group contains directives to initialize and shutdown the RTEMS
+ executive.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+description: null
+enabled-by: true
+identifier: RTEMSAPIClassicInit
+interface-type: group
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: ../../if/group
+name: Initialization and Shutdown
+text: |
+ The Classic API shall provide an interface to the Initialization and Shutdown
+ Manager.
+type: interface
diff --git a/spec/rtems/init/if/header.yml b/spec/rtems/init/if/header.yml
new file mode 100644
index 00000000..a842fbd8
--- /dev/null
+++ b/spec/rtems/init/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 Initialization 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/init.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/rtems/init/if/initialize-executive.yml b/spec/rtems/init/if/initialize-executive.yml
new file mode 100644
index 00000000..5d4e3ac1
--- /dev/null
+++ b/spec/rtems/init/if/initialize-executive.yml
@@ -0,0 +1,32 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Initializes the system and starts multitasking.
+copyrights:
+- Copyright (C) 2015, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default:
+ body: null
+ params: []
+ return: ${../../basedefs/if/no-return:/name} void
+ variants: []
+description: |
+ Iterates through the system initialization linker set and invokes the
+ registered handlers. The final step is to start multitasking.
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+name: rtems_initialize_executive
+notes: |
+ This directive should be called by boot_card() only.
+
+ This directive does not return to the caller. Errors in the initialization
+ sequence are usually fatal and lead to a system termination.
+params: []
+return:
+ return: null
+ return-values: []
+type: interface
diff --git a/spec/rtems/init/if/shutdown-executive.yml b/spec/rtems/init/if/shutdown-executive.yml
new file mode 100644
index 00000000..d4e8fe07
--- /dev/null
+++ b/spec/rtems/init/if/shutdown-executive.yml
@@ -0,0 +1,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:
+ - ${/c/if/uint32_t:/name} ${.:/params[0]/name}
+ return: ${../../basedefs/if/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