include/linux/mmc/dw_mmc.h

   1 /*
   2  * Synopsys DesignWare Multimedia Card Interface driver
   3  *  (Based on NXP driver for lpc 31xx)
   4  *
   5  * Copyright (C) 2009 NXP Semiconductors
   6  * Copyright (C) 2009, 2010 Imagination Technologies Ltd.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  */
  13
  14 #ifndef _LINUX_MMC_DW_MMC_H_
  15 #define _LINUX_MMC_DW_MMC_H_
  16
  17 #define MAX_MCI_SLOTS   2
  18
  19 enum dw_mci_state {
  20         STATE_IDLE = 0,
  21         STATE_SENDING_CMD,
  22         STATE_SENDING_DATA,
  23         STATE_DATA_BUSY,
  24         STATE_SENDING_STOP,
  25         STATE_DATA_ERROR,
  26 };
  27
  28 enum {
  29         EVENT_CMD_COMPLETE = 0,
  30         EVENT_XFER_COMPLETE,
  31         EVENT_DATA_COMPLETE,
  32         EVENT_DATA_ERROR,
  33         EVENT_XFER_ERROR
  34 };
  35
  36 struct mmc_data;
  37
  38 /**
  39  * struct dw_mci - MMC controller state shared between all slots
  40  * @lock: Spinlock protecting the queue and associated data.
  41  * @regs: Pointer to MMIO registers.
  42  * @sg: Scatterlist entry currently being processed by PIO code, if any.
  43  * @pio_offset: Offset into the current scatterlist entry.
  44  * @cur_slot: The slot which is currently using the controller.
  45  * @mrq: The request currently being processed on @cur_slot,
  46  *      or NULL if the controller is idle.
  47  * @cmd: The command currently being sent to the card, or NULL.
  48  * @data: The data currently being transferred, or NULL if no data
  49  *      transfer is in progress.
  50  * @use_dma: Whether DMA channel is initialized or not.
  51  * @sg_dma: Bus address of DMA buffer.
  52  * @sg_cpu: Virtual address of DMA buffer.
  53  * @dma_ops: Pointer to platform-specific DMA callbacks.
  54  * @cmd_status: Snapshot of SR taken upon completion of the current
  55  *      command. Only valid when EVENT_CMD_COMPLETE is pending.
  56  * @data_status: Snapshot of SR taken upon completion of the current
  57  *      data transfer. Only valid when EVENT_DATA_COMPLETE or
  58  *      EVENT_DATA_ERROR is pending.
  59  * @stop_cmdr: Value to be loaded into CMDR when the stop command is
  60  *      to be sent.
  61  * @dir_status: Direction of current transfer.
  62  * @tasklet: Tasklet running the request state machine.
  63  * @card_tasklet: Tasklet handling card detect.
  64  * @pending_events: Bitmask of events flagged by the interrupt handler
  65  *      to be processed by the tasklet.
  66  * @completed_events: Bitmask of events which the state machine has
  67  *      processed.
  68  * @state: Tasklet state.
  69  * @queue: List of slots waiting for access to the controller.
  70  * @bus_hz: The rate of @mck in Hz. This forms the basis for MMC bus
  71  *      rate and timeout calculations.
  72  * @current_speed: Configured rate of the controller.
  73  * @num_slots: Number of slots available.
  74  * @pdev: Platform device associated with the MMC controller.
  75  * @pdata: Platform data associated with the MMC controller.
  76  * @slot: Slots sharing this MMC controller.
  77  * @data_shift: log2 of FIFO item size.
  78  * @push_data: Pointer to FIFO push function.
  79  * @pull_data: Pointer to FIFO pull function.
  80  * @quirks: Set of quirks that apply to specific versions of the IP.
  81  *
  82  * Locking
  83  * =======
  84  *
  85  * @lock is a softirq-safe spinlock protecting @queue as well as
  86  * @cur_slot, @mrq and @state. These must always be updated
  87  * at the same time while holding @lock.
  88  *
  89  * The @mrq field of struct dw_mci_slot is also protected by @lock,
  90  * and must always be written at the same time as the slot is added to
  91  * @queue.
  92  *
  93  * @pending_events and @completed_events are accessed using atomic bit
  94  * operations, so they don't need any locking.
  95  *
  96  * None of the fields touched by the interrupt handler need any
  97  * locking. However, ordering is important: Before EVENT_DATA_ERROR or
  98  * EVENT_DATA_COMPLETE is set in @pending_events, all data-related
  99  * interrupts must be disabled and @data_status updated with a
 100  * snapshot of SR. Similarly, before EVENT_CMD_COMPLETE is set, the
 101  * CMDRDY interupt must be disabled and @cmd_status updated with a
 102  * snapshot of SR, and before EVENT_XFER_COMPLETE can be set, the
 103  * bytes_xfered field of @data must be written. This is ensured by
 104  * using barriers.
 105  */
 106 struct dw_mci {
 107         spinlock_t              lock;
 108         void __iomem            *regs;
 109
 110         struct scatterlist      *sg;
 111         unsigned int            pio_offset;
 112
 113         struct dw_mci_slot      *cur_slot;
 114         struct mmc_request      *mrq;
 115         struct mmc_command      *cmd;
 116         struct mmc_data         *data;
 117
 118         /* DMA interface members*/
 119         int                     use_dma;
 120
 121         dma_addr_t              sg_dma;
 122         void                    *sg_cpu;
 123         struct dw_mci_dma_ops   *dma_ops;
 124         unsigned int            page_size;
 125 #ifdef CONFIG_MMC_DW_IDMAC
 126         unsigned int            ring_size;
 127 #else
 128         struct dw_mci_dma_data  *dma_data;
 129 #endif
 130         u32                     cmd_status;
 131         u32                     data_status;
 132         u32                     stop_cmdr;
 133         u32                     dir_status;
 134         struct tasklet_struct   tasklet;
 135         struct tasklet_struct   card_tasklet;
 136         unsigned long           pending_events;
 137         unsigned long           completed_events;
 138         enum dw_mci_state       state;
 139         struct list_head        queue;
 140
 141         u32                     bus_hz;
 142         u32                     current_speed;
 143         u32                     num_slots;
 144         u32                     fifoth_value;
 145         struct platform_device  *pdev;
 146         struct dw_mci_board     *pdata;
 147         struct dw_mci_slot      *slot[MAX_MCI_SLOTS];
 148
 149         /* FIFO push and pull */
 150         int                     data_shift;
 151         void (*push_data)(struct dw_mci *host, void *buf, int cnt);
 152         void (*pull_data)(struct dw_mci *host, void *buf, int cnt);
 153
 154         /* Workaround flags */
 155         u32                     quirks;
 156
 157         struct regulator        *vmmc;          /* Power regulator */
 158         struct clk              *clk;
 159         atomic_t                clk_cnt;
 160         struct timer_list       clk_timer;              /* Timer for timeouts */
 161 };
 162
 163 /* DMA ops for Internal/External DMAC interface */
 164 struct dw_mci_dma_ops {
 165         /* DMA Ops */
 166         int (*init)(struct dw_mci *host);
 167         void (*start)(struct dw_mci *host, unsigned int sg_len);
 168         void (*complete)(struct dw_mci *host);
 169         void (*stop)(struct dw_mci *host);
 170         void (*cleanup)(struct dw_mci *host);
 171         void (*exit)(struct dw_mci *host);
 172 };
 173
 174 /* IP Quirks/flags. */
 175 /* DTO fix for command transmission with IDMAC configured */
 176 #define DW_MCI_QUIRK_IDMAC_DTO                  BIT(0)
 177 /* delay needed between retries on some 2.11a implementations */
 178 #define DW_MCI_QUIRK_RETRY_DELAY                BIT(1)
 179 /* High Speed Capable - Supports HS cards (upto 50MHz) */
 180 #define DW_MCI_QUIRK_HIGHSPEED                  BIT(2)
 181 /* Unreliable card detection */
 182 #define DW_MCI_QUIRK_BROKEN_CARD_DETECTION      BIT(3)
 183 /* Not used weird length */
 184 #define DW_MCI_QUIRK_NOT_USED_WEIRD_LENGTH      BIT(4)
 185 /* Use Auto_Send_STOP command */
 186 #define DW_MCI_QUIRK_AUTO_SEND_STOP             BIT(5)
 187 /* Support clock-gating */
 188 #define DW_MCI_QUIRK_CLK_GATING                 BIT(6)
 189
 190 struct dma_pdata;
 191
 192 struct block_settings {
 193         unsigned short  max_hw_segs;    /* see blk_queue_max_segments */
 194         unsigned short  max_phys_segs;  /* see blk_queue_max_phys_segments */
 195         unsigned int    max_blk_size;   /* maximum size of one mmc block */
 196         unsigned int    max_blk_count;  /* maximum number of blocks in one req*/
 197         unsigned int    max_req_size;   /* maximum number of bytes in one req*/
 198         unsigned int    max_seg_size;   /* see blk_queue_max_segment_size */
 199 };
 200
 201 /* Board platform data */
 202 struct dw_mci_board {
 203         u32 num_slots;
 204
 205         u32 quirks; /* Workaround / Quirk flags */
 206         unsigned int bus_hz; /* Bus speed */
 207
 208         unsigned int caps;
 209         unsigned int page_size;
 210
 211         /* delay in mS before detecting cards after interrupt */
 212         u32 detect_delay_ms;
 213
 214         int (*init)(u32 slot_id, irq_handler_t , void *);
 215         int (*get_ro)(u32 slot_id);
 216         int (*get_cd)(u32 slot_id);
 217         int (*get_ocr)(u32 slot_id);
 218         int (*get_bus_wd)(u32 slot_id);
 219         /*
 220          * Enable power to selected slot and set voltage to desired level.
 221          * Voltage levels are specified using MMC_VDD_xxx defines defined
 222          * in linux/mmc/host.h file.
 223          */
 224         void (*setpower)(u32 slot_id, u32 volt);
 225         void (*exit)(u32 slot_id);
 226         void (*select_slot)(u32 slot_id);
 227
 228         void (*set_clock)(struct dw_mci *host, unsigned int clock);
 229
 230         struct dw_mci_dma_ops *dma_ops;
 231         struct dma_pdata *data;
 232         struct block_settings *blk_settings;
 233 };
 234
 235 #endif /* _LINUX_MMC_DW_MMC_H_ */