10 and 40 gbit/s serdes transceiver multi source€¦ · web view10 and 40 g application layer...

Description

This technical document has been created by the 300PIN MSA group. This document is offered to transponder users and suppliers as a basis for a technical agreement. However it is not a warranted document, each transponder supplier will have their own datasheet. If the user wishes to find a warranted document, they should consult the datasheet of the chosen transponder supplier.

The MSA group reserves the rights at any time to add, amend, or withdraw technical data contained in this document.

MSA Group Contacts

TriQuint Optoelectronics Genji Tohmon [email protected] Technologies Dan Rausch [email protected] Optronics Patrice Durand [email protected] Technology Peter Dartnell [email protected] Gregg Cockroft [email protected] Quantum Devices Masahiro Kobayashi [email protected] Uniphase Jeff Rollman [email protected] Electric Shinji Shibao [email protected] Tetsuyuki Suzaki [email protected] OpNext Atsushi Takai [email protected]

10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 G

I2C Public Document Edition 4

I2C REFERENCE DOCUMENT FOR 300PIN 10G and 40G TRANSPONDER

No changes are allowed to this documentA printed version of this document is an uncontrolled copy

/8704-AUG-03

I2C REFERENCE DOCUMENT

FOR 300 PIN MSA 10G and 40G TRANSPONDER

mailto:[email protected]










CAUTION: Components within the scope of this 10Gbit/s and 40Gbit/s SERDES TRANSCEIVER are sensitive to electrostatic discharges and should not be handled except at a static free workstation. Invisible laser radiation, avoid direct exposure to beam.

TABLE OF CONTENTS

1 SCOPE........................................................................................................................7

2 DATA LINK BASIS......................................................................................................82.1 PHYSICAL LAYER AND DATA LINK LAYER.....................................................................8

2.1.1 Mechanical Interface..................................................................................................... 82.1.2 Electrical Interface........................................................................................................ 8

2.1.2.1 SCL/SDA.......................................................................................................................................................... 82.1.2.2 Address............................................................................................................................................................. 8

2.1.3 Functional and Procedural Definitions..........................................................................92.1.4 Message Frame............................................................................................................. 92.1.5 ACK/NAK Process....................................................................................................... 102.1.6 Device Addressing....................................................................................................... 10

2.1.6.1 Standard Mode................................................................................................................................................ 102.1.6.2 Enhanced Mode...............................................................................................................................................10

2.1.7 Bus Mastering.............................................................................................................. 102.1.8 Flow Control............................................................................................................... 102.1.9 Error Handling............................................................................................................ 11

2.1.9.1 Transponder NAK of Host Byte.......................................................................................................................112.1.9.2 Host Timeout................................................................................................................................................... 11

2.2 TRANSPORT LAYER...................................................................................................112.2.1 Data Checking............................................................................................................. 11

2.2.1.1 Command Check Byte Calculation..................................................................................................................122.2.1.2 Reply Check Byte Calculation.........................................................................................................................12

2.2.2 Data Exchange Basis................................................................................................... 132.2.3 Status Replying............................................................................................................ 13

2.2.3.1 Command Processed Number (CPN)...............................................................................................................132.2.3.2 Module Status Definition.................................................................................................................................15

2.2.4 Response Retention and Retransmission......................................................................172.3 APPLICATION LAYER BEHAVIOR.................................................................................17

2.3.1 Bit Mapping................................................................................................................. 172.3.2 Protection.................................................................................................................... 172.3.3 Module Reset............................................................................................................... 172.3.4 Interrupt Request Pin Operation..................................................................................18

2.3.4.1 Logical OR IRQ Operation..............................................................................................................................182.3.4.2 Edge IRQ Operation........................................................................................................................................18

2.3.5 Command Execution and Information Latency Times..................................................212.3.5.1 Command Execution Time Definition..............................................................................................................212.3.5.2 Information Latency Time Definition..............................................................................................................22





/8704-AUG-03

2.3.6 Operation Modes (10Gb Only)....................................................................................222.3.6.1 Hardware Control & Status Mode Modules......................................................................................................222.3.6.2 Pin Control Mode Modules..............................................................................................................................222.3.6.3 Soft Control Mode Modules.............................................................................................................................222.3.6.4 Pin/Soft Control Mode Switchable Modules....................................................................................................22

3 10GB APPLICATION LAYER COMMANDS.............................................................243.1 MSA PART...............................................................................................................27

3.1.1 Command Codes.......................................................................................................... 273.1.1.1 Set TX Command Register..............................................................................................................................273.1.1.2 Read TX Command Register...........................................................................................................................293.1.1.3 Save TX Command Register .........................................................................................................................293.1.1.4 Restore TX Command Register .....................................................................................................................293.1.1.5 Set RX Command Register..............................................................................................................................293.1.1.6 Read RX Command Register...........................................................................................................................313.1.1.7 Save RX Command Register .........................................................................................................................313.1.1.8 Restore RX Command Register .....................................................................................................................313.1.1.9 Set Laser ITU Channel...................................................................................................................................313.1.1.10 Read Laser ITU Channel.............................................................................................................................323.1.1.11 Set Receive Decision Threshold .................................................................................................................323.1.1.12 Read Receive Decision Threshold................................................................................................................33

3.1.2 Measurement Codes..................................................................................................... 333.1.2.1 Laser Bias Current Monitor.............................................................................................................................333.1.2.2 Laser Output Power Monitor............................................................................................................................333.1.2.3 Laser Temperature Monitor.............................................................................................................................343.1.2.4 Receiver Signal Monitor AC Optical Power.....................................................................................................343.1.2.5 Receiver Signal Monitor Average Optical Power.............................................................................................343.1.2.6 Laser Wavelength Monitor...............................................................................................................................353.1.2.7 Transponder Temperature Monitor..................................................................................................................353.1.2.8 Photodiode Temperature Monitor....................................................................................................................353.1.2.9 Modulator Bias Monitor..................................................................................................................................363.1.2.10 Laser Output Power Monitor (in dBm).........................................................................................................363.1.2.11 Receiver Signal Monitor Average Optical Power (in dBm)..........................................................................37

3.1.3 Alarm Codes................................................................................................................ 383.1.3.1 Read TX Alarm Status Register.......................................................................................................................383.1.3.2 Read RX Alarm Status Register.......................................................................................................................403.1.3.3 Read Power Supply Alarm Register.................................................................................................................403.1.3.4 Set Rx Interrupt Alarm Mask Register.............................................................................................................413.1.3.5 Read Rx Interrupt Alarm Mask Register..........................................................................................................423.1.3.6 Set Tx Interrupt Alarm Mask Register.............................................................................................................423.1.3.7 Read Tx Interrupt Alarm Mask Register..........................................................................................................433.1.3.8 Set Power Supply Alarm Mask Register...........................................................................................................433.1.3.9 Read Power Supply Alarm Mask Register........................................................................................................443.1.3.10 Read Summary Alarm Register....................................................................................................................443.1.3.11 Interrupt Control.........................................................................................................................................44

3.1.4 Identifier Codes........................................................................................................... 453.1.4.1 Read Supplier Identifier Code..........................................................................................................................453.1.4.2 Read Module Type Code.................................................................................................................................463.1.4.3 Read Customer Parameters..............................................................................................................................463.1.4.4 Write Customer Parameters.............................................................................................................................473.1.4.5 Read First Laser ITU Channel.........................................................................................................................473.1.4.6 Read Last Laser ITU Channel..........................................................................................................................483.1.4.7 Read Laser ITU Channel Spacing....................................................................................................................483.1.4.8 Read Revision Codes.......................................................................................................................................483.1.4.9 Read Unit Serial Number.................................................................................................................................493.1.4.10 Read Unit Manufacture Date.......................................................................................................................493.1.4.11 Read Unit Part Number...............................................................................................................................50

3.1.5 Configuration Codes.................................................................................................... 503.1.5.1 Read Link Status..............................................................................................................................................503.1.5.2 Enter Pin Control Mode .................................................................................................................................51





/8704-AUG-03

3.1.5.3 Read Maximum I2C Rate................................................................................................................................513.1.5.4 Enter Protected Mode......................................................................................................................................513.1.5.5 Exit Protected Mode........................................................................................................................................523.1.5.6 Reset CPN....................................................................................................................................................... 523.1.5.7 Enter Soft Mode ............................................................................................................................................523.1.5.8 Read Edition and Mode...................................................................................................................................533.1.5.9 Data Loopback................................................................................................................................................53

3.2 SUPPLIER RESERVED COMMANDS .........................................................................53

4 40G APPLICATION LAYER COMMANDS...............................................................544.1 MSA PART...............................................................................................................57

4.1.1 Command Codes.......................................................................................................... 574.1.1.1 Set TX Command Register..............................................................................................................................574.1.1.2 Read TX Command Register...........................................................................................................................594.1.1.3 Save TX Command Register .........................................................................................................................594.1.1.4 Restore TX Command Register .....................................................................................................................594.1.1.5 Set RX Command Register..............................................................................................................................604.1.1.6 Read RX Command Register...........................................................................................................................624.1.1.7 Save RX Command Register .........................................................................................................................624.1.1.8 Restore RX Command Register .....................................................................................................................624.1.1.9 Deleted............................................................................................................................................................624.1.1.10 Set Laser ITU Channel...............................................................................................................................624.1.1.11 Read Laser ITU Channel.............................................................................................................................634.1.1.12 Set Receive Decision Threshold .................................................................................................................634.1.1.13 Read Receive Decision Threshold................................................................................................................644.1.1.14 Set DEMUX Phase Offset...........................................................................................................................644.1.1.15 Read DEMUX Phase Offset.........................................................................................................................644.1.1.16 Set Configurable Alarm...............................................................................................................................654.1.1.17 Read Configurable Alarm............................................................................................................................65

4.1.2 Measurement Codes..................................................................................................... 664.1.2.1 Laser Bias Current Monitor.............................................................................................................................664.1.2.2 Laser Output Power Monitor............................................................................................................................664.1.2.3 Laser Temperature Monitor.............................................................................................................................664.1.2.4 Receiver Signal Monitor AC Optical Power.....................................................................................................674.1.2.5 Receiver Signal Monitor Average Optical Power.............................................................................................674.1.2.6 Laser Wavelength Monitor...............................................................................................................................674.1.2.7 Transponder Temperature Monitor..................................................................................................................684.1.2.8 Photodiode Temperature Monitor....................................................................................................................684.1.2.9 Modulator Bias Monitor..................................................................................................................................684.1.2.10 Read Error Checker Error Count.................................................................................................................694.1.2.11 Laser Output Power Monitor (in dBm).........................................................................................................694.1.2.12 Receiver Signal Monitor Average Optical Power (in dBm)..........................................................................69

4.1.3 Alarm Codes................................................................................................................ 704.1.3.1 Read TX Alarm Status Register.......................................................................................................................704.1.3.2 Read RX Alarm Status Register.......................................................................................................................714.1.3.3 Read Power Supply Alarm Status Register.......................................................................................................724.1.3.4 Set Rx Interrupt Alarm Mask Register.............................................................................................................734.1.3.5 Read Rx Interrupt Alarm Mask Register..........................................................................................................734.1.3.6 Set Tx Interrupt Alarm Mask Register.............................................................................................................744.1.3.7 Read Tx Interrupt Alarm Mask Register..........................................................................................................754.1.3.8 Set Power Supply Alarm Mask Register...........................................................................................................754.1.3.9 Read Power Supply Alarm Mask Register........................................................................................................754.1.3.10 Read Summary Alarm Register....................................................................................................................754.1.3.11 Interrupt Control.........................................................................................................................................76

4.1.4 Identifier Codes........................................................................................................... 764.1.4.1 Read Supplier Identifier Code..........................................................................................................................764.1.4.2 Read Module Type Code.................................................................................................................................774.1.4.3 Read Customer Parameters..............................................................................................................................784.1.4.4 Write Customer Parameters.............................................................................................................................784.1.4.5 Read First Laser ITU Channel.........................................................................................................................78





/8704-AUG-03

4.1.4.6 Read Last Laser ITU Channel..........................................................................................................................794.1.4.7 Read Laser ITU Channel Spacing....................................................................................................................794.1.4.8 Read Revision Codes.......................................................................................................................................804.1.4.9 Read Unit Serial Number.................................................................................................................................804.1.4.10 Read Unit Manufacture Date.......................................................................................................................814.1.4.11 Read Unit Part Number...............................................................................................................................81

4.1.5 Configuration Codes.................................................................................................... 814.1.5.1 Read Link Status..............................................................................................................................................814.1.5.2 No Operation ................................................................................................................................................ 824.1.5.3 Read Maximum I2C Rate................................................................................................................................824.1.5.4 Enter Protected Mode......................................................................................................................................824.1.5.5 Exit Protected Mode........................................................................................................................................834.1.5.6 Reset CPN....................................................................................................................................................... 834.1.5.7 Read Edition and Mode...................................................................................................................................834.1.5.8 Data Loopback................................................................................................................................................84

4.2 Supplier Reserved Commands ...........................................................................84





/8704-AUG-03

HISTORY

Edition 1: February 14, 2002Creation -- Never Released

Edition 2: April 19, 2002Reorganized to prepare for 40 Gbps additions

Edition 3: July 24, 2002Corrections and clarifications, delete future broadcast capability, update several 10 Gbps commands, add 40 Gbps commands

Edition 4: August 4, 2003Style and grammar improvements including some paragraph renumbering; clarifications; relaxation of timing (Sections 2.1.2.1, 2.1.8, 2.1.9.1, and 2.1.9.2); clarified CPN text (Section 2.2.3.1); added “Command Failed” status (Section 2.2.3.2); added IRQ section and edge IRQ capability (Section 2.3.4); added definition of command execution and latency timing (Section 2.3.5); changed 10G operation modes (Section 2.3.6); added 10G commands (hex) 6A, 6B, 83 – 8A, A4 – AA, C7, and C8; added 40G commands (hex) 6A, 6B, 87 – 8A, A4 – AA, C7, and C8; added second byte of resolution to commands 0x4B and 4C; changed the returned units for command 0x64; updated supplier code list for MSA membership changes and non-member codes; redefined command 0xC1; allowed varied length passwords with command 0xC3; redefined command 0xC5; added (40G) additional clock control (cmd 0x40); deleted RXS from config. alarm list (40G).





/8704-AUG-03

1 SCOPE

This protocol is designed to be implemented over an I²C data link.

The protocol is made up of two segments:1. A MSA part, that describes the messages that are defined for all the modules

compliant with the MSA requirements;2. A vendor specific part that is made of an additional set of messages covering either

particular module features or complementary functions.

