1#!/usr/libexec/flua 2-- ex: sw=4 et: 3--[[ 4/*- 5 * Copyright (c) 2014, Alexander V. Chernikov 6 * Copyright (c) 2020, Ryan Moeller <freqlabs@FreeBSD.org> 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29]] 30 31-- Try to put the template.lua library in the package search path. 32package.path = (os.getenv("SRCTOP") or "/usr/src").."/tools/lua/?.lua" 33 34-- Render the template named by the first argument to this script. 35require("template").render(arg[1], { -- This table is the template's context. 36 37-- The table `enums' is accessible in the template. It is a list of strings 38-- and tables that describe the various enum types we are generating and the 39-- ancillary metadata for generating other related code. 40enums = { 41 42 -- Strings at this level are rendered as block comments for convenience. 43 "SFF-8024 Rev. 4.6 Table 4-1: Indentifier Values", 44 45 -- This table describes an enum type, in this case enum sfp_id: 46 { 47 name = "id", -- The template prepends the sfp_ prefix to our name. 48 description = "Transceiver identifier", 49 50 -- What width int is needed to store this type: 51 bits = 8, -- This could be inferred by the values below... 52 53 -- The values, symbols, display names, and descriptions of this enum: 54 values = { 55 -- The prefix SFP_ID_ is prepended to the symbolic names. 56 -- Only this enum has shortened names for the values, though they 57 -- could be added to the other enums. 58 59 -- value, symbolic name, description, shortened name 60 {0x00, "UNKNOWN", "Unknown or unspecified", "Unknown"}, 61 {0x01, "GBIC", "GBIC", "GBIC"}, 62 {0x02, "SFF", "Module soldered to motherboard (ex: SFF)", 63 "SFF"}, 64 {0x03, "SFP", "SFP or SFP+", "SFP/SFP+/SFP28"}, 65 {0x04, "XBI", "300 pin XBI", "XBI"}, 66 {0x05, "XENPAK", "Xenpak", "Xenpak"}, 67 {0x06, "XFP", "XFP", "XFP"}, 68 {0x07, "XFF", "XFF", "XFF"}, 69 {0x08, "XFPE", "XFP-E", "XFP-E"}, 70 {0x09, "XPAK", "XPAK", "XPAK"}, 71 {0x0A, "X2", "X2", "X2"}, 72 {0x0B, "DWDM_SFP", "DWDM-SFP/SFP+", "DWDM-SFP/SFP+"}, 73 {0x0C, "QSFP", "QSFP", "QSFP"}, 74 {0x0D, "QSFPPLUS", "QSFP+ or later", "QSFP+"}, 75 {0x0E, "CXP", "CXP", "CXP"}, 76 {0x0F, "HD4X", "Shielded Mini Multilane HD 4X", "HD4X"}, 77 {0x10, "HD8X", "Shielded Mini Multilane HD 8X", "HD8X"}, 78 {0x11, "QSFP28", "QSFP28 or later", "QSFP28"}, 79 {0x12, "CXP2", "CXP2 (aka CXP28)", "CXP2"}, 80 {0x13, "CDFP", "CDFP (Style 1/Style 2)", "CDFP"}, 81 {0x14, "SMM4", "Shielded Mini Multilane HD 4X fanout", 82 "SMM4"}, 83 {0x15, "SMM8", "Shielded Mini Multilane HD 8X fanout", 84 "SMM8"}, 85 {0x16, "CDFP3", "CDFP (Style 3)", "CDFP3"}, 86 {0x17, "MICROQSFP", "microQSFP", "microQSFP"}, 87 {0x18, "QSFP_DD", "QSFP-DD 8X pluggable transceiver", "QSFP-DD"}, 88 {0x19, "QSFP8X", "QSFP 8X pluggable transceiver", "QSFP8X"}, 89 {0x1A, "SFP_DD", "SFP-DD 2X pluggable transceiver", "SFP-DD"}, 90 {0x1B, "DSFP", "DSFP Dual SFP pluggable transceiver", "DSFP"}, 91 {0x1C, "X4ML", "x4 MiniLink/OcuLink", "x4MiniLink/OcuLink"}, 92 {0x1D, "X8ML", "x8 MiniLink", "x8MiniLink"}, 93 {0x1E, "QSFP_CMIS", 94 "QSFP+ or later w/Common Management Interface Specification", 95 "QSFP+(CMIS)"}, 96 }, 97 }, 98 99 "SFF-8024 Rev. 4.6 Table 4-3: Connector Types", 100 { 101 name = "conn", 102 description = "Connector type", 103 bits = 8, 104 values = { 105 {0x00, "UNKNOWN", "Unknown"}, 106 {0x01, "SC", "SC"}, 107 {0x02, "FC_1_COPPER", "Fibre Channel Style 1 copper"}, 108 {0x03, "FC_2_COPPER", "Fibre Channel Style 2 copper"}, 109 {0x04, "BNC_TNC", "BNC/TNC"}, 110 {0x05, "FC_COAX", "Fibre Channel coaxial"}, 111 {0x06, "FIBER_JACK", "Fiber Jack"}, 112 {0x07, "LC", "LC"}, 113 {0x08, "MT_RJ", "MT-RJ"}, 114 {0x09, "MU", "MU"}, 115 {0x0A, "SG", "SG"}, 116 {0x0B, "OPTICAL_PIGTAIL", "Optical pigtail"}, 117 {0x0C, "MPO_1X12_POPTIC", "MPO 1x12 Parallel Optic"}, 118 {0x0D, "MPO_2X16_POPTIC", "MPO 2x16 Parallel Optic"}, 119 {0x20, "HSSDC_II", "HSSDC II"}, 120 {0x21, "COPPER_PIGTAIL", "Copper pigtail"}, 121 {0x22, "RJ45", "RJ45"}, 122 {0x23, "NONE", "No separable connector"}, 123 {0x24, "MXC_2X16", "MXC 2x16"}, 124 {0x25, "CS_OPTICAL", "CS optical connector"}, 125 {0x26, "MINI_CS_OPTICAL", "Mini CS optical connector"}, 126 {0x27, "MPO_2X12_POPTIC", "MPO 2x12 Parallel Optic"}, 127 {0x28, "MPO_1X16_POPTIC", "MPO 1x16 Parallel Optic"}, 128 }, 129 }, 130 "SFF-8472 Rev. 11.4 table 3.5: Transceiver codes", 131 "10G Ethernet/IB compliance codes, byte 3", 132 { 133 name = "eth_10g", 134 description = "10G Ethernet/IB compliance", 135 bits = 8, 136 values = { 137 {0x80, "10G_BASE_ER", "10G Base-ER"}, 138 {0x40, "10G_BASE_LRM", "10G Base-LRM"}, 139 {0x20, "10G_BASE_LR", "10G Base-LR"}, 140 {0x10, "10G_BASE_SR", "10G Base-SR"}, 141 {0x08, "1X_SX", "1X SX"}, 142 {0x04, "1X_LX", "1X LX"}, 143 {0x02, "1X_COPPER_ACTIVE", "1X Copper Active"}, 144 {0x01, "1X_COPPER_PASSIVE", "1X Copper Passive"}, 145 }, 146 }, 147 "Ethernet compliance codes, byte 6", 148 { 149 name = "eth", 150 description = "Ethernet compliance", 151 bits = 8, 152 values = { 153 {0x80, "BASE_PX", "BASE-PX"}, 154 {0x40, "BASE_BX10", "BASE-BX10"}, 155 {0x20, "100BASE_FX", "100BASE-FX"}, 156 {0x10, "100BASE_LX_LX10", "100BASE-LX/LX10"}, 157 {0x08, "1000BASE_T", "1000BASE-T"}, 158 {0x04, "1000BASE_CX", "1000BASE-CX"}, 159 {0x02, "1000BASE_LX", "1000BASE-LX"}, 160 {0x01, "1000BASE_SX", "1000BASE-SX"}, 161 }, 162 }, 163 "FC link length, byte 7", 164 { 165 name = "fc_len", 166 description = "Fibre Channel link length", 167 bits = 8, 168 values = { 169 {0x80, "VERY_LONG", "very long distance"}, 170 {0x40, "SHORT", "short distance"}, 171 {0x20, "INTERMEDIATE", "intermediate distance"}, 172 {0x10, "LONG", "long distance"}, 173 {0x08, "MEDIUM", "medium distance"}, 174 }, 175 }, 176 "Channel/Cable technology, byte 7-8", 177 { 178 name = "cab_tech", 179 description = "Channel/cable technology", 180 bits = 16, 181 values = { 182 {0x0400, "SA", "Shortwave laser (SA)"}, 183 {0x0200, "LC", "Longwave laser (LC)"}, 184 {0x0100, "EL_INTER", "Electrical inter-enclosure (EL)"}, 185 {0x0080, "EL_INTRA", "Electrical intra-enclosure (EL)"}, 186 {0x0040, "SN", "Shortwave laser (SN)"}, 187 {0x0020, "SL", "Shortwave laser (SL)"}, 188 {0x0010, "LL", "Longwave laser (LL)"}, 189 {0x0008, "ACTIVE", "Active Cable"}, 190 {0x0004, "PASSIVE", "Passive Cable"}, 191 }, 192 }, 193 "FC Transmission media, byte 9", 194 { 195 name = "fc_media", 196 description = "Fibre Channel transmission media", 197 bits = 8, 198 values = { 199 {0x80, "TW", "Twin Axial Pair (TW)"}, 200 {0x40, "TP", "Twisted Pair (TP)"}, 201 {0x20, "MI", "Miniature Coax (MI)"}, 202 {0x10, "TV", "Video Coax (TV)"}, 203 {0x08, "M6", "Miltimode 62.5um (M6)"}, 204 {0x04, "M5", "Multimode 50um (M5)"}, 205 {0x02, "RESERVED", "Reserved"}, 206 {0x01, "SM", "Single Mode (SM)"}, 207 }, 208 }, 209 "FC Speed, byte 10", 210 { 211 name = "fc_speed", 212 description = "Fibre Channel speed", 213 bits = 8, 214 values = { 215 {0x80, "1200", "1200 MBytes/sec"}, 216 {0x40, "800", "800 MBytes/sec"}, 217 {0x20, "1600", "1600 MBytes/sec"}, 218 {0x10, "400", "400 MBytes/sec"}, 219 {0x08, "3200", "3200 MBytes/sec"}, 220 {0x04, "200", "200 MBytes/sec"}, 221 {0x01, "100", "100 MBytes/sec"}, 222 }, 223 }, 224 "SFF-8436 Rev. 4.8 table 33: Specification compliance", 225 "10/40G Ethernet compliance codes, byte 128 + 3", 226 { 227 name = "eth_1040g", 228 description = "10/40G Ethernet compliance", 229 bits = 8, 230 values = { 231 {0x80, "EXTENDED", "Extended"}, 232 {0x40, "10GBASE_LRM", "10GBASE-LRM"}, 233 {0x20, "10GBASE_LR", "10GBASE-LR"}, 234 {0x10, "10GBASE_SR", "10GBASE-SR"}, 235 {0x08, "40GBASE_CR4", "40GBASE-CR4"}, 236 {0x04, "40GBASE_SR4", "40GBASE-SR4"}, 237 {0x02, "40GBASE_LR4", "40GBASE-LR4"}, 238 {0x01, "40G_ACTIVE", "40G Active Cable"}, 239 }, 240 }, 241 "SFF-8024 Rev. 4.6 table 4-4: Extended Specification Compliance", 242 { 243 name = "eth_ext", 244 description = "Extended specification compliance", 245 bits = 8, 246 values = { 247 {0xFF, "RESERVED_FF", "Reserved"}, 248 {0x55, "128GFC_LW", "128GFC LW"}, 249 {0x54, "128GFC_SW", "128GFC SW"}, 250 {0x53, "128GFC_EA", "128GFC EA"}, 251 {0x52, "64GFC_LW", "64GFC LW"}, 252 {0x51, "64GFC_SW", "64GFC SW"}, 253 {0x50, "64GFC_EA", "64GFC EA"}, 254 {0x4F, "RESERVED_4F", "Reserved"}, 255 {0x4E, "RESERVED_4E", "Reserved"}, 256 {0x4D, "RESERVED_4D", "Reserved"}, 257 {0x4C, "RESERVED_4C", "Reserved"}, 258 {0x4B, "RESERVED_4B", "Reserved"}, 259 {0x4A, "RESERVED_4A", "Reserved"}, 260 {0x49, "RESERVED_49", "Reserved"}, 261 {0x48, "RESERVED_48", "Reserved"}, 262 {0x47, "RESERVED_47", "Reserved"}, 263 {0x46, "200GBASE_LR4", "200GBASE-LR4"}, 264 {0x45, "50GBASE_LR", "50GBASE-LR"}, 265 {0x44, "200G_1550NM_PSM4", "200G 1550nm PSM4"}, 266 {0x43, "200GBASE_FR4", "200GBASE-FR4"}, 267 {0x42, "50GBASE_FR_200GBASE_DR4", "50GBASE-FR or 200GBASE-DR4"}, 268 {0x41, "50GBASE_SR_100GBASE_SR2_200GBASE_SR4", 269 "50GBASE-SR/100GBASE-SR2/200GBASE-SR4"}, 270 {0x40, "50GBASE_CR_100GBASE_CR2_200GBASE_CR4", 271 "50GBASE-CR/100GBASE-CR2/200GBASE-CR4"}, 272 {0x3F, "RESERVED_3F", "Reserved"}, 273 {0x3E, "RESERVED_3E", "Reserved"}, 274 {0x3D, "RESERVED_3D", "Reserved"}, 275 {0x3C, "RESERVED_3C", "Reserved"}, 276 {0x3B, "RESERVED_3B", "Reserved"}, 277 {0x3A, "RESERVED_3A", "Reserved"}, 278 {0x39, "RESERVED_39", "Reserved"}, 279 {0x38, "RESERVED_38", "Reserved"}, 280 {0x37, "RESERVED_37", "Reserved"}, 281 {0x36, "RESERVED_36", "Reserved"}, 282 {0x35, "RESERVED_35", "Reserved"}, 283 {0x34, "RESERVED_34", "Reserved"}, 284 {0x33, "50_100_200GAUI_AOC_HI_BER", 285 "50GAUI/100GAUI-2/200GAUI-4 AOC (BER <2.6e-4)"}, 286 {0x32, "50_100_200GAUI_ACC_HI_BER", 287 "50GAUI/100GAUI-2/200GAUI-4 ACC (BER <2.6e-4)"}, 288 {0x31, "50_100_200GAUI_AOC_LO_BER", 289 "50GAUI/100GAUI-2/200GAUI-4 AOC (BER <1e-6)"}, 290 {0x30, "50_100_200GAUI_ACC_LO_BER", 291 "50GAUI/100GAUI-2/200GAUI-4 ACC (BER <1e-6)"}, 292 {0x2F, "RESERVED_2F", "Reserved"}, 293 {0x2E, "RESERVED_2E", "Reserved"}, 294 {0x2D, "RESERVED_2D", "Reserved"}, 295 {0x2C, "RESERVED_2C", "Reserved"}, 296 {0x2B, "RESERVED_2B", "Reserved"}, 297 {0x2A, "RESERVED_2A", "Reserved"}, 298 {0x29, "RESERVED_29", "Reserved"}, 299 {0x28, "RESERVED_28", "Reserved"}, 300 {0x27, "100G_LR", "100G-LR"}, 301 {0x26, "100G_FR", "100G-FR"}, 302 {0x25, "100GBASE_DR", "100GBASE-DR"}, 303 {0x24, "4WDM_40_MSA", "4WDM-40 MSA"}, 304 {0x23, "4WDM_20_MSA", "4WDM-20 MSA"}, 305 {0x22, "4WDM_10_MSA", "4WDM-10 MSA"}, 306 {0x21, "100G_PAM4_BIDI", "100G PAM4 BiDi"}, 307 {0x20, "100G_SWDM4", "100G SWDM4"}, 308 {0x1F, "40G_SWDM4", "40G SWDM4"}, 309 {0x1E, "2_5GBASE_T", "2.5GBASE-T"}, 310 {0x1D, "5GBASE_T", "5GBASE-T"}, 311 {0x1C, "10GBASE_T_SR", "10GBASE-T Short Reach"}, 312 {0x1B, "100G_1550NM_WDM", "100G 1550nm WDM"}, 313 {0x1A, "100GE_DWDM2", "100GE-DWDM2"}, 314 {0x19, "100G_25GAUI_C2M_ACC", "100G ACC or 25GAUI C2M ACC"}, 315 {0x18, "100G_25GAUI_C2M_AOC", "100G AOC or 25GAUI C2M AOC"}, 316 {0x17, "100G_CLR4", "100G CLR4"}, 317 {0x16, "10GBASE_T_SFI", 318 "10GBASE-T with SFI electrical interface"}, 319 {0x15, "G959_1_P1L1_2D2", "G959.1 profile P1L1-2D2"}, 320 {0x14, "G959_1_P1S1_2D2", "G959.1 profile P1S1-2D2"}, 321 {0x13, "G959_1_P1I1_2D1", "G959.1 profile P1I1-2D1"}, 322 {0x12, "40G_PSM4", "40G PSM4 Parallel SMF"}, 323 {0x11, "4X_10GBASE_SR", "4 x 10GBASE-SR"}, 324 {0x10, "40GBASE_ER4", "40GBASE-ER4"}, 325 {0x0F, "RESERVED_0F", "Reserved"}, 326 {0x0E, "RESERVED_0E", "Reserved"}, 327 {0x0D, "CA_25G_N", "25GBASE-CR CA-25G-N"}, 328 {0x0C, "CA_25G_S", "25GBASE-CR CA-25G-S"}, 329 {0x0B, "CA_L", "100GBASE-CR4 or 25GBASE-CR CA-L"}, 330 {0x0A, "RESERVED_0A", "Reserved"}, 331 {0x09, "OBSOLETE", "Obsolete"}, 332 {0x08, "100G_25GAUI_C2M_ACC_1", 333 "100G ACC (Active Copper Cable"}, 334 {0x07, "100G_PSM4_P_SMF", "100G PSM4 Parallel SMF"}, 335 {0x06, "100G_CWDM4", "100G CWDM4"}, 336 {0x05, "100GBASE_SR10", "100GBASE-SR10"}, 337 {0x04, "100GBASE_ER4_25GBASE_ER", "100GBASE-ER4 or 25GBASE-ER"}, 338 {0x03, "100GBASE_LR4_25GBASE_LR", "100GBASE-LR4 or 25GBASE-LR"}, 339 {0x02, "100GBASE_SR4_25GBASE_SR", "100GBASE-SR4 or 25GBASE-SR"}, 340 {0x01, "100G_25GAUI_C2M_AOC_1", 341 "100G AOC (Active Optical Cable"}, 342 {0x00, "UNSPECIFIED", "Unspecified"}, 343 }, 344 }, 345 "SFF-8636 Rev. 2.9 table 6.3: Revision compliance", 346 { 347 name = "rev", 348 description = "Revision compliance", 349 bits = 8, 350 values = { 351 {0x1, "SFF_8436_REV_LE_4_8", "SFF-8436 rev <=4.8"}, 352 {0x2, "SFF_8436_REV_LE_4_8_ALT", "SFF-8436 rev <=4.8"}, 353 {0x3, "SFF_8636_REV_LE_1_3", "SFF-8636 rev <=1.3"}, 354 {0x4, "SFF_8636_REV_LE_1_4", "SFF-8636 rev <=1.4"}, 355 {0x5, "SFF_8636_REV_LE_1_5", "SFF-8636 rev <=1.5"}, 356 {0x6, "SFF_8636_REV_LE_2_0", "SFF-8636 rev <=2.0"}, 357 {0x7, "SFF_8636_REV_LE_2_7", "SFF-8636 rev <=2.7"}, 358 {0x8, "SFF_8363_REV_GE_2_8", "SFF-8636 rev >=2.8"}, 359 {0x0, "UNSPECIFIED", "Unspecified"}, 360 }, 361 }, 362} 363 364-- Nothing else in this context. 365}) 366