mmc: export eMMC4.4 enhanced area details to sysfs
[linux-2.6.git] / 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 #ifdef CONFIG_MMC_DW_IDMAC
125         unsigned int            ring_size;
126 #else
127         struct dw_mci_dma_data  *dma_data;
128 #endif
129         u32                     cmd_status;
130         u32                     data_status;
131         u32                     stop_cmdr;
132         u32                     dir_status;
133         struct tasklet_struct   tasklet;
134         struct tasklet_struct   card_tasklet;
135         unsigned long           pending_events;
136         unsigned long           completed_events;
137         enum dw_mci_state       state;
138         struct list_head        queue;
139
140         u32                     bus_hz;
141         u32                     current_speed;
142         u32                     num_slots;
143         struct platform_device  *pdev;
144         struct dw_mci_board     *pdata;
145         struct dw_mci_slot      *slot[MAX_MCI_SLOTS];
146
147         /* FIFO push and pull */
148         int                     data_shift;
149         void (*push_data)(struct dw_mci *host, void *buf, int cnt);
150         void (*pull_data)(struct dw_mci *host, void *buf, int cnt);
151
152         /* Workaround flags */
153         u32                     quirks;
154 };
155
156 /* DMA ops for Internal/External DMAC interface */
157 struct dw_mci_dma_ops {
158         /* DMA Ops */
159         int (*init)(struct dw_mci *host);
160         void (*start)(struct dw_mci *host, unsigned int sg_len);
161         void (*complete)(struct dw_mci *host);
162         void (*stop)(struct dw_mci *host);
163         void (*cleanup)(struct dw_mci *host);
164         void (*exit)(struct dw_mci *host);
165 };
166
167 /* IP Quirks/flags. */
168 /* No special quirks or flags to cater for */
169 #define DW_MCI_QUIRK_NONE               0
170 /* DTO fix for command transmission with IDMAC configured */
171 #define DW_MCI_QUIRK_IDMAC_DTO          1
172 /* delay needed between retries on some 2.11a implementations */
173 #define DW_MCI_QUIRK_RETRY_DELAY        2
174 /* High Speed Capable - Supports HS cards (upto 50MHz) */
175 #define DW_MCI_QUIRK_HIGHSPEED          4
176
177
178 struct dma_pdata;
179
180 struct block_settings {
181         unsigned short  max_segs;       /* see blk_queue_max_segments */
182         unsigned int    max_blk_size;   /* maximum size of one mmc block */
183         unsigned int    max_blk_count;  /* maximum number of blocks in one req*/
184         unsigned int    max_req_size;   /* maximum number of bytes in one req*/
185         unsigned int    max_seg_size;   /* see blk_queue_max_segment_size */
186 };
187
188 /* Board platform data */
189 struct dw_mci_board {
190         u32 num_slots;
191
192         u32 quirks; /* Workaround / Quirk flags */
193         unsigned int bus_hz; /* Bus speed */
194
195         /* delay in mS before detecting cards after interrupt */
196         u32 detect_delay_ms;
197
198         int (*init)(u32 slot_id, irq_handler_t , void *);
199         int (*get_ro)(u32 slot_id);
200         int (*get_cd)(u32 slot_id);
201         int (*get_ocr)(u32 slot_id);
202         int (*get_bus_wd)(u32 slot_id);
203         /*
204          * Enable power to selected slot and set voltage to desired level.
205          * Voltage levels are specified using MMC_VDD_xxx defines defined
206          * in linux/mmc/host.h file.
207          */
208         void (*setpower)(u32 slot_id, u32 volt);
209         void (*exit)(u32 slot_id);
210         void (*select_slot)(u32 slot_id);
211
212         struct dw_mci_dma_ops *dma_ops;
213         struct dma_pdata *data;
214         struct block_settings *blk_settings;
215 };
216
217 #endif /* _LINUX_MMC_DW_MMC_H_ */