1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * i2c Support for Atmel's AT91 Two-Wire Interface (TWI) 4 * 5 * Copyright (C) 2011 Weinmann Medical GmbH 6 * Author: Nikolaus Voss <n.voss@weinmann.de> 7 * 8 * Evolved from original work by: 9 * Copyright (C) 2004 Rick Bronson 10 * Converted to 2.6 by Andrew Victor <andrew@sanpeople.com> 11 * 12 * Borrowed heavily from original work by: 13 * Copyright (C) 2000 Philip Edelbrock <phil@stimpy.netroedge.com> 14 */ 15 16 #include <linux/clk.h> 17 #include <linux/completion.h> 18 #include <linux/dma-mapping.h> 19 #include <linux/dmaengine.h> 20 #include <linux/i2c.h> 21 #include <linux/platform_data/dma-atmel.h> 22 #include <linux/platform_device.h> 23 24 #define AT91_I2C_TIMEOUT msecs_to_jiffies(100) /* transfer timeout */ 25 #define AT91_I2C_DMA_THRESHOLD 8 /* enable DMA if transfer size is bigger than this threshold */ 26 #define AUTOSUSPEND_TIMEOUT 2000 27 #define AT91_I2C_MAX_ALT_CMD_DATA_SIZE 256 28 29 /* AT91 TWI register definitions */ 30 #define AT91_TWI_CR 0x0000 /* Control Register */ 31 #define AT91_TWI_START BIT(0) /* Send a Start Condition */ 32 #define AT91_TWI_STOP BIT(1) /* Send a Stop Condition */ 33 #define AT91_TWI_MSEN BIT(2) /* Master Transfer Enable */ 34 #define AT91_TWI_MSDIS BIT(3) /* Master Transfer Disable */ 35 #define AT91_TWI_SVEN BIT(4) /* Slave Transfer Enable */ 36 #define AT91_TWI_SVDIS BIT(5) /* Slave Transfer Disable */ 37 #define AT91_TWI_QUICK BIT(6) /* SMBus quick command */ 38 #define AT91_TWI_SWRST BIT(7) /* Software Reset */ 39 #define AT91_TWI_CLEAR BIT(15) /* Bus clear command */ 40 #define AT91_TWI_ACMEN BIT(16) /* Alternative Command Mode Enable */ 41 #define AT91_TWI_ACMDIS BIT(17) /* Alternative Command Mode Disable */ 42 #define AT91_TWI_THRCLR BIT(24) /* Transmit Holding Register Clear */ 43 #define AT91_TWI_RHRCLR BIT(25) /* Receive Holding Register Clear */ 44 #define AT91_TWI_LOCKCLR BIT(26) /* Lock Clear */ 45 #define AT91_TWI_FIFOEN BIT(28) /* FIFO Enable */ 46 #define AT91_TWI_FIFODIS BIT(29) /* FIFO Disable */ 47 48 #define AT91_TWI_MMR 0x0004 /* Master Mode Register */ 49 #define AT91_TWI_IADRSZ_1 0x0100 /* Internal Device Address Size */ 50 #define AT91_TWI_MREAD BIT(12) /* Master Read Direction */ 51 52 #define AT91_TWI_SMR 0x0008 /* Slave Mode Register */ 53 #define AT91_TWI_SMR_SADR_MAX 0x007f 54 #define AT91_TWI_SMR_SADR(x) (((x) & AT91_TWI_SMR_SADR_MAX) << 16) 55 56 #define AT91_TWI_IADR 0x000c /* Internal Address Register */ 57 58 #define AT91_TWI_CWGR 0x0010 /* Clock Waveform Generator Reg */ 59 #define AT91_TWI_CWGR_HOLD_MAX 0x1f 60 #define AT91_TWI_CWGR_HOLD(x) (((x) & AT91_TWI_CWGR_HOLD_MAX) << 24) 61 62 #define AT91_TWI_SR 0x0020 /* Status Register */ 63 #define AT91_TWI_TXCOMP BIT(0) /* Transmission Complete */ 64 #define AT91_TWI_RXRDY BIT(1) /* Receive Holding Register Ready */ 65 #define AT91_TWI_TXRDY BIT(2) /* Transmit Holding Register Ready */ 66 #define AT91_TWI_SVREAD BIT(3) /* Slave Read */ 67 #define AT91_TWI_SVACC BIT(4) /* Slave Access */ 68 #define AT91_TWI_OVRE BIT(6) /* Overrun Error */ 69 #define AT91_TWI_UNRE BIT(7) /* Underrun Error */ 70 #define AT91_TWI_NACK BIT(8) /* Not Acknowledged */ 71 #define AT91_TWI_EOSACC BIT(11) /* End Of Slave Access */ 72 #define AT91_TWI_LOCK BIT(23) /* TWI Lock due to Frame Errors */ 73 #define AT91_TWI_SCL BIT(24) /* TWI SCL status */ 74 #define AT91_TWI_SDA BIT(25) /* TWI SDA status */ 75 76 #define AT91_TWI_INT_MASK \ 77 (AT91_TWI_TXCOMP | AT91_TWI_RXRDY | AT91_TWI_TXRDY | AT91_TWI_NACK \ 78 | AT91_TWI_SVACC | AT91_TWI_EOSACC) 79 80 #define AT91_TWI_IER 0x0024 /* Interrupt Enable Register */ 81 #define AT91_TWI_IDR 0x0028 /* Interrupt Disable Register */ 82 #define AT91_TWI_IMR 0x002c /* Interrupt Mask Register */ 83 #define AT91_TWI_RHR 0x0030 /* Receive Holding Register */ 84 #define AT91_TWI_THR 0x0034 /* Transmit Holding Register */ 85 86 #define AT91_TWI_ACR 0x0040 /* Alternative Command Register */ 87 #define AT91_TWI_ACR_DATAL_MASK GENMASK(15, 0) 88 #define AT91_TWI_ACR_DATAL(len) ((len) & AT91_TWI_ACR_DATAL_MASK) 89 #define AT91_TWI_ACR_DIR BIT(8) 90 91 #define AT91_TWI_FILTR 0x0044 92 #define AT91_TWI_FILTR_FILT BIT(0) 93 #define AT91_TWI_FILTR_PADFEN BIT(1) 94 #define AT91_TWI_FILTR_THRES(v) ((v) << 8) 95 #define AT91_TWI_FILTR_THRES_MAX 7 96 #define AT91_TWI_FILTR_THRES_MASK GENMASK(10, 8) 97 98 #define AT91_TWI_FMR 0x0050 /* FIFO Mode Register */ 99 #define AT91_TWI_FMR_TXRDYM(mode) (((mode) & 0x3) << 0) 100 #define AT91_TWI_FMR_TXRDYM_MASK (0x3 << 0) 101 #define AT91_TWI_FMR_RXRDYM(mode) (((mode) & 0x3) << 4) 102 #define AT91_TWI_FMR_RXRDYM_MASK (0x3 << 4) 103 #define AT91_TWI_ONE_DATA 0x0 104 #define AT91_TWI_TWO_DATA 0x1 105 #define AT91_TWI_FOUR_DATA 0x2 106 107 #define AT91_TWI_FLR 0x0054 /* FIFO Level Register */ 108 109 #define AT91_TWI_FSR 0x0060 /* FIFO Status Register */ 110 #define AT91_TWI_FIER 0x0064 /* FIFO Interrupt Enable Register */ 111 #define AT91_TWI_FIDR 0x0068 /* FIFO Interrupt Disable Register */ 112 #define AT91_TWI_FIMR 0x006c /* FIFO Interrupt Mask Register */ 113 114 #define AT91_TWI_VER 0x00fc /* Version Register */ 115 116 struct at91_twi_pdata { 117 unsigned clk_max_div; 118 unsigned clk_offset; 119 bool has_unre_flag; 120 bool has_alt_cmd; 121 bool has_hold_field; 122 bool has_dig_filtr; 123 bool has_adv_dig_filtr; 124 bool has_ana_filtr; 125 bool has_clear_cmd; 126 struct at_dma_slave dma_slave; 127 }; 128 129 struct at91_twi_dma { 130 struct dma_chan *chan_rx; 131 struct dma_chan *chan_tx; 132 struct scatterlist sg[2]; 133 struct dma_async_tx_descriptor *data_desc; 134 enum dma_data_direction direction; 135 bool buf_mapped; 136 bool xfer_in_progress; 137 }; 138 139 struct at91_twi_dev { 140 struct device *dev; 141 void __iomem *base; 142 struct completion cmd_complete; 143 struct clk *clk; 144 u8 *buf; 145 size_t buf_len; 146 struct i2c_msg *msg; 147 int irq; 148 unsigned imr; 149 unsigned transfer_status; 150 struct i2c_adapter adapter; 151 unsigned twi_cwgr_reg; 152 struct at91_twi_pdata *pdata; 153 bool use_dma; 154 bool use_alt_cmd; 155 bool recv_len_abort; 156 u32 fifo_size; 157 struct at91_twi_dma dma; 158 bool slave_detected; 159 struct i2c_bus_recovery_info rinfo; 160 struct pinctrl *pinctrl; 161 struct pinctrl_state *pinctrl_pins_default; 162 struct pinctrl_state *pinctrl_pins_gpio; 163 #ifdef CONFIG_I2C_AT91_SLAVE_EXPERIMENTAL 164 unsigned smr; 165 struct i2c_client *slave; 166 #endif 167 bool enable_dig_filt; 168 bool enable_ana_filt; 169 u32 filter_width; 170 }; 171 172 unsigned at91_twi_read(struct at91_twi_dev *dev, unsigned reg); 173 void at91_twi_write(struct at91_twi_dev *dev, unsigned reg, unsigned val); 174 void at91_disable_twi_interrupts(struct at91_twi_dev *dev); 175 void at91_twi_irq_save(struct at91_twi_dev *dev); 176 void at91_twi_irq_restore(struct at91_twi_dev *dev); 177 void at91_init_twi_bus(struct at91_twi_dev *dev); 178 179 void at91_init_twi_bus_master(struct at91_twi_dev *dev); 180 int at91_twi_probe_master(struct platform_device *pdev, u32 phy_addr, 181 struct at91_twi_dev *dev); 182 183 #ifdef CONFIG_I2C_AT91_SLAVE_EXPERIMENTAL 184 void at91_init_twi_bus_slave(struct at91_twi_dev *dev); 185 int at91_twi_probe_slave(struct platform_device *pdev, u32 phy_addr, 186 struct at91_twi_dev *dev); 187 188 #else 189 static inline void at91_init_twi_bus_slave(struct at91_twi_dev *dev) {} 190 static inline int at91_twi_probe_slave(struct platform_device *pdev, 191 u32 phy_addr, struct at91_twi_dev *dev) 192 { 193 return -EINVAL; 194 } 195 196 #endif 197