Zephyr Project API 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
sys_io.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2015 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12
13#ifndef ZEPHYR_INCLUDE_SYS_SYS_IO_H_
14#define ZEPHYR_INCLUDE_SYS_SYS_IO_H_
15
16#include <zephyr/toolchain.h>
17#include <zephyr/types.h>
18#include <stddef.h>
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
35
38
41
44
45#ifdef __DOXYGEN__
46
59
68static inline void sys_out8(uint8_t data, io_port_t port);
69
79static inline uint8_t sys_in8(io_port_t port);
80
89static inline void sys_out16(uint16_t data, io_port_t port);
90
100static inline uint16_t sys_in16(io_port_t port);
101
110static inline void sys_out32(uint32_t data, io_port_t port);
111
121static inline uint32_t sys_in32(io_port_t port);
122
131static inline void sys_io_set_bit(io_port_t port, unsigned int bit);
132
141static inline void sys_io_clear_bit(io_port_t port, unsigned int bit);
142
154static inline int sys_io_test_bit(io_port_t port, unsigned int bit);
155
167static inline int sys_io_test_and_set_bit(io_port_t port, unsigned int bit);
168
180static inline int sys_io_test_and_clear_bit(io_port_t port, unsigned int bit);
181
183
196
205static inline void sys_write8(uint8_t data, mm_reg_t addr);
206
216static inline uint8_t sys_read8(mm_reg_t addr);
217
226static inline void sys_write16(uint16_t data, mm_reg_t addr);
227
238static inline uint16_t sys_read16(mm_reg_t addr);
239
248static inline void sys_write32(uint32_t data, mm_reg_t addr);
249
260static inline uint32_t sys_read32(mm_reg_t addr);
261
270static inline void sys_write64(uint64_t data, mm_reg_t addr);
271
282static inline uint64_t sys_read64(mm_reg_t addr);
283
285
298
307static ALWAYS_INLINE void sys_set_bit(mem_addr_t addr, unsigned int bit);
308
317static ALWAYS_INLINE void sys_set_bits(mem_addr_t addr, unsigned int mask);
318
327static ALWAYS_INLINE void sys_clear_bits(mem_addr_t addr, unsigned int mask);
328
337static ALWAYS_INLINE void sys_clear_bit(mem_addr_t addr, unsigned int bit);
338
351static ALWAYS_INLINE int sys_test_bit(mem_addr_t addr, unsigned int bit);
352
365static ALWAYS_INLINE int sys_test_and_set_bit(mem_addr_t addr, unsigned int bit);
366
379static ALWAYS_INLINE int sys_test_and_clear_bit(mem_addr_t addr, unsigned int bit);
380
389static ALWAYS_INLINE void sys_bitfield_set_bit(mem_addr_t addr, unsigned int bit);
390
399static ALWAYS_INLINE void sys_bitfield_clear_bit(mem_addr_t addr, unsigned int bit);
400
413static ALWAYS_INLINE int sys_bitfield_test_bit(mem_addr_t addr, unsigned int bit);
414
427static ALWAYS_INLINE int sys_bitfield_test_and_set_bit(mem_addr_t addr, unsigned int bit);
428
442 /* sys_io_bits_apis */
444 /* sys_io_apis */
446
447#endif /* __DOXYGEN__ */
448
449#ifdef __cplusplus
450}
451#endif
452
453#endif /* ZEPHYR_INCLUDE_SYS_SYS_IO_H_ */
static ALWAYS_INLINE int sys_io_test_and_set_bit(io_port_t port, unsigned int bit)
Definition sys_io.h:108
static ALWAYS_INLINE int sys_io_test_bit(io_port_t port, unsigned int bit)
Definition sys_io.h:90
static ALWAYS_INLINE uint8_t sys_in8(io_port_t port)
Definition sys_io.h:32
static ALWAYS_INLINE int sys_io_test_and_clear_bit(io_port_t port, unsigned int bit)
Definition sys_io.h:119
static ALWAYS_INLINE void sys_out8(uint8_t data, io_port_t port)
Definition sys_io.h:26
static ALWAYS_INLINE void sys_io_clear_bit(io_port_t port, unsigned int bit)
Definition sys_io.h:76
static ALWAYS_INLINE void sys_out16(uint16_t data, io_port_t port)
Definition sys_io.h:38
static ALWAYS_INLINE void sys_io_set_bit(io_port_t port, unsigned int bit)
Definition sys_io.h:62
static ALWAYS_INLINE uint16_t sys_in16(io_port_t port)
Definition sys_io.h:44
static ALWAYS_INLINE void sys_out32(uint32_t data, io_port_t port)
Definition sys_io.h:50
static ALWAYS_INLINE uint32_t sys_in32(io_port_t port)
Definition sys_io.h:56
static ALWAYS_INLINE void sys_write64(uint64_t data, mem_addr_t addr)
Definition sys_io.h:95
static ALWAYS_INLINE void sys_write32(uint32_t data, mem_addr_t addr)
Definition sys_io.h:69
static ALWAYS_INLINE uint8_t sys_read8(mem_addr_t addr)
Definition sys_io.h:27
static ALWAYS_INLINE void sys_write16(uint16_t data, mem_addr_t addr)
Definition sys_io.h:53
static ALWAYS_INLINE uint32_t sys_read32(mem_addr_t addr)
Definition sys_io.h:59
static ALWAYS_INLINE uint16_t sys_read16(mem_addr_t addr)
Definition sys_io.h:43
static ALWAYS_INLINE void sys_write8(uint8_t data, mem_addr_t addr)
Definition sys_io.h:37
static ALWAYS_INLINE uint64_t sys_read64(mem_addr_t addr)
Definition sys_io.h:75
uint32_t io_port_t
I/O port address.
Definition sys_io.h:37
uintptr_t mm_reg_t
Memory-mapped register address.
Definition sys_io.h:40
uintptr_t mem_addr_t
Memory address.
Definition sys_io.h:43
static ALWAYS_INLINE int sys_test_and_set_bit(mem_addr_t addr, unsigned int bit)
Test the bit and set it.
static ALWAYS_INLINE void sys_set_bit(mem_addr_t addr, unsigned int bit)
Set the designated bit from addr to 1.
static ALWAYS_INLINE void sys_clear_bit(mem_addr_t addr, unsigned int bit)
Clear the designated bit from addr to 0.
static ALWAYS_INLINE int sys_test_bit(mem_addr_t addr, unsigned int bit)
Test the bit if it is set or not.
static ALWAYS_INLINE void sys_clear_bits(mem_addr_t addr, unsigned int mask)
Masking the designated bits from addr to 0.
static ALWAYS_INLINE int sys_test_and_clear_bit(mem_addr_t addr, unsigned int bit)
Test the bit and clear it.
static ALWAYS_INLINE void sys_set_bits(mem_addr_t addr, unsigned int mask)
Masking the designated bits from addr to 1.
#define ALWAYS_INLINE
Definition common.h:180
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINTPTR_TYPE__ uintptr_t
Definition stdint.h:105
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Macros to abstract toolchain specific capabilities.
#define sys_bitfield_set_bit
Definition arch.h:218
#define sys_bitfield_test_bit
Definition arch.h:220
#define sys_bitfield_clear_bit
Definition arch.h:219
#define sys_bitfield_test_and_set_bit
Definition arch.h:221
#define sys_bitfield_test_and_clear_bit
Definition arch.h:222