Si5338 driver - Revision history

Andrey.filippov: /* Sample configuration of the si5338 using Device Tree */

2013-12-16T21:50:40Z

Sample configuration of the si5338 using Device Tree

Andrey.filippov at 21:49, 16 December 2013

2013-12-16T21:49:18Z

@@ Line 24: / Line 24: @@
   echo "0" > $SI5338/post_init # configure and calibrate PLL, initialize device.
 As long as the PLL frequency is not changed it is now possible to modify other parameters (output routes, output frequencies, spread spectrum) "on the fly" without re-initialization of the device. If programming was performed by loading complete register map and later modifications are required, input frequency and spread spectrum parameters need to be specified - they are stored in the driver variables, not in the device registers.
 ==sysfs interface ==

Andrey.filippov at 21:45, 16 December 2013

2013-12-16T21:45:01Z

@@ Line 5: / Line 5: @@
 ==Reference Documentation==
 This driver is developed using very good and detailed documentation provided by the chip manufacturer:
-[http://www.silabs.com/Support%20Documents/TechnicalDocs/Si5338-RM.pdf] - detailed description of the device registers
+[http://www.silabs.com/Support%20Documents/TechnicalDocs/Si5338-RM.pdf Si5338-RM.pdf] - detailed description of the device registers
-[http://www.silabs.com/Support%20Documents/TechnicalDocs/Si5338.pdf] - overall chip documentation including configuration procedure
+[http://www.silabs.com/Support%20Documents/TechnicalDocs/Si5338.pdf Si5338.pdf] - overall chip documentation including configuration procedure
 ==sysfs interface ==

Andrey.filippov at 20:55, 16 December 2013

2013-12-16T20:55:06Z

← Older revision		Revision as of 20:55, 16 December 2013
Line 402:		Line 402:
	140: 00 01 00 00 90 31 00 00 01 00 00 00 00 00 00 01		140: 00 01 00 00 90 31 00 00 01 00 00 00 00 00 00 01
	150: 00 00 00 00 60 4a 20 00 35 1b 00 00		150: 00 00 00 00 60 4a 20 00 35 1b 00 00
	====raw/hex_adwe ~~(read only)~~ ====		====raw/hex_adwe====
	Setting up a single or multiple registers with mask. Each item 0xAAADDMM is a hex number (with optional "0x" prefix), combining register 9 bit address AAA (shifted left by 16 bits), 8-bit register data DD (shifted left by 8 bits) and 8-bit write enable mask MM where "1" enables modification, "0" - keeps the old value. , can be used to load full register map generated by external software:		Setting up a single or multiple registers with mask. Each item 0xAAADDMM is a hex number (with optional "0x" prefix), combining register 9 bit address AAA (shifted left by 16 bits), 8-bit register data DD (shifted left by 8 bits) and 8-bit write enable mask MM where "1" enables modification, "0" - keeps the old value. , can be used to load full register map generated by external software:
	echo "0x6081d 0x1b7080 0x1c0bff 0x1d08ff 0x1eb0ff 0x1fe3ff 0x20e3ff 0x21e3ff \		echo "0x6081d 0x1b7080 0x1c0bff 0x1d08ff 0x1eb0ff 0x1fe3ff 0x20e3ff 0x21e3ff \
Line 434:		Line 434:
	0x15100ff 0x15200ff 0x15300ff 0x15490ff 0x15531ff 0x15600ff 0x15700ff 0x15801ff \		0x15100ff 0x15200ff 0x15300ff 0x15490ff 0x15531ff 0x15600ff 0x15700ff 0x15801ff \
	0x15900ff 0x15a00ff 0x15b000f" > /sys/devices/amba.0/e0004000.ps7-i2c/i2c-0/0-0070/raw/hex_adwe		0x15900ff 0x15a00ff 0x15b000f" > /sys/devices/amba.0/e0004000.ps7-i2c/i2c-0/0-0070/raw/hex_adwe

	Reading this node outputs current register data in the same format, using masks specified in the Reference Manual.		Reading this node outputs current register data in the same format, using masks specified in the Reference Manual.
	root@elphel393:/sys/devices/amba.0/e0004000.ps7-i2c/i2c-0/0-0070# cat raw/hex_adwe		root@elphel393:/sys/devices/amba.0/e0004000.ps7-i2c/i2c-0/0-0070# cat raw/hex_adwe
Line 467:		Line 466:
	0x15100ff 0x15200ff 0x15300ff 0x15460ff 0x1554aff 0x15620ff 0x15700ff 0x15835ff		0x15100ff 0x15200ff 0x15300ff 0x15460ff 0x1554aff 0x15620ff 0x15700ff 0x15835ff
	0x1591bff 0x15a00ff 0x15b000f		0x1591bff 0x15a00ff 0x15b000f
			====raw/invalidate_cache====
			The driver caches the register data except for the volatile registers (like status register) to reduce number of i2c data sent to and received from the device. For debugging purposes (maybe some of the registers can change that are not specified as being volatile in the driver), there is an explicit command to invalidate the current cache and force driver to read actual device registers next time.
			root@elphel393:/sys/devices/amba.0/e0004000.ps7-i2c/i2c-0/0-0070# echo "0" > raw/invalidate_cache
			Driver support dynamic debug, it can be activated with teh following command:
			echo "file si5338.c +flmpt" > /sys/kernel/debug/dynamic_debug/control

Andrey.filippov at 20:46, 16 December 2013

2013-12-16T20:46:20Z

← Older revision		Revision as of 20:46, 16 December 2013
Line 436:		Line 436:

	Reading this node outputs current register data in the same format, using masks specified in the Reference Manual.		Reading this node outputs current register data in the same format, using masks specified in the Reference Manual.
			root@elphel393:/sys/devices/amba.0/e0004000.ps7-i2c/i2c-0/0-0070# cat raw/hex_adwe
			0x6001d 0x1b7080 0x1c0bff 0x1d08ff 0x1ea0ff 0x1fc0ff 0x20e3ff 0x21e3ff
			0x22c0ff 0x2397ff 0x24011f 0x25041f 0x26041f 0x27061f 0x281fff 0x29427f
			0x2a243f 0x2dc5ff 0x2e01ff 0x2f143f 0x3038ff 0x3180ff 0x32c4ff 0x3307ff
			0x3414ff 0x3500ff 0x3653ff 0x3700ff 0x3800ff 0x3900ff 0x3a00ff 0x3b01ff
			0x3c00ff 0x3d00ff 0x3e003f 0x3f10ff 0x4000ff 0x4100ff 0x4200ff 0x4300ff
			0x4400ff 0x4500ff 0x4600ff 0x4700ff 0x4800ff 0x49003f 0x4a10ff 0x4b00ff
			0x4c00ff 0x4d00ff 0x4e00ff 0x4f00ff 0x5000ff 0x5100ff 0x5200ff 0x5300ff
			0x54003f 0x5514ff 0x5680ff 0x5706ff 0x5800ff 0x5900ff 0x5a00ff 0x5b00ff
			0x5c01ff 0x5d00ff 0x5e00ff 0x5f003f 0x6100ff 0x6231ff 0x6300ff 0x6400ff
			0x6500ff 0x6600ff 0x6701ff 0x6800ff 0x6900ff 0x6a80bf 0x6b00ff 0x6c00ff
			0x6d00ff 0x6e00ff 0x6f00ff 0x7000ff 0x7100ff 0x7200ff 0x7300ff 0x7480ff
			0x7500ff 0x7600ff 0x7700ff 0x7800ff 0x7900ff 0x7a00ff 0x7b00ff 0x7c00ff
			0x7d00ff 0x7e00ff 0x7f00ff 0x8000ff 0x81000f 0x82000f 0x8300ff 0x8400ff
			0x8500ff 0x8600ff 0x8700ff 0x8800ff 0x8900ff 0x8a00ff 0x8b00ff 0x8c00ff
			0x8d00ff 0x8e00ff 0x8f00ff 0x9000ff 0x9800ff 0x9900ff 0x9a00ff 0x9b00ff
			0x9c00ff 0x9d00ff 0x9e000f 0x9f000f 0xa000ff 0xa100ff 0xa200ff 0xa300ff
			0xa400ff 0xa500ff 0xa600ff 0xa700ff 0xa800ff 0xa900ff 0xaa00ff 0xab00ff
			0xac00ff 0xad00ff 0xae00ff 0xaf00ff 0xb000ff 0xb100ff 0xb200ff 0xb300ff
			0xb400ff 0xb5000f 0xb600ff 0xb700ff 0xb800ff 0xb900ff 0xba00ff 0xbb00ff
			0xbc00ff 0xbd00ff 0xbe00ff 0xbf00ff 0xc000ff 0xc100ff 0xc200ff 0xc300ff
			0xc400ff 0xc500ff 0xc600ff 0xc700ff 0xc800ff 0xc900ff 0xca00ff 0xcb000f
			0xcc00ff 0xcd00ff 0xce00ff 0xcf00ff 0xd000ff 0xd100ff 0xd200ff 0xd300ff
			0xd400ff 0xd500ff 0xd600ff 0xd700ff 0xd800ff 0xd900ff 0xf20002 0x11f01ff
			0x12000ff 0x12100ff 0x12200ff 0x12300ff 0x12470ff 0x12507ff 0x1266cff 0x12700ff
			0x12885ff 0x12900ff 0x12a04ff 0x12b000f 0x12f00ff 0x13000ff 0x13101ff 0x13200ff
			0x13300ff 0x13490ff 0x13531ff 0x13600ff 0x13700ff 0x13801ff 0x13900ff 0x13a00ff
			0x13b000f 0x13f00ff 0x14000ff 0x14101ff 0x14200ff 0x14300ff 0x14490ff 0x14531ff
			0x14600ff 0x14700ff 0x14801ff 0x14900ff 0x14a00ff 0x14b000f 0x14f01ff 0x15000ff
			0x15100ff 0x15200ff 0x15300ff 0x15460ff 0x1554aff 0x15620ff 0x15700ff 0x15835ff
			0x1591bff 0x15a00ff 0x15b000f

Andrey.filippov at 20:44, 16 December 2013

2013-12-16T20:44:47Z

@@ Line 364: / Line 364: @@
 ====raw/address====
 ====raw/hex_address====
-Address of the register to read/write data form, this is a full 9-bit register of the si5338 (not the 8-bit i2c register address), the page switching is handled by the driver. Silicon Labs documentation references registers by decimal address, this is why both hex and decimal versions are implemented
+Address of the register to read/write data form, this is a full 9-bit register of the si5338 (not the 8-bit i2c register address), the page switching is handled by the driver.

Andrey.filippov at 20:21, 16 December 2013

2013-12-16T20:21:13Z

← Older revision		Revision as of 20:21, 16 December 2013
Line 360:		Line 360:
	2: 2V5_SSTL_A+B+, output frequency: 200219-169/199 Hz, output route: MS2:32, ms_power_up, disabled state: dis_low, output_power_down, output_en, Spread spectrum is OFF, down amplitude= 50 ( *0.01%), spread rate= 31500 Hz		2: 2V5_SSTL_A+B+, output frequency: 200219-169/199 Hz, output route: MS2:32, ms_power_up, disabled state: dis_low, output_power_down, output_en, Spread spectrum is OFF, down amplitude= 50 ( *0.01%), spread rate= 31500 Hz
	3: 1V8_LVDS, output frequency: 150000000 Hz, output route: MS3:1, ms_power_up, disabled state: dis_hi-z, output_power_down, output_en, Spread spectrum is ON, down amplitude= 50 ( *0.01%), spread rate= 31500 Hz		3: 1V8_LVDS, output frequency: 150000000 Hz, output route: MS3:1, ms_power_up, disabled state: dis_hi-z, output_power_down, output_en, Spread spectrum is ON, down amplitude= 50 ( *0.01%), spread rate= 31500 Hz
			===raw/ folder===
			Nodes in this directory provide low-level access to the chip registers, allow loading of the complete register map generated by the Silicon Labs ClockBuilder software as well as to generate the loadable register map from the current state of the chip.
			====raw/address====
			====raw/hex_address====
			Address of the register to read/write data form, this is a full 9-bit register of the si5338 (not the 8-bit i2c register address), the page switching is handled by the driver. Silicon Labs documentation references registers by decimal address, this is why both hex and decimal versions are implemented

Andrey.filippov: /* Reference Documentation */

2013-12-16T18:22:53Z

Reference Documentation

← Older revision		Revision as of 18:22, 16 December 2013
Line 4:		Line 4:

	==Reference Documentation==		==Reference Documentation==
	This driver is developed using ~~excellent~~ documentation provided by the chip manufacturer:		This driver is developed using very good and detailed documentation provided by the chip manufacturer:
	[http://www.silabs.com/Support%20Documents/TechnicalDocs/Si5338-RM.pdf] - detailed description of the device registers		[http://www.silabs.com/Support%20Documents/TechnicalDocs/Si5338-RM.pdf] - detailed description of the device registers
	[http://www.silabs.com/Support%20Documents/TechnicalDocs/Si5338.pdf] - overall chip documentation including configuration procedure		[http://www.silabs.com/Support%20Documents/TechnicalDocs/Si5338.pdf] - overall chip documentation including configuration procedure

	==sysfs interface ==		==sysfs interface ==
	===top level files ===		===top level files ===

Andrey.filippov at 05:57, 16 December 2013

2013-12-16T05:57:05Z

@@ Line 148: / Line 148: @@
 Reset multiSynth dividers (''not clear when exactly they should be reset - possibly after spread spectrum changes'').
   root@elphel393:/sys/devices/amba.0/e0004000.ps7-i2c/i2c-0/0-0070# echo "0" > multiSynth/ms_reset
 ===output_clocks/ folder ===
 ====output_clocks/out0_div====
@@ Line 236: / Line 219: @@
   MS2:32
   Output frequency for the channel 2 is set to the 200000.5 Hz first with fractional MS2 divider (resulting in 200000.512Hz), then with integer divider - 200219.8 Hz
 ===output_drivers/ folder ===
 Configuring output drivers - voltage, I/O standard, inversion, power up/down, output enable and state when the output is disabled

Andrey.filippov at 05:36, 16 December 2013

2013-12-16T05:36:44Z

@@ Line 148: / Line 148: @@
 Reset multiSynth dividers (''not clear when exactly they should be reset - possibly after spread spectrum changes'').
   root@elphel393:/sys/devices/amba.0/e0004000.ps7-i2c/i2c-0/0-0070# echo "0" > multiSynth/ms_reset
 ===output_clocks/ folder ===
 ====output_clocks/out0_div====

← Older revision		Revision as of 21:50, 16 December 2013
Line 27:		Line 27:
	==Sample configuration of the si5338 using Device Tree==		==Sample configuration of the si5338 using Device Tree==
	si5338@70 {		si5338@70 {
	compatible = "sil,si5338";		compatible = "sil,si5338";
	reg = <0x70>;		reg = <0x70>;
	si5338,init="always"; /* initialize PLL, wait for lock. Other option is 'if off' */		si5338,init="always"; /* initialize PLL, wait for lock. Other option is 'if off' */
	/* low-level masked register writes, may be used to load frequency plan */		/* low-level masked register writes, may be used to load frequency plan */
	/si5338,configuration_data=< 0x1ffcf0 >;/ /* just for testing: write data 0xfc with write enable mask 0xf0 to register 0x01f */		/si5338,configuration_data=< 0x1ffcf0 >;/ /* just for testing: write data 0xfc with write enable mask 0xf0 to register 0x01f */
	si5338,in_frequency3= < 25000000>; /* 25MHz on input 3 (other inputs are '12",'4','56' and '12xo' */		si5338,in_frequency3= < 25000000>; /* 25MHz on input 3 (other inputs are '12",'4','56' and '12xo' */
	/* PLL may be set either directly (pll_freq_fract,pll_freq_int) or to match some output (pll_by_out_fract, pll_by_out_int)		/* PLL may be set either directly (pll_freq_fract,pll_freq_int) or to match some output (pll_by_out_fract, pll_by_out_int)
	* _int suffix forces to find integer divisors, _fract - allows fractional ones */		* _int suffix forces to find integer divisors, _fract - allows fractional ones */
	si5338,pll_by_out_int=<150000000>; /* 150Mhz May have 3 values: integer, nominator and denominator */		si5338,pll_by_out_int=<150000000>; /* 150Mhz May have 3 values: integer, nominator and denominator */
	si5338,out3_freq_int= <150000000>; /* 150Mhz. May have 3 values: integer, nominator and denominator */		si5338,out3_freq_int= <150000000>; /* 150Mhz. May have 3 values: integer, nominator and denominator */
	si5338,out2_select= "in3/2/32"; /* connect out2 to IN3, divided by 2 (input stage) and then by 32 (output stage)*/		si5338,out2_select= "in3/2/32"; /* connect out2 to IN3, divided by 2 (input stage) and then by 32 (output stage)*/
	si5338,2V5_LVPECL= <1 2>; /* set output standard for channels 1 and 2 */		si5338,2V5_LVPECL= <1 2>; /* set output standard for channels 1 and 2 */
	si5338,1V5_HSTL_A+= <0>; /* set output standard for channel 0, only A output is used (noninverted) */		si5338,1V5_HSTL_A+= <0>; /* set output standard for channel 0, only A output is used (noninverted) */
	si5338,1V8_LVDS= <3>;		si5338,1V8_LVDS= <3>;
	/* Disabled state for outputs: */		/* Disabled state for outputs: */
	si5338,dis_hi-z= <0 1 2 3>; /* Disabled state for listed outputs, also possible: "dis_hi-z","dis_low","dis_high","dis_always_on" */		si5338,dis_hi-z= <0 1 2 3>; /* Disabled state for listed outputs, also possible: "dis_hi-z","dis_low","dis_high","dis_always_on" */
	si5338,output_en= < 3>; /* Which outputs should be initially enabled */		si5338,output_en= < 3>; /* Which outputs should be initially enabled */
	si5338,spread_spectrum_3= <1 50 31500>; /* Set spread spectrum for channel3 : enabled, 0.5%, 31.5KHz */		si5338,spread_spectrum_3= <1 50 31500>; /* Set spread spectrum for channel3 : enabled, 0.5%, 31.5KHz */
	si5338,out0_freq_int= <15000000>; /* 15Mhz to output 0 */		si5338,out0_freq_int= <15000000>; /* 15Mhz to output 0 */
	si5338,spread_spectrum_0= <1 500 31500>; /* Set spread spectrum for channel0 : enabled, 5%, 31.5KHz - high value, for testing */		si5338,spread_spectrum_0= <1 500 31500>; /* Set spread spectrum for channel0 : enabled, 5%, 31.5KHz - high value, for testing */
	};		};


	==sysfs interface ==		==sysfs interface ==