blob: dc36180a0cd15ab0859d17fd01f27f6dd6e81dc5 (
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
47
48
49
50
51
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Allocates a memory area from the RTEMS Workspace.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
default:
attributes: null
body: null
params:
- ${/c/if/size_t:/name} ${.:/params[0]/name}
- void **${.:/params[1]/name}
return: ${/c/if/bool:/name}
variants: []
description: null
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
- role: constraint
uid: /constraint/directive-ctx-devinit
- role: constraint
uid: /constraint/directive-ctx-task
- role: constraint
uid: /constraint/object-allocator
name: rtems_workspace_allocate
notes: |
This directive is intended to be used by tests of the RTEMS test suites.
params:
- description: |
is the number of bytes to allocated.
dir: null
name: bytes
- description: |
is the pointer to a ``void`` pointer object. When the directive call is
successful, the begin address of the allocated memory area will be stored
in this object.
dir: out
name: pointer
return:
return: |
Returns true, if the allocation was successful, otherwise false.
return-values: []
type: interface
|
