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/workqueue.h>
  16 #include <linux/compiler.h>
  17 #include <linux/types.h>
  18 #include <linux/mutex.h>
  19 #include <linux/io.h>
  20 #include <linux/mmc/host.h>
  21
  22 struct sdhci_host {
  23         /* Data set by hardware interface driver */
  24         const char *hw_name;    /* Hardware bus name */
  25
  26         unsigned int quirks;    /* Deviations from spec. */
  27
  28 /* Controller doesn't honor resets unless we touch the clock register */
  29 #define SDHCI_QUIRK_CLOCK_BEFORE_RESET                  (1<<0)
  30 /* Controller has bad caps bits, but really supports DMA */
  31 #define SDHCI_QUIRK_FORCE_DMA                           (1<<1)
  32 /* Controller doesn't like to be reset when there is no card inserted. */
  33 #define SDHCI_QUIRK_NO_CARD_NO_RESET                    (1<<2)
  34 /* Controller doesn't like clearing the power reg before a change */
  35 #define SDHCI_QUIRK_SINGLE_POWER_WRITE                  (1<<3)
  36 /* Controller has flaky internal state so reset it on each ios change */
  37 #define SDHCI_QUIRK_RESET_CMD_DATA_ON_IOS               (1<<4)
  38 /* Controller has an unusable DMA engine */
  39 #define SDHCI_QUIRK_BROKEN_DMA                          (1<<5)
  40 /* Controller has an unusable ADMA engine */
  41 #define SDHCI_QUIRK_BROKEN_ADMA                         (1<<6)
  42 /* Controller can only DMA from 32-bit aligned addresses */
  43 #define SDHCI_QUIRK_32BIT_DMA_ADDR                      (1<<7)
  44 /* Controller can only DMA chunk sizes that are a multiple of 32 bits */
  45 #define SDHCI_QUIRK_32BIT_DMA_SIZE                      (1<<8)
  46 /* Controller can only ADMA chunks that are a multiple of 32 bits */
  47 #define SDHCI_QUIRK_32BIT_ADMA_SIZE                     (1<<9)
  48 /* Controller needs to be reset after each request to stay stable */
  49 #define SDHCI_QUIRK_RESET_AFTER_REQUEST                 (1<<10)
  50 /* Controller needs voltage and power writes to happen separately */
  51 #define SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER             (1<<11)
  52 /* Controller provides an incorrect timeout value for transfers */
  53 #define SDHCI_QUIRK_BROKEN_TIMEOUT_VAL                  (1<<12)
  54 /* Controller has an issue with buffer bits for small transfers */
  55 #define SDHCI_QUIRK_BROKEN_SMALL_PIO                    (1<<13)
  56 /* Controller does not provide transfer-complete interrupt when not busy */
  57 #define SDHCI_QUIRK_NO_BUSY_IRQ                         (1<<14)
  58 /* Controller has unreliable card detection */
  59 #define SDHCI_QUIRK_BROKEN_CARD_DETECTION               (1<<15)
  60 /* Controller reports inverted write-protect state */
  61 #define SDHCI_QUIRK_INVERTED_WRITE_PROTECT              (1<<16)
  62 /* Controller has nonstandard clock management */
  63 #define SDHCI_QUIRK_NONSTANDARD_CLOCK                   (1<<17)
  64 /* Controller does not like fast PIO transfers */
  65 #define SDHCI_QUIRK_PIO_NEEDS_DELAY                     (1<<18)
  66 /* Controller losing signal/interrupt enable states after reset */
  67 #define SDHCI_QUIRK_RESTORE_IRQS_AFTER_RESET            (1<<19)
  68 /* Controller has to be forced to use block size of 2048 bytes */
  69 #define SDHCI_QUIRK_FORCE_BLK_SZ_2048                   (1<<20)
  70 /* Controller cannot do multi-block transfers */
  71 #define SDHCI_QUIRK_NO_MULTIBLOCK                       (1<<21)
  72 /* Controller can only handle 1-bit data transfers */
  73 #define SDHCI_QUIRK_FORCE_1_BIT_DATA                    (1<<22)
  74 /* Controller needs 10ms delay between applying power and clock */
  75 #define SDHCI_QUIRK_DELAY_AFTER_POWER                   (1<<23)
  76 /* Controller uses SDCLK instead of TMCLK for data timeouts */
  77 #define SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK             (1<<24)
  78 /* Controller reports wrong base clock capability */
  79 #define SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN               (1<<25)
  80 /* Controller cannot support End Attribute in NOP ADMA descriptor */
  81 #define SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC               (1<<26)
  82 /* Controller is missing device caps. Use caps provided by host */
  83 #define SDHCI_QUIRK_MISSING_CAPS                        (1<<27)
  84 /* Controller uses Auto CMD12 command to stop the transfer */
  85 #define SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12              (1<<28)
  86 /* Controller doesn't have HISPD bit field in HI-SPEED SD card */
  87 #define SDHCI_QUIRK_NO_HISPD_BIT                        (1<<29)
  88 /* Controller treats ADMA descriptors with length 0000h incorrectly */
  89 #define SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC            (1<<30)
  90 /* The read-only detection via SDHCI_PRESENT_STATE register is unstable */
  91 #define SDHCI_QUIRK_UNSTABLE_RO_DETECT                  (1<<31)
  92
  93         unsigned int quirks2;   /* More deviations from spec. */
  94
  95 #define SDHCI_QUIRK2_HOST_OFF_CARD_ON                   (1<<0)
  96 #define SDHCI_QUIRK2_HOST_NO_CMD23                      (1<<1)
  97 /* The system physically doesn't support 1.8v, even if the host does */
  98 #define SDHCI_QUIRK2_NO_1_8_V                           (1<<2)
  99 #define SDHCI_QUIRK2_PRESET_VALUE_BROKEN                (1<<3)
 100 #define SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON               (1<<4)
 101 /* Controller has a non-standard host control register */
 102 #define SDHCI_QUIRK2_BROKEN_HOST_CONTROL                (1<<5)
 103
 104         int irq;                /* Device IRQ */
 105         void __iomem *ioaddr;   /* Mapped address */
 106
 107         const struct sdhci_ops *ops;    /* Low level hw interface */
 108
 109         struct regulator *vmmc;         /* Power regulator (vmmc) */
 110         struct regulator *vqmmc;        /* Signaling regulator (vccq) */
 111
 112         /* Internal data */
 113         struct mmc_host *mmc;   /* MMC structure */
 114         u64 dma_mask;           /* custom DMA mask */
 115
 116 #if defined(CONFIG_LEDS_CLASS) || defined(CONFIG_LEDS_CLASS_MODULE)
 117         struct led_classdev led;        /* LED control */
 118         char led_name[32];
 119         enum led_brightness brightness;
 120 #endif
 121
 122         struct mutex lock;      /* Mutex */
 123
 124         int flags;              /* Host attributes */
 125 #define SDHCI_USE_SDMA          (1<<0)  /* Host is SDMA capable */
 126 #define SDHCI_USE_ADMA          (1<<1)  /* Host is ADMA capable */
 127 #define SDHCI_REQ_USE_DMA       (1<<2)  /* Use DMA for this req. */
 128 #define SDHCI_DEVICE_DEAD       (1<<3)  /* Device unresponsive */
 129 #define SDHCI_SDR50_NEEDS_TUNING (1<<4) /* SDR50 needs tuning */
 130 #define SDHCI_NEEDS_RETUNING    (1<<5)  /* Host needs retuning */
 131 #define SDHCI_AUTO_CMD12        (1<<6)  /* Auto CMD12 support */
 132 #define SDHCI_AUTO_CMD23        (1<<7)  /* Auto CMD23 support */
 133 #define SDHCI_PV_ENABLED        (1<<8)  /* Preset value enabled */
 134 #define SDHCI_SDIO_IRQ_ENABLED  (1<<9)  /* SDIO irq enabled */
 135 #define SDHCI_SDR104_NEEDS_TUNING (1<<10)       /* SDR104/HS200 needs tuning */
 136 #define SDHCI_USING_RETUNING_TIMER (1<<11)      /* Host is using a retuning timer for the card */
 137
 138         unsigned int version;   /* SDHCI spec. version */
 139
 140         unsigned int max_clk;   /* Max possible freq (MHz) */
 141         unsigned int timeout_clk;       /* Timeout freq (KHz) */
 142         unsigned int clk_mul;   /* Clock Muliplier value */
 143
 144         unsigned int clock;     /* Current clock (MHz) */
 145         u8 pwr;                 /* Current voltage */
 146
 147         bool runtime_suspended; /* Host is runtime suspended */
 148         bool bus_on;            /* Bus power prevents runtime suspend */
 149
 150         struct mmc_request *mrq;        /* Current request */
 151         struct mmc_command *cmd;        /* Current command */
 152         struct mmc_data *data;  /* Current data request */
 153         unsigned int data_early:1;      /* Data finished before cmd */
 154
 155         struct sg_mapping_iter sg_miter;        /* SG state for PIO */
 156         unsigned int blocks;    /* remaining PIO blocks */
 157
 158         int sg_count;           /* Mapped sg entries */
 159
 160         u8 *adma_desc;          /* ADMA descriptor table */
 161         u8 *align_buffer;       /* Bounce buffer */
 162
 163         dma_addr_t adma_addr;   /* Mapped ADMA descr. table */
 164         dma_addr_t align_addr;  /* Mapped bounce buffer */
 165
 166         struct work_struct      card_detect_work;
 167         struct work_struct      finish_work;
 168
 169         struct delayed_work     timeout_work;   /* Work for timeouts */
 170
 171         u32 caps;               /* Alternative CAPABILITY_0 */
 172         u32 caps1;              /* Alternative CAPABILITY_1 */
 173
 174         unsigned int            ocr_avail_sdio; /* OCR bit masks */
 175         unsigned int            ocr_avail_sd;
 176         unsigned int            ocr_avail_mmc;
 177         u32 ocr_mask;           /* available voltages */
 178
 179         wait_queue_head_t       buf_ready_int;  /* Waitqueue for Buffer Read Ready interrupt */
 180         unsigned int            tuning_done;    /* Condition flag set when CMD19 succeeds */
 181
 182         unsigned int            tuning_count;   /* Timer count for re-tuning */
 183         unsigned int            tuning_mode;    /* Re-tuning mode supported by host */
 184 #define SDHCI_TUNING_MODE_1     0
 185         struct delayed_work     tuning_timeout_work;    /* Work for tuning timeouts */
 186
 187         unsigned long private[0] ____cacheline_aligned;
 188 };
 189 #endif /* LINUX_MMC_SDHCI_H */