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 #include "hw/qdev.h" 33 34 #define OUT_OF_RANGE (1 << 31) 35 #define ADDRESS_ERROR (1 << 30) 36 #define BLOCK_LEN_ERROR (1 << 29) 37 #define ERASE_SEQ_ERROR (1 << 28) 38 #define ERASE_PARAM (1 << 27) 39 #define WP_VIOLATION (1 << 26) 40 #define CARD_IS_LOCKED (1 << 25) 41 #define LOCK_UNLOCK_FAILED (1 << 24) 42 #define COM_CRC_ERROR (1 << 23) 43 #define ILLEGAL_COMMAND (1 << 22) 44 #define CARD_ECC_FAILED (1 << 21) 45 #define CC_ERROR (1 << 20) 46 #define SD_ERROR (1 << 19) 47 #define CID_CSD_OVERWRITE (1 << 16) 48 #define WP_ERASE_SKIP (1 << 15) 49 #define CARD_ECC_DISABLED (1 << 14) 50 #define ERASE_RESET (1 << 13) 51 #define CURRENT_STATE (7 << 9) 52 #define READY_FOR_DATA (1 << 8) 53 #define APP_CMD (1 << 5) 54 #define AKE_SEQ_ERROR (1 << 3) 55 #define OCR_CCS_BITN 30 56 57 typedef enum { 58 sd_none = -1, 59 sd_bc = 0, /* broadcast -- no response */ 60 sd_bcr, /* broadcast with response */ 61 sd_ac, /* addressed -- no data transfer */ 62 sd_adtc, /* addressed with data transfer */ 63 } sd_cmd_type_t; 64 65 typedef struct { 66 uint8_t cmd; 67 uint32_t arg; 68 uint8_t crc; 69 } SDRequest; 70 71 typedef struct SDState SDState; 72 typedef struct SDBus SDBus; 73 74 #define TYPE_SD_CARD "sd-card" 75 #define SD_CARD(obj) OBJECT_CHECK(SDState, (obj), TYPE_SD_CARD) 76 #define SD_CARD_CLASS(klass) \ 77 OBJECT_CLASS_CHECK(SDCardClass, (klass), TYPE_SD_CARD) 78 #define SD_CARD_GET_CLASS(obj) \ 79 OBJECT_GET_CLASS(SDCardClass, (obj), TYPE_SD_CARD) 80 81 typedef struct { 82 /*< private >*/ 83 DeviceClass parent_class; 84 /*< public >*/ 85 86 int (*do_command)(SDState *sd, SDRequest *req, uint8_t *response); 87 void (*write_data)(SDState *sd, uint8_t value); 88 uint8_t (*read_data)(SDState *sd); 89 bool (*data_ready)(SDState *sd); 90 void (*enable)(SDState *sd, bool enable); 91 bool (*get_inserted)(SDState *sd); 92 bool (*get_readonly)(SDState *sd); 93 } SDCardClass; 94 95 #define TYPE_SD_BUS "sd-bus" 96 #define SD_BUS(obj) OBJECT_CHECK(SDBus, (obj), TYPE_SD_BUS) 97 #define SD_BUS_CLASS(klass) OBJECT_CLASS_CHECK(SDBusClass, (klass), TYPE_SD_BUS) 98 #define SD_BUS_GET_CLASS(obj) OBJECT_GET_CLASS(SDBusClass, (obj), TYPE_SD_BUS) 99 100 struct SDBus { 101 BusState qbus; 102 }; 103 104 typedef struct { 105 /*< private >*/ 106 BusClass parent_class; 107 /*< public >*/ 108 109 /* These methods are called by the SD device to notify the controller 110 * when the card insertion or readonly status changes 111 */ 112 void (*set_inserted)(DeviceState *dev, bool inserted); 113 void (*set_readonly)(DeviceState *dev, bool readonly); 114 } SDBusClass; 115 116 /* Legacy functions to be used only by non-qdevified callers */ 117 SDState *sd_init(BlockBackend *bs, bool is_spi); 118 int sd_do_command(SDState *sd, SDRequest *req, 119 uint8_t *response); 120 void sd_write_data(SDState *sd, uint8_t value); 121 uint8_t sd_read_data(SDState *sd); 122 void sd_set_cb(SDState *sd, qemu_irq readonly, qemu_irq insert); 123 bool sd_data_ready(SDState *sd); 124 /* sd_enable should not be used -- it is only used on the nseries boards, 125 * where it is part of a broken implementation of the MMC card slot switch 126 * (there should be two card slots which are multiplexed to a single MMC 127 * controller, but instead we model it with one card and controller and 128 * disable the card when the second slot is selected, so it looks like the 129 * second slot is always empty). 130 */ 131 void sd_enable(SDState *sd, bool enable); 132 133 /* Functions to be used by qdevified callers (working via 134 * an SDBus rather than directly with SDState) 135 */ 136 int sdbus_do_command(SDBus *sd, SDRequest *req, uint8_t *response); 137 void sdbus_write_data(SDBus *sd, uint8_t value); 138 uint8_t sdbus_read_data(SDBus *sd); 139 bool sdbus_data_ready(SDBus *sd); 140 bool sdbus_get_inserted(SDBus *sd); 141 bool sdbus_get_readonly(SDBus *sd); 142 143 /* Functions to be used by SD devices to report back to qdevified controllers */ 144 void sdbus_set_inserted(SDBus *sd, bool inserted); 145 void sdbus_set_readonly(SDBus *sd, bool inserted); 146 147 #endif /* __hw_sd_h */ 148