xref: /qemu/hw/sd/sdhci.c (revision 70ce076fa6dff60585c229a4b641b13e64bf03cf)
1 /*
2  * SD Association Host Standard Specification v2.0 controller emulation
3  *
4  * Datasheet: PartA2_SD_Host_Controller_Simplified_Specification_Ver2.00.pdf
5  *
6  * Copyright (c) 2011 Samsung Electronics Co., Ltd.
7  * Mitsyanko Igor <i.mitsyanko@samsung.com>
8  * Peter A.G. Crosthwaite <peter.crosthwaite@petalogix.com>
9  *
10  * Based on MMC controller for Samsung S5PC1xx-based board emulation
11  * by Alexey Merkulov and Vladimir Monakhov.
12  *
13  * This program is free software; you can redistribute it and/or modify it
14  * under the terms of the GNU General Public License as published by the
15  * Free Software Foundation; either version 2 of the License, or (at your
16  * option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
21  * See the GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License along
24  * with this program; if not, see <http://www.gnu.org/licenses/>.
25  */
26 
27 #include "qemu/osdep.h"
28 #include "qemu/units.h"
29 #include "qemu/error-report.h"
30 #include "qapi/error.h"
31 #include "hw/irq.h"
32 #include "hw/qdev-properties.h"
33 #include "system/dma.h"
34 #include "qemu/timer.h"
35 #include "qemu/bitops.h"
36 #include "hw/sd/sdhci.h"
37 #include "migration/vmstate.h"
38 #include "sdhci-internal.h"
39 #include "qemu/log.h"
40 #include "trace.h"
41 #include "qom/object.h"
42 
43 #define TYPE_SDHCI_BUS "sdhci-bus"
44 /* This is reusing the SDBus typedef from SD_BUS */
45 DECLARE_INSTANCE_CHECKER(SDBus, SDHCI_BUS,
46                          TYPE_SDHCI_BUS)
47 
48 #define MASKED_WRITE(reg, mask, val)  (reg = (reg & (mask)) | (val))
49 
50 static inline unsigned int sdhci_get_fifolen(SDHCIState *s)
51 {
52     return 1 << (9 + FIELD_EX32(s->capareg, SDHC_CAPAB, MAXBLOCKLENGTH));
53 }
54 
55 /* return true on error */
56 static bool sdhci_check_capab_freq_range(SDHCIState *s, const char *desc,
57                                          uint8_t freq, Error **errp)
58 {
59     if (s->sd_spec_version >= 3) {
60         return false;
61     }
62     switch (freq) {
63     case 0:
64     case 10 ... 63:
65         break;
66     default:
67         error_setg(errp, "SD %s clock frequency can have value"
68                    "in range 0-63 only", desc);
69         return true;
70     }
71     return false;
72 }
73 
74 static void sdhci_check_capareg(SDHCIState *s, Error **errp)
75 {
76     uint64_t msk = s->capareg;
77     uint32_t val;
78     bool y;
79 
80     switch (s->sd_spec_version) {
81     case 4:
82         val = FIELD_EX64(s->capareg, SDHC_CAPAB, BUS64BIT_V4);
83         trace_sdhci_capareg("64-bit system bus (v4)", val);
84         msk = FIELD_DP64(msk, SDHC_CAPAB, BUS64BIT_V4, 0);
85 
86         val = FIELD_EX64(s->capareg, SDHC_CAPAB, UHS_II);
87         trace_sdhci_capareg("UHS-II", val);
88         msk = FIELD_DP64(msk, SDHC_CAPAB, UHS_II, 0);
89 
90         val = FIELD_EX64(s->capareg, SDHC_CAPAB, ADMA3);
91         trace_sdhci_capareg("ADMA3", val);
92         msk = FIELD_DP64(msk, SDHC_CAPAB, ADMA3, 0);
93 
94     /* fallthrough */
95     case 3:
96         val = FIELD_EX64(s->capareg, SDHC_CAPAB, ASYNC_INT);
97         trace_sdhci_capareg("async interrupt", val);
98         msk = FIELD_DP64(msk, SDHC_CAPAB, ASYNC_INT, 0);
99 
100         val = FIELD_EX64(s->capareg, SDHC_CAPAB, SLOT_TYPE);
101         if (val) {
102             error_setg(errp, "slot-type not supported");
103             return;
104         }
105         trace_sdhci_capareg("slot type", val);
106         msk = FIELD_DP64(msk, SDHC_CAPAB, SLOT_TYPE, 0);
107 
108         if (val != 2) {
109             val = FIELD_EX64(s->capareg, SDHC_CAPAB, EMBEDDED_8BIT);
110             trace_sdhci_capareg("8-bit bus", val);
111         }
112         msk = FIELD_DP64(msk, SDHC_CAPAB, EMBEDDED_8BIT, 0);
113 
114         val = FIELD_EX64(s->capareg, SDHC_CAPAB, BUS_SPEED);
115         trace_sdhci_capareg("bus speed mask", val);
116         msk = FIELD_DP64(msk, SDHC_CAPAB, BUS_SPEED, 0);
117 
118         val = FIELD_EX64(s->capareg, SDHC_CAPAB, DRIVER_STRENGTH);
119         trace_sdhci_capareg("driver strength mask", val);
120         msk = FIELD_DP64(msk, SDHC_CAPAB, DRIVER_STRENGTH, 0);
121 
122         val = FIELD_EX64(s->capareg, SDHC_CAPAB, TIMER_RETUNING);
123         trace_sdhci_capareg("timer re-tuning", val);
124         msk = FIELD_DP64(msk, SDHC_CAPAB, TIMER_RETUNING, 0);
125 
126         val = FIELD_EX64(s->capareg, SDHC_CAPAB, SDR50_TUNING);
127         trace_sdhci_capareg("use SDR50 tuning", val);
128         msk = FIELD_DP64(msk, SDHC_CAPAB, SDR50_TUNING, 0);
129 
130         val = FIELD_EX64(s->capareg, SDHC_CAPAB, RETUNING_MODE);
131         trace_sdhci_capareg("re-tuning mode", val);
132         msk = FIELD_DP64(msk, SDHC_CAPAB, RETUNING_MODE, 0);
133 
134         val = FIELD_EX64(s->capareg, SDHC_CAPAB, CLOCK_MULT);
135         trace_sdhci_capareg("clock multiplier", val);
136         msk = FIELD_DP64(msk, SDHC_CAPAB, CLOCK_MULT, 0);
137 
138     /* fallthrough */
139     case 2: /* default version */
140         val = FIELD_EX64(s->capareg, SDHC_CAPAB, ADMA2);
141         trace_sdhci_capareg("ADMA2", val);
142         msk = FIELD_DP64(msk, SDHC_CAPAB, ADMA2, 0);
143 
144         val = FIELD_EX64(s->capareg, SDHC_CAPAB, ADMA1);
145         trace_sdhci_capareg("ADMA1", val);
146         msk = FIELD_DP64(msk, SDHC_CAPAB, ADMA1, 0);
147 
148         val = FIELD_EX64(s->capareg, SDHC_CAPAB, BUS64BIT);
149         trace_sdhci_capareg("64-bit system bus (v3)", val);
150         msk = FIELD_DP64(msk, SDHC_CAPAB, BUS64BIT, 0);
151 
152     /* fallthrough */
153     case 1:
154         y = FIELD_EX64(s->capareg, SDHC_CAPAB, TOUNIT);
155         msk = FIELD_DP64(msk, SDHC_CAPAB, TOUNIT, 0);
156 
157         val = FIELD_EX64(s->capareg, SDHC_CAPAB, TOCLKFREQ);
158         trace_sdhci_capareg(y ? "timeout (MHz)" : "Timeout (KHz)", val);
159         if (sdhci_check_capab_freq_range(s, "timeout", val, errp)) {
160             return;
161         }
162         msk = FIELD_DP64(msk, SDHC_CAPAB, TOCLKFREQ, 0);
163 
164         val = FIELD_EX64(s->capareg, SDHC_CAPAB, BASECLKFREQ);
165         trace_sdhci_capareg(y ? "base (MHz)" : "Base (KHz)", val);
166         if (sdhci_check_capab_freq_range(s, "base", val, errp)) {
167             return;
168         }
169         msk = FIELD_DP64(msk, SDHC_CAPAB, BASECLKFREQ, 0);
170 
171         val = FIELD_EX64(s->capareg, SDHC_CAPAB, MAXBLOCKLENGTH);
172         if (val >= 3) {
173             error_setg(errp, "block size can be 512, 1024 or 2048 only");
174             return;
175         }
176         trace_sdhci_capareg("max block length", sdhci_get_fifolen(s));
177         msk = FIELD_DP64(msk, SDHC_CAPAB, MAXBLOCKLENGTH, 0);
178 
179         val = FIELD_EX64(s->capareg, SDHC_CAPAB, HIGHSPEED);
180         trace_sdhci_capareg("high speed", val);
181         msk = FIELD_DP64(msk, SDHC_CAPAB, HIGHSPEED, 0);
182 
183         val = FIELD_EX64(s->capareg, SDHC_CAPAB, SDMA);
184         trace_sdhci_capareg("SDMA", val);
185         msk = FIELD_DP64(msk, SDHC_CAPAB, SDMA, 0);
186 
187         val = FIELD_EX64(s->capareg, SDHC_CAPAB, SUSPRESUME);
188         trace_sdhci_capareg("suspend/resume", val);
189         msk = FIELD_DP64(msk, SDHC_CAPAB, SUSPRESUME, 0);
190 
191         val = FIELD_EX64(s->capareg, SDHC_CAPAB, V33);
192         trace_sdhci_capareg("3.3v", val);
193         msk = FIELD_DP64(msk, SDHC_CAPAB, V33, 0);
194 
195         val = FIELD_EX64(s->capareg, SDHC_CAPAB, V30);
196         trace_sdhci_capareg("3.0v", val);
197         msk = FIELD_DP64(msk, SDHC_CAPAB, V30, 0);
198 
199         val = FIELD_EX64(s->capareg, SDHC_CAPAB, V18);
200         trace_sdhci_capareg("1.8v", val);
201         msk = FIELD_DP64(msk, SDHC_CAPAB, V18, 0);
202         break;
203 
204     default:
205         error_setg(errp, "Unsupported spec version: %u", s->sd_spec_version);
206     }
207     if (msk) {
208         qemu_log_mask(LOG_UNIMP,
209                       "SDHCI: unknown CAPAB mask: 0x%016" PRIx64 "\n", msk);
210     }
211 }
212 
213 static uint8_t sdhci_slotint(SDHCIState *s)
214 {
215     return (s->norintsts & s->norintsigen) || (s->errintsts & s->errintsigen) ||
216          ((s->norintsts & SDHC_NIS_INSERT) && (s->wakcon & SDHC_WKUP_ON_INS)) ||
217          ((s->norintsts & SDHC_NIS_REMOVE) && (s->wakcon & SDHC_WKUP_ON_RMV));
218 }
219 
220 /* Return true if IRQ was pending and delivered */
221 static bool sdhci_update_irq(SDHCIState *s)
222 {
223     bool pending = sdhci_slotint(s);
224 
225     qemu_set_irq(s->irq, pending);
226 
227     return pending;
228 }
229 
230 static void sdhci_raise_insertion_irq(void *opaque)
231 {
232     SDHCIState *s = (SDHCIState *)opaque;
233 
234     if (s->norintsts & SDHC_NIS_REMOVE) {
235         timer_mod(s->insert_timer,
236                 qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + SDHC_INSERTION_DELAY);
237     } else {
238         s->prnsts = 0x1ff0000;
239         if (s->norintstsen & SDHC_NISEN_INSERT) {
240             s->norintsts |= SDHC_NIS_INSERT;
241         }
242         sdhci_update_irq(s);
243     }
244 }
245 
246 static void sdhci_set_inserted(DeviceState *dev, bool level)
247 {
248     SDHCIState *s = (SDHCIState *)dev;
249 
250     trace_sdhci_set_inserted(level ? "insert" : "eject");
251     if ((s->norintsts & SDHC_NIS_REMOVE) && level) {
252         /* Give target some time to notice card ejection */
253         timer_mod(s->insert_timer,
254                 qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + SDHC_INSERTION_DELAY);
255     } else {
256         if (level) {
257             s->prnsts = 0x1ff0000;
258             if (s->norintstsen & SDHC_NISEN_INSERT) {
259                 s->norintsts |= SDHC_NIS_INSERT;
260             }
261         } else {
262             s->prnsts = 0x1fa0000;
263             s->pwrcon &= ~SDHC_POWER_ON;
264             s->clkcon &= ~SDHC_CLOCK_SDCLK_EN;
265             if (s->norintstsen & SDHC_NISEN_REMOVE) {
266                 s->norintsts |= SDHC_NIS_REMOVE;
267             }
268         }
269         sdhci_update_irq(s);
270     }
271 }
272 
273 static void sdhci_set_readonly(DeviceState *dev, bool level)
274 {
275     SDHCIState *s = (SDHCIState *)dev;
276 
277     if (s->wp_inverted) {
278         level = !level;
279     }
280 
281     if (level) {
282         s->prnsts &= ~SDHC_WRITE_PROTECT;
283     } else {
284         /* Write enabled */
285         s->prnsts |= SDHC_WRITE_PROTECT;
286     }
287 }
288 
289 static void sdhci_reset(SDHCIState *s)
290 {
291     DeviceState *dev = DEVICE(s);
292 
293     timer_del(s->insert_timer);
294     timer_del(s->transfer_timer);
295 
296     /*
297      * Set all registers to 0. Capabilities/Version registers are not cleared
298      * and assumed to always preserve their value, given to them during
299      * initialization
300      */
301     memset(&s->sdmasysad, 0, (uintptr_t)&s->capareg - (uintptr_t)&s->sdmasysad);
302 
303     /* Reset other state based on current card insertion/readonly status */
304     sdhci_set_inserted(dev, sdbus_get_inserted(&s->sdbus));
305     sdhci_set_readonly(dev, sdbus_get_readonly(&s->sdbus));
306 
307     s->data_count = 0;
308     s->stopped_state = sdhc_not_stopped;
309     s->pending_insert_state = false;
310 }
311 
312 static void sdhci_poweron_reset(DeviceState *dev)
313 {
314     /*
315      * QOM (ie power-on) reset. This is identical to reset
316      * commanded via device register apart from handling of the
317      * 'pending insert on powerup' quirk.
318      */
319     SDHCIState *s = (SDHCIState *)dev;
320 
321     sdhci_reset(s);
322 
323     if (s->pending_insert_quirk) {
324         s->pending_insert_state = true;
325     }
326 }
327 
328 static void sdhci_data_transfer(void *opaque);
329 
330 #define BLOCK_SIZE_MASK (4 * KiB - 1)
331 
332 static void sdhci_send_command(SDHCIState *s)
333 {
334     SDRequest request;
335     uint8_t response[16];
336     int rlen;
337     bool timeout = false;
338 
339     s->errintsts = 0;
340     s->acmd12errsts = 0;
341     request.cmd = s->cmdreg >> 8;
342     request.arg = s->argument;
343 
344     trace_sdhci_send_command(request.cmd, request.arg);
345     rlen = sdbus_do_command(&s->sdbus, &request, response);
346 
347     if (s->cmdreg & SDHC_CMD_RESPONSE) {
348         if (rlen == 4) {
349             s->rspreg[0] = ldl_be_p(response);
350             s->rspreg[1] = s->rspreg[2] = s->rspreg[3] = 0;
351             trace_sdhci_response4(s->rspreg[0]);
352         } else if (rlen == 16) {
353             s->rspreg[0] = ldl_be_p(&response[11]);
354             s->rspreg[1] = ldl_be_p(&response[7]);
355             s->rspreg[2] = ldl_be_p(&response[3]);
356             s->rspreg[3] = (response[0] << 16) | (response[1] << 8) |
357                             response[2];
358             trace_sdhci_response16(s->rspreg[3], s->rspreg[2],
359                                    s->rspreg[1], s->rspreg[0]);
360         } else {
361             timeout = true;
362             trace_sdhci_error("timeout waiting for command response");
363             if (s->errintstsen & SDHC_EISEN_CMDTIMEOUT) {
364                 s->errintsts |= SDHC_EIS_CMDTIMEOUT;
365                 s->norintsts |= SDHC_NIS_ERR;
366             }
367         }
368 
369         if (!(s->quirks & SDHCI_QUIRK_NO_BUSY_IRQ) &&
370             (s->norintstsen & SDHC_NISEN_TRSCMP) &&
371             (s->cmdreg & SDHC_CMD_RESPONSE) == SDHC_CMD_RSP_WITH_BUSY) {
372             s->norintsts |= SDHC_NIS_TRSCMP;
373         }
374     }
375 
376     if (s->norintstsen & SDHC_NISEN_CMDCMP) {
377         s->norintsts |= SDHC_NIS_CMDCMP;
378     }
379 
380     sdhci_update_irq(s);
381 
382     if (!timeout && (s->blksize & BLOCK_SIZE_MASK) &&
383         (s->cmdreg & SDHC_CMD_DATA_PRESENT)) {
384         s->data_count = 0;
385         sdhci_data_transfer(s);
386     }
387 }
388 
389 static void sdhci_end_transfer(SDHCIState *s)
390 {
391     /* Automatically send CMD12 to stop transfer if AutoCMD12 enabled */
392     if ((s->trnmod & SDHC_TRNS_ACMD12) != 0) {
393         SDRequest request;
394         uint8_t response[16];
395 
396         request.cmd = 0x0C;
397         request.arg = 0;
398         trace_sdhci_end_transfer(request.cmd, request.arg);
399         sdbus_do_command(&s->sdbus, &request, response);
400         /* Auto CMD12 response goes to the upper Response register */
401         s->rspreg[3] = ldl_be_p(response);
402     }
403 
404     s->prnsts &= ~(SDHC_DOING_READ | SDHC_DOING_WRITE |
405             SDHC_DAT_LINE_ACTIVE | SDHC_DATA_INHIBIT |
406             SDHC_SPACE_AVAILABLE | SDHC_DATA_AVAILABLE);
407 
408     if (s->norintstsen & SDHC_NISEN_TRSCMP) {
409         s->norintsts |= SDHC_NIS_TRSCMP;
410     }
411 
412     sdhci_update_irq(s);
413 }
414 
415 /*
416  * Programmed i/o data transfer
417  */
418 
419 /* Fill host controller's read buffer with BLKSIZE bytes of data from card */
420 static void sdhci_read_block_from_card(SDHCIState *s)
421 {
422     const uint16_t blk_size = s->blksize & BLOCK_SIZE_MASK;
423 
424     if ((s->trnmod & SDHC_TRNS_MULTI) &&
425             (s->trnmod & SDHC_TRNS_BLK_CNT_EN) && (s->blkcnt == 0)) {
426         return;
427     }
428 
429     if (!FIELD_EX32(s->hostctl2, SDHC_HOSTCTL2, EXECUTE_TUNING)) {
430         /* Device is not in tuning */
431         sdbus_read_data(&s->sdbus, s->fifo_buffer, blk_size);
432     }
433 
434     if (FIELD_EX32(s->hostctl2, SDHC_HOSTCTL2, EXECUTE_TUNING)) {
435         /* Device is in tuning */
436         s->hostctl2 &= ~R_SDHC_HOSTCTL2_EXECUTE_TUNING_MASK;
437         s->hostctl2 |= R_SDHC_HOSTCTL2_SAMPLING_CLKSEL_MASK;
438         s->prnsts &= ~(SDHC_DAT_LINE_ACTIVE | SDHC_DOING_READ |
439                        SDHC_DATA_INHIBIT);
440         goto read_done;
441     }
442 
443     /* New data now available for READ through Buffer Port Register */
444     s->prnsts |= SDHC_DATA_AVAILABLE;
445     if (s->norintstsen & SDHC_NISEN_RBUFRDY) {
446         s->norintsts |= SDHC_NIS_RBUFRDY;
447     }
448 
449     /* Clear DAT line active status if that was the last block */
450     if ((s->trnmod & SDHC_TRNS_MULTI) == 0 ||
451             ((s->trnmod & SDHC_TRNS_MULTI) && s->blkcnt == 1)) {
452         s->prnsts &= ~SDHC_DAT_LINE_ACTIVE;
453     }
454 
455     /*
456      * If stop at block gap request was set and it's not the last block of
457      * data - generate Block Event interrupt
458      */
459     if (s->stopped_state == sdhc_gap_read && (s->trnmod & SDHC_TRNS_MULTI) &&
460             s->blkcnt != 1)    {
461         s->prnsts &= ~SDHC_DAT_LINE_ACTIVE;
462         if (s->norintstsen & SDHC_EISEN_BLKGAP) {
463             s->norintsts |= SDHC_EIS_BLKGAP;
464         }
465     }
466 
467 read_done:
468     sdhci_update_irq(s);
469 }
470 
471 /* Read @size byte of data from host controller @s BUFFER DATA PORT register */
472 static uint32_t sdhci_read_dataport(SDHCIState *s, unsigned size)
473 {
474     uint32_t value = 0;
475     int i;
476 
477     /* first check that a valid data exists in host controller input buffer */
478     if ((s->prnsts & SDHC_DATA_AVAILABLE) == 0) {
479         trace_sdhci_error("read from empty buffer");
480         return 0;
481     }
482 
483     for (i = 0; i < size; i++) {
484         assert(s->data_count < s->buf_maxsz);
485         value |= s->fifo_buffer[s->data_count] << i * 8;
486         s->data_count++;
487         /* check if we've read all valid data (blksize bytes) from buffer */
488         if ((s->data_count) >= (s->blksize & BLOCK_SIZE_MASK)) {
489             trace_sdhci_read_dataport(s->data_count);
490             s->prnsts &= ~SDHC_DATA_AVAILABLE; /* no more data in a buffer */
491             s->data_count = 0;  /* next buff read must start at position [0] */
492 
493             if (s->trnmod & SDHC_TRNS_BLK_CNT_EN) {
494                 s->blkcnt--;
495             }
496 
497             /* if that was the last block of data */
498             if ((s->trnmod & SDHC_TRNS_MULTI) == 0 ||
499                 ((s->trnmod & SDHC_TRNS_BLK_CNT_EN) && (s->blkcnt == 0)) ||
500                  /* stop at gap request */
501                 (s->stopped_state == sdhc_gap_read &&
502                  !(s->prnsts & SDHC_DAT_LINE_ACTIVE))) {
503                 sdhci_end_transfer(s);
504             } else { /* if there are more data, read next block from card */
505                 sdhci_read_block_from_card(s);
506             }
507             break;
508         }
509     }
510 
511     return value;
512 }
513 
514 /* Write data from host controller FIFO to card */
515 static void sdhci_write_block_to_card(SDHCIState *s)
516 {
517     if (s->prnsts & SDHC_SPACE_AVAILABLE) {
518         if (s->norintstsen & SDHC_NISEN_WBUFRDY) {
519             s->norintsts |= SDHC_NIS_WBUFRDY;
520         }
521         sdhci_update_irq(s);
522         return;
523     }
524 
525     if (s->trnmod & SDHC_TRNS_BLK_CNT_EN) {
526         if (s->blkcnt == 0) {
527             return;
528         } else {
529             s->blkcnt--;
530         }
531     }
532 
533     sdbus_write_data(&s->sdbus, s->fifo_buffer, s->blksize & BLOCK_SIZE_MASK);
534 
535     /* Next data can be written through BUFFER DATORT register */
536     s->prnsts |= SDHC_SPACE_AVAILABLE;
537 
538     /* Finish transfer if that was the last block of data */
539     if ((s->trnmod & SDHC_TRNS_MULTI) == 0 ||
540             ((s->trnmod & SDHC_TRNS_MULTI) &&
541             (s->trnmod & SDHC_TRNS_BLK_CNT_EN) && (s->blkcnt == 0))) {
542         sdhci_end_transfer(s);
543     } else if (s->norintstsen & SDHC_NISEN_WBUFRDY) {
544         s->norintsts |= SDHC_NIS_WBUFRDY;
545     }
546 
547     /* Generate Block Gap Event if requested and if not the last block */
548     if (s->stopped_state == sdhc_gap_write && (s->trnmod & SDHC_TRNS_MULTI) &&
549             s->blkcnt > 0) {
550         s->prnsts &= ~SDHC_DOING_WRITE;
551         if (s->norintstsen & SDHC_EISEN_BLKGAP) {
552             s->norintsts |= SDHC_EIS_BLKGAP;
553         }
554         sdhci_end_transfer(s);
555     }
556 
557     sdhci_update_irq(s);
558 }
559 
560 /*
561  * Write @size bytes of @value data to host controller @s Buffer Data Port
562  * register
563  */
564 static void sdhci_write_dataport(SDHCIState *s, uint32_t value, unsigned size)
565 {
566     unsigned i;
567 
568     /* Check that there is free space left in a buffer */
569     if (!(s->prnsts & SDHC_SPACE_AVAILABLE)) {
570         trace_sdhci_error("Can't write to data buffer: buffer full");
571         return;
572     }
573 
574     for (i = 0; i < size; i++) {
575         assert(s->data_count < s->buf_maxsz);
576         s->fifo_buffer[s->data_count] = value & 0xFF;
577         s->data_count++;
578         value >>= 8;
579         if (s->data_count >= (s->blksize & BLOCK_SIZE_MASK)) {
580             trace_sdhci_write_dataport(s->data_count);
581             s->data_count = 0;
582             s->prnsts &= ~SDHC_SPACE_AVAILABLE;
583             if (s->prnsts & SDHC_DOING_WRITE) {
584                 sdhci_write_block_to_card(s);
585             }
586         }
587     }
588 }
589 
590 /*
591  * Single DMA data transfer
592  */
593 
594 /* Multi block SDMA transfer */
595 static void sdhci_sdma_transfer_multi_blocks(SDHCIState *s)
596 {
597     bool page_aligned = false;
598     unsigned int begin;
599     const uint16_t block_size = s->blksize & BLOCK_SIZE_MASK;
600     uint32_t boundary_chk = 1 << (((s->blksize & ~BLOCK_SIZE_MASK) >> 12) + 12);
601     uint32_t boundary_count = boundary_chk - (s->sdmasysad % boundary_chk);
602 
603     if (!(s->trnmod & SDHC_TRNS_BLK_CNT_EN) || !s->blkcnt) {
604         qemu_log_mask(LOG_UNIMP, "infinite transfer is not supported\n");
605         return;
606     }
607 
608     /*
609      * XXX: Some sd/mmc drivers (for example, u-boot-slp) do not account for
610      * possible stop at page boundary if initial address is not page aligned,
611      * allow them to work properly
612      */
613     if ((s->sdmasysad % boundary_chk) == 0) {
614         page_aligned = true;
615     }
616 
617     s->prnsts |= SDHC_DATA_INHIBIT | SDHC_DAT_LINE_ACTIVE;
618     if (s->trnmod & SDHC_TRNS_READ) {
619         s->prnsts |= SDHC_DOING_READ;
620         while (s->blkcnt) {
621             if (s->data_count == 0) {
622                 sdbus_read_data(&s->sdbus, s->fifo_buffer, block_size);
623             }
624             begin = s->data_count;
625             if (((boundary_count + begin) < block_size) && page_aligned) {
626                 s->data_count = boundary_count + begin;
627                 boundary_count = 0;
628              } else {
629                 s->data_count = block_size;
630                 boundary_count -= block_size - begin;
631                 if (s->trnmod & SDHC_TRNS_BLK_CNT_EN) {
632                     s->blkcnt--;
633                 }
634             }
635             dma_memory_write(s->dma_as, s->sdmasysad, &s->fifo_buffer[begin],
636                              s->data_count - begin, MEMTXATTRS_UNSPECIFIED);
637             s->sdmasysad += s->data_count - begin;
638             if (s->data_count == block_size) {
639                 s->data_count = 0;
640             }
641             if (page_aligned && boundary_count == 0) {
642                 break;
643             }
644         }
645     } else {
646         s->prnsts |= SDHC_DOING_WRITE;
647         while (s->blkcnt) {
648             begin = s->data_count;
649             if (((boundary_count + begin) < block_size) && page_aligned) {
650                 s->data_count = boundary_count + begin;
651                 boundary_count = 0;
652              } else {
653                 s->data_count = block_size;
654                 boundary_count -= block_size - begin;
655             }
656             dma_memory_read(s->dma_as, s->sdmasysad, &s->fifo_buffer[begin],
657                             s->data_count - begin, MEMTXATTRS_UNSPECIFIED);
658             s->sdmasysad += s->data_count - begin;
659             if (s->data_count == block_size) {
660                 sdbus_write_data(&s->sdbus, s->fifo_buffer, block_size);
661                 s->data_count = 0;
662                 if (s->trnmod & SDHC_TRNS_BLK_CNT_EN) {
663                     s->blkcnt--;
664                 }
665             }
666             if (page_aligned && boundary_count == 0) {
667                 break;
668             }
669         }
670     }
671 
672     if (s->norintstsen & SDHC_NISEN_DMA) {
673         s->norintsts |= SDHC_NIS_DMA;
674     }
675 
676     if (s->blkcnt == 0) {
677         sdhci_end_transfer(s);
678     } else {
679         sdhci_update_irq(s);
680     }
681 }
682 
683 /* single block SDMA transfer */
684 static void sdhci_sdma_transfer_single_block(SDHCIState *s)
685 {
686     uint32_t datacnt = s->blksize & BLOCK_SIZE_MASK;
687 
688     if (s->trnmod & SDHC_TRNS_READ) {
689         sdbus_read_data(&s->sdbus, s->fifo_buffer, datacnt);
690         dma_memory_write(s->dma_as, s->sdmasysad, s->fifo_buffer, datacnt,
691                          MEMTXATTRS_UNSPECIFIED);
692     } else {
693         dma_memory_read(s->dma_as, s->sdmasysad, s->fifo_buffer, datacnt,
694                         MEMTXATTRS_UNSPECIFIED);
695         sdbus_write_data(&s->sdbus, s->fifo_buffer, datacnt);
696     }
697     s->blkcnt--;
698 
699     if (s->norintstsen & SDHC_NISEN_DMA) {
700         s->norintsts |= SDHC_NIS_DMA;
701     }
702 
703     sdhci_end_transfer(s);
704 }
705 
706 static void sdhci_sdma_transfer(SDHCIState *s)
707 {
708     if ((s->blkcnt == 1) || !(s->trnmod & SDHC_TRNS_MULTI)) {
709         sdhci_sdma_transfer_single_block(s);
710     } else {
711         sdhci_sdma_transfer_multi_blocks(s);
712     }
713 }
714 
715 typedef struct ADMADescr {
716     hwaddr addr;
717     uint16_t length;
718     uint8_t attr;
719     uint8_t incr;
720 } ADMADescr;
721 
722 static void get_adma_description(SDHCIState *s, ADMADescr *dscr)
723 {
724     uint32_t adma1 = 0;
725     uint64_t adma2 = 0;
726     hwaddr entry_addr = (hwaddr)s->admasysaddr;
727     switch (SDHC_DMA_TYPE(s->hostctl1)) {
728     case SDHC_CTRL_ADMA2_32:
729         dma_memory_read(s->dma_as, entry_addr, &adma2, sizeof(adma2),
730                         MEMTXATTRS_UNSPECIFIED);
731         adma2 = le64_to_cpu(adma2);
732         /*
733          * The spec does not specify endianness of descriptor table.
734          * We currently assume that it is LE.
735          */
736         dscr->addr = (hwaddr)extract64(adma2, 32, 32) & ~0x3ull;
737         dscr->length = (uint16_t)extract64(adma2, 16, 16);
738         dscr->attr = (uint8_t)extract64(adma2, 0, 7);
739         dscr->incr = 8;
740         break;
741     case SDHC_CTRL_ADMA1_32:
742         dma_memory_read(s->dma_as, entry_addr, &adma1, sizeof(adma1),
743                         MEMTXATTRS_UNSPECIFIED);
744         adma1 = le32_to_cpu(adma1);
745         dscr->addr = (hwaddr)(adma1 & 0xFFFFF000);
746         dscr->attr = (uint8_t)extract32(adma1, 0, 7);
747         dscr->incr = 4;
748         if ((dscr->attr & SDHC_ADMA_ATTR_ACT_MASK) == SDHC_ADMA_ATTR_SET_LEN) {
749             dscr->length = (uint16_t)extract32(adma1, 12, 16);
750         } else {
751             dscr->length = 4 * KiB;
752         }
753         break;
754     case SDHC_CTRL_ADMA2_64:
755         dma_memory_read(s->dma_as, entry_addr, &dscr->attr, 1,
756                         MEMTXATTRS_UNSPECIFIED);
757         dma_memory_read(s->dma_as, entry_addr + 2, &dscr->length, 2,
758                         MEMTXATTRS_UNSPECIFIED);
759         dscr->length = le16_to_cpu(dscr->length);
760         dma_memory_read(s->dma_as, entry_addr + 4, &dscr->addr, 8,
761                         MEMTXATTRS_UNSPECIFIED);
762         dscr->addr = le64_to_cpu(dscr->addr);
763         dscr->attr &= (uint8_t) ~0xC0;
764         dscr->incr = 12;
765         break;
766     }
767 }
768 
769 /* Advanced DMA data transfer */
770 
771 static void sdhci_do_adma(SDHCIState *s)
772 {
773     unsigned int begin, length;
774     const uint16_t block_size = s->blksize & BLOCK_SIZE_MASK;
775     const MemTxAttrs attrs = { .memory = true };
776     ADMADescr dscr = {};
777     MemTxResult res = MEMTX_ERROR;
778     int i;
779 
780     if (s->trnmod & SDHC_TRNS_BLK_CNT_EN && !s->blkcnt) {
781         /* Stop Multiple Transfer */
782         sdhci_end_transfer(s);
783         return;
784     }
785 
786     for (i = 0; i < SDHC_ADMA_DESCS_PER_DELAY; ++i) {
787         s->admaerr &= ~SDHC_ADMAERR_LENGTH_MISMATCH;
788 
789         get_adma_description(s, &dscr);
790         trace_sdhci_adma_loop(dscr.addr, dscr.length, dscr.attr);
791 
792         if ((dscr.attr & SDHC_ADMA_ATTR_VALID) == 0) {
793             /* Indicate that error occurred in ST_FDS state */
794             s->admaerr &= ~SDHC_ADMAERR_STATE_MASK;
795             s->admaerr |= SDHC_ADMAERR_STATE_ST_FDS;
796 
797             /* Generate ADMA error interrupt */
798             if (s->errintstsen & SDHC_EISEN_ADMAERR) {
799                 s->errintsts |= SDHC_EIS_ADMAERR;
800                 s->norintsts |= SDHC_NIS_ERR;
801             }
802 
803             sdhci_update_irq(s);
804             return;
805         }
806 
807         length = dscr.length ? dscr.length : 64 * KiB;
808 
809         switch (dscr.attr & SDHC_ADMA_ATTR_ACT_MASK) {
810         case SDHC_ADMA_ATTR_ACT_TRAN:  /* data transfer */
811             s->prnsts |= SDHC_DATA_INHIBIT | SDHC_DAT_LINE_ACTIVE;
812             if (s->trnmod & SDHC_TRNS_READ) {
813                 s->prnsts |= SDHC_DOING_READ;
814                 while (length) {
815                     if (s->data_count == 0) {
816                         sdbus_read_data(&s->sdbus, s->fifo_buffer, block_size);
817                     }
818                     begin = s->data_count;
819                     if ((length + begin) < block_size) {
820                         s->data_count = length + begin;
821                         length = 0;
822                      } else {
823                         s->data_count = block_size;
824                         length -= block_size - begin;
825                     }
826                     res = dma_memory_write(s->dma_as, dscr.addr,
827                                            &s->fifo_buffer[begin],
828                                            s->data_count - begin,
829                                            attrs);
830                     if (res != MEMTX_OK) {
831                         break;
832                     }
833                     dscr.addr += s->data_count - begin;
834                     if (s->data_count == block_size) {
835                         s->data_count = 0;
836                         if (s->trnmod & SDHC_TRNS_BLK_CNT_EN) {
837                             s->blkcnt--;
838                             if (s->blkcnt == 0) {
839                                 break;
840                             }
841                         }
842                     }
843                 }
844             } else {
845                 s->prnsts |= SDHC_DOING_WRITE;
846                 while (length) {
847                     begin = s->data_count;
848                     if ((length + begin) < block_size) {
849                         s->data_count = length + begin;
850                         length = 0;
851                      } else {
852                         s->data_count = block_size;
853                         length -= block_size - begin;
854                     }
855                     res = dma_memory_read(s->dma_as, dscr.addr,
856                                           &s->fifo_buffer[begin],
857                                           s->data_count - begin,
858                                           attrs);
859                     if (res != MEMTX_OK) {
860                         break;
861                     }
862                     dscr.addr += s->data_count - begin;
863                     if (s->data_count == block_size) {
864                         sdbus_write_data(&s->sdbus, s->fifo_buffer, block_size);
865                         s->data_count = 0;
866                         if (s->trnmod & SDHC_TRNS_BLK_CNT_EN) {
867                             s->blkcnt--;
868                             if (s->blkcnt == 0) {
869                                 break;
870                             }
871                         }
872                     }
873                 }
874             }
875             if (res != MEMTX_OK) {
876                 s->data_count = 0;
877                 if (s->errintstsen & SDHC_EISEN_ADMAERR) {
878                     trace_sdhci_error("Set ADMA error flag");
879                     s->errintsts |= SDHC_EIS_ADMAERR;
880                     s->norintsts |= SDHC_NIS_ERR;
881                 }
882                 sdhci_update_irq(s);
883             } else {
884                 s->admasysaddr += dscr.incr;
885             }
886             break;
887         case SDHC_ADMA_ATTR_ACT_LINK:   /* link to next descriptor table */
888             s->admasysaddr = dscr.addr;
889             trace_sdhci_adma("link", s->admasysaddr);
890             break;
891         default:
892             s->admasysaddr += dscr.incr;
893             break;
894         }
895 
896         if (dscr.attr & SDHC_ADMA_ATTR_INT) {
897             trace_sdhci_adma("interrupt", s->admasysaddr);
898             if (s->norintstsen & SDHC_NISEN_DMA) {
899                 s->norintsts |= SDHC_NIS_DMA;
900             }
901 
902             if (sdhci_update_irq(s) && !(dscr.attr & SDHC_ADMA_ATTR_END)) {
903                 /* IRQ delivered, reschedule current transfer */
904                 break;
905             }
906         }
907 
908         /* ADMA transfer terminates if blkcnt == 0 or by END attribute */
909         if (((s->trnmod & SDHC_TRNS_BLK_CNT_EN) &&
910                     (s->blkcnt == 0)) || (dscr.attr & SDHC_ADMA_ATTR_END)) {
911             trace_sdhci_adma_transfer_completed();
912             if (length || ((dscr.attr & SDHC_ADMA_ATTR_END) &&
913                 (s->trnmod & SDHC_TRNS_BLK_CNT_EN) &&
914                 s->blkcnt != 0)) {
915                 trace_sdhci_error("SD/MMC host ADMA length mismatch");
916                 s->admaerr |= SDHC_ADMAERR_LENGTH_MISMATCH |
917                         SDHC_ADMAERR_STATE_ST_TFR;
918                 if (s->errintstsen & SDHC_EISEN_ADMAERR) {
919                     trace_sdhci_error("Set ADMA error flag");
920                     s->errintsts |= SDHC_EIS_ADMAERR;
921                     s->norintsts |= SDHC_NIS_ERR;
922                 }
923 
924                 sdhci_update_irq(s);
925             }
926             sdhci_end_transfer(s);
927             return;
928         }
929 
930     }
931 
932     /* we have unfinished business - reschedule to continue ADMA */
933     timer_mod(s->transfer_timer,
934                    qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + SDHC_TRANSFER_DELAY);
935 }
936 
937 /* Perform data transfer according to controller configuration */
938 
939 static void sdhci_data_transfer(void *opaque)
940 {
941     SDHCIState *s = (SDHCIState *)opaque;
942 
943     if (s->trnmod & SDHC_TRNS_DMA) {
944         switch (SDHC_DMA_TYPE(s->hostctl1)) {
945         case SDHC_CTRL_SDMA:
946             sdhci_sdma_transfer(s);
947             break;
948         case SDHC_CTRL_ADMA1_32:
949             if (!(s->capareg & R_SDHC_CAPAB_ADMA1_MASK)) {
950                 trace_sdhci_error("ADMA1 not supported");
951                 break;
952             }
953 
954             sdhci_do_adma(s);
955             break;
956         case SDHC_CTRL_ADMA2_32:
957             if (!(s->capareg & R_SDHC_CAPAB_ADMA2_MASK)) {
958                 trace_sdhci_error("ADMA2 not supported");
959                 break;
960             }
961 
962             sdhci_do_adma(s);
963             break;
964         case SDHC_CTRL_ADMA2_64:
965             if (!(s->capareg & R_SDHC_CAPAB_ADMA2_MASK) ||
966                     !(s->capareg & R_SDHC_CAPAB_BUS64BIT_MASK)) {
967                 trace_sdhci_error("64 bit ADMA not supported");
968                 break;
969             }
970 
971             sdhci_do_adma(s);
972             break;
973         default:
974             trace_sdhci_error("Unsupported DMA type");
975             break;
976         }
977     } else {
978         if ((s->trnmod & SDHC_TRNS_READ) && sdbus_data_ready(&s->sdbus)) {
979             s->prnsts |= SDHC_DOING_READ | SDHC_DATA_INHIBIT |
980                     SDHC_DAT_LINE_ACTIVE;
981             sdhci_read_block_from_card(s);
982         } else {
983             s->prnsts |= SDHC_DOING_WRITE | SDHC_DAT_LINE_ACTIVE |
984                     SDHC_SPACE_AVAILABLE | SDHC_DATA_INHIBIT;
985             sdhci_write_block_to_card(s);
986         }
987     }
988 }
989 
990 static bool sdhci_can_issue_command(SDHCIState *s)
991 {
992     if (!SDHC_CLOCK_IS_ON(s->clkcon) ||
993         (((s->prnsts & SDHC_DATA_INHIBIT) || s->stopped_state) &&
994         ((s->cmdreg & SDHC_CMD_DATA_PRESENT) ||
995         ((s->cmdreg & SDHC_CMD_RESPONSE) == SDHC_CMD_RSP_WITH_BUSY &&
996         !(SDHC_COMMAND_TYPE(s->cmdreg) == SDHC_CMD_ABORT))))) {
997         return false;
998     }
999 
1000     return true;
1001 }
1002 
1003 /*
1004  * The Buffer Data Port register must be accessed in sequential and
1005  * continuous manner
1006  */
1007 static inline bool
1008 sdhci_buff_access_is_sequential(SDHCIState *s, unsigned byte_num)
1009 {
1010     if ((s->data_count & 0x3) != byte_num) {
1011         qemu_log_mask(LOG_GUEST_ERROR,
1012                       "SDHCI: Non-sequential access to Buffer Data Port"
1013                       " register is prohibited\n");
1014         return false;
1015     }
1016     return true;
1017 }
1018 
1019 static void sdhci_resume_pending_transfer(SDHCIState *s)
1020 {
1021     timer_del(s->transfer_timer);
1022     sdhci_data_transfer(s);
1023 }
1024 
1025 static uint64_t sdhci_read(void *opaque, hwaddr offset, unsigned size)
1026 {
1027     SDHCIState *s = (SDHCIState *)opaque;
1028     uint32_t ret = 0;
1029 
1030     if (timer_pending(s->transfer_timer)) {
1031         sdhci_resume_pending_transfer(s);
1032     }
1033 
1034     switch (offset & ~0x3) {
1035     case SDHC_SYSAD:
1036         ret = s->sdmasysad;
1037         break;
1038     case SDHC_BLKSIZE:
1039         ret = s->blksize | (s->blkcnt << 16);
1040         break;
1041     case SDHC_ARGUMENT:
1042         ret = s->argument;
1043         break;
1044     case SDHC_TRNMOD:
1045         ret = s->trnmod | (s->cmdreg << 16);
1046         break;
1047     case SDHC_RSPREG0 ... SDHC_RSPREG3:
1048         ret = s->rspreg[((offset & ~0x3) - SDHC_RSPREG0) >> 2];
1049         break;
1050     case  SDHC_BDATA:
1051         if (sdhci_buff_access_is_sequential(s, offset - SDHC_BDATA)) {
1052             ret = sdhci_read_dataport(s, size);
1053             trace_sdhci_access("rd", size << 3, offset, "->", ret, ret);
1054             return ret;
1055         }
1056         break;
1057     case SDHC_PRNSTS:
1058         ret = s->prnsts;
1059         ret = FIELD_DP32(ret, SDHC_PRNSTS, DAT_LVL,
1060                          sdbus_get_dat_lines(&s->sdbus));
1061         ret = FIELD_DP32(ret, SDHC_PRNSTS, CMD_LVL,
1062                          sdbus_get_cmd_line(&s->sdbus));
1063         break;
1064     case SDHC_HOSTCTL:
1065         ret = s->hostctl1 | (s->pwrcon << 8) | (s->blkgap << 16) |
1066               (s->wakcon << 24);
1067         break;
1068     case SDHC_CLKCON:
1069         ret = s->clkcon | (s->timeoutcon << 16);
1070         break;
1071     case SDHC_NORINTSTS:
1072         ret = s->norintsts | (s->errintsts << 16);
1073         break;
1074     case SDHC_NORINTSTSEN:
1075         ret = s->norintstsen | (s->errintstsen << 16);
1076         break;
1077     case SDHC_NORINTSIGEN:
1078         ret = s->norintsigen | (s->errintsigen << 16);
1079         break;
1080     case SDHC_ACMD12ERRSTS:
1081         ret = s->acmd12errsts | (s->hostctl2 << 16);
1082         break;
1083     case SDHC_CAPAB:
1084         ret = (uint32_t)s->capareg;
1085         break;
1086     case SDHC_CAPAB + 4:
1087         ret = (uint32_t)(s->capareg >> 32);
1088         break;
1089     case SDHC_MAXCURR:
1090         ret = (uint32_t)s->maxcurr;
1091         break;
1092     case SDHC_MAXCURR + 4:
1093         ret = (uint32_t)(s->maxcurr >> 32);
1094         break;
1095     case SDHC_ADMAERR:
1096         ret =  s->admaerr;
1097         break;
1098     case SDHC_ADMASYSADDR:
1099         ret = (uint32_t)s->admasysaddr;
1100         break;
1101     case SDHC_ADMASYSADDR + 4:
1102         ret = (uint32_t)(s->admasysaddr >> 32);
1103         break;
1104     case SDHC_SLOT_INT_STATUS:
1105         ret = (s->version << 16) | sdhci_slotint(s);
1106         break;
1107     default:
1108         qemu_log_mask(LOG_UNIMP, "SDHC rd_%ub @0x%02" HWADDR_PRIx " "
1109                       "not implemented\n", size, offset);
1110         break;
1111     }
1112 
1113     ret >>= (offset & 0x3) * 8;
1114     ret &= (1ULL << (size * 8)) - 1;
1115     trace_sdhci_access("rd", size << 3, offset, "->", ret, ret);
1116     return ret;
1117 }
1118 
1119 static inline void sdhci_blkgap_write(SDHCIState *s, uint8_t value)
1120 {
1121     if ((value & SDHC_STOP_AT_GAP_REQ) && (s->blkgap & SDHC_STOP_AT_GAP_REQ)) {
1122         return;
1123     }
1124     s->blkgap = value & SDHC_STOP_AT_GAP_REQ;
1125 
1126     if ((value & SDHC_CONTINUE_REQ) && s->stopped_state &&
1127             (s->blkgap & SDHC_STOP_AT_GAP_REQ) == 0) {
1128         if (s->stopped_state == sdhc_gap_read) {
1129             s->prnsts |= SDHC_DAT_LINE_ACTIVE | SDHC_DOING_READ;
1130             sdhci_read_block_from_card(s);
1131         } else {
1132             s->prnsts |= SDHC_DAT_LINE_ACTIVE | SDHC_DOING_WRITE;
1133             sdhci_write_block_to_card(s);
1134         }
1135         s->stopped_state = sdhc_not_stopped;
1136     } else if (!s->stopped_state && (value & SDHC_STOP_AT_GAP_REQ)) {
1137         if (s->prnsts & SDHC_DOING_READ) {
1138             s->stopped_state = sdhc_gap_read;
1139         } else if (s->prnsts & SDHC_DOING_WRITE) {
1140             s->stopped_state = sdhc_gap_write;
1141         }
1142     }
1143 }
1144 
1145 static inline void sdhci_reset_write(SDHCIState *s, uint8_t value)
1146 {
1147     switch (value) {
1148     case SDHC_RESET_ALL:
1149         sdhci_reset(s);
1150         break;
1151     case SDHC_RESET_CMD:
1152         s->prnsts &= ~SDHC_CMD_INHIBIT;
1153         s->norintsts &= ~SDHC_NIS_CMDCMP;
1154         break;
1155     case SDHC_RESET_DATA:
1156         s->data_count = 0;
1157         s->prnsts &= ~(SDHC_SPACE_AVAILABLE | SDHC_DATA_AVAILABLE |
1158                 SDHC_DOING_READ | SDHC_DOING_WRITE |
1159                 SDHC_DATA_INHIBIT | SDHC_DAT_LINE_ACTIVE);
1160         s->blkgap &= ~(SDHC_STOP_AT_GAP_REQ | SDHC_CONTINUE_REQ);
1161         s->stopped_state = sdhc_not_stopped;
1162         s->norintsts &= ~(SDHC_NIS_WBUFRDY | SDHC_NIS_RBUFRDY |
1163                 SDHC_NIS_DMA | SDHC_NIS_TRSCMP | SDHC_NIS_BLKGAP);
1164         break;
1165     }
1166 }
1167 
1168 static void
1169 sdhci_write(void *opaque, hwaddr offset, uint64_t val, unsigned size)
1170 {
1171     SDHCIState *s = (SDHCIState *)opaque;
1172     unsigned shift =  8 * (offset & 0x3);
1173     uint32_t mask = ~(((1ULL << (size * 8)) - 1) << shift);
1174     uint32_t value = val;
1175     value <<= shift;
1176 
1177     if (timer_pending(s->transfer_timer)) {
1178         sdhci_resume_pending_transfer(s);
1179     }
1180 
1181     switch (offset & ~0x3) {
1182     case SDHC_SYSAD:
1183         if (!TRANSFERRING_DATA(s->prnsts)) {
1184             s->sdmasysad = (s->sdmasysad & mask) | value;
1185             MASKED_WRITE(s->sdmasysad, mask, value);
1186             /* Writing to last byte of sdmasysad might trigger transfer */
1187             if (!(mask & 0xFF000000) && s->blkcnt &&
1188                 (s->blksize & BLOCK_SIZE_MASK) &&
1189                 SDHC_DMA_TYPE(s->hostctl1) == SDHC_CTRL_SDMA) {
1190                 sdhci_sdma_transfer(s);
1191             }
1192         }
1193         break;
1194     case SDHC_BLKSIZE:
1195         if (!TRANSFERRING_DATA(s->prnsts)) {
1196             uint16_t blksize = s->blksize;
1197 
1198             /*
1199              * [14:12] SDMA Buffer Boundary
1200              * [11:00] Transfer Block Size
1201              */
1202             MASKED_WRITE(s->blksize, mask, extract32(value, 0, 15));
1203             MASKED_WRITE(s->blkcnt, mask >> 16, value >> 16);
1204 
1205             /* Limit block size to the maximum buffer size */
1206             if (extract32(s->blksize, 0, 12) > s->buf_maxsz) {
1207                 qemu_log_mask(LOG_GUEST_ERROR, "%s: Size 0x%x is larger than "
1208                               "the maximum buffer 0x%x\n", __func__, s->blksize,
1209                               s->buf_maxsz);
1210 
1211                 s->blksize = deposit32(s->blksize, 0, 12, s->buf_maxsz);
1212             }
1213 
1214             /*
1215              * If the block size is programmed to a different value from
1216              * the previous one, reset the data pointer of s->fifo_buffer[]
1217              * so that s->fifo_buffer[] can be filled in using the new block
1218              * size in the next transfer.
1219              */
1220             if (blksize != s->blksize) {
1221                 s->data_count = 0;
1222             }
1223         }
1224 
1225         break;
1226     case SDHC_ARGUMENT:
1227         MASKED_WRITE(s->argument, mask, value);
1228         break;
1229     case SDHC_TRNMOD:
1230         /*
1231          * DMA can be enabled only if it is supported as indicated by
1232          * capabilities register
1233          */
1234         if (!(s->capareg & R_SDHC_CAPAB_SDMA_MASK)) {
1235             value &= ~SDHC_TRNS_DMA;
1236         }
1237 
1238         /* TRNMOD writes are inhibited while Command Inhibit (DAT) is true */
1239         if (s->prnsts & SDHC_DATA_INHIBIT) {
1240             mask |= 0xffff;
1241         }
1242 
1243         MASKED_WRITE(s->trnmod, mask, value & SDHC_TRNMOD_MASK);
1244         MASKED_WRITE(s->cmdreg, mask >> 16, value >> 16);
1245 
1246         /* Writing to the upper byte of CMDREG triggers SD command generation */
1247         if ((mask & 0xFF000000) || !sdhci_can_issue_command(s)) {
1248             break;
1249         }
1250 
1251         sdhci_send_command(s);
1252         break;
1253     case  SDHC_BDATA:
1254         if (sdhci_buff_access_is_sequential(s, offset - SDHC_BDATA)) {
1255             sdhci_write_dataport(s, value >> shift, size);
1256         }
1257         break;
1258     case SDHC_HOSTCTL:
1259         if (!(mask & 0xFF0000)) {
1260             sdhci_blkgap_write(s, value >> 16);
1261         }
1262         MASKED_WRITE(s->hostctl1, mask, value);
1263         MASKED_WRITE(s->pwrcon, mask >> 8, value >> 8);
1264         MASKED_WRITE(s->wakcon, mask >> 24, value >> 24);
1265         if (!(s->prnsts & SDHC_CARD_PRESENT) || ((s->pwrcon >> 1) & 0x7) < 5 ||
1266                 !(s->capareg & (1 << (31 - ((s->pwrcon >> 1) & 0x7))))) {
1267             s->pwrcon &= ~SDHC_POWER_ON;
1268         }
1269         break;
1270     case SDHC_CLKCON:
1271         if (!(mask & 0xFF000000)) {
1272             sdhci_reset_write(s, value >> 24);
1273         }
1274         MASKED_WRITE(s->clkcon, mask, value);
1275         MASKED_WRITE(s->timeoutcon, mask >> 16, value >> 16);
1276         if (s->clkcon & SDHC_CLOCK_INT_EN) {
1277             s->clkcon |= SDHC_CLOCK_INT_STABLE;
1278         } else {
1279             s->clkcon &= ~SDHC_CLOCK_INT_STABLE;
1280         }
1281         break;
1282     case SDHC_NORINTSTS:
1283         if (s->norintstsen & SDHC_NISEN_CARDINT) {
1284             value &= ~SDHC_NIS_CARDINT;
1285         }
1286         s->norintsts &= mask | ~value;
1287         s->errintsts &= (mask >> 16) | ~(value >> 16);
1288         if (s->errintsts) {
1289             s->norintsts |= SDHC_NIS_ERR;
1290         } else {
1291             s->norintsts &= ~SDHC_NIS_ERR;
1292         }
1293         sdhci_update_irq(s);
1294         break;
1295     case SDHC_NORINTSTSEN:
1296         MASKED_WRITE(s->norintstsen, mask, value);
1297         MASKED_WRITE(s->errintstsen, mask >> 16, value >> 16);
1298         s->norintsts &= s->norintstsen;
1299         s->errintsts &= s->errintstsen;
1300         if (s->errintsts) {
1301             s->norintsts |= SDHC_NIS_ERR;
1302         } else {
1303             s->norintsts &= ~SDHC_NIS_ERR;
1304         }
1305         /*
1306          * Quirk for Raspberry Pi: pending card insert interrupt
1307          * appears when first enabled after power on
1308          */
1309         if ((s->norintstsen & SDHC_NISEN_INSERT) && s->pending_insert_state) {
1310             assert(s->pending_insert_quirk);
1311             s->norintsts |= SDHC_NIS_INSERT;
1312             s->pending_insert_state = false;
1313         }
1314         sdhci_update_irq(s);
1315         break;
1316     case SDHC_NORINTSIGEN:
1317         MASKED_WRITE(s->norintsigen, mask, value);
1318         MASKED_WRITE(s->errintsigen, mask >> 16, value >> 16);
1319         sdhci_update_irq(s);
1320         break;
1321     case SDHC_ADMAERR:
1322         MASKED_WRITE(s->admaerr, mask, value);
1323         break;
1324     case SDHC_ADMASYSADDR:
1325         s->admasysaddr = (s->admasysaddr & (0xFFFFFFFF00000000ULL |
1326                 (uint64_t)mask)) | (uint64_t)value;
1327         break;
1328     case SDHC_ADMASYSADDR + 4:
1329         s->admasysaddr = (s->admasysaddr & (0x00000000FFFFFFFFULL |
1330                 ((uint64_t)mask << 32))) | ((uint64_t)value << 32);
1331         break;
1332     case SDHC_FEAER:
1333         s->acmd12errsts |= value;
1334         s->errintsts |= (value >> 16) & s->errintstsen;
1335         if (s->acmd12errsts) {
1336             s->errintsts |= SDHC_EIS_CMD12ERR;
1337         }
1338         if (s->errintsts) {
1339             s->norintsts |= SDHC_NIS_ERR;
1340         }
1341         sdhci_update_irq(s);
1342         break;
1343     case SDHC_ACMD12ERRSTS:
1344         MASKED_WRITE(s->acmd12errsts, mask, value & UINT16_MAX);
1345         if (s->uhs_mode >= UHS_I) {
1346             MASKED_WRITE(s->hostctl2, mask >> 16, value >> 16);
1347 
1348             if (FIELD_EX32(s->hostctl2, SDHC_HOSTCTL2, V18_ENA)) {
1349                 sdbus_set_voltage(&s->sdbus, SD_VOLTAGE_1_8V);
1350             } else {
1351                 sdbus_set_voltage(&s->sdbus, SD_VOLTAGE_3_3V);
1352             }
1353         }
1354         break;
1355 
1356     case SDHC_CAPAB:
1357     case SDHC_CAPAB + 4:
1358     case SDHC_MAXCURR:
1359     case SDHC_MAXCURR + 4:
1360         qemu_log_mask(LOG_GUEST_ERROR, "SDHC wr_%ub @0x%02" HWADDR_PRIx
1361                       " <- 0x%08x read-only\n", size, offset, value >> shift);
1362         break;
1363 
1364     default:
1365         qemu_log_mask(LOG_UNIMP, "SDHC wr_%ub @0x%02" HWADDR_PRIx " <- 0x%08x "
1366                       "not implemented\n", size, offset, value >> shift);
1367         break;
1368     }
1369     trace_sdhci_access("wr", size << 3, offset, "<-",
1370                        value >> shift, value >> shift);
1371 }
1372 
1373 static const MemoryRegionOps sdhci_mmio_le_ops = {
1374     .read = sdhci_read,
1375     .write = sdhci_write,
1376     .valid = {
1377         .min_access_size = 1,
1378         .max_access_size = 4,
1379         .unaligned = false
1380     },
1381     .endianness = DEVICE_LITTLE_ENDIAN,
1382 };
1383 
1384 static const MemoryRegionOps sdhci_mmio_be_ops = {
1385     .read = sdhci_read,
1386     .write = sdhci_write,
1387     .impl = {
1388         .min_access_size = 4,
1389         .max_access_size = 4,
1390     },
1391     .valid = {
1392         .min_access_size = 1,
1393         .max_access_size = 4,
1394         .unaligned = false
1395     },
1396     .endianness = DEVICE_BIG_ENDIAN,
1397 };
1398 
1399 static void sdhci_init_readonly_registers(SDHCIState *s, Error **errp)
1400 {
1401     ERRP_GUARD();
1402 
1403     switch (s->sd_spec_version) {
1404     case 2 ... 3:
1405         break;
1406     default:
1407         error_setg(errp, "Only Spec v2/v3 are supported");
1408         return;
1409     }
1410     s->version = (SDHC_HCVER_VENDOR << 8) | (s->sd_spec_version - 1);
1411 
1412     sdhci_check_capareg(s, errp);
1413     if (*errp) {
1414         return;
1415     }
1416 }
1417 
1418 /* --- qdev common --- */
1419 
1420 void sdhci_initfn(SDHCIState *s)
1421 {
1422     qbus_init(&s->sdbus, sizeof(s->sdbus), TYPE_SDHCI_BUS, DEVICE(s), "sd-bus");
1423 
1424     s->insert_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL,
1425                                    sdhci_raise_insertion_irq, s);
1426     s->transfer_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL,
1427                                      sdhci_data_transfer, s);
1428 
1429     s->io_ops = &sdhci_mmio_le_ops;
1430 }
1431 
1432 void sdhci_uninitfn(SDHCIState *s)
1433 {
1434     timer_free(s->insert_timer);
1435     timer_free(s->transfer_timer);
1436 
1437     g_free(s->fifo_buffer);
1438     s->fifo_buffer = NULL;
1439 }
1440 
1441 void sdhci_common_realize(SDHCIState *s, Error **errp)
1442 {
1443     ERRP_GUARD();
1444 
1445     switch (s->endianness) {
1446     case DEVICE_LITTLE_ENDIAN:
1447         /* s->io_ops is little endian by default */
1448         break;
1449     case DEVICE_BIG_ENDIAN:
1450         if (s->io_ops != &sdhci_mmio_le_ops) {
1451             error_setg(errp, "SD controller doesn't support big endianness");
1452             return;
1453         }
1454         s->io_ops = &sdhci_mmio_be_ops;
1455         break;
1456     default:
1457         error_setg(errp, "Incorrect endianness");
1458         return;
1459     }
1460 
1461     sdhci_init_readonly_registers(s, errp);
1462     if (*errp) {
1463         return;
1464     }
1465 
1466     s->buf_maxsz = sdhci_get_fifolen(s);
1467     s->fifo_buffer = g_malloc0(s->buf_maxsz);
1468 
1469     memory_region_init_io(&s->iomem, OBJECT(s), s->io_ops, s, "sdhci",
1470                           SDHC_REGISTERS_MAP_SIZE);
1471 }
1472 
1473 void sdhci_common_unrealize(SDHCIState *s)
1474 {
1475     /*
1476      * This function is expected to be called only once for each class:
1477      * - SysBus:    via DeviceClass->unrealize(),
1478      * - PCI:       via PCIDeviceClass->exit().
1479      * However to avoid double-free and/or use-after-free we still nullify
1480      * this variable (better safe than sorry!).
1481      */
1482     g_free(s->fifo_buffer);
1483     s->fifo_buffer = NULL;
1484 }
1485 
1486 static bool sdhci_pending_insert_vmstate_needed(void *opaque)
1487 {
1488     SDHCIState *s = opaque;
1489 
1490     return s->pending_insert_state;
1491 }
1492 
1493 static const VMStateDescription sdhci_pending_insert_vmstate = {
1494     .name = "sdhci/pending-insert",
1495     .version_id = 1,
1496     .minimum_version_id = 1,
1497     .needed = sdhci_pending_insert_vmstate_needed,
1498     .fields = (const VMStateField[]) {
1499         VMSTATE_BOOL(pending_insert_state, SDHCIState),
1500         VMSTATE_END_OF_LIST()
1501     },
1502 };
1503 
1504 const VMStateDescription sdhci_vmstate = {
1505     .name = "sdhci",
1506     .version_id = 1,
1507     .minimum_version_id = 1,
1508     .fields = (const VMStateField[]) {
1509         VMSTATE_UINT32(sdmasysad, SDHCIState),
1510         VMSTATE_UINT16(blksize, SDHCIState),
1511         VMSTATE_UINT16(blkcnt, SDHCIState),
1512         VMSTATE_UINT32(argument, SDHCIState),
1513         VMSTATE_UINT16(trnmod, SDHCIState),
1514         VMSTATE_UINT16(cmdreg, SDHCIState),
1515         VMSTATE_UINT32_ARRAY(rspreg, SDHCIState, 4),
1516         VMSTATE_UINT32(prnsts, SDHCIState),
1517         VMSTATE_UINT8(hostctl1, SDHCIState),
1518         VMSTATE_UINT8(pwrcon, SDHCIState),
1519         VMSTATE_UINT8(blkgap, SDHCIState),
1520         VMSTATE_UINT8(wakcon, SDHCIState),
1521         VMSTATE_UINT16(clkcon, SDHCIState),
1522         VMSTATE_UINT8(timeoutcon, SDHCIState),
1523         VMSTATE_UINT8(admaerr, SDHCIState),
1524         VMSTATE_UINT16(norintsts, SDHCIState),
1525         VMSTATE_UINT16(errintsts, SDHCIState),
1526         VMSTATE_UINT16(norintstsen, SDHCIState),
1527         VMSTATE_UINT16(errintstsen, SDHCIState),
1528         VMSTATE_UINT16(norintsigen, SDHCIState),
1529         VMSTATE_UINT16(errintsigen, SDHCIState),
1530         VMSTATE_UINT16(acmd12errsts, SDHCIState),
1531         VMSTATE_UINT16(data_count, SDHCIState),
1532         VMSTATE_UINT64(admasysaddr, SDHCIState),
1533         VMSTATE_UINT8(stopped_state, SDHCIState),
1534         VMSTATE_VBUFFER_UINT32(fifo_buffer, SDHCIState, 1, NULL, buf_maxsz),
1535         VMSTATE_TIMER_PTR(insert_timer, SDHCIState),
1536         VMSTATE_TIMER_PTR(transfer_timer, SDHCIState),
1537         VMSTATE_END_OF_LIST()
1538     },
1539     .subsections = (const VMStateDescription * const []) {
1540         &sdhci_pending_insert_vmstate,
1541         NULL
1542     },
1543 };
1544 
1545 void sdhci_common_class_init(ObjectClass *klass, const void *data)
1546 {
1547     DeviceClass *dc = DEVICE_CLASS(klass);
1548 
1549     set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
1550     dc->vmsd = &sdhci_vmstate;
1551     device_class_set_legacy_reset(dc, sdhci_poweron_reset);
1552 }
1553 
1554 /* --- qdev SysBus --- */
1555 
1556 static const Property sdhci_sysbus_properties[] = {
1557     DEFINE_SDHCI_COMMON_PROPERTIES(SDHCIState),
1558     DEFINE_PROP_BOOL("pending-insert-quirk", SDHCIState, pending_insert_quirk,
1559                      false),
1560     DEFINE_PROP_LINK("dma", SDHCIState,
1561                      dma_mr, TYPE_MEMORY_REGION, MemoryRegion *),
1562     DEFINE_PROP_BOOL("wp-inverted", SDHCIState,
1563                      wp_inverted, false),
1564 };
1565 
1566 static void sdhci_sysbus_init(Object *obj)
1567 {
1568     SDHCIState *s = SYSBUS_SDHCI(obj);
1569 
1570     sdhci_initfn(s);
1571 }
1572 
1573 static void sdhci_sysbus_finalize(Object *obj)
1574 {
1575     SDHCIState *s = SYSBUS_SDHCI(obj);
1576 
1577     if (s->dma_mr) {
1578         object_unparent(OBJECT(s->dma_mr));
1579     }
1580 
1581     sdhci_uninitfn(s);
1582 }
1583 
1584 static void sdhci_sysbus_realize(DeviceState *dev, Error **errp)
1585 {
1586     ERRP_GUARD();
1587     SDHCIState *s = SYSBUS_SDHCI(dev);
1588     SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
1589 
1590     sdhci_common_realize(s, errp);
1591     if (*errp) {
1592         return;
1593     }
1594 
1595     if (s->dma_mr) {
1596         s->dma_as = &s->sysbus_dma_as;
1597         address_space_init(s->dma_as, s->dma_mr, "sdhci-dma");
1598     } else {
1599         /* use system_memory() if property "dma" not set */
1600         s->dma_as = &address_space_memory;
1601     }
1602 
1603     sysbus_init_irq(sbd, &s->irq);
1604 
1605     sysbus_init_mmio(sbd, &s->iomem);
1606 }
1607 
1608 static void sdhci_sysbus_unrealize(DeviceState *dev)
1609 {
1610     SDHCIState *s = SYSBUS_SDHCI(dev);
1611 
1612     sdhci_common_unrealize(s);
1613 
1614      if (s->dma_mr) {
1615         address_space_destroy(s->dma_as);
1616     }
1617 }
1618 
1619 static void sdhci_sysbus_class_init(ObjectClass *klass, void *data)
1620 {
1621     DeviceClass *dc = DEVICE_CLASS(klass);
1622 
1623     device_class_set_props(dc, sdhci_sysbus_properties);
1624     dc->realize = sdhci_sysbus_realize;
1625     dc->unrealize = sdhci_sysbus_unrealize;
1626 
1627     sdhci_common_class_init(klass, data);
1628 }
1629 
1630 /* --- qdev bus master --- */
1631 
1632 static void sdhci_bus_class_init(ObjectClass *klass, void *data)
1633 {
1634     SDBusClass *sbc = SD_BUS_CLASS(klass);
1635 
1636     sbc->set_inserted = sdhci_set_inserted;
1637     sbc->set_readonly = sdhci_set_readonly;
1638 }
1639 
1640 /* --- qdev i.MX eSDHC --- */
1641 
1642 #define USDHC_MIX_CTRL                  0x48
1643 
1644 #define USDHC_VENDOR_SPEC               0xc0
1645 #define USDHC_IMX_FRC_SDCLK_ON          (1 << 8)
1646 
1647 #define USDHC_DLL_CTRL                  0x60
1648 
1649 #define USDHC_TUNING_CTRL               0xcc
1650 #define USDHC_TUNE_CTRL_STATUS          0x68
1651 #define USDHC_WTMK_LVL                  0x44
1652 
1653 /* Undocumented register used by guests working around erratum ERR004536 */
1654 #define USDHC_UNDOCUMENTED_REG27        0x6c
1655 
1656 #define USDHC_CTRL_4BITBUS              (0x1 << 1)
1657 #define USDHC_CTRL_8BITBUS              (0x2 << 1)
1658 
1659 #define USDHC_PRNSTS_SDSTB              (1 << 3)
1660 
1661 static uint64_t usdhc_read(void *opaque, hwaddr offset, unsigned size)
1662 {
1663     SDHCIState *s = SYSBUS_SDHCI(opaque);
1664     uint32_t ret;
1665     uint16_t hostctl1;
1666 
1667     switch (offset) {
1668     default:
1669         return sdhci_read(opaque, offset, size);
1670 
1671     case SDHC_HOSTCTL:
1672         /*
1673          * For a detailed explanation on the following bit
1674          * manipulation code see comments in a similar part of
1675          * usdhc_write()
1676          */
1677         hostctl1 = SDHC_DMA_TYPE(s->hostctl1) << (8 - 3);
1678 
1679         if (s->hostctl1 & SDHC_CTRL_8BITBUS) {
1680             hostctl1 |= USDHC_CTRL_8BITBUS;
1681         }
1682 
1683         if (s->hostctl1 & SDHC_CTRL_4BITBUS) {
1684             hostctl1 |= USDHC_CTRL_4BITBUS;
1685         }
1686 
1687         ret  = hostctl1;
1688         ret |= (uint32_t)s->blkgap << 16;
1689         ret |= (uint32_t)s->wakcon << 24;
1690 
1691         break;
1692 
1693     case SDHC_PRNSTS:
1694         /* Add SDSTB (SD Clock Stable) bit to PRNSTS */
1695         ret = sdhci_read(opaque, offset, size) & ~USDHC_PRNSTS_SDSTB;
1696         if (s->clkcon & SDHC_CLOCK_INT_STABLE) {
1697             ret |= USDHC_PRNSTS_SDSTB;
1698         }
1699         break;
1700 
1701     case USDHC_VENDOR_SPEC:
1702         ret = s->vendor_spec;
1703         break;
1704     case USDHC_DLL_CTRL:
1705     case USDHC_TUNE_CTRL_STATUS:
1706     case USDHC_UNDOCUMENTED_REG27:
1707     case USDHC_TUNING_CTRL:
1708     case USDHC_MIX_CTRL:
1709     case USDHC_WTMK_LVL:
1710         ret = 0;
1711         break;
1712     }
1713 
1714     return ret;
1715 }
1716 
1717 static void
1718 usdhc_write(void *opaque, hwaddr offset, uint64_t val, unsigned size)
1719 {
1720     SDHCIState *s = SYSBUS_SDHCI(opaque);
1721     uint8_t hostctl1;
1722     uint32_t value = (uint32_t)val;
1723 
1724     switch (offset) {
1725     case USDHC_DLL_CTRL:
1726     case USDHC_TUNE_CTRL_STATUS:
1727     case USDHC_UNDOCUMENTED_REG27:
1728     case USDHC_TUNING_CTRL:
1729     case USDHC_WTMK_LVL:
1730         break;
1731 
1732     case USDHC_VENDOR_SPEC:
1733         s->vendor_spec = value;
1734         switch (s->vendor) {
1735         case SDHCI_VENDOR_IMX:
1736             if (value & USDHC_IMX_FRC_SDCLK_ON) {
1737                 s->prnsts &= ~SDHC_IMX_CLOCK_GATE_OFF;
1738             } else {
1739                 s->prnsts |= SDHC_IMX_CLOCK_GATE_OFF;
1740             }
1741             break;
1742         default:
1743             break;
1744         }
1745         break;
1746 
1747     case SDHC_HOSTCTL:
1748         /*
1749          * Here's What ESDHCI has at offset 0x28 (SDHC_HOSTCTL)
1750          *
1751          *       7         6     5      4      3      2        1      0
1752          * |-----------+--------+--------+-----------+----------+---------|
1753          * | Card      | Card   | Endian | DATA3     | Data     | Led     |
1754          * | Detect    | Detect | Mode   | as Card   | Transfer | Control |
1755          * | Signal    | Test   |        | Detection | Width    |         |
1756          * | Selection | Level  |        | Pin       |          |         |
1757          * |-----------+--------+--------+-----------+----------+---------|
1758          *
1759          * and 0x29
1760          *
1761          *  15      10 9    8
1762          * |----------+------|
1763          * | Reserved | DMA  |
1764          * |          | Sel. |
1765          * |          |      |
1766          * |----------+------|
1767          *
1768          * and here's what SDCHI spec expects those offsets to be:
1769          *
1770          * 0x28 (Host Control Register)
1771          *
1772          *     7        6         5       4  3      2         1        0
1773          * |--------+--------+----------+------+--------+----------+---------|
1774          * | Card   | Card   | Extended | DMA  | High   | Data     | LED     |
1775          * | Detect | Detect | Data     | Sel. | Speed  | Transfer | Control |
1776          * | Signal | Test   | Transfer |      | Enable | Width    |         |
1777          * | Sel.   | Level  | Width    |      |        |          |         |
1778          * |--------+--------+----------+------+--------+----------+---------|
1779          *
1780          * and 0x29 (Power Control Register)
1781          *
1782          * |----------------------------------|
1783          * | Power Control Register           |
1784          * |                                  |
1785          * | Description omitted,             |
1786          * | since it has no analog in ESDHCI |
1787          * |                                  |
1788          * |----------------------------------|
1789          *
1790          * Since offsets 0x2A and 0x2B should be compatible between
1791          * both IP specs we only need to reconcile least 16-bit of the
1792          * word we've been given.
1793          */
1794 
1795         /*
1796          * First, save bits 7 6 and 0 since they are identical
1797          */
1798         hostctl1 = value & (SDHC_CTRL_LED |
1799                             SDHC_CTRL_CDTEST_INS |
1800                             SDHC_CTRL_CDTEST_EN);
1801         /*
1802          * Second, split "Data Transfer Width" from bits 2 and 1 in to
1803          * bits 5 and 1
1804          */
1805         if (value & USDHC_CTRL_8BITBUS) {
1806             hostctl1 |= SDHC_CTRL_8BITBUS;
1807         }
1808 
1809         if (value & USDHC_CTRL_4BITBUS) {
1810             hostctl1 |= USDHC_CTRL_4BITBUS;
1811         }
1812 
1813         /*
1814          * Third, move DMA select from bits 9 and 8 to bits 4 and 3
1815          */
1816         hostctl1 |= SDHC_DMA_TYPE(value >> (8 - 3));
1817 
1818         /*
1819          * Now place the corrected value into low 16-bit of the value
1820          * we are going to give standard SDHCI write function
1821          *
1822          * NOTE: This transformation should be the inverse of what can
1823          * be found in drivers/mmc/host/sdhci-esdhc-imx.c in Linux
1824          * kernel
1825          */
1826         value &= ~UINT16_MAX;
1827         value |= hostctl1;
1828         value |= (uint16_t)s->pwrcon << 8;
1829 
1830         sdhci_write(opaque, offset, value, size);
1831         break;
1832 
1833     case USDHC_MIX_CTRL:
1834         /*
1835          * So, when SD/MMC stack in Linux tries to write to "Transfer
1836          * Mode Register", ESDHC i.MX quirk code will translate it
1837          * into a write to ESDHC_MIX_CTRL, so we do the opposite in
1838          * order to get where we started
1839          *
1840          * Note that Auto CMD23 Enable bit is located in a wrong place
1841          * on i.MX, but since it is not used by QEMU we do not care.
1842          *
1843          * We don't want to call sdhci_write(.., SDHC_TRNMOD, ...)
1844          * here because it will result in a call to
1845          * sdhci_send_command(s) which we don't want.
1846          *
1847          */
1848         s->trnmod = value & UINT16_MAX;
1849         break;
1850     case SDHC_TRNMOD:
1851         /*
1852          * Similar to above, but this time a write to "Command
1853          * Register" will be translated into a 4-byte write to
1854          * "Transfer Mode register" where lower 16-bit of value would
1855          * be set to zero. So what we do is fill those bits with
1856          * cached value from s->trnmod and let the SDHCI
1857          * infrastructure handle the rest
1858          */
1859         sdhci_write(opaque, offset, val | s->trnmod, size);
1860         break;
1861     case SDHC_BLKSIZE:
1862         /*
1863          * ESDHCI does not implement "Host SDMA Buffer Boundary", and
1864          * Linux driver will try to zero this field out which will
1865          * break the rest of SDHCI emulation.
1866          *
1867          * Linux defaults to maximum possible setting (512K boundary)
1868          * and it seems to be the only option that i.MX IP implements,
1869          * so we artificially set it to that value.
1870          */
1871         val |= 0x7 << 12;
1872         /* FALLTHROUGH */
1873     default:
1874         sdhci_write(opaque, offset, val, size);
1875         break;
1876     }
1877 }
1878 
1879 static const MemoryRegionOps usdhc_mmio_ops = {
1880     .read = usdhc_read,
1881     .write = usdhc_write,
1882     .valid = {
1883         .min_access_size = 1,
1884         .max_access_size = 4,
1885         .unaligned = false
1886     },
1887     .endianness = DEVICE_LITTLE_ENDIAN,
1888 };
1889 
1890 static void imx_usdhc_init(Object *obj)
1891 {
1892     SDHCIState *s = SYSBUS_SDHCI(obj);
1893 
1894     s->io_ops = &usdhc_mmio_ops;
1895     s->quirks = SDHCI_QUIRK_NO_BUSY_IRQ;
1896 }
1897 
1898 /* --- qdev Samsung s3c --- */
1899 
1900 #define S3C_SDHCI_CONTROL2      0x80
1901 #define S3C_SDHCI_CONTROL3      0x84
1902 #define S3C_SDHCI_CONTROL4      0x8c
1903 
1904 static uint64_t sdhci_s3c_read(void *opaque, hwaddr offset, unsigned size)
1905 {
1906     uint64_t ret;
1907 
1908     switch (offset) {
1909     case S3C_SDHCI_CONTROL2:
1910     case S3C_SDHCI_CONTROL3:
1911     case S3C_SDHCI_CONTROL4:
1912         /* ignore */
1913         ret = 0;
1914         break;
1915     default:
1916         ret = sdhci_read(opaque, offset, size);
1917         break;
1918     }
1919 
1920     return ret;
1921 }
1922 
1923 static void sdhci_s3c_write(void *opaque, hwaddr offset, uint64_t val,
1924                             unsigned size)
1925 {
1926     switch (offset) {
1927     case S3C_SDHCI_CONTROL2:
1928     case S3C_SDHCI_CONTROL3:
1929     case S3C_SDHCI_CONTROL4:
1930         /* ignore */
1931         break;
1932     default:
1933         sdhci_write(opaque, offset, val, size);
1934         break;
1935     }
1936 }
1937 
1938 static const MemoryRegionOps sdhci_s3c_mmio_ops = {
1939     .read = sdhci_s3c_read,
1940     .write = sdhci_s3c_write,
1941     .valid = {
1942         .min_access_size = 1,
1943         .max_access_size = 4,
1944         .unaligned = false
1945     },
1946     .endianness = DEVICE_LITTLE_ENDIAN,
1947 };
1948 
1949 static void sdhci_s3c_init(Object *obj)
1950 {
1951     SDHCIState *s = SYSBUS_SDHCI(obj);
1952 
1953     s->io_ops = &sdhci_s3c_mmio_ops;
1954 }
1955 
1956 static const TypeInfo sdhci_types[] = {
1957     {
1958         .name = TYPE_SDHCI_BUS,
1959         .parent = TYPE_SD_BUS,
1960         .instance_size = sizeof(SDBus),
1961         .class_init = sdhci_bus_class_init,
1962     },
1963     {
1964         .name = TYPE_SYSBUS_SDHCI,
1965         .parent = TYPE_SYS_BUS_DEVICE,
1966         .instance_size = sizeof(SDHCIState),
1967         .instance_init = sdhci_sysbus_init,
1968         .instance_finalize = sdhci_sysbus_finalize,
1969         .class_init = sdhci_sysbus_class_init,
1970     },
1971     {
1972         .name = TYPE_IMX_USDHC,
1973         .parent = TYPE_SYSBUS_SDHCI,
1974         .instance_init = imx_usdhc_init,
1975     },
1976     {
1977         .name = TYPE_S3C_SDHCI,
1978         .parent = TYPE_SYSBUS_SDHCI,
1979         .instance_init = sdhci_s3c_init,
1980     },
1981 };
1982 
1983 DEFINE_TYPES(sdhci_types)
1984