diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-09-08 14:35:10 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-09-14 14:32:42 +0200 |
| commit | 4644a832cacce5a2ea665d091c26af5df61965be (patch) | |
| tree | 18d3a42b8e3c596ebd704638d92705a8c4e8b818 /spec/rtems/cache/if/aligned-malloc.yml | |
| parent | spec: Fix variable substitution (diff) | |
| download | rtems-central-4644a832cacce5a2ea665d091c26af5df61965be.tar.bz2 | |
spec: Document the cache manager
Diffstat (limited to 'spec/rtems/cache/if/aligned-malloc.yml')
| -rw-r--r-- | spec/rtems/cache/if/aligned-malloc.yml | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/spec/rtems/cache/if/aligned-malloc.yml b/spec/rtems/cache/if/aligned-malloc.yml index 0f9b373b..e1c68d6e 100644 --- a/spec/rtems/cache/if/aligned-malloc.yml +++ b/spec/rtems/cache/if/aligned-malloc.yml @@ -1,8 +1,9 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Allocates memory from the C Program Heap which begins at a cache line + boundary. 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) definition: default: attributes: null @@ -29,10 +30,16 @@ links: name: rtems_cache_aligned_malloc notes: null params: -- description: '%' +- description: | + is the size in bytes of the memory area to allocate. dir: null - name: nbytes + name: size return: - return: null - return-values: [] + return: | + Returns the begin address of the allocated memory. The begin address is on + a cache line boundary. + return-values: + - description: | + There is not enough memory available to satisfy the allocation request. + value: ${/c/if/null:/name} type: interface |