[mirror_ubuntu-artful-kernel.git] / include / linux / iio / frequency / ad9523.h

/*
 * AD9523 SPI Low Jitter Clock Generator
 *
 * Copyright 2012 Analog Devices Inc.
 *
 * Licensed under the GPL-2.
 */

#ifndef IIO_FREQUENCY_AD9523_H_
#define IIO_FREQUENCY_AD9523_H_

enum outp_drv_mode {
	TRISTATE,
	LVPECL_8mA,
	LVDS_4mA,
	LVDS_7mA,
	HSTL0_16mA,
	HSTL1_8mA,
	CMOS_CONF1,
	CMOS_CONF2,
	CMOS_CONF3,
	CMOS_CONF4,
	CMOS_CONF5,
	CMOS_CONF6,
	CMOS_CONF7,
	CMOS_CONF8,
	CMOS_CONF9
};

enum ref_sel_mode {
	NONEREVERTIVE_STAY_ON_REFB,
	REVERT_TO_REFA,
	SELECT_REFA,
	SELECT_REFB,
	EXT_REF_SEL
};

/**
 * struct ad9523_channel_spec - Output channel configuration
 *
 * @channel_num: Output channel number.
 * @divider_output_invert_en: Invert the polarity of the output clock.
 * @sync_ignore_en: Ignore chip-level SYNC signal.
 * @low_power_mode_en: Reduce power used in the differential output modes.
 * @use_alt_clock_src: Channel divider uses alternative clk source.
 * @output_dis: Disables, powers down the entire channel.
 * @driver_mode: Output driver mode (logic level family).
 * @divider_phase: Divider initial phase after a SYNC. Range 0..63
		   LSB = 1/2 of a period of the divider input clock.
 * @channel_divider: 10-bit channel divider.
 * @extended_name: Optional descriptive channel name.
 */

struct ad9523_channel_spec {
	unsigned		channel_num;
	bool			divider_output_invert_en;
	bool			sync_ignore_en;
	bool			low_power_mode_en;
				 /* CH0..CH3 VCXO, CH4..CH9 VCO2 */
	bool			use_alt_clock_src;
	bool			output_dis;
	enum outp_drv_mode	driver_mode;
	unsigned char		divider_phase;
	unsigned short		channel_divider;
	char			extended_name[16];
};

enum pll1_rzero_resistor {
	RZERO_883_OHM,
	RZERO_677_OHM,
	RZERO_341_OHM,
	RZERO_135_OHM,
	RZERO_10_OHM,
	RZERO_USE_EXT_RES = 8,
};

enum rpole2_resistor {
	RPOLE2_900_OHM,
	RPOLE2_450_OHM,
	RPOLE2_300_OHM,
	RPOLE2_225_OHM,
};

enum rzero_resistor {
	RZERO_3250_OHM,
	RZERO_2750_OHM,
	RZERO_2250_OHM,
	RZERO_2100_OHM,
	RZERO_3000_OHM,
	RZERO_2500_OHM,
	RZERO_2000_OHM,
	RZERO_1850_OHM,
};

enum cpole1_capacitor {
	CPOLE1_0_PF,
	CPOLE1_8_PF,
	CPOLE1_16_PF,
	CPOLE1_24_PF,
	_CPOLE1_24_PF, /* place holder */
	CPOLE1_32_PF,
	CPOLE1_40_PF,
	CPOLE1_48_PF,
};

