hw/sd/bcm2835_sdhost.c

   1 /*
   2  * Raspberry Pi (BCM2835) SD Host Controller
   3  *
   4  * Copyright (c) 2017 Antfield SAS
   5  *
   6  * Authors:
   7  *  Clement Deschamps <clement.deschamps@antfield.fr>
   8  *  Luc Michel <luc.michel@antfield.fr>
   9  *
  10  * This work is licensed under the terms of the GNU GPL, version 2 or later.
  11  * See the COPYING file in the top-level directory.
  12  */
  13
  14 #include "qemu/osdep.h"
  15 #include "qemu/log.h"
  16 #include "sysemu/blockdev.h"
  17 #include "hw/sd/bcm2835_sdhost.h"
  18 #include "trace.h"
  19
  20 #define TYPE_BCM2835_SDHOST_BUS "bcm2835-sdhost-bus"
  21 #define BCM2835_SDHOST_BUS(obj) \
  22     OBJECT_CHECK(SDBus, (obj), TYPE_BCM2835_SDHOST_BUS)
  23
  24 #define SDCMD  0x00 /* Command to SD card              - 16 R/W */
  25 #define SDARG  0x04 /* Argument to SD card             - 32 R/W */
  26 #define SDTOUT 0x08 /* Start value for timeout counter - 32 R/W */
  27 #define SDCDIV 0x0c /* Start value for clock divider   - 11 R/W */
  28 #define SDRSP0 0x10 /* SD card rsp (31:0)         - 32 R   */
  29 #define SDRSP1 0x14 /* SD card rsp (63:32)        - 32 R   */
  30 #define SDRSP2 0x18 /* SD card rsp (95:64)        - 32 R   */
  31 #define SDRSP3 0x1c /* SD card rsp (127:96)       - 32 R   */
  32 #define SDHSTS 0x20 /* SD host status                  - 11 R   */
  33 #define SDVDD  0x30 /* SD card power control           -  1 R/W */
  34 #define SDEDM  0x34 /* Emergency Debug Mode            - 13 R/W */
  35 #define SDHCFG 0x38 /* Host configuration              -  2 R/W */
  36 #define SDHBCT 0x3c /* Host byte count (debug)         - 32 R/W */
  37 #define SDDATA 0x40 /* Data to/from SD card            - 32 R/W */
  38 #define SDHBLC 0x50 /* Host block count (SDIO/SDHC)    -  9 R/W */
  39
  40 #define SDCMD_NEW_FLAG                  0x8000
  41 #define SDCMD_FAIL_FLAG                 0x4000
  42 #define SDCMD_BUSYWAIT                  0x800
  43 #define SDCMD_NO_RESPONSE               0x400
  44 #define SDCMD_LONG_RESPONSE             0x200
  45 #define SDCMD_WRITE_CMD                 0x80
  46 #define SDCMD_READ_CMD                  0x40
  47 #define SDCMD_CMD_MASK                  0x3f
  48
  49 #define SDCDIV_MAX_CDIV                 0x7ff
  50
  51 #define SDHSTS_BUSY_IRPT                0x400
  52 #define SDHSTS_BLOCK_IRPT               0x200
  53 #define SDHSTS_SDIO_IRPT                0x100
  54 #define SDHSTS_REW_TIME_OUT             0x80
  55 #define SDHSTS_CMD_TIME_OUT             0x40
  56 #define SDHSTS_CRC16_ERROR              0x20
  57 #define SDHSTS_CRC7_ERROR               0x10
  58 #define SDHSTS_FIFO_ERROR               0x08
  59 /* Reserved */
  60 /* Reserved */
  61 #define SDHSTS_DATA_FLAG                0x01
  62
  63 #define SDHCFG_BUSY_IRPT_EN     (1 << 10)
  64 #define SDHCFG_BLOCK_IRPT_EN    (1 << 8)
  65 #define SDHCFG_SDIO_IRPT_EN     (1 << 5)
  66 #define SDHCFG_DATA_IRPT_EN     (1 << 4)
  67 #define SDHCFG_SLOW_CARD        (1 << 3)
  68 #define SDHCFG_WIDE_EXT_BUS     (1 << 2)
  69 #define SDHCFG_WIDE_INT_BUS     (1 << 1)
  70 #define SDHCFG_REL_CMD_LINE     (1 << 0)
  71
  72 #define SDEDM_FORCE_DATA_MODE   (1 << 19)
  73 #define SDEDM_CLOCK_PULSE       (1 << 20)
  74 #define SDEDM_BYPASS            (1 << 21)
  75
  76 #define SDEDM_WRITE_THRESHOLD_SHIFT 9
  77 #define SDEDM_READ_THRESHOLD_SHIFT 14
  78 #define SDEDM_THRESHOLD_MASK     0x1f
  79
  80 #define SDEDM_FSM_MASK           0xf
  81 #define SDEDM_FSM_IDENTMODE      0x0
  82 #define SDEDM_FSM_DATAMODE       0x1
  83 #define SDEDM_FSM_READDATA       0x2
  84 #define SDEDM_FSM_WRITEDATA      0x3
  85 #define SDEDM_FSM_READWAIT       0x4
  86 #define SDEDM_FSM_READCRC        0x5
  87 #define SDEDM_FSM_WRITECRC       0x6
  88 #define SDEDM_FSM_WRITEWAIT1     0x7
  89 #define SDEDM_FSM_POWERDOWN      0x8
  90 #define SDEDM_FSM_POWERUP        0x9
  91 #define SDEDM_FSM_WRITESTART1    0xa
  92 #define SDEDM_FSM_WRITESTART2    0xb
  93 #define SDEDM_FSM_GENPULSES      0xc
  94 #define SDEDM_FSM_WRITEWAIT2     0xd
  95 #define SDEDM_FSM_STARTPOWDOWN   0xf
  96
  97 #define SDDATA_FIFO_WORDS        16
  98
  99 static void bcm2835_sdhost_update_irq(BCM2835SDHostState *s)
 100 {
 101     uint32_t irq = s->status &
 102         (SDHSTS_BUSY_IRPT | SDHSTS_BLOCK_IRPT | SDHSTS_SDIO_IRPT);
 103     trace_bcm2835_sdhost_update_irq(irq);
 104     qemu_set_irq(s->irq, !!irq);
 105 }
 106
 107 static void bcm2835_sdhost_send_command(BCM2835SDHostState *s)
 108 {
 109     SDRequest request;
 110     uint8_t rsp[16];
 111     int rlen;
 112
 113     request.cmd = s->cmd & SDCMD_CMD_MASK;
 114     request.arg = s->cmdarg;
 115
 116     rlen = sdbus_do_command(&s->sdbus, &request, rsp);
 117     if (rlen < 0) {
 118         goto error;
 119     }
 120     if (!(s->cmd & SDCMD_NO_RESPONSE)) {
 121 #define RWORD(n) (((uint32_t)rsp[n] << 24) | (rsp[n + 1] << 16) \
 122                   | (rsp[n + 2] << 8) | rsp[n + 3])
 123         if (rlen == 0 || (rlen == 4 && (s->cmd & SDCMD_LONG_RESPONSE))) {
 124             goto error;
 125         }
 126         if (rlen != 4 && rlen != 16) {
 127             goto error;
 128         }
 129         if (rlen == 4) {
 130             s->rsp[0] = RWORD(0);
 131             s->rsp[1] = s->rsp[2] = s->rsp[3] = 0;
 132         } else {
 133             s->rsp[0] = RWORD(12);
 134             s->rsp[1] = RWORD(8);
 135             s->rsp[2] = RWORD(4);
 136             s->rsp[3] = RWORD(0);
 137         }
 138 #undef RWORD
 139     }
 140     return;
 141
 142 error:
 143     s->cmd |= SDCMD_FAIL_FLAG;
 144     s->status |= SDHSTS_CMD_TIME_OUT;
 145 }
 146
 147 static void bcm2835_sdhost_fifo_push(BCM2835SDHostState *s, uint32_t value)
 148 {
 149     int n;
 150
 151     if (s->fifo_len == BCM2835_SDHOST_FIFO_LEN) {
 152         /* FIFO overflow */
 153         return;
 154     }
 155     n = (s->fifo_pos + s->fifo_len) & (BCM2835_SDHOST_FIFO_LEN - 1);
 156     s->fifo_len++;
 157     s->fifo[n] = value;
 158 }
 159
 160 static uint32_t bcm2835_sdhost_fifo_pop(BCM2835SDHostState *s)
 161 {
 162     uint32_t value;
 163
 164     if (s->fifo_len == 0) {
 165         /* FIFO underflow */
 166         return 0;
 167     }
 168     value = s->fifo[s->fifo_pos];
 169     s->fifo_len--;
 170     s->fifo_pos = (s->fifo_pos + 1) & (BCM2835_SDHOST_FIFO_LEN - 1);
 171     return value;
 172 }
 173
 174 static void bcm2835_sdhost_fifo_run(BCM2835SDHostState *s)
 175 {
 176     uint32_t value = 0;
 177     int n;
 178     int is_read;
 179
 180     is_read = (s->cmd & SDCMD_READ_CMD) != 0;
 181     if (s->datacnt != 0 && (!is_read || sdbus_data_ready(&s->sdbus))) {
 182         if (is_read) {
 183             n = 0;
 184             while (s->datacnt && s->fifo_len < BCM2835_SDHOST_FIFO_LEN) {
 185                 value |= (uint32_t)sdbus_read_data(&s->sdbus) << (n * 8);
 186                 s->datacnt--;
 187                 n++;
 188                 if (n == 4) {
 189                     bcm2835_sdhost_fifo_push(s, value);
 190                     n = 0;
 191                     value = 0;
 192                 }
 193             }
 194             if (n != 0) {
 195                 bcm2835_sdhost_fifo_push(s, value);
 196             }
 197         } else { /* write */
 198             n = 0;
 199             while (s->datacnt > 0 && (s->fifo_len > 0 || n > 0)) {
 200                 if (n == 0) {
 201                     value = bcm2835_sdhost_fifo_pop(s);
 202                     n = 4;
 203                 }
 204                 n--;
 205                 s->datacnt--;
 206                 sdbus_write_data(&s->sdbus, value & 0xff);
 207                 value >>= 8;
 208             }
 209         }
 210     }
 211     if (s->datacnt == 0) {
 212         s->status |= SDHSTS_DATA_FLAG;
 213
 214         s->edm &= ~0xf;
 215         s->edm |= SDEDM_FSM_DATAMODE;
 216         trace_bcm2835_sdhost_edm_change("datacnt 0", s->edm);
 217
 218         if (s->config & SDHCFG_DATA_IRPT_EN) {
 219             s->status |= SDHSTS_SDIO_IRPT;
 220         }
 221
 222         if ((s->cmd & SDCMD_BUSYWAIT) && (s->config & SDHCFG_BUSY_IRPT_EN)) {
 223             s->status |= SDHSTS_BUSY_IRPT;
 224         }
 225
 226         if ((s->cmd & SDCMD_WRITE_CMD) && (s->config & SDHCFG_BLOCK_IRPT_EN)) {
 227             s->status |= SDHSTS_BLOCK_IRPT;
 228         }
 229
 230         bcm2835_sdhost_update_irq(s);
 231     }
 232
 233     s->edm &= ~(0x1f << 4);
 234     s->edm |= ((s->fifo_len & 0x1f) << 4);
 235     trace_bcm2835_sdhost_edm_change("fifo run", s->edm);
 236 }
 237
 238 static uint64_t bcm2835_sdhost_read(void *opaque, hwaddr offset,
 239     unsigned size)
 240 {
 241     BCM2835SDHostState *s = (BCM2835SDHostState *)opaque;
 242     uint32_t res = 0;
 243
 244     switch (offset) {
 245     case SDCMD:
 246         res = s->cmd;
 247         break;
 248     case SDHSTS:
 249         res = s->status;
 250         break;
 251     case SDRSP0:
 252         res = s->rsp[0];
 253         break;
 254     case SDRSP1:
 255         res = s->rsp[1];
 256         break;
 257     case SDRSP2:
 258         res = s->rsp[2];
 259         break;
 260     case SDRSP3:
 261         res = s->rsp[3];
 262         break;
 263     case SDEDM:
 264         res = s->edm;
 265         break;
 266     case SDVDD:
 267         res = s->vdd;
 268         break;
 269     case SDDATA:
 270         res = bcm2835_sdhost_fifo_pop(s);
 271         bcm2835_sdhost_fifo_run(s);
 272         break;
 273     case SDHBCT:
 274         res = s->hbct;
 275         break;
 276     case SDHBLC:
 277         res = s->hblc;
 278         break;
 279
 280     default:
 281         qemu_log_mask(LOG_GUEST_ERROR, "%s: Bad offset %"HWADDR_PRIx"\n",
 282                       __func__, offset);
 283         res = 0;
 284         break;
 285     }
 286
 287     trace_bcm2835_sdhost_read(offset, res, size);
 288
 289     return res;
 290 }
 291
 292 static void bcm2835_sdhost_write(void *opaque, hwaddr offset,
 293     uint64_t value, unsigned size)
 294 {
 295     BCM2835SDHostState *s = (BCM2835SDHostState *)opaque;
 296
 297     trace_bcm2835_sdhost_write(offset, value, size);
 298
 299     switch (offset) {
 300     case SDCMD:
 301         s->cmd = value;
 302         if (value & SDCMD_NEW_FLAG) {
 303             bcm2835_sdhost_send_command(s);
 304             bcm2835_sdhost_fifo_run(s);
 305             s->cmd &= ~SDCMD_NEW_FLAG;
 306         }
 307         break;
 308     case SDTOUT:
 309         break;
 310     case SDCDIV:
 311         break;
 312     case SDHSTS:
 313         s->status &= ~value;
 314         bcm2835_sdhost_update_irq(s);
 315         break;
 316     case SDARG:
 317         s->cmdarg = value;
 318         break;
 319     case SDEDM:
 320         if ((value & 0xf) == 0xf) {
 321             /* power down */
 322             value &= ~0xf;
 323         }
 324         s->edm = value;
 325         trace_bcm2835_sdhost_edm_change("guest register write", s->edm);
 326         break;
 327     case SDHCFG:
 328         s->config = value;
 329         bcm2835_sdhost_fifo_run(s);
 330         break;
 331     case SDVDD:
 332         s->vdd = value;
 333         break;
 334     case SDDATA:
 335         bcm2835_sdhost_fifo_push(s, value);
 336         bcm2835_sdhost_fifo_run(s);
 337         break;
 338     case SDHBCT:
 339         s->hbct = value;
 340         break;
 341     case SDHBLC:
 342         s->hblc = value;
 343         s->datacnt = s->hblc * s->hbct;
 344         bcm2835_sdhost_fifo_run(s);
 345         break;
 346
 347     default:
 348         qemu_log_mask(LOG_GUEST_ERROR, "%s: Bad offset %"HWADDR_PRIx"\n",
 349                       __func__, offset);
 350         break;
 351     }
 352 }
 353
 354 static const MemoryRegionOps bcm2835_sdhost_ops = {
 355     .read = bcm2835_sdhost_read,
 356     .write = bcm2835_sdhost_write,
 357     .endianness = DEVICE_NATIVE_ENDIAN,
 358 };
 359
 360 static const VMStateDescription vmstate_bcm2835_sdhost = {
 361     .name = TYPE_BCM2835_SDHOST,
 362     .version_id = 1,
 363     .minimum_version_id = 1,
 364     .fields = (VMStateField[]) {
 365         VMSTATE_UINT32(cmd, BCM2835SDHostState),
 366         VMSTATE_UINT32(cmdarg, BCM2835SDHostState),
 367         VMSTATE_UINT32(status, BCM2835SDHostState),
 368         VMSTATE_UINT32_ARRAY(rsp, BCM2835SDHostState, 4),
 369         VMSTATE_UINT32(config, BCM2835SDHostState),
 370         VMSTATE_UINT32(edm, BCM2835SDHostState),
 371         VMSTATE_UINT32(vdd, BCM2835SDHostState),
 372         VMSTATE_UINT32(hbct, BCM2835SDHostState),
 373         VMSTATE_UINT32(hblc, BCM2835SDHostState),
 374         VMSTATE_INT32(fifo_pos, BCM2835SDHostState),
 375         VMSTATE_INT32(fifo_len, BCM2835SDHostState),
 376         VMSTATE_UINT32_ARRAY(fifo, BCM2835SDHostState, BCM2835_SDHOST_FIFO_LEN),
 377         VMSTATE_UINT32(datacnt, BCM2835SDHostState),
 378         VMSTATE_END_OF_LIST()
 379     }
 380 };
 381
 382 static void bcm2835_sdhost_init(Object *obj)
 383 {
 384     BCM2835SDHostState *s = BCM2835_SDHOST(obj);
 385
 386     qbus_create_inplace(&s->sdbus, sizeof(s->sdbus),
 387                         TYPE_BCM2835_SDHOST_BUS, DEVICE(s), "sd-bus");
 388
 389     memory_region_init_io(&s->iomem, obj, &bcm2835_sdhost_ops, s,
 390                           TYPE_BCM2835_SDHOST, 0x1000);
 391     sysbus_init_mmio(SYS_BUS_DEVICE(s), &s->iomem);
 392     sysbus_init_irq(SYS_BUS_DEVICE(s), &s->irq);
 393 }
 394
 395 static void bcm2835_sdhost_reset(DeviceState *dev)
 396 {
 397     BCM2835SDHostState *s = BCM2835_SDHOST(dev);
 398
 399     s->cmd = 0;
 400     s->cmdarg = 0;
 401     s->edm = 0x0000c60f;
 402     trace_bcm2835_sdhost_edm_change("device reset", s->edm);
 403     s->config = 0;
 404     s->hbct = 0;
 405     s->hblc = 0;
 406     s->datacnt = 0;
 407     s->fifo_pos = 0;
 408     s->fifo_len = 0;
 409 }
 410
 411 static void bcm2835_sdhost_class_init(ObjectClass *klass, void *data)
 412 {
 413     DeviceClass *dc = DEVICE_CLASS(klass);
 414
 415     dc->reset = bcm2835_sdhost_reset;
 416     dc->vmsd = &vmstate_bcm2835_sdhost;
 417 }
 418
 419 static TypeInfo bcm2835_sdhost_info = {
 420     .name          = TYPE_BCM2835_SDHOST,
 421     .parent        = TYPE_SYS_BUS_DEVICE,
 422     .instance_size = sizeof(BCM2835SDHostState),
 423     .class_init    = bcm2835_sdhost_class_init,
 424     .instance_init = bcm2835_sdhost_init,
 425 };
 426
 427 static const TypeInfo bcm2835_sdhost_bus_info = {
 428     .name = TYPE_BCM2835_SDHOST_BUS,
 429     .parent = TYPE_SD_BUS,
 430     .instance_size = sizeof(SDBus),
 431 };
 432
 433 static void bcm2835_sdhost_register_types(void)
 434 {
 435     type_register_static(&bcm2835_sdhost_info);
 436     type_register_static(&bcm2835_sdhost_bus_info);
 437 }
 438
 439 type_init(bcm2835_sdhost_register_types)