manualshive.com logo in svg

Cypress Semiconductor GX3 EEPROM, Programming & User Manual, Page: 15 / 50

Share
Download
Cypress Semiconductor GX3 EEPROM Programming & User Manual Download Page 15

 

 

 

15 

Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation 

 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. 

 

3-1.

 

Files Description 

 

File Name 

Description 

GX3 EEPROM Programming 
Tool.exe 

GX3 EEPROM Programming Tool 

EEPROM.dat 

GX3 EEPROM Programming Tool Configuration Setting Data File  
This file will be auto-created after running the tool. 

SROM.dat 

EEPROM Content Data File 
This file will be auto-created after running the tool. 

CYUSB3610Test.sys 

GX3 Windows test driver  

CYUSB3610Test.inf 

GX3 Windows test driver INF file  

Serial-MAC.log 

GX3 EEPROM Programming Log file 

Table 6.

 

GX3 EEPROM Programming Tool Files Description   

 

Note:  

1.  Please uninstall the standard GX3 Windows driver first if it had been installed before. 
2. Please install CYUSB3610 Windows test driver before running the GX3 EEPROM 

Programming Tool. 

3. The GX3_EEPROM_Programming_Tool.EXE tool will auto-load the SROM data from 

the EEPROM.DAT and SROM.DAT files. If the EEPROM.DAT and SROM.DAT files 
do not exist, the tool will create these data files with the default values based on the 
selected device. 

4. Please delete the EEPROM.DAT and SROM.DAT files before running the tool if you 

want to restore the default EEPROM.DAT and SROM.DAT files.

 

 

 

Summary of Contents for GX3 EEPROM

Page 1: ...1 Copyright C 2011 2012 Reserved by Cypress Semiconductor Corporation GX3 EEPROM Programming User Guide GX3 EEPROM Programming User Guide ...

Page 2: ...ata File to Binary File 27 4 Windows Production Test Tool 29 4 1 Files Description 30 4 2 How to Run Windows Production Test Tool on Windows 7 8 or Vista platforms 31 4 3 Function Description 32 4 3 1 Test Tab 34 4 3 2 EEPROM Tab 35 4 3 3 Settings Tab 38 4 3 4 Log Tab 41 4 4 Tool Usage Procedures 42 4 4 1 Windows Production Server Program Setting 42 4 4 2 Windows Production Test Program Setting 43...

Page 3: ...3 EEPROM Programming User Guide 5 2 1 Do I have to assign a unique MAC address to every GX3 based devices 50 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 ...

Page 4: ...SB Device Descriptors Node ID etc GX3 driver software can use the Read EEPROM and Write EEPROM vendor commands to read write the serial EEPROM in 16 bit data word During power on the GX3 first checks if the EEPROM data is valid or not If EEPROM data is invalid GX3 will auto load the internal memory default settings inside chip hardware to communicate with USB host controller during enumeration The...

Page 5: ...3 EEPROM Programming User Guide 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 ...

Page 6: ...of GX3 Vender ID VID B4 04 Cypress VID Flag Remote Wakeup and PME setting etc 73 Enable the remote wakeup and Low Power WOL function Note 1 Max Power for Bus powered configuration 3E 496mA for USB 3 0 248mA for USB 2 0 Note 2 Max Power for Self powered configuration 01 8mA for USB 3 0 4mA for USB 2 0 Note 2 Length of Product String 03 Product String Length Note 3 Length of Manufacturer String 07 M...

Page 7: ...0E 2D 16 41 58 38 38 0x10 31 37 39 00 00 00 00 00 00 00 00 00 00 00 00 00 0x18 00 00 00 00 41 53 49 58 20 45 6C 65 63 2E 20 43 0x20 6F 72 70 2E 00 00 00 00 00 00 00 00 30 30 30 30 0x28 30 30 30 30 30 30 30 30 30 31 05 0F 16 00 02 07 0x30 10 02 02 00 00 00 0A 10 03 00 0E 00 01 01 65 00 0x38 00 00 00 00 00 00 00 00 F3 FF 40 4A 40 00 40 30 0x40 0D 49 90 41 C1 BD FF FF FF FF FF FF FF FF FF FF 0x48 FF ...

