| /* |
| * linux/include/linux/mmc/sdhci.h - Secure Digital Host Controller Interface |
| * |
| * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved. |
| * |
| * This program is free software; you can redistribute it and/or modify |
| * it under the terms of the GNU General Public License as published by |
| * the Free Software Foundation; either version 2 of the License, or (at |
| * your option) any later version. |
| */ |
| #ifndef LINUX_MMC_SDHCI_H |
| #define LINUX_MMC_SDHCI_H |
| |
| #include <linux/scatterlist.h> |
| #include <linux/compiler.h> |
| #include <linux/types.h> |
| #include <linux/io.h> |
| #include <linux/mmc/host.h> |
| #include <linux/pm_qos.h> |
| |
| struct sdhci_next { |
| unsigned int sg_count; |
| s32 cookie; |
| }; |
| |
| enum sdhci_power_policy { |
| SDHCI_PERFORMANCE_MODE, |
| SDHCI_POWER_SAVE_MODE, |
| }; |
| |
| struct sdhci_host { |
| /* Data set by hardware interface driver */ |
| const char *hw_name; /* Hardware bus name */ |
| |
| unsigned int quirks; /* Deviations from spec. */ |
| |
| /* Controller doesn't honor resets unless we touch the clock register */ |
| #define SDHCI_QUIRK_CLOCK_BEFORE_RESET (1<<0) |
| /* Controller has bad caps bits, but really supports DMA */ |
| #define SDHCI_QUIRK_FORCE_DMA (1<<1) |
| /* Controller doesn't like to be reset when there is no card inserted. */ |
| #define SDHCI_QUIRK_NO_CARD_NO_RESET (1<<2) |
| /* Controller doesn't like clearing the power reg before a change */ |
| #define SDHCI_QUIRK_SINGLE_POWER_WRITE (1<<3) |
| /* Controller has flaky internal state so reset it on each ios change */ |
| #define SDHCI_QUIRK_RESET_CMD_DATA_ON_IOS (1<<4) |
| /* Controller has an unusable DMA engine */ |
| #define SDHCI_QUIRK_BROKEN_DMA (1<<5) |
| /* Controller has an unusable ADMA engine */ |
| #define SDHCI_QUIRK_BROKEN_ADMA (1<<6) |
| /* Controller can only DMA from 32-bit aligned addresses */ |
| #define SDHCI_QUIRK_32BIT_DMA_ADDR (1<<7) |
| /* Controller can only DMA chunk sizes that are a multiple of 32 bits */ |
| #define SDHCI_QUIRK_32BIT_DMA_SIZE (1<<8) |
| /* Controller can only ADMA chunks that are a multiple of 32 bits */ |
| #define SDHCI_QUIRK_32BIT_ADMA_SIZE (1<<9) |
| /* Controller needs to be reset after each request to stay stable */ |
| #define SDHCI_QUIRK_RESET_AFTER_REQUEST (1<<10) |
| /* Controller needs voltage and power writes to happen separately */ |
| #define SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER (1<<11) |
| /* Controller provides an incorrect timeout value for transfers */ |
| #define SDHCI_QUIRK_BROKEN_TIMEOUT_VAL (1<<12) |
| /* Controller has an issue with buffer bits for small transfers */ |
| #define SDHCI_QUIRK_BROKEN_SMALL_PIO (1<<13) |
| /* Controller does not provide transfer-complete interrupt when not busy */ |
| #define SDHCI_QUIRK_NO_BUSY_IRQ (1<<14) |
| /* Controller has unreliable card detection */ |
| #define SDHCI_QUIRK_BROKEN_CARD_DETECTION (1<<15) |
| /* Controller reports inverted write-protect state */ |
| #define SDHCI_QUIRK_INVERTED_WRITE_PROTECT (1<<16) |
| /* Controller has nonstandard clock management */ |
| #define SDHCI_QUIRK_NONSTANDARD_CLOCK (1<<17) |
| /* Controller does not like fast PIO transfers */ |
| #define SDHCI_QUIRK_PIO_NEEDS_DELAY (1<<18) |
| /* Controller losing signal/interrupt enable states after reset */ |
| #define SDHCI_QUIRK_RESTORE_IRQS_AFTER_RESET (1<<19) |
| /* Controller has to be forced to use block size of 2048 bytes */ |
| #define SDHCI_QUIRK_FORCE_BLK_SZ_2048 (1<<20) |
| /* Controller cannot do multi-block transfers */ |
| #define SDHCI_QUIRK_NO_MULTIBLOCK (1<<21) |
| /* Controller can only handle 1-bit data transfers */ |
| #define SDHCI_QUIRK_FORCE_1_BIT_DATA (1<<22) |
| /* Controller needs 10ms delay between applying power and clock */ |
| #define SDHCI_QUIRK_DELAY_AFTER_POWER (1<<23) |
| /* Controller uses SDCLK instead of TMCLK for data timeouts */ |
| #define SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK (1<<24) |
| /* Controller reports wrong base clock capability */ |
| #define SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN (1<<25) |
| /* Controller cannot support End Attribute in NOP ADMA descriptor */ |
| #define SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC (1<<26) |
| /* Controller is missing device caps. Use caps provided by host */ |
| #define SDHCI_QUIRK_MISSING_CAPS (1<<27) |
| /* Controller uses Auto CMD12 command to stop the transfer */ |
| #define SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12 (1<<28) |
| /* Controller doesn't have HISPD bit field in HI-SPEED SD card */ |
| #define SDHCI_QUIRK_NO_HISPD_BIT (1<<29) |
| /* Controller treats ADMA descriptors with length 0000h incorrectly */ |
| #define SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC (1<<30) |
| /* The read-only detection via SDHCI_PRESENT_STATE register is unstable */ |
| #define SDHCI_QUIRK_UNSTABLE_RO_DETECT (1<<31) |
| |
| unsigned int quirks2; /* More deviations from spec. */ |
| |
| #define SDHCI_QUIRK2_HOST_OFF_CARD_ON (1<<0) |
| /* |
| * Read Transfer Active/ Write Transfer Active may be not |
| * de-asserted after end of transaction. Issue reset for DAT line. |
| */ |
| #define SDHCI_QUIRK2_RDWR_TX_ACTIVE_EOT (1<<1) |
| /* |
| * Slow interrupt clearance at 400KHz may cause |
| * host controller driver interrupt handler to |
| * be called twice. |
| */ |
| #define SDHCI_QUIRK2_SLOW_INT_CLR (1<<2) |
| /* Ignore CMD CRC errors for tuning commands */ |
| #define SDHCI_QUIRK2_IGNORE_CMDCRC_FOR_TUNING (1<<3) |
| /* |
| * If the base clock can be scalable, then there should be no further |
| * clock dividing as the input clock itself will be scaled down to |
| * required frequency. |
| */ |
| #define SDHCI_QUIRK2_ALWAYS_USE_BASE_CLOCK (1<<4) |
| /* |
| * Dont use the max_discard_to in sdhci driver so that the maximum discard |
| * unit gets picked by the mmc queue. Otherwise, it takes a long time for |
| * secure discard kind of operations to complete. |
| */ |
| #define SDHCI_QUIRK2_USE_MAX_DISCARD_SIZE (1<<5) |
| /* |
| * Ignore data timeout error for R1B commands as there will be no |
| * data associated and the busy timeout value for these commands |
| * could be lager than the maximum timeout value that controller |
| * can handle. |
| */ |
| #define SDHCI_QUIRK2_IGNORE_DATATOUT_FOR_R1BCMD (1<<6) |
| /* |
| * The preset value registers are not properly initialized by |
| * some hardware and hence preset value must not be enabled for |
| * such controllers. |
| */ |
| #define SDHCI_QUIRK2_BROKEN_PRESET_VALUE (1<<7) |
| /* |
| * Some controllers define the usage of 0xF in data timeout counter |
| * register (0x2E) which is actually a reserved bit as per |
| * specification. |
| */ |
| #define SDHCI_QUIRK2_USE_RESERVED_MAX_TIMEOUT (1<<8) |
| /* |
| * This is applicable for controllers that advertize timeout clock |
| * value in capabilities register (bit 5-0) as just 50MHz whereas the |
| * base clock frequency is 200MHz. So, the controller internally |
| * multiplies the value in timeout control register by 4 with the |
| * assumption that driver always uses fixed timeout clock value from |
| * capabilities register to calculate the timeout. But when the driver |
| * uses SDHCI_QUIRK2_ALWAYS_USE_BASE_CLOCK base clock frequency is directly |
| * controller by driver and it's rate varies upto max. 200MHz. This new quirk |
| * will be used in such cases to avoid controller mulplication when timeout is |
| * calculated based on the base clock. |
| */ |
| #define SDHCI_QUIRK2_DIVIDE_TOUT_BY_4 (1 << 9) |
| |
| int irq; /* Device IRQ */ |
| void __iomem *ioaddr; /* Mapped address */ |
| |
| const struct sdhci_ops *ops; /* Low level hw interface */ |
| |
| struct regulator *vmmc; /* Power regulator */ |
| |
| /* Internal data */ |
| struct mmc_host *mmc; /* MMC structure */ |
| u64 dma_mask; /* custom DMA mask */ |
| |
| #if defined(CONFIG_LEDS_CLASS) || defined(CONFIG_LEDS_CLASS_MODULE) |
| struct led_classdev led; /* LED control */ |
| char led_name[32]; |
| #endif |
| |
| spinlock_t lock; /* Mutex */ |
| |
| int flags; /* Host attributes */ |
| #define SDHCI_USE_SDMA (1<<0) /* Host is SDMA capable */ |
| #define SDHCI_USE_ADMA (1<<1) /* Host is ADMA capable */ |
| #define SDHCI_REQ_USE_DMA (1<<2) /* Use DMA for this req. */ |
| #define SDHCI_DEVICE_DEAD (1<<3) /* Device unresponsive */ |
| #define SDHCI_SDR50_NEEDS_TUNING (1<<4) /* SDR50 needs tuning */ |
| #define SDHCI_NEEDS_RETUNING (1<<5) /* Host needs retuning */ |
| #define SDHCI_AUTO_CMD12 (1<<6) /* Auto CMD12 support */ |
| #define SDHCI_AUTO_CMD23 (1<<7) /* Auto CMD23 support */ |
| #define SDHCI_PV_ENABLED (1<<8) /* Preset value enabled */ |
| #define SDHCI_SDIO_IRQ_ENABLED (1<<9) /* SDIO irq enabled */ |
| #define SDHCI_HS200_NEEDS_TUNING (1<<10) /* HS200 needs tuning */ |
| #define SDHCI_HS400_NEEDS_TUNING (1<<11) /* HS400 needs tuning */ |
| |
| unsigned int version; /* SDHCI spec. version */ |
| |
| unsigned int max_clk; /* Max possible freq (MHz) */ |
| unsigned int timeout_clk; /* Timeout freq (KHz) */ |
| unsigned int clk_mul; /* Clock Muliplier value */ |
| |
| unsigned int clock; /* Current clock (MHz) */ |
| u8 pwr; /* Current voltage */ |
| |
| bool runtime_suspended; /* Host is runtime suspended */ |
| |
| struct mmc_request *mrq; /* Current request */ |
| struct mmc_command *cmd; /* Current command */ |
| struct mmc_data *data; /* Current data request */ |
| unsigned int data_early:1; /* Data finished before cmd */ |
| |
| struct sg_mapping_iter sg_miter; /* SG state for PIO */ |
| unsigned int blocks; /* remaining PIO blocks */ |
| |
| int sg_count; /* Mapped sg entries */ |
| |
| u8 *adma_desc; /* ADMA descriptor table */ |
| u8 *align_buffer; /* Bounce buffer */ |
| |
| unsigned int adma_desc_sz; /* ADMA descriptor table size */ |
| unsigned int align_buf_sz; /* Bounce buffer size */ |
| unsigned int adma_max_desc; /* Max ADMA descriptos (max sg segments) */ |
| |
| dma_addr_t adma_addr; /* Mapped ADMA descr. table */ |
| dma_addr_t align_addr; /* Mapped bounce buffer */ |
| |
| struct tasklet_struct card_tasklet; /* Tasklet structures */ |
| struct tasklet_struct finish_tasklet; |
| |
| struct timer_list timer; /* Timer for timeouts */ |
| |
| unsigned int caps; /* Alternative capabilities */ |
| |
| unsigned int ocr_avail_sdio; /* OCR bit masks */ |
| unsigned int ocr_avail_sd; |
| unsigned int ocr_avail_mmc; |
| |
| wait_queue_head_t buf_ready_int; /* Waitqueue for Buffer Read Ready interrupt */ |
| unsigned int tuning_done; /* Condition flag set when CMD19 succeeds */ |
| |
| unsigned int tuning_count; /* Timer count for re-tuning */ |
| unsigned int tuning_mode; /* Re-tuning mode supported by host */ |
| #define SDHCI_TUNING_MODE_1 0 |
| struct timer_list tuning_timer; /* Timer for tuning */ |
| |
| unsigned int cpu_dma_latency_us; |
| struct pm_qos_request pm_qos_req_dma; |
| unsigned int pm_qos_timeout_us; /* timeout for PM QoS request */ |
| struct device_attribute pm_qos_tout; |
| |
| struct sdhci_next next_data; |
| ktime_t data_start_time; |
| struct mutex ios_mutex; |
| enum sdhci_power_policy power_policy; |
| |
| unsigned long private[0] ____cacheline_aligned; |
| }; |
| #endif /* LINUX_MMC_SDHCI_H */ |