Common Management Interface Specification

1 Published Rev Common Management Interface Specification Page 1 Common Management Interface Specification Rev May 8, 2019 Abstract: This document defines the Common Management Interface Specification (CMIS) that may be used by pluggable modules with host to module Management communication based on a Two-Wire- Interface (TWI), such as QSFP Double Density (QSFP-DD), OSFP, COBO, QSFP, and SFP-DD. This document provides a Common Specification for systems manufacturers, system integrators, and suppliers of modules and transceivers. POINTS OF CONTACT: Tom Palkert Mark Nowell Scott Sommers Technical Editor Co-Chair Co-Chair Molex Cisco Molex 2222 Wellington Court 170 West Tasman Dr 2222 Wellington Court Lisle, IL 60532-1682 San Jose, CA 95134 Lisle, IL 60532-1682 Ph: +1 (952)-200-8542 Ph: +1 (613)-254-3391 Ph: +1 (630)-527-4317 at mnowell at at Limitation on use of Information: This Specification is provided "AS IS" with NO WARRANTIES whatsoever and therefore the provision of this Specification does not include any warranty of merchantability, noninfringement, fitness for a particular purpose, or any other warranty otherwise arising out of any proposal, Specification or sample.

2 The authors further disclaim all liability, including liability for infringement of any proprietary rights, relating to use of information in this Specification . No license, express or implied, by estoppel or otherwise, to any intellectual property rights is granted herein. Permissions: You are authorized to download, reproduce and distribute this document. All other rights are reserved. The provision of this document should not be construed as the granting of any right to practice, make, use or otherwise develop products that are based on the document. Any and all IP rights related to this document and the designs disclosed within, except for the rights expressly mentioned above, are reserved by the respective owners of those IP rights. Published Rev Common Management Interface Specification Page 2 Foreword The development work on this Specification was done by the QSFP-DD, OSFP and COBO advisory group.

3 Further revisions of the CMIS shall be backwards compatible to implementations conforming to Revision Revision History Rev August 17, 2018: - Initial public release Draft Rev January 7, 2019: - Converted InitMode signal to continuously-sampled LPMode - Associated Module and Data Path State Machine changes - Added LPMode Override bit - Added pages 04h and 12h for tunable laser support - Added diagnostic pages 13h and 14h - New format to conform to SFF - Added Command Data Block (CDB) section (pages 9Fh and A0h-AFh) Draft Rev May 8, 2019: WARNING: Implementations compliant to CMIS Revision of this Specification will not interoperate with revision implementations and vice-versa. The following specifications have changed: - Converted InitMode signal to continuously-sampled LPMode - Data Path initialization control (Page 10h) meaning/polarity has changed - Added LowPwr register (Lower memory, Byte 26, bit 6) to switch power mode Other changes.

4 - Added Scope statement - Added Conventions - Added Definitions - Updated Introduction - Consolidation of section 5 - Rework and Partial Consolidation of section 6 - Added Versatile Digital Diagnostics Monitoring ( ) - Added CDB Feature ( and 9) - Moved Examples to Appendix - Change Upper Page Lower Page terminology (Upper and Lower Memory plus Pages) - Removed Interface ID tables and replaced them with references to SFF-8024 Published Rev Common Management Interface Specification Page 3 Contents 1 Scope and Purpose 13 2 References and Conventions 14 Industry Documents 14 Sources 14 Conventions 14 3 Keywords, Acronyms, and Definitions 16 Keywords 16 Acronyms and Abbreviations 16 Definitions 17 4 Introduction and General Description 20 CMIS Compliant Modules 20 Management Protocol Layers 20 5 Management Interface 21 Management Control Signals 21 Management Communication Interface 21 General Description 21 Physical Layer 21 Serial Communication Protocol 22 Basic Definitions 22 Start Condition (START) 22 Stop Condition (STOP) 22 Word Size (Byte) 22 Basic Operation Encoding (Control Byte) 22 Acknowledge (ACK)

