1 /*

     2  * SD Memory Card emulation.  Mostly correct for MMC too.

     3  *

     4  * Copyright (c) 2006 Andrzej Zaborowski  <balrog@zabor.org>

     5  *

     6  * Redistribution and use in source and binary forms, with or without

     7  * modification, are permitted provided that the following conditions

     8  * are met:

     9  *

    10  * 1. Redistributions of source code must retain the above copyright

    11  *    notice, this list of conditions and the following disclaimer.

    12  * 2. Redistributions in binary form must reproduce the above copyright

    13  *    notice, this list of conditions and the following disclaimer in

    14  *    the documentation and/or other materials provided with the

    15  *    distribution.

    16  *

    17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS''

    18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,

    19  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

    20  * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR

    21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

    22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

    23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

    24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY

    25  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

    26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

    27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    28  */

    29 #ifndef __hw_sd_h

    30 #define __hw_sd_h		1

    31 

    32 #define OUT_OF_RANGE		(1 << 31)

    33 #define ADDRESS_ERROR		(1 << 30)

    34 #define BLOCK_LEN_ERROR		(1 << 29)

    35 #define ERASE_SEQ_ERROR		(1 << 28)

    36 #define ERASE_PARAM		(1 << 27)

    37 #define WP_VIOLATION		(1 << 26)

    38 #define CARD_IS_LOCKED		(1 << 25)

    39 #define LOCK_UNLOCK_FAILED	(1 << 24)

    40 #define COM_CRC_ERROR		(1 << 23)

    41 #define ILLEGAL_COMMAND		(1 << 22)

    42 #define CARD_ECC_FAILED		(1 << 21)

    43 #define CC_ERROR		(1 << 20)

    44 #define SD_ERROR		(1 << 19)

    45 #define CID_CSD_OVERWRITE	(1 << 16)

    46 #define WP_ERASE_SKIP		(1 << 15)

    47 #define CARD_ECC_DISABLED	(1 << 14)

    48 #define ERASE_RESET		(1 << 13)

    49 #define CURRENT_STATE		(7 << 9)

    50 #define READY_FOR_DATA		(1 << 8)

    51 #define APP_CMD			(1 << 5)

    52 #define AKE_SEQ_ERROR		(1 << 3)

    53 

    54 typedef enum {

    55     sd_none = -1,

    56     sd_bc = 0,	/* broadcast -- no response */

    57     sd_bcr,	/* broadcast with response */

    58     sd_ac,	/* addressed -- no data transfer */

    59     sd_adtc,	/* addressed with data transfer */

    60 } sd_cmd_type_t;

    61 

    62 struct sd_request_s {

    63     uint8_t cmd;

    64     uint32_t arg;

    65     uint8_t crc;

    66 };

    67 

    68 typedef struct SDState SDState;

    69 

    70 SDState *sd_init(BlockDriverState *bs, int is_spi);

    71 int sd_do_command(SDState *sd, struct sd_request_s *req,

    72                   uint8_t *response);

    73 void sd_write_data(SDState *sd, uint8_t value);

    74 uint8_t sd_read_data(SDState *sd);

    75 void sd_set_cb(SDState *sd, qemu_irq readonly, qemu_irq insert);

    76 int sd_data_ready(SDState *sd);

    77 void sd_enable(SDState *sd, int enable);

    78 

    79 /* ssi-sd.c */

    80 int ssi_sd_xfer(void *opaque, int val);

    81 void *ssi_sd_init(BlockDriverState *bs);

    82 

    83 #endif	/* __hw_sd_h */