2 * SSI to SD card adapter.
4 * Copyright (c) 2007-2009 CodeSourcery.
5 * Written by Paul Brook
7 * Copyright (c) 2021 Wind River Systems, Inc.
8 * Improved by Bin Meng <bin.meng@windriver.com>
10 * Validated with U-Boot v2021.01 and Linux v5.10 mmc_spi driver
12 * This code is licensed under the GNU GPL v2.
14 * Contributions after 2012-01-13 are licensed under the terms of the
15 * GNU GPL, version 2 or (at your option) any later version.
18 #include "qemu/osdep.h"
19 #include "sysemu/blockdev.h"
20 #include "hw/ssi/ssi.h"
21 #include "migration/vmstate.h"
22 #include "hw/qdev-properties.h"
24 #include "qapi/error.h"
25 #include "qemu/crc-ccitt.h"
26 #include "qemu/module.h"
27 #include "qom/object.h"
29 //#define DEBUG_SSI_SD 1
32 #define DPRINTF(fmt, ...) \
33 do { printf("ssi_sd: " fmt , ## __VA_ARGS__); } while (0)
34 #define BADF(fmt, ...) \
35 do { fprintf(stderr, "ssi_sd: error: " fmt , ## __VA_ARGS__); exit(1);} while (0)
37 #define DPRINTF(fmt, ...) do {} while(0)
38 #define BADF(fmt, ...) \
39 do { fprintf(stderr, "ssi_sd: error: " fmt , ## __VA_ARGS__);} while (0)
70 #define TYPE_SSI_SD "ssi-sd"
71 OBJECT_DECLARE_SIMPLE_TYPE(ssi_sd_state
, SSI_SD
)
73 /* State word bits. */
74 #define SSI_SDR_LOCKED 0x0001
75 #define SSI_SDR_WP_ERASE 0x0002
76 #define SSI_SDR_ERROR 0x0004
77 #define SSI_SDR_CC_ERROR 0x0008
78 #define SSI_SDR_ECC_FAILED 0x0010
79 #define SSI_SDR_WP_VIOLATION 0x0020
80 #define SSI_SDR_ERASE_PARAM 0x0040
81 #define SSI_SDR_OUT_OF_RANGE 0x0080
82 #define SSI_SDR_IDLE 0x0100
83 #define SSI_SDR_ERASE_RESET 0x0200
84 #define SSI_SDR_ILLEGAL_COMMAND 0x0400
85 #define SSI_SDR_COM_CRC_ERROR 0x0800
86 #define SSI_SDR_ERASE_SEQ_ERROR 0x1000
87 #define SSI_SDR_ADDRESS_ERROR 0x2000
88 #define SSI_SDR_PARAMETER_ERROR 0x4000
90 /* multiple block write */
91 #define SSI_TOKEN_MULTI_WRITE 0xfc
92 /* terminate multiple block write */
93 #define SSI_TOKEN_STOP_TRAN 0xfd
94 /* single block read/write, multiple block read */
95 #define SSI_TOKEN_SINGLE 0xfe
97 /* dummy value - don't care */
98 #define SSI_DUMMY 0xff
101 #define DATA_RESPONSE_ACCEPTED 0x05
103 static uint32_t ssi_sd_transfer(SSIPeripheral
*dev
, uint32_t val
)
105 ssi_sd_state
*s
= SSI_SD(dev
);
107 uint8_t longresp
[16];
110 * Special case: allow CMD12 (STOP TRANSMISSION) while reading data.
112 * See "Physical Layer Specification Version 8.00" chapter 7.5.2.2,
113 * to avoid conflict between CMD12 response and next data block,
114 * timing of CMD12 should be controlled as follows:
116 * - CMD12 issued at the timing that end bit of CMD12 and end bit of
117 * data block is overlapped
118 * - CMD12 issued after one clock cycle after host receives a token
119 * (either Start Block token or Data Error token)
121 * We need to catch CMD12 in all of the data read states.
123 if (s
->mode
>= SSI_SD_PREP_DATA
&& s
->mode
<= SSI_SD_DATA_CRC16
) {
125 s
->mode
= SSI_SD_CMD
;
126 /* There must be at least one byte delay before the card responds */
135 DPRINTF("NULL command\n");
138 case SSI_TOKEN_SINGLE
:
139 case SSI_TOKEN_MULTI_WRITE
:
140 DPRINTF("Start write block\n");
141 s
->mode
= SSI_SD_DATA_WRITE
;
143 case SSI_TOKEN_STOP_TRAN
:
144 DPRINTF("Stop multiple write\n");
146 /* manually issue cmd12 to stop the transfer */
149 s
->arglen
= sdbus_do_command(&s
->sdbus
, &request
, longresp
);
150 if (s
->arglen
<= 0) {
152 /* a zero value indicates the card is busy */
154 DPRINTF("SD card busy\n");
157 /* a non-zero value indicates the card is ready */
158 s
->response
[0] = SSI_DUMMY
;
165 s
->mode
= SSI_SD_CMDARG
;
169 if (s
->arglen
== 4) {
170 /* FIXME: Check CRC. */
171 request
.cmd
= s
->cmd
;
172 request
.arg
= ldl_be_p(s
->cmdarg
);
173 DPRINTF("CMD%d arg 0x%08x\n", s
->cmd
, request
.arg
);
174 s
->arglen
= sdbus_do_command(&s
->sdbus
, &request
, longresp
);
175 if (s
->arglen
<= 0) {
178 DPRINTF("SD command failed\n");
179 } else if (s
->cmd
== 58) {
180 /* CMD58 returns R3 response (OCR) */
181 DPRINTF("Returned OCR\n");
184 memcpy(&s
->response
[1], longresp
, 4);
185 } else if (s
->arglen
!= 4) {
186 BADF("Unexpected response to cmd %d\n", s
->cmd
);
187 /* Illegal command is about as near as we can get. */
191 /* All other commands return status. */
194 /* CMD13 returns a 2-byte statuse work. Other commands
195 only return the first byte. */
196 s
->arglen
= (s
->cmd
== 13) ? 2 : 1;
197 cardstatus
= ldl_be_p(longresp
);
199 if (((cardstatus
>> 9) & 0xf) < 4)
200 status
|= SSI_SDR_IDLE
;
201 if (cardstatus
& ERASE_RESET
)
202 status
|= SSI_SDR_ERASE_RESET
;
203 if (cardstatus
& ILLEGAL_COMMAND
)
204 status
|= SSI_SDR_ILLEGAL_COMMAND
;
205 if (cardstatus
& COM_CRC_ERROR
)
206 status
|= SSI_SDR_COM_CRC_ERROR
;
207 if (cardstatus
& ERASE_SEQ_ERROR
)
208 status
|= SSI_SDR_ERASE_SEQ_ERROR
;
209 if (cardstatus
& ADDRESS_ERROR
)
210 status
|= SSI_SDR_ADDRESS_ERROR
;
211 if (cardstatus
& CARD_IS_LOCKED
)
212 status
|= SSI_SDR_LOCKED
;
213 if (cardstatus
& (LOCK_UNLOCK_FAILED
| WP_ERASE_SKIP
))
214 status
|= SSI_SDR_WP_ERASE
;
215 if (cardstatus
& SD_ERROR
)
216 status
|= SSI_SDR_ERROR
;
217 if (cardstatus
& CC_ERROR
)
218 status
|= SSI_SDR_CC_ERROR
;
219 if (cardstatus
& CARD_ECC_FAILED
)
220 status
|= SSI_SDR_ECC_FAILED
;
221 if (cardstatus
& WP_VIOLATION
)
222 status
|= SSI_SDR_WP_VIOLATION
;
223 if (cardstatus
& ERASE_PARAM
)
224 status
|= SSI_SDR_ERASE_PARAM
;
225 if (cardstatus
& (OUT_OF_RANGE
| CID_CSD_OVERWRITE
))
226 status
|= SSI_SDR_OUT_OF_RANGE
;
227 /* ??? Don't know what Parameter Error really means, so
228 assume it's set if the second byte is nonzero. */
230 status
|= SSI_SDR_PARAMETER_ERROR
;
231 s
->response
[0] = status
>> 8;
232 s
->response
[1] = status
;
233 DPRINTF("Card status 0x%02x\n", status
);
235 s
->mode
= SSI_SD_PREP_RESP
;
238 s
->cmdarg
[s
->arglen
++] = val
;
241 case SSI_SD_PREP_RESP
:
242 DPRINTF("Prepare card response (Ncr)\n");
243 s
->mode
= SSI_SD_RESPONSE
;
245 case SSI_SD_RESPONSE
:
250 if (s
->response_pos
< s
->arglen
) {
251 DPRINTF("Response 0x%02x\n", s
->response
[s
->response_pos
]);
252 return s
->response
[s
->response_pos
++];
254 if (sdbus_data_ready(&s
->sdbus
)) {
255 DPRINTF("Data read\n");
256 s
->mode
= SSI_SD_DATA_START
;
258 DPRINTF("End of command\n");
259 s
->mode
= SSI_SD_CMD
;
262 case SSI_SD_PREP_DATA
:
263 DPRINTF("Prepare data block (Nac)\n");
264 s
->mode
= SSI_SD_DATA_START
;
266 case SSI_SD_DATA_START
:
267 DPRINTF("Start read block\n");
268 s
->mode
= SSI_SD_DATA_READ
;
270 return SSI_TOKEN_SINGLE
;
271 case SSI_SD_DATA_READ
:
272 val
= sdbus_read_byte(&s
->sdbus
);
274 s
->crc16
= crc_ccitt_false(s
->crc16
, (uint8_t *)&val
, 1);
275 if (!sdbus_data_ready(&s
->sdbus
) || s
->read_bytes
== 512) {
276 DPRINTF("Data read end\n");
277 s
->mode
= SSI_SD_DATA_CRC16
;
280 case SSI_SD_DATA_CRC16
:
281 val
= (s
->crc16
& 0xff00) >> 8;
284 if (s
->response_pos
== 2) {
285 DPRINTF("CRC16 read end\n");
286 if (s
->read_bytes
== 512 && s
->cmd
!= 17) {
287 s
->mode
= SSI_SD_PREP_DATA
;
289 s
->mode
= SSI_SD_CMD
;
295 case SSI_SD_DATA_WRITE
:
296 sdbus_write_byte(&s
->sdbus
, val
);
298 if (!sdbus_receive_ready(&s
->sdbus
) || s
->write_bytes
== 512) {
299 DPRINTF("Data write end\n");
300 s
->mode
= SSI_SD_SKIP_CRC16
;
304 case SSI_SD_SKIP_CRC16
:
305 /* we don't verify the crc16 */
307 if (s
->response_pos
== 2) {
308 DPRINTF("CRC16 receive end\n");
309 s
->mode
= SSI_SD_RESPONSE
;
312 s
->response
[0] = DATA_RESPONSE_ACCEPTED
;
317 /* Should never happen. */
321 static int ssi_sd_post_load(void *opaque
, int version_id
)
323 ssi_sd_state
*s
= (ssi_sd_state
*)opaque
;
325 if (s
->mode
> SSI_SD_SKIP_CRC16
) {
328 if (s
->mode
== SSI_SD_CMDARG
&&
329 (s
->arglen
< 0 || s
->arglen
>= ARRAY_SIZE(s
->cmdarg
))) {
332 if (s
->mode
== SSI_SD_RESPONSE
&&
333 (s
->response_pos
< 0 || s
->response_pos
>= ARRAY_SIZE(s
->response
) ||
334 (!s
->stopping
&& s
->arglen
> ARRAY_SIZE(s
->response
)))) {
341 static const VMStateDescription vmstate_ssi_sd
= {
344 .minimum_version_id
= 7,
345 .post_load
= ssi_sd_post_load
,
346 .fields
= (VMStateField
[]) {
347 VMSTATE_UINT32(mode
, ssi_sd_state
),
348 VMSTATE_INT32(cmd
, ssi_sd_state
),
349 VMSTATE_UINT8_ARRAY(cmdarg
, ssi_sd_state
, 4),
350 VMSTATE_UINT8_ARRAY(response
, ssi_sd_state
, 5),
351 VMSTATE_UINT16(crc16
, ssi_sd_state
),
352 VMSTATE_INT32(read_bytes
, ssi_sd_state
),
353 VMSTATE_INT32(write_bytes
, ssi_sd_state
),
354 VMSTATE_INT32(arglen
, ssi_sd_state
),
355 VMSTATE_INT32(response_pos
, ssi_sd_state
),
356 VMSTATE_INT32(stopping
, ssi_sd_state
),
357 VMSTATE_SSI_PERIPHERAL(ssidev
, ssi_sd_state
),
358 VMSTATE_END_OF_LIST()
362 static void ssi_sd_realize(SSIPeripheral
*d
, Error
**errp
)
365 ssi_sd_state
*s
= SSI_SD(d
);
366 DeviceState
*carddev
;
369 qbus_create_inplace(&s
->sdbus
, sizeof(s
->sdbus
), TYPE_SD_BUS
,
370 DEVICE(d
), "sd-bus");
372 /* Create and plug in the sd card */
373 /* FIXME use a qdev drive property instead of drive_get_next() */
374 dinfo
= drive_get_next(IF_SD
);
375 carddev
= qdev_new(TYPE_SD_CARD
);
377 if (!qdev_prop_set_drive_err(carddev
, "drive",
378 blk_by_legacy_dinfo(dinfo
), errp
)) {
383 if (!object_property_set_bool(OBJECT(carddev
), "spi", true, errp
)) {
387 if (!qdev_realize_and_unref(carddev
, BUS(&s
->sdbus
), errp
)) {
394 error_prepend(errp
, "failed to init SD card: ");
397 static void ssi_sd_reset(DeviceState
*dev
)
399 ssi_sd_state
*s
= SSI_SD(dev
);
401 s
->mode
= SSI_SD_CMD
;
403 memset(s
->cmdarg
, 0, sizeof(s
->cmdarg
));
404 memset(s
->response
, 0, sizeof(s
->response
));
413 static void ssi_sd_class_init(ObjectClass
*klass
, void *data
)
415 DeviceClass
*dc
= DEVICE_CLASS(klass
);
416 SSIPeripheralClass
*k
= SSI_PERIPHERAL_CLASS(klass
);
418 k
->realize
= ssi_sd_realize
;
419 k
->transfer
= ssi_sd_transfer
;
420 k
->cs_polarity
= SSI_CS_LOW
;
421 dc
->vmsd
= &vmstate_ssi_sd
;
422 dc
->reset
= ssi_sd_reset
;
423 /* Reason: init() method uses drive_get_next() */
424 dc
->user_creatable
= false;
427 static const TypeInfo ssi_sd_info
= {
429 .parent
= TYPE_SSI_PERIPHERAL
,
430 .instance_size
= sizeof(ssi_sd_state
),
431 .class_init
= ssi_sd_class_init
,
434 static void ssi_sd_register_types(void)
436 type_register_static(&ssi_sd_info
);
439 type_init(ssi_sd_register_types
)