1. Manuals
  2. Brands
  3. Cypress Semiconductor Manuals
  4. Microcontrollers
  5. GX3 EEPROM
  6. Programming & user manual

Cypress Semiconductor GX3 EEPROM Programming & User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
GX3 EEPROM Programming User Guide
GX3 EEPROM Programming
User Guide
1
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the GX3 EEPROM and is the answer not in the manual?

Questions and answers

Related Manuals for Cypress Semiconductor GX3 EEPROM

Summary of Contents for Cypress Semiconductor GX3 EEPROM

  • Page 1 GX3 EEPROM Programming User Guide GX3 EEPROM Programming User Guide Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 2: Table Of Contents

    Internal Memory Default Settings ..............6 2-3. Recommended EEPROM Settings ..............7 2-4. EEPROM User-defined Fields Notes ............... 9 3. GX3 EEPROM Programming Tool ........... 15 3-1. Files Description ..................... 15 3-2. How to Run the EEPROM Programming Tool on Windows 7/8 or Vista platform ........................
  • Page 3 5-2-2. How to register a MAC/Ethernet address from IEEE-SA? ...... 50 5-3. The Serial Number ..................50 5-3-1. Do I have to assign a unique serial number to every GX3 based devices?50 Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 4: Introduction

    GX3 EEPROM Programming User Guide 1. Introduction This user guide provides the information about how to program EZ-USB GX3 EEPROM 2. EEPROM Memory Map 2-1. EEPROM Format The following tables show portions of GX3 EEPROM format. The EEPROM used for GX3 based applications should be a serial EEPROM (93C56 or 93C66) with at least 128*16 bits of storage space for storing the hardware configuration data like USB Device Descriptors, Node-ID, etc.
  • Page 5 Note: The value of EEPROM Checksum field located at EEPROM offset 05h (low byte). The correct value must be equal to (0xFF - SUM [EEPROM offset 03h ~ 04h]). If SUM [EEPROM offset 03h ~ 04h] has carry, please add ‘1’ to its result. Table 1. Serial EEPROM Memory Map Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 6: Internal Memory Default Settings

    43 79 70 72 65 73 73 00 00 00 (Max. 10 bytes) Fixed Pattern 40 4A 40 00 40 30 0D 49 90 41 Fixed pattern to be written Table 2. Internal Memory Default Settings Descriptions Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 7: Recommended Eeprom Settings

    FF FF FF FF FF FF FF FF FF FF 0x80~FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF Table 3. Recommended EEPROM Settings Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 8 Software Field FF FF Refer to Note 10 in Section 2.5 for details Note 1: The Node ID field must be unique for each GX3 device. Table 4. Recommended EEPROM Settings Descriptions Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 9: Eeprom User-Defined Fields Notes

    2-4. EEPROM User-defined Fields Notes Note 1: Node ID Settings Every Ethernet device must have a unique MAC address. Users should always assign a unique MAC address in the GX3 EEPROM for every GX3 based devices. Please refer to Section 5-2 for details.
  • Page 10 GET_DESCRIPTOR command with CONFIGURATION type is issued. These fields are used to define the Maximum power consumption of the USB device drawn from the USB bus in this specific configuration when the device is fully operational. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 11 The “Offset” fields of Product/Manufacturer/Serial Number String are fixed in GX3 EEPROM memory map. Please DON’T change the recommended values of these fields. If you need to change the Product/Manufacturer/Serial Number strings on your GX3 EEPROM, please modify the “Length” fields of Product/Manufacturer/Serial Number String to meet the exact string length of your Product/Manufacturer/Serial Number strings.
  • Page 12 Link 10 Link 10+Active Link 100 Link 100+Active LED_2 Link 100/10 Link 100/10+Active Link 1000 Link 1000+Active Link 1000/10 Link 1000/10+Active Link 1000/100 Link 1000/100+Active Link 1000/100/10 Link 1000/100/10+Active (Default) Full duplex Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 13 00 00 00 00 00 00 00 00”. Note 8: Fixed_pattern (EEPROM: 3D~41h) Please write these 10 bytes of fixed_pattern with hexadecimal (from low bytes to high bytes) = “40 4A 40 00 40 30 0D 49 90 41”. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 14 The EEPROM Software Field (EEPROM offset 43h) is used for GX3 drivers to identify different specific applications for different driver configurations and maintained by Cypress directly. The default value of the Software Field is 0xFFFF that is suitable for most of GX3 applications. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 15: Gx3 Eeprom Programming Tool

    GX3 EEPROM Programming User Guide 3. GX3 EEPROM Programming Tool Cypress provides a GX3 EEPROM Programming tool for users to easily program the Serial EEPROM for GX3 applications. This Windows EEPROM Programming Tool supports to customize the MAC address, Serial Number, Vendor ID and Product ID, etc. for GX3 based application systems in mass production.

  • Page 16: How To Run The Eeprom Programming Tool On Windows 7/8 Or Vista Platform

    3-2. How to Run the EEPROM Programming Tool on Windows 7/8 or Vista platform While executing the GX3 EEPROM Programming Tool on Windows 8/7 or Vista platform, users need to run with “Administrator” authority. Right-click on the GX3 EEPROM Programming tool and select “Run as administrator”. After that, a User Account Control pop-up window will show on screen to tell you an unidentified program wants access to your computer.
  • Page 17 GX3 EEPROM Programming User Guide Figure 2. Allow User Account Control (UAC) for EEPROM Programming Tool Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 18: Gx3 Eeprom Programming

    GX3 EEPROM Programming User Guide 3-3. GX3 EEPROM Programming 3-3-1. Function Description The GX3 EEPROM Programming Tool GUI is shown below. Figure 3. GX3 Programming Tool EEPROM Programming User Interface Button # Button Name Description Program Start programming the EEPROM.
  • Page 19 Bar Code Read MAC address from Bar Code scanner: If Bar Code box is checked, the GX3 EEPROM Programming tool will fill the Bar-code’s MAC Address into the Current MAC address field and then program the EEPROM automatically while using the Bar Code Scanner to scan the bar code that contains the Ethernet MAC Address.

  • Page 20: Tool Usage Procedures

    GX3 EEPROM Programming User Guide 3-3-2. Tool Usage Procedures The following are the test procedures of Windows GX3 EEPROM Programming Tool. Please uninstall the standard GX3 Windows driver first if it had been installed before. Check if GX3 Windows test driver was installed properly.
  • Page 21 Note: If the EEPROM.DAT and SROM.DAT files are not existent in the same subdirectory of the .exe file, users will see the following warning dialog while running the tool. The tool will auto-create these two data files, and users can just ignore this warning message. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 22 GX3 EEPROM Programming User Guide Configure proper settings on all fields of GX3 EEPROM Programming Tool. Re-confirm all settings that match your GX3 application’s configuration; for example, VID/PID, MAC Address, Serial Number, Manufacture/Product String, LED Setting, etc. Press “Program” button to start programming GX3 SROM data into EEPROM. The test results will be displayed in the “Result”...
  • Page 23 GX3 EEPROM Programming User Guide Figure 6. GX3 EEPROM Tool Programming Result Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 24: How To Load Recommended Srom Data File

    GX3_SROM.exe tool was located and overwrite the original SROM.DAT file. 7. Click “Load SROM” button to load the specific SROM data file as the figure below. GX3 EEPROM Tool “Load SROM” Dialog Figure 7. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 25 GX3 EEPROM Programming User Guide Configure proper EEPROM setting such as VID/PID, MAC address, Serial Number, etc. Figure 8. GX3 Tool EEPROM Setting Press the “Program” button to start programming the EEPROM. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 26 SROM.DAT file in the folder that the GX3 Programming tool was located. Figure 9. GX3 EEPROM Tool Dump SROM Data b) Compare the dump programmed SROM.DAT file with the original recommended SROM.DAT file to confirm all EEPROM contents were programmed as you expected. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 27: How To Convert Srom Data File To Binary File

    “Open” button to start converting the SROM.DAT file into the binary file. After converting the SROM.DAT file into the binary file (SROM.BIN) successfully, you will see the following dialog and then click “OK” button to continue. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 28 GX3 EEPROM Programming User Guide Now, you can find the SROM binary file (SROM.BIN) in the same folder of the SROM.DAT file for universal programmer. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 29: Windows Production Test Tool

    This tool also needs a separate server PC to run the test server tool. The test server tool on server PC can receive packets from the “device under test” product, and then reply back. The test environment is as below: Figure 10. Windows Production Test Tool Test Environment Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 30: Files Description

    Windows Production Test log file. This file will be auto-created after running ProductionTest.exe. SROM.DAT The GX3 SROM data file. Users can create this SROM data file by GX3 EEPROM Programming Tool. CYUSB3610Test.SYS GX3 Windows test driver CYUSB3610Test.INF GX3 Windows test driver INF file Table 9.

  • Page 31: How To Run Windows Production Test Tool On Windows 7/8 Or Vista Platforms

    Note: You might also see this error message if you don’t install GX3 Windows test driver properly. Please refer to Figure 4 to check if the Windows test driver was installed properly or not. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 32: Function Description

    Click Yes button to allow launching the ProductionTest.exe program. 4-3. Function Description The following is the user interface of Windows Production Test program. Figure 11. Windows Production Test Tool User Interface Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 33 This test will program EEPROM content, and then read EEPROM to verify. After starting each of above test items, if the result of current test item is failed, the test will be stopped. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 34: Test Tab

    Note: Please double check following items before starting the Production Test. 1. The IP address (e.g. 192.168.0.100) of GX3 Windows test driver of Test PC should be configured to the same subnet as the IP address (e.g. 192.168.0.1) of Server PC. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 35: Eeprom Tab

    Production Test Server should be the same as that in the Windows Production Test program. 4-3-2. EEPROM Tab The following is the user interface of “EEPROM” tab of the Windows Production Test program. Figure 13. Windows Production Test Tool EEPROM Tab Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 36 GX3 dongles. Note that the other test items will be auto-disabled when the “Auto Writing” function is enabled. “Dump EEPROM” Dump the EEPROM data from GX3 EEPROM to a pop-up button window. “Preview” button Preview the EEPROM content that is going to be programmed.
  • Page 37 GX3 EEPROM Programming User Guide Figure 14. Windows Production Test Tool Dump/Preview SROM Data Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 38: Settings Tab

    2. The Server IP address, TCP/UDP packet type and port number settings of Windows Production Test Server should be the same as that in Windows Production Test program. Windows Production Test Tool Setting Tab – Ethernet Setting Figure 15. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 39 Note that the loopback test items only support 100M/10M Full- duplex modes. Please connect a loopback RJ-45 connector to GX3 for loopback test. “Load Setting” button Load the default setting of “EEPROM” and “Setting” tabs from Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 40 SETTING.INI file. “Save Setting” button Save the new setting of “EEPROM” and “Setting” tabs into the SETTING.INI file. “Exit” button Quit this program. Windows Production Test Tool “Setting” tab Table 12. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 41: Log Tab

    Field Name Description Event Log Display test log. “Clear” button Clear the test log strings in the “Event Log” window. “Exit” button Quit this program. Windows Production Test Tool “Log” tab Table 13. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 42: Tool Usage Procedures

    4. Press “Start” button to start Windows Production Test Server. Note: The Server IP address, the TCP/UDP packet type and port number settings of Windows Production Test Server should be the same as that in Windows Production Test program. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 43: Windows Production Test Program Setting

    IP address (e.g. 192.168.0.1) of Server PC. 4. Configure proper Server IP address (e.g. 192.168.0.1), TCP/UDP packet type and port number in the “Setting” tab of Windows Production Test program on Test PC. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 44 5. If the “EEPROM Program” test item was selected, set the EEPROM configuration in the “EEPROM” tab of Windows Production Test program on Test PC. (1) Press button to select a correct SROM.DAT file. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 45 (2) Press “Preview” button in EEPROM tab to double check the EEPROM content that is going to be programmed. 6. Press “START” button to start running Windows Production Test on Test PC. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...
  • Page 46 GX3 EEPROM Programming User Guide Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 47: How To Run Windows Production Test Tool If I Have My Own Vid/Pid

    4-5. How to Run Windows Production Test Tool If I Have My Own VID/PID? If you have your own VID/PID after programming SROM data using the GX3 EEPROM Programming Tool, the GX3 Windows test drivers may not recognize your device due to the GX3 Windows test drivers can only acknowledge Cypress’s GX3 default VID/PID.

  • Page 48: Skip To Program Eeprom Again On Windows Production Test Tool

    Test Item Select and un-check EEPROM Program as the figure below. It will reduce the procedures of Windows Production Test. Figure 19. Uncheck EEPROM Program in Windows Production Test Tool Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 49: Gx3 Eeprom Faqs

    (2) For brand name products, you probably don’t want your GX3 based devices to become compatible with other company’s GX3 based devices. In this case, you should consider assigning your own unique VID and PID for your GX3 based devices. Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation...

  • Page 50: How To Register A Vendor Id From Usb-If

    Yes, every Ethernet device must have a unique MAC address. Users should always assign a unique MAC address in the GX3 EEPROM for every GX3 based devices. You should refer to Section 5-2-2 to register a block of MAC addresses for your company.

Table of Contents