]>
git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blob - include/linux/mmc/dw_mmc.h
2 * Synopsys DesignWare Multimedia Card Interface driver
3 * (Based on NXP driver for lpc 31xx)
5 * Copyright (C) 2009 NXP Semiconductors
6 * Copyright (C) 2009, 2010 Imagination Technologies Ltd.
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.
14 #ifndef LINUX_MMC_DW_MMC_H
15 #define LINUX_MMC_DW_MMC_H
17 #include <linux/scatterlist.h>
18 #include <linux/mmc/core.h>
20 #define MAX_MCI_SLOTS 2
30 STATE_WAITING_CMD11_DONE
,
34 EVENT_CMD_COMPLETE
= 0,
44 * struct dw_mci - MMC controller state shared between all slots
45 * @lock: Spinlock protecting the queue and associated data.
46 * @regs: Pointer to MMIO registers.
47 * @sg: Scatterlist entry currently being processed by PIO code, if any.
48 * @sg_miter: PIO mapping scatterlist iterator.
49 * @cur_slot: The slot which is currently using the controller.
50 * @mrq: The request currently being processed on @cur_slot,
51 * or NULL if the controller is idle.
52 * @cmd: The command currently being sent to the card, or NULL.
53 * @data: The data currently being transferred, or NULL if no data
54 * transfer is in progress.
55 * @use_dma: Whether DMA channel is initialized or not.
56 * @using_dma: Whether DMA is in use for the current transfer.
57 * @dma_64bit_address: Whether DMA supports 64-bit address mode or not.
58 * @sg_dma: Bus address of DMA buffer.
59 * @sg_cpu: Virtual address of DMA buffer.
60 * @dma_ops: Pointer to platform-specific DMA callbacks.
61 * @cmd_status: Snapshot of SR taken upon completion of the current
62 * command. Only valid when EVENT_CMD_COMPLETE is pending.
63 * @data_status: Snapshot of SR taken upon completion of the current
64 * data transfer. Only valid when EVENT_DATA_COMPLETE or
65 * EVENT_DATA_ERROR is pending.
66 * @stop_cmdr: Value to be loaded into CMDR when the stop command is
68 * @dir_status: Direction of current transfer.
69 * @tasklet: Tasklet running the request state machine.
70 * @card_tasklet: Tasklet handling card detect.
71 * @pending_events: Bitmask of events flagged by the interrupt handler
72 * to be processed by the tasklet.
73 * @completed_events: Bitmask of events which the state machine has
75 * @state: Tasklet state.
76 * @queue: List of slots waiting for access to the controller.
77 * @bus_hz: The rate of @mck in Hz. This forms the basis for MMC bus
78 * rate and timeout calculations.
79 * @current_speed: Configured rate of the controller.
80 * @num_slots: Number of slots available.
81 * @verid: Denote Version ID.
82 * @data_offset: Set the offset of DATA register according to VERID.
83 * @dev: Device associated with the MMC controller.
84 * @pdata: Platform data associated with the MMC controller.
85 * @drv_data: Driver specific data for identified variant of the controller
86 * @priv: Implementation defined private data.
87 * @biu_clk: Pointer to bus interface unit clock instance.
88 * @ciu_clk: Pointer to card interface unit clock instance.
89 * @slot: Slots sharing this MMC controller.
90 * @fifo_depth: depth of FIFO.
91 * @data_shift: log2 of FIFO item size.
92 * @part_buf_start: Start index in part_buf.
93 * @part_buf_count: Bytes of partial data in part_buf.
94 * @part_buf: Simple buffer for partial fifo reads/writes.
95 * @push_data: Pointer to FIFO push function.
96 * @pull_data: Pointer to FIFO pull function.
97 * @quirks: Set of quirks that apply to specific versions of the IP.
98 * @irq_flags: The flags to be passed to request_irq.
99 * @irq: The irq value to be passed to request_irq.
100 * @sdio_id0: Number of slot0 in the SDIO interrupt registers.
105 * @lock is a softirq-safe spinlock protecting @queue as well as
106 * @cur_slot, @mrq and @state. These must always be updated
107 * at the same time while holding @lock.
109 * @irq_lock is an irq-safe spinlock protecting the INTMASK register
110 * to allow the interrupt handler to modify it directly. Held for only long
111 * enough to read-modify-write INTMASK and no other locks are grabbed when
114 * The @mrq field of struct dw_mci_slot is also protected by @lock,
115 * and must always be written at the same time as the slot is added to
118 * @pending_events and @completed_events are accessed using atomic bit
119 * operations, so they don't need any locking.
121 * None of the fields touched by the interrupt handler need any
122 * locking. However, ordering is important: Before EVENT_DATA_ERROR or
123 * EVENT_DATA_COMPLETE is set in @pending_events, all data-related
124 * interrupts must be disabled and @data_status updated with a
125 * snapshot of SR. Similarly, before EVENT_CMD_COMPLETE is set, the
126 * CMDRDY interrupt must be disabled and @cmd_status updated with a
127 * snapshot of SR, and before EVENT_XFER_COMPLETE can be set, the
128 * bytes_xfered field of @data must be written. This is ensured by
136 struct scatterlist
*sg
;
137 struct sg_mapping_iter sg_miter
;
139 struct dw_mci_slot
*cur_slot
;
140 struct mmc_request
*mrq
;
141 struct mmc_command
*cmd
;
142 struct mmc_data
*data
;
143 struct mmc_command stop_abort
;
144 unsigned int prev_blksz
;
145 unsigned char timing
;
147 /* DMA interface members*/
150 int dma_64bit_address
;
154 const struct dw_mci_dma_ops
*dma_ops
;
155 #ifdef CONFIG_MMC_DW_IDMAC
156 unsigned int ring_size
;
158 struct dw_mci_dma_data
*dma_data
;
164 struct tasklet_struct tasklet
;
165 unsigned long pending_events
;
166 unsigned long completed_events
;
167 enum dw_mci_state state
;
168 struct list_head queue
;
177 struct dw_mci_board
*pdata
;
178 const struct dw_mci_drv_data
*drv_data
;
182 struct dw_mci_slot
*slot
[MAX_MCI_SLOTS
];
184 /* FIFO push and pull */
194 void (*push_data
)(struct dw_mci
*host
, void *buf
, int cnt
);
195 void (*pull_data
)(struct dw_mci
*host
, void *buf
, int cnt
);
197 /* Workaround flags */
201 unsigned long irq_flags
; /* IRQ flags */
207 /* DMA ops for Internal/External DMAC interface */
208 struct dw_mci_dma_ops
{
210 int (*init
)(struct dw_mci
*host
);
211 void (*start
)(struct dw_mci
*host
, unsigned int sg_len
);
212 void (*complete
)(struct dw_mci
*host
);
213 void (*stop
)(struct dw_mci
*host
);
214 void (*cleanup
)(struct dw_mci
*host
);
215 void (*exit
)(struct dw_mci
*host
);
218 /* IP Quirks/flags. */
219 /* DTO fix for command transmission with IDMAC configured */
220 #define DW_MCI_QUIRK_IDMAC_DTO BIT(0)
221 /* delay needed between retries on some 2.11a implementations */
222 #define DW_MCI_QUIRK_RETRY_DELAY BIT(1)
223 /* High Speed Capable - Supports HS cards (up to 50MHz) */
224 #define DW_MCI_QUIRK_HIGHSPEED BIT(2)
225 /* Unreliable card detection */
226 #define DW_MCI_QUIRK_BROKEN_CARD_DETECTION BIT(3)
227 /* No write protect */
228 #define DW_MCI_QUIRK_NO_WRITE_PROTECT BIT(4)
230 /* Slot level quirks */
231 /* This slot has no write protect */
232 #define DW_MCI_SLOT_QUIRK_NO_WRITE_PROTECT BIT(0)
236 struct block_settings
{
237 unsigned short max_segs
; /* see blk_queue_max_segments */
238 unsigned int max_blk_size
; /* maximum size of one mmc block */
239 unsigned int max_blk_count
; /* maximum number of blocks in one req*/
240 unsigned int max_req_size
; /* maximum number of bytes in one req*/
241 unsigned int max_seg_size
; /* see blk_queue_max_segment_size */
244 /* Board platform data */
245 struct dw_mci_board
{
248 u32 quirks
; /* Workaround / Quirk flags */
249 unsigned int bus_hz
; /* Clock speed at the cclk_in pad */
251 u32 caps
; /* Capabilities */
252 u32 caps2
; /* More capabilities */
253 u32 pm_caps
; /* PM capabilities */
255 * Override fifo depth. If 0, autodetect it from the FIFOTH register,
256 * but note that this may not be reliable after a bootloader has used
259 unsigned int fifo_depth
;
261 /* delay in mS before detecting cards after interrupt */
264 struct dw_mci_dma_ops
*dma_ops
;
265 struct dma_pdata
*data
;
266 struct block_settings
*blk_settings
;
269 #endif /* LINUX_MMC_DW_MMC_H */