summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorRenato Botelho <renato@netgate.com>2016-10-06 07:48:56 -0300
committerRenato Botelho <renato@netgate.com>2016-10-06 07:48:56 -0300
commitfa098ef31c4cf4ddab63aced6553fef24c185eea (patch)
tree889bed18c879ec9a159ac7ceca8c175fe3dbffa8 /share/man
parent4548300e7a07c11f157a8ca76565517d2483df36 (diff)
parentad44cbcf96571d28c76d58c4beff77c8f2af28cb (diff)
downloadFreeBSD-src-fa098ef31c4cf4ddab63aced6553fef24c185eea.zip
FreeBSD-src-fa098ef31c4cf4ddab63aced6553fef24c185eea.tar.gz
Merge remote-tracking branch 'origin/stable/10' into devel
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man4/gre.42
-rw-r--r--share/man/man4/man4.arm/cgem.435
-rw-r--r--share/man/man4/me.41
-rw-r--r--share/man/man4/netmap.42
-rw-r--r--share/man/man4/pci.49
-rw-r--r--share/man/man9/Makefile3
-rw-r--r--share/man/man9/get_cyclecount.91
-rw-r--r--share/man/man9/malloc.912
-rw-r--r--share/man/man9/pci.9106
-rw-r--r--share/man/man9/sleepqueue.91
10 files changed, 131 insertions, 41 deletions
diff --git a/share/man/man4/gre.4 b/share/man/man4/gre.4
index 15ef0ec..1efb0f5 100644
--- a/share/man/man4/gre.4
+++ b/share/man/man4/gre.4
@@ -91,7 +91,6 @@ Enables checksum calculation for outgoing packets.
Enables use of sequence number field in the GRE header for outgoing packets.
.El
.Sh EXAMPLES
-.Pp
.Bd -literal
192.168.1.* --- Router A -------tunnel-------- Router B --- 192.168.2.*
\\ /
@@ -190,7 +189,6 @@ A description of GRE encapsulation can be found in RFC 2784 and RFC 2890.
.An Andrey V. Elsukov Aq Mt ae@FreeBSD.org
.An Heiko W.Rupp Aq Mt hwr@pilhuhn.de
.Sh BUGS
-.Pp
The current implementation uses the key only for outgoing packets.
Incoming packets with a different key or without a key will be treated as if they
would belong to this interface.
diff --git a/share/man/man4/man4.arm/cgem.4 b/share/man/man4/man4.arm/cgem.4
index 8af1b2a..01e2921 100644
--- a/share/man/man4/man4.arm/cgem.4
+++ b/share/man/man4/man4.arm/cgem.4
@@ -248,6 +248,23 @@ checksum offloading is enabled.
Counter of frames discarded due to an incorrect UDP checksum when
checksum offloading is enabled.
.El
+.Sh SEE ALSO
+.Xr miibus 4 ,
+.Xr ifconfig 8
+.Rs
+.%T "Zynq-7000 SoC Technical Reference Manual (Xilinx doc UG585)"
+.%U http://www.xilinx.com/support/documentation/user_guides/\:ug585-Zynq-7000-TRM.pdf
+.Re
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Fx 10.0 .
+.Sh AUTHORS
+The
+.Nm
+driver and this manual page was written by
+.An Thomas Skibo Aq Mt thomasskibo@yahoo.com .
.Sh BUGS
The GEM can perform TCP/UDP/IP checksum offloading.
However, when transmit checksum offloading is enabled, the GEM generates and
@@ -277,21 +294,3 @@ If the bug does not exist in other versions of this device, the
work-around can be disabled by setting the dev.cgem.%d.rxhangwar
.Xr sysctl 8
variable to 0.
-.Pp
-.Sh SEE ALSO
-.Xr miibus 4 ,
-.Xr ifconfig 8
-.Rs
-.%T "Zynq-7000 SoC Technical Reference Manual (Xilinx doc UG585)"
-.%U http://www.xilinx.com/support/documentation/user_guides/\:ug585-Zynq-7000-TRM.pdf
-.Re
-.Sh HISTORY
-The
-.Nm
-device driver first appeared in
-.Fx 10.0 .
-.Sh AUTHORS
-The
-.Nm
-driver and this manual page was written by
-.An Thomas Skibo Aq Mt thomasskibo@yahoo.com .
diff --git a/share/man/man4/me.4 b/share/man/man4/me.4
index e1be5c8..668d346 100644
--- a/share/man/man4/me.4
+++ b/share/man/man4/me.4
@@ -67,7 +67,6 @@ IP header is modified and the modifications are inserted between the
so modified header and the original payload.
The protocol number 55 is used for outer header.
.Sh NOTES
-.Pp
For correct operation, the
.Nm
device needs a route to the decapsulating host that does not run over the tunnel,
diff --git a/share/man/man4/netmap.4 b/share/man/man4/netmap.4
index 1b2dc7a..08349bd 100644
--- a/share/man/man4/netmap.4
+++ b/share/man/man4/netmap.4
@@ -614,7 +614,7 @@ In the example below, "netmap:foo" is any valid netmap port name.
(default) all hardware ring pairs
.It NR_REG_SW_NIC "netmap:foo^"
the ``host rings'', connecting to the host stack.
-.It NR_RING_NIC_SW "netmap:foo+
+.It NR_RING_NIC_SW "netmap:foo+"
all hardware rings and the host rings
.It NR_REG_ONE_NIC "netmap:foo-i"
only the i-th hardware ring pair, where the number is in
diff --git a/share/man/man4/pci.4 b/share/man/man4/pci.4
index c79626f..578c365 100644
--- a/share/man/man4/pci.4
+++ b/share/man/man4/pci.4
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd January 3, 2008
+.Dd August 9, 2016
.Dt PCI 4
.Os
.Sh NAME
@@ -229,7 +229,8 @@ The status tells the user the disposition of his request for a device list.
The possible status values are:
.Bl -ohang
.It PCI_GETCONF_LAST_DEVICE
-This means that there are no more devices in the PCI device list after the
+This means that there are no more devices in the PCI device list matching
+the specified criteria after the
ones returned in the
.Va matches
buffer.
@@ -245,9 +246,7 @@ and
to zero to start over at the beginning of the list.
.It PCI_GETCONF_MORE_DEVS
This tells the user that his buffer was not large enough to hold all of the
-remaining devices in the device list that possibly match his criteria.
-It is possible for this status to be returned, even when none of the remaining
-devices in the list would match the user's criteria.
+remaining devices in the device list that match his criteria.
.It PCI_GETCONF_ERROR
This indicates a general error while servicing the user's request.
If the
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 6b368bf..3a3508a 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -1037,7 +1037,10 @@ MLINKS+=pci.9 pci_alloc_msi.9 \
pci.9 pci_set_max_read_req.9 \
pci.9 pci_write_config.9 \
pci.9 pcie_adjust_config.9 \
+ pci.9 pcie_flr.9 \
+ pci.9 pcie_max_completion_timeout.9 \
pci.9 pcie_read_config.9 \
+ pci.9 pcie_wait_for_pending_transactions.9 \
pci.9 pcie_write_config.9
MLINKS+=pfil.9 pfil_add_hook.9 \
pfil.9 pfil_hook_get.9 \
diff --git a/share/man/man9/get_cyclecount.9 b/share/man/man9/get_cyclecount.9
index eabaeb1..04efdd5 100644
--- a/share/man/man9/get_cyclecount.9
+++ b/share/man/man9/get_cyclecount.9
@@ -77,7 +77,6 @@ and
processors use the
.Li TSC
register.
-.Pp
The
.Tn IA64
processors use the
diff --git a/share/man/man9/malloc.9 b/share/man/man9/malloc.9
index 9653b58..45a52d1 100644
--- a/share/man/man9/malloc.9
+++ b/share/man/man9/malloc.9
@@ -208,12 +208,6 @@ one must include
.In sys/types.h )
and
.In sys/kernel.h .
-.Sh IMPLEMENTATION NOTES
-The memory allocator allocates memory in chunks that have size a power
-of two for requests up to the size of a page of memory.
-For larger requests, one or more pages is allocated.
-While it should not be relied upon, this information may be useful for
-optimizing the efficiency of memory use.
.Pp
Programmers should be careful not to confuse the malloc flags
.Dv M_NOWAIT
@@ -255,6 +249,12 @@ when holding a
.Xr vnode 9
interlock, will cause a LOR (Lock Order Reversal) due to the
intertwining of VM Objects and Vnodes.
+.Sh IMPLEMENTATION NOTES
+The memory allocator allocates memory in chunks that have size a power
+of two for requests up to the size of a page of memory.
+For larger requests, one or more pages is allocated.
+While it should not be relied upon, this information may be useful for
+optimizing the efficiency of memory use.
.Sh RETURN VALUES
The
.Fn malloc ,
diff --git a/share/man/man9/pci.9 b/share/man/man9/pci.9
index cddefb1..1a9be2d 100644
--- a/share/man/man9/pci.9
+++ b/share/man/man9/pci.9
@@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd June 24, 2016
+.Dd September 1, 2016
.Dt PCI 9
.Os
.Sh NAME
@@ -62,7 +62,10 @@
.Nm pci_set_powerstate ,
.Nm pci_write_config ,
.Nm pcie_adjust_config ,
+.Nm pcie_flr ,
+.Nm pcie_get_max_completion_timeout ,
.Nm pcie_read_config ,
+.Nm pcie_wait_for_pending_transactions ,
.Nm pcie_write_config
.Nd PCI bus interface
.Sh SYNOPSIS
@@ -139,8 +142,14 @@
.Fa "uint32_t val"
.Fa "int width"
.Fc
+.Ft bool
+.Fn pcie_flr "device_t dev" "u_int max_delay" "bool force"
+.Ft int
+.Fn pcie_get_max_completion_timeout "device_t dev"
.Ft uint32_t
.Fn pcie_read_config "device_t dev" "int reg" "int width"
+.Ft bool
+.Fn pcie_wait_for_pending_transactions "device_t dev" "u_int max_delay"
.Ft void
.Fn pcie_write_config "device_t dev" "int reg" "uint32_t val" "int width"
.Sh DESCRIPTION
@@ -393,6 +402,51 @@ keyword,
then
.Fn pci_get_vpd_readonly
returns an error.
+.Pp
+The
+.Fn pcie_get_max_completion_timeout
+function returns the maximum completion timeout configured for the device
+.Fa dev
+in microseconds.
+If the
+.Fa dev
+device is not a PCI-express device,
+.Fn pcie_get_max_completion_timeout
+returns zero.
+When completion timeouts are disabled for
+.Fa dev ,
+this function returns the maxmimum timeout that would be used if timeouts
+were enabled.
+.Pp
+The
+.Fn pcie_wait_for_pending_transactions
+function waits for any pending transactions initiated by the
+.Fa dev
+device to complete.
+The function checks for pending transactions by polling the transactions
+pending flag in the PCI-express device status register.
+It returns
+.Dv true
+once the transaction pending flag is clear.
+If transactions are still pending after
+.Fa max_delay
+milliseconds,
+.Fn pcie_wait_for_pending_transactions
+returns
+.Dv false .
+If
+.Fa max_delay
+is set to zero,
+.Fn pcie_wait_for_pending_transactions
+performs a single check;
+otherwise,
+this function may sleep while polling the transactions pending flag.
+.Nm pcie_wait_for_pending_transactions
+returns
+.Dv true
+if
+.Fa dev
+is not a PCI-express device.
.Ss Device Configuration
The
.Fn pci_enable_busmaster
@@ -541,6 +595,51 @@ is invoked,
then the device will be transitioned to
.Dv PCI_POWERSTATE_D0
before any config registers are restored.
+.Pp
+The
+.Fn pcie_flr
+function requests a Function Level Reset
+.Pq FLR
+of
+.Fa dev .
+If
+.Fa dev
+is not a PCI-express device or does not support Function Level Resets via
+the PCI-express device control register,
+.Dv false
+is returned.
+Pending transactions are drained by disabling busmastering and calling
+.Fn pcie_wait_for_pending_transactions
+before resetting the device.
+The
+.Fa max_delay
+argument specifies the maximum timeout to wait for pending transactions as
+described for
+.Fn pcie_wait_for_pending_transactions .
+If
+.Fn pcie_wait_for_pending_transactions
+fails with a timeout and
+.Fa force
+is
+.Dv false ,
+busmastering is re-enabled and
+.Dv false
+is returned.
+If
+.Fn pcie_wait_for_pending_transactions
+fails with a timeout and
+.Fa force
+is
+.Dv true ,
+the device is reset despite the timeout.
+After the reset has been requested,
+.Nm pcie_flr
+sleeps for at least 100 milliseconds before returning
+.Dv true .
+Note that
+.Nm pcie_flr
+does not save and restore any state around the reset.
+The caller should save and restore state as needed.
.Ss Message Signaled Interrupts
Message Signaled Interrupts
.Pq MSI
@@ -793,11 +892,6 @@ with one in the new distribution.
The
.Fn pci_remap_msix
function will fail if this condition is not met.
-.Sh IMPLEMENTATION NOTES
-The
-.Vt pci_addr_t
-type varies according to the size of the PCI bus address
-space on the target architecture.
.Sh SEE ALSO
.Xr pci 4 ,
.Xr pciconf 8 ,
diff --git a/share/man/man9/sleepqueue.9 b/share/man/man9/sleepqueue.9
index 7f6269b..46f6539 100644
--- a/share/man/man9/sleepqueue.9
+++ b/share/man/man9/sleepqueue.9
@@ -246,7 +246,6 @@ allows to pass additional
.Fn callout_reset_sbt
flags.
.Pp
-.Pp
Once the thread is ready to suspend,
one of the wait functions is called to put the current thread to sleep
until it is awakened and to context switch to another thread.
OpenPOWER on IntegriCloud