/**
 * struct ad9523_platform_data - platform specific information
 *
 * @vcxo_freq: External VCXO frequency in Hz
 * @refa_diff_rcv_en: REFA differential/single-ended input selection.
 * @refb_diff_rcv_en: REFB differential/single-ended input selection.
 * @zd_in_diff_en: Zero Delay differential/single-ended input selection.
 * @osc_in_diff_en: OSC differential/ single-ended input selection.
 * @refa_cmos_neg_inp_en: REFA single-ended neg./pos. input enable.
 * @refb_cmos_neg_inp_en: REFB single-ended neg./pos. input enable.
 * @zd_in_cmos_neg_inp_en: Zero Delay single-ended neg./pos. input enable.
 * @osc_in_cmos_neg_inp_en: OSC single-ended neg./pos. input enable.
 * @refa_r_div: PLL1 10-bit REFA R divider.
 * @refb_r_div: PLL1 10-bit REFB R divider.
 * @pll1_feedback_div: PLL1 10-bit Feedback N divider.
 * @pll1_charge_pump_current_nA: Magnitude of PLL1 charge pump current (nA).
 * @zero_delay_mode_internal_en: Internal, external Zero Delay mode selection.
 * @osc_in_feedback_en: PLL1 feedback path, local feedback from
 *			the OSC_IN receiver or zero delay mode
 * @pll1_loop_filter_rzero: PLL1 Loop Filter Zero Resistor selection.
 * @ref_mode: Reference selection mode.
 * @pll2_charge_pump_current_nA: Magnitude of PLL2 charge pump current (nA).
 * @pll2_ndiv_a_cnt: PLL2 Feedback N-divider, A Counter, range 0..4.
 * @pll2_ndiv_b_cnt: PLL2 Feedback N-divider, B Counter, range 0..63.
 * @pll2_freq_doubler_en: PLL2 frequency doubler enable.
 * @pll2_r2_div: PLL2 R2 divider, range 0..31.
 * @pll2_vco_diff_m1: VCO1 divider, range 3..5.
 * @pll2_vco_diff_m2: VCO2 divider, range 3..5.
 * @rpole2: PLL2 loop filter Rpole resistor value.
 * @rzero: PLL2 loop filter Rzero resistor value.
 * @cpole1: PLL2 loop filter Cpole capacitor value.
 * @rzero_bypass_en: PLL2 loop filter Rzero bypass enable.
 * @num_channels: Array size of struct ad9523_channel_spec.
 * @channels: Pointer to channel array.
 * @name: Optional alternative iio device name.
 */

struct ad9523_platform_data {
	unsigned long vcxo_freq;

	/* Differential/ Single-Ended Input Configuration */
	bool				refa_diff_rcv_en;
	bool				refb_diff_rcv_en;
	bool				zd_in_diff_en;
	bool				osc_in_diff_en;

	/*
	 * Valid if differential input disabled
	 * if false defaults to pos input
	 */
	bool				refa_cmos_neg_inp_en;
	bool				refb_cmos_neg_inp_en;
	bool				zd_in_cmos_neg_inp_en;
	bool				osc_in_cmos_neg_inp_en;

	/* PLL1 Setting */
	unsigned short			refa_r_div;
	unsigned short			refb_r_div;
	unsigned short			pll1_feedback_div;
	unsigned short			pll1_charge_pump_current_nA;
	bool				zero_delay_mode_internal_en;
	bool				osc_in_feedback_en;
	enum pll1_rzero_resistor	pll1_loop_filter_rzero;

	/* Reference */
	enum ref_sel_mode		ref_mode;

	/* PLL2 Setting */
	unsigned int			pll2_charge_pump_current_nA;
	unsigned char			pll2_ndiv_a_cnt;
	unsigned char			pll2_ndiv_b_cnt;
	bool				pll2_freq_doubler_en;
	unsigned char			pll2_r2_div;
	unsigned char			pll2_vco_diff_m1; /* 3..5 */
	unsigned char			pll2_vco_diff_m2; /* 3..5 */

	/* Loop Filter PLL2 */
	enum rpole2_resistor		rpole2;
	enum rzero_resistor		rzero;
	enum cpole1_capacitor		cpole1;
	bool				rzero_bypass_en;

	/* Output Channel Configuration */
	int				num_channels;
	struct ad9523_channel_spec	*channels;

	char				name[SPI_NAME_SIZE];
};

