linux/Documentation/networking
Linus Torvalds 5bbcc0f595 Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net-next
Pull networking updates from David Miller:
 "Highlights:

   1) Maintain the TCP retransmit queue using an rbtree, with 1GB
      windows at 100Gb this really has become necessary. From Eric
      Dumazet.

   2) Multi-program support for cgroup+bpf, from Alexei Starovoitov.

   3) Perform broadcast flooding in hardware in mv88e6xxx, from Andrew
      Lunn.

   4) Add meter action support to openvswitch, from Andy Zhou.

   5) Add a data meta pointer for BPF accessible packets, from Daniel
      Borkmann.

   6) Namespace-ify almost all TCP sysctl knobs, from Eric Dumazet.

   7) Turn on Broadcom Tags in b53 driver, from Florian Fainelli.

   8) More work to move the RTNL mutex down, from Florian Westphal.

   9) Add 'bpftool' utility, to help with bpf program introspection.
      From Jakub Kicinski.

  10) Add new 'cpumap' type for XDP_REDIRECT action, from Jesper
      Dangaard Brouer.

  11) Support 'blocks' of transformations in the packet scheduler which
      can span multiple network devices, from Jiri Pirko.

  12) TC flower offload support in cxgb4, from Kumar Sanghvi.

  13) Priority based stream scheduler for SCTP, from Marcelo Ricardo
      Leitner.

  14) Thunderbolt networking driver, from Amir Levy and Mika Westerberg.

  15) Add RED qdisc offloadability, and use it in mlxsw driver. From
      Nogah Frankel.

  16) eBPF based device controller for cgroup v2, from Roman Gushchin.

  17) Add some fundamental tracepoints for TCP, from Song Liu.

  18) Remove garbage collection from ipv6 route layer, this is a
      significant accomplishment. From Wei Wang.

  19) Add multicast route offload support to mlxsw, from Yotam Gigi"

* git://git.kernel.org/pub/scm/linux/kernel/git/davem/net-next: (2177 commits)
  tcp: highest_sack fix
  geneve: fix fill_info when link down
  bpf: fix lockdep splat
  net: cdc_ncm: GetNtbFormat endian fix
  openvswitch: meter: fix NULL pointer dereference in ovs_meter_cmd_reply_start
  netem: remove unnecessary 64 bit modulus
  netem: use 64 bit divide by rate
  tcp: Namespace-ify sysctl_tcp_default_congestion_control
  net: Protect iterations over net::fib_notifier_ops in fib_seq_sum()
  ipv6: set all.accept_dad to 0 by default
  uapi: fix linux/tls.h userspace compilation error
  usbnet: ipheth: prevent TX queue timeouts when device not ready
  vhost_net: conditionally enable tx polling
  uapi: fix linux/rxrpc.h userspace compilation errors
  net: stmmac: fix LPI transitioning for dwmac4
  atm: horizon: Fix irq release error
  net-sysfs: trigger netlink notification on ifalias change via sysfs
  openvswitch: Using kfree_rcu() to simplify the code
  openvswitch: Make local function ovs_nsh_key_attr_size() static
  openvswitch: Fix return value check in ovs_meter_cmd_features()
  ...
