summaryrefslogtreecommitdiffstats
path: root/spec/rtems/init/if/initialize-executive.yml
blob: 5d4e3ac1a9e3aed945dce42a5f983e1964ff10f3 (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
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