Wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
resources:eval:ad9578-user-guide [28 Apr 2015 22:20] – Added Software section Kyle Slightomresources:eval:ad9578-user-guide [04 Feb 2021 21:52] (current) – [Running the Software] Petre Minciunescu
Line 25: Line 25:
  
 =====General Description===== =====General Description=====
----- +The [[adi>AD9578|AD9578]] evaluation board is a compact, easy-to-use platform for evaluating all features of the [[adi>AD9578|AD9578]]. The [[adi>AD9578|AD9578]] is a programmable synthesizer intended for jitter attenuation and asynchronous clocking applications in high performance telecommunications, networking, data storage, serializer/deserializer (SERDESand physical layer (PHYapplications.  The evaluation board consists of one prepopulated 49.152MHz crystal and optional single ended SMA inputs to drive the XO2 and XO4 pins.  Each output is accessed through edge launch ac-coupled SMA connectors.  The on board power supply allows users to simply operate the [[adi>AD9578|AD9578]] with 2.5V or 3.3V voltages by altering a few jumper settings.  Use this user guide in conjunction with the [[adi>AD9578|AD9578]] data sheet and the evaluation software available at [[adi>en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EVAL-AD9578.html#eb-overview]]
-The [[adi>AD9578|AD9578]] evaluation board is a compact, easy-to-use platform for evaluating all features of the [[adi>AD9578|AD9578]]. The [[adi>AD9578|AD9578]] is a programmable synthesizer intended for jitter attenuation and asynchronous clocking applications in high performance telecommunications, networking, data storage, SERDES and PHY applications.  The evaluation board consists of one prepopulated 49.152MHz crystal and optional single ended SMA inputs to drive the XO2 and XO4 pins.  Each output is accessed through edge launch ac-coupled SMA connectors.  The on board power supply allows users to simply operate the [[adi>AD9578|AD9578]] with 2.5V or 3.3V voltages by altering a few jumper settings.  Use this user guide in conjunction with the [[adi>AD9578|AD9578]] data sheet and software documentation available at www.analog.com+
 <WRAP centeralign> <WRAP centeralign>
 {{ :resources:eval:user-guides:ad9578:ad9578evb_cropped.png?direct&700 |}} {{ :resources:eval:user-guides:ad9578:ad9578evb_cropped.png?direct&700 |}}
Line 37: Line 36:
 The following instructions are for setting up the physical connections to the AD9578/PCBZ evaluation board.   The following instructions are for setting up the physical connections to the AD9578/PCBZ evaluation board.  
 ==== Power Connections ====  ==== Power Connections ==== 
-The AD9578/PCBZ is setup by default to power the AD9578 and remaining circuitry with 3.3V using the provided 6V wall power supply.  The evaluation board can be configured to operate at 2.5V when using the 6V wall supply by removing jumpers P507 and P509.+The AD9578/PCBZ is setup by default to power the AD9578 and remaining circuitry with 3.3V using the provided 6V wall power supply.  The evaluation board can be configured to operate at 2.5V when using the 6V wall supply by removing jumpers P507 and P509. Make sure the jumper P508 is between pins 1 and 2.
  
 ===Connecting External Supplies=== ===Connecting External Supplies===
Line 46: Line 45:
 ==== PC Connections ====  ==== PC Connections ==== 
 The following instructions assume the evaluation board is set up with the default power configuration as described in the **Power Connections** section. The following instructions assume the evaluation board is set up with the default power configuration as described in the **Power Connections** section.
-  - Download the latest [[adi>EVAL-AD9578|AD9578 evaluation software]] from analog.com website.+  - Download the latest [[adi>EVAL-AD9578|AD9578 evaluation software]] from AD9578/PCBZ website.
   - Install the [[adi>EVAL-AD9578|AD9578 evaluation software]]; uninstall prior versions of the software before installation updates.  Administrative privileges are needed to install the software.    - Install the [[adi>EVAL-AD9578|AD9578 evaluation software]]; uninstall prior versions of the software before installation updates.  Administrative privileges are needed to install the software. 
   - Connect the 6V wall power supply to the main power connector labeled P500.     - Connect the 6V wall power supply to the main power connector labeled P500.  
Line 58: Line 57:
 The AD9578 evaluation board comes prepopulated with a 49.152MHz crystal (Y101) across the XO1 and XO2 pins.  Crystal Y102 connects to the XO3 and XO4 pins and is not prepopulated.  Any crystal between 22MHz and 54MHz in a 3.2mm x 2.5mm package is suitable but care must be taken to select the proper load capacitance to ensure oscillation. The AD9578 evaluation board comes prepopulated with a 49.152MHz crystal (Y101) across the XO1 and XO2 pins.  Crystal Y102 connects to the XO3 and XO4 pins and is not prepopulated.  Any crystal between 22MHz and 54MHz in a 3.2mm x 2.5mm package is suitable but care must be taken to select the proper load capacitance to ensure oscillation.
  
-<note important>**Expand XO as REFIN**</note> 
  
 === Outputs === === Outputs ===
-The REFOUT output (J217 and J218) can be configured to be a copy of either XO input or a divided version of the applied REFCLK input (includes divide by 1).  The frequency source of OUT1 and OUT2 is PLL1 and the source of OUT3 and OUT4 is PLL2. The logic level of each output is selectable between CMOS, HCSL, LVDS and LVPECL.  All outputs are terminated as LVPECL by default and ac coupled to their respective SMA connectors.  Using any logic type other than LVPECL will require modifications to the terminations.  Refer to the AD9578 datasheet for the  recommended termination for each logic type.+The REFOUT output (J217 and J218) can be configured to be a copy of either XO input or a divided version of the applied REFCLK input (includes divide by 1).  The frequency source of OUT1 and OUT2 is PLL1 and the source of OUT3 and OUT4 is PLL2. The logic level of each output is selectable between CMOS, HCSL, LVDS and LVPECL.  All outputs are terminated as 3.3V LVPECL by default and ac coupled to their respective SMA connectors.  Using any logic type other than LVPECL will require modifications to the terminations.  Refer to the AD9578 datasheet for the  recommended termination for each logic type.
  
 ===SPI Bus===  ===SPI Bus=== 
-The AD9574/PCBZ default configuration allows a PC running the AD9578 evaluation software to read and write the various registers of the AD9578 via a USB connection.  The user may interface with the SPI bus from an external SPI controller by removing jumpers P108-P110 and driving the appropriate signals to the SDO, SCK, CSB, and SDI nodes.+The AD9574/PCBZ default configuration allows a PC running the AD9578 evaluation software to read and write the various registers of the AD9578 via a USB connection.  The user may interface with the SPI bus from an external SPI controller by removing jumpers P107-P110 and driving the appropriate signals to the SDO, SCK, CSB, and SDI nodes at the pin 2 of the P107-P110. As GND, use TP102 point.
  
  
  
 ==== Default Evaluation Boards Setup Summary ==== ==== Default Evaluation Boards Setup Summary ====
-  * Jumper P508 set to SW_OUT to provide the switcher output voltage to on board LDO regulators.+  * Jumper P508 set to SW_OUT between pins 1 and 2 to provide the switcher output voltage to the on board LDO regulators.
   * Jumpers P507 and P509 are populated to set LDO regulator outputs to 3.3V.   * Jumpers P507 and P509 are populated to set LDO regulator outputs to 3.3V.
-  * Jumpers P502 and P510 are populated to connect LDO voltages to AD9578 and microcontroller. +  * Jumpers P502 and P510 are populated to connect LDO voltages to the AD9578 and the microcontroller. 
   * 49.152MHz crystal oscillator connected to the XO1 and XO2 inputs is populated.   * 49.152MHz crystal oscillator connected to the XO1 and XO2 inputs is populated.
-  *  +  * OUT1 (J209 and J210), OUT2 (J211 and J212), OUT3 (J213 and J214), OUT4 (J215 and J216), and REFOUT (J217 and J218) are terminated for 3.3V LVPECL and ac coupled.
-  * OUT1 (J209 and J210), OUT2 (J211 and J212), OUT3 (J213 and J214), OUT4 (J215 and J216), and REFOUT (J217 and J218) are terminated for LVPECL and ac coupled.+
  
 =====Evaluation Board Software===== =====Evaluation Board Software=====
Line 80: Line 77:
 Use the following instructions to set up the [[adi>AD9578|AD9578]] evaluation board software.  Use the following instructions to set up the [[adi>AD9578|AD9578]] evaluation board software. 
  
- 
- 
-Use the following instructions to set up the AD9578 evaluation board software.  
 ====Software Installation==== ====Software Installation====
-Do not connect the evaluation board until the software installation is complete.+Connect the evaluation board to the PC until the software installation is complete.
   - The latest evaluation software and documentation can be downloaded from [[adi>EVAL-AD9578|the AD9578 evaluation board page.]].    - The latest evaluation software and documentation can be downloaded from [[adi>EVAL-AD9578|the AD9578 evaluation board page.]]. 
   - Once downloaded, double-click **AD9578 Evaluation Software Setup.msi**. (Note that the website may have a newer version.) Follow the installation instructions.    - Once downloaded, double-click **AD9578 Evaluation Software Setup.msi**. (Note that the website may have a newer version.) Follow the installation instructions. 
Line 94: Line 88:
 <WRAP centeralign> <WRAP centeralign>
 {{ :resources:eval:user-guides:ad9578:noevbconnected.png?direct&300 |}}\\   {{ :resources:eval:user-guides:ad9578:noevbconnected.png?direct&300 |}}\\  
-**Figure 2. Evaluation Board Not Connected Message**\\   +//Figure 2. Evaluation Board Not Connected Message//\\   
 </WRAP>\\ </WRAP>\\
  
 Clicking **OK** allows the software to be used without a connected evaluation board.  This mode is convenient for creating register setup files when an evaluation board is not present.  If an evaluation board is present and the error message appears, check power and USB connections and re start the program. Clicking **OK** allows the software to be used without a connected evaluation board.  This mode is convenient for creating register setup files when an evaluation board is not present.  If an evaluation board is present and the error message appears, check power and USB connections and re start the program.
-When and evaluation board is connected before starting program, the standard GUI appears as shown in Figure 6.  It is possible to connect the evaluation board after the software is started by selecting **File/Select Hardware** after the board has been powered and USB cable connected.  When a board is properly connected, **Read All Successful** will appear in the **Comments** box.+If the evaluation board is connected before starting the program, the standard GUI appears as shown in Figure 6.  It is possible to connect the evaluation board after the software is started by selecting **File/Select Hardware** after the board has been powered and USB cable connected.  When a board is properly connected, **Read All Successful** will appear in the **Comments** box.
  
 ===Setup Files=== ===Setup Files===
Line 130: Line 124:
   - Type the Crystal 1 reference frequency in the text box located in the upper left of the Main Window.<WRAP centeralign>   - Type the Crystal 1 reference frequency in the text box located in the upper left of the Main Window.<WRAP centeralign>
 {{ :resources:eval:user-guides:ad9578:quickstart_crystal_freq.png?direct&200 |}}   {{ :resources:eval:user-guides:ad9578:quickstart_crystal_freq.png?direct&200 |}}  
-**Figure 3. Crystal 1 Frequency Text Box**\\   +//Figure 3. Crystal 1 Frequency Text Box//\\   
 </WRAP> </WRAP>
   - Select **Crystal 1** as the **PLL1 Reference** and **PLL2 Reference** to using the drop down in the upper right of the Main Window.<WRAP centeralign>   - Select **Crystal 1** as the **PLL1 Reference** and **PLL2 Reference** to using the drop down in the upper right of the Main Window.<WRAP centeralign>
 {{ :resources:eval:user-guides:ad9578:quickstart_refsource.png?direct&200 |}}  {{ :resources:eval:user-guides:ad9578:quickstart_refsource.png?direct&200 |}} 
-**Figure 4. Input Reference Selection**\\   +//Figure 4. Input Reference Selection//\\   
 </WRAP> </WRAP>
   - Select the appropriate logic level for Output 1 through Output 4 and REFOUT by using each logic level drop down as shown in Figure 5 and type the desired frequency in each Output1 through Output 4 text box.<WRAP centeralign>   - Select the appropriate logic level for Output 1 through Output 4 and REFOUT by using each logic level drop down as shown in Figure 5 and type the desired frequency in each Output1 through Output 4 text box.<WRAP centeralign>
 {{ :resources:eval:user-guides:ad9578:quickstart_outconfig.png?direct&200 |}}   {{ :resources:eval:user-guides:ad9578:quickstart_outconfig.png?direct&200 |}}  
-**Figure 5. Logic Level Selection and Frequency Input**\\   +//Figure 5. Logic Level Selection and Frequency Input//\\   
 </WRAP> </WRAP>
   - Press the **Autocalculate** button at the bottom of the screen.  The software will calculate to the closest possible output frequency given the specified reference frequency.   - Press the **Autocalculate** button at the bottom of the screen.  The software will calculate to the closest possible output frequency given the specified reference frequency.
Line 150: Line 144:
 <WRAP centeralign> <WRAP centeralign>
  {{ :resources:eval:user-guides:ad9578:main_window.png?direct&600 |}}  {{ :resources:eval:user-guides:ad9578:main_window.png?direct&600 |}}
-**Figure 6. AD9578 Evaluation Software Main Window**\\   +//Figure 6. AD9578 Evaluation Software Main Window//\\   
 </WRAP> </WRAP>
 +
 +====Active and Inactive Controls====
 +Upon startup, many controls in the AD9578 main window are inactive and grayed out.  To manipulate all controls within the main window check the **Advanced** box in the lower right corner of the main window.
 +<WRAP centeralign>
 +{{ :resources:eval:user-guides:ad9578:advancedcontrols.png?direct&200 |}}
 +//Figure 7. Advanced Box//\\   
 +</WRAP>
 +Checking the **Advanced** box expands the main window to include a full register map and many other features, which are explained in the following sections of the user guide.
 +
 +====Invalid Value Indication====
 +Certain combinations of values can cause the AD9578 operating parameters to exceed the valid ranges specified in the datasheet.  In these cases, the invalid entry will be highlighted in yellow and a message will appear in the **Comments** box explaining why the entry is invalid.  
 +\\ 
 +The following conditions are checked within the software:
 +  * Crystal 1, Crystal 2, and External Reference input frequency ranges
 +  * Output 1 through Output 4 and Reference Output frequency ranges.
 +  * All text box entries within the expanded Main Window when the **Advanced** box is checked.
 +
 +====Autocalculate, Configure, and Read Buttons====
 +The **Autocalculate** button takes the user defined reference input and output frequency parameters and automatically configures the proper PLL settings using the Frequency Wizard.  Autocalculate is disabled in **Advanced Controls** mode.  For more information on the **Frequency Wizard** and **Advanced Controls**, refer to the respective sections in this document.
 +\\ \\
 +The **Configure** button loads all of the parameters from the GUI into the AD9578 on the evaluation board.  **“Write All Successful”** will appear in the comments box upon the completion of a successful write operation.
 +\\ \\
 +The **Read** button reads the current register values from inside the AD9578 and loads them into the Main Window. **“Read All Successful”** will appear in the comments box upon the completion of a successful read operation.
 +
 +====Input Frequency Section====
 +The input frequency section of the Main Window is used to identify the reference input frequency of either crystal input.  Each text box (**Crystal 1** and **Crystal 2**) is editable by the user and is used to calculate the output frequency of each output. If a differential input is used for an external reference, check the **Differential Input** check box. 
 +
 +====PLL Input Reference Selection====
 +The reference input to each PLL is specified by using the various drop down menus shown in Figure 8.
 +
 +<WRAP centeralign>
 +{{ :resources:eval:user-guides:ad9578:refinselect.png?direct&200 |}}
 +<wrap centeralign>
 +//Figure 8. PLL Input Reference Selection Drop Downs //</wrap>
 +</WRAP>
 +
 +Each PLL and REFOUT reference frequency can be supplied by Crystal 1, Crystal 2, or an external reference input Ref In. Crystal 2 and Ref In cannot be used simultaneously.  The selection of Ref In or Crystal 2 is controlled by using the Ref In/Crystal 2 drop down.
 +
 +====PLL1 and PLL2 Default Controls====
 +The AD9578 evaluation software automatically configures the settings for each PLL based on user inputs for both the reference frequency and output frequency by using an internal frequency wizard and the **Autocalculate** button.  To enable an output text box, change the appropriate logic level in each outputs allocated drop down menu.  Logic levels are selectable from LVDS, LVPECL, HCSL, and LVCMOS. Once a text box is enabled, the user may enter the desired output frequency.  Pressing **Autocalculate** will then calculate the value closest to the user input.  Figure 9 shows a standard configuration in the software’s default mode using Output 1 and Output 3.
 +<WRAP centeralign>
 +{{ :resources:eval:user-guides:ad9578:pll1_and_pll2_default_controls.png?direct |}}
 +<wrap centeralign>//Figure 9. PLL1 and PLL2 Default Controls //</wrap>
 +</WRAP>
 +
 +The **OEx** and **override** check boxes allow the user to manipulate the various output enable bits from the register 0x02 of the AD9578.  Default operation is for both boxes to be checked, allowing the software to have control over each output. 
 +
 +====PLL1 and PLL2 Advanced Controls====
 +Clicking the Advanced check box, as shown in Figure 7, expands the Main Window to allow the user to interact with individual PLL settings and the entire register map as the part is currently configured.
 +<WRAP centeralign>
 +{{ :resources:eval:user-guides:ad9578:pll1_and_pll2_advanced_controls.png?direct |}}
 +<wrap centeralign>//Figure 10. PLL1 and PLL2 Advanced Controls //</wrap>
 +</WRAP>
 +In **Advanced Controls** mode, all PLL feedback dividers, output dividers, charge pump and VCO settings are editable by typing in the various text boxes. It is recommended to allow the software to auto select the VCO band being used when in **Advanced Controls** mode. In this mode, all of the output frequencies are calculated based off the user’s settings for the reference frequencies and feedback/output division settings.  The **Autocalcuate** feature is thus disabled in **Advanced Controls** mode. Another feature in **Advanced Controls** mode is the **Reset Fuses Button**.  This button allows the user to reset the AD9578 to its default fuse blown settings  without power cycling evaluation board.  The default fuse blown settings are then displayed in the Main Window.
 +<WRAP centeralign>
 +{{ :resources:eval:user-guides:ad9578:reset_fuses_button.png?direct&100 |}}
 +<wrap centeralign>//Figure 11. Reset Fuses Button //</wrap>
 +</WRAP>
 +
 +====Reference Output Section====
 +The Reference Output source is selected in the **Input Frequency Section**.  The output frequency is displayed in the **Reference Output** section and the logic level is selectable from LVDS, LVPECL, HCSL, and LVCMOS.
 +<WRAP centeralign>
 +{{ :resources:eval:user-guides:ad9578:reference_output_selection.png?direct&250 |}}
 +<wrap centeralign>//Figure 12. Reference Output Section //</wrap>
 +</WRAP>
 +
 +====PLL Lock Indicators====
 +When either PLL1 or PLL2 are in lock, the appropriate PLL lock indicator will turn blue.
 +<WRAP centeralign>
 +{{ :resources:eval:user-guides:ad9578:pll_lock_indicators.png?direct&150 |}}
 +<wrap centeralign>//Figure 13. PLL Lock Indicators //</wrap>
 +</WRAP>
 +
 +====Comments Box====
 +The Comments box displays notifications to the user upon successful read/write operations as well as warnings when maximum limits of the part have been exceeded. Pressing the **Clear Comments** button erases all previous comments.
 +<WRAP centeralign>
 +{{ :resources:eval:user-guides:ad9578:comments_box.png?direct&250 |}}
 +<wrap centeralign>//Figure 14. Comments Box //</wrap>
 +</WRAP>
 +
 +====Frequency Wizard====
 +The AD9578 **Frequency Wizard** is responsible for calculating the optimum PLL settings for the user’s desired input and output frequencies when the **Autocalculate** feature is used.  For any given frequency plan there may be multiple configurations possible for each PLL.  The Frequency Wizard will automatically pick the best option by default, but every configuration can be accessed by pressing the **Show Frequency Wizard** button after **Autocalculate** has been pressed.  The **Frequency Wizard** is shown in Figure 15.
 +<WRAP centeralign>
 +{{ :resources:eval:user-guides:ad9578:frequency_wizard.png?direct&800 |}}
 +<wrap centeralign>//Figure 15. Frequency Wizard //</wrap>
 +</WRAP>
 +Pressing the various **Index** buttons on the left of the window will load those particular settings into the **Main Window** and override the original settings chosen by the **Frequency Wizard**.
 +
 +=====Evaluation Software Menu Items=====
 +----
 +<WRAP centeralign>
 +{{ :resources:eval:user-guides:ad9578:menu_bar.png?direct&300 |}}
 +<wrap centeralign>//Figure 16. Menu Bar //</wrap>
 +</WRAP>
 +
 +====Menu Bar====
 +===File Menu===
 +The **File** menu has the following options:
 +===Select Hardware===
 +Select hardware is used to find and connect to an evaluation board that has been plugged in to the computer (or recently power cycled) after the evaluation software has already started.  
 +
 +===Enable Polling===
 +Polling allows the software to automatically update the software without having to press the **Read** button.  To disable Polling, uncheck the box shown in Figure 16.
 +
 +===Load All Registers===
 +Allows the user to load a previously created setup file into the software.  Press the **Configure** button to load the setup file into the AD9578.
 +
 +===Save All Registers===
 +Creates a register setup file of the current settings seen in the evaluation board software.  This setup file can be saved and used later by using **Load All Registers**.
 +
 +===Exit===
 +Exits the program.  This is the same function as the “X” icon in the upper right of the screen.
 +
 +====View Menu (Advanced Controls Mode Only)====
 +The **View** menu has the following options:
 +
 +===Debug Window===
 +Allows the user to read write hex values to specific registers.  The register address is selected in a drop down menu and the register value is written by the user.  The **Read** button reads in the current register value at the address chosen the drop down.  The **Load** button loads the setting in the **Register Value** text box into the register chosen in the drop down. The **Debug Window** expects register writes to be a hexadecimal number starting with “0x”.
 +<WRAP centeralign>
 +{{ :resources:eval:user-guides:ad9578:debug_window.png?direct&300 |}}
 +<wrap centeralign>//Figure 17. Debug Window //</wrap>
 +</WRAP>
 +
 +===Crystal Settings===
 +Allows the user to alter the various XO settings found in registers 4 and 10.  This is useful when configuring the part to use a different crystal value than what is originally placed on the board.
 +<WRAP centeralign>
 +{{ :resources:eval:user-guides:ad9578:crystal_settings_window.png?direct&300 |}}
 +<wrap centeralign>//Figure 18. Crystal Settings Mode //</wrap>
 +</WRAP>
 +
 +====Help Menu====
 +The Help Menu only contains the **About** section which shows a short summary of the software being used.
resources/eval/ad9578-user-guide.1430252451.txt.gz · Last modified: 28 Apr 2015 22:20 by Kyle Slightom