summaryrefslogtreecommitdiffstats
path: root/spec/rtems/config/if/get-target-hash.yml
blob: d987a077d2043eed0d7cf491446f83bcab32673f (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
33
34
35
36
37
38
39
40
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