Additionally, some of the commands require entering a particular mode, called the “protected mode”, to become available. This feature is implemented in order to avoid either unsafe access to some commands (those that may alter the module function) or unauthorized access to vendor specific commands.

This specification is intended for use in low bit error rate situations (better than 10 -6). Physically, it is anticipated that the host processor will be on the same board or shelf as the transponder module(s). Use in situations with higher bit error rates is not recommended.

Note: the ‘C’ language prefix ‘0x’ is used throughout this document to indicate hexadecimal numbers.

Note: Some parts of this document are optional for vendors to implement. Optional items are noted with the use of italic text.





/8704-AUG-03

2 DATA LINK BASIS

For the remainder of the document, transfers from the Host to the transponder Module are noted by: HM. Bytes transferring from the Module to the Host are noted by: MH.

2.1 Physical Layer and Data Link Layer The physical layer complies with the Philips specifications as defined in the “I2C-Bus Specification, Version 2.1, January 2000”, and the “Reference Document for 300pin 10Gb Transponder”, or the “Reference Document for 300pin 40Gb Transponder” as appropriate.

2.1.1 Mechanical Interface The I2C mechanical interface is five pins within the 300 pin connector. The clock (SCL), data (SDA) and 3 address pins along with the remainder of the mechanical specification for the overall 300 pin connector is in accordance with the “Reference Document for 300pin 10Gb Transponder” or “Reference Document for 300pin 40Gb Transponder”.

2.1.2 Electrical Interface

2.1.2.1 SCL/SDA The following indications are just to point out some particular “I2C-Bus Specification” re-quirements to meet.

The system architecture calls for a wired-AND structure bus as described in Section 5 of the “I2C-Bus Specification”. This implies that each device on the bus has an open collector or open drain structure for transmitting on both the SDA and SCL lines. (Note: the clock receiver function needs the open collector for clock stretching as defined in the flow control section below). The bus, not the module, provides the pull-up resistors per Section 16.1 of the “I2C-Bus Specification”. The protective series resistors are not required but strongly recommended to be provided in the module. If used, R S is valued per Section 16.1 of the “I2C-Bus Specification”.

The bus operates in standard mode (100 kHz) or fast-mode (400 kHz). All transponders support 100 kHz operation and may or may not support 400 kHz operation. On the transponder, the I2C supply voltage is VDD1 as specified in the MSA Reference Document for 300pin 10Gb and 40Gb Transponders (3.3 Volts nominal). The interface between the transponder and the I2C bus meets the electrical and timing specification (for the appropriate mode) given in Section 15.1 of the “I2C-Bus Specification”.

Note that I2C bus can accommodate bus and/or the master running from a different supply voltage. See Section 18 of the “I2C-Bus Specification” for further information.

2.1.2.2 Address Address pins are positive true logic with voltage levels as defined in the MSA Reference Documents for 300pin 10Gb and 40Gb Transponders. 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

Unconnected address pins are pulled low to be at logical ‘0’.

2.1.3 Functional and Procedural Definitions The definitions of ‘1’ and ‘0’ levels are in accordance with Section 6 of the “I2C-Bus Specification”.

In order to separate logical messages, special start and stop conditions are created on the I2C bus. These conditions off load the module from sampling the bus when no activity is present or a message is addressed for another unit. The start and stop conditions are as defined in Section 6.2 of the “I2C-Bus Specification”.

As defined in Section 7.1 of the “I2C-Bus Specification”, the most significant bit of bytes are transmitted across SDA first.

2.1.4 Message Frame The messages are binary strings of variable length encapsulated by the I2C hardware link management.

The host module communication is broken down in two successive phases: 1. The host sends a message containing a command with its operands;2. The device always1 replies to this command when read by the host by sending a

message containing a status byte and required data.

The typical host command frame is as follows (standard addressing mode shown):

HM HM MH HM MH HM

start address + wr bit ack command issued by host ack … stop

- First byte:This is the I2C standard 7 bits slave address for the module plus wr bit.

- Following bytes:This is the message body, which contains the command.

The typical module reply frame is as follows:

HM HM MH MH HM MH HM HMstart address + rd bit ack returned data ack … last nak stop

- First byte:This is the I2C standard 7 bits slave address for the device plus rd bit (generated by the host).

- Following bytes:This is the message body, which contains the data returned by the module.

- Last byte:This byte is NAK’ed by the host indicating to the module that this is the last byte of transmission per “The I2C-Bus Specification” Section 7.2.

1There are exceptions to this rule listed in Section 2.1.9.1.10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

2.1.5 ACK/NAK Process Each byte transmission has an Acknowledge process at the I2C hardware level. The NAK is provided by the I2C hardware (or software emulator) in case of error.

2.1.6 Device Addressing Note that module’s address pins are sampled once at module reset. Any further change is not taken into account until the next module reset. This prevents unexpected address changes during operation. Also note that the “General Call” address as described in “The I2C-Bus Specification” is ignored by the module.

2.1.6.1 Standard Mode The standard mode is based on the I2C addressing capability: a device only responds to an I2C message when its own address and the address field of the I 2C frame match. The definition of the address is xxxxyyy. The four most significant bits, xxxx, are 1000 (allocated by Philips). The three least significant bits, yyy, are specific to an individual module and known as the I2C address offset. This allows up to 8 identical devices on a single physical link.

2.1.6.2 Enhanced Mode The enhanced mode is a superset of the I2C addressing capability. It allows up to TBD identical devices on a single logical link2. The implementation details of this addressing mode are to be determined in a later edition of this document.

2.1.7 Bus Mastering The transponders are connected to the bus as slaves. This means that the host controller is the bus master. According to the “I2C-Bus Specification”:1. The clock is provided by the host for both transmit and receive frames (this clock may

nevertheless be stretched to ground by any transponder, see next paragraph);2. Address + r/w byte, as well as start and stop bits are provided by the master.

2.1.8 Flow Control Should a host or slave not be able to operate at the full clock speed (momentarily or permanently), it is permitted to “stretch” SCL low to force wait time. Wait time generation is done in accordance with Section 8.3 in the “I2C-Bus Specification”. The Philips “I2C-Bus Specification” does not set a maximum limit on the wait time. Any one device should not be able to force an infinite wait time. Therefore, the following timing limitations are imposed on the transponders and the hosts.

The single bit clock cycle (rising edge to rising edge) for bits within a byte transfer must not exceed 100 μS.

2 The physical bus is actually limited to a maximum of 400 pF (typically 40 terminals) due to I2C device fan-out characteristics. A larger number of terminals can be logically connected to the same bus with proper external buffering.





/8704-AUG-03

The host or slave cannot hold SCL low for more than 15 ms under any circumstance (e.g., between bytes, START to first bit, last bit to STOP). Devices detecting this condition must reset so that they are prepared to issue/accept a start within 25 ms from the beginning of violating SCL low time.

Units are encouraged to operate as quickly as possible to allow maximum bus throughput.

2.1.9 Error Handling

2.1.9.1 Transponder NAK of Host Byte The transponder being consumed by a real time processing or a failure is the most likely cause of a NAK by a transponder. If a failure has occurred, a system level solution must be sought. In the case of a real time priority lock out of the I2C port, it is unknown how many bits of the current byte have been received. Since the overflow causes loss of byte synchronization, the entire message must be resent on a transponder NAK.

2.1.9.2 Host Timeout If the transponder detects a host timeout during a message, it no longer considers itself as being addressed and begins searching for a START condition. The host timeout pe-riod is defined in the flow control section (2.1.8) above as the maximum SCL low time.

2.2 Transport Layer

2.2.1 Data Checking Additional check processes are provided in order to ensure message consistency and find data errors.

The message frame is made of the following parts:1. A CMD byte (host module) which contains the code of the command to be executed

by the module, or a STS byte (module host) which contains the status of the module, giving information about the last received command completion status;

2. A LGTH byte which contains the length of the command parameters field (may be 0 to 18, inclusive);

3. An optional command/reply parameters field, which size and definition depends on the command (each command and response has its own size/definition for this field);

4. A CHK byte, which contains the message check byte.

Standard ModeThis frame allows a wide command set and reliable communication protocol in low bit error rate situations as indicated in chapter 1.

Command (from host to module, 0 LGTH 18):Command Length Command Parameters Field (0~18 bytes) Check byte

CMD LGTH DATA1 DATA2 … DATAn CHK





/8704-AUG-03

Reply (from module to host, 0 LGTH 18), issued either after command completion or error detection:

Status Length Reply Parameters Field (0~18 bytes) Check byte

STS LGTH DATA1 DATA2 … DATAn CHKBoth command and reply messages are at least 3 bytes long (Command/status + Length + Check byte).

Enhanced ModeTBD.

2.2.1.1 Command Check Byte Calculation

2.2.1.1.1 Standard Mode All bytes are XORed in order transferred then 1 is subtracted, starting from the I2C 7-bit address + wr bit and ending with the last byte prior to the check byte. Should the value of the XOR before the subtraction be 0, the result should be the two’s complement of –1 (0xFF). Example:

HM

ADDR CMD LGTH DATA DATA CHK0x80 0x44 0x02 0x03 0xFF 0x3

9Calculation (in hex): 80 44 02 03 FF = 3A – 1 = 39.

2.2.1.1.2 Enhanced Mode TBD.

2.2.1.2 Reply Check Byte Calculation

2.2.1.2.1 Standard Mode When the master performs a read of the slave, the check byte calculation is slightly more complex. All of the bytes transferred are subject to the check byte, regardless of direc -tion. The transponder starts it's check byte calculation with the 7-bit read address + rd bit it receives. It then proceeds to continue the XOR process across the status, length, and data bytes before transmitting the check byte.

The host knows what transponder address it sent and starts its check byte calculation with the 7-bit read address + rd bit it sent out. The host then proceeds to continue the XOR process across the received status, length, and data bytes. It can then compare its result to the received check word.

The check byte is calculated by XORing all bytes in order transferred then 1 is subtracted. Should the value of the XOR before the subtraction be 0, the result is the two’s complement of –1 (0xFF). Example (both host and module perform same calculation):

HM MH

ADDR STS LGTH DATA DATA CHK0x81 0x8

00x02 0x03 0xFF 0xFE





/8704-AUG-03

Calculation (in hex): 81 80 02 03 FF = FF – 1 = FE.

2.2.1.2.2 Enhanced Mode TBD.

2.2.2 Data Exchange Basis The serial link protocol is based on a handshake process, each command issued by the host being followed by a read of the same module after command execution completion. While a module is busy executing a command, the modules transport layer is unable to accept any further commands even though the lower layers may successfully receive the command. (See “Busy” status below.) The host may access other modules or I 2C devices while waiting for a command to complete execution.

2.2.3 Status Replying The module issues a Status Byte (STS) within its reply to a command.

2.2.3.1 Command Processed Number (CPN) The most significant bit of the status byte indicates the Command Processed Number (CPN). The CPN is loosely based upon the concept of the sliding window flow control protocol with a window size of one. The CPN alternates between zero and one with each successful message processed by the module. The CPN does not change state when an error status is sent to the host or when any reply is repeated to the host. In other words, every time that a status of “OK, Command Executed” is prepared by the module for sending to the host (excluding repeats), the CPN is toggled. It is not toggled again until another command has been received, successfully executed by the module, and the “OK, Command Executed” reply is being prepared.

The CPN is set to zero on module reset and on command. See application layer command “Reset CPN” for more information on the reset command.

If the host wishes to synchronize with the module, it can issue a “Read Link Status Byte” command. The CPN will be part of the status returned. The host can then set it’s tracking of the CPN to the returned value. Alternatively, the host can issue a “Reset CPN” command to force the CPN back to zero without resetting the module.

The purpose of the CPN is to avoid host confusion on commands missed by the module. The primary failure mechanism leading to this confusion is a bit error in the address field that is a legal address for another device on the I2C bus. The unintended recipient slave acknowledges all of the bytes at the data link layer, as the message looks correct at that layer. The transport layer, however, will detect the check byte error (MSA module) or other problems (non-MSA module) and reject the command. When the host reads the command target, it receives an “OK” status. However, without the CPN it is impossible to distinguish between a repeated “OK” response to a prior command and an “OK” status for the most recent command. Therefore, without the CPN the host could be misled into thinking message with the address error had been successfully executed.





/8704-AUG-03

The figure below shows an example of how the CPN works to indicate a dropped command. In this example, a command is sent and executed successfully. The host and module both toggle their CPN variable. The host reads back the “OK” reply and verifies the CPN is as expected. The host then sends a new command and toggles the expected CPN. However, the message has failed to reach the addressed module (0x1000 000) because of a bit error in the address and has reached another module (0x1000 001) on the same bus instead. The host does not know the error has occurred as it has received byte acknowledgements from module 0x1000 001 at the data link layer. The read of the intended destination module (0x1000 000) returns an “OK” reply with a CPN that is not in the expected state. The host then knows that the command reached a device on the bus other than the intended module.

Also within the figure is a second example of the benefits of the CPN. For commands that require long processing times, the receipt of a “busy” response with the CPN number op-posite that expected for the next “OK” response indicates the long duration command has been received and is being processed.





/8704-AUG-03

2.2.3.2 Module Status Definition The Status Byte can have the following values depending on the module status:





/8704-AUG-03

Status bit 7

(CPN)

Status bits 6-0)

(Hex)

Description Note

0,1 00 OK Command executed.0,1 01 Unknown

commandThe command code is either not supported or is a protected one accessed without having entered the protected mode.

0,1 02 Frame error The length of the command message (host to module) is not consistent with the value indicated by the Length Byte or the length of the entire frame is longer/shorter than the MSA protocol range.

0,1 03 Out of range At least one parameter of the command is out of range.

0,1 04 Time out The command timing is out of range.0,1 05 Check error The calculated check byte is not consistent with the

value indicated by the Check Byte field.0,1 06 Reserved Reserved for future use.0,1 07 Module busy The module has started working on the received

command (this status only applies for long delay commands, the module is to be re-asked later to check for command completion). This reply will only be issued when the module processing the long command is read without an intervening command. Example: Host writes Set Laser ITU Channel command, host reads module before wavelength is attained, module replies busy.

0,1 08 Still processing

The module is not able to execute the command because the previous one is still in progress. This reply will only be issued following a command write to a module that has yet to complete the previous command. Example: Host writes Set Laser ITU Channel command, host writes Read Laser Bias Current Monitor command, host reads module, module replies still processing (module will continue to reply still processing until the original Set Laser ITU Channel command has either completed successful or failed).

0,1 09 Command not executed

The module is not able to execute the command according to current conditions (for example: a read is issued before any writes after module reset).

0,1 0A Command Failed

The command is legal and the module attempted to execute it but was unable reach a successful outcome (for example: Set Laser ITU Channel was unable to tune to the proper wavelength).

