Cypress Semiconductor GX3 EEPROM Assembly instructions

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

2
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
Table of Contents
1. Introduction............................................................................................4
2. EEPROM Memory Map........................................................................4
2-1. EEPROM Format..............................................................................................4
2-2. 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......................................................................................................................16
3-3. GX3 EEPROM Programming ........................................................................18
3-3-1. Function Description................................................................................18
3-3-2. Tool Usage Procedures............................................................................20
3-3-3. How to Load Recommended SROM Data File.........................................24
3-3-4. How to Convert SROM Data 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
4-5. How to Run Windows Production Test Tool If I Have My Own VID/PID?.47
4-6. Skip to Program EEPROM again on Windows Production Test Tool...........48
5. GX3 EEPROM FAQs ..........................................................................49
5-1. The Vendor ID (VID) and Product ID (PID) .................................................49
5-1-1. Do we need to register our own VID/PID for our GX3 based application
systems or can we use the Cypress VID/PID? .........................................49
5-1-2. How to register a Vendor ID from USB-IF?............................................50
5-2. The MAC address...........................................................................................50

3
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 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

4
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
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. 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 default settings inside chip
facilitate users to update the EEPROM content through a Windows PC during R&D validation
process or program a blank EEPROM during manufacturing process.
Please refer to Section 4 of GX3 datasheet for detailed description of the EEPROM contents.

5
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 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

6
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
2-2. Internal Memory Default Settings
The GX3 internal memory default settings are fixed by hardware and can’t be modified.
Below table shows GX3’s internal memory default settings being used in the case of blank
EEPROM or EEPROM with wrong checksum value or 1st byte is “0xFF”on board.
Field Definition
Default Values
Description
Node ID
00 0E C6 F9 D0 00
Node ID 0 ~ 5
Product ID (PID)
10 36
PID 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
Manufacturer String
Length (Note 3)
Product String
(Max. 12 bytes)
41 58 33 00 00 00 00 00 00 00 00 00
“GX3”
Manufacture String
(Max. 10 bytes)
43 79 70 72 65 73 73 00 00 00
“Cypress”
Fixed Pattern
40 4A 40 00 40 30 0D 49 90 41
Fixed pattern to be
written
Table 2. Internal Memory Default Settings Descriptions

7
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
2-3. Recommended EEPROM Settings
Below table shows the typical EEPROM settings. For this kind of applications, the EEPROM
part, 93C56 with 128*16 bits of storage space is sufficient while 93C66 is also acceptable.
Each of the address offset contains 16-bit data from left to right representing the low-byte and
high-byte, respectively. For example, in offset address 0x08, the ‘80’is low-byte data and the
‘0B’is high-byte data.
Offset
0
1
2
3
4
5
6
7
Address
8
9
A
B
C
D
E
F
0x00
00 00
00 00
00 01
90 17
95 0B
B7 73
00 E0
3E 01
0x08
80 0B
09 04
0E 07
1A 10
26 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 FF
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
0x50
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
0x58
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
0x60
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
0x68
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
0x70
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
FF FF
0x78
FF FF
FF FF
FF FF
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

8
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
Field Definition
Address
Offset
Default Values
Description
Node ID
00h ~02h
00 00 00 00 00 01
Node ID 0 ~ 5
(Note 1)
Product ID (PID)
03h
10 36
The PID of GX3 is 0x3610
Vender ID (VID)
04h
B4 04
CYPRESS’s VID is 0x04B4
Checksum
05h
(Low byte)
E0
0xFF - SUM [EEPROM offset 03h ~
04h]
Flag
05h
(High byte)
73
Enable the “remote wakeup” and Low
Power WOL function
Max Power for
Bus Power
07h
(Low byte)
3E
496mA for USB 3.0
248mA for USB 2.0
Max Power for
Self Power
07h
(High byte)
01
8mA for USB 3.0
4mA for USB 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 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
“Cypress.”
Serial Number String
(Max. 14 bytes)
26h~2Ch
30 30 30 30 30 30 30 30
30 30 30 30 30 31
“00000000000001”
LED Mode
42h
C1 BD
Refer to Note 7 in Section 2.5 for
details
Software Field
43h
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

9
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
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.
For example, if MAC address = 00-23-45-67-89-AB, then Node ID 0 = 00h, Node ID 1 =
23h, Node ID 2 = 45h, Node ID 3 = 67h, Node ID 4 = 89h, and Node ID 5 = ABh.
Note that the Node ID value cannot be set to multicast MAC address (i.e. the 1st bit of MAC
address is set to “1”). If the 1st byte of Node ID value of EEPROM was set to “0xFF”, the
GX3 will auto-detect the programmed EEPROM as blank EEPROM
Note 2: 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 the “bmAttributes”
field of Standard Configuration Descriptor that will be reported to the USB host controller
when the GET_DESCRIPTOR command with CONFIGURATION type is issued. Please
refer the “Section 9.6.3 Configuration”of Universal Serial Bus 3.0 Spec for the detailed
description of the “bmAttributes”field of Standard Configuration Descriptor.
The USB device power mode (bus-powered or self-powered) is decided by the SELF_PWR
pin when chip powers on. This will updated to the “bmAttributes”field of Standard
Configuration Descriptor.

