e2434bb0b308c9db523d35c0d7cee5d79b0c114e
[sfrench/cifs-2.6.git] / include / media / s5p_fimc.h
1 /*
2  * Samsung S5P/Exynos4 SoC series camera interface driver header
3  *
4  * Copyright (C) 2010 - 2013 Samsung Electronics Co., Ltd.
5  * Sylwester Nawrocki <s.nawrocki@samsung.com>
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
12 #ifndef S5P_FIMC_H_
13 #define S5P_FIMC_H_
14
15 #include <media/media-entity.h>
16
17 /*
18  * Enumeration of data inputs to the camera subsystem.
19  */
20 enum fimc_input {
21         FIMC_INPUT_PARALLEL_0   = 1,
22         FIMC_INPUT_PARALLEL_1,
23         FIMC_INPUT_MIPI_CSI2_0  = 3,
24         FIMC_INPUT_MIPI_CSI2_1,
25         FIMC_INPUT_WRITEBACK_A  = 5,
26         FIMC_INPUT_WRITEBACK_B,
27         FIMC_INPUT_WRITEBACK_ISP = 5,
28 };
29
30 /*
31  * Enumeration of the FIMC data bus types.
32  */
33 enum fimc_bus_type {
34         /* Camera parallel bus */
35         FIMC_BUS_TYPE_ITU_601 = 1,
36         /* Camera parallel bus with embedded synchronization */
37         FIMC_BUS_TYPE_ITU_656,
38         /* Camera MIPI-CSI2 serial bus */
39         FIMC_BUS_TYPE_MIPI_CSI2,
40         /* FIFO link from LCD controller (WriteBack A) */
41         FIMC_BUS_TYPE_LCD_WRITEBACK_A,
42         /* FIFO link from LCD controller (WriteBack B) */
43         FIMC_BUS_TYPE_LCD_WRITEBACK_B,
44         /* FIFO link from FIMC-IS */
45         FIMC_BUS_TYPE_ISP_WRITEBACK = FIMC_BUS_TYPE_LCD_WRITEBACK_B,
46 };
47
48 #define fimc_input_is_parallel(x) ((x) == 1 || (x) == 2)
49 #define fimc_input_is_mipi_csi(x) ((x) == 3 || (x) == 4)
50
51 struct i2c_board_info;
52
53 /**
54  * struct fimc_source_info - video source description required for the host
55  *                           interface configuration
56  *
57  * @board_info: pointer to I2C subdevice's board info
58  * @clk_frequency: frequency of the clock the host interface provides to sensor
59  * @fimc_bus_type: FIMC camera input type
60  * @sensor_bus_type: image sensor bus type, MIPI, ITU-R BT.601 etc.
61  * @flags: the parallel sensor bus flags defining signals polarity (V4L2_MBUS_*)
62  * @i2c_bus_num: i2c control bus id the sensor is attached to
63  * @mux_id: FIMC camera interface multiplexer index (separate for MIPI and ITU)
64  * @clk_id: index of the SoC peripheral clock for sensors
65  */
66 struct fimc_source_info {
67         struct i2c_board_info *board_info;
68         unsigned long clk_frequency;
69         enum fimc_bus_type fimc_bus_type;
70         enum fimc_bus_type sensor_bus_type;
71         u16 flags;
72         u16 i2c_bus_num;
73         u16 mux_id;
74         u8 clk_id;
75 };
76
77 /**
78  * struct s5p_platform_fimc - camera host interface platform data
79  *
80  * @source_info: properties of an image source for the host interface setup
81  * @num_clients: the number of attached image sources
82  */
83 struct s5p_platform_fimc {
84         struct fimc_source_info *source_info;
85         int num_clients;
86 };
87
88 /*
89  * v4l2_device notification id. This is only for internal use in the kernel.
90  * Sensor subdevs should issue S5P_FIMC_TX_END_NOTIFY notification in single
91  * frame capture mode when there is only one VSYNC pulse issued by the sensor
92  * at begining of the frame transmission.
93  */
94 #define S5P_FIMC_TX_END_NOTIFY _IO('e', 0)
95
96 enum fimc_subdev_index {
97         IDX_SENSOR,
98         IDX_CSIS,
99         IDX_FLITE,
100         IDX_IS_ISP,
101         IDX_FIMC,
102         IDX_MAX,
103 };
104
105 struct media_pipeline;
106 struct v4l2_subdev;
107
108 struct fimc_pipeline {
109         struct v4l2_subdev *subdevs[IDX_MAX];
110         struct media_pipeline *m_pipeline;
111 };
112
113 /*
114  * Media pipeline operations to be called from within the fimc(-lite)
115  * video node when it is the last entity of the pipeline. Implemented
116  * by corresponding media device driver.
117  */
118 struct fimc_pipeline_ops {
119         int (*open)(struct fimc_pipeline *p, struct media_entity *me,
120                           bool resume);
121         int (*close)(struct fimc_pipeline *p);
122         int (*set_stream)(struct fimc_pipeline *p, bool state);
123 };
124
125 #define fimc_pipeline_call(f, op, p, args...)                           \
126         (!(f) ? -ENODEV : (((f)->pipeline_ops && (f)->pipeline_ops->op) ? \
127                             (f)->pipeline_ops->op((p), ##args) : -ENOIOCTLCMD))
128
129 #endif /* S5P_FIMC_H_ */