0,1 0B-7E Reserved Reserved for future use.0,1 7F Invalid Invalid response, 0xFF indistinguishable from no

response.10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

2.2.4 Response Retention and Retransmission The last built response by the transponder is held in its volatile memory until it receives another command or until a “busy” or “still processing” status changes to an “OK” status. This allows the host to ask for retransmission of the last response should an error occur and to poll for completion of long execution time commands. A “Command Not Executed” response is the default module response after a module reset until a command is received.

2.3 Application Layer Behavior For Application Layer Commands, see the respective 10G and 40G sections below.

2.3.1 Bit Mapping In the command sections below, bit 7 is defined to be the most significant bit and bit 0 the least significant bit of the data byte.

2.3.2 Protection Some commands are protected against unintentional access.

The protection feature supports two levels of protection:- The first level, intended to avoid accidental access to commands that may alter the

module's functions, requires to enter the protected mode without password;- The second level, intended to protect vendor's specific commands access, requires

entering the protected mode with a password.

The protection status is volatile and is set to not allow access at system power-up and module reset.

2.3.3 Module Reset For all causes of a module reset (power cycle or hardware reset via the MSA connector), the module returns to the last known addressing mode (standard or enhanced). The module configuration returns to the last known values of the command registers when in -dicated as nonvolatile in the command descriptions below. In addition, 10 Gbps modules return to the last known operation mode.

See individual commands for how they react to a reset. The general philosophy is that command functions that are factory calibrated but host adjustable return to their factory calibrated value (e.g., Receive Decision Threshold). Items that do not have host adjustable factory calibration return to the last value set by the host (e.g., Tx command Register).





/8704-AUG-03

2.3.4 Interrupt Request Pin Operation For 10Gb modules supporting the I2C interface, the use of the alarm interrupt (ALMINT) pin is mandatory. (The ALMINT pin is optional for 10Gb hardware only modules.) For 40Gb modules, use of the STAT_INT pin is also mandatory. Since these pins function similarly, this section is written discussing both 10Gb and 40Gb at the same time. When discussing both, the hardware pin is referred to as the interrupt request pin and abbreviated IRQ. The 40Gb configurable alarm pin is ignored for purposes of this section.

The IRQ pin provides a mechanism for the module to interrupt the host processor when an alarm or error occurs within the module. Since some alarms and errors may not be available via discrete alarm pins, the IRQ pin and host polling are the only two mechanisms available for host notification of a problem.

There are two possible modes operation of the IRQ pin: Logical OR (mandatory default) and Edge (optional and entered by command).

2.3.4.1 Logical OR IRQ Operation The factory default operation for the IRQ pin is Logical OR. This is the same operation as an all hardware module (10 Gb only). All alarms (and errors) that are implemented (including I2C available only) and unmasked are logically ORed together to form the IRQ signal. In other words, if any alarm is active and unmasked, the IRQ signal will also be active. If an alarm is masked, it does not contribute to calculation of the IRQ. The IRQ is non-latching when operating as a logical OR. The IRQ pin timing is as given in the appropriate 300 pin MSA 10 Gb / 40 Gb Reference Document.

2.3.4.2 Edge IRQ Operation Edge IRQ operation is optional. Edge operation makes the IRQ pin operate in a manner that it can be directly connected to a negative edge triggered interrupt request pin on a processor. Issuing an “interrupt control” command with the appropriate value in the data field will move the module into and out of edge operation. Entering edge mode will clear the IRQ pin if set at time of entry.

2.3.4.2.1 Definitions Host Interrupt Handling Period – The time from an IRQ assertion to IRQ pin cleared via “Clear Interrupt” command.

First Alarm – An alarm that occurs when no other alarms are active and not in a Host Interrupt Handling Period.





/8704-AUG-03

2.3.4.2.2 IRQ Pin Timing The IRQ pin is asserted within 10 ms of the internal occurrence of a non-masked, first alarm, not from the signaling of an alarm on a hardware pin. (Alarms occurring during host interrupt handling periods and additional alarms after a first alarm have an unknown timing relationship to the IRQ pin). The IRQ pin is cleared within 10 ms of an “Interrupt Control” command with a “clear” value in the data field. The IRQ pin has a minimum cleared pulse width of one microsecond. If an “Interrupt Control - Clear” is issued when one or more non-masked interrupts are active, the IRQ pin reasserts within 10 ms. “Interrupt Control - Clear” is the only mechanism to clear the IRQ pin.

2.3.4.2.3 Alarm Status and Mask Registers The alarm status registers are latched allowing transient conditions to be captured. When read by the host, the module will clear the status register immediately. If the underlying condition has not cleared when the module processor next samples the underlying alarm conditions, the alarm bit is again set. (Note that there may be as long as 10 ms from the time the status register is first read to the next sample. Therefore, a host that wishes to poll the module to verify the alarm has condition has been corrected must read the status register twice with at least 10 ms between reads.) The alarm mask will not affect the alarms reported in the status register. The mask only blocks the alarm from causing the IRQ pin from indicating an alarm on that condition.

2.3.4.2.4 Edge Mode Interrupt Cycle Example The following sequence diagram is an example of an alarm interrupt cycle involving a host and a module. The entire sequence is set into motion when Alarm Condition 1 occurs within the module. Within 10 ms, the module notifies the host of a problem. The host reacts to the interrupt by scheduling a module alarm handling process. As part of the alarm handling process, the host reads the alarms, evaluates the problem, and takes appropriate action. At the completion of this cycle, the host reads the alarm status registers a second time to clear the alarm bit again in case it has been set by the module processor sample cycle. In this example, alarm condition 2 occurs just after this last read of the alarm status register and before the “clear interrupt” command is issued. Notice that the occurrence of the second alarm after the handling of the first forces a second IRQ edge to start the interrupt handling process a second time. Also note that the time from alarm 2 occurring to the IRQ edge is unknown. Note: If the original alarm condition is neither cleared nor masked when the “clear interrupt” command is issued, the second IRQ edge still occurs with or without the second alarm condition becoming active.





/8704-AUG-03

Edge Interrupt Example Interaction Diagram





/8704-AUG-03

Edge Interrupt Example Timing Diagram

2.3.5 Command Execution and Information Latency Times Many of the commands have a maximum time for execution. Many of the response also have a maximum time for data latency. For most items, the timing is called out either in the MSA 10G and 40G individual specifications (referred to hereafter as “HW specs”). The items with timing in this document were established because the item did not appear in the HW specs. This section defines the measurement points for these timing requirements.

In all cases, the shortest timing available for I2C based commands is 10 ms. For example the HW spec for a laser disable operation is 1 ms. The same action taken through I2C commands may take up to 10 ms to execute. For commands where the HW spec has a time longer than the I2C spec, the longer HW spec time also applies to the I2C command.

Individual module data sheets and application notes should be referenced to verify these timing conditions are met by each module and under what conditions. Some implementations may not be able to meet all of the timing specs of this section particularly when busy with other real time tasks. Also see the vendor data sheet for any items that are not specified by the MSA.

2.3.5.1 Command Execution Time Definition Command execution times are defined as being measured from the occurrence of an I 2C STOP condition at the 300 Pin interface on a valid, error free command to the commanded condition being met.





/8704-AUG-03

2.3.5.2 Information Latency Time Definition When reading monitors and alarms, the data returned is no older than the applicable timing spec at the time the I2C STOP condition occurs at the 300 Pin interface on a valid, error free first request. If the read data is corrupted, the command needs to be resent.

2.3.6 Operation Modes (10Gb Only) Module can be manufactured in four distinct types: Hardware Control & Status only, Pin Control only, Soft Control only, and Pin/Soft Control Switchable. Each is defined below. Each vendor may choose which operating mode is appropriate for each module type. This makes each mode optional to a certain extent. The following paragraphs only use italic text to indicate functions that are optional within each mode rather than marking all of the text as optional. One of the four modes must be chosen.

2.3.6.1 Hardware Control & Status Mode Modules Hardware Control & Status mode modules do not support the interface described in this document. All control and status is performed exclusively using the pin interfaces described in “Reference Document for 300pin 10Gb Transponder”. Since this type of module does not support I2C, this mode is ignored in this document.

2.3.6.2 Pin Control Mode Modules Pin Control mode modules only accept module hardware control commands from the host via hardware pins. A module in this mode works identically to a module that does not have I2C communications capability it only accepts hardware control commands from hardware pins. However, modules in this mode provide status information via the communications interface. Optionally, the module may provide some status on hardware pins simultaneously with the I2C interface. If a status is provided on a hardware pin, it must also be provided via I2C to be compliant with this document.

2.3.6.3 Soft Control Mode Modules Soft Control mode modules receive commands via the communications interface and ignore the state of all of the hardware control pins (except module reset and laser enable). The status is provided as described in Pin Control mode.

2.3.6.4 Pin/Soft Control Mode Switchable Modules The command set permits for modules that can switch between Pin Control and Soft Control. This allows for a universal module to be manufactured that can reside in hardware and software controlled sockets. For a switchable module to be compliant with this document, all functions that can be controlled via hardware (except module reset) must be available via software. Following this rule is important as a module in Soft Control mode ignores all hardware control (except laser enable and module reset). Additional control commands may be made available in software that are not provided in hardware.





/8704-AUG-03

2.3.6.4.1 Pin/Soft Mode Transitions New switchable devices leaving the factory are in Pin Control Mode. The transition from Pin Control Mode to Soft Control Mode causes a transition in control from the hard pins to the software registers. In order to avoid a disruption in operation, the soft mode registers are set to the values on the hard pins at the time of transition 3. After completion of the entry into Soft Control Mode, the operation of the module can only be controlled by the software command. The LsENABLE pin is still active in soft mode for safety purposes as described in the “Set TX Command Register” application layer command description below.

The transition from Soft Control Mode to Pin Control Mode transfers module control from the software programmable registers to the hardware pins. It is important for the host to have the hardware pins configured to the desired state before issuing the “Enter Pins Control Mode” command as the hardware control takes effect within 10 ms.

The selection of the mode is nonvolatile.

3 An exception are the LsTUNE pins. The larger range “Set Laser ITU Channel” command is used for setting a tunable laser channel via software. The transition to soft mode shall not change the wavelength of a tunable wavelength module.10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

3 10GB APPLICATION LAYER COMMANDS

10 and 40 G application layer commands are inherently different due to the physical properties of the modules. However, the intent is that wherever possible the commands and bit fields will be the same between 10 and 40 G.

Protected commands, required to enter the protected mode prior being called, are indicated by the symbol . The vendor level of protection is marked as . Commands in italics are optional. Consult the data sheet of the specific module to determine what optional commands have been implemented.

The two columns Pin and Soft indicate whether the corresponding commands are available depending the current module mode as described in Section 2.3.6.

Cmd (hex)

MSA Prot.

Pin Soft Description

00 to 0F Reserved For Future Use10 to 1F Reserved For Future Use20 to 2F Reserved For Future Use30 to 3F Reserved For Future Use40 Set TX Command Register41 Read TX Command Register 42 Save TX Command Register 43 Restore TX Command Register 44 Set RX Command Register45 Read RX Command Register 46 Save RX Command Register 47 Restore RX Command Register 48 Reserved For Future Use49 Set Laser ITU Channel4A Read Laser ITU Channel4B Set Receive Decision Threshold4C Read Receive Decision Threshold4D to 4F Reserved For Future Use50 to 5F Reserved For Future Use60 Laser Bias Current Monitor61 Laser Output Power Monitor62 Laser Temperature Monitor63 Receiver Signal Monitor AC

Optical Power64 Receiver Signal Monitor Average

Optical Power65 Laser Wavelength Monitor66 Transponder Temperature Monitor





/8704-AUG-03

Cmd (hex)

MSA Prot.


67 Photodiode Temperature Monitor68 Modulator Bias Monitor69 Reserved For Future Use6A Laser Output Power Monitor (in

dBm)6B Receiver Signal Monitor Average

Optical Power (in dBm)6C to 6F Reserved For Future Use70 to 7F Reserved For Future Use80 Read TX Alarm Status Register81 Read RX Alarm Status Register82 Read Power Alarm Status

Register83 Set Rx Interrupt Alarm Mask

Register84 Read Rx Interrupt Alarm Mask

Register85 Set Tx Interrupt Alarm Mask

Register86 Read Tx Interrupt Alarm Mask

Register87 Set Power Supply Alarm Mask

Register88 Read Power Supply Alarm Mask

Register89 Read Summary Alarm Register8A Interrupt Control8B to 8F Reserved For Future Use90 to 9F Reserved For Future UseA0 Read Supplier Identifier CodeA1 Read Module Type CodeA2 Read Customer ParametersA3 Write Customer ParametersA4 Read First Laser ITU ChannelA5 Read Last Laser ITU ChannelA6 Read Laser ITU Channel SpacingA7 Read Revision CodesA8 Read Unit Serial NumberA9 Read Unit Manufacture DateAA Read Unit Part NumberAB to AF Reserved For Future UseB0 to BF Reserved For Future UseC0 Read Link Status





/8704-AUG-03

Cmd (hex)

MSA Prot.


C1 Enter Pin Control ModeC2 Read Maximum I2C RateC3 Enter Protected ModeC4 Exit Protected ModeC5 Reset CPNC6 Enter Soft ModeC7 Read Edition and ModeC8 Data LoopbackC9 to CF Reserved For Future UseD0 to DF Reserved For Future UseE0 to EF Reserved For Future UseF0 to FF 4 5 Supplier Reserved Codes

The message frame definitions described in the following paragraphs corresponds to the message body as defined in paragraph 2.2.

4 See supplier documentation for modal availability of supplier specified commands.5 See supplier documentation for modal availability of supplier specified commands.10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

3.1 MSA Part The MSA part is the definition of all MSA specified commands, both mandatory and optional.

3.1.1 Command Codes The module functions are controlled using these commands. Note: lower layer framing bytes are not shown each command/response definition but are applied each one as shown above.

3.1.1.1 Set TX Command Register This command sets the module's TX command register. This value is nonvolatile. After a power disruption or reset, the last value written to this register is restored.

The message frame is as follows:HM MH

CMD LGTH DATA DATA DATA STS LGTH0x40 0x03 Data1 Data

2Data3 STS 0x00

3 byte operand: Data1, Data2, Data3: MSByte first DataX description is as follows:





/8704-AUG-03

Data Bit Name Condition DefaultData1 0 ~ 7 FFU All 1’sData2 0 TxPICLKSEL (selects TxPICLK

frequency, equiv. to HW pin)0 for TxPICLK = fedata

1 for TxPICLK = fedata/2 0

