include/linux/mmc/sdhci.h

   1 /*
   2  *  linux/include/linux/mmc/sdhci.h - Secure Digital Host Controller Interface
   3  *
   4  *  Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or (at
   9  * your option) any later version.
  10  */
  11 #ifndef LINUX_MMC_SDHCI_H
  12 #define LINUX_MMC_SDHCI_H
  13
  14 #include <linux/scatterlist.h>
  15 #include <linux/compiler.h>
  16 #include <linux/types.h>
  17 #include <linux/io.h>
  18 #include <linux/mmc/host.h>
  19
  20 struct sdhci_host_next {
  21         unsigned int    sg_count;
  22         s32             cookie;
  23 };
  24
  25 struct sdhci_host {
  26         /* Data set by hardware interface driver */
  27         const char *hw_name;    /* Hardware bus name */
  28
  29         unsigned int quirks;    /* Deviations from spec. */
  30
  31 /* Controller doesn't honor resets unless we touch the clock register */
  32 #define SDHCI_QUIRK_CLOCK_BEFORE_RESET                  (1<<0)
  33 /* Controller has bad caps bits, but really supports DMA */
  34 #define SDHCI_QUIRK_FORCE_DMA                           (1<<1)
  35 /* Controller doesn't like to be reset when there is no card inserted. */
  36 #define SDHCI_QUIRK_NO_CARD_NO_RESET                    (1<<2)
  37 /* Controller doesn't like clearing the power reg before a change */
  38 #define SDHCI_QUIRK_SINGLE_POWER_WRITE                  (1<<3)
  39 /* Controller has flaky internal state so reset it on each ios change */
  40 #define SDHCI_QUIRK_RESET_CMD_DATA_ON_IOS               (1<<4)
  41 /* Controller has an unusable DMA engine */
  42 #define SDHCI_QUIRK_BROKEN_DMA                          (1<<5)
  43 /* Controller has an unusable ADMA engine */
  44 #define SDHCI_QUIRK_BROKEN_ADMA                         (1<<6)
  45 /* Controller can only DMA from 32-bit aligned addresses */
  46 #define SDHCI_QUIRK_32BIT_DMA_ADDR                      (1<<7)
  47 /* Controller can only DMA chunk sizes that are a multiple of 32 bits */
  48 #define SDHCI_QUIRK_32BIT_DMA_SIZE                      (1<<8)
  49 /* Controller can only ADMA chunks that are a multiple of 32 bits */
  50 #define SDHCI_QUIRK_32BIT_ADMA_SIZE                     (1<<9)
  51 /* Controller needs to be reset after each request to stay stable */
  52 #define SDHCI_QUIRK_RESET_AFTER_REQUEST                 (1<<10)
  53 /* Controller needs voltage and power writes to happen separately */
  54 #define SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER             (1<<11)
  55 /* Controller provides an incorrect timeout value for transfers */
  56 #define SDHCI_QUIRK_BROKEN_TIMEOUT_VAL                  (1<<12)
  57 /* Controller has an issue with buffer bits for small transfers */
  58 #define SDHCI_QUIRK_BROKEN_SMALL_PIO                    (1<<13)
  59 /* Controller does not provide transfer-complete interrupt when not busy */
  60 #define SDHCI_QUIRK_NO_BUSY_IRQ                         (1<<14)
  61 /* Controller has unreliable card detection */
  62 #define SDHCI_QUIRK_BROKEN_CARD_DETECTION               (1<<15)
  63 /* Controller reports inverted write-protect state */
  64 #define SDHCI_QUIRK_INVERTED_WRITE_PROTECT              (1<<16)
  65 /* Controller does not like fast PIO transfers */
  66 #define SDHCI_QUIRK_PIO_NEEDS_DELAY                     (1<<18)
  67 /* Controller has to be forced to use block size of 2048 bytes */
  68 #define SDHCI_QUIRK_FORCE_BLK_SZ_2048                   (1<<20)
  69 /* Controller cannot do multi-block transfers */
  70 #define SDHCI_QUIRK_NO_MULTIBLOCK                       (1<<21)
  71 /* Controller can only handle 1-bit data transfers */
  72 #define SDHCI_QUIRK_FORCE_1_BIT_DATA                    (1<<22)
  73 /* Controller needs 10ms delay between applying power and clock */
  74 #define SDHCI_QUIRK_DELAY_AFTER_POWER                   (1<<23)
  75 /* Controller uses SDCLK instead of TMCLK for data timeouts */
  76 #define SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK             (1<<24)
  77 /* Controller reports wrong base clock capability */
  78 #define SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN               (1<<25)
  79 /* Controller cannot support End Attribute in NOP ADMA descriptor */
  80 #define SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC               (1<<26)
  81 /* Controller is missing device caps. Use caps provided by host */
  82 #define SDHCI_QUIRK_MISSING_CAPS                        (1<<27)
  83 /* Controller uses Auto CMD12 command to stop the transfer */
  84 #define SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12              (1<<28)
  85 /* Controller doesn't have HISPD bit field in HI-SPEED SD card */
  86 #define SDHCI_QUIRK_NO_HISPD_BIT                        (1<<29)
  87 /* Controller treats ADMA descriptors with length 0000h incorrectly */
  88 #define SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC            (1<<30)
  89 /* The read-only detection via SDHCI_PRESENT_STATE register is unstable */
  90 #define SDHCI_QUIRK_UNSTABLE_RO_DETECT                  (1<<31)
  91
  92         unsigned int quirks2;   /* More deviations from spec. */
  93
  94 #define SDHCI_QUIRK2_HOST_OFF_CARD_ON                   (1<<0)
  95 #define SDHCI_QUIRK2_HOST_NO_CMD23                      (1<<1)
  96 /* The system physically doesn't support 1.8v, even if the host does */
  97 #define SDHCI_QUIRK2_NO_1_8_V                           (1<<2)
  98 #define SDHCI_QUIRK2_PRESET_VALUE_BROKEN                (1<<3)
  99 #define SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON               (1<<4)
 100 /* Controller has a non-standard host control register */
 101 #define SDHCI_QUIRK2_BROKEN_HOST_CONTROL                (1<<5)
 102 /* Controller does not support HS200 */
 103 #define SDHCI_QUIRK2_BROKEN_HS200                       (1<<6)
 104 /* Controller does not support DDR50 */
 105 #define SDHCI_QUIRK2_BROKEN_DDR50                       (1<<7)
 106 /* Stop command (CMD12) can set Transfer Complete when not using MMC_RSP_BUSY */
 107 #define SDHCI_QUIRK2_STOP_WITH_TC                       (1<<8)
 108 /* Controller does not support 64-bit DMA */
 109 #define SDHCI_QUIRK2_BROKEN_64_BIT_DMA                  (1<<9)
 110 /* need clear transfer mode register before send cmd */
 111 #define SDHCI_QUIRK2_CLEAR_TRANSFERMODE_REG_BEFORE_CMD  (1<<10)
 112 /* Capability register bit-63 indicates HS400 support */
 113 #define SDHCI_QUIRK2_CAPS_BIT63_FOR_HS400               (1<<11)
 114 /* forced tuned clock */
 115 #define SDHCI_QUIRK2_TUNING_WORK_AROUND                 (1<<12)
 116
 117         int irq;                /* Device IRQ */
 118         void __iomem *ioaddr;   /* Mapped address */
 119
 120         const struct sdhci_ops *ops;    /* Low level hw interface */
 121
 122         /* Internal data */
 123         struct mmc_host *mmc;   /* MMC structure */
 124         u64 dma_mask;           /* custom DMA mask */
 125
 126 #if defined(CONFIG_LEDS_CLASS) || defined(CONFIG_LEDS_CLASS_MODULE)
 127         struct led_classdev led;        /* LED control */
 128         char led_name[32];
 129 #endif
 130
 131         spinlock_t lock;        /* Mutex */
 132
 133         int flags;              /* Host attributes */
 134 #define SDHCI_USE_SDMA          (1<<0)  /* Host is SDMA capable */
 135 #define SDHCI_USE_ADMA          (1<<1)  /* Host is ADMA capable */
 136 #define SDHCI_REQ_USE_DMA       (1<<2)  /* Use DMA for this req. */
 137 #define SDHCI_DEVICE_DEAD       (1<<3)  /* Device unresponsive */
 138 #define SDHCI_SDR50_NEEDS_TUNING (1<<4) /* SDR50 needs tuning */
 139 #define SDHCI_NEEDS_RETUNING    (1<<5)  /* Host needs retuning */
 140 #define SDHCI_AUTO_CMD12        (1<<6)  /* Auto CMD12 support */
 141 #define SDHCI_AUTO_CMD23        (1<<7)  /* Auto CMD23 support */
 142 #define SDHCI_PV_ENABLED        (1<<8)  /* Preset value enabled */
 143 #define SDHCI_SDIO_IRQ_ENABLED  (1<<9)  /* SDIO irq enabled */
 144 #define SDHCI_SDR104_NEEDS_TUNING (1<<10)       /* SDR104/HS200 needs tuning */
 145 #define SDHCI_USING_RETUNING_TIMER (1<<11)      /* Host is using a retuning timer for the card */
 146 #define SDHCI_USE_64_BIT_DMA    (1<<12) /* Use 64-bit DMA */
 147 #define SDHCI_HS400_TUNING      (1<<13) /* Tuning for HS400 */
 148
 149         unsigned int version;   /* SDHCI spec. version */
 150
 151         unsigned int max_clk;   /* Max possible freq (MHz) */
 152         unsigned int timeout_clk;       /* Timeout freq (KHz) */
 153         unsigned int clk_mul;   /* Clock Muliplier value */
 154
 155         unsigned int clock;     /* Current clock (MHz) */
 156         u8 pwr;                 /* Current voltage */
 157
 158         bool runtime_suspended; /* Host is runtime suspended */
 159         bool bus_on;            /* Bus power prevents runtime suspend */
 160         bool preset_enabled;    /* Preset is enabled */
 161
 162         struct mmc_request *mrq;        /* Current request */
 163         struct mmc_command *cmd;        /* Current command */
 164         struct mmc_data *data;  /* Current data request */
 165         unsigned int data_early:1;      /* Data finished before cmd */
 166         unsigned int busy_handle:1;     /* Handling the order of Busy-end */
 167
 168         struct sg_mapping_iter sg_miter;        /* SG state for PIO */
 169         unsigned int blocks;    /* remaining PIO blocks */
 170
 171         int sg_count;           /* Mapped sg entries */
 172
 173         void *adma_table;       /* ADMA descriptor table */
 174         void *align_buffer;     /* Bounce buffer */
 175
 176         size_t adma_table_sz;   /* ADMA descriptor table size */
 177         size_t align_buffer_sz; /* Bounce buffer size */
 178
 179         dma_addr_t adma_addr;   /* Mapped ADMA descr. table */
 180         dma_addr_t align_addr;  /* Mapped bounce buffer */
 181
 182         unsigned int desc_sz;   /* ADMA descriptor size */
 183         unsigned int align_sz;  /* ADMA alignment */
 184         unsigned int align_mask;        /* ADMA alignment mask */
 185
 186         struct tasklet_struct finish_tasklet;   /* Tasklet structures */
 187
 188         struct timer_list timer;        /* Timer for timeouts */
 189
 190         u32 caps;               /* Alternative CAPABILITY_0 */
 191         u32 caps1;              /* Alternative CAPABILITY_1 */
 192
 193         unsigned int            ocr_avail_sdio; /* OCR bit masks */
 194         unsigned int            ocr_avail_sd;
 195         unsigned int            ocr_avail_mmc;
 196         u32 ocr_mask;           /* available voltages */
 197
 198         unsigned                timing;         /* Current timing */
 199
 200         u32                     thread_isr;
 201
 202         /* cached registers */
 203         u32                     ier;
 204
 205         wait_queue_head_t       buf_ready_int;  /* Waitqueue for Buffer Read Ready interrupt */
 206         unsigned int            tuning_done;    /* Condition flag set when CMD19 succeeds */
 207
 208         unsigned int            tuning_count;   /* Timer count for re-tuning */
 209         unsigned int            tuning_mode;    /* Re-tuning mode supported by host */
 210 #define SDHCI_TUNING_MODE_1     0
 211         struct timer_list       tuning_timer;   /* Timer for tuning */
 212
 213         struct sdhci_host_next  next_data;
 214         unsigned long private[0] ____cacheline_aligned;
 215 };
 216 #endif /* LINUX_MMC_SDHCI_H */