summaryrefslogtreecommitdiff
path: root/spec/if/rtems/init
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-14 08:29:58 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:38:23 +0200
commitcae542a3541dc5e34d4cf36bc37967e09d0661e2 (patch)
tree3a26a37619a4248460e80e0bbaa7e7d90eb05440 /spec/if/rtems/init
parentf9cff66d1c1fe69e0814602403279cdf001d36cb (diff)
spec: Add more interface specification items
Diffstat (limited to 'spec/if/rtems/init')
-rw-r--r--spec/if/rtems/init/header.yml10
-rw-r--r--spec/if/rtems/init/initialize-executive.yml31
-rw-r--r--spec/if/rtems/init/shutdown-executive.yml34
3 files changed, 75 insertions, 0 deletions
diff --git a/spec/if/rtems/init/header.yml b/spec/if/rtems/init/header.yml
new file mode 100644
index 00000000..64d108f2
--- /dev/null
+++ b/spec/if/rtems/init/header.yml
@@ -0,0 +1,10 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+interface-domain: rtems
+interface-path: rtems/init.h
+interface-prefix: cpukit/include
+interface-type: header-file
+links: []
+type: interface
diff --git a/spec/if/rtems/init/initialize-executive.yml b/spec/if/rtems/init/initialize-executive.yml
new file mode 100644
index 00000000..b95c79a7
--- /dev/null
+++ b/spec/if/rtems/init/initialize-executive.yml
@@ -0,0 +1,31 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2015, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+interface-brief: |
+ Initializes the system and starts multitasking.
+interface-definition:
+ default:
+ params: []
+ return: ${/if/rtems/basedefs/no-return:/interface-name} void
+ variants: []
+interface-description: |
+ Iterates through the system initialization linker set and invokes the
+ registered handlers. The final step is to start multitasking.
+interface-name: rtems_initialize_executive
+interface-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.
+interface-params: []
+interface-return:
+ return: null
+ return-values: []
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/classic/init
+type: interface
diff --git a/spec/if/rtems/init/shutdown-executive.yml b/spec/if/rtems/init/shutdown-executive.yml
new file mode 100644
index 00000000..c0f28ec4
--- /dev/null
+++ b/spec/if/rtems/init/shutdown-executive.yml
@@ -0,0 +1,34 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2015, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
+enabled-by: true
+interface-brief: |
+ Shuts down the RTEMS environment.
+interface-definition:
+ default:
+ params:
+ - ${/if/c/uint32_t:/interface-name} ${.:/interface-params[0]/name}
+ return: ${/if/rtems/basedefs/no-return:/interface-name} void
+ variants: []
+interface-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.
+interface-name: rtems_shutdown_executive
+interface-notes: |
+ This directive does not return to the caller.
+interface-params:
+- description: is the result code.
+ dir: null
+ name: result
+interface-return:
+ return: null
+ return-values: []
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: /groups/api/classic/init
+type: interface