1 TxLINETIMSEL (selects line timing mode, equiv. to HW pin)

0 for line timing mode1 for normal operation

1

2 LLOOPENB (enables line loopback, equiv. to HW pin)

0 for enable line loopback1 for normal operation

1

3 TxRESET (Mux system reset, equiv. to HW pin)

0 for Reset1 for normal operation

1

4 TxFIFORES (Mux FIFO reset, equiv. to HW pin)


1

5 AUTOTxFIFORES (Automatic Mux FIFO Reset, no HW equiv.)

0 for auto reset on error enabled1 for auto reset not enabled

1

6 SCTxRESET (Self-Clearing Mux system reset, no HW equiv.)


1

7 FFU 1Data3 0 LsENABLE (laser enabled or disabled,

equiv. to HW pin)0 for normal operation1 for laser disable

0

1 TxRATESEL0 (rate selection of system, equiv. to HW pin)

Sel1 Sel0 Rate (Gbps)0 0 10.3 (Ethernet)0 1 FFU1 0 10.7 (FEC)1 1 9.9 (SONET)

1

2 TxRATESEL1 (rate selection of system, equiv. to HW pin)

1

3 TxREFSEL (selects TxREFCLK, equiv. to HW pin)

0 for TXREFCLK = fedata/4,1 for TXREFCLK = fedata

1

4 TxPHSADJ0 (adjusts phase of TxPCLK, equiv. to HW pin)

Adj1 Adj0 Adjustment0 0 0º0 1 90º1 0 180º1 1 270º

1

5 TxPHSADJ1 (adjusts phase of TxPCLK, equiv. to HW pin)

1

6 TxSKEWSEL0 (adjusts delays of TxPICLK when in fedata/2 mode, equiv. to HW pin)

Sel1 Sel0 Delay (ps)0 0 9150 1 10151 0 7151 1 815

1

7 TxSKEWSEL1 (adjusts delays of TxPICLK when in fedata/2 mode, equiv. to HW pin)

1

fedata is defined to be the single data channel input/output electrical data rate (e.g., 622.08 Mbps at SONET optical data rate)

Note: TxRESET and TxFIFORES hold in reset until commanded to release the reset

condition. AUTOTxFIFORES is overridden by TxFIFORES being set to reset. SCTxRESET releases the reset automatically after the reset actions are complete

(except when TxRESET indicates to hold reset). For modules that do not have independent Rx and Tx controls of a feature, the Tx

controls are used. See the specific vendor module datasheet for further information. LsENABLE hardware pin and LsENABLE bit are logically ORed according to the

following truth table:





/8704-AUG-03

LsENABLE Bit LsENABLE Pin Laser Output

0 0 Enabled0 1 Disabled1 0 Disabled1 1 Disabled

3.1.1.2 Read TX Command Register The message frame is as follows:

HM MH

CMD LGTH STS LGTH DATA DATA DATA0x41 0x00 STS 0x03 Data1 Data2 Data3

3 bytes returned: Data1, Data2, Data3: MSByte first; DataX description is identical to the Set TX Command Register command.

NOTE: The LsENABLE bit reads back as set by command 0x40. It does not reflect the effects of the HW pin on the module’s present activity.

3.1.1.3 Save TX Command Register This command saves the current TX command register value in a unique location of the module's nonvolatile memory. The data stored by this command can only be retrieved by the “Restore Tx Command Register” command. Saving the current register values via this command has no effect on values used after the module is reset.


CMD LGTH STS LGTH0x42 0x00 STS 0x00

No operands.

3.1.1.4 Restore TX Command Register This command changes the TX command register to the value previously stored using the Save TX Command Register command.



No operands.





/8704-AUG-03

3.1.1.5 Set RX Command Register This command sets the module's RX command register. This value is nonvolatile. After a power disruption or reset, the last value written to this register is restored.


CMD LGTH DATA DATA DATA STS LGTH0x44 0x03 Data1 Data2 Data3 STS 0x00


Data Bit Name Condition DefaultData 1

0-7 FFU All 1’s

Data2

0 RxMUTE Dout (Mutes the RxDout[0:15], equiv. to HW pin)

0 for mute1 for normal operation

1

1 DLOOPENB (diagnostic loopback, equiv. to HW pin)


1

2 SCRxRESET (Self-Clearing DeMux system reset, no HW equiv.)


1

3~7 FFU All 1’sData3

0 RxRATESEL0 (rate selection of system, equiv. to HW pin)

Sel1 Sel0 Rate (Gbps)0 0 10.3 (Ethernet)0 1 FFU1 0 10.7 (FEC)1 1 9.9 (SONET)

1

1 RxRATESEL1 (rate selection of system, equiv. to HW pin)

1

2 RxREFSEL (selects RxREFCLK frequency, equiv. to HW pin)

0 for RXREFCLK = fedata/41 for RXREFCLK = fedata

0

3 RxLCKREF (Locks RxPOCLK to RxREFCLK, equiv. to HW pin)

0 locks RXPOCLK to RXREFCLK1 for normal operation

1

4 RxMCLKSEL (selects RxMCLK frequency, equiv. to HW pin)

0 for RXMCLK = fedata/41 for RXMCLK = fedata

1

5 RxRESET (DeMux system reset, equiv. to HW pin)


1

6 RxMUTEPOCLK (mutes the RxPOCLK, equiv. to HW pin)

0 for RXPOCLK mute1 for normal operation

1

7 RxMUTEMCLK (mutes the RxMCLK, equiv. to HW pin)

0 for RXMCLK mute1 for normal operation

1

fedata is defined to be the single data channel input/output electrical data rate (e.g., 622.08 Mbps at SONET optical data rate)

Note: RxRESET holds in reset until commanded to release the reset condition. 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

SCRxRESET releases the reset automatically after the reset actions are complete (except when RxRESET indicates to hold reset).

For modules that do not have independent Rx and Tx controls of a feature, the Tx controls are used. See the specific vendor module datasheet for further information.

3.1.1.6 Read RX Command Register The message frame is as follows:

HM MH


3 bytes returned: Data1, Data2, Data3: MSByte first DataX description is identical to the Set RX Command Register command.

3.1.1.7 Save RX Command Register This command saves the current RX command register value in a unique location of the module's nonvolatile memory. The data stored by this command can only be retrieved by the “Restore Rx Command Register” command. Saving the current register values via this command has no effect on values used after the module is reset.



No operands.

3.1.1.8 Restore RX Command Register This command changes the RX command register to the value previously stored using the Save RX Command Register command.



No operands.

3.1.1.9 Set Laser ITU Channel This command sets the laser wavelength (if tunable). This command is nonvolatile. The value of this variable is set by the LsTUNE pins when a module transitions from allocated to soft mode.

The message frame is as follows:





/8704-AUG-03

HM MH

CMD LGTH DATA DATA DATA STS

LGTH

0x49 0x03 Data1 Data2 Data3 STS

0x00

3 byte operand: Data1, Data 2, Data3; Data1: Band

o 0x43 = C-Bando 0x4C = L-Bando 0x53 = S-Bando Other values reserved for future use

Data2-3 Units: ITU channel number; Data2-3 format for C-band (one field, bits 15:0): fixed point binary ITU grid number

12.4, where the four least significant bits (3:0) represents a fraction of 0.0625 (1/16), bits 15:4 represent integers 1 through 81 (valid channel range);

o The ITU channel number is based on the 50 GHz spacing presented in Annex A of ITU-T-G.692 (10/98). This numbering scheme extends to 3.125 GHz spacing with the addition of the fraction. The channel number is determined by the following equation (all frequencies in THz):

.

o Examples: 193.875000 THz = channel 45.5000 = data2-3 0x02D8, 195.550 THz = channel 12.0000 = data2-3 0x00C0, 192.103125 THz = channel 80.9375 = data2-3 0x050F.

Other band channel numbering is for future study.

3.1.1.10 Read Laser ITU Channel This command returns the laser wavelength setting.

The message frame is as follows:HM M

H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x4A 0x00 STS

0x03 Data1 Data2 Data3

3 bytes returned: Data1, Data2, Data3; Data1: Band






/8704-AUG-03

Data2-3 Unit: ITU channel number (see Set Laser ITU Channel for definition).

3.1.1.11 Set Receive Decision Threshold This command sets the receive decision threshold. This value is stored in volatile memory. This is a software equivalent to the RxDTV pin in HW.


H

CMD LGTH DATA DATA STS

LGTH

0x4B 0x02 Data1 Data2 STS

0x00

2 byte operand: Data1: integer, Data2: fraction; Data Unit: percent (see 10Gb Reference Document for further definition); Data format: unsigned fixed point binary, valid range 0.0000 to 100.0000 in

1/256% steps; Accuracy and resolution: Vendor specific.

3.1.1.12 Read Receive Decision Threshold This command reads the present setting of the Receive Decision Threshold.


CMD LGTH STS LGTH DATA DATA0x4C 0x00 STS 0x02 Data1 Data2

2 bytes returned: Data1: integer, Data2: fraction; Data Unit: percent (see 10Gb Reference Document for further definition); Data format: unsigned fixed point binary, valid range 0.0000 to 100.0000 in

1/256% steps; Resolution: vendor specific.

3.1.2 Measurement Codes The module operation can be monitored using these commands.

3.1.2.1 Laser Bias Current Monitor This command returns the magnitude of the laser bias power setting current. This is a software equivalent to the LsBIASMON pin in HW.





/8704-AUG-03



3 bytes returned: Data1, Data 2, Data3: MSByte first; Data Unit: A; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

3.1.2.2 Laser Output Power Monitor This command returns the laser output power. This is a software equivalent to the LsPOWMON pin in HW.



3 bytes returned: Data1, Data 2, Data3: MSByte first; Data Unit: W; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

3.1.2.3 Laser Temperature Monitor This command returns the temperature of the laser. This is a software equivalent of the LsTEMPMON pin in HW. NOTE: The value returned is a relative error to the factory determined correct laser operating temperature.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x62 0x00 STS


3 bytes returned: Data1, Data 2, Data3: MSByte first; Data Unit: mC; Data format: 24 bits two’s complement; Accuracy: Vendor specific.





/8704-AUG-03

3.1.2.4 Receiver Signal Monitor AC Optical Power This command returns the received AC (modulated) optical signal power. This is a software equivalent of the RxSIGMON pin in HW.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x63 0x00 STS


3 bytes returned: Data1, Data 2, Data3: MSByte first; Data Unit: TBD; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

3.1.2.5 Receiver Signal Monitor Average Optical Power This command returns the average received optical power. This is a software equivalent to the RxPOWMON pin in HW.



3 bytes returned: Data1, Data 2, Data3: MSByte first; Data Unit: nW; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

3.1.2.6 Laser Wavelength Monitor This command returns the offset from the exact ITU channel wavelength. This is a software equivalent to the LsWAVEMON pin in HW.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x65 0x00 STS


3 bytes returned: Data1, Data2, Data3: MSByte first;





/8704-AUG-03

Data Unit: MHz; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

3.1.2.7 Transponder Temperature Monitor This command returns the ambient circuit card or case temperature within the module. See vendor data for the exact location of the sensor within the module. There is no equivalent hardware pin for this monitor.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x66 0x00 STS


3 bytes returned: Data1, Data2, Data3: MSByte first; Data Unit: mC; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

3.1.2.8 Photodiode Temperature Monitor This command returns the temperature of the photodiode. This is a software equivalent to the APDTEMPMON pin in HW.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x67 0x00 STS



3.1.2.9 Modulator Bias Monitor This command returns the linearly scaled value of the modulator bias control. The scaling is such that when this monitor reads ‘1’ for all of the meaningful bits, the bias control is at (or beyond) the maximum value for this module’s design. A returned value of zero will indicate that the bias control is at (or below) the minimum operating voltage. All references are assuming an absolute value of the bias control. This is a software equivalent to the ModBIASMON pin in HW.10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03


CMD LGTH STS LGTH DATA DATA0x68 0x00 STS 0x02 Data1 Data2

2 bytes returned: Data1, Data 2: MSByte first; Data Unit: none, value scaled to fit to 16 bits; Data format: 16 bit, unsigned; Accuracy: Vendor specific number of most significant bits, the remaining least

significant bits will always read 0 (left justified, vendor specific number of significant bits).

3.1.2.10 Laser Output Power Monitor (in dBm) This command returns the laser output optical power LsPOWMON.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x6A 0x00 STS


3 bytes returned: Data1, Data 2, Data3: MSByte first; Data Unit: 0.01dBm; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

3.1.2.11 Receiver Signal Monitor Average Optical Power (in dBm) This command returns the average received optical power, RxPOWMON.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x6B 0x00 STS







/8704-AUG-03

3.1.3 Alarm Codes The module alarm status can be monitored using these commands. The following figure gives a pictorial flow of the alarms and masks.

3.1.3.1 Read TX Alarm Status Register This command returns a bit field indicating the state of each transmit alarm with alarm conditions as specified in the “Reference Document For 300 Pin 10Gb Transponder”. These alarms are latching. Alarm bits in this register remain in the alarmed state until a read of this register occurs after the alarm condition has been cleared for greater than or equal to the deactivation time. Note that on power-up, many alarms may be set until the module completes initialization. Therefore, the host should read this register as part of module initialization to clear those alarms.







/8704-AUG-03

3 bytes returned: Data1, Data2, Data3: MSByte first DataX description is as follows:

Data Bit Name ConditionData1

0~7 FFU All bits 1

Data2

0 EOLALM (Laser end of life alarm, no HW equivalent)

0 for alarm since last read, 1 for no alarm since last read or if not implemented

1 ModTEMPALM (Modulator Temperature Alarm, no HW equivalent)


2~4 FFU All bits 15 LsWAVALM (Laser

Wavelength Alarm, no HW equivalent)


6~7 FFU All bits 1Data3

0 TxALM INT (Tx Summary alarm, equiv. to HW pin)


1 LsBIASALM (Laser bias current alarm, equiv. to HW pin)


2 LsTEMPALM (Laser temperature alarm, equiv. to HW pin)


3 TxLOCKERR (Loss of TxPLL lock indicator, equiv. to HW pin)

0 for alarm since last read, 1 for no alarm since last read

4 Reserved This bit was transient TxFIFOERR in Edition 3 and earlier. It is recommended that hosts not use this bit for new designs and that modules make this bit mirror Data3 bit 7 for backwards compatibility.

5 LsPOWALM (Laser power alarm, equiv. to HW pin)


6 ModBIASALM (Modulator bias alarm, equiv. to HW pin)


7 TxFIFOERR (Mux FIFO error indicator, equiv. to HW pin)


Note: EOLALM alarms when the vendor specific algorithm determines the module end of

life has been reached. ModTEMPALM definition is vendor specific.