Page 8: ...B 2 0 Length of Product String 0Ah High byte 03 Product String Length Length of Manufacturer String 0Bh High byte 07 Manufacturer String Length Length of Serial Number String 0Ch High byte 0E Serial Number String Length Product String Max 24 bytes 0Eh 19h 41 58 33 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 GX3 Manufacture String Max 24 bytes 1Ah 25h 43 79 70 72 65 73 73 00 00 0...

Page 9: ... PID VID EEPROM Checksum Settings Note the EEPROM Checksum field should be changed together with the VID PID fields The value of EEPROM Checksum MUST be equal to 0xFF SUM EEPROM offset 03h 04h If SUM EEPROM offset 03h 04h has carry please add 1 to its result Please refer to Section 5 1 for details Note 3 Flag Remote Wakeup Settings The RWU bit of EEPROM offset 05h Flag field is used to configure t...

Page 10: ...t 07h for bus powered field and high byte of GX3 EEPROM offset 07h for self powered field are used to configure the bMaxPower field of Standard Configuration Descriptor that will be reported to the USB host controller when the 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 speci...

Page 11: ...it4 Bit3 Bit2 Bit1 Bit0 LED1_100 LED1_10 LED1_Active LED0_Duplex LED0_1000 LED0_100 LED0_10 LED0_Active Bit15 Bit14 Bit13 Bit12 Bit11 Bit10 Bit9 Bit8 1 LED2_Duplex LED2_1000 LED2_100 LED2_10 LED2_Active LED1_Duplex LED1_1000 Note Bit 15 must be 1 to enable the LED_mode setting otherwise it will work at default LED mode The LED mode table is as below bit 4 3 2 1 0 Description of indication LED_0 Fu...

Page 12: ...tive 0 1 1 0 0 Link 1000 100 0 1 1 0 1 Link 1000 100 Active 0 1 1 1 0 Link 1000 100 10 Default 0 1 1 1 1 Link 1000 100 10 Active 1 0 0 0 0 Full duplex bit 14 13 12 11 10 Description of indication LED_2 Full duplex Link speed Mbps Active TX RX 1000 100 10 0 0 0 0 0 USB3 0 Super Speed It keeps radiating when device operated at USB3 0 Super Speed 0 0 0 0 1 Active 0 0 0 1 0 Link 10 0 0 0 1 1 Link 10 A...

Page 13: ...er speed and keep flashing when device is receiving transmitting packets Table 5 LED Mode Setting Table Note 7 BOS type Descriptor Settings 1 EEPROM BOS type Descriptor Settings Offset address 2D 3Bh Please write these 30 bytes of EEPROM BOS type Descriptor with hexadecimal from low bytes to high bytes 05 0F 16 00 02 07 10 02 02 00 00 00 0A 10 03 00 0E 00 01 01 65 00 00 00 00 00 00 00 00 00 Note 8...

Page 14: ...te 9 Software Field EEPROM 43h 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 ...

Page 15: ...dat EEPROM Content Data File This file will be auto created after running the tool CYUSB3610Test sys GX3 Windows test driver CYUSB3610Test inf GX3 Windows test driver INF file Serial MAC log GX3 EEPROM Programming Log file Table 6 GX3 EEPROM Programming Tool Files Description Note 1 Please uninstall the standard GX3 Windows driver first if it had been installed before 2 Please install CYUSB3610 Wi...

Page 16: ... 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 Click Yes button to allow launching the EEPROM Programming Tool Figure 1 Run as administrator for GX3...

Page 17: ...17 Copyright C 2011 2012 Reserved by Cypress Semiconductor Corporation GX3 EEPROM Programming User Guide Figure 2 Allow User Account Control UAC for EEPROM Programming Tool ...

Page 18: ...sage window and save into the SROM DAT file 3 Save Save the EEPROM content and the SROM tool configuration setting into the SROM DAT and EEPROM DAT files respectively 4 Load EEPROM Load the SROM tool configuration setting from the EEPROM DAT file 5 Load SROM Load the EEPROM content from the selected SROM data file e g SROM DAT 6 Preview Preview the coming programmed EEPROM content 7 Convert to Bin...