5 22 Clock Stretching 22 Acknowledge Polling 22 Protocol Reset and Recovery 23 Power On Reset 23 Protocol Reset and Recovery 23 Binary Serial Frame Format for Basic Operations 23 Read/Write Control Byte and Response 23 Byte Address and Data 23 Read/Write Operations 24 Slave Memory Current Byte Address Counter (Read and Write Operations) 24 Data Coherency 24 Byte Read Operations 25 Current Address Read Operation 25 Random Read Operation 26 Sequential Bytes Read Operation 27 Sequential Read from Current Start Address 27 Sequential Read from Random Start Address 28 Byte Write Operation 29 Sequential Bytes Write Operation 30 Timing Specifications 31 6 Core Management Features 32 Module Management Basics 32 Host Interface Conventions 32 Media Interface Conventions 32 Interface Memory Map Representations 32 Module Functional Model 33 Published Rev Common Management Interface Specification Page 4 Functional Module Capabilities Applications 33 Advertising Methodology 34 Logical Module Use Data Paths 36 Data Path Configuration Control Sets 36 Control Set Usage 37 Initialization Sequence Examples 38 Signal Integrity Controls 39

6 Tx Input Equalization Control 39 Rx Output Emphasis Control 40 Rx Output Amplitude Control 40 Tx Input Eq Adaptation Store/Recall Methodology 40 Module Behavioral Model 42 Module State Machine 42 Module State Machine, paged memory modules 42 Module State Machine, flat memory modules 47 Module Power Mode control 48 Resetting State 48 Reset State 49 MgmtInit State 49 ModuleLowPwr State 50 ModulePwrUp state 50 ModuleReady State 50 ModulePwrDn State 51 Fault State 51 Data Path State Machine 51 Data Path control and status 56 DataPathDeactivated State 57 DataPathInit State 57 DataPathInitialized State 58 DataPathDeinit State 58 DataPathTxTurnOn State 59 DataPathActivated State 60 DataPathTxTurnOff State 60 Interrupt Flag Conformance per State 61 Module Flag Conformance per State 61 Lane-Specific Flag Conformance per State 62 7 Advanced Management Features 64 Versatile Diagnostics Monitoring (VDM)

7 64 Overview 64 PAM4 Monitored Parameters 65 SNR 66 PAM Level Transition Parameter 66 Error Metrics 67 DWDM Monitored Parameters 68 TEC Current 68 laser Frequency 68 laser Temperature 68 Command Data Block (CDB) Message Communication 69 CDB support levels 69 Sequential CDB (foreground only) 70 One CDB with parallel register access (background mode) 70 Two CDB instances with parallel register access (background mode) 70 Firmware Upgrade Commands in CDB. 71 Firmware Upgrade using CDB 71 Firmware Readback using CDB 72 Published Rev Common Management Interface Specification Page 5 Performance Monitoring using CDB. 74 Module Boot Record (MBR) 75 8 Module Management Memory Map 76 Overview 76 Memory Structure and Mapping 76 Supported Pages 76 General Specifications and Conventions 78 Referring to Bytes and Fields 78 Reserved Bytes, Fields, or Bits 78 Custom Bytes or Fields 78 Register Default Values 79 Lower Memory Page 00h (Control and Status Essentials) 80 ID and Status 81 Lane Flag Summary 82 Module-Level Flags 83 Module-Level Monitors 84 Module Global Controls 85 Module-Level Flag Masks 85 CDB Status 87 Module Active Firmware Version 88 Application Advertising 89 Password Entry and Change 91 Bank Select Byte 91 Page Select Byte 91 Upper Memory - Page 00h (Administrative Information) 92 Identifier 92 Vendor Name (Page 00h, Bytes 129-144, RO, required)

8 92 Vendor Organizationally Unique Identifier (Page 00h, Bytes 145-147, RO, required) 93 Vendor Part Number (Page 00h, Bytes 148-163, RO, required) 93 Vendor Revision Number (Page 00h, Bytes 164-165, RO, required) 93 Vendor Serial Number (Page 00h, Bytes 166-181, RO, required) 93 Date Code 93 CLEI Code 93 Module Power Characteristics 93 Cable Assembly Length 94 Media Connector Type 94 Copper Cable Attenuation 95 Cable Assembly Lane Information 95 Media Interface Technology (required) 97 Page 00h Checksum 97 Custom Info (non-volatile) 97 Page 01h (Advertising) 98 Module Inactive Firmware and Hardware Revisions 98 Supported Link Length 99 Wavelength (Page 01h, Bytes 138 - 139, RO, RQD) 100 Wavelength Tolerance (Page 01h, Bytes 140 - 141, RO, RQD) 100 Implemented Memory Pages and Durations Advertising 100 Module Characteristics Advertising 102 Implemented Controls Advertisement 103 Implemented Flags Advertisement 104 Implemented Monitors Advertisement 104 Implemented Signal Integrity Controls Advertisement 105 CDB Support Advertisement 106 Additional Durations Advertising 108 Media Lane Assignment Options Advertising 109 Published Rev Common Management Interface Specification Page 6 Additional Application Advertising 109 Checksum (Upper Page 01h, Byte 255, RO RQD) 111 Page 02h (Module and Lane Thresholds) 112 Module-Level Monitor Thresholds 112 Lane-specific Monitor Thresholds 114 Checksum (Page 02h, Byte 255, RO RQD) 115 laser Capabilities Advertising (Page 04h, Optional) 116 Page 10h (Lane and Data Path Control)