/8704-AUG-03

3.1.3.2 Read RX Alarm Status Register This command returns a bit field indicating the state of each receive alarm with alarm conditions as specified in the “Reference Document For 300 Pin 10Gb Transponder”. These alarms are latching. Alarm bits in this register remain in the alarmed state until a read of this register occurs after the alarm condition has been cleared for greater than or equal to the deactivation time. Note that on power-up, many alarms may be set until the module completes initialization. Therefore, the host should read this register as part of module initialization to clear those alarms.



2 bytes returned: Data1, Data2: MSByte first DataX description is as follows:

Data Bit Name ConditionData1 0~7 FFU Always 1Data2 0 RxALM INT (RX summary alarm,

equiv. to HW pin)0 for alarm since last read, 1 for no alarm since last read or if not implemented

1 RxPOWALM (Loss average optical power alarm, equiv. to HW pin)


2 RxSIGALM (Loss AC (modulated) power alarm, equiv. to HW pin)


3 RxLOCKERR (Loss of RxPLL lock indicator, equiv. to HW pin)


4~7 FFU Always 1

3.1.3.3 Read Power Supply Alarm Register This command returns a bit field indicating if each power supply is within the voltage window specified in the “Reference Document For 300 Pin 10Gb Transponder”. There are no hardware equivalents to these alarm indicators. These alarms are latching. Alarm bits in this register remain in the alarmed state until a read of this register occurs after the alarm condition has been cleared for greater than or equal to the deactivation time. Note that on power-up, many alarms may be set until the module completes initialization. Therefore, the host should read this register as part of module initialization to clear those alarms.






/8704-AUG-03

HM MH

CMD LGTH

STS

LGTH

DATA

0x82 0x00 STS

0x01 Data1

1 byte returned: Data1 description is as follows:

Data Bit Name ConditionData1 0 PSUMMARY (Power summary

alarm)0 for alarm since last read, 1 for no alarm since last read or if not implemented

1 P5VANALOG (+5V analog) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

2 N5V2ANALOG (-5.2V analog) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

3 P3P3VANALOG (+3.3V analog) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

4 P3P3VDIGITAL (+3.3V digital) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

5 LVDIGITAL (+1.8V digital) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

6 N5P2VDIGITAL (-5.2V digital) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

7 FFU Always 1

3.1.3.4 Set Rx Interrupt Alarm Mask Register This command inhibits the disabled alarms from contributing to the ALMINT pin output. Alarm masks are volatile and set back to the default at reset. Optional masks must be im-plemented if the corresponding alarm bits are implemented.


CMD LGTH DATA DATA STS LGTH0x83 0x02 Data1 Data2 STS 0x00

2 byte operand: Data1, Data2: MSB first; DataX description is as follows:





/8704-AUG-03

Data Bit Name Condition Default*Data1 0~

7FFU All bits 1 N/A

Data2 0 Reserved 0 01 RxPOWALM (Loss average optical power

alarm)0 for alarm enabled, 1 for alarm disabled

0

2 RxSIGALM (Loss of AC (modulated) optical signal)

0 for alarm enabled, 1 for alarm disabled

0

3 RxLOCKERR (Loss of RxPLL lock indicator)


0

4~7

FFU All bits 1 N/A

* For optional bits, default is 0 if alarm and mask implemented, 1 if alarm and mask not implemented.

3.1.3.5 Read Rx Interrupt Alarm Mask Register The message frame is as follows:

HM MH


DataX description is as shown in the Set Rx Interrupt Alarm Mask Register command.

3.1.3.6 Set Tx Interrupt Alarm Mask Register This command inhibits the disabled alarms from contributing to the ALMINT pin output. Alarm masks are volatile and set back to the default at reset. Optional masks must be implemented if the corresponding alarm bits are implemented.



3 byte operand: Data1, Data2, Data3: MSB first; DataX description is as follows:





/8704-AUG-03


7FFU All bits 1 N/A

Data2 0 EOLALM (Laser end of life alarm) 0 for alarm enabled, 1 for alarm disabled

0

1 ModTEMPALM (Modulator Temperature Alarm)


0

2~4

FFU All bits 1 N/A

5 LsWAVALM (Laser Wavelength Alarm) 0 for alarm enabled, 1 for alarm disabled

0

6~7

FFU All bits 1 N/A

Data3 0 Reserved 0 01 LsBIASALM (Laser bias current alarm) 0 for alarm enabled, 1 for alarm

disabled0

2 LsTEMPALM (Laser temperature alarm) 0 for alarm enabled, 1 for alarm disabled

0

3 TxLOCKERR (Loss of TxPLL lock indicator) 0 for alarm enabled, 1 for alarm disabled

0

4 Reserved N/A 05 LsPOWALM (Laser power alarm) 0 for alarm enabled, 1 for alarm

disabled0

6 ModBIASALM (Modulator bias alarm) 0 for alarm enabled, 1 for alarm disabled

0

7 TxFIFOERR (Mux FIFO error indicator) 0 for alarm enabled, 1 for alarm disabled

0


3.1.3.7 Read Tx Interrupt Alarm Mask Register The message frame is as follows:

HM MH


DataX description is as shown in the Set Tx Interrupt Alarm Mask Register command.

3.1.3.8 Set Power Supply Alarm Mask Register This command inhibits the disabled alarms from contributing to the ALMINT pin output. Alarm masks are volatile and set back to the default at reset. Optional masks must be implemented if the corresponding alarm bits are implemented.


CMD LGTH DATA STS LGTH0x87 0x01 Data1 STS 0x00

1 byte operand: Data1 description is as follows:





/8704-AUG-03

Data Bit

Name Condition Default*

Data1 0 Reserved 0 N/A1 P5VANALOG (+5V analog) 0 for alarm enabled, 1 for alarm

disabled0

2 N5V2ANALOG (-5.2V analog) 0 for alarm enabled, 1 for alarm disabled

0

3 P3P3VANALOG (+3.3V analog)


0

4 P3P3VDIGITAL (+3.3V digital) 0 for alarm enabled, 1 for alarm disabled

0

5 LVDIGITAL (low voltage digital) 0 for alarm enabled, 1 for alarm disabled

0

6 N5P2VDIGITAL (-5.2V digital) 0 for alarm enabled, 1 for alarm disabled

0

7 FFU 1 N/A* For optional bits, default is 0 if alarm and mask implemented, 1 if alarm and mask not implemented.

3.1.3.9 Read Power Supply Alarm Mask Register The message frame is as follows:

HM MH

CMD LGTH STS LGTH DATA0x88 0x00 STS 0x01 Data1

Data1 description is as shown in the Set Power Supply Alarm Mask Register command.

3.1.3.10 Read Summary Alarm Register This command returns a bit field indicating the state of each summary alarm bit specified in the individual Tx, Rx, and Power alarm registers. This register is designed to allow a quick determination of which sub-alarm registers have active alarms. These bits mirror the state of the individual alarm registers. Therefore, reading of the individual command registers controls the latching feature of these bits.




Data Bit Name ConditionData1 0 TxALM INT (TX summary alarm) Mirror of command 0x80, Data3, Bit 0

1 RxALM INT (RX summary alarm) Mirror of command 0x81, Data2, Bit 02 PSUMMARY (Power summary

alarm)Mirror of command 0x82, Data1, Bit 0 or 1 if not implemented

3~7 FFU All bits 1





/8704-AUG-03

3.1.3.11 Interrupt Control This command changes the behavior of the ALMINT pin. Please refer to section 2.3.4 for detailed description of each mode. This command is nonvolatile.


CMD LGTH DATA STS LGTH DATA0x8A 0x01 Action STS 0x01 Result

1 byte operand: Action:

o 0x01 Read present modeo 0x02 Enter logical OR modeo 0x04 Enter edge modeo 0x08 Clear IRQ (Edge only)o All other codes reserved

1 byte returned: Result:

o 0x02 Logical OR modeo 0x04 Edge modeo 0x08 IRQ Clearing (Edge only)o All other codes reserved

3.1.4 Identifier Codes Module identifying information can be read using these commands. There are no hardware equivalents to these commands.

3.1.4.1 Read Supplier Identifier Code The message frame is as follows:

HM MH

CMD LGTH STS LGTH DATA0xA0 0x00 STS 0x01 IC

1 Byte returned: IC (Identifier Code)





/8704-AUG-03

IC (Identifier Code) is defined as follows. For an up to date list of supplier codes and application procedures see http://www.300pinmsa.org/.

Memberso 0x00 Unidentified vendoro 0x01 Alcatel Optronicso 0x02 TriQuint Optoelectronics (including legacy Agere Systems

modules)o 0x03 OpNexto 0x04 Mitsubishi Electrico 0x05 Agilent Technologieso 0x06 Reserved (formerly Ericsson Optoelectronics AB)o 0x07 NECo 0x08 ExceLighto 0x09 JDS Uniphaseo 0x0A Fujitsu Quantum Deviceso 0x0B Bookham Technology (including legacy Nortel Networks

modules)o 0x0C – 0x2F FFU

Non-Memberso 0x30 – 0xFF, see http://www.300pinmsa.org/ for latest listing.

3.1.4.2 Read Module Type Code The message frame is as follows:

HM MH

CMD LGTH STS LGTH DATA0xA1 0x00 STS 0x01 TC

1 Byte returned: TC (Type Code) TC (Type Code) is defined as follows:

o 0x00 for undefined typeo 0x01 VSR-1/VSR-64.1 0.6 kmo 0x02 SR-1/I-64.1 2 kmo 0x03 SR-2/I-64.2 25 kmo 0x04 IR-1/S-64.1 20 kmo 0x05 IR-2/S-64.2b 40 kmo 0x06 10Gb MSA 65 kmo 0x07 IR-2/ S-64.2 WDM 40 kmo 0x08 10Gb MSA WDM 65 km o 0x09 LR-2/L-64.2a 80 km o 0x0A to 0xFF Reserved for Future Use

3.1.4.3 Read Customer Parameters This command returns 1 to 16 bytes stored in the 64 bytes customer dedicated area of the module's nonvolatile memory. 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

http://www.300pinmsa.org/



CMD LGTH DATA DATA STS LGTH DATA … DATA0xA2 0x02 ADD N STS N Data1 … DataN

2 bytes operand: ADD (memory ADDress, range is 0x00 to 0x3F) N [number of contiguous bytes to return (0x01 to 0x10, inclusive)]

N bytes returned: Data (stored data)

Usage: ADD+ N-1 ≤ 0x3F for the command to be valid.

3.1.4.4 Write Customer Parameters This command stores 1 to 16 bytes in the 64 bytes customer dedicated area of the mod -ule's nonvolatile memory.


CMD LGTH DATA DATA … DATA STS LGTH0xA3 0xN+1 ADD Data1 … DataN STS 0x00

N+1 bytes operand: ADD (memory ADDress, range is 0x00 to 0x3F) Data1:N (Data to store, 0x01<N0x10)

Usage: All bytes in a write must reside in the same 16 byte page where a page begins with binary address xx0000 and ends with xx1111.

3.1.4.5 Read First Laser ITU Channel This command returns the First ITU Channel setting supported by the module (i.e., minimum wavelength), as defined in the factory prior to shipment.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0xA4 0x00 STS



o 0x43 = C-Band10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

o 0x4C = L-Bando 0x53 = S-Bando Other values reserved for future use


3.1.4.6 Read Last Laser ITU Channel This command returns the Last ITU Channel setting supported by the module (i.e., maximum wavelength), as defined in the factory prior to shipment.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0xA5 0x00 STS





3.1.4.7 Read Laser ITU Channel Spacing This command returns the module’s spacing between defined wavelength channels expressed in a fraction of an ITU channel, as defined in the factory prior to shipment. This command can be used, in conjunction with the First and Last Channel commands, to calculate the number of supported channels for a particular module, and to calculate the specific ITU channel to be set by command 0x49.


H

CMD LGTH

STS

LGTH

DATA

0xA6 0x00 STS

0x01 Data1

1 byte returned: Data1: fixed point binary number 4.4, where the four least significant bits (3:0)

represents a fraction of a 50 GHz ITU Channel spacing, and the four most significant bits (7:4) represent whole ITU channel spacing. This gives a resolution of 1/16 of a 50 GHz ITU channel spacing (3.125 GHz).

o Examples:10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

100 GHz spacing: Data1 = 0x20; 50 GHz spacing: Data1 = 0x10; 25 GHz spacing: Data1 = 0x08.

3.1.4.8 Read Revision Codes This command returns the vendor defined hardware and software revision codes for the unit queried.

The message format is as follows:HM

CMD LGTH0xA7 0x00

MH

STS LGTH DATA DATA DATA DATA DATA DATA DATA DATASTS 0x10 HW1 HW2 HW3 HW4 HW5 HW6 HW7 HW8

DATA DATA DATA DATA DATA DATA DATA DATASW1 SW2 SW3 SW4 SW5 SW6 SW7 SW8

16 bytes returned: HW1-HW8: hardware revision, up to 8 ASCII characters, vendor specific

information, left justified, 0x00 filled; SW1-SW8: software revision, up to 8 ASCII characters, vendor specific

information, left justified, 0x00 filled.

3.1.4.9 Read Unit Serial Number This command returns the vendor defined unit serial number for the unit queried.


CMD LGTH0xA8 0x00

MH

STS LGTH DATA DATA DATA DATA DATA DATA DATA DATASTS 0x10 Data1 Data2 Data3 Data4 Data5 Data6 Data7 Data8

DATA DATA DATA DATA DATA DATA DATA DATAData9 Data10 Data11 Data12 Data13 Data14 Data15 Data16

16 bytes returned: Data1-16: unit serial number, up to 16 ASCII characters, vendor specific

information, left justified, 0x00 filled;





/8704-AUG-03

3.1.4.10 Read Unit Manufacture Date This command returns the date of manufacture for the unit queried in ISO 8601 calendar date basic format.


CMD LGTH0xA9 0x00

MH

STS LGTH DATA DATA DATA DATA DATA DATA DATA DATASTS 0x08 C1 C2 Y1 Y2 M1 M2 D1 D2

8 bytes returned: C1-2: Century digit 1 and 2, 2 ASCII characters, MSB first (example 20 = 0x32,

0x30); Y1-2: Year digit 1 and 2, 2 ASCII characters, MSB first (example 03 = 0x30, 0x33); M1-2: Month digit 1 and 2, 2 ASCII characters, MSB first (example July = 07 =

0x30, 0x37); D1-2: Day digit 1 and 2, 2 ASCII characters, MSB first (example 01 = 0x30, 0x31).

3.1.4.11 Read Unit Part Number This command returns the vendor defined part number for the unit queried.


CMD LGTH0xAA 0x00

