diff --git a/share/man/man4/ix.4 b/share/man/man4/ix.4 --- a/share/man/man4/ix.4 +++ b/share/man/man4/ix.4 @@ -78,6 +78,8 @@ .Pp .Bl -bullet -compact .It +Intel(R) Ethernet E610 +.It Intel(R) Ethernet X553 .It Intel(R) Ethernet X552 @@ -130,6 +132,114 @@ Vary the interrupt rate over time based on the traffic for that interrupt vector. .El +.\" +.Sh FEATURES +.Ss DEBUG DUMP +Intel(R) E610 Ethernet Controller devices support debug dump, which allows +obtaining runtime register values from the firmware for "clusters" of +events and then write the results to a single dump file, for debugging +complicated issues in the field. +.\" +This debug dump contains a snapshot of the device and its existing hardware +configuration, such as switch tables, transmit scheduler tables, and other +information. Debug dump captures the current state of the specified cluster(s) +and is a stateless snapshot of the whole device. +.\" +.Pp +Note: +.Bl -bullet -compact +.It +The contents of the debug dump are not human-readable. Contact +Customer Support to decode the file. +.It +Debug dump is per device, not per Physical Function (PF). +.It +Debug dump writes all information to a single file. +.El +.\" +.Pp +To generate a debug dump file in +.Fx , +do the following: +.\" +.Bl -enum -compact +.It +Specify the cluster(s) to include in the dump file, using a bitmask and the +following command: +.Pp +.Dl sysctl Va dev.ix..debug.dump.clusters Ns = Ns Ar +.Pp +.\" +To print the complete cluster bitmask and parameter list to the screen, pass +the +.Fl d +argument. For example: +.Pp +.Dl sysctl -d Va dev.ix.0.debug.dump.clusters +.Pp +.\" +Possible bitmask values for +.Va clusters +are: +.Bl -bullet -compact +.It +0x1 - Link +.It +0x2 - Full CSR Space, excluding RCW registers +.El +.\" +For example, to dump the Link cluster, use the following: +.Pp +.Dl sysctl Va dev.ix.0.debug.dump.clusters Ns = Ns Ar 0x1 +.Pp +.\" +To dump full CSR Space, excluding RCW registers, use the following: +.Pp +.Dl sysctl Va dev.ix.0.debug.dump.clusters Ns = Ns Ar 0x2 +.Pp +.\" +To dump all clusters, use the following: +.Pp +.Dl sysctl Va dev.ix.0.debug.dump.clusters Ns = Ns Ar 0 +.Pp +.\" +.Pp +Note: Using 0 will skip Manageability Transactions data. +.\" +When a cluster is not specified, the driver will dump all clusters to a +single file. +.\" +.It +Issue the debug dump command using the +.Va dev.ix..debug.dump.dump +sysctl: +.Pp +.Dl sysctl -b Va dev.ix..debug.dump.dump Ns = Ns Ar 1 No > dump.bin +.Pp +.\" +.Pp +Note: +.Bl -bullet -compact +.It +The driver will not receive the command if the sysctl is not set to "1". +.It +Replace +.Dq dump.bin +above with the desired file name. +.It +If no clusters were specified, the dump file will include information +about all clusters. +.El +.\" +.It +To clear the clusters bitmap before a subsequent debug dump and then do the +dump: +.Pp +.Dl sysctl Va dev.ix.0.debug.dump.clusters Ns = Ns Ar 0 +.Dl sysctl Va dev.ix.0.debug.dump.dump Ns = Ns Ar 1 +.Pp +.El +.\" .Sh DIAGNOSTICS .Bl -diag .It "ix%d: Unable to allocate bus resource: memory"