Page 19: ...ax length of Product String is 24 characters 5 ID Set Vendor ID and Product ID Cypress s default Vendor ID is 04B4h GX3 s default Product ID is 3610h 6 Bus Powered Self Powered Set Max Power of Super Speed High Speed Full Speed modes The following are the default Max Power at GX3 USB Super High Full Speed mode 7 Characteristics Set the Flag field of EEPROM Please refer to Section 4 of GX3 datashee...

Page 20: ...3 3 2 Tool Usage Procedures The following are the test procedures of Windows GX3 EEPROM Programming Tool 1 Please uninstall the standard GX3 Windows driver first if it had been installed before 2 Check if GX3 Windows test driver was installed properly Figure 4 Windows Test Driver in Windows Device Manager ...

Page 21: ...EPROM Programming tool Figure 5 GX3 EEPROM Programming Tool Main Page 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 ...

Page 22: ...hat match your GX3 application s configuration for example VID PID MAC Address Serial Number Manufacture Product String LED Setting etc 5 Press Program button to start programming GX3 SROM data into EEPROM The test results will be displayed in the Result window after programming EEPROM completely A big green O shown on Result s pane means successful and a big red X shown on Result s pane means fai...

Page 23: ...23 Copyright C 2011 2012 Reserved by Cypress Semiconductor Corporation GX3 EEPROM Programming User Guide Figure 6 GX3 EEPROM Tool Programming Result ...

Page 24: ...tall the standard GX3 Windows driver first if it had been installed before 2 Install the GX3 Windows test driver and ensure it is indeed a Windows Test Driver shown in Windows Device Manager ex Cypress GX3 SuperSpeed to Gigabit Ethernet Adapter Test Driver 3 Delete the previous EEPROM DAT and SROM DAT files located in the same folder before running the tool 4 Run the GX3_EEPROM_Programming exe Win...

Page 25: ...Cypress Semiconductor Corporation GX3 EEPROM Programming User Guide 8 Configure proper EEPROM setting such as VID PID MAC address Serial Number etc Figure 8 GX3 Tool EEPROM Setting 9 Press the Program button to start programming the EEPROM ...

Page 26: ...owing procedures to compare the programmed SROM data with the recommended SROM data to check if you had programmed the EEPROM as expected a Press the Dump button to dump the programmed EEPROM content into the 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 DA...

Page 27: ...in function to convert the SROM data file SROM DAT to a binary file SROM BIN for universal programmer 1 Press the Convert to Bin button to select a proper SROM DAT file and then click Open button to start converting the SROM DAT file into the binary file 2 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 con...

Page 28: ...ight C 2011 2012 Reserved by Cypress Semiconductor Corporation GX3 EEPROM Programming User Guide 3 Now you can find the SROM binary file SROM BIN in the same folder of the SROM DAT file for universal programmer ...

Page 29: ...tion This tool is used for testing GX3 USB 3 0 to Gigabit products This tool supports to send receive packets in different Ethernet speed modes and program EEPROM This tool must be run on a Windows PC which installs the GX3 Windows test driver 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 produ...

Page 30: ...CYUSB3610Test INF GX3 Windows test driver INF file Table 9 Windows Production Test Tool Files Description Note 1 Please uninstall the standard GX3 Windows driver first if it had been installed before 2 If your GX3 board has your own VID PID please refer to Section 4 5 for more details 3 If you had programmed the EEPROM content on your GX3 device please refer to Section 4 6 for more details 4 Pleas...

Page 31: ...ms When execute the Windows Production Test Tool on Windows 8 7 Vista users need to run with Administrator authority otherwise you might see below error messages after pressing the START button 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 ...

Page 32: ... Run as administrator After that a User Account Control pop up window will be displayed on screen to tell you an unidentified program wants access to your computer 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 ...

Page 33: ...er will be compared 4 100Mbps Half Duplex Test This test will let network auto negotiates at 100Mbps Half Duplex and then starts sending packets to test server Every packet received from test server will be compared 5 10Mbps Full Duplex Test This test will let network auto negotiates at 10Mbps Full Duplex and then starts sending packets to test server Every packet received from test server will be...

Page 34: ... results 2 Result Displays final test result O PASS means SUCCESS and X FAIL means FAIL The error message will be displayed in the Error Message window if the test is failure 3 Error Message Displays the error messages when the test result is failure 4 START button Starts running all Production Test items 5 Exit button Quit this program Table 10 Windows Production Test Tool Test tab Note Please do...

