include/hw/sd/sd.h

   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 enum {
  79     sd_spi,
  80     sd_bc,     /* broadcast -- no response */
  81     sd_bcr,    /* broadcast with response */
  82     sd_ac,     /* addressed -- no data transfer */
  83     sd_adtc,   /* addressed with data transfer */
  84 } sd_cmd_type_t;
  85
  86 typedef struct {
  87     uint8_t cmd;
  88     uint32_t arg;
  89     uint8_t crc;
  90 } SDRequest;
  91
  92
  93 #define TYPE_SD_CARD "sd-card"
  94 OBJECT_DECLARE_TYPE(SDState, SDCardClass, SD_CARD)
  95
  96 #define TYPE_SD_CARD_SPI "sd-card-spi"
  97 DECLARE_INSTANCE_CHECKER(SDState, SD_CARD_SPI, TYPE_SD_CARD_SPI)
  98
  99 #define TYPE_EMMC "emmc"
 100 DECLARE_INSTANCE_CHECKER(SDState, EMMC, TYPE_EMMC)
 101
 102 struct SDCardClass {
 103     /*< private >*/
 104     DeviceClass parent_class;
 105     /*< public >*/
 106
 107     int (*do_command)(SDState *sd, SDRequest *req, uint8_t *response);
 108     /**
 109      * Write a byte to a SD card.
 110      * @sd: card
 111      * @value: byte to write
 112      *
 113      * Write a byte on the data lines of a SD card.
 114      */
 115     void (*write_byte)(SDState *sd, uint8_t value);
 116     /**
 117      * Read a byte from a SD card.
 118      * @sd: card
 119      *
 120      * Read a byte from the data lines of a SD card.
 121      *
 122      * Return: byte value read
 123      */
 124     uint8_t (*read_byte)(SDState *sd);
 125     bool (*receive_ready)(SDState *sd);
 126     bool (*data_ready)(SDState *sd);
 127     void (*set_voltage)(SDState *sd, uint16_t millivolts);
 128     uint8_t (*get_dat_lines)(SDState *sd);
 129     bool (*get_cmd_line)(SDState *sd);
 130     void (*enable)(SDState *sd, bool enable);
 131     bool (*get_inserted)(SDState *sd);
 132     bool (*get_readonly)(SDState *sd);
 133     void (*set_cid)(SDState *sd);
 134     void (*set_csd)(SDState *sd, uint64_t size);
 135
 136     const struct SDProto *proto;
 137 };
 138
 139 #define TYPE_SD_BUS "sd-bus"
 140 OBJECT_DECLARE_TYPE(SDBus, SDBusClass,
 141                     SD_BUS)
 142
 143 struct SDBus {
 144     BusState qbus;
 145 };
 146
 147 struct SDBusClass {
 148     /*< private >*/
 149     BusClass parent_class;
 150     /*< public >*/
 151
 152     /* These methods are called by the SD device to notify the controller
 153      * when the card insertion or readonly status changes
 154      */
 155     void (*set_inserted)(DeviceState *dev, bool inserted);
 156     void (*set_readonly)(DeviceState *dev, bool readonly);
 157 };
 158
 159 /* Functions to be used by qdevified callers (working via
 160  * an SDBus rather than directly with SDState)
 161  */
 162 void sdbus_set_voltage(SDBus *sdbus, uint16_t millivolts);
 163 uint8_t sdbus_get_dat_lines(SDBus *sdbus);
 164 bool sdbus_get_cmd_line(SDBus *sdbus);
 165 int sdbus_do_command(SDBus *sd, SDRequest *req, uint8_t *response);
 166 /**
 167  * Write a byte to a SD bus.
 168  * @sd: bus
 169  * @value: byte to write
 170  *
 171  * Write a byte on the data lines of a SD bus.
 172  */
 173 void sdbus_write_byte(SDBus *sd, uint8_t value);
 174 /**
 175  * Read a byte from a SD bus.
 176  * @sd: bus
 177  *
 178  * Read a byte from the data lines of a SD bus.
 179  *
 180  * Return: byte value read
 181  */
 182 uint8_t sdbus_read_byte(SDBus *sd);
 183 /**
 184  * Write data to a SD bus.
 185  * @sdbus: bus
 186  * @buf: data to write
 187  * @length: number of bytes to write
 188  *
 189  * Write multiple bytes of data on the data lines of a SD bus.
 190  */
 191 void sdbus_write_data(SDBus *sdbus, const void *buf, size_t length);
 192 /**
 193  * Read data from a SD bus.
 194  * @sdbus: bus
 195  * @buf: buffer to read data into
 196  * @length: number of bytes to read
 197  *
 198  * Read multiple bytes of data on the data lines of a SD bus.
 199  */
 200 void sdbus_read_data(SDBus *sdbus, void *buf, size_t length);
 201 bool sdbus_receive_ready(SDBus *sd);
 202 bool sdbus_data_ready(SDBus *sd);
 203 bool sdbus_get_inserted(SDBus *sd);
 204 bool sdbus_get_readonly(SDBus *sd);
 205 /**
 206  * sdbus_reparent_card: Reparent an SD card from one controller to another
 207  * @from: controller bus to remove card from
 208  * @to: controller bus to move card to
 209  *
 210  * Reparent an SD card, effectively unplugging it from one controller
 211  * and inserting it into another. This is useful for SoCs like the
 212  * bcm2835 which have two SD controllers and connect a single SD card
 213  * to them, selected by the guest reprogramming GPIO line routing.
 214  */
 215 void sdbus_reparent_card(SDBus *from, SDBus *to);
 216
 217 /* Functions to be used by SD devices to report back to qdevified controllers */
 218 void sdbus_set_inserted(SDBus *sd, bool inserted);
 219 void sdbus_set_readonly(SDBus *sd, bool inserted);
 220
 221 #endif /* HW_SD_H */