MH



16 bytes returned: Data1-16: unit part number, up to 16 ASCII characters, vendor specific information,

left justified, 0x00 filled;





/8704-AUG-03

3.1.5 Configuration Codes The module configuration can be set and monitored using these commands. There are no hardware equivalents to these commands.

3.1.5.1 Read Link Status This command is provided as a neutral command which purpose is only to return the I 2C link status.


CMD LGTH STS LGTH DATA DATA0xC0

0x00 STS 0x02 0xC0 Data1

2 bytes returned: Fixed value 0xC0 (echo of command number); Data1:

o Standard addressing mode: Module 7-bit address, left justified with bit 0 cleared to zero (binary 1000yyy0);

o Enhanced addressing mode: TBD.

The returned data is provided to verify the STS is in response to the Link Status Com-mand, not a prior command. This extra data will allow the host to synchronize the Com -mand Processed Number (CPN) with the module.

3.1.5.2 Enter Pin Control Mode This command is provided to send the mode back to the pin controlled mode from the soft control mode. Issuing this command while already in pin control mode is permitted but has no effect on operational mode. See Section 2.3.6.4.1 for information about state transitions between pin and soft control modes. This command is nonvolatile.

Note: This command was “Enter Hard Mode” in Edition 3 and earlier. The command now has a response and retains I2C activity (including updating the CPN) where it previously had no response and deallocated the I2C port.


CMD LGTH STS LGTH0xC1

0x00 STS 0x00

No operands.

3.1.5.3 Read Maximum I2C Rate This command returns the module's maximum supported I2C data rate.





/8704-AUG-03


CMD LGTH STS LGTH DATA0xC2 0x00 STS 0x01 MBR

1 Byte returned: MBR (Maximum Baud Rate)

o 0x01: 100 kbpso 0x04: 400 kbpso Other values reserved for future use

3.1.5.4 Enter Protected Mode This command allows the module to enter the protected mode, this enabling the protected functions. The protected mode is automatically disabled after a protocol processor reset, whatever its status was before. This command is available either to enter the Protected Mode (without password) or to enter the Vendor Protected Mode (with password). The protection state of a module is stored in volatile memory.

The message frame is as follows (Protected Mode):HM MH

CMD LGTH STS LGTH0xC3 0x00 STS 0x00

No operands.

The message frame is as follows (Vendor Protected Mode):HM MH

CMD LGTH DATA DATA STS LGTH0xC3 LEN K1 … KLEN STS 0x00

LEN byte operand: 1 ≤ LEN ≤ 8 K1…KLEN (LEN character key, vendor defined).

3.1.5.5 Exit Protected Mode This command allows the module to exit the protected mode, thus disabling the protected functions. The protection state of a module is stored in volatile memory.



0x00 STS 0x00

No operands.





/8704-AUG-03

3.1.5.6 Reset CPN This command sets the CPN to zero including in the reply to this command. This command was known as “Allocate Module” in Edition 3 and earlier of this protocol . The Reset CPN command is mostly backwards compatible with the Allocate Module command. The Reset CPN command does have a reply of “OK” should the host read it rather than the non-response that is required by Edition 3 and earlier.



0x00 STS 0x00

3.1.5.7 Enter Soft Mode This command transitions the module to Soft Controlled mode (control through the I 2C bus). The mode of a module is stored in nonvolatile memory.



No operand.

3.1.5.8 Read Edition and Mode This command provides the module 300 Pin MSA “I2C Reference Document For 300 Pin 10Gb and 40Gb Transponders” edition compatibility, operational capability, and present operational mode.


CMD LGTH STS LGTH DATA DATA DATA0xC7 0x00 STS 0x03 EDN CAP OPR

The 3 bytes returned are as follows: First byte (EDN): Edition, binary number indicating the Edition Number of the 300

Pin MSA “I2C Reference Document For 300 Pin 10Gb and 40Gb Transponders” which is most compatible with this transponder;

Second byte (CAP): Capability, modes in which the module is capable of operating, a bit should be set to 1 in each field that the module supports, see OPR for bit field definition;

Third byte (OPR): Operating mode, the mode in current use by the module as indicated by a 1 in the appropriate bit as shown below. For example, a module in soft mode reads 0x02 and a module in pins mode reads 0x01.

Bit 7 (msb) 6 5 4 3 2 1 0 (lsb)10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

Definition FFU (0)

FFU (0)

FFU (0)

FFU (0)

FFU (0)

FFU (0)

Soft Pin

3.1.5.9 Data Loopback This command allows for testing of the communications link by looping back the command data in the response.

The message frame is as follows:HM

CMD LGTH DATA DATA DATA DATA0xC8

0x04 Data1 Data2 Data3 Data4

MH

STS LGTH DATA DATA DATA DATASTS 0x04 Data1 Data2 Data3 Data4

3 bytes operand and returned: Data 1 - 4: 4 bytes of customer provided data, any value is legal.

3.2 Supplier Reserved Commands These commands are not part of the MSA and are provided for extra functions support. Each supplier is free to format these commands as they see fit within the constraints of the framing described in this document.





/8704-AUG-03

4 40G APPLICATION LAYER COMMANDS

10 and 40 G application layer commands are inherently different due to the physical properties of the modules. However, the intent is that wherever possible the commands and bit fields will be the same between 10 and 40 G.

Protected commands that require entering the protected mode prior being called are indicated by the symbol . The vendor level of protection is marked with . Commands in italics are optional. Consult the data sheet of the specific module to determine what optional commands have been implemented.

Cmd (hex)

MSA Prot.

Description

00 to 0F Reserved For Future Use10 to 1F Reserved For Future Use20 to 2F Reserved For Future Use30 to 3F Reserved For Future Use40 Set TX Command Register41 Read TX Command Register 42 Save TX Command Register 43 Restore TX Command Register 44 Set RX Command Register45 Read RX Command Register 46 Save RX Command Register 47 Restore RX Command Register 48 Reserved For Future Use49 Set Laser ITU Channel4A Read Laser ITU Channel4B Set Receive Decision Threshold4C Read Receive Decision Threshold4D Set Demux Phase Offset4E Read Demux Phase Offset4F Set Configurable Alarm50 Read Configurable Alarm51 to 5F Reserved For Future Use60 Laser Bias Current Monitor61 Laser Output Power Monitor62 Laser Temperature Monitor63 Receiver Signal Monitor AC Optical Power64 Receiver Signal Monitor Average Optical

Power65 Laser Wavelength Monitor66 Transponder Temperature Monitor67 Photodiode Temperature Monitor





/8704-AUG-03

Cmd (hex)

MSA Prot.

Description

68 Modulator Bias Monitor69 Read Error Checker Error Count6A Laser Output Power Monitor (in dBm)6B Receiver Signal Monitor Average Optical

Power (in dBm)6C to 6F Reserved For Future Use70 to 7F Reserved For Future Use80 Read TX Alarm Status Register81 Read RX Alarm Status Register82 Read Power Supply Alarm Register83 Set Rx Interrupt Alarm Mask Register84 Read Rx Interrupt Alarm Mask Register85 Set Tx Interrupt Alarm Mask Register86 Read Tx Interrupt Alarm Mask Register87 Set Power Supply Alarm Mask Register88 Read Power Supply Alarm Mask Register89 Read Summary Alarm Register8A Interrupt Control8B to 8F Reserved For Future Use90 to 9F Reserved For Future UseA0 Read Supplier Identifier CodeA1 Read Module Type CodeA2 Read Customer ParameterA3 Write Customer ParameterA4 Read First Laser ITU ChannelA5 Read Last Laser ITU ChannelA6 Read Laser ITU Channel SpacingA7 Read Revision CodesA8 Read Unit Serial NumberA9 Read Unit Manufacture DateAA Read Unit Part NumberAB to AF Reserved For Future UseB0 to BF Reserved For Future UseC0 Read Link StatusC1 No OperationC2 Read Maximum I2C RateC3 Enter Protected ModeC4 Exit Protected ModeC5 Reset CPNC6 Reserved For Future UseC7 Read Edition and ModeC8 Data Loopback





/8704-AUG-03

Cmd (hex)

MSA Prot.

Description

C9 to CF Reserved For Future UseD0 to DF Reserved For Future UseE0 to EF Reserved For Future UseF0 to FF Supplier Reserved Codes

The message frame definitions described in the following paragraphs corresponds to the message body as defined in paragraph 2.2.





/8704-AUG-03

4.1 MSA Part The MSA part is the definition of all MSA specified commands, both mandatory and optional.

4.1.1 Command Codes The module functions are controlled using these commands. Note: lower layer framing bytes are not shown each command/response definition but are applied each one as shown above.

4.1.1.1 Set TX Command Register This command sets the module's TX command register. This value is nonvolatile. After a power disruption or reset, the last value written to this register is restored.








/8704-AUG-03

Data Bit Name Condition DefaultData1 0 PRBSEN (enables PRBS generator) 0 for PRBS mode

1 for normal operation1

1 PRBSPAT0 (selects PRBS pattern length)

Pat1

Pat0

Pattern

0 0 27

0 1 215

1 0 223

1 1 231

1

2 PRBSPAT1 (selects PRBS pattern length)

1

3 TxDESKEWEN (enables Tx SFI-5 deskew algorithm)

0 for disable1 for enable

1

4 ~ 7

FFU All 1’s

Data2 0 TxDCKSEL (selects TxDCK frequency) 0 for TxDCK = fedata/41 for TxDCK = fedata

0

1 TxLINETIMSEL (selects line timing mode)


1

2 TxLLOOPENB (enables line loopback) 0 for enable line loopback1 for normal operation

1

3 TxRESET (Mux system reset) 0 for Reset1 for normal operation

1

4 TxFIFORES (Mux FIFO reset) 0 for Reset1 for normal operation

1

5 AUTOTxFIFORES (Automatic Mux FIFO Reset)

0 for auto reset on error enabled1 for auto reset not enabled

1

6 SCTxRESET (Self-Clearing Mux system reset)


1

7 TxMUTEMONCLK 0 for Mute1 for normal operation

1

Data3 0 LsENABLE (laser enabled or disabled) 0 for normal operation1 for laser disable

0

1 TxRATESEL0 (rate selection of system)

Sel1 Sel0 Rate (Gbps)0 0 FFU0 1 FFU1 0 43.1 (FEC)1 1 39.8

(SONET)

1

2 TxRATESEL1 (rate selection of system) 1

3 TxREFSEL (selects TxREFCLK) 0 for TXREFCLK = fedata/4,1 for TXREFCLK = fedata

0

4 TxSRCCKSEL (selects the source clock only when TxLINETIMSEL = 1 (nominal))

0 for TxDCK as source, 1 for TxREFCK as source

1

5~7 FFU 1fedata is defined to be the single data channel input/output electrical data rate (e.g., 2.488 Gbps at SONET optical data rate)

Note: TxRESET and TxFIFORES hold in reset until commanded to release the reset

condition. AUTOTxFIFORES is overridden by TxFIFORES being set to reset. SCTxRESET releases the reset automatically after the reset actions are complete

(except when TxRESET indicates to hold reset).





/8704-AUG-03


LsENABLE hardware pin and LsENABLE bit are logically ORed according to the following truth table:

LsEnable Bit

LsEnable Pin

Laser Output

0 0 0, Enabled0 1 1, Disabled1 0 1, Disabled1 1 1, Disabled

TxLINETIMSEL hardware pin and TxLINETIMSEL bit are logically ORed according to the following truth table:

TxLineTimSel Bit

TxLineTimSel Pin

Timing Mode

0 0 Line0 1 Source1 0 Source1 1 Source

4.1.1.2 Read TX Command Register The message frame is as follows:

HM MH


3 bytes returned: Data1, Data2, Data3: MSByte first; DataX description is identical to the Set TX Command Register command.

NOTE: The LsENABLE and TxLINETIMSEL bits read back as set by command 0x40. They do not reflect the effects of the HW pins on the module’s present activity.

4.1.1.3 Save TX Command Register This command saves the current TX command register value in a unique location of the module's nonvolatile memory. The data stored by this command can only be retrieved by the “Restore Tx Command Register” command. Saving the current register values via this command has no effect on values used after the module is reset.



No operands.





/8704-AUG-03

4.1.1.4 Restore TX Command Register This command changes the TX command register to the value previously stored using the Save TX Command Register command.



No operands.

4.1.1.5 Set RX Command Register This command sets the module's RX command register. This value is nonvolatile. After a power disruption or reset, the last value written to this register is restored.








/8704-AUG-03

Data Bit Name Condition DefaultData 1

0-7 FFU All 1’s

Data2

0 RxMUTE Dout (Mutes the RxDout[0:15])

0 for mute1 for normal operation

1

1 RxDLOOPENB (diagnostic loopback)


1

2 SCRxRESET (Self-Clearing DeMux system reset)


1

3 PRBSEN (enables PRBS checker)

0 for PRBS mode1 for normal operation

1

4 PRBSPAT0 (PRBS data length)

Pat1 Pat0 Pattern0 0 27

0 1 215

1 0 223

1 1 231

1

5 PRBSPAT1 (PRBS data length)

1

6~7 FFU All 1’sData3

0 RxRATESEL0 (rate selection of system)

Sel1 Sel0 Rate (Gbps)

0 0 FFU0 1 FFU1 0 43.1

(FEC)1 1 39.8

(SONET)

1

1 RxRATESEL1 (rate selection of system)

1

2 RxREFSEL (selects RxREFCLK frequency)

0 for RXREFCLK = fedata/4 1 for RXREFCLK = fedata

0

3 RxLCKREF (Locks RxDCK to RxREFCLK)

0 locks RXDCK to RXREFCLK1 for normal operation

1

4 RxMONCLKSEL (selects RxMONCLK frequency)

0 for RXMONCLK = fedata/41 for RXMONCLK = fedata

1

5 RxRESET (DeMux system reset)


1

6 RxMUTERxDCK (mutes the RxDCLK)

0 for RxDCK mute1 for normal operation

1

7 RxMUTEMONCLK (mutes the RxMONCLK)

0 for RXMONCLK mute1 for normal operation

1

fedata is defined to be the single data channel input/output electrical data rate (e.g., 2.488 Gbps at SONET optical data rate)

Note: RxRESET holds in reset until commanded to release the reset condition. SCRxRESET releases the reset automatically after the reset actions are complete

(except when RxRESET indicates to hold reset).





/8704-AUG-03


4.1.1.6 Read RX Command Register The message frame is as follows:

HM MH


3 bytes returned: Data1, Data2, Data3: MSByte first DataX description is identical to the Set RX Command Register command.