2017-11-15 11:56:19 -08:00
..
caif
dsa net: dsa: lan9303: Documentation: Add missing word "Mbps" 2017-11-13 09:59:29 +09:00
mac80211_hwsim mac80211_hwsim: suggest nl80211 instead of wext driver in documentation 2016-10-17 11:38:01 +02:00
3c509.txt
6lowpan.txt documentation: networking: add 6lowpan documentation 2015-08-11 22:05:36 +02:00
6pack.txt
00-INDEX batman-adv: Convert batman-adv.txt to reStructuredText 2017-07-29 09:51:28 +02:00
alias.txt
altera_tse.txt Documentation: networking: fix spelling mistakes 2016-04-28 14:21:13 -04:00
arcnet-hardware.txt
arcnet.txt
atm.txt
ax25.txt
batman-adv.rst batman-adv: Convert batman-adv.txt to reStructuredText 2017-07-29 09:51:28 +02:00
baycom.txt
bonding.txt doc: Fix typo "8023.ad" in bonding documentation 2017-10-07 23:19:13 +01:00
bridge.txt
can.txt can: bcm: add documentation for CAN FD support 2016-06-17 15:39:47 +02:00
cdc_mbim.txt Documentation: fix usb related doc refs 2017-10-12 11:15:48 -06:00
checksum-offloads.txt Documentation: fix networking related doc refs. 2017-10-12 11:21:05 -06:00
conf.py docs-rst: convert networking book to ReST 2017-05-16 08:44:13 -03:00
cops.txt
cs89x0.txt
cxacru-cf.py
cxacru.txt
cxgb.txt
dccp.txt doc: spelling error changes 2014-05-05 15:32:05 +02:00
dctcp.txt tcp: add rfc3168, section 6.1.1.1. fallback 2015-05-19 16:53:37 -04:00
de4x5.txt
decnet.txt
dl2k.txt
dm9000.txt
dmfe.txt
dns_resolver.txt doc: ReSTify keys-request-key.txt 2017-05-18 10:33:51 -06:00
dpaa.txt Documentation: networking: add RSS information 2017-08-28 16:41:01 -07:00
driver.txt
e100.txt Documentation: Fix dead URLs to ftp.kernel.org 2017-03-29 15:46:06 -06:00
e1000.txt Documentation: Fix dead URLs to ftp.kernel.org 2017-03-29 15:46:06 -06:00
e1000e.txt Documentation: Fix dead URLs to ftp.kernel.org 2017-03-29 15:46:06 -06:00
ena.txt net: ena: Add a driver for Amazon Elastic Network Adapters (ENA) 2016-08-12 17:12:08 -07:00
eql.txt
fib_trie.txt fib_trie.txt: fix typo 2014-12-15 11:45:15 -05:00
filter.txt Major additions: 2017-09-22 16:16:41 -10:00
fore200e.txt Doc: Change wikipedia's URL from http to https 2015-06-22 10:14:05 -06:00
framerelay.txt
gen_stats.txt net: sched: do not acquire qdisc spinlock in qdisc/class stats dump 2016-06-07 16:37:14 -07:00
generic_netlink.txt
generic-hdlc.txt
gianfar.txt gianfar: Remove sysfs stubs for FIFOCFG and stashing 2014-02-18 15:03:02 -05:00
gtp.txt net: Extend Kernel GTP-U tunneling documentation 2017-11-14 21:11:57 +09:00
hinic.txt net-next/hinic: Initialize hw interface 2017-08-22 10:48:52 -07:00
i40e.txt i40e: document drivers use of ntuple filters 2017-03-23 21:13:33 -07:00
i40evf.txt i40evf: update i40evf.txt with new content 2017-06-01 14:31:37 -07:00
ieee802154.txt doc: linux-wpan: Change the old function names to the lastest function names 2017-08-10 15:03:18 -06:00
igb.txt Documentation: Fix dead URLs to ftp.kernel.org 2017-03-29 15:46:06 -06:00
igbvf.txt Documentation: Fix dead URLs to ftp.kernel.org 2017-03-29 15:46:06 -06:00
ila.txt ila: Add ila.txt 2017-11-08 11:21:16 +09:00
index.rst batman-adv: Convert batman-adv.txt to reStructuredText 2017-07-29 09:51:28 +02:00
ip_dynaddr.txt
ip-sysctl.txt tcp: retire FACK loss detection 2017-11-11 18:53:16 +09:00
ipddp.txt
iphase.txt
ipsec.txt xfrm: Add file to document IPsec corner case 2013-12-16 12:54:05 +01:00
ipv6.txt
ipvlan.txt ipvlan: implement VEPA mode 2017-10-29 18:39:57 +09:00
ipvs-sysctl.txt ipvs: Document sysctl pmtu_disc 2017-03-16 13:33:39 +01:00
irda.txt
ixgb.txt Documentation: Fix dead URLs to ftp.kernel.org 2017-03-29 15:46:06 -06:00
ixgbe.txt Documentation: Fix dead URLs to ftp.kernel.org 2017-03-29 15:46:06 -06:00
ixgbevf.txt
kapi.rst docs-rst: convert networking book to ReST 2017-05-16 08:44:13 -03:00
kcm.txt Doc: Fix double words in Documentation 2017-01-26 15:25:41 -07:00
l2tp.txt net: l2tp: deprecate PPPOL2TP_MSG_* in favour of L2TP_MSG_* 2016-12-10 23:29:11 -05:00
lapb-module.txt
LICENSE.qla3xxx
LICENSE.qlcnic
LICENSE.qlge
ltpc.txt
mac80211-auth-assoc-deauth.txt
mac80211-injection.txt mac80211: document only injected *_RADIOTAP_* flags 2016-04-05 10:48:57 +02:00
mpls-sysctl.txt mpls: allow TTL propagation from IP packets to be configured 2017-03-13 15:29:22 -07:00
msg_zerocopy.rst doc: document MSG_ZEROCOPY 2017-09-01 10:39:35 -07:00
multiqueue.txt
netconsole.txt docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
netdev-FAQ.txt net: Mention net-next status web page in netdev-FAQ.txt 2017-11-14 21:11:57 +09:00
netdev-features.txt net: remove NETDEV_TX_LOCKED support 2016-04-26 15:53:05 -04:00
netdevices.txt net: remove NETDEV_TX_LOCKED support 2016-04-26 15:53:05 -04:00
netfilter-sysctl.txt netfilter: allow logging from non-init namespaces 2017-02-02 14:31:58 +01:00
netif-msg.txt
netvsc.txt hv_netvsc: Update netvsc Document for TCP hash level setting 2017-10-08 10:11:01 -07:00
nf_conntrack-sysctl.txt netfilter: conntrack: do not enable connection tracking unless needed 2017-07-31 20:42:00 +02:00
nfc.txt
openvswitch.txt openvswitch: Add support for unique flow IDs. 2015-01-26 15:45:50 -08:00
operstates.txt doc:net: Fix typo in Documentation/networking 2013-10-30 17:10:20 -04:00
packet_mmap.txt Documentation: fix networking related doc refs. 2017-10-12 11:21:05 -06:00
phonet.txt
phy.txt net: phy: Delete unused function phy_ethtool_gset 2017-06-06 15:12:28 -04:00
pktgen.txt Documentation: networking: fix spelling mistakes 2016-04-28 14:21:13 -04:00
PLIP.txt
ppp_generic.txt
proc_net_tcp.txt
radiotap-headers.txt
ray_cs.txt
rds.txt Documentation: RDS: Document Multipath RDS (mprds) 2016-07-15 11:36:58 -07:00
README.ipw2100
README.ipw2200
README.sb1000
regulatory.txt cfg80211: reg: remove support for built-in regdb 2017-10-11 13:18:51 +02:00
rmnet.txt drivers: net: ethernet: qualcomm: rmnet: Initial implementation 2017-08-30 11:41:13 -07:00
rxrpc.txt rxrpc: Use MSG_WAITALL to tell sendmsg() to temporarily ignore signals 2017-10-18 11:43:07 +01:00
s2io.txt neterion: remove reference to ifconfig 2015-03-08 19:11:44 -04:00
scaling.txt net: fix up hash documentation 2017-06-07 13:00:41 -04:00
sctp.txt
secid.txt
seg6-sysctl.txt ipv6: sr: add documentation file for per-interface sysctls 2016-11-09 20:40:06 -05:00
segmentation-offloads.txt doc: SKB_GSO_[IPIP|SIT] have been replaced 2017-07-08 11:25:56 +01:00
skfp.txt
smc9.txt
spider_net.txt doc: fix double words 2014-03-21 13:16:58 +01:00
stmmac.txt net: smmac: allow configuring lower pbl values 2016-12-08 13:07:10 -05:00
strparser.txt strparser: initialize all callbacks 2017-08-24 21:57:50 -07:00
switchdev.txt Documentation: networking: fix ASCII art in switchdev.txt 2017-09-18 16:38:46 -07:00
tc-actions-env-rules.txt net: sched: use counter to break reclassify loops 2015-05-13 15:08:14 -04:00
tcp-thin.txt
tcp.txt net: Update TCP congestion control documentation 2017-06-05 10:53:24 -04:00
team.txt
timestamping.txt net: Fix minor code bug in timestamping.txt 2017-07-11 13:34:54 -07:00
tlan.txt
tls.txt tls: Documentation 2017-06-15 12:12:41 -04:00
tproxy.txt
tuntap.txt
udplite.txt Doc: networking: Fix URL for wiki.wireshark.org in udplite.txt 2015-06-12 14:21:29 -07:00
vortex.txt docs: fix locations of several documents that got moved 2016-10-24 08:12:35 -02:00
vrf.txt doc: Update VRF documentation metric 2017-10-20 13:03:03 +01:00
vxge.txt neterion: remove reference to ifconfig 2015-03-08 19:11:44 -04:00
vxlan.txt documentation: bring vxlan documentation more up-to-date 2015-08-12 16:46:30 -07:00
x25-iface.txt doc:net: Fix typo in Documentation/networking 2013-10-30 17:10:20 -04:00
x25.txt
xfrm_proc.txt
xfrm_sync.txt Documentation: networking: fix spelling mistakes 2016-04-28 14:21:13 -04:00
xfrm_sysctl.txt
z8530book.rst docs-rst: convert scsi DocBook to ReST 2017-05-16 08:44:15 -03:00
z8530drv.txt

