arch/arm/plat-omap/include/plat/mmc.h

   1 /*
   2  * MMC definitions for OMAP2
   3  *
   4  * Copyright (C) 2006 Nokia Corporation
   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 version 2 as
   8  * published by the Free Software Foundation.
   9  */
  10
  11 #ifndef __OMAP2_MMC_H
  12 #define __OMAP2_MMC_H
  13
  14 #include <linux/types.h>
  15 #include <linux/device.h>
  16 #include <linux/mmc/host.h>
  17
  18 #include <plat/board.h>
  19
  20 #define OMAP15XX_NR_MMC         1
  21 #define OMAP16XX_NR_MMC         2
  22 #define OMAP1_MMC_SIZE          0x080
  23 #define OMAP1_MMC1_BASE         0xfffb7800
  24 #define OMAP1_MMC2_BASE         0xfffb7c00      /* omap16xx only */
  25
  26 #define OMAP24XX_NR_MMC         2
  27 #define OMAP2420_MMC_SIZE       OMAP1_MMC_SIZE
  28 #define OMAP2_MMC1_BASE         0x4809c000
  29
  30 #define OMAP4_MMC_REG_OFFSET    0x100
  31
  32 #define OMAP_MMC_MAX_SLOTS      2
  33
  34 /*
  35  * struct omap_mmc_dev_attr.flags possibilities
  36  *
  37  * OMAP_HSMMC_SUPPORTS_DUAL_VOLT: Some HSMMC controller instances can
  38  *    operate with either 1.8Vdc or 3.0Vdc card voltages; this flag
  39  *    should be set if this is the case.  See for example Section 22.5.3
  40  *    "MMC/SD/SDIO1 Bus Voltage Selection" of the OMAP34xx Multimedia
  41  *    Device Silicon Revision 3.1.x Revision ZR (July 2011) (SWPU223R).
  42  *
  43  * OMAP_HSMMC_BROKEN_MULTIBLOCK_READ: Multiple-block read transfers
  44  *    don't work correctly on some MMC controller instances on some
  45  *    OMAP3 SoCs; this flag should be set if this is the case.  See
  46  *    for example Advisory 2.1.1.128 "MMC: Multiple Block Read
  47  *    Operation Issue" in _OMAP3530/3525/3515/3503 Silicon Errata_
  48  *    Revision F (October 2010) (SPRZ278F).
  49  */
  50 #define OMAP_HSMMC_SUPPORTS_DUAL_VOLT           BIT(0)
  51 #define OMAP_HSMMC_BROKEN_MULTIBLOCK_READ       BIT(1)
  52
  53 enum {
  54         MMC_CTRL_VERSION_1 = 0, /* OMAP class devicess */
  55         MMC_CTRL_VERSION_2      /* AM33XX class devices */
  56 };
  57
  58 struct omap_mmc_dev_attr {
  59         u8 flags;
  60 };
  61
  62 struct omap_mmc_platform_data {
  63         /* back-link to device */
  64         struct device *dev;
  65
  66         /* number of slots per controller */
  67         unsigned nr_slots:2;
  68
  69         /* set if your board has components or wiring that limits the
  70          * maximum frequency on the MMC bus */
  71         unsigned int max_freq;
  72
  73         /* switch the bus to a new slot */
  74         int (*switch_slot)(struct device *dev, int slot);
  75         /* initialize board-specific MMC functionality, can be NULL if
  76          * not supported */
  77         int (*init)(struct device *dev);
  78         void (*cleanup)(struct device *dev);
  79         void (*shutdown)(struct device *dev);
  80
  81         /* To handle board related suspend/resume functionality for MMC */
  82         int (*suspend)(struct device *dev, int slot);
  83         int (*resume)(struct device *dev, int slot);
  84
  85         /* Return context loss count due to PM states changing */
  86         int (*get_context_loss_count)(struct device *dev);
  87
  88         u64 dma_mask;
  89
  90         /* Integrating attributes from the omap_hwmod layer */
  91         u8 controller_flags;
  92
  93         /* Register offset deviation */
  94         u16 reg_offset;
  95
  96         struct omap_mmc_slot_data {
  97
  98                 /*
  99                  * 4/8 wires and any additional host capabilities
 100                  * need to OR'd all capabilities (ref. linux/mmc/host.h)
 101                  */
 102                 u8  wires;      /* Used for the MMC driver on omap1 and 2420 */
 103                 u32 caps;       /* Used for the MMC driver on 2430 and later */
 104                 u32 pm_caps;    /* PM capabilities of the mmc */
 105
 106                 /*
 107                  * nomux means "standard" muxing is wrong on this board, and
 108                  * that board-specific code handled it before common init logic.
 109                  */
 110                 unsigned nomux:1;
 111
 112                 /* switch pin can be for card detect (default) or card cover */
 113                 unsigned cover:1;
 114
 115                 /* use the internal clock */
 116                 unsigned internal_clock:1;
 117
 118                 /* nonremovable e.g. eMMC */
 119                 unsigned nonremovable:1;
 120
 121                 /* Try to sleep or power off when possible */
 122                 unsigned power_saving:1;
 123
 124                 /* If using power_saving and the MMC power is not to go off */
 125                 unsigned no_off:1;
 126
 127                 /* eMMC does not handle power off when not in sleep state */
 128                 unsigned no_regulator_off_init:1;
 129
 130                 /* Regulator off remapped to sleep */
 131                 unsigned vcc_aux_disable_is_sleep:1;
 132
 133                 /* we can put the features above into this variable */
 134 #define HSMMC_HAS_PBIAS         (1 << 0)
 135 #define HSMMC_HAS_UPDATED_RESET (1 << 1)
 136                 unsigned features;
 137
 138                 int switch_pin;                 /* gpio (card detect) */
 139                 int gpio_wp;                    /* gpio (write protect) */
 140
 141                 int (*set_bus_mode)(struct device *dev, int slot, int bus_mode);
 142                 int (*set_power)(struct device *dev, int slot,
 143                                  int power_on, int vdd);
 144                 int (*get_ro)(struct device *dev, int slot);
 145                 int (*set_sleep)(struct device *dev, int slot, int sleep,
 146                                  int vdd, int cardsleep);
 147                 void (*remux)(struct device *dev, int slot, int power_on);
 148                 /* Call back before enabling / disabling regulators */
 149                 void (*before_set_reg)(struct device *dev, int slot,
 150                                        int power_on, int vdd);
 151                 /* Call back after enabling / disabling regulators */
 152                 void (*after_set_reg)(struct device *dev, int slot,
 153                                       int power_on, int vdd);
 154                 /* if we have special card, init it using this callback */
 155                 void (*init_card)(struct mmc_card *card);
 156
 157                 /* return MMC cover switch state, can be NULL if not supported.
 158                  *
 159                  * possible return values:
 160                  *   0 - closed
 161                  *   1 - open
 162                  */
 163                 int (*get_cover_state)(struct device *dev, int slot);
 164
 165                 const char *name;
 166                 u32 ocr_mask;
 167
 168                 /* Card detection IRQs */
 169                 int card_detect_irq;
 170                 int (*card_detect)(struct device *dev, int slot);
 171
 172                 unsigned int ban_openended:1;
 173
 174         } slots[OMAP_MMC_MAX_SLOTS];
 175
 176         u8 version;
 177 };
 178
 179 /* called from board-specific card detection service routine */
 180 extern void omap_mmc_notify_cover_event(struct device *dev, int slot,
 181                                         int is_closed);
 182
 183 #if     defined(CONFIG_MMC_OMAP) || defined(CONFIG_MMC_OMAP_MODULE) || \
 184         defined(CONFIG_MMC_OMAP_HS) || defined(CONFIG_MMC_OMAP_HS_MODULE)
 185 void omap1_init_mmc(struct omap_mmc_platform_data **mmc_data,
 186                                 int nr_controllers);
 187 void omap242x_init_mmc(struct omap_mmc_platform_data **mmc_data);
 188 int omap_mmc_add(const char *name, int id, unsigned long base,
 189                                 unsigned long size, unsigned int irq,
 190                                 struct omap_mmc_platform_data *data);
 191 #else
 192 static inline void omap1_init_mmc(struct omap_mmc_platform_data **mmc_data,
 193                                 int nr_controllers)
 194 {
 195 }
 196 static inline void omap242x_init_mmc(struct omap_mmc_platform_data **mmc_data)
 197 {
 198 }
 199 static inline int omap_mmc_add(const char *name, int id, unsigned long base,
 200                                 unsigned long size, unsigned int irq,
 201                                 struct omap_mmc_platform_data *data)
 202 {
 203         return 0;
 204 }
 205
 206 #endif
 207 #endif