#endif /* IIO_FREQUENCY_AD9523_H_ */
Commit	Line	Data
cd1678f9 MH	1	/*
	2	* AD9523 SPI Low Jitter Clock Generator
	3	*
	4	* Copyright 2012 Analog Devices Inc.
	5	*
	6	* Licensed under the GPL-2.
	7	*/
	8
	9	#ifndef IIO_FREQUENCY_AD9523_H_
	10	#define IIO_FREQUENCY_AD9523_H_
	11
	12	enum outp_drv_mode {
	13	TRISTATE,
	14	LVPECL_8mA,
	15	LVDS_4mA,
	16	LVDS_7mA,
	17	HSTL0_16mA,
	18	HSTL1_8mA,
	19	CMOS_CONF1,
	20	CMOS_CONF2,
	21	CMOS_CONF3,
	22	CMOS_CONF4,
	23	CMOS_CONF5,
	24	CMOS_CONF6,
	25	CMOS_CONF7,
	26	CMOS_CONF8,
	27	CMOS_CONF9
	28	};
	29
	30	enum ref_sel_mode {
	31	NONEREVERTIVE_STAY_ON_REFB,
	32	REVERT_TO_REFA,
	33	SELECT_REFA,
	34	SELECT_REFB,
	35	EXT_REF_SEL
	36	};
	37
	38	/**
	39	* struct ad9523_channel_spec - Output channel configuration
	40	*
	41	* @channel_num: Output channel number.
	42	* @divider_output_invert_en: Invert the polarity of the output clock.
	43	* @sync_ignore_en: Ignore chip-level SYNC signal.
	44	* @low_power_mode_en: Reduce power used in the differential output modes.
	45	* @use_alt_clock_src: Channel divider uses alternative clk source.
	46	* @output_dis: Disables, powers down the entire channel.
	47	* @driver_mode: Output driver mode (logic level family).
	48	* @divider_phase: Divider initial phase after a SYNC. Range 0..63
	49	LSB = 1/2 of a period of the divider input clock.
	50	* @channel_divider: 10-bit channel divider.
	51	* @extended_name: Optional descriptive channel name.
	52	*/
	53
	54	struct ad9523_channel_spec {
	55	unsigned channel_num;
	56	bool divider_output_invert_en;
	57	bool sync_ignore_en;
	58	bool low_power_mode_en;
	59	/* CH0..CH3 VCXO, CH4..CH9 VCO2 */
	60	bool use_alt_clock_src;
	61	bool output_dis;
	62	enum outp_drv_mode driver_mode;
	63	unsigned char divider_phase;
	64	unsigned short channel_divider;
65	char extended_name[16];
66	};
67
68	enum pll1_rzero_resistor {
69	RZERO_883_OHM,
70	RZERO_677_OHM,
71	RZERO_341_OHM,
72	RZERO_135_OHM,
73	RZERO_10_OHM,
74	RZERO_USE_EXT_RES = 8,
75	};
76
77	enum rpole2_resistor {
78	RPOLE2_900_OHM,
79	RPOLE2_450_OHM,
80	RPOLE2_300_OHM,
81	RPOLE2_225_OHM,
82	};
83
84	enum rzero_resistor {
85	RZERO_3250_OHM,
86	RZERO_2750_OHM,
87	RZERO_2250_OHM,
88	RZERO_2100_OHM,
89	RZERO_3000_OHM,
90	RZERO_2500_OHM,
91	RZERO_2000_OHM,
92	RZERO_1850_OHM,
93	};
94
95	enum cpole1_capacitor {
96	CPOLE1_0_PF,
97	CPOLE1_8_PF,
98	CPOLE1_16_PF,
99	CPOLE1_24_PF,
100	_CPOLE1_24_PF, /* place holder */
101	CPOLE1_32_PF,
102	CPOLE1_40_PF,
103	CPOLE1_48_PF,
104	};
105
106	/**
107	* struct ad9523_platform_data - platform specific information
108	*
109	* @vcxo_freq: External VCXO frequency in Hz
110	* @refa_diff_rcv_en: REFA differential/single-ended input selection.
111	* @refb_diff_rcv_en: REFB differential/single-ended input selection.
112	* @zd_in_diff_en: Zero Delay differential/single-ended input selection.
113	* @osc_in_diff_en: OSC differential/ single-ended input selection.
114	* @refa_cmos_neg_inp_en: REFA single-ended neg./pos. input enable.
115	* @refb_cmos_neg_inp_en: REFB single-ended neg./pos. input enable.
116	* @zd_in_cmos_neg_inp_en: Zero Delay single-ended neg./pos. input enable.
117	* @osc_in_cmos_neg_inp_en: OSC single-ended neg./pos. input enable.
118	* @refa_r_div: PLL1 10-bit REFA R divider.
119	* @refb_r_div: PLL1 10-bit REFB R divider.
120	* @pll1_feedback_div: PLL1 10-bit Feedback N divider.
121	* @pll1_charge_pump_current_nA: Magnitude of PLL1 charge pump current (nA).
122	* @zero_delay_mode_internal_en: Internal, external Zero Delay mode selection.
123	* @osc_in_feedback_en: PLL1 feedback path, local feedback from
124	* the OSC_IN receiver or zero delay mode
125	* @pll1_loop_filter_rzero: PLL1 Loop Filter Zero Resistor selection.
126	* @ref_mode: Reference selection mode.
127	* @pll2_charge_pump_current_nA: Magnitude of PLL2 charge pump current (nA).
128	* @pll2_ndiv_a_cnt: PLL2 Feedback N-divider, A Counter, range 0..4.
129	* @pll2_ndiv_b_cnt: PLL2 Feedback N-divider, B Counter, range 0..63.
130	* @pll2_freq_doubler_en: PLL2 frequency doubler enable.
131	* @pll2_r2_div: PLL2 R2 divider, range 0..31.
132	* @pll2_vco_diff_m1: VCO1 divider, range 3..5.
133	* @pll2_vco_diff_m2: VCO2 divider, range 3..5.
134	* @rpole2: PLL2 loop filter Rpole resistor value.
135	* @rzero: PLL2 loop filter Rzero resistor value.
136	* @cpole1: PLL2 loop filter Cpole capacitor value.
137	* @rzero_bypass_en: PLL2 loop filter Rzero bypass enable.
138	* @num_channels: Array size of struct ad9523_channel_spec.
139	* @channels: Pointer to channel array.
140	* @name: Optional alternative iio device name.
141	*/
142
143	struct ad9523_platform_data {
144	unsigned long vcxo_freq;
145
146	/* Differential/ Single-Ended Input Configuration */
147	bool refa_diff_rcv_en;
148	bool refb_diff_rcv_en;
149	bool zd_in_diff_en;
150	bool osc_in_diff_en;
151
152	/*
153	* Valid if differential input disabled
154	* if false defaults to pos input
155	*/
156	bool refa_cmos_neg_inp_en;
157	bool refb_cmos_neg_inp_en;
158	bool zd_in_cmos_neg_inp_en;
159	bool osc_in_cmos_neg_inp_en;
160
161	/* PLL1 Setting */
162	unsigned short refa_r_div;
163	unsigned short refb_r_div;
164	unsigned short pll1_feedback_div;
165	unsigned short pll1_charge_pump_current_nA;
166	bool zero_delay_mode_internal_en;
167	bool osc_in_feedback_en;
168	enum pll1_rzero_resistor pll1_loop_filter_rzero;
169
170	/* Reference */
171	enum ref_sel_mode ref_mode;
172
173	/* PLL2 Setting */
174	unsigned int pll2_charge_pump_current_nA;
175	unsigned char pll2_ndiv_a_cnt;
176	unsigned char pll2_ndiv_b_cnt;
177	bool pll2_freq_doubler_en;
178	unsigned char pll2_r2_div;
179	unsigned char pll2_vco_diff_m1; /* 3..5 */
180	unsigned char pll2_vco_diff_m2; /* 3..5 */
181
182	/* Loop Filter PLL2 */
183	enum rpole2_resistor rpole2;
184	enum rzero_resistor rzero;
185	enum cpole1_capacitor cpole1;
186	bool rzero_bypass_en;
187
188	/* Output Channel Configuration */
189	int num_channels;
190	struct ad9523_channel_spec *channels;
191
192	char name[SPI_NAME_SIZE];
193	};
194
195	#endif /* IIO_FREQUENCY_AD9523_H_ */