10
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
Note 4: Max Power Settings
The unit of EEPROM “Max. Power”fields is 8mA at super-speed mode and is 4mA at high-
speed mode.
The low byte of EEPROM offset 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 specific configuration when the device is fully operational.

11
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
Note 5: Product/Manufacturer/Serial Number String Settings
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.
Note 6: LED Mode Settings
It’s to define the indication setting for LED_0/1/2/3 function of MFA_0/1/2/3 pins.
Bit 7~Bit 0: LED_Mode_LB; Bit 15~Bit 8: LED_Mode_HB
Bit7
Bit6
Bit5
Bit4
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
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 (Default)
0
0
0
1
0
Link 10
0
0
0
1
1
Link 10+Active
0
0
1
0
0
Link 100
0
0
1
0
1
Link 100+Active
0
0
1
1
0
Link 100/10
0
0
1
1
1
Link 100/10+Active
0
1
0
0
0
Link 1000
0
1
0
0
1
Link 1000+Active
0
1
0
1
0
Link 1000/10
0
1
0
1
1
Link 1000/10+Active
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
0
1
1
1
1
Link 1000/100/10+Active
1
0
0
0
0
Full duplex

12
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
bit
9
8
7
6
5
Description of indication
LED_1
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+Active
0
0
1
0
0
Link 100
0
0
1
0
1
Link 100+Active
0
0
1
1
0
Link 100/10
0
0
1
1
1
Link 100/10+Active
0
1
0
0
0
Link 1000
0
1
0
0
1
Link 1000+Active
0
1
0
1
0
Link 1000/10
0
1
0
1
1
Link 1000/10+Active
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+Active
0
0
1
0
0
Link 100
0
0
1
0
1
Link 100+Active
0
0
1
1
0
Link 100/10
0
0
1
1
1
Link 100/10+Active
0
1
0
0
0
Link 1000
0
1
0
0
1
Link 1000+Active
0
1
0
1
0
Link 1000/10
0
1
0
1
1
Link 1000/10+Active
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
0
1
1
1
1
Link 1000/100/10+Active (Default)
1
0
0
0
0
Full duplex

13
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
bit
4
3
2
1
0
Description of indication
LED_3
Full duplex
Link speed(Mbps)
Active
(TX/RX)
1000
100
10
0
0
0
0
1
USB3.0 Super Speed: The LED_0
mode MUST be set to “Active”
only when the LED_3 is used.
It will radiate when device
operated at USB3.0 super 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: 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”.

14
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
Note 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.

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.

16
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
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. Click Yes button to allow launching the EEPROM
Programming Tool.
Figure 1. Run as administrator for GX3 EEPROM Programming Tool

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

18
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
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
1
Program
Start programming the EEPROM.
2
Dump
Dump the EEPROM content to the message 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
Convert the SROM data file (SROM.DAT) to binary file (SROM.BIN)
for universal programmer
8
Erase EEPROM
Erase all the EEPROM contents
Table 7. GX3 Programming Tool EEPROM Programming Buttons

19
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
Field #
Field Name
Description
1
Disable Setting
Disable all input fields except Program to prevent error operation during mass
production.
2
Mac Address
Set Current/Maximum MAC Address and Incremental value of MAC Address:
The Current MAC Address should be smaller than the Max MAC Address.
The incremental value is 0 ~ 9. “0” means non-incremental MAC address after
programming.
3
Serial Number
Set Current/Maximum Serial Number and Incremental value 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.
The "Based on Mac Address" check box in the Serial Number field is used to
assign the Serial Number field based on the MAC Address field value.
4
String
Set Manufacturer String and Product String in ASCII text:
The max length of Manufacture String is 24 characters.
The max 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 datasheet for details.
8
LED Setting
Set LED0/LED1/LED2 functionalities:
Please refer to “Note 7: LED Mode Settings”in Section 4 for details.
9
Reload
Reload EEPROM after programming EEPROM:
Imitate the scenario of detaching/re-attaching demo board after programming
EEPROM. The MAC Address will be updated immediately in Windows
System without un-plugging/re-plugging the demo board if Reload EEPROM
box is checked.
10
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.
Table 8. GX3 Programming Tool EEPROM Programming Configuration Fields

20
Copyright (C) 2011-2012 Reserved by Cypress Semiconductor Corporation
GX3 EEPROM Programming User Guide
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