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