sb1000 is a module network device driver for the General Instrument (also known
as NextLevel) SURFboard1000 internal cable modem board.  This is an ISA card
which is used by a number of cable TV companies to provide cable modem access.
It's a one-way downstream-only cable modem, meaning that your upstream net link
is provided by your regular phone modem.

This driver was written by Franco Venturi <fventuri@mediaone.net>.  He deserves
a great deal of thanks for this wonderful piece of code!

-----------------------------------------------------------------------------

Support for this device is now a part of the standard Linux kernel.  The
driver source code file is drivers/net/sb1000.c.  In addition to this
you will need:

1.) The "cmconfig" program.  This is a utility which supplements "ifconfig"
to configure the cable modem and network interface (usually called "cm0");
and

2.) Several PPP scripts which live in /etc/ppp to make connecting via your
cable modem easy.

   These utilities can be obtained from:

      http://www.jacksonville.net/~fventuri/

   in Franco's original source code distribution .tar.gz file.  Support for
   the sb1000 driver can be found at:

      http://web.archive.org/web/*/http://home.adelphia.net/~siglercm/sb1000.html
      http://web.archive.org/web/*/http://linuxpower.cx/~cable/

   along with these utilities.

3.) The standard isapnp tools.  These are necessary to configure your SB1000
card at boot time (or afterwards by hand) since it's a PnP card.

   If you don't have these installed as a standard part of your Linux
   distribution, you can find them at:

      http://www.roestock.demon.co.uk/isapnptools/

   or check your Linux distribution binary CD or their web site.  For help with
   isapnp, pnpdump, or /etc/isapnp.conf, go to:

      http://www.roestock.demon.co.uk/isapnptools/isapnpfaq.html

