hw/ssi/xilinx_spips.c

   1 /*
   2  * QEMU model of the Xilinx Zynq SPI controller
   3  *
   4  * Copyright (c) 2012 Peter A. G. Crosthwaite
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #include "hw/sysbus.h"
  26 #include "sysemu/sysemu.h"
  27 #include "hw/ptimer.h"
  28 #include "qemu/log.h"
  29 #include "qemu/fifo8.h"
  30 #include "hw/ssi.h"
  31 #include "qemu/bitops.h"
  32
  33 #ifndef XILINX_SPIPS_ERR_DEBUG
  34 #define XILINX_SPIPS_ERR_DEBUG 0
  35 #endif
  36
  37 #define DB_PRINT_L(level, ...) do { \
  38     if (XILINX_SPIPS_ERR_DEBUG > (level)) { \
  39         fprintf(stderr,  ": %s: ", __func__); \
  40         fprintf(stderr, ## __VA_ARGS__); \
  41     } \
  42 } while (0);
  43
  44 /* config register */
  45 #define R_CONFIG            (0x00 / 4)
  46 #define IFMODE              (1 << 31)
  47 #define ENDIAN              (1 << 26)
  48 #define MODEFAIL_GEN_EN     (1 << 17)
  49 #define MAN_START_COM       (1 << 16)
  50 #define MAN_START_EN        (1 << 15)
  51 #define MANUAL_CS           (1 << 14)
  52 #define CS                  (0xF << 10)
  53 #define CS_SHIFT            (10)
  54 #define PERI_SEL            (1 << 9)
  55 #define REF_CLK             (1 << 8)
  56 #define FIFO_WIDTH          (3 << 6)
  57 #define BAUD_RATE_DIV       (7 << 3)
  58 #define CLK_PH              (1 << 2)
  59 #define CLK_POL             (1 << 1)
  60 #define MODE_SEL            (1 << 0)
  61 #define R_CONFIG_RSVD       (0x7bf40000)
  62
  63 /* interrupt mechanism */
  64 #define R_INTR_STATUS       (0x04 / 4)
  65 #define R_INTR_EN           (0x08 / 4)
  66 #define R_INTR_DIS          (0x0C / 4)
  67 #define R_INTR_MASK         (0x10 / 4)
  68 #define IXR_TX_FIFO_UNDERFLOW   (1 << 6)
  69 #define IXR_RX_FIFO_FULL        (1 << 5)
  70 #define IXR_RX_FIFO_NOT_EMPTY   (1 << 4)
  71 #define IXR_TX_FIFO_FULL        (1 << 3)
  72 #define IXR_TX_FIFO_NOT_FULL    (1 << 2)
  73 #define IXR_TX_FIFO_MODE_FAIL   (1 << 1)
  74 #define IXR_RX_FIFO_OVERFLOW    (1 << 0)
  75 #define IXR_ALL                 ((IXR_TX_FIFO_UNDERFLOW<<1)-1)
  76
  77 #define R_EN                (0x14 / 4)
  78 #define R_DELAY             (0x18 / 4)
  79 #define R_TX_DATA           (0x1C / 4)
  80 #define R_RX_DATA           (0x20 / 4)
  81 #define R_SLAVE_IDLE_COUNT  (0x24 / 4)
  82 #define R_TX_THRES          (0x28 / 4)
  83 #define R_RX_THRES          (0x2C / 4)
  84 #define R_TXD1              (0x80 / 4)
  85 #define R_TXD2              (0x84 / 4)
  86 #define R_TXD3              (0x88 / 4)
  87
  88 #define R_LQSPI_CFG         (0xa0 / 4)
  89 #define R_LQSPI_CFG_RESET       0x03A002EB
  90 #define LQSPI_CFG_LQ_MODE       (1 << 31)
  91 #define LQSPI_CFG_TWO_MEM       (1 << 30)
  92 #define LQSPI_CFG_SEP_BUS       (1 << 30)
  93 #define LQSPI_CFG_U_PAGE        (1 << 28)
  94 #define LQSPI_CFG_MODE_EN       (1 << 25)
  95 #define LQSPI_CFG_MODE_WIDTH    8
  96 #define LQSPI_CFG_MODE_SHIFT    16
  97 #define LQSPI_CFG_DUMMY_WIDTH   3
  98 #define LQSPI_CFG_DUMMY_SHIFT   8
  99 #define LQSPI_CFG_INST_CODE     0xFF
 100
 101 #define R_LQSPI_STS         (0xA4 / 4)
 102 #define LQSPI_STS_WR_RECVD      (1 << 1)
 103
 104 #define R_MOD_ID            (0xFC / 4)
 105
 106 #define R_MAX (R_MOD_ID+1)
 107
 108 /* size of TXRX FIFOs */
 109 #define RXFF_A          32
 110 #define TXFF_A          32
 111
 112 #define RXFF_A_Q          (64 * 4)
 113 #define TXFF_A_Q          (64 * 4)
 114
 115 /* 16MB per linear region */
 116 #define LQSPI_ADDRESS_BITS 24
 117 /* Bite off 4k chunks at a time */
 118 #define LQSPI_CACHE_SIZE 1024
 119
 120 #define SNOOP_CHECKING 0xFF
 121 #define SNOOP_NONE 0xFE
 122 #define SNOOP_STRIPING 0
 123
 124 typedef enum {
 125     READ = 0x3,
 126     FAST_READ = 0xb,
 127     DOR = 0x3b,
 128     QOR = 0x6b,
 129     DIOR = 0xbb,
 130     QIOR = 0xeb,
 131
 132     PP = 0x2,
 133     DPP = 0xa2,
 134     QPP = 0x32,
 135 } FlashCMD;
 136
 137 typedef struct {
 138     SysBusDevice parent_obj;
 139
 140     MemoryRegion iomem;
 141     MemoryRegion mmlqspi;
 142
 143     qemu_irq irq;
 144     int irqline;
 145
 146     uint8_t num_cs;
 147     uint8_t num_busses;
 148
 149     uint8_t snoop_state;
 150     qemu_irq *cs_lines;
 151     SSIBus **spi;
 152
 153     Fifo8 rx_fifo;
 154     Fifo8 tx_fifo;
 155
 156     uint8_t num_txrx_bytes;
 157
 158     uint32_t regs[R_MAX];
 159 } XilinxSPIPS;
 160
 161 typedef struct {
 162     XilinxSPIPS parent_obj;
 163
 164     uint32_t lqspi_buf[LQSPI_CACHE_SIZE];
 165     hwaddr lqspi_cached_addr;
 166 } XilinxQSPIPS;
 167
 168 typedef struct XilinxSPIPSClass {
 169     SysBusDeviceClass parent_class;
 170
 171     const MemoryRegionOps *reg_ops;
 172
 173     uint32_t rx_fifo_size;
 174     uint32_t tx_fifo_size;
 175 } XilinxSPIPSClass;
 176
 177 #define TYPE_XILINX_SPIPS "xlnx.ps7-spi"
 178 #define TYPE_XILINX_QSPIPS "xlnx.ps7-qspi"
 179
 180 #define XILINX_SPIPS(obj) \
 181      OBJECT_CHECK(XilinxSPIPS, (obj), TYPE_XILINX_SPIPS)
 182 #define XILINX_SPIPS_CLASS(klass) \
 183      OBJECT_CLASS_CHECK(XilinxSPIPSClass, (klass), TYPE_XILINX_SPIPS)
 184 #define XILINX_SPIPS_GET_CLASS(obj) \
 185      OBJECT_GET_CLASS(XilinxSPIPSClass, (obj), TYPE_XILINX_SPIPS)
 186
 187 #define XILINX_QSPIPS(obj) \
 188      OBJECT_CHECK(XilinxQSPIPS, (obj), TYPE_XILINX_QSPIPS)
 189
 190 static inline int num_effective_busses(XilinxSPIPS *s)
 191 {
 192     return (s->regs[R_LQSPI_CFG] & LQSPI_CFG_SEP_BUS &&
 193             s->regs[R_LQSPI_CFG] & LQSPI_CFG_TWO_MEM) ? s->num_busses : 1;
 194 }
 195
 196 static inline bool xilinx_spips_cs_is_set(XilinxSPIPS *s, int i, int field)
 197 {
 198     return ~field & (1 << i) && (s->regs[R_CONFIG] & MANUAL_CS
 199                     || !fifo8_is_empty(&s->tx_fifo));
 200 }
 201
 202 static void xilinx_spips_update_cs_lines(XilinxSPIPS *s)
 203 {
 204     int i, j;
 205     bool found = false;
 206     int field = s->regs[R_CONFIG] >> CS_SHIFT;
 207
 208     for (i = 0; i < s->num_cs; i++) {
 209         for (j = 0; j < num_effective_busses(s); j++) {
 210             int upage = !!(s->regs[R_LQSPI_STS] & LQSPI_CFG_U_PAGE);
 211             int cs_to_set = (j * s->num_cs + i + upage) %
 212                                 (s->num_cs * s->num_busses);
 213
 214             if (xilinx_spips_cs_is_set(s, i, field) && !found) {
 215                 DB_PRINT_L(0, "selecting slave %d\n", i);
 216                 qemu_set_irq(s->cs_lines[cs_to_set], 0);
 217             } else {
 218                 DB_PRINT_L(0, "deselecting slave %d\n", i);
 219                 qemu_set_irq(s->cs_lines[cs_to_set], 1);
 220             }
 221         }
 222         if (xilinx_spips_cs_is_set(s, i, field)) {
 223             found = true;
 224         }
 225     }
 226     if (!found) {
 227         s->snoop_state = SNOOP_CHECKING;
 228         DB_PRINT_L(1, "moving to snoop check state\n");
 229     }
 230 }
 231
 232 static void xilinx_spips_update_ixr(XilinxSPIPS *s)
 233 {
 234     if (s->regs[R_LQSPI_CFG] & LQSPI_CFG_LQ_MODE) {
 235         return;
 236     }
 237     /* These are set/cleared as they occur */
 238     s->regs[R_INTR_STATUS] &= (IXR_TX_FIFO_UNDERFLOW | IXR_RX_FIFO_OVERFLOW |
 239                                 IXR_TX_FIFO_MODE_FAIL);
 240     /* these are pure functions of fifo state, set them here */
 241     s->regs[R_INTR_STATUS] |=
 242         (fifo8_is_full(&s->rx_fifo) ? IXR_RX_FIFO_FULL : 0) |
 243         (s->rx_fifo.num >= s->regs[R_RX_THRES] ? IXR_RX_FIFO_NOT_EMPTY : 0) |
 244         (fifo8_is_full(&s->tx_fifo) ? IXR_TX_FIFO_FULL : 0) |
 245         (s->tx_fifo.num < s->regs[R_TX_THRES] ? IXR_TX_FIFO_NOT_FULL : 0);
 246     /* drive external interrupt pin */
 247     int new_irqline = !!(s->regs[R_INTR_MASK] & s->regs[R_INTR_STATUS] &
 248                                                                 IXR_ALL);
 249     if (new_irqline != s->irqline) {
 250         s->irqline = new_irqline;
 251         qemu_set_irq(s->irq, s->irqline);
 252     }
 253 }
 254
 255 static void xilinx_spips_reset(DeviceState *d)
 256 {
 257     XilinxSPIPS *s = XILINX_SPIPS(d);
 258
 259     int i;
 260     for (i = 0; i < R_MAX; i++) {
 261         s->regs[i] = 0;
 262     }
 263
 264     fifo8_reset(&s->rx_fifo);
 265     fifo8_reset(&s->rx_fifo);
 266     /* non zero resets */
 267     s->regs[R_CONFIG] |= MODEFAIL_GEN_EN;
 268     s->regs[R_SLAVE_IDLE_COUNT] = 0xFF;
 269     s->regs[R_TX_THRES] = 1;
 270     s->regs[R_RX_THRES] = 1;
 271     /* FIXME: move magic number definition somewhere sensible */
 272     s->regs[R_MOD_ID] = 0x01090106;
 273     s->regs[R_LQSPI_CFG] = R_LQSPI_CFG_RESET;
 274     s->snoop_state = SNOOP_CHECKING;
 275     xilinx_spips_update_ixr(s);
 276     xilinx_spips_update_cs_lines(s);
 277 }
 278
 279 /* N way (num) in place bit striper. Lay out row wise bits (LSB to MSB)
 280  * column wise (from element 0 to N-1). num is the length of x, and dir
 281  * reverses the direction of the transform. Best illustrated by example:
 282  * Each digit in the below array is a single bit (num == 3):
 283  *
 284  * {{ 76543210, }  ----- stripe (dir == false) -----> {{ FCheb630, }
 285  *  { hgfedcba, }                                      { GDAfc741, }
 286  *  { HGFEDCBA, }} <---- upstripe (dir == true) -----  { HEBgda52, }}
 287  */
 288
 289 static inline void stripe8(uint8_t *x, int num, bool dir)
 290 {
 291     uint8_t r[num];
 292     memset(r, 0, sizeof(uint8_t) * num);
 293     int idx[2] = {0, 0};
 294     int bit[2] = {0, 0};
 295     int d = dir;
 296
 297     for (idx[0] = 0; idx[0] < num; ++idx[0]) {
 298         for (bit[0] = 0; bit[0] < 8; ++bit[0]) {
 299             r[idx[d]] |= x[idx[!d]] & 1 << bit[!d] ? 1 << bit[d] : 0;
 300             idx[1] = (idx[1] + 1) % num;
 301             if (!idx[1]) {
 302                 bit[1]++;
 303             }
 304         }
 305     }
 306     memcpy(x, r, sizeof(uint8_t) * num);
 307 }
 308
 309 static void xilinx_spips_flush_txfifo(XilinxSPIPS *s)
 310 {
 311     int debug_level = 0;
 312
 313     for (;;) {
 314         int i;
 315         uint8_t tx = 0;
 316         uint8_t tx_rx[num_effective_busses(s)];
 317
 318         if (fifo8_is_empty(&s->tx_fifo)) {
 319             if (!(s->regs[R_LQSPI_CFG] & LQSPI_CFG_LQ_MODE)) {
 320                 s->regs[R_INTR_STATUS] |= IXR_TX_FIFO_UNDERFLOW;
 321             }
 322             xilinx_spips_update_ixr(s);
 323             return;
 324         } else if (s->snoop_state == SNOOP_STRIPING) {
 325             for (i = 0; i < num_effective_busses(s); ++i) {
 326                 tx_rx[i] = fifo8_pop(&s->tx_fifo);
 327             }
 328             stripe8(tx_rx, num_effective_busses(s), false);
 329         } else {
 330             tx = fifo8_pop(&s->tx_fifo);
 331             for (i = 0; i < num_effective_busses(s); ++i) {
 332                 tx_rx[i] = tx;
 333             }
 334         }
 335
 336         for (i = 0; i < num_effective_busses(s); ++i) {
 337             DB_PRINT_L(debug_level, "tx = %02x\n", tx_rx[i]);
 338             tx_rx[i] = ssi_transfer(s->spi[i], (uint32_t)tx_rx[i]);
 339             DB_PRINT_L(debug_level, "rx = %02x\n", tx_rx[i]);
 340         }
 341
 342         if (fifo8_is_full(&s->rx_fifo)) {
 343             s->regs[R_INTR_STATUS] |= IXR_RX_FIFO_OVERFLOW;
 344             DB_PRINT_L(0, "rx FIFO overflow");
 345         } else if (s->snoop_state == SNOOP_STRIPING) {
 346             stripe8(tx_rx, num_effective_busses(s), true);
 347             for (i = 0; i < num_effective_busses(s); ++i) {
 348                 fifo8_push(&s->rx_fifo, (uint8_t)tx_rx[i]);
 349             }
 350         } else {
 351            fifo8_push(&s->rx_fifo, (uint8_t)tx_rx[0]);
 352         }
 353
 354         DB_PRINT_L(debug_level, "initial snoop state: %x\n",
 355                    (unsigned)s->snoop_state);
 356         switch (s->snoop_state) {
 357         case (SNOOP_CHECKING):
 358             switch (tx) { /* new instruction code */
 359             case READ: /* 3 address bytes, no dummy bytes/cycles */
 360             case PP:
 361             case DPP:
 362             case QPP:
 363                 s->snoop_state = 3;
 364                 break;
 365             case FAST_READ: /* 3 address bytes, 1 dummy byte */
 366             case DOR:
 367             case QOR:
 368             case DIOR: /* FIXME: these vary between vendor - set to spansion */
 369                 s->snoop_state = 4;
 370                 break;
 371             case QIOR: /* 3 address bytes, 2 dummy bytes */
 372                 s->snoop_state = 6;
 373                 break;
 374             default:
 375                 s->snoop_state = SNOOP_NONE;
 376             }
 377             break;
 378         case (SNOOP_STRIPING):
 379         case (SNOOP_NONE):
 380             /* Once we hit the boring stuff - squelch debug noise */
 381             if (!debug_level) {
 382                 DB_PRINT_L(0, "squelching debug info ....\n");
 383                 debug_level = 1;
 384             }
 385             break;
 386         default:
 387             s->snoop_state--;
 388         }
 389         DB_PRINT_L(debug_level, "final snoop state: %x\n",
 390                    (unsigned)s->snoop_state);
 391     }
 392 }
 393
 394 static inline void rx_data_bytes(XilinxSPIPS *s, uint32_t *value, int max)
 395 {
 396     int i;
 397
 398     *value = 0;
 399     for (i = 0; i < max && !fifo8_is_empty(&s->rx_fifo); ++i) {
 400         uint32_t next = fifo8_pop(&s->rx_fifo) & 0xFF;
 401         *value |= next << 8 * (s->regs[R_CONFIG] & ENDIAN ? 3-i : i);
 402     }
 403 }
 404
 405 static uint64_t xilinx_spips_read(void *opaque, hwaddr addr,
 406                                                         unsigned size)
 407 {
 408     XilinxSPIPS *s = opaque;
 409     uint32_t mask = ~0;
 410     uint32_t ret;
 411
 412     addr >>= 2;
 413     switch (addr) {
 414     case R_CONFIG:
 415         mask = ~(R_CONFIG_RSVD | MAN_START_COM);
 416         break;
 417     case R_INTR_STATUS:
 418         ret = s->regs[addr] & IXR_ALL;
 419         s->regs[addr] = 0;
 420         DB_PRINT_L(0, "addr=" TARGET_FMT_plx " = %x\n", addr * 4, ret);
 421         return ret;
 422     case R_INTR_MASK:
 423         mask = IXR_ALL;
 424         break;
 425     case  R_EN:
 426         mask = 0x1;
 427         break;
 428     case R_SLAVE_IDLE_COUNT:
 429         mask = 0xFF;
 430         break;
 431     case R_MOD_ID:
 432         mask = 0x01FFFFFF;
 433         break;
 434     case R_INTR_EN:
 435     case R_INTR_DIS:
 436     case R_TX_DATA:
 437         mask = 0;
 438         break;
 439     case R_RX_DATA:
 440         rx_data_bytes(s, &ret, s->num_txrx_bytes);
 441         DB_PRINT_L(0, "addr=" TARGET_FMT_plx " = %x\n", addr * 4, ret);
 442         xilinx_spips_update_ixr(s);
 443         return ret;
 444     }
 445     DB_PRINT_L(0, "addr=" TARGET_FMT_plx " = %x\n", addr * 4,
 446                s->regs[addr] & mask);
 447     return s->regs[addr] & mask;
 448
 449 }
 450
 451 static inline void tx_data_bytes(XilinxSPIPS *s, uint32_t value, int num)
 452 {
 453     int i;
 454     for (i = 0; i < num && !fifo8_is_full(&s->tx_fifo); ++i) {
 455         if (s->regs[R_CONFIG] & ENDIAN) {
 456             fifo8_push(&s->tx_fifo, (uint8_t)(value >> 24));
 457             value <<= 8;
 458         } else {
 459             fifo8_push(&s->tx_fifo, (uint8_t)value);
 460             value >>= 8;
 461         }
 462     }
 463 }
 464
 465 static void xilinx_spips_write(void *opaque, hwaddr addr,
 466                                         uint64_t value, unsigned size)
 467 {
 468     int mask = ~0;
 469     int man_start_com = 0;
 470     XilinxSPIPS *s = opaque;
 471
 472     DB_PRINT_L(0, "addr=" TARGET_FMT_plx " = %x\n", addr, (unsigned)value);
 473     addr >>= 2;
 474     switch (addr) {
 475     case R_CONFIG:
 476         mask = ~(R_CONFIG_RSVD | MAN_START_COM);
 477         if (value & MAN_START_COM) {
 478             man_start_com = 1;
 479         }
 480         break;
 481     case R_INTR_STATUS:
 482         mask = IXR_ALL;
 483         s->regs[R_INTR_STATUS] &= ~(mask & value);
 484         goto no_reg_update;
 485     case R_INTR_DIS:
 486         mask = IXR_ALL;
 487         s->regs[R_INTR_MASK] &= ~(mask & value);
 488         goto no_reg_update;
 489     case R_INTR_EN:
 490         mask = IXR_ALL;
 491         s->regs[R_INTR_MASK] |= mask & value;
 492         goto no_reg_update;
 493     case R_EN:
 494         mask = 0x1;
 495         break;
 496     case R_SLAVE_IDLE_COUNT:
 497         mask = 0xFF;
 498         break;
 499     case R_RX_DATA:
 500     case R_INTR_MASK:
 501     case R_MOD_ID:
 502         mask = 0;
 503         break;
 504     case R_TX_DATA:
 505         tx_data_bytes(s, (uint32_t)value, s->num_txrx_bytes);
 506         goto no_reg_update;
 507     case R_TXD1:
 508         tx_data_bytes(s, (uint32_t)value, 1);
 509         goto no_reg_update;
 510     case R_TXD2:
 511         tx_data_bytes(s, (uint32_t)value, 2);
 512         goto no_reg_update;
 513     case R_TXD3:
 514         tx_data_bytes(s, (uint32_t)value, 3);
 515         goto no_reg_update;
 516     }
 517     s->regs[addr] = (s->regs[addr] & ~mask) | (value & mask);
 518 no_reg_update:
 519     xilinx_spips_update_cs_lines(s);
 520     if ((man_start_com && s->regs[R_CONFIG] & MAN_START_EN) ||
 521             (fifo8_is_empty(&s->tx_fifo) && s->regs[R_CONFIG] & MAN_START_EN)) {
 522         xilinx_spips_flush_txfifo(s);
 523     }
 524     xilinx_spips_update_cs_lines(s);
 525     xilinx_spips_update_ixr(s);
 526 }
 527
 528 static const MemoryRegionOps spips_ops = {
 529     .read = xilinx_spips_read,
 530     .write = xilinx_spips_write,
 531     .endianness = DEVICE_LITTLE_ENDIAN,
 532 };
 533
 534 static void xilinx_qspips_write(void *opaque, hwaddr addr,
 535                                 uint64_t value, unsigned size)
 536 {
 537     XilinxQSPIPS *q = XILINX_QSPIPS(opaque);
 538
 539     xilinx_spips_write(opaque, addr, value, size);
 540     addr >>= 2;
 541
 542     if (addr == R_LQSPI_CFG) {
 543         q->lqspi_cached_addr = ~0ULL;
 544     }
 545 }
 546
 547 static const MemoryRegionOps qspips_ops = {
 548     .read = xilinx_spips_read,
 549     .write = xilinx_qspips_write,
 550     .endianness = DEVICE_LITTLE_ENDIAN,
 551 };
 552
 553 #define LQSPI_CACHE_SIZE 1024
 554
 555 static uint64_t
 556 lqspi_read(void *opaque, hwaddr addr, unsigned int size)
 557 {
 558     int i;
 559     XilinxQSPIPS *q = opaque;
 560     XilinxSPIPS *s = opaque;
 561     uint32_t ret;
 562
 563     if (addr >= q->lqspi_cached_addr &&
 564             addr <= q->lqspi_cached_addr + LQSPI_CACHE_SIZE - 4) {
 565         ret = q->lqspi_buf[(addr - q->lqspi_cached_addr) >> 2];
 566         DB_PRINT_L(1, "addr: %08x, data: %08x\n", (unsigned)addr,
 567                    (unsigned)ret);
 568         return ret;
 569     } else {
 570         int flash_addr = (addr / num_effective_busses(s));
 571         int slave = flash_addr >> LQSPI_ADDRESS_BITS;
 572         int cache_entry = 0;
 573         uint32_t u_page_save = s->regs[R_LQSPI_STS] & ~LQSPI_CFG_U_PAGE;
 574
 575         s->regs[R_LQSPI_STS] &= ~LQSPI_CFG_U_PAGE;
 576         s->regs[R_LQSPI_STS] |= slave ? LQSPI_CFG_U_PAGE : 0;
 577
 578         DB_PRINT_L(0, "config reg status: %08x\n", s->regs[R_LQSPI_CFG]);
 579
 580         fifo8_reset(&s->tx_fifo);
 581         fifo8_reset(&s->rx_fifo);
 582
 583         /* instruction */
 584         DB_PRINT_L(0, "pushing read instruction: %02x\n",
 585                    (unsigned)(uint8_t)(s->regs[R_LQSPI_CFG] &
 586                                        LQSPI_CFG_INST_CODE));
 587         fifo8_push(&s->tx_fifo, s->regs[R_LQSPI_CFG] & LQSPI_CFG_INST_CODE);
 588         /* read address */
 589         DB_PRINT_L(0, "pushing read address %06x\n", flash_addr);
 590         fifo8_push(&s->tx_fifo, (uint8_t)(flash_addr >> 16));
 591         fifo8_push(&s->tx_fifo, (uint8_t)(flash_addr >> 8));
 592         fifo8_push(&s->tx_fifo, (uint8_t)flash_addr);
 593         /* mode bits */
 594         if (s->regs[R_LQSPI_CFG] & LQSPI_CFG_MODE_EN) {
 595             fifo8_push(&s->tx_fifo, extract32(s->regs[R_LQSPI_CFG],
 596                                               LQSPI_CFG_MODE_SHIFT,
 597                                               LQSPI_CFG_MODE_WIDTH));
 598         }
 599         /* dummy bytes */
 600         for (i = 0; i < (extract32(s->regs[R_LQSPI_CFG], LQSPI_CFG_DUMMY_SHIFT,
 601                                    LQSPI_CFG_DUMMY_WIDTH)); ++i) {
 602             DB_PRINT_L(0, "pushing dummy byte\n");
 603             fifo8_push(&s->tx_fifo, 0);
 604         }
 605         xilinx_spips_update_cs_lines(s);
 606         xilinx_spips_flush_txfifo(s);
 607         fifo8_reset(&s->rx_fifo);
 608
 609         DB_PRINT_L(0, "starting QSPI data read\n");
 610
 611         for (i = 0; i < LQSPI_CACHE_SIZE / 4; ++i) {
 612             tx_data_bytes(s, 0, 4);
 613             xilinx_spips_flush_txfifo(s);
 614             rx_data_bytes(s, &q->lqspi_buf[cache_entry], 4);
 615             cache_entry++;
 616         }
 617
 618         s->regs[R_LQSPI_STS] &= ~LQSPI_CFG_U_PAGE;
 619         s->regs[R_LQSPI_STS] |= u_page_save;
 620         xilinx_spips_update_cs_lines(s);
 621
 622         q->lqspi_cached_addr = addr;
 623         return lqspi_read(opaque, addr, size);
 624     }
 625 }
 626
 627 static const MemoryRegionOps lqspi_ops = {
 628     .read = lqspi_read,
 629     .endianness = DEVICE_NATIVE_ENDIAN,
 630     .valid = {
 631         .min_access_size = 4,
 632         .max_access_size = 4
 633     }
 634 };
 635
 636 static void xilinx_spips_realize(DeviceState *dev, Error **errp)
 637 {
 638     XilinxSPIPS *s = XILINX_SPIPS(dev);
 639     SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
 640     XilinxSPIPSClass *xsc = XILINX_SPIPS_GET_CLASS(s);
 641     int i;
 642
 643     DB_PRINT_L(0, "realized spips\n");
 644
 645     s->spi = g_new(SSIBus *, s->num_busses);
 646     for (i = 0; i < s->num_busses; ++i) {
 647         char bus_name[16];
 648         snprintf(bus_name, 16, "spi%d", i);
 649         s->spi[i] = ssi_create_bus(dev, bus_name);
 650     }
 651
 652     s->cs_lines = g_new0(qemu_irq, s->num_cs * s->num_busses);
 653     ssi_auto_connect_slaves(DEVICE(s), s->cs_lines, s->spi[0]);
 654     ssi_auto_connect_slaves(DEVICE(s), s->cs_lines, s->spi[1]);
 655     sysbus_init_irq(sbd, &s->irq);
 656     for (i = 0; i < s->num_cs * s->num_busses; ++i) {
 657         sysbus_init_irq(sbd, &s->cs_lines[i]);
 658     }
 659
 660     memory_region_init_io(&s->iomem, xsc->reg_ops, s, "spi", R_MAX*4);
 661     sysbus_init_mmio(sbd, &s->iomem);
 662
 663     s->irqline = -1;
 664
 665     fifo8_create(&s->rx_fifo, xsc->rx_fifo_size);
 666     fifo8_create(&s->tx_fifo, xsc->tx_fifo_size);
 667 }
 668
 669 static void xilinx_qspips_realize(DeviceState *dev, Error **errp)
 670 {
 671     XilinxSPIPS *s = XILINX_SPIPS(dev);
 672     XilinxQSPIPS *q = XILINX_QSPIPS(dev);
 673     SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
 674
 675     DB_PRINT_L(0, "realized qspips\n");
 676
 677     s->num_busses = 2;
 678     s->num_cs = 2;
 679     s->num_txrx_bytes = 4;
 680
 681     xilinx_spips_realize(dev, errp);
 682     memory_region_init_io(&s->mmlqspi, &lqspi_ops, s, "lqspi",
 683                           (1 << LQSPI_ADDRESS_BITS) * 2);
 684     sysbus_init_mmio(sbd, &s->mmlqspi);
 685
 686     q->lqspi_cached_addr = ~0ULL;
 687 }
 688
 689 static int xilinx_spips_post_load(void *opaque, int version_id)
 690 {
 691     xilinx_spips_update_ixr((XilinxSPIPS *)opaque);
 692     xilinx_spips_update_cs_lines((XilinxSPIPS *)opaque);
 693     return 0;
 694 }
 695
 696 static const VMStateDescription vmstate_xilinx_spips = {
 697     .name = "xilinx_spips",
 698     .version_id = 2,
 699     .minimum_version_id = 2,
 700     .minimum_version_id_old = 2,
 701     .post_load = xilinx_spips_post_load,
 702     .fields = (VMStateField[]) {
 703         VMSTATE_FIFO8(tx_fifo, XilinxSPIPS),
 704         VMSTATE_FIFO8(rx_fifo, XilinxSPIPS),
 705         VMSTATE_UINT32_ARRAY(regs, XilinxSPIPS, R_MAX),
 706         VMSTATE_UINT8(snoop_state, XilinxSPIPS),
 707         VMSTATE_END_OF_LIST()
 708     }
 709 };
 710
 711 static Property xilinx_spips_properties[] = {
 712     DEFINE_PROP_UINT8("num-busses", XilinxSPIPS, num_busses, 1),
 713     DEFINE_PROP_UINT8("num-ss-bits", XilinxSPIPS, num_cs, 4),
 714     DEFINE_PROP_UINT8("num-txrx-bytes", XilinxSPIPS, num_txrx_bytes, 1),
 715     DEFINE_PROP_END_OF_LIST(),
 716 };
 717
 718 static void xilinx_qspips_class_init(ObjectClass *klass, void * data)
 719 {
 720     DeviceClass *dc = DEVICE_CLASS(klass);
 721     XilinxSPIPSClass *xsc = XILINX_SPIPS_CLASS(klass);
 722
 723     dc->realize = xilinx_qspips_realize;
 724     xsc->reg_ops = &qspips_ops;
 725     xsc->rx_fifo_size = RXFF_A_Q;
 726     xsc->tx_fifo_size = TXFF_A_Q;
 727 }
 728
 729 static void xilinx_spips_class_init(ObjectClass *klass, void *data)
 730 {
 731     DeviceClass *dc = DEVICE_CLASS(klass);
 732     XilinxSPIPSClass *xsc = XILINX_SPIPS_CLASS(klass);
 733
 734     dc->realize = xilinx_spips_realize;
 735     dc->reset = xilinx_spips_reset;
 736     dc->props = xilinx_spips_properties;
 737     dc->vmsd = &vmstate_xilinx_spips;
 738
 739     xsc->reg_ops = &spips_ops;
 740     xsc->rx_fifo_size = RXFF_A;
 741     xsc->tx_fifo_size = TXFF_A;
 742 }
 743
 744 static const TypeInfo xilinx_spips_info = {
 745     .name  = TYPE_XILINX_SPIPS,
 746     .parent = TYPE_SYS_BUS_DEVICE,
 747     .instance_size  = sizeof(XilinxSPIPS),
 748     .class_init = xilinx_spips_class_init,
 749     .class_size = sizeof(XilinxSPIPSClass),
 750 };
 751
 752 static const TypeInfo xilinx_qspips_info = {
 753     .name  = TYPE_XILINX_QSPIPS,
 754     .parent = TYPE_XILINX_SPIPS,
 755     .instance_size  = sizeof(XilinxQSPIPS),
 756     .class_init = xilinx_qspips_class_init,
 757 };
 758
 759 static void xilinx_spips_register_types(void)
 760 {
 761     type_register_static(&xilinx_spips_info);
 762     type_register_static(&xilinx_qspips_info);
 763 }
 764
 765 type_init(xilinx_spips_register_types)