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