include/hw/i2c/aspeed_i2c.h

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