ARM: PL08x: avoid 'void *' struct fields when we can type them properly
[linux-2.6-microblaze.git] / include / linux / amba / pl08x.h
1 /*
2  * linux/amba/pl08x.h - ARM PrimeCell DMA Controller driver
3  *
4  * Copyright (C) 2005 ARM Ltd
5  * Copyright (C) 2010 ST-Ericsson SA
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  *
11  * pl08x information required by platform code
12  *
13  * Please credit ARM.com
14  * Documentation: ARM DDI 0196D
15  *
16  */
17
18 #ifndef AMBA_PL08X_H
19 #define AMBA_PL08X_H
20
21 /* We need sizes of structs from this header */
22 #include <linux/dmaengine.h>
23 #include <linux/interrupt.h>
24
25 struct pl08x_lli;
26 struct pl08x_driver_data;
27
28 /**
29  * struct pl08x_channel_data - data structure to pass info between
30  * platform and PL08x driver regarding channel configuration
31  * @bus_id: name of this device channel, not just a device name since
32  * devices may have more than one channel e.g. "foo_tx"
33  * @min_signal: the minimum DMA signal number to be muxed in for this
34  * channel (for platforms supporting muxed signals). If you have
35  * static assignments, make sure this is set to the assigned signal
36  * number, PL08x have 16 possible signals in number 0 thru 15 so
37  * when these are not enough they often get muxed (in hardware)
38  * disabling simultaneous use of the same channel for two devices.
39  * @max_signal: the maximum DMA signal number to be muxed in for
40  * the channel. Set to the same as min_signal for
41  * devices with static assignments
42  * @muxval: a number usually used to poke into some mux regiser to
43  * mux in the signal to this channel
44  * @cctl_opt: default options for the channel control register
45  * @addr: source/target address in physical memory for this DMA channel,
46  * can be the address of a FIFO register for burst requests for example.
47  * This can be left undefined if the PrimeCell API is used for configuring
48  * this.
49  * @circular_buffer: whether the buffer passed in is circular and
50  * shall simply be looped round round (like a record baby round
51  * round round round)
52  * @single: the device connected to this channel will request single
53  * DMA transfers, not bursts. (Bursts are default.)
54  */
55 struct pl08x_channel_data {
56         char *bus_id;
57         int min_signal;
58         int max_signal;
59         u32 muxval;
60         u32 cctl;
61         u32 ccfg;
62         dma_addr_t addr;
63         bool circular_buffer;
64         bool single;
65 };
66
67 /**
68  * Struct pl08x_bus_data - information of source or destination
69  * busses for a transfer
70  * @addr: current address
71  * @maxwidth: the maximum width of a transfer on this bus
72  * @buswidth: the width of this bus in bytes: 1, 2 or 4
73  * @fill_bytes: bytes required to fill to the next bus memory
74  * boundary
75  */
76 struct pl08x_bus_data {
77         dma_addr_t addr;
78         u8 maxwidth;
79         u8 buswidth;
80         u32 fill_bytes;
81 };
82
83 /**
84  * struct pl08x_phy_chan - holder for the physical channels
85  * @id: physical index to this channel
86  * @lock: a lock to use when altering an instance of this struct
87  * @signal: the physical signal (aka channel) serving this
88  * physical channel right now
89  * @serving: the virtual channel currently being served by this
90  * physical channel
91  */
92 struct pl08x_phy_chan {
93         unsigned int id;
94         void __iomem *base;
95         spinlock_t lock;
96         int signal;
97         struct pl08x_dma_chan *serving;
98         u32 csrc;
99         u32 cdst;
100         u32 clli;
101         u32 cctl;
102         u32 ccfg;
103 };
104
105 /**
106  * struct pl08x_txd - wrapper for struct dma_async_tx_descriptor
107  * @llis_bus: DMA memory address (physical) start for the LLIs
108  * @llis_va: virtual memory address start for the LLIs
109  */
110 struct pl08x_txd {
111         struct dma_async_tx_descriptor tx;
112         struct list_head node;
113         enum dma_data_direction direction;
114         struct pl08x_bus_data srcbus;
115         struct pl08x_bus_data dstbus;
116         int len;
117         dma_addr_t llis_bus;
118         void *llis_va;
119         struct pl08x_channel_data *cd;
120         bool active;
121         /*
122          * Settings to be put into the physical channel when we
123          * trigger this txd
124          */
125         u32 csrc;
126         u32 cdst;
127         u32 clli;
128         u32 cctl;
129 };
130
131 /**
132  * struct pl08x_dma_chan_state - holds the PL08x specific virtual
133  * channel states
134  * @PL08X_CHAN_IDLE: the channel is idle
135  * @PL08X_CHAN_RUNNING: the channel has allocated a physical transport
136  * channel and is running a transfer on it
137  * @PL08X_CHAN_PAUSED: the channel has allocated a physical transport
138  * channel, but the transfer is currently paused
139  * @PL08X_CHAN_WAITING: the channel is waiting for a physical transport
140  * channel to become available (only pertains to memcpy channels)
141  */
142 enum pl08x_dma_chan_state {
143         PL08X_CHAN_IDLE,
144         PL08X_CHAN_RUNNING,
145         PL08X_CHAN_PAUSED,
146         PL08X_CHAN_WAITING,
147 };
148
149 /**
150  * struct pl08x_dma_chan - this structure wraps a DMA ENGINE channel
151  * @chan: wrappped abstract channel
152  * @phychan: the physical channel utilized by this channel, if there is one
153  * @tasklet: tasklet scheduled by the IRQ to handle actual work etc
154  * @name: name of channel
155  * @cd: channel platform data
156  * @runtime_addr: address for RX/TX according to the runtime config
157  * @runtime_direction: current direction of this channel according to
158  * runtime config
159  * @lc: last completed transaction on this channel
160  * @desc_list: queued transactions pending on this channel
161  * @at: active transaction on this channel
162  * @lockflags: sometimes we let a lock last between two function calls,
163  * especially prep/submit, and then we need to store the IRQ flags
164  * in the channel state, here
165  * @lock: a lock for this channel data
166  * @host: a pointer to the host (internal use)
167  * @state: whether the channel is idle, paused, running etc
168  * @slave: whether this channel is a device (slave) or for memcpy
169  * @waiting: a TX descriptor on this channel which is waiting for
170  * a physical channel to become available
171  */
172 struct pl08x_dma_chan {
173         struct dma_chan chan;
174         struct pl08x_phy_chan *phychan;
175         struct tasklet_struct tasklet;
176         char *name;
177         struct pl08x_channel_data *cd;
178         dma_addr_t runtime_addr;
179         enum dma_data_direction runtime_direction;
180         dma_cookie_t lc;
181         struct list_head desc_list;
182         struct pl08x_txd *at;
183         unsigned long lockflags;
184         spinlock_t lock;
185         struct pl08x_driver_data *host;
186         enum pl08x_dma_chan_state state;
187         bool slave;
188         struct pl08x_txd *waiting;
189 };
190
191 /**
192  * struct pl08x_platform_data - the platform configuration for the
193  * PL08x PrimeCells.
194  * @slave_channels: the channels defined for the different devices on the
195  * platform, all inclusive, including multiplexed channels. The available
196  * physical channels will be multiplexed around these signals as they
197  * are requested, just enumerate all possible channels.
198  * @get_signal: request a physical signal to be used for a DMA
199  * transfer immediately: if there is some multiplexing or similar blocking
200  * the use of the channel the transfer can be denied by returning
201  * less than zero, else it returns the allocated signal number
202  * @put_signal: indicate to the platform that this physical signal is not
203  * running any DMA transfer and multiplexing can be recycled
204  * @bus_bit_lli: Bit[0] of the address indicated which AHB bus master the
205  * LLI addresses are on 0/1 Master 1/2.
206  */
207 struct pl08x_platform_data {
208         struct pl08x_channel_data *slave_channels;
209         unsigned int num_slave_channels;
210         struct pl08x_channel_data memcpy_channel;
211         int (*get_signal)(struct pl08x_dma_chan *);
212         void (*put_signal)(struct pl08x_dma_chan *);
213 };
214
215 #ifdef CONFIG_AMBA_PL08X
216 bool pl08x_filter_id(struct dma_chan *chan, void *chan_id);
217 #else
218 static inline bool pl08x_filter_id(struct dma_chan *chan, void *chan_id)
219 {
220         return false;
221 }
222 #endif
223
224 #endif  /* AMBA_PL08X_H */