4.1.1.7 Save RX Command Register This command saves the current RX command register value in a unique location of the module's nonvolatile memory. The data stored by this command can only be retrieved by the “Restore Rx Command Register” command. Saving the current register values via this command has no effect on values used after the module is reset.



No operands.

4.1.1.8 Restore RX Command Register This command changes the RX command register to the value previously stored using the Save RX Command Register command.



No operands.

4.1.1.9 Deleted

4.1.1.10 Set Laser ITU Channel This command sets the laser wavelength (if tunable). This command is nonvolatile.






/8704-AUG-03

HM

MH

CMD LGTH DATA DATA DATA STS LGTH

0x49 0x03 Data1 Data2 Data3 STS 0x00

3 byte operand: Data1, Data 2, Data3; Data1: Band


Data2-3 Units: ITU channel number; Data2-3 format for C-band (one field, bits 15:0): fixed point binary ITU grid number

12.4, where the four least significant bits (3:0) represents a fraction of 0.0625 (1/16), bits 15:4 represent integers 1 through 81 (valid channel range);

o The ITU channel number is based on the 50 GHz spacing presented in Annex A of ITU-T-G.692 (10/98). This numbering scheme extends to 3.125 GHz spacing with the addition of the fraction. The channel number is determined by the following equation (all frequencies in THz):

.

o Examples: 193.875000 THz = channel 45.5000 = data2-3 0x02D8, 195.550 THz = channel 12.0000 = data2-3 0x00C0, 192.103125 THz = channel 80.9375 = data2-3 0x050F.

Other band channel numbering is for future study.

4.1.1.11 Read Laser ITU Channel This command returns the laser wavelength setting.


MH

CMD LGTH

STS LGTH

DATA DATA DATA

0x4A 0x00 STS 0x03 Data1 Data2 Data3



Data2-3 Unit: ITU channel number (see Set Laser ITU Channel for definition).10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

4.1.1.12 Set Receive Decision Threshold This command sets the receive decision threshold. This value is stored in volatile memory.


H

CMD LGTH

DATA DATA STS

LGTH

0x4B 0x02 Data1 Data2 STS

0x00

2 byte operand is as follows: Data1: integer, Data2: fraction; Data Unit: percent (see 40Gb Reference Document for further definition); Data format: unsigned fixed point binary, valid range 0.0000 to 100.0000 in

1/256% steps; Accuracy and resolution: Vendor specific.

4.1.1.13 Read Receive Decision Threshold This command reads the present setting of the Receive Decision Threshold.


CMD LGTH STS LGTH DATA DATA0x4C 0x00 STS 0x02 Data1 Data2

2 bytes returned: Data1: integer, Data2: fraction; Data Unit: percent (see 40Gb Reference Document for further definition) ; Data format: unsigned fixed point binary, valid range 0.0000 to 100.0000 in

1/256% steps; Resolution: vendor specific.

4.1.1.14 Set DEMUX Phase Offset This command sets the DEMUX CDR phase offset. This command is stored in volatile memory therefore the module returns to the factory preset on reset.


CMD LGTH DATA STS LGTH0x4D

0x01 Data1 STS 0x00

1 byte operand:10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

Data1 phase offset; Data Unit: Degrees; Data format: 8 bit two’s complement; Range: -127º ≤ Data1 ≤ +127º, maximum; Accuracy: Vendor specific.

4.1.1.15 Read DEMUX Phase Offset This command reads the presently used DEMUX CDR phase offset.


CMD LGTH STS LGTH DATA0x4E 0x00 STS 0x01 Data1

1 byte returned: Data1: phase offset; Data Unit: Degrees; Data format: 8 bit two’s complement; Range: -127º ≤ Data1 ≤ +127º.

4.1.1.16 Set Configurable Alarm This command configures the configurable alarm pin. This value is stored in nonvolatile memory.


CMD LGTH DATA STS LGTH0x4F 0x01 Data1 STS 0x00

1 byte operand: Data 1: defined in the following table:





/8704-AUG-03

Data Value (Decimal)

Name

Data1 0 (Default) RxPOWALM (Loss average optical power alarm)

1 RxLOCKERR (Loss of RxPLL lock indicator)2 Reserved3 LsBIASALM (Laser bias current alarm)4 LsTEMPALM (Laser temperature alarm)5 TxLOCKERR (Loss of TxPLL lock indicator)6 TxFIFO ERR (Mux FIFO error indicator)7 TxOOA (SFI-5 DESKEW Alarm)8 PRBSERRDET (an error was detected by

the PRBS error checker)9 PRBSCntHalfFull (PRBS error counter

register is half full)10 EOL (end of life)11 PSUMMARY (power supply fault)12-239 FFU240-255 Vendor Specific

See “Reference Document for 300 Pin 40Gb Transponder” for alarm activation - deactivation conditions and timing.

4.1.1.17 Read Configurable Alarm This command reads the present assignment of the configurable alarm pin.



1 byte returned: Data1: defined in Set Configurable Alarm command.

4.1.2 Measurement Codes The module operation can be monitored using these commands.

4.1.2.1 Laser Bias Current Monitor This command returns the magnitude of the laser power setting bias current, LsBIAS-MON.







/8704-AUG-03

3 bytes returned: Data1, Data 2, Data3: MSByte first; Data Unit: A; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

4.1.2.2 Laser Output Power Monitor This command returns the laser output optical power LsPOWMON.



3 bytes returned: Data1, Data 2, Data3: MSByte first; Data Unit: W; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

4.1.2.3 Laser Temperature Monitor This command returns the laser temperature, LsTEMPMON. NOTE: The value returned is a relative error to the factory determined correct laser operating temperature.



3 bytes returned: Data1, Data 2, Data3: MSByte first; Data Unit: mC; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

4.1.2.4 Receiver Signal Monitor AC Optical Power This command returns the received AC (modulated) optical signal power, RxSIGMON.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x63 0x00 STS


3 bytes returned: Data1, Data 2, Data3: MSByte first;





/8704-AUG-03

Data Unit: TBD; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

4.1.2.5 Receiver Signal Monitor Average Optical Power This command returns the average received optical power, RxPOWMON.



3 bytes returned: Data1, Data 2, Data3: MSByte first; Data Unit: nW; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

4.1.2.6 Laser Wavelength Monitor This command returns the offset from the exact ITU channel wavelength.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x65 0x00 STS


3 bytes returned: Data1, Data2, Data3: MSByte first; Data Unit: MHz; Data format: 24 bits two’s complement; Accuracy: Vendor specific.

4.1.2.7 Transponder Temperature Monitor This command returns the ambient circuit card or case temperature within the module. See vendor data for the exact location of the sensor within the module.



3 bytes returned: Data1, Data 2, Data3: MSByte first; Data Unit: mC; Data format: 24 bits two’s complement;





/8704-AUG-03

Accuracy: Vendor specific.

4.1.2.8 Photodiode Temperature Monitor This command returns the temperature of the photodiode.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x67 0x00 STS



4.1.2.9 Modulator Bias Monitor This command returns the linearly scaled value of the modulator bias control. The scaling is such that when this monitor reads the vendor specified, the bias control is at (or beyond) the maximum operational value for this module’s design. A returned value of zero will indicate that the bias control is at (or below) the minimum operating voltage. All references are assuming an absolute value of the bias control.



2 bytes returned: Data1, Data 2: MSByte first; Data Unit: none, value scaled to fit to 16 bits; Data format: 16 bit, unsigned; Accuracy: Vendor specific number of most significant bits, the remaining least

significant bits will always read 0 (left justified, vendor specific number of significant bits).

4.1.2.10 Read Error Checker Error Count This command returns the DEMUX PRBS error checker count.



2 bytes returned:10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

Data1, Data2, MSB first; Data Unit: Errors; Data format: 16 bits unsigned binary, destructive read (reset to 0 after read),

saturates at 0xFFFF.

4.1.2.11 Laser Output Power Monitor (in dBm) This command returns the laser output optical power LsPOWMON.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x6A 0x00 STS



4.1.2.12 Receiver Signal Monitor Average Optical Power (in dBm) This command returns the average received optical power, RxPOWMON.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0x6B 0x00 STS







/8704-AUG-03

4.1.3 Alarm Codes The module alarm status can be monitored using these commands. The following figure gives a pictorial flow of the alarms and masks.

4.1.3.1 Read TX Alarm Status Register This command returns a bit field indicating the state of each transmit alarm with alarm conditions as specified in the “Reference Document For 300 Pin 40Gb Transponder”. These alarms are latching. Alarm bits in this register remain in the alarmed state until a read of this register occurs after the alarm condition has been cleared for greater than or equal to the deactivation time. Note that on power-up, many alarms may be set until the module completes initialization. Therefore, the host should read this register as part of module initialization to clear those alarms.







/8704-AUG-03

3 bytes returned: Data1, Data2, Data3: MSByte first DataX description is as follows:

Data Bit Name ConditionData1 0~7 FFU All bits 1Data2 0 EOLALM (Laser end of life alarm) 0 for alarm since last read, 1 for no

alarm since last read or if not implemented

1 ModTEMPALM (Modulator Temperature Alarm)


2 TxOOA (SFI-5 DESKEW alarm) 0 for alarm since last read, 1 for no alarm since last read

3 TxLOFALM (Loss of Frame alarm) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

4 TxDSCERR (Latching SFI-5 DESKEW Channel error, cleared on read)


5 LsWAVALM (Laser Wavelength Alarm)


6~7 FFU All bits 1Data3 0 TxALM INT (Tx summary alarm) 0 for alarm since last read, 1 for no

alarm since last read1 LsBIASALM (Laser bias current alarm) 0 for alarm since last read, 1 for no

alarm since last read2 LsTEMPALM (Laser temperature

alarm)0 for alarm since last read, 1 for no alarm since last read

3 TxLOCKERR (Loss of TxPLL lock indicator)


4 Reserved This bit was transient TxFIFOERR in Edition 3 and earlier. It is recommended that hosts not use this bit for new designs and that modules make this bit mirror Data3 bit 7 for backwards compatibility.

5 LsPOWALM (Laser power alarm) 0 for alarm since last read, 1 for no alarm since last read

6 ModBIASALM (Modulator bias alarm) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

7 LATCHEDTxFIFOERR (Historical Mux FIFO error indicator)


4.1.3.2 Read RX Alarm Status Register This command returns a bit field indicating the state of each receive alarm with alarm conditions as specified in the “Reference Document For 300 Pin 40Gb Transponder”. These alarms are latching. Alarm bits in this register remain in the alarmed state until a read of this register occurs after the alarm condition has been cleared for greater than or 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

equal to the deactivation time. Note that on power-up, many alarms may be set until the module completes initialization. Therefore, the host should read this register as part of module initialization to clear those alarms.

HM MH


2 bytes returned: Data1, Data2: MSByte first DataX description is as follows:

Data Bit Name ConditionData1 0~7 FFU All bits 1Data2 0 RxALM INT (RX summary alarm,

with exception to PRBSERRDET)0 for alarm since last read, 1 for no alarm since last read (PRBSERRDET excluded from both states)

1 RxPOWALM (Loss average optical power alarm)


2 RxLOS (Loss AC (modulated) power alarm)


3 RxLOCKERR (Loss of RxPLL lock indicator)


4 RXS (SFI-5 DEMUX status) 0 for alarm since last read, 1 for no alarm since last read

5 PRBSERRDET (an error was detected by the PRBS error checker)


6~7 FFU All bits 1

4.1.3.3 Read Power Supply Alarm Status Register This command returns a bit field indicating if each power supply is within the voltage window specified in the “Reference Document For 300 Pin 40Gb Transponder”. These alarms are latching. Alarm bits in this register remain in the alarmed state until a read of this register occurs after the alarm condition has been cleared for greater than or equal to the deactivation time. Note that on power-up, many alarms may be set until the module completes initialization. Therefore, the host should read this register as part of module initialization to clear those alarms.








/8704-AUG-03

Data Bit Name ConditionData1 0 PSUMMARY (Power summary

alarm)0 for alarm since last read, 1 for no alarm since last read or if not implemented

1 P5VANALOG (+5V analog) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

2 N5V2ANALOG (-5.2V analog) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

3 P3P3VANALOG (+3.3V analog) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

4 P3P3VDIGITAL (+3.3V digital) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

5 LVDIGITAL (low voltage digital) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

6 N5P2VDIGITAL (-5.2V digital) 0 for alarm since last read, 1 for no alarm since last read or if not implemented

7 FFU 1

4.1.3.4 Set Rx Interrupt Alarm Mask Register This command inhibits the disabled alarms from contributing to the STAT_INT pin output. Alarm masks are volatile and set back to the default at reset. Optional masks must be im-plemented if the corresponding alarm bits are implemented.

The message frame are as follows:HM MH

CMD LGTH DATA DATA STS LGTH0x83 0x02 Data1 Data2 STS 0x00

2 byte operand: Data1, Data2: MSB first; DataX description is as follows:


7FFU All bits 1 N/A

Data2 0 Reserved 0 01 RxPOWALM (Loss average optical power alarm) 0 for alarm enabled, 1 for alarm

disabled0

2 RxLOS (Loss of AC (modulated) optical signal) 0 for alarm enabled, 1 for alarm disabled

0

3 RxLOCKERR (Loss of RxPLL lock indicator) 0 for alarm enabled, 1 for alarm disabled

0

4 RXS (SFI-5 DEMUX status) 0 for alarm enabled, 1 for alarm disabled

0

5 PRBSERRDET (an error was detected by the PRBS error checker)


0

6~7

FFU All bits 1 N/A


4.1.3.5 Read Rx Interrupt Alarm Mask Register The message frame is as follows:10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

HM MH


DataX description is as shown in the Set Rx Interrupt Alarm Mask Register command.

4.1.3.6 Set Tx Interrupt Alarm Mask Register This command inhibits the disabled alarms from contributing to the STAT_INT pin output. Alarm masks are volatile and set back to the default at reset. Optional masks must be im-plemented if the corresponding alarm bits are implemented.



3 byte operand: Data1, Data2, Data3: MSB first; DataX description is as follows:


7FFU All bits 1 N/A

Data2 0 EOLALM (Laser end of life alarm) 0 for alarm enabled, 1 for alarm disabled

0

1 ModTEMPALM (Modulator Temperature Alarm) 0 for alarm enabled, 1 for alarm disabled

0

2 TxOOA (SFI-5 DESKEW alarm) 0 for alarm enabled, 1 for alarm disabled

0

3 TxLOFALM (Loss of Frame alarm) 0 for alarm enabled, 1 for alarm disabled

0

4 TxDSCERR (SFI-5 DESKEW Channel error) 0 for alarm enabled, 1 for alarm disabled

0

5 LsWAVALM (Laser Wavelength Alarm) 0 for alarm enabled, 1 for alarm disabled

