summaryrefslogtreecommitdiffstats
path: root/spec/rtems/cache/if/get-maximal-line-size.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-09-08 14:35:10 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-09-14 14:32:42 +0200
commit4644a832cacce5a2ea665d091c26af5df61965be (patch)
tree18d3a42b8e3c596ebd704638d92705a8c4e8b818 /spec/rtems/cache/if/get-maximal-line-size.yml
parentspec: Fix variable substitution (diff)
downloadrtems-central-4644a832cacce5a2ea665d091c26af5df61965be.tar.bz2
spec: Document the cache manager
Diffstat (limited to 'spec/rtems/cache/if/get-maximal-line-size.yml')
-rw-r--r--spec/rtems/cache/if/get-maximal-line-size.yml17
1 files changed, 12 insertions, 5 deletions
diff --git a/spec/rtems/cache/if/get-maximal-line-size.yml b/spec/rtems/cache/if/get-maximal-line-size.yml
index e231695c..3a616746 100644
--- a/spec/rtems/cache/if/get-maximal-line-size.yml
+++ b/spec/rtems/cache/if/get-maximal-line-size.yml
@@ -1,8 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+ Gets the maximal cache line size in bytes of all caches (data, instruction,
+ or unified).
copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2016 Pavel Pisa
definition:
default:
attributes: null
@@ -27,6 +29,11 @@ name: rtems_cache_get_maximal_line_size
notes: null
params: []
return:
- return: null
- return-values: []
+ return: |
+ Returns the maximal cache line size in bytes of all caches (data,
+ instruction, or unified).
+ return-values:
+ - description: |
+ There is no cache present.
+ value: 0
type: interface