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 30 #ifndef HW_SD_H 31 #define HW_SD_H 32 33 #include "hw/qdev-core.h" 34 #include "qom/object.h" 35 36 #define OUT_OF_RANGE (1 << 31) 37 #define ADDRESS_ERROR (1 << 30) 38 #define BLOCK_LEN_ERROR (1 << 29) 39 #define ERASE_SEQ_ERROR (1 << 28) 40 #define ERASE_PARAM (1 << 27) 41 #define WP_VIOLATION (1 << 26) 42 #define CARD_IS_LOCKED (1 << 25) 43 #define LOCK_UNLOCK_FAILED (1 << 24) 44 #define COM_CRC_ERROR (1 << 23) 45 #define ILLEGAL_COMMAND (1 << 22) 46 #define CARD_ECC_FAILED (1 << 21) 47 #define CC_ERROR (1 << 20) 48 #define SD_ERROR (1 << 19) 49 #define CID_CSD_OVERWRITE (1 << 16) 50 #define WP_ERASE_SKIP (1 << 15) 51 #define CARD_ECC_DISABLED (1 << 14) 52 #define ERASE_RESET (1 << 13) 53 #define CURRENT_STATE (7 << 9) 54 #define READY_FOR_DATA (1 << 8) 55 #define APP_CMD (1 << 5) 56 #define AKE_SEQ_ERROR (1 << 3) 57 58 enum SDPhySpecificationVersion { 59 SD_PHY_SPECv1_10_VERS = 1, 60 SD_PHY_SPECv2_00_VERS = 2, 61 SD_PHY_SPECv3_01_VERS = 3, 62 }; 63 64 typedef enum { 65 SD_VOLTAGE_0_4V = 400, /* currently not supported */ 66 SD_VOLTAGE_1_8V = 1800, 67 SD_VOLTAGE_3_0V = 3000, 68 SD_VOLTAGE_3_3V = 3300, 69 } sd_voltage_mv_t; 70 71 typedef enum { 72 UHS_NOT_SUPPORTED = 0, 73 UHS_I = 1, 74 UHS_II = 2, /* currently not supported */ 75 UHS_III = 3, /* currently not supported */ 76 } sd_uhs_mode_t; 77 78 typedef struct { 79 uint8_t cmd; 80 uint32_t arg; 81 uint8_t crc; 82 } SDRequest; 83 84 85 #define TYPE_SD_CARD "sd-card" 86 OBJECT_DECLARE_TYPE(SDState, SDCardClass, SD_CARD) 87 88 #define TYPE_SD_CARD_SPI "sd-card-spi" 89 DECLARE_INSTANCE_CHECKER(SDState, SD_CARD_SPI, TYPE_SD_CARD_SPI) 90 91 #define TYPE_EMMC "emmc" 92 DECLARE_INSTANCE_CHECKER(SDState, EMMC, TYPE_EMMC) 93 94 struct SDCardClass { 95 /*< private >*/ 96 DeviceClass parent_class; 97 /*< public >*/ 98 99 /** 100 * Process a SD command request. 101 * @sd: card 102 * @req: command request 103 * @resp: buffer to receive the command response 104 * @respsz: size of @resp buffer 105 * 106 * Return: size of the response 107 */ 108 size_t (*do_command)(SDState *sd, SDRequest *req, 109 uint8_t *resp, size_t respsz); 110 /** 111 * Write a byte to a SD card. 112 * @sd: card 113 * @value: byte to write 114 * 115 * Write a byte on the data lines of a SD card. 116 */ 117 void (*write_byte)(SDState *sd, uint8_t value); 118 /** 119 * Read a byte from a SD card. 120 * @sd: card 121 * 122 * Read a byte from the data lines of a SD card. 123 * 124 * Return: byte value read 125 */ 126 uint8_t (*read_byte)(SDState *sd); 127 bool (*receive_ready)(SDState *sd); 128 bool (*data_ready)(SDState *sd); 129 void (*set_voltage)(SDState *sd, uint16_t millivolts); 130 uint8_t (*get_dat_lines)(SDState *sd); 131 bool (*get_cmd_line)(SDState *sd); 132 bool (*get_inserted)(SDState *sd); 133 bool (*get_readonly)(SDState *sd); 134 void (*set_cid)(SDState *sd); 135 void (*set_csd)(SDState *sd, uint64_t size); 136 137 const struct SDProto *proto; 138 }; 139 140 #define TYPE_SD_BUS "sd-bus" 141 OBJECT_DECLARE_TYPE(SDBus, SDBusClass, 142 SD_BUS) 143 144 struct SDBus { 145 BusState qbus; 146 }; 147 148 struct SDBusClass { 149 /*< private >*/ 150 BusClass parent_class; 151 /*< public >*/ 152 153 /* These methods are called by the SD device to notify the controller 154 * when the card insertion or readonly status changes 155 */ 156 void (*set_inserted)(DeviceState *dev, bool inserted); 157 void (*set_readonly)(DeviceState *dev, bool readonly); 158 }; 159 160 /* Functions to be used by qdevified callers (working via 161 * an SDBus rather than directly with SDState) 162 */ 163 void sdbus_set_voltage(SDBus *sdbus, uint16_t millivolts); 164 uint8_t sdbus_get_dat_lines(SDBus *sdbus); 165 bool sdbus_get_cmd_line(SDBus *sdbus); 166 /** 167 * sdbus_do_command: Process a SD command request 168 * @sd: card 169 * @req: command request 170 * @resp: buffer to receive the command response 171 * @respsz: size of @resp buffer 172 * 173 * Return: size of the response 174 */ 175 size_t sdbus_do_command(SDBus *sd, SDRequest *req, uint8_t *resp, size_t respsz); 176 /** 177 * Write a byte to a SD bus. 178 * @sd: bus 179 * @value: byte to write 180 * 181 * Write a byte on the data lines of a SD bus. 182 */ 183 void sdbus_write_byte(SDBus *sd, uint8_t value); 184 /** 185 * Read a byte from a SD bus. 186 * @sd: bus 187 * 188 * Read a byte from the data lines of a SD bus. 189 * 190 * Return: byte value read 191 */ 192 uint8_t sdbus_read_byte(SDBus *sd); 193 /** 194 * Write data to a SD bus. 195 * @sdbus: bus 196 * @buf: data to write 197 * @length: number of bytes to write 198 * 199 * Write multiple bytes of data on the data lines of a SD bus. 200 */ 201 void sdbus_write_data(SDBus *sdbus, const void *buf, size_t length); 202 /** 203 * Read data from a SD bus. 204 * @sdbus: bus 205 * @buf: buffer to read data into 206 * @length: number of bytes to read 207 * 208 * Read multiple bytes of data on the data lines of a SD bus. 209 */ 210 void sdbus_read_data(SDBus *sdbus, void *buf, size_t length); 211 bool sdbus_receive_ready(SDBus *sd); 212 bool sdbus_data_ready(SDBus *sd); 213 bool sdbus_get_inserted(SDBus *sd); 214 bool sdbus_get_readonly(SDBus *sd); 215 /** 216 * sdbus_reparent_card: Reparent an SD card from one controller to another 217 * @from: controller bus to remove card from 218 * @to: controller bus to move card to 219 * 220 * Reparent an SD card, effectively unplugging it from one controller 221 * and inserting it into another. This is useful for SoCs like the 222 * bcm2835 which have two SD controllers and connect a single SD card 223 * to them, selected by the guest reprogramming GPIO line routing. 224 */ 225 void sdbus_reparent_card(SDBus *from, SDBus *to); 226 227 /* Functions to be used by SD devices to report back to qdevified controllers */ 228 void sdbus_set_inserted(SDBus *sd, bool inserted); 229 void sdbus_set_readonly(SDBus *sd, bool inserted); 230 231 #endif /* HW_SD_H */ 232