diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-25 09:52:00 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-28 10:38:23 +0200 |
commit | 8821c7d4313148585caaf6f93e85346537746587 (patch) | |
tree | 6eedae16d1e957de7a3628d78c4e053d92ea1ec7 /spec/if/rtems/init | |
parent | 37d648b805563bc20bc296414ed3f086da190306 (diff) |
Rename interface attributes
Diffstat (limited to 'spec/if/rtems/init')
-rw-r--r-- | spec/if/rtems/init/header.yml | 6 | ||||
-rw-r--r-- | spec/if/rtems/init/initialize-executive.yml | 32 | ||||
-rw-r--r-- | spec/if/rtems/init/shutdown-executive.yml | 34 |
3 files changed, 36 insertions, 36 deletions
diff --git a/spec/if/rtems/init/header.yml b/spec/if/rtems/init/header.yml index 64d108f2..6128dace 100644 --- a/spec/if/rtems/init/header.yml +++ b/spec/if/rtems/init/header.yml @@ -1,10 +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) +domain: rtems enabled-by: true -interface-domain: rtems -interface-path: rtems/init.h -interface-prefix: cpukit/include interface-type: header-file links: [] +path: rtems/init.h +prefix: cpukit/include type: interface diff --git a/spec/if/rtems/init/initialize-executive.yml b/spec/if/rtems/init/initialize-executive.yml index b95c79a7..dd5a4c48 100644 --- a/spec/if/rtems/init/initialize-executive.yml +++ b/spec/if/rtems/init/initialize-executive.yml @@ -1,31 +1,31 @@ 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) -enabled-by: true -interface-brief: | - Initializes the system and starts multitasking. -interface-definition: +definition: default: params: [] - return: ${/if/rtems/basedefs/no-return:/interface-name} void + return: ${/if/rtems/basedefs/no-return:/name} void variants: [] -interface-description: | +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: [] +enabled-by: true interface-type: function links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/classic/init +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/if/rtems/init/shutdown-executive.yml b/spec/if/rtems/init/shutdown-executive.yml index c0f28ec4..bab3153f 100644 --- a/spec/if/rtems/init/shutdown-executive.yml +++ b/spec/if/rtems/init/shutdown-executive.yml @@ -1,34 +1,34 @@ 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) -enabled-by: true -interface-brief: | - Shuts down the RTEMS environment. -interface-definition: +definition: default: params: - - ${/if/c/uint32_t:/interface-name} ${.:/interface-params[0]/name} - return: ${/if/rtems/basedefs/no-return:/interface-name} void + - ${/if/c/uint32_t:/name} ${.:/params[0]/name} + return: ${/if/rtems/basedefs/no-return:/name} void variants: [] -interface-description: | +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: [] +enabled-by: true interface-type: function links: - role: interface-placement uid: header - role: interface-ingroup uid: /groups/api/classic/init +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 |