summaryrefslogtreecommitdiffstats
path: root/spec/rtems/config/if/get-target-hash.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/config/if/get-target-hash.yml')
-rw-r--r--spec/rtems/config/if/get-target-hash.yml41
1 files changed, 41 insertions, 0 deletions
diff --git a/spec/rtems/config/if/get-target-hash.yml b/spec/rtems/config/if/get-target-hash.yml
new file mode 100644
index 00000000..d987a077
--- /dev/null
+++ b/spec/rtems/config/if/get-target-hash.yml
@@ -0,0 +1,41 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Gets the RTEMS target hash.
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default:
+ attributes: null
+ body: null
+ params: []
+ return: const char *
+ variants: []
+description: |
+ The target hash is calculated from BSP-specific values which characterize a
+ target system.
+enabled-by: true
+index-entries: []
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
+name: rtems_get_target_hash
+notes: |
+ For example, the device tree, settings of the memory controller, processor
+ and bus frequencies, a serial number of a chip may be used to calculate the
+ target hash.
+
+ The target hash can be used to distinguish test suite results obtained from
+ different target systems.
+params: []
+return:
+ return: |
+ Returns the pointer to the RTEMS target hash.
+ return-values: []
+type: interface