diff options
Diffstat (limited to 'spec/acfg/if/appl-does-not-need-clock-driver.yml')
| -rw-r--r-- | spec/acfg/if/appl-does-not-need-clock-driver.yml | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/spec/acfg/if/appl-does-not-need-clock-driver.yml b/spec/acfg/if/appl-does-not-need-clock-driver.yml new file mode 100644 index 00000000..fcfb0a8e --- /dev/null +++ b/spec/acfg/if/appl-does-not-need-clock-driver.yml @@ -0,0 +1,33 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | + If this configuration option is undefined, then a Clock Driver may be + initialized during system initialization. +description: | + In case this configuration option is defined, then **no** Clock Driver is + initialized during system initialization. +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: group-devdrv +name: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER +notes: | + This configuration parameter is intended to prevent the common user error + of using the Hello World example as the baseline for an application and + leaving out a clock tick source. + + The application shall define exactly one of the following configuration options + + * ${appl-needs-clock-driver:/name}, + + * ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER``, or + + * ${appl-needs-timer-driver:/name}, + + otherwise a compile time error in the configuration file will occur. +text: '' +type: interface |