History

ethtool: Expand documentation of struct ethtool_regs

Ben Hutchings committed 12 years ago

Commit 09fb8bb1 parent 02d59f31 file · +17 −3Browse files

Showing the changes to include/uapi/linux (1 of 1 file). Show all

Unified · Split

include/uapi/linux/ethtool.h+17−3
@@ -209,11 +209,25 @@ struct ethtool_value { · 208 unmodified lines
209209 __u32 data;
210210 };
211211
212−/* for passing big chunks of data */
212+/**
213+ * struct ethtool_regs - hardware register dump
214+ * @cmd: Command number = %ETHTOOL_GREGS
215+ * @version: Dump format version. This is driver-specific and may
216+ * distinguish different chips/revisions. Drivers must use new
217+ * version numbers whenever the dump format changes in an
218+ * incompatible way.
219+ * @len: On entry, the real length of @data. On return, the number of
220+ * bytes used.
221+ * @data: Buffer for the register dump
222+ *
223+ * Users should use %ETHTOOL_GDRVINFO to find the maximum length of
224+ * a register dump for the interface. They must allocate the buffer
225+ * immediately following this structure.
226+ */
213227 struct ethtool_regs {
214228 __u32 cmd;
215− __u32 version; /* driver-specific, indicates different chips/revs */
216− __u32 len; /* bytes */
229+ __u32 version;
230+ __u32 len;
217231 __u8 data[0];
218232 };
219233