| commit | efbdace1f928d3e32f468ee1184e7212ef8f9c52 | [log] [tgz] |
|---|---|---|
| author | George Liu <liuxiwei@ieisystem.com> | Tue Aug 06 10:12:20 2024 +0800 |
| committer | George Liu <liuxiwei@ieisystem.com> | Wed Aug 07 08:37:27 2024 +0800 |
| tree | 2d3d6cba0c170e0dfabf03132e191c32a0899776 | |
| parent | 472df7ed943c0583e4b4cb888a01231795bd3dbe [diff] |
README.md: Fix MD041 warnings The following warnings are generated by using markdownlint analysis: ``` MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "### Ethernet Statistics Command..."] ``` Refer to markdown-lint [1] to fix MD041 [1]: https://github.com/updownpress/markdown-lint/blob/master/rules/041-first-line-h1.md Change-Id: I11b661fb02b389d40e3d037203138b534d54b27d Signed-off-by: George Liu <liuxiwei@ieisystem.com>
There is the need to read a specific ethernet-level statistic value from the BMC. This is driven primarily to detect link errors that require hardware swaps during manufacturing.
This command will be well structured such that there is a request and response which mirror to some extent.
The request will specify the ethernet interface by name, as a length-prepended string, and the field they're requesting by identifier (an unsigned byte).
If the command is not supported, the IPMI OEM handler will respond accordingly, however, if the field is not supported or not recognized, the command will return 0xcc (invalid field).
The current ethernet statistics available (all future additions must append):
| Identifier | Human Readable Name |
|---|---|
| 0 | rx_bytes |
| 1 | rx_compressed |
| 2 | rx_crc_errors |
| 3 | rx_dropped |
| 4 | rx_errors |
| 5 | rx_fifo_errors |
| 6 | rx_frame_errors |
| 7 | rx_length_errors |
| 8 | rx_missed_errors |
| 9 | rx_nohandler |
| 10 | rx_over_errors |
| 11 | rx_packets |
| 12 | tx_aborted_errors |
| 13 | tx_bytes |
| 14 | tx_carrier_errors |
| 15 | tx_compressed |
| 16 | tx_dropped |
| 17 | tx_errors |
| 18 | tx_fifo_errors |
| 19 | tx_heartbeat_errors |
| 20 | tx_packets |
| 21 | tx_window_errors |
Request
| Byte(s) | Value | Data |
|---|---|---|
| 0x00 | Statistic ID | The identifier of the desired statistic. |
| 0x01 | Length | Length of string (not including null termination). |
| 0x02.. | The name | The string, not null-terminated. |
Response
| Byte(s) | Value | Data |
|---|---|---|
| 0x00 | Stat ID | The identifier of the desired statistic. |
| 0x01.... | Uint64 | The value. Because these are counters we don't anticipate negative values, and we don't expect overflow. |