xref: /aosp_15_r20/external/mesa3d/src/imagination/include/pvr_types.h (revision 6104692788411f58d303aa86923a9ff6ecaded22)
1 /*
2  * Copyright © 2022 Imagination Technologies Ltd.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23 
24 #ifndef PVR_TYPES_H
25 #define PVR_TYPES_H
26 
27 #include <inttypes.h>
28 #include <stdint.h>
29 
30 /**
31  * \brief Convert dwords to bytes.
32  *
33  * Throughout the code base we keep sizes in dwords (e.g. code_size and
34  * data_size returned by the pds api) and in some cases we need to convert those
35  * to be in bytes.
36  *
37  * This macro makes the conversion more obvious.
38  */
39 /* clang-format off */
40 #define PVR_DW_TO_BYTES(_value) ((_value) * 4)
41 /* clang-format on */
42 
43 /*****************************************************************************
44    Device virtual addresses
45 *****************************************************************************/
46 
47 typedef struct pvr_dev_addr {
48    uint64_t addr;
49 } pvr_dev_addr_t;
50 
51 #define PVR_DEV_ADDR(addr_) ((pvr_dev_addr_t){ .addr = (addr_) })
52 #define PVR_DEV_ADDR_OFFSET(base, offset) PVR_DEV_ADDR((base).addr + (offset))
53 #define PVR_DEV_ADDR_INVALID PVR_DEV_ADDR(0)
54 
55 /* All currently supported devices use a 40-bit virtual address space. */
56 #define PVR_DEV_ADDR_FMT "0x%010" PRIx64
57 
58 #endif /* PVR_TYPES_H */
59