xref: /openbmc/qemu/hw/ssi/xilinx_spips.c (revision 3ae8a100)
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 "qemu/osdep.h"
26 #include "hw/sysbus.h"
27 #include "sysemu/sysemu.h"
28 #include "hw/ptimer.h"
29 #include "qemu/log.h"
30 #include "qemu/bitops.h"
31 #include "hw/ssi/xilinx_spips.h"
32 #include "qapi/error.h"
33 #include "hw/register.h"
34 #include "sysemu/dma.h"
35 #include "migration/blocker.h"
36 
37 #ifndef XILINX_SPIPS_ERR_DEBUG
38 #define XILINX_SPIPS_ERR_DEBUG 0
39 #endif
40 
41 #define DB_PRINT_L(level, ...) do { \
42     if (XILINX_SPIPS_ERR_DEBUG > (level)) { \
43         fprintf(stderr,  ": %s: ", __func__); \
44         fprintf(stderr, ## __VA_ARGS__); \
45     } \
46 } while (0)
47 
48 /* config register */
49 #define R_CONFIG            (0x00 / 4)
50 #define IFMODE              (1U << 31)
51 #define R_CONFIG_ENDIAN     (1 << 26)
52 #define MODEFAIL_GEN_EN     (1 << 17)
53 #define MAN_START_COM       (1 << 16)
54 #define MAN_START_EN        (1 << 15)
55 #define MANUAL_CS           (1 << 14)
56 #define CS                  (0xF << 10)
57 #define CS_SHIFT            (10)
58 #define PERI_SEL            (1 << 9)
59 #define REF_CLK             (1 << 8)
60 #define FIFO_WIDTH          (3 << 6)
61 #define BAUD_RATE_DIV       (7 << 3)
62 #define CLK_PH              (1 << 2)
63 #define CLK_POL             (1 << 1)
64 #define MODE_SEL            (1 << 0)
65 #define R_CONFIG_RSVD       (0x7bf40000)
66 
67 /* interrupt mechanism */
68 #define R_INTR_STATUS       (0x04 / 4)
69 #define R_INTR_STATUS_RESET (0x104)
70 #define R_INTR_EN           (0x08 / 4)
71 #define R_INTR_DIS          (0x0C / 4)
72 #define R_INTR_MASK         (0x10 / 4)
73 #define IXR_TX_FIFO_UNDERFLOW   (1 << 6)
74 /* Poll timeout not implemented */
75 #define IXR_RX_FIFO_EMPTY       (1 << 11)
76 #define IXR_GENERIC_FIFO_FULL   (1 << 10)
77 #define IXR_GENERIC_FIFO_NOT_FULL (1 << 9)
78 #define IXR_TX_FIFO_EMPTY       (1 << 8)
79 #define IXR_GENERIC_FIFO_EMPTY  (1 << 7)
80 #define IXR_RX_FIFO_FULL        (1 << 5)
81 #define IXR_RX_FIFO_NOT_EMPTY   (1 << 4)
82 #define IXR_TX_FIFO_FULL        (1 << 3)
83 #define IXR_TX_FIFO_NOT_FULL    (1 << 2)
84 #define IXR_TX_FIFO_MODE_FAIL   (1 << 1)
85 #define IXR_RX_FIFO_OVERFLOW    (1 << 0)
86 #define IXR_ALL                 ((1 << 13) - 1)
87 #define GQSPI_IXR_MASK          0xFBE
88 #define IXR_SELF_CLEAR \
89 (IXR_GENERIC_FIFO_EMPTY \
90 | IXR_GENERIC_FIFO_FULL  \
91 | IXR_GENERIC_FIFO_NOT_FULL \
92 | IXR_TX_FIFO_EMPTY \
93 | IXR_TX_FIFO_FULL  \
94 | IXR_TX_FIFO_NOT_FULL \
95 | IXR_RX_FIFO_EMPTY \
96 | IXR_RX_FIFO_FULL  \
97 | IXR_RX_FIFO_NOT_EMPTY)
98 
99 #define R_EN                (0x14 / 4)
100 #define R_DELAY             (0x18 / 4)
101 #define R_TX_DATA           (0x1C / 4)
102 #define R_RX_DATA           (0x20 / 4)
103 #define R_SLAVE_IDLE_COUNT  (0x24 / 4)
104 #define R_TX_THRES          (0x28 / 4)
105 #define R_RX_THRES          (0x2C / 4)
106 #define R_GPIO              (0x30 / 4)
107 #define R_LPBK_DLY_ADJ      (0x38 / 4)
108 #define R_LPBK_DLY_ADJ_RESET (0x33)
109 #define R_TXD1              (0x80 / 4)
110 #define R_TXD2              (0x84 / 4)
111 #define R_TXD3              (0x88 / 4)
112 
113 #define R_LQSPI_CFG         (0xa0 / 4)
114 #define R_LQSPI_CFG_RESET       0x03A002EB
115 #define LQSPI_CFG_LQ_MODE       (1U << 31)
116 #define LQSPI_CFG_TWO_MEM       (1 << 30)
117 #define LQSPI_CFG_SEP_BUS       (1 << 29)
118 #define LQSPI_CFG_U_PAGE        (1 << 28)
119 #define LQSPI_CFG_ADDR4         (1 << 27)
120 #define LQSPI_CFG_MODE_EN       (1 << 25)
121 #define LQSPI_CFG_MODE_WIDTH    8
122 #define LQSPI_CFG_MODE_SHIFT    16
123 #define LQSPI_CFG_DUMMY_WIDTH   3
124 #define LQSPI_CFG_DUMMY_SHIFT   8
125 #define LQSPI_CFG_INST_CODE     0xFF
126 
127 #define R_CMND        (0xc0 / 4)
128     #define R_CMND_RXFIFO_DRAIN   (1 << 19)
129     FIELD(CMND, PARTIAL_BYTE_LEN, 16, 3)
130 #define R_CMND_EXT_ADD        (1 << 15)
131     FIELD(CMND, RX_DISCARD, 8, 7)
132     FIELD(CMND, DUMMY_CYCLES, 2, 6)
133 #define R_CMND_DMA_EN         (1 << 1)
134 #define R_CMND_PUSH_WAIT      (1 << 0)
135 #define R_TRANSFER_SIZE     (0xc4 / 4)
136 #define R_LQSPI_STS         (0xA4 / 4)
137 #define LQSPI_STS_WR_RECVD      (1 << 1)
138 
139 #define R_MOD_ID            (0xFC / 4)
140 
141 #define R_GQSPI_SELECT          (0x144 / 4)
142     FIELD(GQSPI_SELECT, GENERIC_QSPI_EN, 0, 1)
143 #define R_GQSPI_ISR         (0x104 / 4)
144 #define R_GQSPI_IER         (0x108 / 4)
145 #define R_GQSPI_IDR         (0x10c / 4)
146 #define R_GQSPI_IMR         (0x110 / 4)
147 #define R_GQSPI_IMR_RESET   (0xfbe)
148 #define R_GQSPI_TX_THRESH   (0x128 / 4)
149 #define R_GQSPI_RX_THRESH   (0x12c / 4)
150 #define R_GQSPI_GPIO (0x130 / 4)
151 #define R_GQSPI_LPBK_DLY_ADJ (0x138 / 4)
152 #define R_GQSPI_LPBK_DLY_ADJ_RESET (0x33)
153 #define R_GQSPI_CNFG        (0x100 / 4)
154     FIELD(GQSPI_CNFG, MODE_EN, 30, 2)
155     FIELD(GQSPI_CNFG, GEN_FIFO_START_MODE, 29, 1)
156     FIELD(GQSPI_CNFG, GEN_FIFO_START, 28, 1)
157     FIELD(GQSPI_CNFG, ENDIAN, 26, 1)
158     /* Poll timeout not implemented */
159     FIELD(GQSPI_CNFG, EN_POLL_TIMEOUT, 20, 1)
160     /* QEMU doesnt care about any of these last three */
161     FIELD(GQSPI_CNFG, BR, 3, 3)
162     FIELD(GQSPI_CNFG, CPH, 2, 1)
163     FIELD(GQSPI_CNFG, CPL, 1, 1)
164 #define R_GQSPI_GEN_FIFO        (0x140 / 4)
165 #define R_GQSPI_TXD             (0x11c / 4)
166 #define R_GQSPI_RXD             (0x120 / 4)
167 #define R_GQSPI_FIFO_CTRL       (0x14c / 4)
168     FIELD(GQSPI_FIFO_CTRL, RX_FIFO_RESET, 2, 1)
169     FIELD(GQSPI_FIFO_CTRL, TX_FIFO_RESET, 1, 1)
170     FIELD(GQSPI_FIFO_CTRL, GENERIC_FIFO_RESET, 0, 1)
171 #define R_GQSPI_GFIFO_THRESH    (0x150 / 4)
172 #define R_GQSPI_DATA_STS (0x15c / 4)
173 /* We use the snapshot register to hold the core state for the currently
174  * or most recently executed command. So the generic fifo format is defined
175  * for the snapshot register
176  */
177 #define R_GQSPI_GF_SNAPSHOT (0x160 / 4)
178     FIELD(GQSPI_GF_SNAPSHOT, POLL, 19, 1)
179     FIELD(GQSPI_GF_SNAPSHOT, STRIPE, 18, 1)
180     FIELD(GQSPI_GF_SNAPSHOT, RECIEVE, 17, 1)
181     FIELD(GQSPI_GF_SNAPSHOT, TRANSMIT, 16, 1)
182     FIELD(GQSPI_GF_SNAPSHOT, DATA_BUS_SELECT, 14, 2)
183     FIELD(GQSPI_GF_SNAPSHOT, CHIP_SELECT, 12, 2)
184     FIELD(GQSPI_GF_SNAPSHOT, SPI_MODE, 10, 2)
185     FIELD(GQSPI_GF_SNAPSHOT, EXPONENT, 9, 1)
186     FIELD(GQSPI_GF_SNAPSHOT, DATA_XFER, 8, 1)
187     FIELD(GQSPI_GF_SNAPSHOT, IMMEDIATE_DATA, 0, 8)
188 #define R_GQSPI_MOD_ID        (0x1fc / 4)
189 #define R_GQSPI_MOD_ID_RESET  (0x10a0000)
190 
191 #define R_QSPIDMA_DST_CTRL         (0x80c / 4)
192 #define R_QSPIDMA_DST_CTRL_RESET   (0x803ffa00)
193 #define R_QSPIDMA_DST_I_MASK       (0x820 / 4)
194 #define R_QSPIDMA_DST_I_MASK_RESET (0xfe)
195 #define R_QSPIDMA_DST_CTRL2        (0x824 / 4)
196 #define R_QSPIDMA_DST_CTRL2_RESET  (0x081bfff8)
197 
198 /* size of TXRX FIFOs */
199 #define RXFF_A          (128)
200 #define TXFF_A          (128)
201 
202 #define RXFF_A_Q          (64 * 4)
203 #define TXFF_A_Q          (64 * 4)
204 
205 /* 16MB per linear region */
206 #define LQSPI_ADDRESS_BITS 24
207 
208 #define SNOOP_CHECKING 0xFF
209 #define SNOOP_ADDR 0xF0
210 #define SNOOP_NONE 0xEE
211 #define SNOOP_STRIPING 0
212 
213 #define MIN_NUM_BUSSES 1
214 #define MAX_NUM_BUSSES 2
215 
216 static inline int num_effective_busses(XilinxSPIPS *s)
217 {
218     return (s->regs[R_LQSPI_CFG] & LQSPI_CFG_SEP_BUS &&
219             s->regs[R_LQSPI_CFG] & LQSPI_CFG_TWO_MEM) ? s->num_busses : 1;
220 }
221 
222 static void xilinx_spips_update_cs(XilinxSPIPS *s, int field)
223 {
224     int i;
225 
226     for (i = 0; i < s->num_cs * s->num_busses; i++) {
227         bool old_state = s->cs_lines_state[i];
228         bool new_state = field & (1 << i);
229 
230         if (old_state != new_state) {
231             s->cs_lines_state[i] = new_state;
232             s->rx_discard = ARRAY_FIELD_EX32(s->regs, CMND, RX_DISCARD);
233             DB_PRINT_L(1, "%sselecting slave %d\n", new_state ? "" : "de", i);
234         }
235         qemu_set_irq(s->cs_lines[i], !new_state);
236     }
237     if (!(field & ((1 << (s->num_cs * s->num_busses)) - 1))) {
238         s->snoop_state = SNOOP_CHECKING;
239         s->cmd_dummies = 0;
240         s->link_state = 1;
241         s->link_state_next = 1;
242         s->link_state_next_when = 0;
243         DB_PRINT_L(1, "moving to snoop check state\n");
244     }
245 }
246 
247 static void xlnx_zynqmp_qspips_update_cs_lines(XlnxZynqMPQSPIPS *s)
248 {
249     if (s->regs[R_GQSPI_GF_SNAPSHOT]) {
250         int field = ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, CHIP_SELECT);
251         bool upper_cs_sel = field & (1 << 1);
252         bool lower_cs_sel = field & 1;
253         bool bus0_enabled;
254         bool bus1_enabled;
255         uint8_t buses;
256         int cs = 0;
257 
258         buses = ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, DATA_BUS_SELECT);
259         bus0_enabled = buses & 1;
260         bus1_enabled = buses & (1 << 1);
261 
262         if (bus0_enabled && bus1_enabled) {
263             if (lower_cs_sel) {
264                 cs |= 1;
265             }
266             if (upper_cs_sel) {
267                 cs |= 1 << 3;
268             }
269         } else if (bus0_enabled) {
270             if (lower_cs_sel) {
271                 cs |= 1;
272             }
273             if (upper_cs_sel) {
274                 cs |= 1 << 1;
275             }
276         } else if (bus1_enabled) {
277             if (lower_cs_sel) {
278                 cs |= 1 << 2;
279             }
280             if (upper_cs_sel) {
281                 cs |= 1 << 3;
282             }
283         }
284         xilinx_spips_update_cs(XILINX_SPIPS(s), cs);
285     }
286 }
287 
288 static void xilinx_spips_update_cs_lines(XilinxSPIPS *s)
289 {
290     int field = ~((s->regs[R_CONFIG] & CS) >> CS_SHIFT);
291 
292     /* In dual parallel, mirror low CS to both */
293     if (num_effective_busses(s) == 2) {
294         /* Single bit chip-select for qspi */
295         field &= 0x1;
296         field |= field << 3;
297     /* Dual stack U-Page */
298     } else if (s->regs[R_LQSPI_CFG] & LQSPI_CFG_TWO_MEM &&
299                s->regs[R_LQSPI_STS] & LQSPI_CFG_U_PAGE) {
300         /* Single bit chip-select for qspi */
301         field &= 0x1;
302         /* change from CS0 to CS1 */
303         field <<= 1;
304     }
305     /* Auto CS */
306     if (!(s->regs[R_CONFIG] & MANUAL_CS) &&
307         fifo8_is_empty(&s->tx_fifo)) {
308         field = 0;
309     }
310     xilinx_spips_update_cs(s, field);
311 }
312 
313 static void xilinx_spips_update_ixr(XilinxSPIPS *s)
314 {
315     if (!(s->regs[R_LQSPI_CFG] & LQSPI_CFG_LQ_MODE)) {
316         s->regs[R_INTR_STATUS] &= ~IXR_SELF_CLEAR;
317         s->regs[R_INTR_STATUS] |=
318             (fifo8_is_full(&s->rx_fifo) ? IXR_RX_FIFO_FULL : 0) |
319             (s->rx_fifo.num >= s->regs[R_RX_THRES] ?
320                                     IXR_RX_FIFO_NOT_EMPTY : 0) |
321             (fifo8_is_full(&s->tx_fifo) ? IXR_TX_FIFO_FULL : 0) |
322             (fifo8_is_empty(&s->tx_fifo) ? IXR_TX_FIFO_EMPTY : 0) |
323             (s->tx_fifo.num < s->regs[R_TX_THRES] ? IXR_TX_FIFO_NOT_FULL : 0);
324     }
325     int new_irqline = !!(s->regs[R_INTR_MASK] & s->regs[R_INTR_STATUS] &
326                                                                 IXR_ALL);
327     if (new_irqline != s->irqline) {
328         s->irqline = new_irqline;
329         qemu_set_irq(s->irq, s->irqline);
330     }
331 }
332 
333 static void xlnx_zynqmp_qspips_update_ixr(XlnxZynqMPQSPIPS *s)
334 {
335     uint32_t gqspi_int;
336     int new_irqline;
337 
338     s->regs[R_GQSPI_ISR] &= ~IXR_SELF_CLEAR;
339     s->regs[R_GQSPI_ISR] |=
340         (fifo32_is_empty(&s->fifo_g) ? IXR_GENERIC_FIFO_EMPTY : 0) |
341         (fifo32_is_full(&s->fifo_g) ? IXR_GENERIC_FIFO_FULL : 0) |
342         (s->fifo_g.fifo.num < s->regs[R_GQSPI_GFIFO_THRESH] ?
343                                     IXR_GENERIC_FIFO_NOT_FULL : 0) |
344         (fifo8_is_empty(&s->rx_fifo_g) ? IXR_RX_FIFO_EMPTY : 0) |
345         (fifo8_is_full(&s->rx_fifo_g) ? IXR_RX_FIFO_FULL : 0) |
346         (s->rx_fifo_g.num >= s->regs[R_GQSPI_RX_THRESH] ?
347                                     IXR_RX_FIFO_NOT_EMPTY : 0) |
348         (fifo8_is_empty(&s->tx_fifo_g) ? IXR_TX_FIFO_EMPTY : 0) |
349         (fifo8_is_full(&s->tx_fifo_g) ? IXR_TX_FIFO_FULL : 0) |
350         (s->tx_fifo_g.num < s->regs[R_GQSPI_TX_THRESH] ?
351                                     IXR_TX_FIFO_NOT_FULL : 0);
352 
353     /* GQSPI Interrupt Trigger Status */
354     gqspi_int = (~s->regs[R_GQSPI_IMR]) & s->regs[R_GQSPI_ISR] & GQSPI_IXR_MASK;
355     new_irqline = !!(gqspi_int & IXR_ALL);
356 
357     /* drive external interrupt pin */
358     if (new_irqline != s->gqspi_irqline) {
359         s->gqspi_irqline = new_irqline;
360         qemu_set_irq(XILINX_SPIPS(s)->irq, s->gqspi_irqline);
361     }
362 }
363 
364 static void xilinx_spips_reset(DeviceState *d)
365 {
366     XilinxSPIPS *s = XILINX_SPIPS(d);
367 
368     memset(s->regs, 0, sizeof(s->regs));
369 
370     fifo8_reset(&s->rx_fifo);
371     fifo8_reset(&s->rx_fifo);
372     /* non zero resets */
373     s->regs[R_CONFIG] |= MODEFAIL_GEN_EN;
374     s->regs[R_SLAVE_IDLE_COUNT] = 0xFF;
375     s->regs[R_TX_THRES] = 1;
376     s->regs[R_RX_THRES] = 1;
377     /* FIXME: move magic number definition somewhere sensible */
378     s->regs[R_MOD_ID] = 0x01090106;
379     s->regs[R_LQSPI_CFG] = R_LQSPI_CFG_RESET;
380     s->link_state = 1;
381     s->link_state_next = 1;
382     s->link_state_next_when = 0;
383     s->snoop_state = SNOOP_CHECKING;
384     s->cmd_dummies = 0;
385     s->man_start_com = false;
386     xilinx_spips_update_ixr(s);
387     xilinx_spips_update_cs_lines(s);
388 }
389 
390 static void xlnx_zynqmp_qspips_reset(DeviceState *d)
391 {
392     XlnxZynqMPQSPIPS *s = XLNX_ZYNQMP_QSPIPS(d);
393 
394     xilinx_spips_reset(d);
395 
396     memset(s->regs, 0, sizeof(s->regs));
397 
398     fifo8_reset(&s->rx_fifo_g);
399     fifo8_reset(&s->rx_fifo_g);
400     fifo32_reset(&s->fifo_g);
401     s->regs[R_INTR_STATUS] = R_INTR_STATUS_RESET;
402     s->regs[R_GPIO] = 1;
403     s->regs[R_LPBK_DLY_ADJ] = R_LPBK_DLY_ADJ_RESET;
404     s->regs[R_GQSPI_GFIFO_THRESH] = 0x10;
405     s->regs[R_MOD_ID] = 0x01090101;
406     s->regs[R_GQSPI_IMR] = R_GQSPI_IMR_RESET;
407     s->regs[R_GQSPI_TX_THRESH] = 1;
408     s->regs[R_GQSPI_RX_THRESH] = 1;
409     s->regs[R_GQSPI_GPIO] = 1;
410     s->regs[R_GQSPI_LPBK_DLY_ADJ] = R_GQSPI_LPBK_DLY_ADJ_RESET;
411     s->regs[R_GQSPI_MOD_ID] = R_GQSPI_MOD_ID_RESET;
412     s->regs[R_QSPIDMA_DST_CTRL] = R_QSPIDMA_DST_CTRL_RESET;
413     s->regs[R_QSPIDMA_DST_I_MASK] = R_QSPIDMA_DST_I_MASK_RESET;
414     s->regs[R_QSPIDMA_DST_CTRL2] = R_QSPIDMA_DST_CTRL2_RESET;
415     s->man_start_com_g = false;
416     s->gqspi_irqline = 0;
417     xlnx_zynqmp_qspips_update_ixr(s);
418 }
419 
420 /* N way (num) in place bit striper. Lay out row wise bits (MSB to LSB)
421  * column wise (from element 0 to N-1). num is the length of x, and dir
422  * reverses the direction of the transform. Best illustrated by example:
423  * Each digit in the below array is a single bit (num == 3):
424  *
425  * {{ 76543210, }  ----- stripe (dir == false) -----> {{ 741gdaFC, }
426  *  { hgfedcba, }                                      { 630fcHEB, }
427  *  { HGFEDCBA, }} <---- upstripe (dir == true) -----  { 52hebGDA, }}
428  */
429 
430 static inline void stripe8(uint8_t *x, int num, bool dir)
431 {
432     uint8_t r[num];
433     memset(r, 0, sizeof(uint8_t) * num);
434     int idx[2] = {0, 0};
435     int bit[2] = {0, 7};
436     int d = dir;
437 
438     for (idx[0] = 0; idx[0] < num; ++idx[0]) {
439         for (bit[0] = 7; bit[0] >= 0; bit[0]--) {
440             r[idx[!d]] |= x[idx[d]] & 1 << bit[d] ? 1 << bit[!d] : 0;
441             idx[1] = (idx[1] + 1) % num;
442             if (!idx[1]) {
443                 bit[1]--;
444             }
445         }
446     }
447     memcpy(x, r, sizeof(uint8_t) * num);
448 }
449 
450 static void xlnx_zynqmp_qspips_flush_fifo_g(XlnxZynqMPQSPIPS *s)
451 {
452     while (s->regs[R_GQSPI_DATA_STS] || !fifo32_is_empty(&s->fifo_g)) {
453         uint8_t tx_rx[2] = { 0 };
454         int num_stripes = 1;
455         uint8_t busses;
456         int i;
457 
458         if (!s->regs[R_GQSPI_DATA_STS]) {
459             uint8_t imm;
460 
461             s->regs[R_GQSPI_GF_SNAPSHOT] = fifo32_pop(&s->fifo_g);
462             DB_PRINT_L(0, "GQSPI command: %x\n", s->regs[R_GQSPI_GF_SNAPSHOT]);
463             if (!s->regs[R_GQSPI_GF_SNAPSHOT]) {
464                 DB_PRINT_L(0, "Dummy GQSPI Delay Command Entry, Do nothing");
465                 continue;
466             }
467             xlnx_zynqmp_qspips_update_cs_lines(s);
468 
469             imm = ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, IMMEDIATE_DATA);
470             if (!ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, DATA_XFER)) {
471                 /* immedate transfer */
472                 if (ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, TRANSMIT) ||
473                     ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, RECIEVE)) {
474                     s->regs[R_GQSPI_DATA_STS] = 1;
475                 /* CS setup/hold - do nothing */
476                 } else {
477                     s->regs[R_GQSPI_DATA_STS] = 0;
478                 }
479             } else if (ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, EXPONENT)) {
480                 if (imm > 31) {
481                     qemu_log_mask(LOG_UNIMP, "QSPI exponential transfer too"
482                                   " long - 2 ^ %" PRId8 " requested\n", imm);
483                 }
484                 s->regs[R_GQSPI_DATA_STS] = 1ul << imm;
485             } else {
486                 s->regs[R_GQSPI_DATA_STS] = imm;
487             }
488         }
489         /* Zero length transfer check */
490         if (!s->regs[R_GQSPI_DATA_STS]) {
491             continue;
492         }
493         if (ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, RECIEVE) &&
494             fifo8_is_full(&s->rx_fifo_g)) {
495             /* No space in RX fifo for transfer - try again later */
496             return;
497         }
498         if (ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, STRIPE) &&
499             (ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, TRANSMIT) ||
500              ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, RECIEVE))) {
501             num_stripes = 2;
502         }
503         if (!ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, DATA_XFER)) {
504             tx_rx[0] = ARRAY_FIELD_EX32(s->regs,
505                                         GQSPI_GF_SNAPSHOT, IMMEDIATE_DATA);
506         } else if (ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, TRANSMIT)) {
507             for (i = 0; i < num_stripes; ++i) {
508                 if (!fifo8_is_empty(&s->tx_fifo_g)) {
509                     tx_rx[i] = fifo8_pop(&s->tx_fifo_g);
510                     s->tx_fifo_g_align++;
511                 } else {
512                     return;
513                 }
514             }
515         }
516         if (num_stripes == 1) {
517             /* mirror */
518             tx_rx[1] = tx_rx[0];
519         }
520         busses = ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, DATA_BUS_SELECT);
521         for (i = 0; i < 2; ++i) {
522             DB_PRINT_L(1, "bus %d tx = %02x\n", i, tx_rx[i]);
523             tx_rx[i] = ssi_transfer(XILINX_SPIPS(s)->spi[i], tx_rx[i]);
524             DB_PRINT_L(1, "bus %d rx = %02x\n", i, tx_rx[i]);
525         }
526         if (s->regs[R_GQSPI_DATA_STS] > 1 &&
527             busses == 0x3 && num_stripes == 2) {
528             s->regs[R_GQSPI_DATA_STS] -= 2;
529         } else if (s->regs[R_GQSPI_DATA_STS] > 0) {
530             s->regs[R_GQSPI_DATA_STS]--;
531         }
532         if (ARRAY_FIELD_EX32(s->regs, GQSPI_GF_SNAPSHOT, RECIEVE)) {
533             for (i = 0; i < 2; ++i) {
534                 if (busses & (1 << i)) {
535                     DB_PRINT_L(1, "bus %d push_byte = %02x\n", i, tx_rx[i]);
536                     fifo8_push(&s->rx_fifo_g, tx_rx[i]);
537                     s->rx_fifo_g_align++;
538                 }
539             }
540         }
541         if (!s->regs[R_GQSPI_DATA_STS]) {
542             for (; s->tx_fifo_g_align % 4; s->tx_fifo_g_align++) {
543                 fifo8_pop(&s->tx_fifo_g);
544             }
545             for (; s->rx_fifo_g_align % 4; s->rx_fifo_g_align++) {
546                 fifo8_push(&s->rx_fifo_g, 0);
547             }
548         }
549     }
550 }
551 
552 static int xilinx_spips_num_dummies(XilinxQSPIPS *qs, uint8_t command)
553 {
554     if (!qs) {
555         /* The SPI device is not a QSPI device */
556         return -1;
557     }
558 
559     switch (command) { /* check for dummies */
560     case READ: /* no dummy bytes/cycles */
561     case PP:
562     case DPP:
563     case QPP:
564     case READ_4:
565     case PP_4:
566     case QPP_4:
567         return 0;
568     case FAST_READ:
569     case DOR:
570     case QOR:
571     case DOR_4:
572     case QOR_4:
573         return 1;
574     case DIOR:
575     case FAST_READ_4:
576     case DIOR_4:
577         return 2;
578     case QIOR:
579     case QIOR_4:
580         return 4;
581     default:
582         return -1;
583     }
584 }
585 
586 static inline uint8_t get_addr_length(XilinxSPIPS *s, uint8_t cmd)
587 {
588    switch (cmd) {
589    case PP_4:
590    case QPP_4:
591    case READ_4:
592    case QIOR_4:
593    case FAST_READ_4:
594    case DOR_4:
595    case QOR_4:
596    case DIOR_4:
597        return 4;
598    default:
599        return (s->regs[R_CMND] & R_CMND_EXT_ADD) ? 4 : 3;
600    }
601 }
602 
603 static void xilinx_spips_flush_txfifo(XilinxSPIPS *s)
604 {
605     int debug_level = 0;
606     XilinxQSPIPS *q = (XilinxQSPIPS *) object_dynamic_cast(OBJECT(s),
607                                                            TYPE_XILINX_QSPIPS);
608 
609     for (;;) {
610         int i;
611         uint8_t tx = 0;
612         uint8_t tx_rx[MAX_NUM_BUSSES] = { 0 };
613         uint8_t dummy_cycles = 0;
614         uint8_t addr_length;
615 
616         if (fifo8_is_empty(&s->tx_fifo)) {
617             xilinx_spips_update_ixr(s);
618             return;
619         } else if (s->snoop_state == SNOOP_STRIPING ||
620                    s->snoop_state == SNOOP_NONE) {
621             for (i = 0; i < num_effective_busses(s); ++i) {
622                 tx_rx[i] = fifo8_pop(&s->tx_fifo);
623             }
624             stripe8(tx_rx, num_effective_busses(s), false);
625         } else if (s->snoop_state >= SNOOP_ADDR) {
626             tx = fifo8_pop(&s->tx_fifo);
627             for (i = 0; i < num_effective_busses(s); ++i) {
628                 tx_rx[i] = tx;
629             }
630         } else {
631             /* Extract a dummy byte and generate dummy cycles according to the
632              * link state */
633             tx = fifo8_pop(&s->tx_fifo);
634             dummy_cycles = 8 / s->link_state;
635         }
636 
637         for (i = 0; i < num_effective_busses(s); ++i) {
638             int bus = num_effective_busses(s) - 1 - i;
639             if (dummy_cycles) {
640                 int d;
641                 for (d = 0; d < dummy_cycles; ++d) {
642                     tx_rx[0] = ssi_transfer(s->spi[bus], (uint32_t)tx_rx[0]);
643                 }
644             } else {
645                 DB_PRINT_L(debug_level, "tx = %02x\n", tx_rx[i]);
646                 tx_rx[i] = ssi_transfer(s->spi[bus], (uint32_t)tx_rx[i]);
647                 DB_PRINT_L(debug_level, "rx = %02x\n", tx_rx[i]);
648             }
649         }
650 
651         if (s->regs[R_CMND] & R_CMND_RXFIFO_DRAIN) {
652             DB_PRINT_L(debug_level, "dircarding drained rx byte\n");
653             /* Do nothing */
654         } else if (s->rx_discard) {
655             DB_PRINT_L(debug_level, "dircarding discarded rx byte\n");
656             s->rx_discard -= 8 / s->link_state;
657         } else if (fifo8_is_full(&s->rx_fifo)) {
658             s->regs[R_INTR_STATUS] |= IXR_RX_FIFO_OVERFLOW;
659             DB_PRINT_L(0, "rx FIFO overflow");
660         } else if (s->snoop_state == SNOOP_STRIPING) {
661             stripe8(tx_rx, num_effective_busses(s), true);
662             for (i = 0; i < num_effective_busses(s); ++i) {
663                 fifo8_push(&s->rx_fifo, (uint8_t)tx_rx[i]);
664                 DB_PRINT_L(debug_level, "pushing striped rx byte\n");
665             }
666         } else {
667            DB_PRINT_L(debug_level, "pushing unstriped rx byte\n");
668            fifo8_push(&s->rx_fifo, (uint8_t)tx_rx[0]);
669         }
670 
671         if (s->link_state_next_when) {
672             s->link_state_next_when--;
673             if (!s->link_state_next_when) {
674                 s->link_state = s->link_state_next;
675             }
676         }
677 
678         DB_PRINT_L(debug_level, "initial snoop state: %x\n",
679                    (unsigned)s->snoop_state);
680         switch (s->snoop_state) {
681         case (SNOOP_CHECKING):
682             /* Store the count of dummy bytes in the txfifo */
683             s->cmd_dummies = xilinx_spips_num_dummies(q, tx);
684             addr_length = get_addr_length(s, tx);
685             if (s->cmd_dummies < 0) {
686                 s->snoop_state = SNOOP_NONE;
687             } else {
688                 s->snoop_state = SNOOP_ADDR + addr_length - 1;
689             }
690             switch (tx) {
691             case DPP:
692             case DOR:
693             case DOR_4:
694                 s->link_state_next = 2;
695                 s->link_state_next_when = addr_length + s->cmd_dummies;
696                 break;
697             case QPP:
698             case QPP_4:
699             case QOR:
700             case QOR_4:
701                 s->link_state_next = 4;
702                 s->link_state_next_when = addr_length + s->cmd_dummies;
703                 break;
704             case DIOR:
705             case DIOR_4:
706                 s->link_state = 2;
707                 break;
708             case QIOR:
709             case QIOR_4:
710                 s->link_state = 4;
711                 break;
712             }
713             break;
714         case (SNOOP_ADDR):
715             /* Address has been transmitted, transmit dummy cycles now if
716              * needed */
717             if (s->cmd_dummies < 0) {
718                 s->snoop_state = SNOOP_NONE;
719             } else {
720                 s->snoop_state = s->cmd_dummies;
721             }
722             break;
723         case (SNOOP_STRIPING):
724         case (SNOOP_NONE):
725             /* Once we hit the boring stuff - squelch debug noise */
726             if (!debug_level) {
727                 DB_PRINT_L(0, "squelching debug info ....\n");
728                 debug_level = 1;
729             }
730             break;
731         default:
732             s->snoop_state--;
733         }
734         DB_PRINT_L(debug_level, "final snoop state: %x\n",
735                    (unsigned)s->snoop_state);
736     }
737 }
738 
739 static inline void tx_data_bytes(Fifo8 *fifo, uint32_t value, int num, bool be)
740 {
741     int i;
742     for (i = 0; i < num && !fifo8_is_full(fifo); ++i) {
743         if (be) {
744             fifo8_push(fifo, (uint8_t)(value >> 24));
745             value <<= 8;
746         } else {
747             fifo8_push(fifo, (uint8_t)value);
748             value >>= 8;
749         }
750     }
751 }
752 
753 static void xilinx_spips_check_zero_pump(XilinxSPIPS *s)
754 {
755     if (!s->regs[R_TRANSFER_SIZE]) {
756         return;
757     }
758     if (!fifo8_is_empty(&s->tx_fifo) && s->regs[R_CMND] & R_CMND_PUSH_WAIT) {
759         return;
760     }
761     /*
762      * The zero pump must never fill tx fifo such that rx overflow is
763      * possible
764      */
765     while (s->regs[R_TRANSFER_SIZE] &&
766            s->rx_fifo.num + s->tx_fifo.num < RXFF_A_Q - 3) {
767         /* endianess just doesn't matter when zero pumping */
768         tx_data_bytes(&s->tx_fifo, 0, 4, false);
769         s->regs[R_TRANSFER_SIZE] &= ~0x03ull;
770         s->regs[R_TRANSFER_SIZE] -= 4;
771     }
772 }
773 
774 static void xilinx_spips_check_flush(XilinxSPIPS *s)
775 {
776     if (s->man_start_com ||
777         (!fifo8_is_empty(&s->tx_fifo) &&
778          !(s->regs[R_CONFIG] & MAN_START_EN))) {
779         xilinx_spips_check_zero_pump(s);
780         xilinx_spips_flush_txfifo(s);
781     }
782     if (fifo8_is_empty(&s->tx_fifo) && !s->regs[R_TRANSFER_SIZE]) {
783         s->man_start_com = false;
784     }
785     xilinx_spips_update_ixr(s);
786 }
787 
788 static void xlnx_zynqmp_qspips_check_flush(XlnxZynqMPQSPIPS *s)
789 {
790     bool gqspi_has_work = s->regs[R_GQSPI_DATA_STS] ||
791                           !fifo32_is_empty(&s->fifo_g);
792 
793     if (ARRAY_FIELD_EX32(s->regs, GQSPI_SELECT, GENERIC_QSPI_EN)) {
794         if (s->man_start_com_g || (gqspi_has_work &&
795              !ARRAY_FIELD_EX32(s->regs, GQSPI_CNFG, GEN_FIFO_START_MODE))) {
796             xlnx_zynqmp_qspips_flush_fifo_g(s);
797         }
798     } else {
799         xilinx_spips_check_flush(XILINX_SPIPS(s));
800     }
801     if (!gqspi_has_work) {
802         s->man_start_com_g = false;
803     }
804     xlnx_zynqmp_qspips_update_ixr(s);
805 }
806 
807 static inline int rx_data_bytes(Fifo8 *fifo, uint8_t *value, int max)
808 {
809     int i;
810 
811     for (i = 0; i < max && !fifo8_is_empty(fifo); ++i) {
812         value[i] = fifo8_pop(fifo);
813     }
814     return max - i;
815 }
816 
817 static const void *pop_buf(Fifo8 *fifo, uint32_t max, uint32_t *num)
818 {
819     void *ret;
820 
821     if (max == 0 || max > fifo->num) {
822         abort();
823     }
824     *num = MIN(fifo->capacity - fifo->head, max);
825     ret = &fifo->data[fifo->head];
826     fifo->head += *num;
827     fifo->head %= fifo->capacity;
828     fifo->num -= *num;
829     return ret;
830 }
831 
832 static void xlnx_zynqmp_qspips_notify(void *opaque)
833 {
834     XlnxZynqMPQSPIPS *rq = XLNX_ZYNQMP_QSPIPS(opaque);
835     XilinxSPIPS *s = XILINX_SPIPS(rq);
836     Fifo8 *recv_fifo;
837 
838     if (ARRAY_FIELD_EX32(rq->regs, GQSPI_SELECT, GENERIC_QSPI_EN)) {
839         if (!(ARRAY_FIELD_EX32(rq->regs, GQSPI_CNFG, MODE_EN) == 2)) {
840             return;
841         }
842         recv_fifo = &rq->rx_fifo_g;
843     } else {
844         if (!(s->regs[R_CMND] & R_CMND_DMA_EN)) {
845             return;
846         }
847         recv_fifo = &s->rx_fifo;
848     }
849     while (recv_fifo->num >= 4
850            && stream_can_push(rq->dma, xlnx_zynqmp_qspips_notify, rq))
851     {
852         size_t ret;
853         uint32_t num;
854         const void *rxd = pop_buf(recv_fifo, 4, &num);
855 
856         memcpy(rq->dma_buf, rxd, num);
857 
858         ret = stream_push(rq->dma, rq->dma_buf, 4);
859         assert(ret == 4);
860         xlnx_zynqmp_qspips_check_flush(rq);
861     }
862 }
863 
864 static uint64_t xilinx_spips_read(void *opaque, hwaddr addr,
865                                                         unsigned size)
866 {
867     XilinxSPIPS *s = opaque;
868     uint32_t mask = ~0;
869     uint32_t ret;
870     uint8_t rx_buf[4];
871     int shortfall;
872 
873     addr >>= 2;
874     switch (addr) {
875     case R_CONFIG:
876         mask = ~(R_CONFIG_RSVD | MAN_START_COM);
877         break;
878     case R_INTR_STATUS:
879         ret = s->regs[addr] & IXR_ALL;
880         s->regs[addr] = 0;
881         DB_PRINT_L(0, "addr=" TARGET_FMT_plx " = %x\n", addr * 4, ret);
882         xilinx_spips_update_ixr(s);
883         return ret;
884     case R_INTR_MASK:
885         mask = IXR_ALL;
886         break;
887     case  R_EN:
888         mask = 0x1;
889         break;
890     case R_SLAVE_IDLE_COUNT:
891         mask = 0xFF;
892         break;
893     case R_MOD_ID:
894         mask = 0x01FFFFFF;
895         break;
896     case R_INTR_EN:
897     case R_INTR_DIS:
898     case R_TX_DATA:
899         mask = 0;
900         break;
901     case R_RX_DATA:
902         memset(rx_buf, 0, sizeof(rx_buf));
903         shortfall = rx_data_bytes(&s->rx_fifo, rx_buf, s->num_txrx_bytes);
904         ret = s->regs[R_CONFIG] & R_CONFIG_ENDIAN ?
905                         cpu_to_be32(*(uint32_t *)rx_buf) :
906                         cpu_to_le32(*(uint32_t *)rx_buf);
907         if (!(s->regs[R_CONFIG] & R_CONFIG_ENDIAN)) {
908             ret <<= 8 * shortfall;
909         }
910         DB_PRINT_L(0, "addr=" TARGET_FMT_plx " = %x\n", addr * 4, ret);
911         xilinx_spips_check_flush(s);
912         xilinx_spips_update_ixr(s);
913         return ret;
914     }
915     DB_PRINT_L(0, "addr=" TARGET_FMT_plx " = %x\n", addr * 4,
916                s->regs[addr] & mask);
917     return s->regs[addr] & mask;
918 
919 }
920 
921 static uint64_t xlnx_zynqmp_qspips_read(void *opaque,
922                                         hwaddr addr, unsigned size)
923 {
924     XlnxZynqMPQSPIPS *s = XLNX_ZYNQMP_QSPIPS(opaque);
925     uint32_t reg = addr / 4;
926     uint32_t ret;
927     uint8_t rx_buf[4];
928     int shortfall;
929 
930     if (reg <= R_MOD_ID) {
931         return xilinx_spips_read(opaque, addr, size);
932     } else {
933         switch (reg) {
934         case R_GQSPI_RXD:
935             if (fifo8_is_empty(&s->rx_fifo_g)) {
936                 qemu_log_mask(LOG_GUEST_ERROR,
937                               "Read from empty GQSPI RX FIFO\n");
938                 return 0;
939             }
940             memset(rx_buf, 0, sizeof(rx_buf));
941             shortfall = rx_data_bytes(&s->rx_fifo_g, rx_buf,
942                                       XILINX_SPIPS(s)->num_txrx_bytes);
943             ret = ARRAY_FIELD_EX32(s->regs, GQSPI_CNFG, ENDIAN) ?
944                   cpu_to_be32(*(uint32_t *)rx_buf) :
945                   cpu_to_le32(*(uint32_t *)rx_buf);
946             if (!ARRAY_FIELD_EX32(s->regs, GQSPI_CNFG, ENDIAN)) {
947                 ret <<= 8 * shortfall;
948             }
949             xlnx_zynqmp_qspips_check_flush(s);
950             xlnx_zynqmp_qspips_update_ixr(s);
951             return ret;
952         default:
953             return s->regs[reg];
954         }
955     }
956 }
957 
958 static void xilinx_spips_write(void *opaque, hwaddr addr,
959                                         uint64_t value, unsigned size)
960 {
961     int mask = ~0;
962     XilinxSPIPS *s = opaque;
963 
964     DB_PRINT_L(0, "addr=" TARGET_FMT_plx " = %x\n", addr, (unsigned)value);
965     addr >>= 2;
966     switch (addr) {
967     case R_CONFIG:
968         mask = ~(R_CONFIG_RSVD | MAN_START_COM);
969         if ((value & MAN_START_COM) && (s->regs[R_CONFIG] & MAN_START_EN)) {
970             s->man_start_com = true;
971         }
972         break;
973     case R_INTR_STATUS:
974         mask = IXR_ALL;
975         s->regs[R_INTR_STATUS] &= ~(mask & value);
976         goto no_reg_update;
977     case R_INTR_DIS:
978         mask = IXR_ALL;
979         s->regs[R_INTR_MASK] &= ~(mask & value);
980         goto no_reg_update;
981     case R_INTR_EN:
982         mask = IXR_ALL;
983         s->regs[R_INTR_MASK] |= mask & value;
984         goto no_reg_update;
985     case R_EN:
986         mask = 0x1;
987         break;
988     case R_SLAVE_IDLE_COUNT:
989         mask = 0xFF;
990         break;
991     case R_RX_DATA:
992     case R_INTR_MASK:
993     case R_MOD_ID:
994         mask = 0;
995         break;
996     case R_TX_DATA:
997         tx_data_bytes(&s->tx_fifo, (uint32_t)value, s->num_txrx_bytes,
998                       s->regs[R_CONFIG] & R_CONFIG_ENDIAN);
999         goto no_reg_update;
1000     case R_TXD1:
1001         tx_data_bytes(&s->tx_fifo, (uint32_t)value, 1,
1002                       s->regs[R_CONFIG] & R_CONFIG_ENDIAN);
1003         goto no_reg_update;
1004     case R_TXD2:
1005         tx_data_bytes(&s->tx_fifo, (uint32_t)value, 2,
1006                       s->regs[R_CONFIG] & R_CONFIG_ENDIAN);
1007         goto no_reg_update;
1008     case R_TXD3:
1009         tx_data_bytes(&s->tx_fifo, (uint32_t)value, 3,
1010                       s->regs[R_CONFIG] & R_CONFIG_ENDIAN);
1011         goto no_reg_update;
1012     }
1013     s->regs[addr] = (s->regs[addr] & ~mask) | (value & mask);
1014 no_reg_update:
1015     xilinx_spips_update_cs_lines(s);
1016     xilinx_spips_check_flush(s);
1017     xilinx_spips_update_cs_lines(s);
1018     xilinx_spips_update_ixr(s);
1019 }
1020 
1021 static const MemoryRegionOps spips_ops = {
1022     .read = xilinx_spips_read,
1023     .write = xilinx_spips_write,
1024     .endianness = DEVICE_LITTLE_ENDIAN,
1025 };
1026 
1027 static void xilinx_qspips_invalidate_mmio_ptr(XilinxQSPIPS *q)
1028 {
1029     XilinxSPIPS *s = &q->parent_obj;
1030 
1031     if ((q->mmio_execution_enabled) && (q->lqspi_cached_addr != ~0ULL)) {
1032         /* Invalidate the current mapped mmio */
1033         memory_region_invalidate_mmio_ptr(&s->mmlqspi, q->lqspi_cached_addr,
1034                                           LQSPI_CACHE_SIZE);
1035     }
1036 
1037     q->lqspi_cached_addr = ~0ULL;
1038 }
1039 
1040 static void xilinx_qspips_write(void *opaque, hwaddr addr,
1041                                 uint64_t value, unsigned size)
1042 {
1043     XilinxQSPIPS *q = XILINX_QSPIPS(opaque);
1044     XilinxSPIPS *s = XILINX_SPIPS(opaque);
1045 
1046     xilinx_spips_write(opaque, addr, value, size);
1047     addr >>= 2;
1048 
1049     if (addr == R_LQSPI_CFG) {
1050         xilinx_qspips_invalidate_mmio_ptr(q);
1051     }
1052     if (s->regs[R_CMND] & R_CMND_RXFIFO_DRAIN) {
1053         fifo8_reset(&s->rx_fifo);
1054     }
1055 }
1056 
1057 static void xlnx_zynqmp_qspips_write(void *opaque, hwaddr addr,
1058                                         uint64_t value, unsigned size)
1059 {
1060     XlnxZynqMPQSPIPS *s = XLNX_ZYNQMP_QSPIPS(opaque);
1061     uint32_t reg = addr / 4;
1062 
1063     if (reg <= R_MOD_ID) {
1064         xilinx_qspips_write(opaque, addr, value, size);
1065     } else {
1066         switch (reg) {
1067         case R_GQSPI_CNFG:
1068             if (FIELD_EX32(value, GQSPI_CNFG, GEN_FIFO_START) &&
1069                 ARRAY_FIELD_EX32(s->regs, GQSPI_CNFG, GEN_FIFO_START_MODE)) {
1070                 s->man_start_com_g = true;
1071             }
1072             s->regs[reg] = value & ~(R_GQSPI_CNFG_GEN_FIFO_START_MASK);
1073             break;
1074         case R_GQSPI_GEN_FIFO:
1075             if (!fifo32_is_full(&s->fifo_g)) {
1076                 fifo32_push(&s->fifo_g, value);
1077             }
1078             break;
1079         case R_GQSPI_TXD:
1080             tx_data_bytes(&s->tx_fifo_g, (uint32_t)value, 4,
1081                           ARRAY_FIELD_EX32(s->regs, GQSPI_CNFG, ENDIAN));
1082             break;
1083         case R_GQSPI_FIFO_CTRL:
1084             if (FIELD_EX32(value, GQSPI_FIFO_CTRL, GENERIC_FIFO_RESET)) {
1085                 fifo32_reset(&s->fifo_g);
1086             }
1087             if (FIELD_EX32(value, GQSPI_FIFO_CTRL, TX_FIFO_RESET)) {
1088                 fifo8_reset(&s->tx_fifo_g);
1089             }
1090             if (FIELD_EX32(value, GQSPI_FIFO_CTRL, RX_FIFO_RESET)) {
1091                 fifo8_reset(&s->rx_fifo_g);
1092             }
1093             break;
1094         case R_GQSPI_IDR:
1095             s->regs[R_GQSPI_IMR] |= value;
1096             break;
1097         case R_GQSPI_IER:
1098             s->regs[R_GQSPI_IMR] &= ~value;
1099             break;
1100         case R_GQSPI_ISR:
1101             s->regs[R_GQSPI_ISR] &= ~value;
1102             break;
1103         case R_GQSPI_IMR:
1104         case R_GQSPI_RXD:
1105         case R_GQSPI_GF_SNAPSHOT:
1106         case R_GQSPI_MOD_ID:
1107             break;
1108         default:
1109             s->regs[reg] = value;
1110             break;
1111         }
1112         xlnx_zynqmp_qspips_update_cs_lines(s);
1113         xlnx_zynqmp_qspips_check_flush(s);
1114         xlnx_zynqmp_qspips_update_cs_lines(s);
1115         xlnx_zynqmp_qspips_update_ixr(s);
1116     }
1117     xlnx_zynqmp_qspips_notify(s);
1118 }
1119 
1120 static const MemoryRegionOps qspips_ops = {
1121     .read = xilinx_spips_read,
1122     .write = xilinx_qspips_write,
1123     .endianness = DEVICE_LITTLE_ENDIAN,
1124 };
1125 
1126 static const MemoryRegionOps xlnx_zynqmp_qspips_ops = {
1127     .read = xlnx_zynqmp_qspips_read,
1128     .write = xlnx_zynqmp_qspips_write,
1129     .endianness = DEVICE_LITTLE_ENDIAN,
1130 };
1131 
1132 #define LQSPI_CACHE_SIZE 1024
1133 
1134 static void lqspi_load_cache(void *opaque, hwaddr addr)
1135 {
1136     XilinxQSPIPS *q = opaque;
1137     XilinxSPIPS *s = opaque;
1138     int i;
1139     int flash_addr = ((addr & ~(LQSPI_CACHE_SIZE - 1))
1140                    / num_effective_busses(s));
1141     int slave = flash_addr >> LQSPI_ADDRESS_BITS;
1142     int cache_entry = 0;
1143     uint32_t u_page_save = s->regs[R_LQSPI_STS] & ~LQSPI_CFG_U_PAGE;
1144 
1145     if (addr < q->lqspi_cached_addr ||
1146             addr > q->lqspi_cached_addr + LQSPI_CACHE_SIZE - 4) {
1147         xilinx_qspips_invalidate_mmio_ptr(q);
1148         s->regs[R_LQSPI_STS] &= ~LQSPI_CFG_U_PAGE;
1149         s->regs[R_LQSPI_STS] |= slave ? LQSPI_CFG_U_PAGE : 0;
1150 
1151         DB_PRINT_L(0, "config reg status: %08x\n", s->regs[R_LQSPI_CFG]);
1152 
1153         fifo8_reset(&s->tx_fifo);
1154         fifo8_reset(&s->rx_fifo);
1155 
1156         /* instruction */
1157         DB_PRINT_L(0, "pushing read instruction: %02x\n",
1158                    (unsigned)(uint8_t)(s->regs[R_LQSPI_CFG] &
1159                                        LQSPI_CFG_INST_CODE));
1160         fifo8_push(&s->tx_fifo, s->regs[R_LQSPI_CFG] & LQSPI_CFG_INST_CODE);
1161         /* read address */
1162         DB_PRINT_L(0, "pushing read address %06x\n", flash_addr);
1163         if (s->regs[R_LQSPI_CFG] & LQSPI_CFG_ADDR4) {
1164             fifo8_push(&s->tx_fifo, (uint8_t)(flash_addr >> 24));
1165         }
1166         fifo8_push(&s->tx_fifo, (uint8_t)(flash_addr >> 16));
1167         fifo8_push(&s->tx_fifo, (uint8_t)(flash_addr >> 8));
1168         fifo8_push(&s->tx_fifo, (uint8_t)flash_addr);
1169         /* mode bits */
1170         if (s->regs[R_LQSPI_CFG] & LQSPI_CFG_MODE_EN) {
1171             fifo8_push(&s->tx_fifo, extract32(s->regs[R_LQSPI_CFG],
1172                                               LQSPI_CFG_MODE_SHIFT,
1173                                               LQSPI_CFG_MODE_WIDTH));
1174         }
1175         /* dummy bytes */
1176         for (i = 0; i < (extract32(s->regs[R_LQSPI_CFG], LQSPI_CFG_DUMMY_SHIFT,
1177                                    LQSPI_CFG_DUMMY_WIDTH)); ++i) {
1178             DB_PRINT_L(0, "pushing dummy byte\n");
1179             fifo8_push(&s->tx_fifo, 0);
1180         }
1181         xilinx_spips_update_cs_lines(s);
1182         xilinx_spips_flush_txfifo(s);
1183         fifo8_reset(&s->rx_fifo);
1184 
1185         DB_PRINT_L(0, "starting QSPI data read\n");
1186 
1187         while (cache_entry < LQSPI_CACHE_SIZE) {
1188             for (i = 0; i < 64; ++i) {
1189                 tx_data_bytes(&s->tx_fifo, 0, 1, false);
1190             }
1191             xilinx_spips_flush_txfifo(s);
1192             for (i = 0; i < 64; ++i) {
1193                 rx_data_bytes(&s->rx_fifo, &q->lqspi_buf[cache_entry++], 1);
1194             }
1195         }
1196 
1197         s->regs[R_LQSPI_STS] &= ~LQSPI_CFG_U_PAGE;
1198         s->regs[R_LQSPI_STS] |= u_page_save;
1199         xilinx_spips_update_cs_lines(s);
1200 
1201         q->lqspi_cached_addr = flash_addr * num_effective_busses(s);
1202     }
1203 }
1204 
1205 static void *lqspi_request_mmio_ptr(void *opaque, hwaddr addr, unsigned *size,
1206                                     unsigned *offset)
1207 {
1208     XilinxQSPIPS *q = opaque;
1209     hwaddr offset_within_the_region;
1210 
1211     if (!q->mmio_execution_enabled) {
1212         return NULL;
1213     }
1214 
1215     offset_within_the_region = addr & ~(LQSPI_CACHE_SIZE - 1);
1216     lqspi_load_cache(opaque, offset_within_the_region);
1217     *size = LQSPI_CACHE_SIZE;
1218     *offset = offset_within_the_region;
1219     return q->lqspi_buf;
1220 }
1221 
1222 static uint64_t
1223 lqspi_read(void *opaque, hwaddr addr, unsigned int size)
1224 {
1225     XilinxQSPIPS *q = opaque;
1226     uint32_t ret;
1227 
1228     if (addr >= q->lqspi_cached_addr &&
1229             addr <= q->lqspi_cached_addr + LQSPI_CACHE_SIZE - 4) {
1230         uint8_t *retp = &q->lqspi_buf[addr - q->lqspi_cached_addr];
1231         ret = cpu_to_le32(*(uint32_t *)retp);
1232         DB_PRINT_L(1, "addr: %08x, data: %08x\n", (unsigned)addr,
1233                    (unsigned)ret);
1234         return ret;
1235     } else {
1236         lqspi_load_cache(opaque, addr);
1237         return lqspi_read(opaque, addr, size);
1238     }
1239 }
1240 
1241 static const MemoryRegionOps lqspi_ops = {
1242     .read = lqspi_read,
1243     .request_ptr = lqspi_request_mmio_ptr,
1244     .endianness = DEVICE_NATIVE_ENDIAN,
1245     .valid = {
1246         .min_access_size = 1,
1247         .max_access_size = 4
1248     }
1249 };
1250 
1251 static void xilinx_spips_realize(DeviceState *dev, Error **errp)
1252 {
1253     XilinxSPIPS *s = XILINX_SPIPS(dev);
1254     SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
1255     XilinxSPIPSClass *xsc = XILINX_SPIPS_GET_CLASS(s);
1256     qemu_irq *cs;
1257     int i;
1258 
1259     DB_PRINT_L(0, "realized spips\n");
1260 
1261     if (s->num_busses > MAX_NUM_BUSSES) {
1262         error_setg(errp,
1263                    "requested number of SPI busses %u exceeds maximum %d",
1264                    s->num_busses, MAX_NUM_BUSSES);
1265         return;
1266     }
1267     if (s->num_busses < MIN_NUM_BUSSES) {
1268         error_setg(errp,
1269                    "requested number of SPI busses %u is below minimum %d",
1270                    s->num_busses, MIN_NUM_BUSSES);
1271         return;
1272     }
1273 
1274     s->spi = g_new(SSIBus *, s->num_busses);
1275     for (i = 0; i < s->num_busses; ++i) {
1276         char bus_name[16];
1277         snprintf(bus_name, 16, "spi%d", i);
1278         s->spi[i] = ssi_create_bus(dev, bus_name);
1279     }
1280 
1281     s->cs_lines = g_new0(qemu_irq, s->num_cs * s->num_busses);
1282     s->cs_lines_state = g_new0(bool, s->num_cs * s->num_busses);
1283     for (i = 0, cs = s->cs_lines; i < s->num_busses; ++i, cs += s->num_cs) {
1284         ssi_auto_connect_slaves(DEVICE(s), cs, s->spi[i]);
1285     }
1286 
1287     sysbus_init_irq(sbd, &s->irq);
1288     for (i = 0; i < s->num_cs * s->num_busses; ++i) {
1289         sysbus_init_irq(sbd, &s->cs_lines[i]);
1290     }
1291 
1292     memory_region_init_io(&s->iomem, OBJECT(s), xsc->reg_ops, s,
1293                           "spi", XLNX_ZYNQMP_SPIPS_R_MAX * 4);
1294     sysbus_init_mmio(sbd, &s->iomem);
1295 
1296     s->irqline = -1;
1297 
1298     fifo8_create(&s->rx_fifo, xsc->rx_fifo_size);
1299     fifo8_create(&s->tx_fifo, xsc->tx_fifo_size);
1300 }
1301 
1302 static void xilinx_qspips_realize(DeviceState *dev, Error **errp)
1303 {
1304     XilinxSPIPS *s = XILINX_SPIPS(dev);
1305     XilinxQSPIPS *q = XILINX_QSPIPS(dev);
1306     SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
1307 
1308     DB_PRINT_L(0, "realized qspips\n");
1309 
1310     s->num_busses = 2;
1311     s->num_cs = 2;
1312     s->num_txrx_bytes = 4;
1313 
1314     xilinx_spips_realize(dev, errp);
1315     memory_region_init_io(&s->mmlqspi, OBJECT(s), &lqspi_ops, s, "lqspi",
1316                           (1 << LQSPI_ADDRESS_BITS) * 2);
1317     sysbus_init_mmio(sbd, &s->mmlqspi);
1318 
1319     q->lqspi_cached_addr = ~0ULL;
1320 
1321     /* mmio_execution breaks migration better aborting than having strange
1322      * bugs.
1323      */
1324     if (q->mmio_execution_enabled) {
1325         error_setg(&q->migration_blocker,
1326                    "enabling mmio_execution breaks migration");
1327         migrate_add_blocker(q->migration_blocker, &error_fatal);
1328     }
1329 }
1330 
1331 static void xlnx_zynqmp_qspips_realize(DeviceState *dev, Error **errp)
1332 {
1333     XlnxZynqMPQSPIPS *s = XLNX_ZYNQMP_QSPIPS(dev);
1334     XilinxSPIPSClass *xsc = XILINX_SPIPS_GET_CLASS(s);
1335 
1336     xilinx_qspips_realize(dev, errp);
1337     fifo8_create(&s->rx_fifo_g, xsc->rx_fifo_size);
1338     fifo8_create(&s->tx_fifo_g, xsc->tx_fifo_size);
1339     fifo32_create(&s->fifo_g, 32);
1340 }
1341 
1342 static void xlnx_zynqmp_qspips_init(Object *obj)
1343 {
1344     XlnxZynqMPQSPIPS *rq = XLNX_ZYNQMP_QSPIPS(obj);
1345 
1346     object_property_add_link(obj, "stream-connected-dma", TYPE_STREAM_SLAVE,
1347                              (Object **)&rq->dma,
1348                              object_property_allow_set_link,
1349                              OBJ_PROP_LINK_STRONG,
1350                              NULL);
1351 }
1352 
1353 static int xilinx_spips_post_load(void *opaque, int version_id)
1354 {
1355     xilinx_spips_update_ixr((XilinxSPIPS *)opaque);
1356     xilinx_spips_update_cs_lines((XilinxSPIPS *)opaque);
1357     return 0;
1358 }
1359 
1360 static const VMStateDescription vmstate_xilinx_spips = {
1361     .name = "xilinx_spips",
1362     .version_id = 2,
1363     .minimum_version_id = 2,
1364     .post_load = xilinx_spips_post_load,
1365     .fields = (VMStateField[]) {
1366         VMSTATE_FIFO8(tx_fifo, XilinxSPIPS),
1367         VMSTATE_FIFO8(rx_fifo, XilinxSPIPS),
1368         VMSTATE_UINT32_ARRAY(regs, XilinxSPIPS, XLNX_SPIPS_R_MAX),
1369         VMSTATE_UINT8(snoop_state, XilinxSPIPS),
1370         VMSTATE_END_OF_LIST()
1371     }
1372 };
1373 
1374 static int xlnx_zynqmp_qspips_post_load(void *opaque, int version_id)
1375 {
1376     XlnxZynqMPQSPIPS *s = (XlnxZynqMPQSPIPS *)opaque;
1377     XilinxSPIPS *qs = XILINX_SPIPS(s);
1378 
1379     if (ARRAY_FIELD_EX32(s->regs, GQSPI_SELECT, GENERIC_QSPI_EN) &&
1380         fifo8_is_empty(&qs->rx_fifo) && fifo8_is_empty(&qs->tx_fifo)) {
1381         xlnx_zynqmp_qspips_update_ixr(s);
1382         xlnx_zynqmp_qspips_update_cs_lines(s);
1383     }
1384     return 0;
1385 }
1386 
1387 static const VMStateDescription vmstate_xilinx_qspips = {
1388     .name = "xilinx_qspips",
1389     .version_id = 1,
1390     .minimum_version_id = 1,
1391     .fields = (VMStateField[]) {
1392         VMSTATE_STRUCT(parent_obj, XilinxQSPIPS, 0,
1393                        vmstate_xilinx_spips, XilinxSPIPS),
1394         VMSTATE_END_OF_LIST()
1395     }
1396 };
1397 
1398 static const VMStateDescription vmstate_xlnx_zynqmp_qspips = {
1399     .name = "xlnx_zynqmp_qspips",
1400     .version_id = 1,
1401     .minimum_version_id = 1,
1402     .post_load = xlnx_zynqmp_qspips_post_load,
1403     .fields = (VMStateField[]) {
1404         VMSTATE_STRUCT(parent_obj, XlnxZynqMPQSPIPS, 0,
1405                        vmstate_xilinx_qspips, XilinxQSPIPS),
1406         VMSTATE_FIFO8(tx_fifo_g, XlnxZynqMPQSPIPS),
1407         VMSTATE_FIFO8(rx_fifo_g, XlnxZynqMPQSPIPS),
1408         VMSTATE_FIFO32(fifo_g, XlnxZynqMPQSPIPS),
1409         VMSTATE_UINT32_ARRAY(regs, XlnxZynqMPQSPIPS, XLNX_ZYNQMP_SPIPS_R_MAX),
1410         VMSTATE_END_OF_LIST()
1411     }
1412 };
1413 
1414 static Property xilinx_qspips_properties[] = {
1415     /* We had to turn this off for 2.10 as it is not compatible with migration.
1416      * It can be enabled but will prevent the device to be migrated.
1417      * This will go aways when a fix will be released.
1418      */
1419     DEFINE_PROP_BOOL("x-mmio-exec", XilinxQSPIPS, mmio_execution_enabled,
1420                      false),
1421     DEFINE_PROP_END_OF_LIST(),
1422 };
1423 
1424 static Property xilinx_spips_properties[] = {
1425     DEFINE_PROP_UINT8("num-busses", XilinxSPIPS, num_busses, 1),
1426     DEFINE_PROP_UINT8("num-ss-bits", XilinxSPIPS, num_cs, 4),
1427     DEFINE_PROP_UINT8("num-txrx-bytes", XilinxSPIPS, num_txrx_bytes, 1),
1428     DEFINE_PROP_END_OF_LIST(),
1429 };
1430 
1431 static void xilinx_qspips_class_init(ObjectClass *klass, void * data)
1432 {
1433     DeviceClass *dc = DEVICE_CLASS(klass);
1434     XilinxSPIPSClass *xsc = XILINX_SPIPS_CLASS(klass);
1435 
1436     dc->realize = xilinx_qspips_realize;
1437     dc->props = xilinx_qspips_properties;
1438     xsc->reg_ops = &qspips_ops;
1439     xsc->rx_fifo_size = RXFF_A_Q;
1440     xsc->tx_fifo_size = TXFF_A_Q;
1441 }
1442 
1443 static void xilinx_spips_class_init(ObjectClass *klass, void *data)
1444 {
1445     DeviceClass *dc = DEVICE_CLASS(klass);
1446     XilinxSPIPSClass *xsc = XILINX_SPIPS_CLASS(klass);
1447 
1448     dc->realize = xilinx_spips_realize;
1449     dc->reset = xilinx_spips_reset;
1450     dc->props = xilinx_spips_properties;
1451     dc->vmsd = &vmstate_xilinx_spips;
1452 
1453     xsc->reg_ops = &spips_ops;
1454     xsc->rx_fifo_size = RXFF_A;
1455     xsc->tx_fifo_size = TXFF_A;
1456 }
1457 
1458 static void xlnx_zynqmp_qspips_class_init(ObjectClass *klass, void * data)
1459 {
1460     DeviceClass *dc = DEVICE_CLASS(klass);
1461     XilinxSPIPSClass *xsc = XILINX_SPIPS_CLASS(klass);
1462 
1463     dc->realize = xlnx_zynqmp_qspips_realize;
1464     dc->reset = xlnx_zynqmp_qspips_reset;
1465     dc->vmsd = &vmstate_xlnx_zynqmp_qspips;
1466     xsc->reg_ops = &xlnx_zynqmp_qspips_ops;
1467     xsc->rx_fifo_size = RXFF_A_Q;
1468     xsc->tx_fifo_size = TXFF_A_Q;
1469 }
1470 
1471 static const TypeInfo xilinx_spips_info = {
1472     .name  = TYPE_XILINX_SPIPS,
1473     .parent = TYPE_SYS_BUS_DEVICE,
1474     .instance_size  = sizeof(XilinxSPIPS),
1475     .class_init = xilinx_spips_class_init,
1476     .class_size = sizeof(XilinxSPIPSClass),
1477 };
1478 
1479 static const TypeInfo xilinx_qspips_info = {
1480     .name  = TYPE_XILINX_QSPIPS,
1481     .parent = TYPE_XILINX_SPIPS,
1482     .instance_size  = sizeof(XilinxQSPIPS),
1483     .class_init = xilinx_qspips_class_init,
1484 };
1485 
1486 static const TypeInfo xlnx_zynqmp_qspips_info = {
1487     .name  = TYPE_XLNX_ZYNQMP_QSPIPS,
1488     .parent = TYPE_XILINX_QSPIPS,
1489     .instance_size  = sizeof(XlnxZynqMPQSPIPS),
1490     .instance_init  = xlnx_zynqmp_qspips_init,
1491     .class_init = xlnx_zynqmp_qspips_class_init,
1492 };
1493 
1494 static void xilinx_spips_register_types(void)
1495 {
1496     type_register_static(&xilinx_spips_info);
1497     type_register_static(&xilinx_qspips_info);
1498     type_register_static(&xlnx_zynqmp_qspips_info);
1499 }
1500 
1501 type_init(xilinx_spips_register_types)
1502