Page 35: ...ver IP address TCP UDP packet type and port number settings of Windows 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 ...

Page 36: ... Current Maximum Serial Number and Increment of Serial Number The Current Serial Number should be smaller than the Max Serial Number The incremental value is 0 9 0 means non increased Serial Number after programming 5 Reload Check Reload box to auto reload EEPROM after programming EEPROM 6 Auto Writing Check Auto Writing box to auto program EEPROM after unplugging re plugging GX3 dongles Note that...

Page 37: ...37 Copyright C 2011 2012 Reserved by Cypress Semiconductor Corporation GX3 EEPROM Programming User Guide Figure 14 Windows Production Test Tool Dump Preview SROM Data ...

Page 38: ...rogram Note 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 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 Figure 15 Windows Production Test Tool Setting Tab Ethernet Set...

Page 39: ...onse or error packet count Ping Test Packet Length Enter the data length 1 65500 bytes of ping command Ping Test Packet Number Enter the packet number for ping test Ethernet Test Item Select button Select Production Test items Loopback Setting Destination IP Enter a different IP address from the IP address of GX3 Windows test driver but at the same subnet Packet Number Enter the packet number for ...

Page 40: ...conductor Corporation GX3 EEPROM Programming User Guide the 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 Table 12 Windows Production Test Tool Setting tab ...

Page 41: ...ollowing is the user interface of Log tab of Windows Production Test program Figure 17 Windows Production Test Tool Log Tab Field Field Name Description 1 Event Log Display test log 2 Clear button Clear the test log strings in the Event Log window 3 Exit button Quit this program Table 13 Windows Production Test Tool Log tab ...

Page 42: ...nterface of Windows Production Test Server program Figure 18 Windows Production Test Server Setting The Windows Production Test Server setup procedures 1 Configure a proper IP address e g 192 168 0 1 for Server PC s NIC card 2 Set a correct IP address e g 192 168 0 1 of Server PC in the Host Address field 3 Select TCP or UDP packet type in the Setting field and set a correct port number of TCP or ...

Page 43: ...test driver GX3_TEST SYS was installed properly on Test PC Please refer to Figure 4 for details 3 Configure a proper IP address for GX3 Windows test driver on Test PC Note The IP address e g 192 168 0 100 of GX3 Windows test driver should be configured to the same subnet as the 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...

Page 44: ...emiconductor Corporation GX3 EEPROM Programming User Guide 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 ...

Page 45: ...press Semiconductor Corporation GX3 EEPROM Programming User Guide 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 ...

Page 46: ...46 Copyright C 2011 2012 Reserved by Cypress Semiconductor Corporation GX3 EEPROM Programming User Guide ...

Page 47: ...EST inf It is supposed the VID is 1234h and PID is 5678h Cypress GX3 USB 3 0 2 0 to Gigabit Ethernet Adapter Test Driver Copyright 2014 2015 Cypress Semiconductor Corporation Version 1 104 5 0 for Windows 32 bit Version Signature Windows NT CatalogFile CYUSB3610Test cat Class Net ClassGUID 4d36e972 e325 11ce bfc1 08002be10318 Provider Cypress DriverVer 03 17 2015 1 104 5 0 Manufacturer CYPRESS USB...

Page 48: ...to your device s EEPROM by using Windows GX3 EEPROM Programming Tool or universal I O Programmer before using the Windows Production Tool Under this circumstance to prevent programming EEPROM twice and save time click 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 ...

Page 49: ...D Cypress would like to request customers to inform Cypress sales staffs by sending us email at sales cypress com beforehand if you would like to use Cypress VID and PID for your products In other words if your GX3 based application system requires you to modify GX3 driver on your own or by Cypress support team you might have to register your own VID and PID This can avoid your end customers from ...

Page 50: ...ter a block of MAC addresses for your company 5 2 2 How to register a MAC Ethernet address from IEEE SA You must first have an OUI or an IAB to which you then append 24 or 12 bits respectively in a way that makes the resulting 48 bit number unique i e your 24 or 12 bits must be unique within your organization which will require coordination among all the users of your organization s OUI or IAB Ple...

Reviews:

No comments