/* spi_dw.h - Designware SPI driver private definitions */ /* * Copyright (c) 2015 Intel Corporation. * * SPDX-License-Identifier: Apache-2.0 */ #ifndef ZEPHYR_DRIVERS_SPI_SPI_DW_H_ #define ZEPHYR_DRIVERS_SPI_SPI_DW_H_ #include #include #include "spi_context.h" #ifdef __cplusplus extern "C" { #endif typedef void (*spi_dw_config_t)(void); /* Private structures */ struct spi_dw_config { uint32_t regs; uint32_t clock_frequency; #ifdef CONFIG_CLOCK_CONTROL const char *clock_name; void *clock_data; #endif /* CONFIG_CLOCK_CONTROL */ spi_dw_config_t config_func; uint8_t op_modes; }; struct spi_dw_data { #ifdef CONFIG_CLOCK_CONTROL const struct device *clock; #endif /* CONFIG_CLOCK_CONTROL */ struct spi_context ctx; uint8_t dfs; /* dfs in bytes: 1,2 or 4 */ uint8_t fifo_diff; /* cannot be bigger than FIFO depth */ uint16_t _unused; }; /* Helper macros */ #define SPI_DW_CLK_DIVIDER(clock_freq, ssi_clk_hz) \ ((clock_freq / ssi_clk_hz) & 0xFFFF) #ifdef CONFIG_SPI_DW_ARC_AUX_REGS #define Z_REG_READ(__sz) sys_in##__sz #define Z_REG_WRITE(__sz) sys_out##__sz #define Z_REG_SET_BIT sys_io_set_bit #define Z_REG_CLEAR_BIT sys_io_clear_bit #define Z_REG_TEST_BIT sys_io_test_bit #else #define Z_REG_READ(__sz) sys_read##__sz #define Z_REG_WRITE(__sz) sys_write##__sz #define Z_REG_SET_BIT sys_set_bit #define Z_REG_CLEAR_BIT sys_clear_bit #define Z_REG_TEST_BIT sys_test_bit #endif /* CONFIG_SPI_DW_ARC_AUX_REGS */ #define DEFINE_MM_REG_READ(__reg, __off, __sz) \ static inline uint32_t read_##__reg(uint32_t addr) \ { \ return Z_REG_READ(__sz)(addr + __off); \ } #define DEFINE_MM_REG_WRITE(__reg, __off, __sz) \ static inline void write_##__reg(uint32_t data, uint32_t addr) \ { \ Z_REG_WRITE(__sz)(data, addr + __off); \ } #define DEFINE_SET_BIT_OP(__reg_bit, __reg_off, __bit) \ static inline void set_bit_##__reg_bit(uint32_t addr) \ { \ Z_REG_SET_BIT(addr + __reg_off, __bit); \ } #define DEFINE_CLEAR_BIT_OP(__reg_bit, __reg_off, __bit) \ static inline void clear_bit_##__reg_bit(uint32_t addr) \ { \ Z_REG_CLEAR_BIT(addr + __reg_off, __bit); \ } #define DEFINE_TEST_BIT_OP(__reg_bit, __reg_off, __bit) \ static inline int test_bit_##__reg_bit(uint32_t addr) \ { \ return Z_REG_TEST_BIT(addr + __reg_off, __bit); \ } /* Common registers settings, bits etc... */ /* CTRLR0 settings */ #define DW_SPI_CTRLR0_SCPH_BIT (6) #define DW_SPI_CTRLR0_SCPOL_BIT (7) #define DW_SPI_CTRLR0_SRL_BIT (11) #define DW_SPI_CTRLR0_SCPH BIT(DW_SPI_CTRLR0_SCPH_BIT) #define DW_SPI_CTRLR0_SCPOL BIT(DW_SPI_CTRLR0_SCPOL_BIT) #define DW_SPI_CTRLR0_SRL BIT(DW_SPI_CTRLR0_SRL_BIT) #define DW_SPI_CTRLR0_SLV_OE_BIT (10) #define DW_SPI_CTRLR0_SLV_OE BIT(DW_SPI_CTRLR0_SLV_OE_BIT) #ifdef CONFIG_SOC_INTEL_S1000 #define DW_SPI_CTRLR0_TMOD_SHIFT (10) #else #define DW_SPI_CTRLR0_TMOD_SHIFT (8) #endif #define DW_SPI_CTRLR0_TMOD_TX_RX (0) #define DW_SPI_CTRLR0_TMOD_TX (1 << DW_SPI_CTRLR0_TMOD_SHIFT) #define DW_SPI_CTRLR0_TMOD_RX (2 << DW_SPI_CTRLR0_TMOD_SHIFT) #define DW_SPI_CTRLR0_TMOD_EEPROM (3 << DW_SPI_CTRLR0_TMOD_SHIFT) #define DW_SPI_CTRLR0_TMOD_RESET (3 << DW_SPI_CTRLR0_TMOD_SHIFT) #define DW_SPI_CTRLR0_DFS_16(__bpw) ((__bpw) - 1) #define DW_SPI_CTRLR0_DFS_32(__bpw) (((__bpw) - 1) << 16) #if defined(CONFIG_ARC) || defined(CONFIG_SOC_INTEL_S1000) #define DW_SPI_CTRLR0_DFS DW_SPI_CTRLR0_DFS_16 #else #define DW_SPI_CTRLR0_DFS DW_SPI_CTRLR0_DFS_32 #endif /* 0x38 represents the bits 8, 16 and 32. Knowing that 24 is bits 8 and 16 * These are the bits were when you divide by 8, you keep the result as it is. * For all the other ones, 4 to 7, 9 to 15, etc... you need a +1, * since on such division it takes only the result above 0 */ #define SPI_WS_TO_DFS(__bpw) (((__bpw) & ~0x38) ? \ (((__bpw) / 8) + 1) : \ ((__bpw) / 8)) /* SSIENR bits */ #define DW_SPI_SSIENR_SSIEN_BIT (0) /* SR bits and values */ #define DW_SPI_SR_BUSY_BIT (0) #define DW_SPI_SR_TFNF_BIT (1) #define DW_SPI_SR_RFNE_BIT (3) /* IMR bits (ISR valid as well) */ #define DW_SPI_IMR_TXEIM_BIT (0) #define DW_SPI_IMR_TXOIM_BIT (1) #define DW_SPI_IMR_RXUIM_BIT (2) #define DW_SPI_IMR_RXOIM_BIT (3) #define DW_SPI_IMR_RXFIM_BIT (4) #define DW_SPI_IMR_MSTIM_BIT (5) /* IMR values */ #define DW_SPI_IMR_TXEIM BIT(DW_SPI_IMR_TXEIM_BIT) #define DW_SPI_IMR_TXOIM BIT(DW_SPI_IMR_TXOIM_BIT) #define DW_SPI_IMR_RXUIM BIT(DW_SPI_IMR_RXUIM_BIT) #define DW_SPI_IMR_RXOIM BIT(DW_SPI_IMR_RXOIM_BIT) #define DW_SPI_IMR_RXFIM BIT(DW_SPI_IMR_RXFIM_BIT) #define DW_SPI_IMR_MSTIM BIT(DW_SPI_IMR_MSTIM_BIT) /* ISR values (same as IMR) */ #define DW_SPI_ISR_TXEIS DW_SPI_IMR_TXEIM #define DW_SPI_ISR_TXOIS DW_SPI_IMR_TXOIM #define DW_SPI_ISR_RXUIS DW_SPI_IMR_RXUIM #define DW_SPI_ISR_RXOIS DW_SPI_IMR_RXOIM #define DW_SPI_ISR_RXFIS DW_SPI_IMR_RXFIM #define DW_SPI_ISR_MSTIS DW_SPI_IMR_MSTIM /* Error interrupt */ #define DW_SPI_ISR_ERRORS_MASK (DW_SPI_ISR_TXOIS | \ DW_SPI_ISR_RXUIS | \ DW_SPI_ISR_RXOIS | \ DW_SPI_ISR_MSTIS) /* ICR Bit */ #define DW_SPI_SR_ICR_BIT (0) /* Threshold defaults */ #define DW_SPI_FIFO_DEPTH CONFIG_SPI_DW_FIFO_DEPTH #define DW_SPI_TXFTLR_DFLT ((DW_SPI_FIFO_DEPTH * 1) / 2) /* 50% */ #define DW_SPI_RXFTLR_DFLT ((DW_SPI_FIFO_DEPTH * 5) / 8) /* Interrupt mask (IMR) */ #define DW_SPI_IMR_MASK (0x0) #define DW_SPI_IMR_UNMASK (DW_SPI_IMR_TXEIM | \ DW_SPI_IMR_TXOIM | \ DW_SPI_IMR_RXUIM | \ DW_SPI_IMR_RXOIM | \ DW_SPI_IMR_RXFIM) #define DW_SPI_IMR_MASK_TX (~(DW_SPI_IMR_TXEIM | \ DW_SPI_IMR_TXOIM)) #define DW_SPI_IMR_MASK_RX (~(DW_SPI_IMR_RXUIM | \ DW_SPI_IMR_RXOIM | \ DW_SPI_IMR_RXFIM)) /* * Including the right register definition file * SoC SPECIFIC! * * The file included next uses the DEFINE_MM_REG macros above to * declare functions. In this situation we'll leave the containing * extern "C" active in C++ compilations. */ #include "spi_dw_regs.h" #define z_extra_clock_on(...) #define z_extra_clock_off(...) /* Based on those macros above, here are common helpers for some registers */ DEFINE_MM_REG_READ(txflr, DW_SPI_REG_TXFLR, 32) DEFINE_MM_REG_READ(rxflr, DW_SPI_REG_RXFLR, 32) #ifdef CONFIG_SPI_DW_ACCESS_WORD_ONLY DEFINE_MM_REG_WRITE(baudr, DW_SPI_REG_BAUDR, 32) DEFINE_MM_REG_WRITE(imr, DW_SPI_REG_IMR, 32) DEFINE_MM_REG_READ(imr, DW_SPI_REG_IMR, 32) DEFINE_MM_REG_READ(isr, DW_SPI_REG_ISR, 32) #else DEFINE_MM_REG_WRITE(baudr, DW_SPI_REG_BAUDR, 16) DEFINE_MM_REG_WRITE(imr, DW_SPI_REG_IMR, 8) DEFINE_MM_REG_READ(imr, DW_SPI_REG_IMR, 8) DEFINE_MM_REG_READ(isr, DW_SPI_REG_ISR, 8) #endif DEFINE_SET_BIT_OP(ssienr, DW_SPI_REG_SSIENR, DW_SPI_SSIENR_SSIEN_BIT) DEFINE_CLEAR_BIT_OP(ssienr, DW_SPI_REG_SSIENR, DW_SPI_SSIENR_SSIEN_BIT) DEFINE_TEST_BIT_OP(ssienr, DW_SPI_REG_SSIENR, DW_SPI_SSIENR_SSIEN_BIT) DEFINE_TEST_BIT_OP(sr_busy, DW_SPI_REG_SR, DW_SPI_SR_BUSY_BIT) #ifdef CONFIG_CLOCK_CONTROL static inline int clock_config(const struct device *dev) { const struct spi_dw_config *info = dev->config; struct spi_dw_data *spi = dev->data; if (!info->clock_name || strlen(info->clock_name) == 0) { spi->clock = NULL; return 0; } spi->clock = device_get_binding(info->clock_name); if (!spi->clock) { return -ENODEV; } return 0; } static inline void clock_on(const struct device *dev) { struct spi_dw_data *spi = dev->data; if (spi->clock) { const struct spi_dw_config *info = dev->config; clock_control_on(spi->clock, info->clock_data); } extra_clock_on(dev); } static inline void clock_off(const struct device *dev) { struct spi_dw_data *spi = dev->data; if (spi->clock) { const struct spi_dw_config *info = dev->config; clock_control_off(spi->clock, info->clock_data); } extra_clock_off(dev); } #else /* CONFIG_CLOCK_CONTROL */ #define clock_config(...) #define clock_on(...) #define clock_off(...) #endif /* CONFIG_CLOCK_CONTROL */ #ifdef __cplusplus } #endif #endif /* ZEPHYR_DRIVERS_SPI_SPI_DW_H_ */