0

6~7

FFU All bits 1 N/A

Data3 0 Reserved 0 01 LsBIASALM (Laser bias current alarm) 0 for alarm enabled, 1 for alarm

disabled0

2 LsTEMPALM (Laser temperature alarm) 0 for alarm enabled, 1 for alarm disabled

0

3 TxLOCKERR (Loss of TxPLL lock indicator) 0 for alarm enabled, 1 for alarm disabled

0

4 TxFIFO ERR (Mux FIFO error indicator) 0 for alarm enabled, 1 for alarm disabled

0

5 LsPOWALM (Laser power alarm) 0 for alarm enabled, 1 for alarm disabled

0

6 ModBIASALM (Modulator bias alarm) 0 for alarm enabled, 1 for alarm disabled

0

7 LATCHEDTxFIFOERR (Historical Mux FIFO error indicator)


0





/8704-AUG-03


4.1.3.7 Read Tx Interrupt Alarm Mask Register The message frame is as follows:

HM MH


DataX description is as shown in the Set Tx Interrupt Alarm Mask Register command.

4.1.3.8 Set Power Supply Alarm Mask Register This command inhibits the disabled alarms from contributing to the STAT_INT pin output. Alarm masks are volatile and set back to the default at reset. Optional masks must be implemented if the corresponding alarm bits are implemented.


CMD LGTH DATA STS LGTH0x87 0x01 Data1 STS 0x00

1 byte operand: Data1 description is as follows:

Data Bit

Name Condition Default*

Data1 0 Reserved 0 N/A1 P5VANALOG (+5V analog) 0 for alarm enabled, 1 for alarm

disabled0

2 N5V2ANALOG (-5.2V analog) 0 for alarm enabled, 1 for alarm disabled

0

3 P3P3VANALOG (+3.3V analog)


0

4 P3P3VDIGITAL (+3.3V digital) 0 for alarm enabled, 1 for alarm disabled

0

5 LVDIGITAL (low voltage digital) 0 for alarm enabled, 1 for alarm disabled

0

6 N5P2VDIGITAL (-5.2V digital) 0 for alarm enabled, 1 for alarm disabled

0

7 FFU 1 N/A* For optional bits, default is 0 if alarm and mask implemented, 1 if alarm and mask not implemented.

4.1.3.9 Read Power Supply Alarm Mask Register The message frame is as follows:

HM MH


Data1 description is as shown in the Set Power Supply Alarm Mask Register command.10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40 Giga MSA 10 Giga and 40

G




/8704-AUG-03

4.1.3.10 Read Summary Alarm Register This command returns a bit field indicating the state of each summary alarm bit specified in the individual Tx, Rx, and Power alarm registers. This register is designed to allow a quick determination of which sub-alarm registers have active alarms. These bits mirror the state of the individual alarm registers. Therefore, reading of the individual command registers controls the latching feature of these bits.




Data Bit Name ConditionData1 0 TxALM INT (TX summary alarm) Mirror of command 0x80, Data3, Bit 0

1 RxALM INT (RX summary alarm) Mirror of command 0x81, Data2, Bit 02 PSUMMARY (Power summary

alarm)Mirror of command 0x82, Data1, Bit 0 or 1 if not implemented

3~7 FFU All bits 1

4.1.3.11 Interrupt Control This command changes the behavior of the STAT_INT pin. Please refer to section 2.3.4 for detailed description of each mode. This command is nonvolatile.


CMD LGTH DATA STS LGTH DATA0x8A 0x01 Action STS 0x01 Result

1 byte operand: Action:

o 0x01 Read present modeo 0x02 Enter logical OR modeo 0x04 Enter edge modeo 0x08 Clear IRQ (Edge only)o All other codes reserved

1 byte returned: Result:

o 0x02 Logical OR modeo 0x04 Edge modeo 0x08 IRQ Clearing (Edge only)o All other codes reserved





/8704-AUG-03

4.1.4 Identifier Codes Module identifying information can be read using these commands.

4.1.4.1 Read Supplier Identifier Code This command returns the supplier number.


CMD LGTH STS LGTH DATA0xA0 0x00 STS 0x01 IC

1 Byte returned: IC (Identifier Code) IC (Identifier Code) is defined as follows. For an up to date list of supplier codes

and application procedures see http://www.300pinmsa.org/. Members

o 0x00 Unidentified vendoro 0x01 Alcatel Optronicso 0x02 TriQuint Optoelectronics (including legacy Agere Systems

modules)o 0x03 OpNexto 0x04 Mitsubishi Electrico 0x05 Agilent Technologieso 0x06 Reserved (formerly Ericsson Optoelectronics AB)o 0x07 NECo 0x08 ExceLighto 0x09 JDS Uniphaseo 0x0A Fujitsu Quantum Deviceso 0x0B Bookham Technology (including legacy Nortel Networks

modules)o 0x0C – 0x2F FFU

Non-Memberso 0x30 – 0xFF, see http://www.300pinmsa.org/ for latest listing.

4.1.4.2 Read Module Type Code This command returns the module type.


CMD LGTH STS LGTH DATA0xA1 0x00 STS 0x01 TC

1 byte returned: TC (Type Code) is defined as follows:

o 0x00 for undefined type





/8704-AUG-03



o 0x01 VSR2000-2R1 2kmo 0x02 VSR2000-3R1 2kmo 0x03 VSR2000-3R2 2kmo 0x04 VSR2000-3R3 2kmo 0x05 VSR2000-3R5 2kmo 0x06 VSR2000-2L2 2kmo 0x07 VSR2000-2L3 2kmo 0x08 VSR 2000-2L5 2km o 0x09 VSR2000-3M1 2km o 0x0A VSR2000-3M2 2kmo 0x0B VSR2000-3M3 2kmo 0x0C VSR2000-3M5 2kmo 0x0D VSR2000-3H2 2kmo 0x0E VSR2000-3H3 2kmo 0x0F VSR2000-3H5 2kmo 0x10 to 0xFF Reserved for Future Use

4.1.4.3 Read Customer Parameters This command returns 1 to 16 bytes stored in the 64 bytes customer dedicated area of the module's nonvolatile memory.


CMD LGTH DATA DATA STS LGTH DATA … DATA0xA2 0x02 ADD N STS N Data1 … DataN

2 bytes operand: ADD (memory ADDress, range is 0x00 to 0x3F) N [number of contiguous bytes to return (0x01 to 0x10, inclusive)]

N bytes returned: Data (stored data)

Usage: ADD+ N-1 ≤ 0x3F for the command to be valid.

4.1.4.4 Write Customer Parameters This command stores 1 to 16 bytes in the 64 bytes customer dedicated area of the mod -ule's nonvolatile memory.


CMD LGTH DATA DATA … DATA STS LGTH0xA3 0xN+1 ADD Data1 … DataN STS 0x00





/8704-AUG-03

N+1 bytes operand: ADD (memory ADDress, range is 0x00 to 0x3F) Data1:N (Data to store, 0x01<N0x10)

Usage: All bytes in a write must reside in the same 16 byte page where a page begins with binary address xx0000 and ends with xx1111.

4.1.4.5 Read First Laser ITU Channel This command returns the First ITU Channel setting supported by the module (i.e., minimum wavelength), as defined in the factory prior to shipment.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0xA4 0x00 STS





4.1.4.6 Read Last Laser ITU Channel This command returns the Last ITU Channel setting supported by the module (i.e., maximum wavelength), as defined in the factory prior to shipment.


H

CMD LGTH

STS

LGTH

DATA DATA DATA

0xA5 0x00 STS



o 0x43 = C-Bando 0x4C = L-Bando 0x53 = S-Band





/8704-AUG-03

o Other values reserved for future use Data2-3 Unit: ITU channel number (see Set Laser ITU Channel for definition).

4.1.4.7 Read Laser ITU Channel Spacing This command returns the module’s spacing between defined wavelength channels expressed in a fraction of an ITU channel, as defined in the factory prior to shipment. This command can be used, in conjunction with the First and Last Channel commands, to calculate the number of supported channels for a particular module, and to calculate the specific ITU channel to be set by command 0x49.


H

CMD LGTH

STS

LGTH

DATA

0xA6 0x00 STS

0x01 Data1

1 byte returned: Data1: fixed point binary number 4.4, where the four least significant bits (3:0)

represents a fraction of a 50 GHz ITU Channel spacing, and the four most significant bits (7:4) represent whole ITU channel spacing. This gives a resolution of 1/16 of a 50 GHz ITU channel spacing (3.125 GHz).

o Examples: 100 GHz spacing: Data1 = 0x20; 50 GHz spacing: Data1 = 0x10; 25 GHz spacing: Data1 = 0x08.

4.1.4.8 Read Revision Codes This command returns the vendor defined hardware and software revision codes for the unit queried.


CMD LGTH0xA7 0x00

MH

STS LGTH DATA DATA DATA DATA DATA DATA DATA DATASTS 0x10 HW1 HW2 HW3 HW4 HW5 HW6 HW7 HW8

DATA DATA DATA DATA DATA DATA DATA DATASW1 SW2 SW3 SW4 SW5 SW6 SW7 SW8

16 bytes returned:





/8704-AUG-03

HW1-HW8: hardware revision, up to 8 ASCII characters, vendor specific information, left justified, 0x00 filled;

SW1-SW8: software revision, up to 8 ASCII characters, vendor specific information, left justified, 0x00 filled.

4.1.4.9 Read Unit Serial Number This command returns the vendor defined unit serial number for the unit queried.


CMD LGTH0xA8 0x00

MH



16 bytes returned: Data1-16: unit serial number, up to 16 ASCII characters, vendor specific

information, left justified, 0x00 filled;

4.1.4.10 Read Unit Manufacture Date This command returns the date of manufacture for the unit queried in ISO 8601 calendar date basic format.


CMD LGTH0xA9 0x00

MH

STS LGTH DATA DATA DATA DATA DATA DATA DATA DATASTS 0x08 C1 C2 Y1 Y2 M1 M2 D1 D2

8 bytes returned: C1-2: Century digit 1 and 2, 2 ASCII characters, MSB first (example 20 = 0x32,

0x30); Y1-2: Year digit 1 and 2, 2 ASCII characters, MSB first (example 03 = 0x30, 0x33); M1-2: Month digit 1 and 2, 2 ASCII characters, MSB first (example July = 07 =

0x30, 0x37); D1-2: Day digit 1 and 2, 2 ASCII characters, MSB first (example 01 = 0x30, 0x31).





/8704-AUG-03

4.1.4.11 Read Unit Part Number This command returns the vendor defined part number for the unit queried.


CMD LGTH0xAA 0x00

MH



16 bytes returned: Data1-16: unit part number, up to 16 ASCII characters, vendor specific information,

left justified, 0x00 filled;

4.1.5 Configuration Codes The module configuration can be set and monitored using these commands.

4.1.5.1 Read Link Status This command is provided as a neutral command which purpose is only to return the I 2C link status.


CMD LGTH STS LGTH DATA DATA0xC0

0x00 STS 0x02 0xC0 Data1

2 bytes returned: Fixed value 0xC0 (echo of command number); Data1:

o Standard addressing mode: Module 7-bit address, left justified with bit 0 cleared to zero (binary 1000yyy0);

o Enhanced addressing mode: TBD.

The returned data is provided to verify the STS is in response to the Link Status Command, not a prior command. This extra data will allow the host to synchronize the Command Processed Number (CPN) with the module.





/8704-AUG-03

4.1.5.2 No Operation This command performs no operation. It is available to make the interface backwards compatible with Edition 3 and earlier version of this protocol. Previously this command allowed the module to switch to the non-allocated state and provided no response. Starting with Edition 4, the command now has a response and maintains the CPN.



No operands.

4.1.5.3 Read Maximum I2C Rate This command returns the module's maximum supported I2C data rate.


CMD LGTH STS LGTH DATA0xC2 0x00 STS 0x01 MBR

1 Byte returned: MBR (Maximum Baud Rate)

o 0x01: 100 kbpso 0x04: 400 kbpso Other values reserved for future use

4.1.5.4 Enter Protected Mode This command allows the module to enter the protected mode, this enabling the protected functions. The protected mode is automatically disabled after a protocol processor reset, whatever its status was before. This command is available either to enter the Protected Mode (without password) or to enter the Vendor Protected Mode (with password). The protection state of a module is stored in volatile memory.

The message frame is as follows (Protected Mode):HM MH


No operands.

The message frame is as follows (Vendor Protected Mode):HM MH

CMD LGTH DATA DATA STS LGTH0xC3 LEN K1 … KLEN STS 0x00





/8704-AUG-03

LEN byte operand: 1 ≤ LEN ≤ 8 K1…KLEN (LEN character key, vendor defined).

4.1.5.5 Exit Protected Mode This command allows the module to exit the protected mode, thus disabling the protected functions. The protection state of a module is stored in volatile memory.



0x00 STS 0x00

No operands.

4.1.5.6 Reset CPN This command sets the CPN to zero including in the reply to this command. This command was known as “Allocate Module” in Edition 3 and earlier of this protocol . The Reset CPN command is backwards compatible with the Allocate Module command. The Reset CPN command does have a reply of “OK” should the host read it rather than the non-response that is required by Edition 3 and earlier.



0x00 STS 0x00

4.1.5.7 Read Edition and Mode This command provides the module 300 Pin MSA “I2C Reference Document For 300 Pin 10Gb and 40Gb Transponders” edition compatibility, operational capability, and present operational mode. Since there are no modes defined for 40G at this time, these bits are fixed at zero.


CMD LGTH STS LGTH DATA DATA DATA0xC7 0x00 STS 0x03 EDN CAP OPR

The 3 bytes returned are as follows: First byte (EDN): Edition, binary number indicating the Edition Number of the 300

Pin MSA “I2C Reference Document For 300 Pin 10Gb and 40Gb Transponders” which is most compatible with this transponder;

Second byte (CAP): Capability, 0x00 for 40G modules at this time; Third byte (OPR): Operating mode, 0x00 for 40G modules at this time.





/8704-AUG-03

4.1.5.8 Data Loopback This command allows for testing of the communications link by looping back the command data in the response.


CMD LGTH DATA DATA DATA DATA0xC8

0x04 Data1 Data2 Data3 Data4

MH

STS LGTH DATA DATA DATA DATASTS 0x04 Data1 Data2 Data3 Data4

3 bytes operand and returned: Data 1 - 4: 4 bytes of customer provided data, any value is legal.

4.2 Supplier Reserved Commands These commands are not part of the MSA and are provided for extra functions support. Each supplier is free to format these commands as they see fit within the constraints of the framing described in this document.

END OF DOCUMENT





/8704-AUG-03