9 119 Data Path Initialization Control 119 Lane-Specific Direct Effect Control Fields 120 Staged Control Set 0 124 Apply Controls 124 Application Select Controls 124 Tx and Rx Signal Integrity Controls 125 Staged Control Set 1 128 Apply Controls 128 Application Select Controls 128 Tx and Rx Signal Integrity Controls 129 Lane-Specific Flag Masks 131 Page 11h (Lane Status) 136 Data Path State Indicator 136 Lane-Specific Flags 137 Lane-Specific Monitors 140 Configuration Error Codes 142 Active Control Set 143 Application Select Fields 143 Tx and Rx Signal Integrity Fields 144 Module Media Lane to Module Media Wavelength and Fiber Mapping 146 Page 12h (Tuneable laser Control and Status) 153 Page 13h (Module Diagnostics 1) 155 Loopback Capabilities Advertisement 156 General Pattern Capabilities Advertisement 158 Diagnostic Reporting Capabilities Advertisement 159 Pattern Generation and Checking Location Advertisement 160 Pattern Generation and Checking Capabilities Advertisement 161 Host Side Pattern Generator Controls 165 Media Side Pattern Generator Controls 166 Host Side Pattern Checker Controls 167 Media Side Pattern Checker Controls 168 Generator/Checker Controls 169 Controls and Behavior Un-Gated Mode 172 Controls and Behavior Single Gate Timer 173 Controls and Behavior Per Lane Gate Timer 174 Controls 176 Flag Masks 177 Pattern 178 Page 14h (Module Diagnostics 2) 179 Diagnostics Selection Register 179 Latched Diagnostics Flags 180 Error Information Registers 181 Pages 20h-2Fh (VDM)

10 185 Pages 20h-23h (VDM Configuration Pages) 185 Versatile VDM Configuration Setting Bytes 186 Versatile VDM Configuration Parameter List 187 Pages 24h-27h (VDM Real Time Value Pages) 188 Published Rev Common Management Interface Specification Page 7 Pages 28h-2Bh (VDM Threshold Pages) 190 Page 2Ch (VDM Alarms) 192 Page 2Dh (VDM Mask) 194 Page 2Fh (VDM Advertisement and Controls) 195 VDM Detailed Description of Monitored Parameters 197 Page 9Fh (CDB Messaging) 198 Triggering CDB on Writes to Page 9Fh Byte 129 200 Triggering CDB on STOP bit 200 Pages A0h-AFh (CDB Extended Payload Pages) 201 9 CDB Command Reference 202 CDB Command Group Summary 202 CDB Module Commands 203 CMD 0000h: QUERY Status 204 CMD 0001h: Enter Password 205 CMD 0002h: Change Password 205 CMD 0003h: Enable/Disable Password Protection 207 CMD 0004h: General ABORT 208 CDB Feature and Capabilities Implemented 209 CMD 0040h: Module Features Implemented 210 CMD 0041h: Firmware Update Features Implemented 211 CMD 0042h: Performance and Data Monitoring Features Implemented 213 CMD 0043h: BERT and Diagnostics Features Implemented 214 CDB Bulk Read Commands 215 CDB Bulk Write Commands 216 CDB Firmware Download Commands 217 CMD 0100h: Get Firmware Info 219 CMD 0101h: Start Firmware Download 221 CMD 0102h: Abort Firmware Download 222 CMD 0103h: Write Firmware Image LPL 223 CMD 0104h: Write Firmware Image EPL 224 CMD 0105h: Read Firmware Image LPL 225 CM