1 /* 2 * ASPEED AST2400 I2C Controller 3 * 4 * Copyright (C) 2016 IBM Corp. 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation; either version 2 of the License, or 9 * (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License along 17 * with this program; if not, write to the Free Software Foundation, Inc., 18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 19 */ 20 21 #ifndef ASPEED_I2C_H 22 #define ASPEED_I2C_H 23 24 #include "hw/i2c/i2c.h" 25 #include "hw/sysbus.h" 26 #include "hw/registerfields.h" 27 #include "qom/object.h" 28 29 #define TYPE_ASPEED_I2C "aspeed.i2c" 30 #define TYPE_ASPEED_2400_I2C TYPE_ASPEED_I2C "-ast2400" 31 #define TYPE_ASPEED_2500_I2C TYPE_ASPEED_I2C "-ast2500" 32 #define TYPE_ASPEED_2600_I2C TYPE_ASPEED_I2C "-ast2600" 33 #define TYPE_ASPEED_1030_I2C TYPE_ASPEED_I2C "-ast1030" 34 OBJECT_DECLARE_TYPE(AspeedI2CState, AspeedI2CClass, ASPEED_I2C) 35 36 #define ASPEED_I2C_NR_BUSSES 16 37 #define ASPEED_I2C_SHARE_POOL_SIZE 0x800 38 #define ASPEED_I2C_BUS_POOL_SIZE 0x20 39 #define ASPEED_I2C_OLD_NUM_REG 11 40 #define ASPEED_I2C_NEW_NUM_REG 22 41 42 #define A_I2CD_M_STOP_CMD BIT(5) 43 #define A_I2CD_M_RX_CMD BIT(3) 44 #define A_I2CD_M_TX_CMD BIT(1) 45 #define A_I2CD_M_START_CMD BIT(0) 46 47 #define A_I2CD_MASTER_EN BIT(0) 48 49 /* Tx State Machine */ 50 #define I2CD_TX_STATE_MASK 0xf 51 #define I2CD_IDLE 0x0 52 #define I2CD_MACTIVE 0x8 53 #define I2CD_MSTART 0x9 54 #define I2CD_MSTARTR 0xa 55 #define I2CD_MSTOP 0xb 56 #define I2CD_MTXD 0xc 57 #define I2CD_MRXACK 0xd 58 #define I2CD_MRXD 0xe 59 #define I2CD_MTXACK 0xf 60 #define I2CD_SWAIT 0x1 61 #define I2CD_SRXD 0x4 62 #define I2CD_STXACK 0x5 63 #define I2CD_STXD 0x6 64 #define I2CD_SRXACK 0x7 65 #define I2CD_RECOVER 0x3 66 67 /* I2C Global Register */ 68 REG32(I2C_CTRL_STATUS, 0x0) /* Device Interrupt Status */ 69 REG32(I2C_CTRL_ASSIGN, 0x8) /* Device Interrupt Target Assignment */ 70 REG32(I2C_CTRL_GLOBAL, 0xC) /* Global Control Register */ 71 FIELD(I2C_CTRL_GLOBAL, REG_MODE, 2, 1) 72 FIELD(I2C_CTRL_GLOBAL, SRAM_EN, 0, 1) 73 REG32(I2C_CTRL_NEW_CLK_DIVIDER, 0x10) /* New mode clock divider */ 74 75 /* I2C Old Mode Device (Bus) Register */ 76 REG32(I2CD_FUN_CTRL, 0x0) /* I2CD Function Control */ 77 FIELD(I2CD_FUN_CTRL, POOL_PAGE_SEL, 20, 3) /* AST2400 */ 78 SHARED_FIELD(M_SDA_LOCK_EN, 16, 1) 79 SHARED_FIELD(MULTI_MASTER_DIS, 15, 1) 80 SHARED_FIELD(M_SCL_DRIVE_EN, 14, 1) 81 SHARED_FIELD(MSB_STS, 9, 1) 82 SHARED_FIELD(SDA_DRIVE_IT_EN, 8, 1) 83 SHARED_FIELD(M_SDA_DRIVE_IT_EN, 7, 1) 84 SHARED_FIELD(M_HIGH_SPEED_EN, 6, 1) 85 SHARED_FIELD(DEF_ADDR_EN, 5, 1) 86 SHARED_FIELD(DEF_ALERT_EN, 4, 1) 87 SHARED_FIELD(DEF_ARP_EN, 3, 1) 88 SHARED_FIELD(DEF_GCALL_EN, 2, 1) 89 SHARED_FIELD(SLAVE_EN, 1, 1) 90 SHARED_FIELD(MASTER_EN, 0, 1) 91 REG32(I2CD_AC_TIMING1, 0x04) /* Clock and AC Timing Control #1 */ 92 REG32(I2CD_AC_TIMING2, 0x08) /* Clock and AC Timing Control #2 */ 93 REG32(I2CD_INTR_CTRL, 0x0C) /* I2CD Interrupt Control */ 94 REG32(I2CD_INTR_STS, 0x10) /* I2CD Interrupt Status */ 95 SHARED_FIELD(SLAVE_ADDR_MATCH, 31, 1) /* 0: addr1 1: addr2 */ 96 SHARED_FIELD(SLAVE_ADDR_RX_PENDING, 29, 1) 97 SHARED_FIELD(SLAVE_INACTIVE_TIMEOUT, 15, 1) 98 SHARED_FIELD(SDA_DL_TIMEOUT, 14, 1) 99 SHARED_FIELD(BUS_RECOVER_DONE, 13, 1) 100 SHARED_FIELD(SMBUS_ALERT, 12, 1) /* Bus [0-3] only */ 101 FIELD(I2CD_INTR_STS, SMBUS_ARP_ADDR, 11, 1) /* Removed */ 102 FIELD(I2CD_INTR_STS, SMBUS_DEV_ALERT_ADDR, 10, 1) /* Removed */ 103 FIELD(I2CD_INTR_STS, SMBUS_DEF_ADDR, 9, 1) /* Removed */ 104 FIELD(I2CD_INTR_STS, GCALL_ADDR, 8, 1) /* Removed */ 105 FIELD(I2CD_INTR_STS, SLAVE_ADDR_RX_MATCH, 7, 1) /* use RX_DONE */ 106 SHARED_FIELD(SCL_TIMEOUT, 6, 1) 107 SHARED_FIELD(ABNORMAL, 5, 1) 108 SHARED_FIELD(NORMAL_STOP, 4, 1) 109 SHARED_FIELD(ARBIT_LOSS, 3, 1) 110 SHARED_FIELD(RX_DONE, 2, 1) 111 SHARED_FIELD(TX_NAK, 1, 1) 112 SHARED_FIELD(TX_ACK, 0, 1) 113 REG32(I2CD_CMD, 0x14) /* I2CD Command/Status */ 114 SHARED_FIELD(SDA_OE, 28, 1) 115 SHARED_FIELD(SDA_O, 27, 1) 116 SHARED_FIELD(SCL_OE, 26, 1) 117 SHARED_FIELD(SCL_O, 25, 1) 118 SHARED_FIELD(TX_TIMING, 23, 2) 119 SHARED_FIELD(TX_STATE, 19, 4) 120 SHARED_FIELD(SCL_LINE_STS, 18, 1) 121 SHARED_FIELD(SDA_LINE_STS, 17, 1) 122 SHARED_FIELD(BUS_BUSY_STS, 16, 1) 123 SHARED_FIELD(SDA_OE_OUT_DIR, 15, 1) 124 SHARED_FIELD(SDA_O_OUT_DIR, 14, 1) 125 SHARED_FIELD(SCL_OE_OUT_DIR, 13, 1) 126 SHARED_FIELD(SCL_O_OUT_DIR, 12, 1) 127 SHARED_FIELD(BUS_RECOVER_CMD_EN, 11, 1) 128 SHARED_FIELD(S_ALT_EN, 10, 1) 129 /* Command Bits */ 130 SHARED_FIELD(RX_DMA_EN, 9, 1) 131 SHARED_FIELD(TX_DMA_EN, 8, 1) 132 SHARED_FIELD(RX_BUFF_EN, 7, 1) 133 SHARED_FIELD(TX_BUFF_EN, 6, 1) 134 SHARED_FIELD(M_STOP_CMD, 5, 1) 135 SHARED_FIELD(M_S_RX_CMD_LAST, 4, 1) 136 SHARED_FIELD(M_RX_CMD, 3, 1) 137 SHARED_FIELD(S_TX_CMD, 2, 1) 138 SHARED_FIELD(M_TX_CMD, 1, 1) 139 SHARED_FIELD(M_START_CMD, 0, 1) 140 REG32(I2CD_DEV_ADDR, 0x18) /* Slave Device Address */ 141 SHARED_FIELD(SLAVE_DEV_ADDR1, 0, 7) 142 REG32(I2CD_POOL_CTRL, 0x1C) /* Pool Buffer Control */ 143 SHARED_FIELD(RX_COUNT, 24, 6) 144 SHARED_FIELD(RX_SIZE, 16, 5) 145 SHARED_FIELD(TX_COUNT, 8, 5) 146 FIELD(I2CD_POOL_CTRL, OFFSET, 2, 6) /* AST2400 */ 147 SHARED_FIELD(BUF_ORGANIZATION, 0, 1) /* AST2600 */ 148 REG32(I2CD_BYTE_BUF, 0x20) /* Transmit/Receive Byte Buffer */ 149 SHARED_FIELD(RX_BUF, 8, 8) 150 SHARED_FIELD(TX_BUF, 0, 8) 151 REG32(I2CD_DMA_ADDR, 0x24) /* DMA Buffer Address */ 152 REG32(I2CD_DMA_LEN, 0x28) /* DMA Transfer Length < 4KB */ 153 154 /* I2C New Mode Device (Bus) Register */ 155 REG32(I2CC_FUN_CTRL, 0x0) 156 FIELD(I2CC_FUN_CTRL, RB_EARLY_DONE_EN, 22, 1) 157 FIELD(I2CC_FUN_CTRL, DMA_DIS_AUTO_RECOVER, 21, 1) 158 FIELD(I2CC_FUN_CTRL, S_SAVE_ADDR, 20, 1) 159 FIELD(I2CC_FUN_CTRL, M_PKT_RETRY_CNT, 18, 2) 160 /* 17:0 shared with I2CD_FUN_CTRL[17:0] */ 161 REG32(I2CC_AC_TIMING, 0x04) 162 REG32(I2CC_MS_TXRX_BYTE_BUF, 0x08) 163 /* 31:16 shared with I2CD_CMD[31:16] */ 164 /* 15:0 shared with I2CD_BYTE_BUF[15:0] */ 165 REG32(I2CC_POOL_CTRL, 0x0c) 166 /* 31:0 shared with I2CD_POOL_CTRL[31:0] */ 167 REG32(I2CM_INTR_CTRL, 0x10) 168 REG32(I2CM_INTR_STS, 0x14) 169 FIELD(I2CM_INTR_STS, PKT_STATE, 28, 4) 170 FIELD(I2CM_INTR_STS, PKT_CMD_TIMEOUT, 18, 1) 171 FIELD(I2CM_INTR_STS, PKT_CMD_FAIL, 17, 1) 172 FIELD(I2CM_INTR_STS, PKT_CMD_DONE, 16, 1) 173 FIELD(I2CM_INTR_STS, BUS_RECOVER_FAIL, 15, 1) 174 /* 14:0 shared with I2CD_INTR_STS[14:0] */ 175 REG32(I2CM_CMD, 0x18) 176 FIELD(I2CM_CMD, W1_CTRL, 31, 1) 177 FIELD(I2CM_CMD, PKT_DEV_ADDR, 24, 7) 178 FIELD(I2CM_CMD, HS_MASTER_MODE_LSB, 17, 3) 179 FIELD(I2CM_CMD, PKT_OP_EN, 16, 1) 180 /* 15:0 shared with I2CD_CMD[15:0] */ 181 REG32(I2CM_DMA_LEN, 0x1c) 182 FIELD(I2CM_DMA_LEN, RX_BUF_LEN_W1T, 31, 1) 183 FIELD(I2CM_DMA_LEN, RX_BUF_LEN, 16, 11) 184 FIELD(I2CM_DMA_LEN, TX_BUF_LEN_W1T, 15, 1) 185 FIELD(I2CM_DMA_LEN, TX_BUF_LEN, 0, 11) 186 REG32(I2CS_INTR_CTRL, 0x20) 187 FIELD(I2CS_INTR_CTRL, PKT_CMD_FAIL, 17, 1) 188 FIELD(I2CS_INTR_CTRL, PKT_CMD_DONE, 16, 1) 189 REG32(I2CS_INTR_STS, 0x24) 190 /* 31:29 shared with I2CD_INTR_STS[31:29] */ 191 FIELD(I2CS_INTR_STS, SLAVE_PARKING_STS, 24, 2) 192 FIELD(I2CS_INTR_STS, SLAVE_ADDR3_NAK, 22, 1) 193 FIELD(I2CS_INTR_STS, SLAVE_ADDR2_NAK, 21, 1) 194 FIELD(I2CS_INTR_STS, SLAVE_ADDR1_NAK, 20, 1) 195 FIELD(I2CS_INTR_STS, SLAVE_ADDR_INDICATOR, 18, 2) 196 FIELD(I2CS_INTR_STS, PKT_CMD_FAIL, 17, 1) 197 FIELD(I2CS_INTR_STS, PKT_CMD_DONE, 16, 1) 198 /* 14:0 shared with I2CD_INTR_STS[14:0] */ 199 FIELD(I2CS_INTR_STS, SLAVE_ADDR_RX_MATCH, 7, 1) 200 REG32(I2CS_CMD, 0x28) 201 FIELD(I2CS_CMD, W1_CTRL, 31, 1) 202 FIELD(I2CS_CMD, PKT_MODE_ACTIVE_ADDR, 17, 2) 203 FIELD(I2CS_CMD, PKT_MODE_EN, 16, 1) 204 FIELD(I2CS_CMD, AUTO_NAK_INACTIVE_ADDR, 15, 1) 205 FIELD(I2CS_CMD, AUTO_NAK_ACTIVE_ADDR, 14, 1) 206 /* 13:0 shared with I2CD_CMD[13:0] */ 207 REG32(I2CS_DMA_LEN, 0x2c) 208 FIELD(I2CS_DMA_LEN, RX_BUF_LEN_W1T, 31, 1) 209 FIELD(I2CS_DMA_LEN, RX_BUF_LEN, 16, 11) 210 FIELD(I2CS_DMA_LEN, TX_BUF_LEN_W1T, 15, 1) 211 FIELD(I2CS_DMA_LEN, TX_BUF_LEN, 0, 11) 212 REG32(I2CM_DMA_TX_ADDR, 0x30) 213 FIELD(I2CM_DMA_TX_ADDR, ADDR, 0, 31) 214 REG32(I2CM_DMA_RX_ADDR, 0x34) 215 FIELD(I2CM_DMA_RX_ADDR, ADDR, 0, 31) 216 REG32(I2CS_DMA_TX_ADDR, 0x38) 217 FIELD(I2CS_DMA_TX_ADDR, ADDR, 0, 31) 218 REG32(I2CS_DMA_RX_ADDR, 0x3c) 219 FIELD(I2CS_DMA_RX_ADDR, ADDR, 0, 31) 220 REG32(I2CS_DEV_ADDR, 0x40) 221 REG32(I2CM_DMA_LEN_STS, 0x48) 222 FIELD(I2CM_DMA_LEN_STS, RX_LEN, 16, 13) 223 FIELD(I2CM_DMA_LEN_STS, TX_LEN, 0, 13) 224 REG32(I2CS_DMA_LEN_STS, 0x4c) 225 FIELD(I2CS_DMA_LEN_STS, RX_LEN, 16, 13) 226 FIELD(I2CS_DMA_LEN_STS, TX_LEN, 0, 13) 227 REG32(I2CC_DMA_ADDR, 0x50) 228 REG32(I2CC_DMA_LEN, 0x54) 229 230 struct AspeedI2CState; 231 232 #define TYPE_ASPEED_I2C_BUS "aspeed.i2c.bus" 233 OBJECT_DECLARE_SIMPLE_TYPE(AspeedI2CBus, ASPEED_I2C_BUS) 234 struct AspeedI2CBus { 235 SysBusDevice parent_obj; 236 237 struct AspeedI2CState *controller; 238 239 /* slave mode */ 240 I2CSlave *slave; 241 242 MemoryRegion mr; 243 MemoryRegion mr_pool; 244 245 I2CBus *bus; 246 uint8_t id; 247 qemu_irq irq; 248 249 uint32_t regs[ASPEED_I2C_NEW_NUM_REG]; 250 uint8_t pool[ASPEED_I2C_BUS_POOL_SIZE]; 251 uint64_t dma_dram_offset; 252 }; 253 254 struct AspeedI2CState { 255 SysBusDevice parent_obj; 256 257 MemoryRegion iomem; 258 qemu_irq irq; 259 260 uint32_t intr_status; 261 uint32_t ctrl_global; 262 uint32_t new_clk_divider; 263 MemoryRegion pool_iomem; 264 uint8_t share_pool[ASPEED_I2C_SHARE_POOL_SIZE]; 265 266 AspeedI2CBus busses[ASPEED_I2C_NR_BUSSES]; 267 MemoryRegion *dram_mr; 268 AddressSpace dram_as; 269 }; 270 271 #define TYPE_ASPEED_I2C_BUS_SLAVE "aspeed.i2c.slave" 272 OBJECT_DECLARE_SIMPLE_TYPE(AspeedI2CBusSlave, ASPEED_I2C_BUS_SLAVE) 273 struct AspeedI2CBusSlave { 274 I2CSlave i2c; 275 }; 276 277 struct AspeedI2CClass { 278 SysBusDeviceClass parent_class; 279 280 uint8_t num_busses; 281 uint8_t reg_size; 282 uint32_t reg_gap_size; 283 uint8_t gap; 284 qemu_irq (*bus_get_irq)(AspeedI2CBus *); 285 286 uint64_t pool_size; 287 hwaddr pool_base; 288 uint32_t pool_gap_size; 289 uint8_t *(*bus_pool_base)(AspeedI2CBus *); 290 bool check_sram; 291 bool has_dma; 292 bool has_share_pool; 293 uint64_t mem_size; 294 }; 295 296 static inline bool aspeed_i2c_is_new_mode(AspeedI2CState *s) 297 { 298 return FIELD_EX32(s->ctrl_global, I2C_CTRL_GLOBAL, REG_MODE); 299 } 300 301 static inline bool aspeed_i2c_bus_pkt_mode_en(AspeedI2CBus *bus) 302 { 303 if (aspeed_i2c_is_new_mode(bus->controller)) { 304 return ARRAY_FIELD_EX32(bus->regs, I2CM_CMD, PKT_OP_EN); 305 } 306 return false; 307 } 308 309 static inline uint32_t aspeed_i2c_bus_ctrl_offset(AspeedI2CBus *bus) 310 { 311 if (aspeed_i2c_is_new_mode(bus->controller)) { 312 return R_I2CC_FUN_CTRL; 313 } 314 return R_I2CD_FUN_CTRL; 315 } 316 317 static inline uint32_t aspeed_i2c_bus_cmd_offset(AspeedI2CBus *bus) 318 { 319 if (aspeed_i2c_is_new_mode(bus->controller)) { 320 return R_I2CM_CMD; 321 } 322 return R_I2CD_CMD; 323 } 324 325 static inline uint32_t aspeed_i2c_bus_dev_addr_offset(AspeedI2CBus *bus) 326 { 327 if (aspeed_i2c_is_new_mode(bus->controller)) { 328 return R_I2CS_DEV_ADDR; 329 } 330 return R_I2CD_DEV_ADDR; 331 } 332 333 static inline uint32_t aspeed_i2c_bus_intr_ctrl_offset(AspeedI2CBus *bus) 334 { 335 if (aspeed_i2c_is_new_mode(bus->controller)) { 336 return R_I2CM_INTR_CTRL; 337 } 338 return R_I2CD_INTR_CTRL; 339 } 340 341 static inline uint32_t aspeed_i2c_bus_intr_sts_offset(AspeedI2CBus *bus) 342 { 343 if (aspeed_i2c_is_new_mode(bus->controller)) { 344 return R_I2CM_INTR_STS; 345 } 346 return R_I2CD_INTR_STS; 347 } 348 349 static inline uint32_t aspeed_i2c_bus_pool_ctrl_offset(AspeedI2CBus *bus) 350 { 351 if (aspeed_i2c_is_new_mode(bus->controller)) { 352 return R_I2CC_POOL_CTRL; 353 } 354 return R_I2CD_POOL_CTRL; 355 } 356 357 static inline uint32_t aspeed_i2c_bus_byte_buf_offset(AspeedI2CBus *bus) 358 { 359 if (aspeed_i2c_is_new_mode(bus->controller)) { 360 return R_I2CC_MS_TXRX_BYTE_BUF; 361 } 362 return R_I2CD_BYTE_BUF; 363 } 364 365 static inline uint32_t aspeed_i2c_bus_dma_len_offset(AspeedI2CBus *bus) 366 { 367 if (aspeed_i2c_is_new_mode(bus->controller)) { 368 return R_I2CC_DMA_LEN; 369 } 370 return R_I2CD_DMA_LEN; 371 } 372 373 static inline bool aspeed_i2c_bus_is_master(AspeedI2CBus *bus) 374 { 375 return SHARED_ARRAY_FIELD_EX32(bus->regs, aspeed_i2c_bus_ctrl_offset(bus), 376 MASTER_EN); 377 } 378 379 static inline bool aspeed_i2c_bus_is_enabled(AspeedI2CBus *bus) 380 { 381 uint32_t ctrl_reg = aspeed_i2c_bus_ctrl_offset(bus); 382 return SHARED_ARRAY_FIELD_EX32(bus->regs, ctrl_reg, MASTER_EN) || 383 SHARED_ARRAY_FIELD_EX32(bus->regs, ctrl_reg, SLAVE_EN); 384 } 385 386 I2CBus *aspeed_i2c_get_bus(AspeedI2CState *s, int busnr); 387 388 #endif /* ASPEED_I2C_H */ 389