-----------------------------------------------------------------------------

To make the SB1000 card work, follow these steps:

1.) Run `make config', or `make menuconfig', or `make xconfig', whichever
you prefer, in the top kernel tree directory to set up your kernel
configuration.  Make sure to say "Y" to "Prompt for development drivers"
and to say "M" to the sb1000 driver.  Also say "Y" or "M" to all the standard
networking questions to get TCP/IP and PPP networking support.

2.) *BEFORE* you build the kernel, edit drivers/net/sb1000.c.  Make sure
to redefine the value of READ_DATA_PORT to match the I/O address used
by isapnp to access your PnP cards.  This is the value of READPORT in
/etc/isapnp.conf or given by the output of pnpdump.

3.) Build and install the kernel and modules as usual.

4.) Boot your new kernel following the usual procedures.

5.) Set up to configure the new SB1000 PnP card by capturing the output
of "pnpdump" to a file and editing this file to set the correct I/O ports,
IRQ, and DMA settings for all your PnP cards.  Make sure none of the settings
conflict with one another.  Then test this configuration by running the
"isapnp" command with your new config file as the input.  Check for
errors and fix as necessary.  (As an aside, I use I/O ports 0x110 and
0x310 and IRQ 11 for my SB1000 card and these work well for me.  YMMV.)
Then save the finished config file as /etc/isapnp.conf for proper configuration
on subsequent reboots.

6.) Download the original file sb1000-1.1.2.tar.gz from Franco's site or one of
the others referenced above.  As root, unpack it into a temporary directory and
do a `make cmconfig' and then `install -c cmconfig /usr/local/sbin'.  Don't do
`make install' because it expects to find all the utilities built and ready for
installation, not just cmconfig.

7.) As root, copy all the files under the ppp/ subdirectory in Franco's
tar file into /etc/ppp, being careful not to overwrite any files that are
already in there.  Then modify ppp@gi-on to set the correct login name,
phone number, and frequency for the cable modem.  Also edit pap-secrets
to specify your login name and password and any site-specific information
you need.

8.) Be sure to modify /etc/ppp/firewall to use ipchains instead of
the older ipfwadm commands from the 2.0.x kernels.  There's a neat utility to
convert ipfwadm commands to ipchains commands:

   http://users.dhp.com/~whisper/ipfwadm2ipchains/

You may also wish to modify the firewall script to implement a different
firewalling scheme.

9.) Start the PPP connection via the script /etc/ppp/ppp@gi-on.  You must be
root to do this.  It's better to use a utility like sudo to execute
frequently used commands like this with root permissions if possible.  If you
connect successfully the cable modem interface will come up and you'll see a
driver message like this at the console:

         cm0: sb1000 at (0x110,0x310), csn 1, S/N 0x2a0d16d8, IRQ 11.
         sb1000.c:v1.1.2 6/01/98 (fventuri@mediaone.net)

The "ifconfig" command should show two new interfaces, ppp0 and cm0.
The command "cmconfig cm0" will give you information about the cable modem
interface.

10.) Try pinging a site via `ping -c 5 www.yahoo.com', for example.  You should
see packets received.

