summaryrefslogtreecommitdiffstats
path: root/spec/rtems/cache/if/invalidate-multiple-data-lines.yml
blob: a6b77e02688aec077dc0075848066b51bf24fca0 (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
42
43
44
45
46
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Invalidates the data cache lines covering the memory area.
copyrights:
- Copyright (C) 2014, 2021 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default:
    attributes: null
    body: null
    params:
    - const void *${.:/params[0]/name}
    - ${/c/if/size_t:/name} ${.:/params[1]/name}
    return: void
  variants: []
description: |
  The cache lines covering the area are marked as invalid.  A later read
  access in the area will load the data from memory.
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_cache_invalidate_multiple_data_lines
notes: |
  In case the area is not aligned on cache line boundaries, then this
  operation may destroy unrelated data.

  On some systems, the cache lines may be flushed before they are invalidated.
params:
- description: |
    is the begin address of the memory area to invalidate.
  dir: null
  name: begin
- description: |
    is the size in bytes of the memory area to invalidate.
  dir: null
  name: size
return: null
type: interface