1.概述
Open Network Install Environment (ONIE)是一个用于裸机网络交换机的小型操作系统，提供了一个自动配置环境。ONIE找到并执行网络操作系统（NOS）提供商提供的安装镜像。
一个带ONIE的系统由以下部分组成：
- 支持ONIE的硬件平台
- 支持ONIE的bootloader
- 支持ONIE的Linux kernel.
- ONIE发现并执行的应用程序
- 支持ONIE的操作系统安装程序
当一个ONIE网络交换机首次启动时，bootloader负责启动内核，该内核包含在ONIE发现并执行（ODE）应用程序中。
ODE操作使用多种方法(如本地文件、DHCP、IPv6邻居、mDNS/DNS-SD)来发现和下载(通过HTTP 或者TFTP)操作系统安装程序。
一旦安装程序找到，ODE便执行安装程序，接着以NOS特定的方式来配置设备。
1.1.初始引导
交换机第一次启动时，将执行如下步骤：
- Bootloader启动默认的操作系统，即ONIE内核
- ODE找到NOS安装镜像
- ODE执行NOS安装镜像
- NOS安装镜像安装操作系统
- NOS安装镜像引导环境标记为直接启动NOS
- 系统重启
1.2.后续引导
在后续的启动中，系统直接引导到已经安装的NOS中，绕过ONIE内核和ODE应用程序。后续的启动顺序是：
- Bootloader启动默认的OS，即NOS
- NOS启动并执行
2.交换机硬件需求
ONIE只具有少量的硬件需求。NOS对硬件有特殊的需求，因此，只有满足条件的NOS才能被安装到设备上。
由于是Linux的，ONIE基本上对CPU架构无任何需求。
当前的ONIE版本支持x86、PowerPC 32/64-bit及ARM 32/64-bit CPU架构。
PowerPC及ARM CPU架构都是用U-Boot作为bootloader，在本规范中称为“U-Boot平台”。
本节列出了ONIE兼容的交换平台交换机的硬件需求。
有关CPU架构的详细规范，请参阅以下章节。
- U-Boot平台需求
- x86硬件需求
2.1.电路板EEPROM信息格式
每个ONIE系统都必须包含非易失性存储器，用于存储由制造商分配的重要产品数据。非易失性存储器可以采用EEPROM、NOR Flash、NAND Flash或其他存储介质。
在本文中，术语EEPROM用来代指非易失性存储器，它可以是任意的存储介质。
EEPROM中存储的数据包括分配给系统的MAC地址、序列号、制造日期等信息。这里指定的EEPROM格式的名称是TlvInfo，因为包含在EEPROM中的信息是按照TLV编码的。
2.1.1.TlvInfo EEPROM格式定义
EEPROM的前8个字节是以NULL为结尾的ASCII字符串“TlvInfo”。这个标识符可以用作简单的初步检查，使得EEPROM符合这里定义的TlvInfo格式。同时应该执行额外的验证以检查TlvInfo格式是否真的被使用，如CRC。当调试或打印内存时，这个字符串提供了很到的线索，接下来是TlvInfo格式。
标识符字符串之后，跟着一个单字节的值，表示版本号。对于本文所描述的TlvInfo EEPROM格式，版本值固定为0x01。由于这里描述的格式是非常灵活和可扩展的，因此，这个版本号一般无需被改变，但是也定义了这个值，以防万一。当从这个值中读到版本号时，如果软件没有规定对该版本有支持，那么后续读到的任何数据都不能假设是正确的。版本号0x00及0xFF将永远保留，不会被使用。
版本号之后，紧跟着2个字节，标识后面的数据的总长度。这个数据是大端序的，包括后续所有TLV字段的累积长度。如果要批量读取EEPROM数据，那么可以使用这个字段来确定能读取的数据量。由于CRC-32 TLV是固定长度的，并且始终位于EEPROM的最后一个TLV，所以也可以用该字段来定位CRC的位置。
总长度后面紧跟着的是EEPROM数据域，称为TLV字段。每个TLV字段由三个子字段组成：一个类型码Type，一个长度字段Length和一个值Value。
- Type code: 这是一个单字节，用于定义值字段的类型和格式。这些类型在下表中有定义。由于类型将随着时间的增加而增加，所以预留的类型代码，应该将值视为不透明的数据，而不是随便赋予其含义。类型吗0x00和0xFF将被保留，且永远不会被使用，因此，最多支持254个类型。
- Length: 表示当前TLV字段中Vlaue域的字节数，一个字节长度。有效值为0～255。长度0则意味着没有与此类型代码关联的value域。在这种情况下，长度字段之后接着是下一个TLV的第一个字节，即下一个TLV的Type字段。
- Value: 该字段标识指定类型TLV的value。它的大小范围为0～255。下面将为每个单独Type定义其字段格式。由于每个TLV都包含一个Length字段，所以ASCII字符串不以NULL结尾，除非另有说明。
本规范只要求存在CRC-32 TLV，但是有些系统在没有其他字段的情况下可能无法正确初始化。CRC-32 TLV必须放在最后。通过将11（固定报头信息长度）+Length字段的值-6（CRC-32 TLV字段的length），可以快速在EEPROm中定位到CRC的位置。
从标识符字符串的第一个字节到CRC TLV的最后一个字节的TlvInfo EEPROM的总长度必须小于或等于2048字节。
整个EEPROM模块的布局如下所示：
| Field Name | Size in Bytes | Value |
|---|---|---|
| ID String | 8 | "TlvInfo" |
| Header Version | 1 | 0x01 |
| Total Length | 2 | 后续字段的总长度 |
| TLV 1 | Varies | The data for TLV 1 |
| TLV 2 | Varies | The data for TLV 2 |
| ..... | ..... | ..... |
| TLV N | Varies | The data for TLV N |
| CRC-32 TLV | 6 | Type = 0xFE, Length = 4, Value = 4 byte CRC-32 |
2.1.2.类型码定义
下表定义了当前代码中用到的类型。
| Type Code | Length | Description | Format |
|---|---|---|---|
| 0x00 | None | Reserved | 非法值，永久保留。所以很容易检测到EEPROM的一部分是否被擦除。 |
| 0x21 | Variable | 产品名称 | 产品名 |
| 0x22 | Variable | 部件号 | 供应商的设备部件号 |
| 0x23 | Variable | 序列号 | 设备的系列号 |
| 0x24 | 6 bytes | MAC基址 | 6个字节，设备的MAC基址，前三个字节是OUI |
| 0x25 | 19 bytes | 制造数据 | 指定设备什么时候生产，字符串的格式为MM/DD/YYYY HH:NN:SS，即月(01-12)/日(01-31)/年 HH (00-23)，NN (00-59)及SS (00-59)。 |
| 0x26 | 1 byte | 设备版本号 | 设备版本 |
| 0x27 | Variable | 标签修订 | 标签修订 |
| 0x28 | Variable | 平台名称 | 标识CPU子系统(CPU、架构、DRAM、NOR flash)。当CPU以子卡方式存在时，这个字段非常有用。格式通常为<arch>-<machine>-<machine_revision> |
| 0x29 | Variable | ONIE版本 | 设备安装的ONIE软件版本 |
| 0x2A | 2 bytes | MAC数目 | 两字节，大端序的值，用于描述分配给当前设备的连续的MAC地址。分配给设备的MAC地址从上述MAC基址开始。本字段有效值为1～65535。 |
| 0x2B | Variable | 制造商 | 制造商名称 |
| 0x2C | 2 bytes | 国家 | 两字节ASCII字符串，ISO 3166-1规定的地理位置编码，指定制造商所在的国家 |
| 0x2D | Variable | 供应商 | 与制造商签订生产此设备的供应商名称，通常是设备外部标明的公司名称 |
| 0x2E | Variable | 诊断版本 | 诊断软件版本号 |
| 0x2F | Variable | 服务Tag | 供应商定义的服务Tag |
| 0xFD | Variable | 供应商扩展 | 允许供应商提供特定的额外信息，且只能用这个类型的代码来指定。此字段的值是一个4B的IANA企业编号。后跟一个供应商定义的字符串。字节串的格式则完全取决于供应商，但是最多只能包含255个字节（包括IANA）。如果需要使用更多的信息，则可以封装到多个此类型的TLV中。 |
| 0xFE | 4 bytes | CRC-32 | 4B CRC，覆盖EEPROM的第一个字节(从"TlvInfo"的"T"开始)到此TLV的length字段结束。使用crc32算法 (具体算法实现，可以参考Python's binascii.crc32() 函数说明)。 |
| 0xFF | None | Reserved | 非法值，永久保留。 |
2.1.3.MAC地址注意事项
交换平台EEPROM的一个关键信息是分配给设备的MAC地址数量。ONIE需要为该设备上的每个SerDes分配一个MAC地址。
例如，考虑一个以太网管理端口和具有48x10G及6x40G端口的设备。每个40G端口可以分裂为4x10G端口，因此，此设备需要分配的MAC数目为：
1 -- Ethernet management port
48 -- 1 for each 48x10G port
24 -- 4 for each 6x40G port
-----------------------------
73 Total MACs
要将其编码到EEPROm中，请将TLV代码0x2A (MAC数目)的value设置为73。
该EEPROM格式规范的维护和TLV类型码的分配由ONIE项目处理。
2.2.串口控制台默认波特率
默认的串行控制台波特率为115200，最终用户可以自行更改。
出厂时设置的默认串行控制台波特率为115200。
2.3.硬件面板和FRU编号
ONIE项目为设备上的钣金推荐了以下约定：
- 交换机端口号以数字1开始
- 交换机端口编号从上到下，从左到右顺序。例如，考虑两排48个端口的交换机。上面那一排的编号从左到右为"1, 3, 5 ... 47"，下面那排的端口编号为"2, 4, 8 ... 48"。
- 现场可替换单元（FRU）以数字1开始编号。这通常适用于可插拔电源和风扇模块。例如，具有2个电源模块和3个风扇模块的系统，将标记为PSUs "1, 2" 及fans "1, 2, 3"。
2.4.硬件文档
ONIE项目建议交换机包装包括一页（双面打印）的快速入门指南。这与大多数商业产品所包含的内容类似。
此传单包括如下内容：
- ONIE版本号和认证号码/日期
- 前后视图模板，带有箭头标明“以太网管理口”及带外串行控制台
- 温度传感器的位置布局，即温度传感器位于电路板上的位置
- Console口引脚输出，波特率/设置信息（默认115200）
- 通用ONIE安装说明(可视的流程图)
- 通用ONIE调试 (ssh/telnet access, syslog)
遵循这些建议将改善最终用户的运营体验。
2.5.资产跟踪和标签
关于资产跟踪和标签，ONIE建议如下内容：
- 表示第一个可用的以太网管理端口（通常是eth0）的MAC地址，系统系列号，产品系列号或SKU标识和CPU ID等人和机器可读的条码。可接受的条形码必须是：Code 38, Code 128, or QR Code。人机之间的这种编码应该是一致的（如以ASCII格式打印的序列号，但是编码为HEX是不允许的）。
- 对于将在2个或4个机架环境中提供的产品，这些标签应该在交换机的后面或前面板上，而不是在交换机的顶部，底部或侧面上，必须保证在机架结构中的可读性。一个很好的例子就是使用“行李标签”。
- 无论资产放置于何处，都需要有足够的空间使最终用户放置自己的资产定位器。一个理想的区域就是“行李标签”，为最终用户的资产定位器提供足够的控制键。这种安装在凹陷位置的标签必须至少有3mm的间隙，以便插入或取出标签，标签不得陷入机架底盘。
- 在支持SMBIOS/DMI标准的平台上，dmidecode、序列号和产品系列/SKU标识信息必须进行编码，以匹配人可读标签。例如系列号(SMBIOS type 1, offset 07h)字段的编码绝对不能为null或fake (123456789)。
遵循这些建议将改善最终用户的运营体验。
