xref: /optee_os/core/include/io.h (revision 81801f833a1f3af4cf098de75211eea5df924c51)
11bb92983SJerome Forissier /* SPDX-License-Identifier: BSD-2-Clause */
2b0104773SPascal Brand /*
3b0104773SPascal Brand  * Copyright (c) 2014, Linaro Limited
4b0104773SPascal Brand  */
5b0104773SPascal Brand #ifndef IO_H
6b0104773SPascal Brand #define IO_H
7b0104773SPascal Brand 
8*81801f83SVolodymyr Babchuk #include <compiler.h>
91f70169dSJoakim Bech #include <stdint.h>
10ec219598SPascal Brand #include <types_ext.h>
11685204ebSJens Wiklander #include <utee_defines.h>
121f70169dSJoakim Bech 
13*81801f83SVolodymyr Babchuk /*
14*81801f83SVolodymyr Babchuk  * Make sure that compiler reads given variable only once. This is needed
15*81801f83SVolodymyr Babchuk  * in cases when we have normal shared memory, and this memory can be changed
16*81801f83SVolodymyr Babchuk  * at any moment. Compiler does not knows about this, so it can optimize memory
17*81801f83SVolodymyr Babchuk  * access in any way, including repeated read from the same address. This macro
18*81801f83SVolodymyr Babchuk  * enforces compiler to access memory only once.
19*81801f83SVolodymyr Babchuk  */
20*81801f83SVolodymyr Babchuk #define READ_ONCE(p) __compiler_atomic_load(&(p))
21*81801f83SVolodymyr Babchuk 
22b0104773SPascal Brand static inline void write8(uint8_t val, vaddr_t addr)
23b0104773SPascal Brand {
24b0104773SPascal Brand 	*(volatile uint8_t *)addr = val;
25b0104773SPascal Brand }
26b0104773SPascal Brand 
27b0104773SPascal Brand static inline void write16(uint16_t val, vaddr_t addr)
28b0104773SPascal Brand {
29b0104773SPascal Brand 	*(volatile uint16_t *)addr = val;
30b0104773SPascal Brand }
31b0104773SPascal Brand 
32b0104773SPascal Brand static inline void write32(uint32_t val, vaddr_t addr)
33b0104773SPascal Brand {
34b0104773SPascal Brand 	*(volatile uint32_t *)addr = val;
35b0104773SPascal Brand }
36b0104773SPascal Brand 
37b0104773SPascal Brand static inline uint8_t read8(vaddr_t addr)
38b0104773SPascal Brand {
39b0104773SPascal Brand 	return *(volatile uint8_t *)addr;
40b0104773SPascal Brand }
41b0104773SPascal Brand 
42b0104773SPascal Brand static inline uint16_t read16(vaddr_t addr)
43b0104773SPascal Brand {
44b0104773SPascal Brand 	return *(volatile uint16_t *)addr;
45b0104773SPascal Brand }
46b0104773SPascal Brand 
47b0104773SPascal Brand static inline uint32_t read32(vaddr_t addr)
48b0104773SPascal Brand {
49b0104773SPascal Brand 	return *(volatile uint32_t *)addr;
50b0104773SPascal Brand }
51b0104773SPascal Brand 
5214ed3274SVictor Chong static inline void io_mask8(vaddr_t addr, uint8_t val, uint8_t mask)
5314ed3274SVictor Chong {
5414ed3274SVictor Chong 	write8((read8(addr) & ~mask) | (val & mask), addr);
5514ed3274SVictor Chong }
5614ed3274SVictor Chong 
5714ed3274SVictor Chong static inline void io_mask16(vaddr_t addr, uint16_t val, uint16_t mask)
5814ed3274SVictor Chong {
5914ed3274SVictor Chong 	write16((read16(addr) & ~mask) | (val & mask), addr);
6014ed3274SVictor Chong }
6114ed3274SVictor Chong 
6214ed3274SVictor Chong static inline void io_mask32(vaddr_t addr, uint32_t val, uint32_t mask)
6314ed3274SVictor Chong {
6414ed3274SVictor Chong 	write32((read32(addr) & ~mask) | (val & mask), addr);
6514ed3274SVictor Chong }
6614ed3274SVictor Chong 
67685204ebSJens Wiklander static inline uint64_t get_be64(const void *p)
68685204ebSJens Wiklander {
69685204ebSJens Wiklander 	return TEE_U64_FROM_BIG_ENDIAN(*(const uint64_t *)p);
70685204ebSJens Wiklander }
71685204ebSJens Wiklander 
72685204ebSJens Wiklander static inline void put_be64(void *p, uint64_t val)
73685204ebSJens Wiklander {
74685204ebSJens Wiklander 	*(uint64_t *)p = TEE_U64_TO_BIG_ENDIAN(val);
75685204ebSJens Wiklander }
76685204ebSJens Wiklander 
77685204ebSJens Wiklander static inline uint32_t get_be32(const void *p)
78685204ebSJens Wiklander {
79685204ebSJens Wiklander 	return TEE_U32_FROM_BIG_ENDIAN(*(const uint32_t *)p);
80685204ebSJens Wiklander }
81685204ebSJens Wiklander 
82685204ebSJens Wiklander static inline void put_be32(void *p, uint32_t val)
83685204ebSJens Wiklander {
84685204ebSJens Wiklander 	*(uint32_t *)p = TEE_U32_TO_BIG_ENDIAN(val);
85685204ebSJens Wiklander }
86685204ebSJens Wiklander 
87685204ebSJens Wiklander static inline uint16_t get_be16(const void *p)
88685204ebSJens Wiklander {
89685204ebSJens Wiklander 	return TEE_U16_FROM_BIG_ENDIAN(*(const uint16_t *)p);
90685204ebSJens Wiklander }
91685204ebSJens Wiklander 
92685204ebSJens Wiklander static inline void put_be16(void *p, uint16_t val)
93685204ebSJens Wiklander {
94685204ebSJens Wiklander 	*(uint16_t *)p = TEE_U16_TO_BIG_ENDIAN(val);
95685204ebSJens Wiklander }
96685204ebSJens Wiklander 
97b0104773SPascal Brand #endif /*IO_H*/
98