summaryrefslogtreecommitdiffstats
path: root/spec/rtems/basedefs/if/align-up.yml
blob: 597667aab326fb3424db1defc20e5cce78040b33 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Returns the specified value aligned up to the specified alignment.
copyrights:
- Copyright (C) 2016 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default: |
    ( ( ( ${.:/params[0]/name} ) + ( ${.:/params[1]/name} ) - 1 ) & ~( ( ${.:/params[1]/name} ) - 1 ) )
  variants: []
description: null
enabled-by: true
index-entries: []
interface-type: macro
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
name: RTEMS_ALIGN_UP
notes: null
params:
- description: |
    is the value to align up.
  dir: null
  name: _value
- description: |
    is the desired alignment in bytes.  The alignment shall be a power of two,
    otherwise the returned value is undefined.  The alignment parameter is
    evaluated twice.
  dir: null
  name: _alignment
return:
  return: |
    The specified value aligned up to the specified alignment is returned.
  return-values: []
type: interface