Changeset View
Standalone View
share/man/man4/sume.4
Property | Old Value | New Value |
---|---|---|
svn:eol-style | null | native \ No newline at end of property |
svn:keywords | null | FreeBSD=%H \ No newline at end of property |
svn:mime-type | null | text/plain \ No newline at end of property |
.\"- | |||||
.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD | |||||
rgrimes: This file is missing copyright, license and $FreeBSD$. | |||||
.\" | |||||
.\" Copyright (c) 2015 University of Cambridge All rights reserved. | |||||
.\" Copyright (c) 2015 Bjoern A. Zeeb All rights reserved. | |||||
rgrimesUnsubmitted Done Inline ActionsSince you just wrote this man page how is it possible to have a copyright from Cambridge or BZ, and especially from 2015? Or was some of this text from a linux file? rgrimes: Since you just wrote this man page how is it possible to have a copyright from Cambridge or BZ… | |||||
.\" Copyright (c) 2020 Denis Salopek All rights reserved. | |||||
zecUnsubmitted Done Inline ActionsThe "All rights reserved" formula is obsolete and can and could be ommited, especially in freshly created files zec: The "All rights reserved" formula is obsolete and can and could be ommited, especially in… | |||||
.\" | |||||
.\" Redistribution and use in source and binary forms, with or without | |||||
.\" modification, are permitted provided that the following conditions | |||||
.\" are met: | |||||
.\" 1. Redistributions of source code must retain the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer. | |||||
.\" 2. Redistributions in binary form must reproduce the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer in the | |||||
.\" documentation and/or other materials provided with the distribution. | |||||
.\" | |||||
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |||||
.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | |||||
.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |||||
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |||||
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |||||
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |||||
.\" CONTRACT, STRICT 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 SUCH DAMAGE. | |||||
.\" | |||||
.\" This software was developed by Stanford University and the University of | |||||
.\" Cambridge Computer Laboratory under National Science Foundation under Grant | |||||
.\" No. CNS-0855268, the University of Cambridge Computer Laboratory under EPSRC | |||||
.\" INTERNET Project EP/H040536/1 and by the University of Cambridge Computer | |||||
Done Inline Actionsman pages usually have a line break at full stops per style guide (full stop == period), This is done to ease future edits. rgrimes: man pages usually have a line break at full stops per style guide (full stop == period), This… | |||||
Done Inline Actions
This has not been done, the text is still flowed to fill margins, which is not the normal form for man pages. rgrimes: > man pages usually have a line break at full stops per style guide (full stop == period)… | |||||
Done Inline ActionsIs this fixed now? denissal: Is this fixed now? | |||||
Done Inline ActionsNot really, but this is not a blocking issue. rgrimes: Not really, but this is not a blocking issue. | |||||
.\" Laboratory under DARPA/AFRL contract FA8750-11-C-0249 ("MRC2"), as part of | |||||
.\" the DARPA MRC research programme. | |||||
zecUnsubmitted Done Inline ActionsNeither Stanford nor UCAM have authored this manpage, so this paragraph should be removed. zec: Neither Stanford nor UCAM have authored this manpage, so this paragraph should be removed. | |||||
.\" | |||||
.\" $FreeBSD$ | |||||
.\" | |||||
.Dd July 25, 2020 | |||||
.Dt SUME 4 | |||||
Done Inline Actions"me" should probably not be in a man page. rgrimes: "me" should probably not be in a man page. | |||||
.Os | |||||
.Sh NAME | |||||
.Nm sume | |||||
.Nd "NetFPGA SUME 4x10Gb Ethernet driver" | |||||
.Sh SYNOPSIS | |||||
To compile this driver into the kernel, place the following lines in your | |||||
kernel configuration file: | |||||
.Bd -ragged -offset indent | |||||
.Cd "device sume" | |||||
.Ed | |||||
.Pp | |||||
Alternatively, to load the driver as a module at boot time, place the following | |||||
line in | |||||
.Xr loader.conf 5 : | |||||
.Bd -literal -offset indent | |||||
if_sume_load="YES" | |||||
.Ed | |||||
Done Inline ActionsInsert "single" before "DMA transaction", to clarify the inefficiency of the reference NIC DMA design and the huge PIO PCI traffic overhead (to set up the DMA) associated with each packet transfer. zec: Insert "single" before "DMA transaction", to clarify the inefficiency of the reference NIC DMA… | |||||
.Sh DESCRIPTION | |||||
Done Inline ActionsDrop "in" after "yields", I don't think it is necessary. zec: Drop "in" after "yields", I don't think it is necessary. | |||||
The | |||||
.Nm | |||||
driver provides support for NetFPGA SUME Virtex-7 FPGA Development Board with | |||||
Done Inline ActionsDouble use of original does not read well here. I would just drop the first one, as it is implied by the second one. rgrimes: Double use of original does not read well here. I would just drop the first one, as it is… | |||||
the reference NIC bitstream loaded onto it. | |||||
The HDL design for the reference NIC project uses the RIFFA based DMA engine to | |||||
communicate with the host machine over PCIe. | |||||
Done Inline ActionsThere's also no support for multicast filters... zec: There's also no support for multicast filters... | |||||
Every packet is transmitted to / from the board via one DMA transaction, taking | |||||
up to two or three interrupts per one transaction which yields in low | |||||
Done Inline Actionss/Cambridge/the NetFPGA project/ bz: s/Cambridge/the NetFPGA project/ | |||||
performance. | |||||
There is no support for Jumbo frames as the hardware is capable of dealing only | |||||
with frames with maximum size of 1514 bytes. | |||||
The hardware provides no checksums and offers no other offloading. | |||||
.Sh BUGS | |||||
Pre-built bitstream from Cambridge may not work correctly - at higher RX packet | |||||
rates, the newly incoming packets would overwrite the ones in some internal | |||||
FIFO so the packets would come out of the board scrambled until physical reset | |||||
of the board. | |||||
There is also a strange behaviour in the TX path: when sending "small" packets, | |||||
TX works as it should, but when sending packets above some size limit right | |||||
after loading the driver, SUME doesn't send the TX_DONE interrupt and refuses | |||||
to send packets until the driver is reloaded / board is reset. | |||||
This would mean that the driver would get stuck in a non-IDLE TX state but a | |||||
watchdog-like function is implemented in the driver to check whether the | |||||
non-IDLE state lasts more then 3 seconds and it resets the board automatically. | |||||
For more details, visit the NetFPGA SUME project site. | |||||
.Sh SEE ALSO | |||||
.Xr arp 4 , | |||||
.Xr ifconfig 8 , | |||||
.Xr netgraph 4 , | |||||
.Xr netintro 4 , | |||||
.Xr ng_ether 4 , | |||||
.Xr vlan 4 | |||||
.Sh AUTHOR | |||||
The Linux NetFPGA SUME driver was originally written by Bjoern A. Zeeb. | |||||
The FreeBSD version is written by Denis Salopek as a GSoC project. | |||||
rgrimesUnsubmitted Done Inline ActionsChange in tense from past to present (was in last sentence, is in this sentence), the "is" should be changed to a "was". rgrimes: Change in tense from past to present (was in last sentence, is in this sentence), the "is"… | |||||
More information about the project can be found here: | |||||
.Pa https://wiki.freebsd.org/SummerOfCode2020Projects/NetFPGA_SUME_Driver | |||||
Done Inline ActionsHaving played with the driver over the past few days, it would always successfully recover from rare glitches (presumably in FPGA logic(. Hence, I'm curious whether this comment is still valid and needed, and if not, I'd vote for removing it, or at least to trim it down and simply say that . I think it would be more important to notify users about the current FPGA design's inability to stop physical ports which have been configured as DOWN from consuming PCI / memory bandwidth, interrupts and CPU cycles, and that there's absolutely noting we can do about it in the driver. zec: Having played with the driver over the past few days, it would always successfully recover from… |
This file is missing copyright, license and $FreeBSD$.