[qemu.git] / hw / sd / ssi-sd.c

/*
 * SSI to SD card adapter.
 *
 * Copyright (c) 2007-2009 CodeSourcery.
 * Written by Paul Brook
 *
 * This code is licensed under the GNU GPL v2.
 *
 * Contributions after 2012-01-13 are licensed under the terms of the
 * GNU GPL, version 2 or (at your option) any later version.
 */

#include "sysemu/block-backend.h"
#include "sysemu/blockdev.h"
#include "hw/ssi.h"
#include "hw/sd.h"

//#define DEBUG_SSI_SD 1

#ifdef DEBUG_SSI_SD
#define DPRINTF(fmt, ...) \
do { printf("ssi_sd: " fmt , ## __VA_ARGS__); } while (0)
#define BADF(fmt, ...) \
do { fprintf(stderr, "ssi_sd: error: " fmt , ## __VA_ARGS__); exit(1);} while (0)
#else
#define DPRINTF(fmt, ...) do {} while(0)
#define BADF(fmt, ...) \
do { fprintf(stderr, "ssi_sd: error: " fmt , ## __VA_ARGS__);} while (0)
#endif

typedef enum {
    SSI_SD_CMD,
    SSI_SD_CMDARG,
    SSI_SD_RESPONSE,
    SSI_SD_DATA_START,
    SSI_SD_DATA_READ,
} ssi_sd_mode;

typedef struct {
    SSISlave ssidev;
    ssi_sd_mode mode;
    int cmd;
    uint8_t cmdarg[4];
    uint8_t response[5];
    int arglen;
    int response_pos;
    int stopping;
    SDState *sd;
} ssi_sd_state;

/* State word bits.  */
#define SSI_SDR_LOCKED          0x0001
#define SSI_SDR_WP_ERASE        0x0002
#define SSI_SDR_ERROR           0x0004
#define SSI_SDR_CC_ERROR        0x0008
#define SSI_SDR_ECC_FAILED      0x0010
#define SSI_SDR_WP_VIOLATION    0x0020
#define SSI_SDR_ERASE_PARAM     0x0040
#define SSI_SDR_OUT_OF_RANGE    0x0080
#define SSI_SDR_IDLE            0x0100
#define SSI_SDR_ERASE_RESET     0x0200
#define SSI_SDR_ILLEGAL_COMMAND 0x0400
#define SSI_SDR_COM_CRC_ERROR   0x0800
#define SSI_SDR_ERASE_SEQ_ERROR 0x1000
#define SSI_SDR_ADDRESS_ERROR   0x2000
#define SSI_SDR_PARAMETER_ERROR 0x4000

static uint32_t ssi_sd_transfer(SSISlave *dev, uint32_t val)
{
    ssi_sd_state *s = FROM_SSI_SLAVE(ssi_sd_state, dev);

    /* Special case: allow CMD12 (STOP TRANSMISSION) while reading data.  */
    if (s->mode == SSI_SD_DATA_READ && val == 0x4d) {
        s->mode = SSI_SD_CMD;
        /* There must be at least one byte delay before the card responds.  */
        s->stopping = 1;
    }

    switch (s->mode) {
    case SSI_SD_CMD:
        if (val == 0xff) {
            DPRINTF("NULL command\n");
            return 0xff;
        }
        s->cmd = val & 0x3f;
        s->mode = SSI_SD_CMDARG;
        s->arglen = 0;
        return 0xff;
    case SSI_SD_CMDARG:
        if (s->arglen == 4) {
            SDRequest request;
            uint8_t longresp[16];
            /* FIXME: Check CRC.  */
            request.cmd = s->cmd;
            request.arg = (s->cmdarg[0] << 24) | (s->cmdarg[1] << 16)
                           | (s->cmdarg[2] << 8) | s->cmdarg[3];
            DPRINTF("CMD%d arg 0x%08x\n", s->cmd, request.arg);
            s->arglen = sd_do_command(s->sd, &request, longresp);
            if (s->arglen <= 0) {
                s->arglen = 1;
                s->response[0] = 4;
                DPRINTF("SD command failed\n");
            } else if (s->cmd == 58) {
                /* CMD58 returns R3 response (OCR)  */
                DPRINTF("Returned OCR\n");
                s->arglen = 5;
                s->response[0] = 1;
                memcpy(&s->response[1], longresp, 4);
            } else if (s->arglen != 4) {
                BADF("Unexpected response to cmd %d\n", s->cmd);
                /* Illegal command is about as near as we can get.  */
                s->arglen = 1;
                s->response[0] = 4;
            } else {
                /* All other commands return status.  */
                uint32_t cardstatus;
                uint16_t status;
                /* CMD13 returns a 2-byte statuse work. Other commands
                   only return the first byte.  */
                s->arglen = (s->cmd == 13) ? 2 : 1;
                cardstatus = (longresp[0] << 24) | (longresp[1] << 16)
                             | (longresp[2] << 8) | longresp[3];
                status = 0;
                if (((cardstatus >> 9) & 0xf) < 4)
                    status |= SSI_SDR_IDLE;
                if (cardstatus & ERASE_RESET)
                    status |= SSI_SDR_ERASE_RESET;
                if (cardstatus & ILLEGAL_COMMAND)
                    status |= SSI_SDR_ILLEGAL_COMMAND;
                if (cardstatus & COM_CRC_ERROR)
                    status |= SSI_SDR_COM_CRC_ERROR;
                if (cardstatus & ERASE_SEQ_ERROR)
                    status |= SSI_SDR_ERASE_SEQ_ERROR;
                if (cardstatus & ADDRESS_ERROR)
                    status |= SSI_SDR_ADDRESS_ERROR;
                if (cardstatus & CARD_IS_LOCKED)
                    status |= SSI_SDR_LOCKED;
                if (cardstatus & (LOCK_UNLOCK_FAILED | WP_ERASE_SKIP))
                    status |= SSI_SDR_WP_ERASE;
                if (cardstatus & SD_ERROR)
                    status |= SSI_SDR_ERROR;
                if (cardstatus & CC_ERROR)
                    status |= SSI_SDR_CC_ERROR;
                if (cardstatus & CARD_ECC_FAILED)
                    status |= SSI_SDR_ECC_FAILED;
                if (cardstatus & WP_VIOLATION)
                    status |= SSI_SDR_WP_VIOLATION;
                if (cardstatus & ERASE_PARAM)
                    status |= SSI_SDR_ERASE_PARAM;
                if (cardstatus & (OUT_OF_RANGE | CID_CSD_OVERWRITE))
                    status |= SSI_SDR_OUT_OF_RANGE;
                /* ??? Don't know what Parameter Error really means, so
                   assume it's set if the second byte is nonzero.  */
                if (status & 0xff)
                    status |= SSI_SDR_PARAMETER_ERROR;
                s->response[0] = status >> 8;
                s->response[1] = status;
                DPRINTF("Card status 0x%02x\n", status);
            }
            s->mode = SSI_SD_RESPONSE;
            s->response_pos = 0;
        } else {
            s->cmdarg[s->arglen++] = val;
        }
        return 0xff;
    case SSI_SD_RESPONSE:
        if (s->stopping) {
            s->stopping = 0;
            return 0xff;
        }
        if (s->response_pos < s->arglen) {
            DPRINTF("Response 0x%02x\n", s->response[s->response_pos]);
            return s->response[s->response_pos++];
        }
        if (sd_data_ready(s->sd)) {
            DPRINTF("Data read\n");
            s->mode = SSI_SD_DATA_START;
        } else {
            DPRINTF("End of command\n");
            s->mode = SSI_SD_CMD;
        }
        return 0xff;
    case SSI_SD_DATA_START:
        DPRINTF("Start read block\n");
        s->mode = SSI_SD_DATA_READ;
        return 0xfe;
    case SSI_SD_DATA_READ:
        val = sd_read_data(s->sd);
        if (!sd_data_ready(s->sd)) {
            DPRINTF("Data read end\n");
            s->mode = SSI_SD_CMD;
        }
        return val;
    }
    /* Should never happen.  */
    return 0xff;
}

static void ssi_sd_save(QEMUFile *f, void *opaque)
{
    SSISlave *ss = SSI_SLAVE(opaque);
    ssi_sd_state *s = (ssi_sd_state *)opaque;
    int i;

    qemu_put_be32(f, s->mode);
    qemu_put_be32(f, s->cmd);
    for (i = 0; i < 4; i++)
        qemu_put_be32(f, s->cmdarg[i]);
    for (i = 0; i < 5; i++)
        qemu_put_be32(f, s->response[i]);
    qemu_put_be32(f, s->arglen);
    qemu_put_be32(f, s->response_pos);
    qemu_put_be32(f, s->stopping);

    qemu_put_be32(f, ss->cs);
}

static int ssi_sd_load(QEMUFile *f, void *opaque, int version_id)
{
    SSISlave *ss = SSI_SLAVE(opaque);
    ssi_sd_state *s = (ssi_sd_state *)opaque;
    int i;

    if (version_id != 1)
        return -EINVAL;

    s->mode = qemu_get_be32(f);
    s->cmd = qemu_get_be32(f);
    for (i = 0; i < 4; i++)
        s->cmdarg[i] = qemu_get_be32(f);
    for (i = 0; i < 5; i++)
        s->response[i] = qemu_get_be32(f);
    s->arglen = qemu_get_be32(f);
    if (s->mode == SSI_SD_CMDARG &&
        (s->arglen < 0 || s->arglen >= ARRAY_SIZE(s->cmdarg))) {
        return -EINVAL;
    }
    s->response_pos = qemu_get_be32(f);
    s->stopping = qemu_get_be32(f);
    if (s->mode == SSI_SD_RESPONSE &&
        (s->response_pos < 0 || s->response_pos >= ARRAY_SIZE(s->response) ||
        (!s->stopping && s->arglen > ARRAY_SIZE(s->response)))) {
        return -EINVAL;
    }

    ss->cs = qemu_get_be32(f);

    return 0;
}

static int ssi_sd_init(SSISlave *d)
{
    DeviceState *dev = DEVICE(d);
    ssi_sd_state *s = FROM_SSI_SLAVE(ssi_sd_state, d);
    DriveInfo *dinfo;

    s->mode = SSI_SD_CMD;
    /* FIXME use a qdev drive property instead of drive_get_next() */
    dinfo = drive_get_next(IF_SD);
    s->sd = sd_init(dinfo ? blk_by_legacy_dinfo(dinfo) : NULL, true);
    if (s->sd == NULL) {
        return -1;
    }
    register_savevm(dev, "ssi_sd", -1, 1, ssi_sd_save, ssi_sd_load, s);
    return 0;
}

static void ssi_sd_class_init(ObjectClass *klass, void *data)
{
    SSISlaveClass *k = SSI_SLAVE_CLASS(klass);

    k->init = ssi_sd_init;
    k->transfer = ssi_sd_transfer;
    k->cs_polarity = SSI_CS_LOW;
}

static const TypeInfo ssi_sd_info = {
    .name          = "ssi-sd",
    .parent        = TYPE_SSI_SLAVE,
    .instance_size = sizeof(ssi_sd_state),
    .class_init    = ssi_sd_class_init,
};

static void ssi_sd_register_types(void)
{
    type_register_static(&ssi_sd_info);
}

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