Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/cgem.4
- This file was moved from share/man/man4/man4.arm/cgem.4.
Show All 18 Lines | ||||||||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |||||||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |||||||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |||||||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | |||||||||
.\" | .\" | |||||||||
.\" $FreeBSD: head/share/man/man4/man4.arm/cgem.4 301591 2016-06-08 09:36:07Z trasz $ | .\" $FreeBSD: head/share/man/man4/man4.arm/cgem.4 301591 2016-06-08 09:36:07Z trasz $ | |||||||||
.\" | .\" | |||||||||
.Dd August 26, 2014 | .Dd March 27, 2020 | |||||||||
.Dt CGEM 4 | .Dt CGEM 4 | |||||||||
.Os | .Os | |||||||||
.Sh NAME | .Sh NAME | |||||||||
.Nm cgem | .Nm cgem | |||||||||
.Nd "Cadence GEM Gigabit Ethernet driver" | .Nd "Cadence GEM Gigabit Ethernet driver" | |||||||||
.Sh SYNOPSIS | .Sh SYNOPSIS | |||||||||
To compile this driver into the kernel, | To compile this driver into the kernel, | |||||||||
place the following lines in your | place the following lines in your | |||||||||
kernel configuration file: | kernel configuration file: | |||||||||
.Bd -ragged -offset indent | .Bd -ragged -offset indent | |||||||||
.Cd "device ether" | .Cd "device ether" | |||||||||
.Cd "device miibus" | .Cd "device miibus" | |||||||||
.Cd "device cgem" | .Cd "device cgem" | |||||||||
.Ed | .Ed | |||||||||
.Sh DESCRIPTION | .Sh DESCRIPTION | |||||||||
The | The | |||||||||
.Nm | .Nm | |||||||||
driver provides support for the Cadence GEM (Gigabit Ethernet MAC). | driver provides support for the Cadence GEM (Gigabit Ethernet MAC). | |||||||||
The Cadence GEM is used in some SoC (System on a Chip) devices such as | The Cadence GEM is used in some SoC (System on a Chip) devices such as | |||||||||
the Xilinx Zynq-7000 and the Atmel SAMA5D3. | the Xilinx Zynq-7000, the Xilinx Zynq UltraScale+, and the SiFive | |||||||||
HiFive Unleashed. | ||||||||||
philip: "among many others"? It's a pretty common IP block. | ||||||||||
Done Inline ActionsIs it? The only other place I could find any reference to it was in the Atmel AT91 boards and support for those was pulled out a while ago. Further, the "macb" device is a different enough beast than cgem that the driver in (that other operating system) has separate register definitions and separate routines for initialization and filling and retrieving descriptors. I don't think this driver would work for the macb and that's why I removed "cdns,macb" from the compatibility list. skibo: Is it? The only other place I could find any reference to it was in the Atmel AT91 boards and… | ||||||||||
.Pp | .Pp | |||||||||
The | The | |||||||||
.Nm | .Nm | |||||||||
driver supports the following media types: | driver supports the following media types: | |||||||||
.Bl -tag -width ".Cm 10baseT/UTP" | .Bl -tag -width ".Cm 10baseT/UTP" | |||||||||
.It Cm autoselect | .It Cm autoselect | |||||||||
Enable autoselection of the media type and options. | Enable autoselection of the media type and options. | |||||||||
The user can manually override | The user can manually override | |||||||||
▲ Show 20 Lines • Show All 223 Lines • ▼ Show 20 Lines | ||||||||||
The bad packets will not be counted in any | The bad packets will not be counted in any | |||||||||
.Xr netstat 1 | .Xr netstat 1 | |||||||||
statistics. | statistics. | |||||||||
There are | There are | |||||||||
.Xr sysctl 8 | .Xr sysctl 8 | |||||||||
variables that count | variables that count | |||||||||
packets discarded by the hardware (see below). | packets discarded by the hardware (see below). | |||||||||
.Pp | .Pp | |||||||||
The GEM used in the Zynq-7000 has a bug such that the receiver can | The GEM used in the Zynq-7000 has a bug such that the receiver can | |||||||||
potentially freeze up under a high load. | potentially freeze up under a high load. | |||||||||
The issue is described in sec. 16.7 | The issue is described in sec. 16.7 | |||||||||
"Known Issues" of the Zynq-7000 SoC Technical Reference Manual (Xilinx | "Known Issues" of the Zynq-7000 SoC Technical Reference Manual (Xilinx | |||||||||
UG585 v1.7). | UG585 v1.7). | |||||||||
The | The | |||||||||
.Nm | .Nm | |||||||||
driver implements the work-around suggested in the manual. | driver implements the work-around suggested in the manual. | |||||||||
If the bug does not exist in other versions of this device, the | It is believed that the bug does not exist in the Zynq UltraScale+ and | |||||||||
work-around can be disabled by setting the dev.cgem.%d.rxhangwar | SiFive SoCs so the work-around is disabled in those instances and enabled | |||||||||
in all others. The work-around can be disabled by setting the | ||||||||||
Not Done Inline Actions
There's a missing newline. 0mp: There's a missing newline. | ||||||||||
dev.cgem.%d.rxhangwar | ||||||||||
Not Done Inline Actions
This should probably be stylized with the Va macro. 0mp: This should probably be stylized with the Va macro. | ||||||||||
.Xr sysctl 8 | .Xr sysctl 8 | |||||||||
variable to 0. | variable to 0. | |||||||||
Done Inline ActionsBut we default to 1 for other devices already? emaste: But we default to 1 for other devices already? |
"among many others"? It's a pretty common IP block.