1 /* 2 * SSI to SD card adapter. 3 * 4 * Copyright (c) 2007-2009 CodeSourcery. 5 * Written by Paul Brook 6 * 7 * This code is licensed under the GNU GPL v2. 8 * 9 * Contributions after 2012-01-13 are licensed under the terms of the 10 * GNU GPL, version 2 or (at your option) any later version. 11 */ 12 13 #include "qemu/osdep.h" 14 #include "sysemu/blockdev.h" 15 #include "hw/ssi/ssi.h" 16 #include "hw/sd/sd.h" 17 #include "qapi/error.h" 18 19 //#define DEBUG_SSI_SD 1 20 21 #ifdef DEBUG_SSI_SD 22 #define DPRINTF(fmt, ...) \ 23 do { printf("ssi_sd: " fmt , ## __VA_ARGS__); } while (0) 24 #define BADF(fmt, ...) \ 25 do { fprintf(stderr, "ssi_sd: error: " fmt , ## __VA_ARGS__); exit(1);} while (0) 26 #else 27 #define DPRINTF(fmt, ...) do {} while(0) 28 #define BADF(fmt, ...) \ 29 do { fprintf(stderr, "ssi_sd: error: " fmt , ## __VA_ARGS__);} while (0) 30 #endif 31 32 typedef enum { 33 SSI_SD_CMD = 0, 34 SSI_SD_CMDARG, 35 SSI_SD_RESPONSE, 36 SSI_SD_DATA_START, 37 SSI_SD_DATA_READ, 38 } ssi_sd_mode; 39 40 typedef struct { 41 SSISlave ssidev; 42 uint32_t mode; 43 int cmd; 44 uint8_t cmdarg[4]; 45 uint8_t response[5]; 46 int32_t arglen; 47 int32_t response_pos; 48 int32_t stopping; 49 SDBus sdbus; 50 } ssi_sd_state; 51 52 #define TYPE_SSI_SD "ssi-sd" 53 #define SSI_SD(obj) OBJECT_CHECK(ssi_sd_state, (obj), TYPE_SSI_SD) 54 55 /* State word bits. */ 56 #define SSI_SDR_LOCKED 0x0001 57 #define SSI_SDR_WP_ERASE 0x0002 58 #define SSI_SDR_ERROR 0x0004 59 #define SSI_SDR_CC_ERROR 0x0008 60 #define SSI_SDR_ECC_FAILED 0x0010 61 #define SSI_SDR_WP_VIOLATION 0x0020 62 #define SSI_SDR_ERASE_PARAM 0x0040 63 #define SSI_SDR_OUT_OF_RANGE 0x0080 64 #define SSI_SDR_IDLE 0x0100 65 #define SSI_SDR_ERASE_RESET 0x0200 66 #define SSI_SDR_ILLEGAL_COMMAND 0x0400 67 #define SSI_SDR_COM_CRC_ERROR 0x0800 68 #define SSI_SDR_ERASE_SEQ_ERROR 0x1000 69 #define SSI_SDR_ADDRESS_ERROR 0x2000 70 #define SSI_SDR_PARAMETER_ERROR 0x4000 71 72 static uint32_t ssi_sd_transfer(SSISlave *dev, uint32_t val) 73 { 74 ssi_sd_state *s = FROM_SSI_SLAVE(ssi_sd_state, dev); 75 76 /* Special case: allow CMD12 (STOP TRANSMISSION) while reading data. */ 77 if (s->mode == SSI_SD_DATA_READ && val == 0x4d) { 78 s->mode = SSI_SD_CMD; 79 /* There must be at least one byte delay before the card responds. */ 80 s->stopping = 1; 81 } 82 83 switch (s->mode) { 84 case SSI_SD_CMD: 85 if (val == 0xff) { 86 DPRINTF("NULL command\n"); 87 return 0xff; 88 } 89 s->cmd = val & 0x3f; 90 s->mode = SSI_SD_CMDARG; 91 s->arglen = 0; 92 return 0xff; 93 case SSI_SD_CMDARG: 94 if (s->arglen == 4) { 95 SDRequest request; 96 uint8_t longresp[16]; 97 /* FIXME: Check CRC. */ 98 request.cmd = s->cmd; 99 request.arg = (s->cmdarg[0] << 24) | (s->cmdarg[1] << 16) 100 | (s->cmdarg[2] << 8) | s->cmdarg[3]; 101 DPRINTF("CMD%d arg 0x%08x\n", s->cmd, request.arg); 102 s->arglen = sdbus_do_command(&s->sdbus, &request, longresp); 103 if (s->arglen <= 0) { 104 s->arglen = 1; 105 s->response[0] = 4; 106 DPRINTF("SD command failed\n"); 107 } else if (s->cmd == 58) { 108 /* CMD58 returns R3 response (OCR) */ 109 DPRINTF("Returned OCR\n"); 110 s->arglen = 5; 111 s->response[0] = 1; 112 memcpy(&s->response[1], longresp, 4); 113 } else if (s->arglen != 4) { 114 BADF("Unexpected response to cmd %d\n", s->cmd); 115 /* Illegal command is about as near as we can get. */ 116 s->arglen = 1; 117 s->response[0] = 4; 118 } else { 119 /* All other commands return status. */ 120 uint32_t cardstatus; 121 uint16_t status; 122 /* CMD13 returns a 2-byte statuse work. Other commands 123 only return the first byte. */ 124 s->arglen = (s->cmd == 13) ? 2 : 1; 125 cardstatus = (longresp[0] << 24) | (longresp[1] << 16) 126 | (longresp[2] << 8) | longresp[3]; 127 status = 0; 128 if (((cardstatus >> 9) & 0xf) < 4) 129 status |= SSI_SDR_IDLE; 130 if (cardstatus & ERASE_RESET) 131 status |= SSI_SDR_ERASE_RESET; 132 if (cardstatus & ILLEGAL_COMMAND) 133 status |= SSI_SDR_ILLEGAL_COMMAND; 134 if (cardstatus & COM_CRC_ERROR) 135 status |= SSI_SDR_COM_CRC_ERROR; 136 if (cardstatus & ERASE_SEQ_ERROR) 137 status |= SSI_SDR_ERASE_SEQ_ERROR; 138 if (cardstatus & ADDRESS_ERROR) 139 status |= SSI_SDR_ADDRESS_ERROR; 140 if (cardstatus & CARD_IS_LOCKED) 141 status |= SSI_SDR_LOCKED; 142 if (cardstatus & (LOCK_UNLOCK_FAILED | WP_ERASE_SKIP)) 143 status |= SSI_SDR_WP_ERASE; 144 if (cardstatus & SD_ERROR) 145 status |= SSI_SDR_ERROR; 146 if (cardstatus & CC_ERROR) 147 status |= SSI_SDR_CC_ERROR; 148 if (cardstatus & CARD_ECC_FAILED) 149 status |= SSI_SDR_ECC_FAILED; 150 if (cardstatus & WP_VIOLATION) 151 status |= SSI_SDR_WP_VIOLATION; 152 if (cardstatus & ERASE_PARAM) 153 status |= SSI_SDR_ERASE_PARAM; 154 if (cardstatus & (OUT_OF_RANGE | CID_CSD_OVERWRITE)) 155 status |= SSI_SDR_OUT_OF_RANGE; 156 /* ??? Don't know what Parameter Error really means, so 157 assume it's set if the second byte is nonzero. */ 158 if (status & 0xff) 159 status |= SSI_SDR_PARAMETER_ERROR; 160 s->response[0] = status >> 8; 161 s->response[1] = status; 162 DPRINTF("Card status 0x%02x\n", status); 163 } 164 s->mode = SSI_SD_RESPONSE; 165 s->response_pos = 0; 166 } else { 167 s->cmdarg[s->arglen++] = val; 168 } 169 return 0xff; 170 case SSI_SD_RESPONSE: 171 if (s->stopping) { 172 s->stopping = 0; 173 return 0xff; 174 } 175 if (s->response_pos < s->arglen) { 176 DPRINTF("Response 0x%02x\n", s->response[s->response_pos]); 177 return s->response[s->response_pos++]; 178 } 179 if (sdbus_data_ready(&s->sdbus)) { 180 DPRINTF("Data read\n"); 181 s->mode = SSI_SD_DATA_START; 182 } else { 183 DPRINTF("End of command\n"); 184 s->mode = SSI_SD_CMD; 185 } 186 return 0xff; 187 case SSI_SD_DATA_START: 188 DPRINTF("Start read block\n"); 189 s->mode = SSI_SD_DATA_READ; 190 return 0xfe; 191 case SSI_SD_DATA_READ: 192 val = sdbus_read_data(&s->sdbus); 193 if (!sdbus_data_ready(&s->sdbus)) { 194 DPRINTF("Data read end\n"); 195 s->mode = SSI_SD_CMD; 196 } 197 return val; 198 } 199 /* Should never happen. */ 200 return 0xff; 201 } 202 203 static int ssi_sd_post_load(void *opaque, int version_id) 204 { 205 ssi_sd_state *s = (ssi_sd_state *)opaque; 206 207 if (s->mode > SSI_SD_DATA_READ) { 208 return -EINVAL; 209 } 210 if (s->mode == SSI_SD_CMDARG && 211 (s->arglen < 0 || s->arglen >= ARRAY_SIZE(s->cmdarg))) { 212 return -EINVAL; 213 } 214 if (s->mode == SSI_SD_RESPONSE && 215 (s->response_pos < 0 || s->response_pos >= ARRAY_SIZE(s->response) || 216 (!s->stopping && s->arglen > ARRAY_SIZE(s->response)))) { 217 return -EINVAL; 218 } 219 220 return 0; 221 } 222 223 static const VMStateDescription vmstate_ssi_sd = { 224 .name = "ssi_sd", 225 .version_id = 2, 226 .minimum_version_id = 2, 227 .post_load = ssi_sd_post_load, 228 .fields = (VMStateField []) { 229 VMSTATE_UINT32(mode, ssi_sd_state), 230 VMSTATE_INT32(cmd, ssi_sd_state), 231 VMSTATE_UINT8_ARRAY(cmdarg, ssi_sd_state, 4), 232 VMSTATE_UINT8_ARRAY(response, ssi_sd_state, 5), 233 VMSTATE_INT32(arglen, ssi_sd_state), 234 VMSTATE_INT32(response_pos, ssi_sd_state), 235 VMSTATE_INT32(stopping, ssi_sd_state), 236 VMSTATE_SSI_SLAVE(ssidev, ssi_sd_state), 237 VMSTATE_END_OF_LIST() 238 } 239 }; 240 241 static void ssi_sd_realize(SSISlave *d, Error **errp) 242 { 243 ssi_sd_state *s = FROM_SSI_SLAVE(ssi_sd_state, d); 244 DeviceState *carddev; 245 DriveInfo *dinfo; 246 Error *err = NULL; 247 248 qbus_create_inplace(&s->sdbus, sizeof(s->sdbus), TYPE_SD_BUS, 249 DEVICE(d), "sd-bus"); 250 251 /* Create and plug in the sd card */ 252 /* FIXME use a qdev drive property instead of drive_get_next() */ 253 dinfo = drive_get_next(IF_SD); 254 carddev = qdev_create(&s->sdbus.qbus, TYPE_SD_CARD); 255 if (dinfo) { 256 qdev_prop_set_drive(carddev, "drive", blk_by_legacy_dinfo(dinfo), &err); 257 } 258 object_property_set_bool(OBJECT(carddev), true, "spi", &err); 259 object_property_set_bool(OBJECT(carddev), true, "realized", &err); 260 if (err) { 261 error_setg(errp, "failed to init SD card: %s", error_get_pretty(err)); 262 return; 263 } 264 } 265 266 static void ssi_sd_reset(DeviceState *dev) 267 { 268 ssi_sd_state *s = SSI_SD(dev); 269 270 s->mode = SSI_SD_CMD; 271 s->cmd = 0; 272 memset(s->cmdarg, 0, sizeof(s->cmdarg)); 273 memset(s->response, 0, sizeof(s->response)); 274 s->arglen = 0; 275 s->response_pos = 0; 276 s->stopping = 0; 277 } 278 279 static void ssi_sd_class_init(ObjectClass *klass, void *data) 280 { 281 DeviceClass *dc = DEVICE_CLASS(klass); 282 SSISlaveClass *k = SSI_SLAVE_CLASS(klass); 283 284 k->realize = ssi_sd_realize; 285 k->transfer = ssi_sd_transfer; 286 k->cs_polarity = SSI_CS_LOW; 287 dc->vmsd = &vmstate_ssi_sd; 288 dc->reset = ssi_sd_reset; 289 } 290 291 static const TypeInfo ssi_sd_info = { 292 .name = TYPE_SSI_SD, 293 .parent = TYPE_SSI_SLAVE, 294 .instance_size = sizeof(ssi_sd_state), 295 .class_init = ssi_sd_class_init, 296 }; 297 298 static void ssi_sd_register_types(void) 299 { 300 type_register_static(&ssi_sd_info); 301 } 302 303 type_init(ssi_sd_register_types) 304