blob: 95b7d4ab950b76f3757cf28b4d5d8c79f47f73ed [file] [log] [blame]
/* Port and memory mapped registers I/O operations */
/*
* Copyright (c) 2015 Intel Corporation.
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef ZEPHYR_INCLUDE_SYS_SYS_IO_H_
#define ZEPHYR_INCLUDE_SYS_SYS_IO_H_
#include <zephyr/types.h>
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef uint32_t io_port_t;
typedef uintptr_t mm_reg_t;
typedef uintptr_t mem_addr_t;
/* Port I/O functions */
/**
* @fn static inline void sys_out8(uint8_t data, io_port_t port);
* @brief Output a byte to an I/O port
*
* This function writes a byte to the given port.
*
* @param data the byte to write
* @param port the port address where to write the byte
*/
/**
* @fn static inline uint8_t sys_in8(io_port_t port);
* @brief Input a byte from an I/O port
*
* This function reads a byte from the port.
*
* @param port the port address from where to read the byte
*
* @return the byte read
*/
/**
* @fn static inline void sys_out16(uint16_t data, io_port_t port);
* @brief Output a 16 bits to an I/O port
*
* This function writes a 16 bits to the given port.
*
* @param data the 16 bits to write
* @param port the port address where to write the 16 bits
*/
/**
* @fn static inline uint16_t sys_in16(io_port_t port);
* @brief Input 16 bits from an I/O port
*
* This function reads 16 bits from the port.
*
* @param port the port address from where to read the 16 bits
*
* @return the 16 bits read
*/
/**
* @fn static inline void sys_out32(uint32_t data, io_port_t port);
* @brief Output 32 bits to an I/O port
*
* This function writes 32 bits to the given port.
*
* @param data the 32 bits to write
* @param port the port address where to write the 32 bits
*/
/**
* @fn static inline uint32_t sys_in32(io_port_t port);
* @brief Input 32 bits from an I/O port
*
* This function reads 32 bits from the port.
*
* @param port the port address from where to read the 32 bits
*
* @return the 32 bits read
*/
/**
* @fn static inline void sys_io_set_bit(io_port_t port, unsigned int bit)
* @brief Set the designated bit from port to 1
*
* This functions takes the designated bit starting from port and sets it to 1.
*
* @param port the port address from where to look for the bit
* @param bit the designated bit to set (from 0 to n)
*/
/**
* @fn static inline void sys_io_clear_bit(io_port_t port, unsigned int bit)
* @brief Clear the designated bit from port to 0
*
* This functions takes the designated bit starting from port and sets it to 0.
*
* @param port the port address from where to look for the bit
* @param bit the designated bit to clear (from 0 to n)
*/
/**
* @fn static inline int sys_io_test_bit(io_port_t port, unsigned int bit)
* @brief Test the bit from port if it is set or not
*
* This functions takes the designated bit starting from port and tests its
* current setting. It will return the current setting.
*
* @param port the port address from where to look for the bit
* @param bit the designated bit to test (from 0 to n)
*
* @return 1 if it is set, 0 otherwise
*/
/**
* @fn static inline int sys_io_test_and_set_bit(io_port_t port, unsigned int bit)
* @brief Test the bit from port and set it
*
* This functions takes the designated bit starting from port, tests its
* current setting and sets it. It will return the previous setting.
*
* @param port the port address from where to look for the bit
* @param bit the designated bit to test and set (from 0 to n)
*
* @return 1 if it was set, 0 otherwise
*/
/**
* @fn static inline int sys_io_test_and_clear_bit(io_port_t port, unsigned int bit)
* @brief Test the bit from port and clear it
*
* This functions takes the designated bit starting from port, tests its
* current setting and clears it. It will return the previous setting.
*
* @param port the port address from where to look for the bit
* @param bit the designated bit to test and clear (from 0 to n)
*
* @return 0 if it was clear, 1 otherwise
*/
/* Memory mapped registers I/O functions */
/**
* @fn static inline void sys_write8(uint8_t data, mm_reg_t addr);
* @brief Write a byte to a memory mapped register
*
* This function writes a byte to the given memory mapped register.
*
* @param data the byte to write
* @param addr the memory mapped register address where to write the byte
*/
/**
* @fn static inline uint8_t sys_read8(mm_reg_t addr);
* @brief Read a byte from a memory mapped register
*
* This function reads a byte from the given memory mapped register.
*
* @param addr the memory mapped register address from where to read the byte
*
* @return the byte read
*/
/**
* @fn static inline void sys_write16(uint16_t data, mm_reg_t addr);
* @brief Write 16 bits to a memory mapped register
*
* This function writes 16 bits to the given memory mapped register.
*
* @param data the 16 bits to write
* @param addr the memory mapped register address where to write the 16 bits
*/
/**
* @fn static inline uint16_t sys_read16(mm_reg_t addr);
* @brief Read 16 bits from a memory mapped register
*
* This function reads 16 bits from the given memory mapped register.
*
* @param addr the memory mapped register address from where to read
* the 16 bits
*
* @return the 16 bits read
*/
/**
* @fn static inline void sys_write32(uint32_t data, mm_reg_t addr);
* @brief Write 32 bits to a memory mapped register
*
* This function writes 32 bits to the given memory mapped register.
*
* @param data the 32 bits to write
* @param addr the memory mapped register address where to write the 32 bits
*/
/**
* @fn static inline uint32_t sys_read32(mm_reg_t addr);
* @brief Read 32 bits from a memory mapped register
*
* This function reads 32 bits from the given memory mapped register.
*
* @param addr the memory mapped register address from where to read
* the 32 bits
*
* @return the 32 bits read
*/
/**
* @fn static inline void sys_write64(uint64_t data, mm_reg_t addr);
* @brief Write 64 bits to a memory mapped register
*
* This function writes 64 bits to the given memory mapped register.
*
* @param data the 64 bits to write
* @param addr the memory mapped register address where to write the 64 bits
*/
/**
* @fn static inline uint64_t sys_read64(mm_reg_t addr);
* @brief Read 64 bits from a memory mapped register
*
* This function reads 64 bits from the given memory mapped register.
*
* @param addr the memory mapped register address from where to read
* the 64 bits
*
* @return the 64 bits read
*/
/* Memory bits manipulation functions */
/**
* @fn static inline void sys_set_bit(mem_addr_t addr, unsigned int bit)
* @brief Set the designated bit from addr to 1
*
* This functions takes the designated bit starting from addr and sets it to 1.
*
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to set (from 0 to 31)
*/
/**
* @fn static inline void sys_clear_bit(mem_addr_t addr, unsigned int bit)
* @brief Clear the designated bit from addr to 0
*
* This functions takes the designated bit starting from addr and sets it to 0.
*
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to clear (from 0 to 31)
*/
/**
* @fn static inline int sys_test_bit(mem_addr_t addr, unsigned int bit)
* @brief Test the bit if it is set or not
*
* This functions takes the designated bit starting from addr and tests its
* current setting. It will return the current setting.
*
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to test (from 0 to 31)
*
* @return 1 if it is set, 0 otherwise
*/
/**
* @fn static inline int sys_test_and_set_bit(mem_addr_t addr, unsigned int bit)
* @brief Test the bit and set it
*
* This functions takes the designated bit starting from addr, tests its
* current setting and sets it. It will return the previous setting.
*
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to test and set (from 0 to 31)
*
* @return 1 if it was set, 0 otherwise
*/
/**
* @fn static inline int sys_test_and_clear_bit(mem_addr_t addr, unsigned int bit)
* @brief Test the bit and clear it
*
* This functions takes the designated bit starting from addr, test its
* current setting and clears it. It will return the previous setting.
*
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to test and clear (from 0 to 31)
*
* @return 0 if it was clear, 1 otherwise
*/
/**
* @fn static inline void sys_bitfield_set_bit(mem_addr_t addr, unsigned int bit)
* @brief Set the designated bit from addr to 1
*
* This functions takes the designated bit starting from addr and sets it to 1.
*
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to set (arbitrary)
*/
/**
* @fn static inline void sys_bitfield_clear_bit(mem_addr_t addr, unsigned int bit)
* @brief Clear the designated bit from addr to 0
*
* This functions takes the designated bit starting from addr and sets it to 0.
*
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to clear (arbitrary)
*/
/**
* @fn static inline int sys_bitfield_test_bit(mem_addr_t addr, unsigned int bit)
* @brief Test the bit if it is set or not
*
* This functions takes the designated bit starting from addr and tests its
* current setting. It will return the current setting.
*
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to test (arbitrary
*
* @return 1 if it is set, 0 otherwise
*/
/**
* @fn static inline int sys_bitfield_test_and_set_bit(mem_addr_t addr, unsigned int bit)
* @brief Test the bit and set it
*
* This functions takes the designated bit starting from addr, tests its
* current setting and sets it. It will return the previous setting.
*
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to test and set (arbitrary)
*
* @return 1 if it was set, 0 otherwise
*/
/**
* @fn static inline int sys_bitfield_test_and_clear_bit(mem_addr_t addr, unsigned int bit)
* @brief Test the bit and clear it
*
* This functions takes the designated bit starting from addr, test its
* current setting and clears it. It will return the previous setting.
*
* @param addr the memory address from where to look for the bit
* @param bit the designated bit to test and clear (arbitrary)
*
* @return 0 if it was clear, 1 otherwise
*/
#ifdef __cplusplus
}
#endif
#endif /* ZEPHYR_INCLUDE_SYS_SYS_IO_H_ */