49b7f71ac96897487d6c873c834c48d8760f7616
[sfrench/cifs-2.6.git] / drivers / media / platform / omap3isp / isp.h
1 /*
2  * isp.h
3  *
4  * TI OMAP3 ISP - Core
5  *
6  * Copyright (C) 2009-2010 Nokia Corporation
7  * Copyright (C) 2009 Texas Instruments, Inc.
8  *
9  * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
10  *           Sakari Ailus <sakari.ailus@iki.fi>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License version 2 as
14  * published by the Free Software Foundation.
15  */
16
17 #ifndef OMAP3_ISP_CORE_H
18 #define OMAP3_ISP_CORE_H
19
20 #include <media/media-entity.h>
21 #include <media/v4l2-async.h>
22 #include <media/v4l2-device.h>
23 #include <linux/clk-provider.h>
24 #include <linux/device.h>
25 #include <linux/io.h>
26 #include <linux/iommu.h>
27 #include <linux/platform_device.h>
28 #include <linux/wait.h>
29
30 #include "omap3isp.h"
31 #include "ispstat.h"
32 #include "ispccdc.h"
33 #include "ispreg.h"
34 #include "ispresizer.h"
35 #include "isppreview.h"
36 #include "ispcsiphy.h"
37 #include "ispcsi2.h"
38 #include "ispccp2.h"
39
40 #define ISP_TOK_TERM            0xFFFFFFFF      /*
41                                                  * terminating token for ISP
42                                                  * modules reg list
43                                                  */
44 #define to_isp_device(ptr_module)                               \
45         container_of(ptr_module, struct isp_device, isp_##ptr_module)
46 #define to_device(ptr_module)                                           \
47         (to_isp_device(ptr_module)->dev)
48
49 enum isp_mem_resources {
50         OMAP3_ISP_IOMEM_MAIN,
51         OMAP3_ISP_IOMEM_CCP2,
52         OMAP3_ISP_IOMEM_CCDC,
53         OMAP3_ISP_IOMEM_HIST,
54         OMAP3_ISP_IOMEM_H3A,
55         OMAP3_ISP_IOMEM_PREV,
56         OMAP3_ISP_IOMEM_RESZ,
57         OMAP3_ISP_IOMEM_SBL,
58         OMAP3_ISP_IOMEM_CSI2A_REGS1,
59         OMAP3_ISP_IOMEM_CSIPHY2,
60         OMAP3_ISP_IOMEM_CSI2A_REGS2,
61         OMAP3_ISP_IOMEM_CSI2C_REGS1,
62         OMAP3_ISP_IOMEM_CSIPHY1,
63         OMAP3_ISP_IOMEM_CSI2C_REGS2,
64         OMAP3_ISP_IOMEM_LAST
65 };
66
67 enum isp_sbl_resource {
68         OMAP3_ISP_SBL_CSI1_READ         = 0x1,
69         OMAP3_ISP_SBL_CSI1_WRITE        = 0x2,
70         OMAP3_ISP_SBL_CSI2A_WRITE       = 0x4,
71         OMAP3_ISP_SBL_CSI2C_WRITE       = 0x8,
72         OMAP3_ISP_SBL_CCDC_LSC_READ     = 0x10,
73         OMAP3_ISP_SBL_CCDC_WRITE        = 0x20,
74         OMAP3_ISP_SBL_PREVIEW_READ      = 0x40,
75         OMAP3_ISP_SBL_PREVIEW_WRITE     = 0x80,
76         OMAP3_ISP_SBL_RESIZER_READ      = 0x100,
77         OMAP3_ISP_SBL_RESIZER_WRITE     = 0x200,
78 };
79
80 enum isp_subclk_resource {
81         OMAP3_ISP_SUBCLK_CCDC           = (1 << 0),
82         OMAP3_ISP_SUBCLK_AEWB           = (1 << 1),
83         OMAP3_ISP_SUBCLK_AF             = (1 << 2),
84         OMAP3_ISP_SUBCLK_HIST           = (1 << 3),
85         OMAP3_ISP_SUBCLK_PREVIEW        = (1 << 4),
86         OMAP3_ISP_SUBCLK_RESIZER        = (1 << 5),
87 };
88
89 /* ISP: OMAP 34xx ES 1.0 */
90 #define ISP_REVISION_1_0                0x10
91 /* ISP2: OMAP 34xx ES 2.0, 2.1 and 3.0 */
92 #define ISP_REVISION_2_0                0x20
93 /* ISP2P: OMAP 36xx */
94 #define ISP_REVISION_15_0               0xF0
95
96 #define ISP_PHY_TYPE_3430               0
97 #define ISP_PHY_TYPE_3630               1
98
99 struct regmap;
100
101 /*
102  * struct isp_res_mapping - Map ISP io resources to ISP revision.
103  * @isp_rev: ISP_REVISION_x_x
104  * @offset: register offsets of various ISP sub-blocks
105  * @phy_type: ISP_PHY_TYPE_{3430,3630}
106  */
107 struct isp_res_mapping {
108         u32 isp_rev;
109         u32 offset[OMAP3_ISP_IOMEM_LAST];
110         u32 phy_type;
111 };
112
113 /*
114  * struct isp_reg - Structure for ISP register values.
115  * @reg: 32-bit Register address.
116  * @val: 32-bit Register value.
117  */
118 struct isp_reg {
119         enum isp_mem_resources mmio_range;
120         u32 reg;
121         u32 val;
122 };
123
124 enum isp_xclk_id {
125         ISP_XCLK_A,
126         ISP_XCLK_B,
127 };
128
129 struct isp_xclk {
130         struct isp_device *isp;
131         struct clk_hw hw;
132         struct clk *clk;
133         enum isp_xclk_id id;
134
135         spinlock_t lock;        /* Protects enabled and divider */
136         bool enabled;
137         unsigned int divider;
138 };
139
140 /*
141  * struct isp_device - ISP device structure.
142  * @dev: Device pointer specific to the OMAP3 ISP.
143  * @revision: Stores current ISP module revision.
144  * @irq_num: Currently used IRQ number.
145  * @mmio_base: Array with kernel base addresses for ioremapped ISP register
146  *             regions.
147  * @mmio_hist_base_phys: Physical L4 bus address for ISP hist block register
148  *                       region.
149  * @syscon: Regmap for the syscon register space
150  * @syscon_offset: Offset of the CSIPHY control register in syscon
151  * @phy_type: ISP_PHY_TYPE_{3430,3630}
152  * @mapping: IOMMU mapping
153  * @stat_lock: Spinlock for handling statistics
154  * @isp_mutex: Mutex for serializing requests to ISP.
155  * @stop_failure: Indicates that an entity failed to stop.
156  * @crashed: Crashed ent_enum
157  * @has_context: Context has been saved at least once and can be restored.
158  * @ref_count: Reference count for handling multiple ISP requests.
159  * @cam_ick: Pointer to camera interface clock structure.
160  * @cam_mclk: Pointer to camera functional clock structure.
161  * @csi2_fck: Pointer to camera CSI2 complexIO clock structure.
162  * @l3_ick: Pointer to OMAP3 L3 bus interface clock.
163  * @xclks: External clocks provided by the ISP
164  * @irq: Currently attached ISP ISR callbacks information structure.
165  * @isp_af: Pointer to current settings for ISP AutoFocus SCM.
166  * @isp_hist: Pointer to current settings for ISP Histogram SCM.
167  * @isp_h3a: Pointer to current settings for ISP Auto Exposure and
168  *           White Balance SCM.
169  * @isp_res: Pointer to current settings for ISP Resizer.
170  * @isp_prev: Pointer to current settings for ISP Preview.
171  * @isp_ccdc: Pointer to current settings for ISP CCDC.
172  * @platform_cb: ISP driver callback function pointers for platform code
173  *
174  * This structure is used to store the OMAP ISP Information.
175  */
176 struct isp_device {
177         struct v4l2_device v4l2_dev;
178         struct v4l2_async_notifier notifier;
179         struct media_device media_dev;
180         struct media_entity_graph pm_count_graph;
181         struct device *dev;
182         u32 revision;
183
184         /* platform HW resources */
185         unsigned int irq_num;
186
187         void __iomem *mmio_base[OMAP3_ISP_IOMEM_LAST];
188         unsigned long mmio_hist_base_phys;
189         struct regmap *syscon;
190         u32 syscon_offset;
191         u32 phy_type;
192
193         struct dma_iommu_mapping *mapping;
194
195         /* ISP Obj */
196         spinlock_t stat_lock;   /* common lock for statistic drivers */
197         struct mutex isp_mutex; /* For handling ref_count field */
198         bool stop_failure;
199         struct media_entity_enum crashed;
200         int has_context;
201         int ref_count;
202         unsigned int autoidle;
203 #define ISP_CLK_CAM_ICK         0
204 #define ISP_CLK_CAM_MCLK        1
205 #define ISP_CLK_CSI2_FCK        2
206 #define ISP_CLK_L3_ICK          3
207         struct clk *clock[4];
208         struct isp_xclk xclks[2];
209
210         /* ISP modules */
211         struct ispstat isp_af;
212         struct ispstat isp_aewb;
213         struct ispstat isp_hist;
214         struct isp_res_device isp_res;
215         struct isp_prev_device isp_prev;
216         struct isp_ccdc_device isp_ccdc;
217         struct isp_csi2_device isp_csi2a;
218         struct isp_csi2_device isp_csi2c;
219         struct isp_ccp2_device isp_ccp2;
220         struct isp_csiphy isp_csiphy1;
221         struct isp_csiphy isp_csiphy2;
222
223         unsigned int sbl_resources;
224         unsigned int subclk_resources;
225
226 #define ISP_MAX_SUBDEVS         8
227         struct v4l2_subdev *subdevs[ISP_MAX_SUBDEVS];
228 };
229
230 struct isp_async_subdev {
231         struct v4l2_subdev *sd;
232         struct isp_bus_cfg bus;
233         struct v4l2_async_subdev asd;
234 };
235
236 #define v4l2_dev_to_isp_device(dev) \
237         container_of(dev, struct isp_device, v4l2_dev)
238
239 void omap3isp_hist_dma_done(struct isp_device *isp);
240
241 void omap3isp_flush(struct isp_device *isp);
242
243 int omap3isp_module_sync_idle(struct media_entity *me, wait_queue_head_t *wait,
244                               atomic_t *stopping);
245
246 int omap3isp_module_sync_is_stopping(wait_queue_head_t *wait,
247                                      atomic_t *stopping);
248
249 int omap3isp_pipeline_set_stream(struct isp_pipeline *pipe,
250                                  enum isp_pipeline_stream_state state);
251 void omap3isp_pipeline_cancel_stream(struct isp_pipeline *pipe);
252 void omap3isp_configure_bridge(struct isp_device *isp,
253                                enum ccdc_input_entity input,
254                                const struct isp_parallel_cfg *buscfg,
255                                unsigned int shift, unsigned int bridge);
256
257 struct isp_device *omap3isp_get(struct isp_device *isp);
258 void omap3isp_put(struct isp_device *isp);
259
260 void omap3isp_print_status(struct isp_device *isp);
261
262 void omap3isp_sbl_enable(struct isp_device *isp, enum isp_sbl_resource res);
263 void omap3isp_sbl_disable(struct isp_device *isp, enum isp_sbl_resource res);
264
265 void omap3isp_subclk_enable(struct isp_device *isp,
266                             enum isp_subclk_resource res);
267 void omap3isp_subclk_disable(struct isp_device *isp,
268                              enum isp_subclk_resource res);
269
270 int omap3isp_pipeline_pm_use(struct media_entity *entity, int use,
271                              struct media_entity_graph *graph);
272
273 int omap3isp_register_entities(struct platform_device *pdev,
274                                struct v4l2_device *v4l2_dev);
275 void omap3isp_unregister_entities(struct platform_device *pdev);
276
277 /*
278  * isp_reg_readl - Read value of an OMAP3 ISP register
279  * @isp: Device pointer specific to the OMAP3 ISP.
280  * @isp_mmio_range: Range to which the register offset refers to.
281  * @reg_offset: Register offset to read from.
282  *
283  * Returns an unsigned 32 bit value with the required register contents.
284  */
285 static inline
286 u32 isp_reg_readl(struct isp_device *isp, enum isp_mem_resources isp_mmio_range,
287                   u32 reg_offset)
288 {
289         return __raw_readl(isp->mmio_base[isp_mmio_range] + reg_offset);
290 }
291
292 /*
293  * isp_reg_writel - Write value to an OMAP3 ISP register
294  * @isp: Device pointer specific to the OMAP3 ISP.
295  * @reg_value: 32 bit value to write to the register.
296  * @isp_mmio_range: Range to which the register offset refers to.
297  * @reg_offset: Register offset to write into.
298  */
299 static inline
300 void isp_reg_writel(struct isp_device *isp, u32 reg_value,
301                     enum isp_mem_resources isp_mmio_range, u32 reg_offset)
302 {
303         __raw_writel(reg_value, isp->mmio_base[isp_mmio_range] + reg_offset);
304 }
305
306 /*
307  * isp_reg_clr - Clear individual bits in an OMAP3 ISP register
308  * @isp: Device pointer specific to the OMAP3 ISP.
309  * @mmio_range: Range to which the register offset refers to.
310  * @reg: Register offset to work on.
311  * @clr_bits: 32 bit value which would be cleared in the register.
312  */
313 static inline
314 void isp_reg_clr(struct isp_device *isp, enum isp_mem_resources mmio_range,
315                  u32 reg, u32 clr_bits)
316 {
317         u32 v = isp_reg_readl(isp, mmio_range, reg);
318
319         isp_reg_writel(isp, v & ~clr_bits, mmio_range, reg);
320 }
321
322 /*
323  * isp_reg_set - Set individual bits in an OMAP3 ISP register
324  * @isp: Device pointer specific to the OMAP3 ISP.
325  * @mmio_range: Range to which the register offset refers to.
326  * @reg: Register offset to work on.
327  * @set_bits: 32 bit value which would be set in the register.
328  */
329 static inline
330 void isp_reg_set(struct isp_device *isp, enum isp_mem_resources mmio_range,
331                  u32 reg, u32 set_bits)
332 {
333         u32 v = isp_reg_readl(isp, mmio_range, reg);
334
335         isp_reg_writel(isp, v | set_bits, mmio_range, reg);
336 }
337
338 /*
339  * isp_reg_clr_set - Clear and set invidial bits in an OMAP3 ISP register
340  * @isp: Device pointer specific to the OMAP3 ISP.
341  * @mmio_range: Range to which the register offset refers to.
342  * @reg: Register offset to work on.
343  * @clr_bits: 32 bit value which would be cleared in the register.
344  * @set_bits: 32 bit value which would be set in the register.
345  *
346  * The clear operation is done first, and then the set operation.
347  */
348 static inline
349 void isp_reg_clr_set(struct isp_device *isp, enum isp_mem_resources mmio_range,
350                      u32 reg, u32 clr_bits, u32 set_bits)
351 {
352         u32 v = isp_reg_readl(isp, mmio_range, reg);
353
354         isp_reg_writel(isp, (v & ~clr_bits) | set_bits, mmio_range, reg);
355 }
356
357 static inline enum v4l2_buf_type
358 isp_pad_buffer_type(const struct v4l2_subdev *subdev, int pad)
359 {
360         if (pad >= subdev->entity.num_pads)
361                 return 0;
362
363         if (subdev->entity.pads[pad].flags & MEDIA_PAD_FL_SINK)
364                 return V4L2_BUF_TYPE_VIDEO_OUTPUT;
365         else
366                 return V4L2_BUF_TYPE_VIDEO_CAPTURE;
367 }
368
369 #endif  /* OMAP3_ISP_CORE_H */