11c6a0718SPierre Ossman /* 270f10482SPierre Ossman * linux/drivers/mmc/host/sdhci.h - Secure Digital Host Controller Interface driver 31c6a0718SPierre Ossman * 41978fda8SGiuseppe Cavallaro * Header file for Host Controller registers and I/O accessors. 51978fda8SGiuseppe Cavallaro * 6b69c9058SPierre Ossman * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved. 71c6a0718SPierre Ossman * 81c6a0718SPierre Ossman * This program is free software; you can redistribute it and/or modify 91c6a0718SPierre Ossman * it under the terms of the GNU General Public License as published by 101c6a0718SPierre Ossman * the Free Software Foundation; either version 2 of the License, or (at 111c6a0718SPierre Ossman * your option) any later version. 121c6a0718SPierre Ossman */ 131978fda8SGiuseppe Cavallaro #ifndef __SDHCI_HW_H 141978fda8SGiuseppe Cavallaro #define __SDHCI_HW_H 151c6a0718SPierre Ossman 160c7ad106SAndrew Morton #include <linux/scatterlist.h> 174e4141a5SAnton Vorontsov #include <linux/compiler.h> 184e4141a5SAnton Vorontsov #include <linux/types.h> 194e4141a5SAnton Vorontsov #include <linux/io.h> 200c7ad106SAndrew Morton 211978fda8SGiuseppe Cavallaro #include <linux/mmc/sdhci.h> 221978fda8SGiuseppe Cavallaro 231c6a0718SPierre Ossman /* 241c6a0718SPierre Ossman * Controller registers 251c6a0718SPierre Ossman */ 261c6a0718SPierre Ossman 271c6a0718SPierre Ossman #define SDHCI_DMA_ADDRESS 0x00 281c6a0718SPierre Ossman 291c6a0718SPierre Ossman #define SDHCI_BLOCK_SIZE 0x04 301c6a0718SPierre Ossman #define SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF)) 311c6a0718SPierre Ossman 321c6a0718SPierre Ossman #define SDHCI_BLOCK_COUNT 0x06 331c6a0718SPierre Ossman 341c6a0718SPierre Ossman #define SDHCI_ARGUMENT 0x08 351c6a0718SPierre Ossman 361c6a0718SPierre Ossman #define SDHCI_TRANSFER_MODE 0x0C 371c6a0718SPierre Ossman #define SDHCI_TRNS_DMA 0x01 381c6a0718SPierre Ossman #define SDHCI_TRNS_BLK_CNT_EN 0x02 391c6a0718SPierre Ossman #define SDHCI_TRNS_ACMD12 0x04 401c6a0718SPierre Ossman #define SDHCI_TRNS_READ 0x10 411c6a0718SPierre Ossman #define SDHCI_TRNS_MULTI 0x20 421c6a0718SPierre Ossman 431c6a0718SPierre Ossman #define SDHCI_COMMAND 0x0E 441c6a0718SPierre Ossman #define SDHCI_CMD_RESP_MASK 0x03 451c6a0718SPierre Ossman #define SDHCI_CMD_CRC 0x08 461c6a0718SPierre Ossman #define SDHCI_CMD_INDEX 0x10 471c6a0718SPierre Ossman #define SDHCI_CMD_DATA 0x20 481c6a0718SPierre Ossman 491c6a0718SPierre Ossman #define SDHCI_CMD_RESP_NONE 0x00 501c6a0718SPierre Ossman #define SDHCI_CMD_RESP_LONG 0x01 511c6a0718SPierre Ossman #define SDHCI_CMD_RESP_SHORT 0x02 521c6a0718SPierre Ossman #define SDHCI_CMD_RESP_SHORT_BUSY 0x03 531c6a0718SPierre Ossman 541c6a0718SPierre Ossman #define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff)) 551c6a0718SPierre Ossman 561c6a0718SPierre Ossman #define SDHCI_RESPONSE 0x10 571c6a0718SPierre Ossman 581c6a0718SPierre Ossman #define SDHCI_BUFFER 0x20 591c6a0718SPierre Ossman 601c6a0718SPierre Ossman #define SDHCI_PRESENT_STATE 0x24 611c6a0718SPierre Ossman #define SDHCI_CMD_INHIBIT 0x00000001 621c6a0718SPierre Ossman #define SDHCI_DATA_INHIBIT 0x00000002 631c6a0718SPierre Ossman #define SDHCI_DOING_WRITE 0x00000100 641c6a0718SPierre Ossman #define SDHCI_DOING_READ 0x00000200 651c6a0718SPierre Ossman #define SDHCI_SPACE_AVAILABLE 0x00000400 661c6a0718SPierre Ossman #define SDHCI_DATA_AVAILABLE 0x00000800 671c6a0718SPierre Ossman #define SDHCI_CARD_PRESENT 0x00010000 681c6a0718SPierre Ossman #define SDHCI_WRITE_PROTECT 0x00080000 691c6a0718SPierre Ossman 701c6a0718SPierre Ossman #define SDHCI_HOST_CONTROL 0x28 711c6a0718SPierre Ossman #define SDHCI_CTRL_LED 0x01 721c6a0718SPierre Ossman #define SDHCI_CTRL_4BITBUS 0x02 731c6a0718SPierre Ossman #define SDHCI_CTRL_HISPD 0x04 742134a922SPierre Ossman #define SDHCI_CTRL_DMA_MASK 0x18 752134a922SPierre Ossman #define SDHCI_CTRL_SDMA 0x00 762134a922SPierre Ossman #define SDHCI_CTRL_ADMA1 0x08 772134a922SPierre Ossman #define SDHCI_CTRL_ADMA32 0x10 782134a922SPierre Ossman #define SDHCI_CTRL_ADMA64 0x18 79ae6d6c92SKyungmin Park #define SDHCI_CTRL_8BITBUS 0x20 801c6a0718SPierre Ossman 811c6a0718SPierre Ossman #define SDHCI_POWER_CONTROL 0x29 821c6a0718SPierre Ossman #define SDHCI_POWER_ON 0x01 831c6a0718SPierre Ossman #define SDHCI_POWER_180 0x0A 841c6a0718SPierre Ossman #define SDHCI_POWER_300 0x0C 851c6a0718SPierre Ossman #define SDHCI_POWER_330 0x0E 861c6a0718SPierre Ossman 871c6a0718SPierre Ossman #define SDHCI_BLOCK_GAP_CONTROL 0x2A 881c6a0718SPierre Ossman 892df3b71bSNicolas Pitre #define SDHCI_WAKE_UP_CONTROL 0x2B 901c6a0718SPierre Ossman 911c6a0718SPierre Ossman #define SDHCI_CLOCK_CONTROL 0x2C 921c6a0718SPierre Ossman #define SDHCI_DIVIDER_SHIFT 8 9385105c53SZhangfei Gao #define SDHCI_DIVIDER_HI_SHIFT 6 9485105c53SZhangfei Gao #define SDHCI_DIV_MASK 0xFF 9585105c53SZhangfei Gao #define SDHCI_DIV_MASK_LEN 8 9685105c53SZhangfei Gao #define SDHCI_DIV_HI_MASK 0x300 971c6a0718SPierre Ossman #define SDHCI_CLOCK_CARD_EN 0x0004 981c6a0718SPierre Ossman #define SDHCI_CLOCK_INT_STABLE 0x0002 991c6a0718SPierre Ossman #define SDHCI_CLOCK_INT_EN 0x0001 1001c6a0718SPierre Ossman 1011c6a0718SPierre Ossman #define SDHCI_TIMEOUT_CONTROL 0x2E 1021c6a0718SPierre Ossman 1031c6a0718SPierre Ossman #define SDHCI_SOFTWARE_RESET 0x2F 1041c6a0718SPierre Ossman #define SDHCI_RESET_ALL 0x01 1051c6a0718SPierre Ossman #define SDHCI_RESET_CMD 0x02 1061c6a0718SPierre Ossman #define SDHCI_RESET_DATA 0x04 1071c6a0718SPierre Ossman 1081c6a0718SPierre Ossman #define SDHCI_INT_STATUS 0x30 1091c6a0718SPierre Ossman #define SDHCI_INT_ENABLE 0x34 1101c6a0718SPierre Ossman #define SDHCI_SIGNAL_ENABLE 0x38 1111c6a0718SPierre Ossman #define SDHCI_INT_RESPONSE 0x00000001 1121c6a0718SPierre Ossman #define SDHCI_INT_DATA_END 0x00000002 1131c6a0718SPierre Ossman #define SDHCI_INT_DMA_END 0x00000008 1141c6a0718SPierre Ossman #define SDHCI_INT_SPACE_AVAIL 0x00000010 1151c6a0718SPierre Ossman #define SDHCI_INT_DATA_AVAIL 0x00000020 1161c6a0718SPierre Ossman #define SDHCI_INT_CARD_INSERT 0x00000040 1171c6a0718SPierre Ossman #define SDHCI_INT_CARD_REMOVE 0x00000080 1181c6a0718SPierre Ossman #define SDHCI_INT_CARD_INT 0x00000100 119964f9ce2SPierre Ossman #define SDHCI_INT_ERROR 0x00008000 1201c6a0718SPierre Ossman #define SDHCI_INT_TIMEOUT 0x00010000 1211c6a0718SPierre Ossman #define SDHCI_INT_CRC 0x00020000 1221c6a0718SPierre Ossman #define SDHCI_INT_END_BIT 0x00040000 1231c6a0718SPierre Ossman #define SDHCI_INT_INDEX 0x00080000 1241c6a0718SPierre Ossman #define SDHCI_INT_DATA_TIMEOUT 0x00100000 1251c6a0718SPierre Ossman #define SDHCI_INT_DATA_CRC 0x00200000 1261c6a0718SPierre Ossman #define SDHCI_INT_DATA_END_BIT 0x00400000 1271c6a0718SPierre Ossman #define SDHCI_INT_BUS_POWER 0x00800000 1281c6a0718SPierre Ossman #define SDHCI_INT_ACMD12ERR 0x01000000 1292134a922SPierre Ossman #define SDHCI_INT_ADMA_ERROR 0x02000000 1301c6a0718SPierre Ossman 1311c6a0718SPierre Ossman #define SDHCI_INT_NORMAL_MASK 0x00007FFF 1321c6a0718SPierre Ossman #define SDHCI_INT_ERROR_MASK 0xFFFF8000 1331c6a0718SPierre Ossman 1341c6a0718SPierre Ossman #define SDHCI_INT_CMD_MASK (SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \ 1351c6a0718SPierre Ossman SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX) 1361c6a0718SPierre Ossman #define SDHCI_INT_DATA_MASK (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \ 1371c6a0718SPierre Ossman SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \ 1381c6a0718SPierre Ossman SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \ 139a751a7d6SZhangfei Gao SDHCI_INT_DATA_END_BIT | SDHCI_INT_ADMA_ERROR) 1407260cf5eSAnton Vorontsov #define SDHCI_INT_ALL_MASK ((unsigned int)-1) 1411c6a0718SPierre Ossman 1421c6a0718SPierre Ossman #define SDHCI_ACMD12_ERR 0x3C 1431c6a0718SPierre Ossman 1441c6a0718SPierre Ossman /* 3E-3F reserved */ 1451c6a0718SPierre Ossman 1461c6a0718SPierre Ossman #define SDHCI_CAPABILITIES 0x40 1471c6a0718SPierre Ossman #define SDHCI_TIMEOUT_CLK_MASK 0x0000003F 1481c6a0718SPierre Ossman #define SDHCI_TIMEOUT_CLK_SHIFT 0 1491c6a0718SPierre Ossman #define SDHCI_TIMEOUT_CLK_UNIT 0x00000080 1501c6a0718SPierre Ossman #define SDHCI_CLOCK_BASE_MASK 0x00003F00 151c4687d5fSZhangfei Gao #define SDHCI_CLOCK_V3_BASE_MASK 0x0000FF00 1521c6a0718SPierre Ossman #define SDHCI_CLOCK_BASE_SHIFT 8 1531c6a0718SPierre Ossman #define SDHCI_MAX_BLOCK_MASK 0x00030000 1541c6a0718SPierre Ossman #define SDHCI_MAX_BLOCK_SHIFT 16 1552134a922SPierre Ossman #define SDHCI_CAN_DO_ADMA2 0x00080000 1562134a922SPierre Ossman #define SDHCI_CAN_DO_ADMA1 0x00100000 1571c6a0718SPierre Ossman #define SDHCI_CAN_DO_HISPD 0x00200000 158a13abc7bSRichard Röjfors #define SDHCI_CAN_DO_SDMA 0x00400000 1591c6a0718SPierre Ossman #define SDHCI_CAN_VDD_330 0x01000000 1601c6a0718SPierre Ossman #define SDHCI_CAN_VDD_300 0x02000000 1611c6a0718SPierre Ossman #define SDHCI_CAN_VDD_180 0x04000000 1622134a922SPierre Ossman #define SDHCI_CAN_64BIT 0x10000000 1631c6a0718SPierre Ossman 1641c6a0718SPierre Ossman /* 44-47 reserved for more caps */ 1651c6a0718SPierre Ossman 1661c6a0718SPierre Ossman #define SDHCI_MAX_CURRENT 0x48 1671c6a0718SPierre Ossman 1681c6a0718SPierre Ossman /* 4C-4F reserved for more max current */ 1691c6a0718SPierre Ossman 1702134a922SPierre Ossman #define SDHCI_SET_ACMD12_ERROR 0x50 1712134a922SPierre Ossman #define SDHCI_SET_INT_ERROR 0x52 1722134a922SPierre Ossman 1732134a922SPierre Ossman #define SDHCI_ADMA_ERROR 0x54 1742134a922SPierre Ossman 1752134a922SPierre Ossman /* 55-57 reserved */ 1762134a922SPierre Ossman 1772134a922SPierre Ossman #define SDHCI_ADMA_ADDRESS 0x58 1782134a922SPierre Ossman 1792134a922SPierre Ossman /* 60-FB reserved */ 1801c6a0718SPierre Ossman 1811c6a0718SPierre Ossman #define SDHCI_SLOT_INT_STATUS 0xFC 1821c6a0718SPierre Ossman 1831c6a0718SPierre Ossman #define SDHCI_HOST_VERSION 0xFE 1841c6a0718SPierre Ossman #define SDHCI_VENDOR_VER_MASK 0xFF00 1851c6a0718SPierre Ossman #define SDHCI_VENDOR_VER_SHIFT 8 1861c6a0718SPierre Ossman #define SDHCI_SPEC_VER_MASK 0x00FF 1871c6a0718SPierre Ossman #define SDHCI_SPEC_VER_SHIFT 0 1882134a922SPierre Ossman #define SDHCI_SPEC_100 0 1892134a922SPierre Ossman #define SDHCI_SPEC_200 1 19085105c53SZhangfei Gao #define SDHCI_SPEC_300 2 1911c6a0718SPierre Ossman 1920397526dSZhangfei Gao /* 1930397526dSZhangfei Gao * End of controller registers. 1940397526dSZhangfei Gao */ 1950397526dSZhangfei Gao 1960397526dSZhangfei Gao #define SDHCI_MAX_DIV_SPEC_200 256 1970397526dSZhangfei Gao #define SDHCI_MAX_DIV_SPEC_300 2046 1980397526dSZhangfei Gao 199b8c86fc5SPierre Ossman struct sdhci_ops { 2004e4141a5SAnton Vorontsov #ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS 201dc297c92SMatt Fleming u32 (*read_l)(struct sdhci_host *host, int reg); 202dc297c92SMatt Fleming u16 (*read_w)(struct sdhci_host *host, int reg); 203dc297c92SMatt Fleming u8 (*read_b)(struct sdhci_host *host, int reg); 204dc297c92SMatt Fleming void (*write_l)(struct sdhci_host *host, u32 val, int reg); 205dc297c92SMatt Fleming void (*write_w)(struct sdhci_host *host, u16 val, int reg); 206dc297c92SMatt Fleming void (*write_b)(struct sdhci_host *host, u8 val, int reg); 2074e4141a5SAnton Vorontsov #endif 2084e4141a5SAnton Vorontsov 2098114634cSAnton Vorontsov void (*set_clock)(struct sdhci_host *host, unsigned int clock); 2108114634cSAnton Vorontsov 211b8c86fc5SPierre Ossman int (*enable_dma)(struct sdhci_host *host); 2124240ff0aSBen Dooks unsigned int (*get_max_clock)(struct sdhci_host *host); 213a9e58f25SAnton Vorontsov unsigned int (*get_min_clock)(struct sdhci_host *host); 2144240ff0aSBen Dooks unsigned int (*get_timeout_clock)(struct sdhci_host *host); 215643a81ffSPhilip Rakity void (*platform_send_init_74_clocks)(struct sdhci_host *host, 216643a81ffSPhilip Rakity u8 power_mode); 2171c6a0718SPierre Ossman }; 218b8c86fc5SPierre Ossman 2194e4141a5SAnton Vorontsov #ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS 2204e4141a5SAnton Vorontsov 2214e4141a5SAnton Vorontsov static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg) 2224e4141a5SAnton Vorontsov { 223dc297c92SMatt Fleming if (unlikely(host->ops->write_l)) 224dc297c92SMatt Fleming host->ops->write_l(host, val, reg); 2254e4141a5SAnton Vorontsov else 2264e4141a5SAnton Vorontsov writel(val, host->ioaddr + reg); 2274e4141a5SAnton Vorontsov } 2284e4141a5SAnton Vorontsov 2294e4141a5SAnton Vorontsov static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg) 2304e4141a5SAnton Vorontsov { 231dc297c92SMatt Fleming if (unlikely(host->ops->write_w)) 232dc297c92SMatt Fleming host->ops->write_w(host, val, reg); 2334e4141a5SAnton Vorontsov else 2344e4141a5SAnton Vorontsov writew(val, host->ioaddr + reg); 2354e4141a5SAnton Vorontsov } 2364e4141a5SAnton Vorontsov 2374e4141a5SAnton Vorontsov static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg) 2384e4141a5SAnton Vorontsov { 239dc297c92SMatt Fleming if (unlikely(host->ops->write_b)) 240dc297c92SMatt Fleming host->ops->write_b(host, val, reg); 2414e4141a5SAnton Vorontsov else 2424e4141a5SAnton Vorontsov writeb(val, host->ioaddr + reg); 2434e4141a5SAnton Vorontsov } 2444e4141a5SAnton Vorontsov 2454e4141a5SAnton Vorontsov static inline u32 sdhci_readl(struct sdhci_host *host, int reg) 2464e4141a5SAnton Vorontsov { 247dc297c92SMatt Fleming if (unlikely(host->ops->read_l)) 248dc297c92SMatt Fleming return host->ops->read_l(host, reg); 2494e4141a5SAnton Vorontsov else 2504e4141a5SAnton Vorontsov return readl(host->ioaddr + reg); 2514e4141a5SAnton Vorontsov } 2524e4141a5SAnton Vorontsov 2534e4141a5SAnton Vorontsov static inline u16 sdhci_readw(struct sdhci_host *host, int reg) 2544e4141a5SAnton Vorontsov { 255dc297c92SMatt Fleming if (unlikely(host->ops->read_w)) 256dc297c92SMatt Fleming return host->ops->read_w(host, reg); 2574e4141a5SAnton Vorontsov else 2584e4141a5SAnton Vorontsov return readw(host->ioaddr + reg); 2594e4141a5SAnton Vorontsov } 2604e4141a5SAnton Vorontsov 2614e4141a5SAnton Vorontsov static inline u8 sdhci_readb(struct sdhci_host *host, int reg) 2624e4141a5SAnton Vorontsov { 263dc297c92SMatt Fleming if (unlikely(host->ops->read_b)) 264dc297c92SMatt Fleming return host->ops->read_b(host, reg); 2654e4141a5SAnton Vorontsov else 2664e4141a5SAnton Vorontsov return readb(host->ioaddr + reg); 2674e4141a5SAnton Vorontsov } 2684e4141a5SAnton Vorontsov 2694e4141a5SAnton Vorontsov #else 2704e4141a5SAnton Vorontsov 2714e4141a5SAnton Vorontsov static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg) 2724e4141a5SAnton Vorontsov { 2734e4141a5SAnton Vorontsov writel(val, host->ioaddr + reg); 2744e4141a5SAnton Vorontsov } 2754e4141a5SAnton Vorontsov 2764e4141a5SAnton Vorontsov static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg) 2774e4141a5SAnton Vorontsov { 2784e4141a5SAnton Vorontsov writew(val, host->ioaddr + reg); 2794e4141a5SAnton Vorontsov } 2804e4141a5SAnton Vorontsov 2814e4141a5SAnton Vorontsov static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg) 2824e4141a5SAnton Vorontsov { 2834e4141a5SAnton Vorontsov writeb(val, host->ioaddr + reg); 2844e4141a5SAnton Vorontsov } 2854e4141a5SAnton Vorontsov 2864e4141a5SAnton Vorontsov static inline u32 sdhci_readl(struct sdhci_host *host, int reg) 2874e4141a5SAnton Vorontsov { 2884e4141a5SAnton Vorontsov return readl(host->ioaddr + reg); 2894e4141a5SAnton Vorontsov } 2904e4141a5SAnton Vorontsov 2914e4141a5SAnton Vorontsov static inline u16 sdhci_readw(struct sdhci_host *host, int reg) 2924e4141a5SAnton Vorontsov { 2934e4141a5SAnton Vorontsov return readw(host->ioaddr + reg); 2944e4141a5SAnton Vorontsov } 2954e4141a5SAnton Vorontsov 2964e4141a5SAnton Vorontsov static inline u8 sdhci_readb(struct sdhci_host *host, int reg) 2974e4141a5SAnton Vorontsov { 2984e4141a5SAnton Vorontsov return readb(host->ioaddr + reg); 2994e4141a5SAnton Vorontsov } 3004e4141a5SAnton Vorontsov 3014e4141a5SAnton Vorontsov #endif /* CONFIG_MMC_SDHCI_IO_ACCESSORS */ 302b8c86fc5SPierre Ossman 303b8c86fc5SPierre Ossman extern struct sdhci_host *sdhci_alloc_host(struct device *dev, 304b8c86fc5SPierre Ossman size_t priv_size); 305b8c86fc5SPierre Ossman extern void sdhci_free_host(struct sdhci_host *host); 306b8c86fc5SPierre Ossman 307b8c86fc5SPierre Ossman static inline void *sdhci_priv(struct sdhci_host *host) 308b8c86fc5SPierre Ossman { 309b8c86fc5SPierre Ossman return (void *)host->private; 310b8c86fc5SPierre Ossman } 311b8c86fc5SPierre Ossman 31217866e14SMarek Szyprowski extern void sdhci_card_detect(struct sdhci_host *host); 313b8c86fc5SPierre Ossman extern int sdhci_add_host(struct sdhci_host *host); 3141e72859eSPierre Ossman extern void sdhci_remove_host(struct sdhci_host *host, int dead); 315b8c86fc5SPierre Ossman 316b8c86fc5SPierre Ossman #ifdef CONFIG_PM 317b8c86fc5SPierre Ossman extern int sdhci_suspend_host(struct sdhci_host *host, pm_message_t state); 318b8c86fc5SPierre Ossman extern int sdhci_resume_host(struct sdhci_host *host); 319b8c86fc5SPierre Ossman #endif 320c0bba0d2SAlbert Herranz 3211978fda8SGiuseppe Cavallaro #endif /* __SDHCI_HW_H */ 322