1/*
2 * Copyright (c) 2017-2018 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Andrew Bardsley
38 */
39
40#ifndef __CPU_UTILS_HH__
41#define __CPU_UTILS_HH__
42
43#include "base/types.hh"
44
45/**
46 * Calculates the offset of a given address wrt aligned fixed-size blocks.
47 * @param addr Input address.
48 * @param block_size Block size in bytes.
49 * @return Offset of the given address in bytes.
50 */
51inline Addr
52addrBlockOffset(Addr addr, Addr block_size)
53{
54    return addr & (block_size - 1);
55}
56
57/**
58 * Returns the address of the closest aligned fixed-size block to the given
59 * address.
60 * @param addr Input address.
61 * @param block_size Block size in bytes.
62 * @return Address of the closest aligned block.
63 */
64inline Addr
65addrBlockAlign(Addr addr, Addr block_size)
66{
67    return addr & ~(block_size - 1);
68}
69
70/**
71 * Returns true if the given memory access (address, size) needs to be
72 * fragmented across aligned fixed-size blocks.
73 * @param addr Address of the memory access.
74 * @param size Size of the memory access.
75 * @param block_size Block size in bytes.
76 * @return True if the memory access needs to be fragmented.
77 */
78inline bool
79transferNeedsBurst(Addr addr, unsigned int size, unsigned int block_size)
80{
81    return (addrBlockOffset(addr, block_size) + size) > block_size;
82}
83
84/**
85 * Test if there is any active element in an enablement range.
86 */
87inline bool
88isAnyActiveElement(const std::vector<bool>::const_iterator& it_start,
89                   const std::vector<bool>::const_iterator& it_end)
90{
91    auto it_tmp = it_start;
92    for (;it_tmp != it_end && !(*it_tmp); ++it_tmp);
93    return (it_tmp != it_end);
94}
95
96#endif // __CPU_UTILS_HH__
97