Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mason/linux...
[firefly-linux-kernel-4.4.55.git] / drivers / media / i2c / smiapp-pll.h
1 /*
2  * drivers/media/i2c/smiapp-pll.h
3  *
4  * Generic driver for SMIA/SMIA++ compliant camera modules
5  *
6  * Copyright (C) 2012 Nokia Corporation
7  * Contact: Sakari Ailus <sakari.ailus@iki.fi>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * version 2 as published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21  * 02110-1301 USA
22  *
23  */
24
25 #ifndef SMIAPP_PLL_H
26 #define SMIAPP_PLL_H
27
28 #include <linux/device.h>
29
30 /* CSI-2 or CCP-2 */
31 #define SMIAPP_PLL_BUS_TYPE_CSI2                                0x00
32 #define SMIAPP_PLL_BUS_TYPE_PARALLEL                            0x01
33
34 /* op pix clock is for all lanes in total normally */
35 #define SMIAPP_PLL_FLAG_OP_PIX_CLOCK_PER_LANE                   (1 << 0)
36 #define SMIAPP_PLL_FLAG_NO_OP_CLOCKS                            (1 << 1)
37
38 struct smiapp_pll_branch {
39         uint16_t sys_clk_div;
40         uint16_t pix_clk_div;
41         uint32_t sys_clk_freq_hz;
42         uint32_t pix_clk_freq_hz;
43 };
44
45 struct smiapp_pll {
46         /* input values */
47         uint8_t bus_type;
48         union {
49                 struct {
50                         uint8_t lanes;
51                 } csi2;
52                 struct {
53                         uint8_t bus_width;
54                 } parallel;
55         };
56         unsigned long flags;
57         uint8_t binning_horizontal;
58         uint8_t binning_vertical;
59         uint8_t scale_m;
60         uint8_t scale_n;
61         uint8_t bits_per_pixel;
62         uint32_t link_freq;
63         uint32_t ext_clk_freq_hz;
64
65         /* output values */
66         uint16_t pre_pll_clk_div;
67         uint16_t pll_multiplier;
68         uint32_t pll_ip_clk_freq_hz;
69         uint32_t pll_op_clk_freq_hz;
70         struct smiapp_pll_branch vt;
71         struct smiapp_pll_branch op;
72
73         uint32_t pixel_rate_csi;
74         uint32_t pixel_rate_pixel_array;
75 };
76
77 struct smiapp_pll_branch_limits {
78         uint16_t min_sys_clk_div;
79         uint16_t max_sys_clk_div;
80         uint32_t min_sys_clk_freq_hz;
81         uint32_t max_sys_clk_freq_hz;
82         uint16_t min_pix_clk_div;
83         uint16_t max_pix_clk_div;
84         uint32_t min_pix_clk_freq_hz;
85         uint32_t max_pix_clk_freq_hz;
86 };
87
88 struct smiapp_pll_limits {
89         /* Strict PLL limits */
90         uint32_t min_ext_clk_freq_hz;
91         uint32_t max_ext_clk_freq_hz;
92         uint16_t min_pre_pll_clk_div;
93         uint16_t max_pre_pll_clk_div;
94         uint32_t min_pll_ip_freq_hz;
95         uint32_t max_pll_ip_freq_hz;
96         uint16_t min_pll_multiplier;
97         uint16_t max_pll_multiplier;
98         uint32_t min_pll_op_freq_hz;
99         uint32_t max_pll_op_freq_hz;
100
101         struct smiapp_pll_branch_limits vt;
102         struct smiapp_pll_branch_limits op;
103
104         /* Other relevant limits */
105         uint32_t min_line_length_pck_bin;
106         uint32_t min_line_length_pck;
107 };
108
109 struct device;
110
111 int smiapp_pll_calculate(struct device *dev,
112                          const struct smiapp_pll_limits *limits,
113                          struct smiapp_pll *pll);
114
115 #endif /* SMIAPP_PLL_H */