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

/*
 * SSI to SD card adapter.
 *
 * Copyright (c) 2007-2009 CodeSourcery.
 * Written by Paul Brook
 *
 * This code is licenced under the GNU GPL v2.
 */

#include "ssi.h"
#include "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)
{
    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);
}

static int ssi_sd_load(QEMUFile *f, void *opaque, int version_id)
{
    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);
    s->response_pos = qemu_get_be32(f);
    s->stopping = qemu_get_be32(f);

    return 0;
}

static int ssi_sd_init(SSISlave *dev)
{
    ssi_sd_state *s = FROM_SSI_SLAVE(ssi_sd_state, dev);
    BlockDriverState *bs;

    s->mode = SSI_SD_CMD;
    bs = qdev_init_bdrv(&dev->qdev, IF_SD);
    s->sd = sd_init(bs, 1);
    register_savevm("ssi_sd", -1, 1, ssi_sd_save, ssi_sd_load, s);
    return 0;
}

static SSISlaveInfo ssi_sd_info = {
    .qdev.name = "ssi-sd",
    .qdev.size = sizeof(ssi_sd_state),
    .init = ssi_sd_init,
    .transfer = ssi_sd_transfer
};

static void ssi_sd_register_devices(void)
{
    ssi_register_slave(&ssi_sd_info);
}

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