11.) If you can't get site names (like www.yahoo.com) to resolve into
IP addresses (like 204.71.200.67), be sure your /etc/resolv.conf file
has no syntax errors and has the right nameserver IP addresses in it.
If this doesn't help, try something like `ping -c 5 204.71.200.67' to
see if the networking is running but the DNS resolution is where the
problem lies.

12.) If you still have problems, go to the support web sites mentioned above
and read the information and documentation there.

-----------------------------------------------------------------------------

Common problems:

1.) Packets go out on the ppp0 interface but don't come back on the cm0
interface.  It looks like I'm connected but I can't even ping any
numerical IP addresses.  (This happens predominantly on Debian systems due
to a default boot-time configuration script.)

Solution -- As root `echo 0 > /proc/sys/net/ipv4/conf/cm0/rp_filter' so it
can share the same IP address as the ppp0 interface.  Note that this
command should probably be added to the /etc/ppp/cablemodem script
*right*between* the "/sbin/ifconfig" and "/sbin/cmconfig" commands.
You may need to do this to /proc/sys/net/ipv4/conf/ppp0/rp_filter as well.
If you do this to /proc/sys/net/ipv4/conf/default/rp_filter on each reboot
(in rc.local or some such) then any interfaces can share the same IP
addresses.

2.) I get "unresolved symbol" error messages on executing `insmod sb1000.o'.

Solution -- You probably have a non-matching kernel source tree and
/usr/include/linux and /usr/include/asm header files.  Make sure you
install the correct versions of the header files in these two directories.
Then rebuild and reinstall the kernel.

3.) When isapnp runs it reports an error, and my SB1000 card isn't working.

Solution -- There's a problem with later versions of isapnp using the "(CHECK)"
option in the lines that allocate the two I/O addresses for the SB1000 card.
This first popped up on RH 6.0.  Delete "(CHECK)" for the SB1000 I/O addresses.
Make sure they don't conflict with any other pieces of hardware first!  Then
rerun isapnp and go from there.

4.) I can't execute the /etc/ppp/ppp@gi-on file.

Solution -- As root do `chmod ug+x /etc/ppp/ppp@gi-on'.

5.) The firewall script isn't working (with 2.2.x and higher kernels).

Solution -- Use the ipfwadm2ipchains script referenced above to convert the
/etc/ppp/firewall script from the deprecated ipfwadm commands to ipchains.

6.) I'm getting *tons* of firewall deny messages in the /var/kern.log,
/var/messages, and/or /var/syslog files, and they're filling up my /var
partition!!!

Solution -- First, tell your ISP that you're receiving DoS (Denial of Service)
and/or portscanning (UDP connection attempts) attacks!  Look over the deny
messages to figure out what the attack is and where it's coming from.  Next,
edit /etc/ppp/cablemodem and make sure the ",nobroadcast" option is turned on
to the "cmconfig" command (uncomment that line).  If you're not receiving these
denied packets on your broadcast interface (IP address xxx.yyy.zzz.255
typically), then someone is attacking your machine in particular.  Be careful
out there....

7.) Everything seems to work fine but my computer locks up after a while
(and typically during a lengthy download through the cable modem)!

Solution -- You may need to add a short delay in the driver to 'slow down' the
SURFboard because your PC might not be able to keep up with the transfer rate
of the SB1000. To do this, it's probably best to download Franco's
sb1000-1.1.2.tar.gz archive and build and install sb1000.o manually.  You'll
want to edit the 'Makefile' and look for the 'SB1000_DELAY'
define.  Uncomment those 'CFLAGS' lines (and comment out the default ones)
and try setting the delay to something like 60 microseconds with:
'-DSB1000_DELAY=60'.  Then do `make' and as root `make install' and try
it out.  If it still doesn't work or you like playing with the driver, you may
try other numbers.  Remember though that the higher the delay, the slower the
driver (which slows down the rest of the PC too when it is actively
used). Thanks to Ed Daiga for this tip!

-----------------------------------------------------------------------------

Credits:  This README came from Franco Venturi's original README file which is
still supplied with his driver .tar.gz archive.  I and all other sb1000 users
owe Franco a tremendous "Thank you!"  Additional thanks goes to Carl Patten
and Ralph Bonnell who are now managing the Linux SB1000 web site, and to
the SB1000 users who reported and helped debug the common problems listed
above.


					Clemmitt Sigler
					csigler@vt.edu