Sync em(4) manpage with the one in Intel em 6.2.9

Sync with Intel's em-6.2.9
- Support more chips.
- Implement suspend/resume device methods.
- Correct promisc mode support.
- Code and comment clean up.
- Avoid reinitializing the hardware if only IP address is changed.  This is
  implemented in a different way from Intel's:
  If IFF_RUNNING is set, em_init() will return immediately.  So for some
  situation in which em_init() must run, IFF_RUNNING is cleared before calling
  em_init().
- Rework TX processing:
  In em_encap(), save the index of the packet's last TX descriptor (EOP) in
  the packet's first descriptor.  In em_txeof(), test E1000_TXD_STAT_DD bit
  only for last TX descriptor (EOP) of certain packet.  If it is set, then
  reap the TX descriptors of the packet in an inner loop.
  "This change is important for future chips, where DD bit is going
   to be set only on the EOP descriptors." -- Jack Vogel at Intel

- Replace magic number with macro.
- In iwi_auth_and_assoc(), add assertion before the questionable memcpy().
  After recent bug fixing in 802.11 layer, this assertion should not fail.

Since all necessary bits are in 802_11 layer now:
- Properly set basic rate set and operational rate set for acx100 part.
- Properly set basic rate set for acx111 part.
- More strigent rate checking

Massive 802_11 XRATE bug fixing.

- Correct ieee80211_fix_rate(IEEE80211_F_DODEL) operation by entering
  IEEE80211_F_DONEGO code segment but avoiding real negotiation.
- In ieee80211_fix_rate(), remove duplicated rates if rate set is to
  be sorted.  This should be enough to protect us against maliciously
  minted 802.11 management frames which contain supported rate and
  extended supported rate ies. [*]
- In ieee80211_sta_join(), call ieee80211_fix_rate(IEEE80211_F_DODEL),
  if the wireless NIC operates in STA mode.  So drivers can depend on
  ieee80211com.ic_bss's ni_rates even before entering RUN state, this
  is *very important* for certain driver e.g. iwi(4) [*].
- Add ic_nbasicrates in ieee80211com, which records the number of
  basic rates in the current BSS. [1]
- Add a new function ieee80211_copy_basicrates().  This function is
  used to propagate IEEE80211_RATE_BASIC bit from second parameter
  to the first parameter.  It will return number of basic rates in
  the second parameter.  It is called in ieee80211_sta_join() to
  properly setup basic rates in ieee80211com.ic_sup_rates and
  ieee80211com.ic_nbasicrates. [2]
- Introduce extra parameter to ieee80211_setup_rates() and
  ieee80211_fix_rate().
  This parameter only affects how IEEE80211_F_DONEGO is done.
  Adjust IEEE80211_F_DONEGO behavior after introducing this parameter:
  If the new parameter is 1, then the negotiation is performed on the
  behalf of a STA which wants to join either an infrastructured or an
  independent BSS, and the rate set going to be negotiated is the BSS's
  supported rate set:
  o  Don't overwrite the BSS basic rate set.  So drivers and TX rate
     control algorithm can have knowledge of the BSS basic rate set and
     can do various setting accordingly.
  o  Avoid joining the BSS, if certain rates in the BSS basic rate set
     are not supported.
  If the new parameter is 0, then the negotiation is performed on the
  behalf of a HOSTAP, or a STA that already joined/started an independent
  BSS, and the rate set going to be negotiated is peer STA's supported
  rate set:
  o  Overwrite the basic rates of peer STA's supported rate set with
     basic rates in ieee80211com.ic_sup_rates, which is set up properly
     in ieee80211_sta_join() by ieee80211_copy_basicrates() (see [2]),
     so TX rate control algorithm can act accordingly.
  o  If the current operation mode is IEEE80211_M_HOSTAP, use a counter
     to bookkeep how many basic rates got overwritten during negotiation.
     If at the end of the negotiation the counter is less than
     ieee80211com.ic_nbasicrates (see [1] and [2]), then it means that
     the peer STA does not support certain rates in our basic rate set.
     This kind of STA should not be allowed to join the current BSS.
     This prevention mechanism should be more straightforword than the
     old one in ieee80211_recv_mgmt(), nuke the old prevention mechanism
     after this change.
- In ieee80211_init_neighbor(), do full rate set negotiation, so nodes
  created by ieee80211_add_neighbor() or ieee80211_fakeup_adhoc_node(),
  will not contain rates that the wireless NIC does not support.
- In ieee80211_{beacon,probe_resp}_alloc(), use ieee80211com.ic_sup_rates
  to setup supported rates and extended supported rates ie, instead of
  using ieee80211com.ic_bss's ni_rates.  So two 11g STAs in a 11g/11b
  mixed IBSS can comunicate with each other using OFDM rates, given proper
  protection, like RTS-CTS/CTS-to-self, is applied. [**]
- In ieee80211_send_mgmt(), use ieee80211com.ic_sup_rates to create
  supported rates and extended supported rates ie of (re)association
  response.  So these ies are consistent with what's in beacon and probe
  response. [**]
- In ieee80211_send_mgmt(), use ieee80211_probe_resp_alloc() to create
  frame body of probe response.
- Add more XRATE debug messages.

#
# [*] Details:
# http://lists.freebsd.org/pipermail/freebsd-current/2006-October/066679.html
#
# [**] Basic rates in ieee80211com.ic_sup_rates are set beforehand (see [2])
#

- Don't call m_adj() to make RX buffer's _payload_ on longword aligned,
  because some re(4) chips (e.g. RTL8101E) require RX buffer to be
  8-bytes aligned.  This change shows no noticeable performance change.
Reported-by: Joe Talbott <josepht@cstone.net>
- Avoid writing extra hardware registers by writing 2 bytes to IDR4
  instead instead of writing 4 bytes, bacause:
  1) the extra two registers after IDR5 are reserved.
  2) accessing arpcom.ac_enaddr[6,7] should be invalid.
- Add a flag field in re_softc and re_hwrev.  Currently only one flag,
  RE_F_HASMPC, is defined.  This flag is used to indicate whether the
  hardware has MPC register or not, so we can avoid writing to MPC's
  position, if that position is reserved.
- Move descriptor ring address setting up before RX/TX enabling, since
  some re(4) chips (e.g. RTL8101E) will try accessing descriptor ring
  immediately after RX/TX is enabled, which results in intermittent
  kernel panic or system hanging.
Paniced-by: Joe Talbott <josepht@cstone.net>
- Avoid calling re_init(), if hw.reX.tx_moderation is changed but NIC
  is not up yet.
- Const-fy global hardware id arrays and nuke unused macro while I'm here.

Thank Joe Talbott <josepht@cstone.net> to help debugging and provide
valuable information (esp. locating the problematic RX/TX enabling :)

Thank dillon@ to provide debugging hints.

Tested-by:
  Joe Talbott <josepht@cstone.net> (RTL8101E)
  swildner@ (onboard RTL8169S) (*)
  me (RTL8169S)

# (*) swildner@'s card is still half broken even after this commit :\

Remove an #ifdef _KERNEL inside an #ifdef _KERNEL.

Rename printf -> kprintf in sys/ and add some defines where necessary
(files which are used in userland, too).

Rename printf -> kprintf in sys/ and add some defines where necessary
(files which are used in userland, too).

Rename printf -> kprintf in sys/ and add some defines where necessary
(files which are used in userland, too).

Rename printf -> kprintf in sys/ and add some defines where necessary
(files which are used in userland, too).

Rename printf -> kprintf in sys/ and add some defines where necessary
(files which are used in userland, too).

Rename printf -> kprintf in sys/ and add some defines where necessary
(files which are used in userland, too).

Rename printf -> kprintf in sys/ and add some defines where necessary
(files which are used in userland, too).

Define kvsnprintf as vsnprintf for the case where subr_sbuf.c is compiled
as libsbuf.

Spotted-by: Trevor Kendall <trevorjkendall@gmail.com>

- Use jumbo buffers only when MTU > 1518 bytes.
  o  In sk_dma_alloc(), allocate additional DMA stuffs for normal mbuf cluster
     to use.
  o  In sk_init(), set sk_if_softc.sk_use_jumbo if ifnet.if_mtu > 1518.  This
     should only be done after sk_stop(), so sk_stop() will not free wrong RX
     buffers.  Add a comment about it.
  o  Don't touch jumbo buffer related bits in hardware registers, if jumbo
     buffer is not used currently.
  o  Rename old sk_newbuf() to sk_newbuf_jumbo().
  o  Implement sk_newbuf_std(), which allocates RX buffer using mbuf clusters.
  o  Add a wrapper function, sk_newbuf(), to switch between above two functions
     based on whether sk_if_softc.sk_use_jumbo is set or not.
- If something fail in sk_rxeof(), don't call sk_newbuf() with old mbuf:
  Hardware will not change RX descriptor's buffer address part.  Only
  controlling bits of the RX descriptor need to be set up properly.
  Nuke third parameter (i.e. mbuf) of sk_newbuf() after this change and
  rearrange sk_newbuf_jumbo() accordingly.
- Since sk_chain and TX/RX descriptor use same index, nuke unnecessary
  sk_chain.sk_desc field, which points to a corresponding TX/RX descriptor.
  Pass the TX/RX descriptor index to sk_newbuf() instead of sk_chain pointer.
  Nuke never used sk_chain.sk_next field.  These changes degenarate sk_chain
  into a mbuf pointer, so nuke no longer needed sk_chain structure.

Tested-by: Rumko <rumcic@gmail.com> and Gergo Szakal <bastyaelvtars@gmail.com>
Partially-reviewed-by: dillon@

Add the PCI_MAP_FIXUP code as proposed two weeks ago. The code is only
enabled with options PCI_MAP_FIXUP in your kernel, and should only be used
when using nata.

Rename sprintf  -> ksprintf
Rename snprintf -> knsprintf

Make allowances for source files that are compiled for both userland and
the kernel.

Add IFF_MONITOR support.

Submitted-by: "Vlad Galu" <dudu@dudu.ro>
Obtained-from: FreeBSD

See whether we should compile ipfilter with INET6 support by looking at the
kernel config rather than requiring the user to use an undocumented build
option.

Thanks to corecode, TGEN, and vbd for various suggestions and Max Herrgard
<herrgard@gmail.com> for testing.

Dragonfly-bug:  <http://bugs.dragonflybsd.org/issue322>
Reviewed-by: vbd

Undo some renames that don't apply to the boot code (linked against libstand).

Add 'k' versions for printf, sprintf, and snprintf.  kprintf, ksprintf, and
ksnprintf.  This will allow these functions to be renamed piecemeal without
breaking the source tree.

Rename kvprintf  -> kvcprintf (call-back version)
Rename vprintf   -> kvprintf
Rename vsprintf  -> kvsprintf
Rename vsnprintf -> kvsnprintf

Add a prototype for the new mcontrol() system call.

Repo copy machine/pc32/i386/mem.c to kern/kern_memio.c and separate out
the (few) machine-dependant parts.  This file primarily controls access
to /dev/zero, /dev/null, /dev/random, and kernel memory, and does not belong
in a machine-dependant directory.

Pass NULL to objcache_create() to indicate that null_ctor() and/or null_dtor()
should be used.  Make null_ctor() and null_dtor() private functions.

Disallow M_ZERO entirely, it doesn't really fit the objcache model.

With-input-from: "Simon 'corecode' Schubert" <corecode@fs.ei.tum.de>,
 "Thomas E. Spanjaard" <tgen@netphreax.net>,
 Jeffrey Hsu <hsu@crater.dragonflybsd.org>

- Factor out ieee80211_print_rateset().
- Add a debug macro: IEEE80211_PRINT_NODERATES().  Replace two almost same
  debug code segments with it.

Add a manual page for umct(4).

Make umct compilable into the kernel and add it to LINT.

Fix a typo (found in FreeBSD) and update CVS tag.

There is no "atapi-all.h" anymore. Remove reference to it from atapi-cam.c.

rename sscanf -> ksscanf
rename vsscanf -> kvsscanf
rename fnmatch -> kfnmatch
rename qsort -> kqsort

Fix umct and add F5U409 USB Serial Adaptor.

Submitted-by: Joe Talbott <josepht@cstone.net>

Have the genassym.o target depend on forwarding-headers. This unbreaks
parallel kernel builds.

${_LHDRS} must succeed ${_MACHINE_FWD}/include/machine, which creates
${_MACHINE_FWD}/include, in which ${_LHDRS} target creates some headers.

Reported-by: tgen@

Modify the device description for the standard nForce and nForce2 on-chip
ethernet controllers to Fast Ethernet. Only the last one or two models of
the nForce2 (Ultra 400Gb and possibly Ultra 400R) supported a gmiibus.

Also add a comment regarding PCI_PRODUCT_NVIDIA_NFORCE3_LAN2, as that PCI
ID also appears on the nForce2 Ultra 400Gb chipset's MCP.

Explicitly specify null_dtor as our objcache destructor. Fixes a panic when
we were out of empty magazines.

Add another ICH PCI ID.

Submitted-by: "Vlad Galu" <dudu@dudu.ro>

Merge from vendor branch FILE:
Update to file-4.19.

Update to file-4.19.

Update to file-4.19.

We don't use magic2mime, so remove it.

- Correct some debug messages format.
- In ieee80211_init_neighbor(), print neighbors' rate set.

Exploring low speed busses during cold boot, so USB keyboard will work even
if the kernel is configured with "device atkbd" and "device atkbdc"

Reported-by: Petr Janda <elekktretterr@exemail.com.au>
Tested-by: Petr Janda <elekktretterr@exemail.com.au>

Update with the latest newsletters from the ISO3166 Maintenance Agency:

http://www.iso.ch/iso/en/prods-services/iso3166ma/03updates-on-iso-3166/index.html

This has the nice side-effect of fixing tzsetup.

Remove unnecessary escape character.

Convert to mdoc.

Convert to mdoc.

Add documentation for the mcontrol system call.

Add markup and bump date for rev. 1.5.

Fix typos: mininum/minimun -> minimum

Document MADV_SETMAP and MAP_VPAGETABLE.  These functions support virtualized
page tables for memory mapped regions from userland.

Use ${.CURDIR} to get the correct path to the root skeleton directory.

This time *really* fix the .PATHs in the kmod Makefiles. I promise.

Fix a deadlock in the request completion code when the timeout timed out.
The cause was not unlocking the done spinlock before calling ata_completed,
resulting in ata_completed waiting forever because it needs to acquire the
lock as well.

The solution introduces a new request flag, ATA_R_COMPLETED to signal
sleepers that a request has or has not been completed. In theory, we could
just check the return value of msleep(), but this is quite elegant, and
corecode convinced me ;).

Reported-by: YONETANI Tomokazu <qhwt+dfly@les.ath.cx>
Reviewed-by: Simon 'corecode' Schubert <corecode@fs.ei.tum.de>

Don't mention recently nuked sysctl MIBs

Mention required kernel devices for rtw(4) and acx(4)

rtw(4) requires wlan_wep(4)

- Add manpage for rum(4)
  Obtained-from: OpenBSD
- Add manpage for ural(4)
  Obatined-frim: FreeBSD

Reviewed-by: swildner@

- Hook rum(4) and ural(4) into GENERIC and LINT
- Hook rum(4) and ural(4) into module building
- Enable wlan_ratectl_onoe in GENERIC.  It is required by rum(4) and ural(4)
- Add a commented-out entry in GENERIC for wlan_ratectl_amrr
- Enable rtw(4) in GENERIC again

Add missing header if USB_DEBUG is defined

Add support for RT2501USB/RT2601USB devices.

Thank Niall O'Higgins <niallo@openbsd.org> and
Damien Bergamini <damien@openbsd.org> for writing this driver.

Obtained-from: OpenBSD

Add support for RT2500USB devices.

Thank Damien Bergamini <damien@openbsd.org> for writing this driver.

Obtained-from: FreeBSD

Update following manpage to reflect changes made to USB host controller part:
- usb.4
  Obtained-from: FreeBSD
- ehci.4 ohci.4 uhci.4

Reviewed-by: swildner@

Sync USB support (host controller part) with FreeBSD6.

Following changes on FreeBSD-CURRENT(by iedowse@freebsd.org) are merged:
ehci.c rev 1.52
ohci.c rev 1.167
uhci.c rev 1.172
usb.c rev 1.111
usbdi.h rev 1.61
"Use a different task queue for host controller and peripheral driver
 tasks. Since the host controllers rely on tasks to process transfer
 timeouts, if a synchronous transfer from a driver was invoked from
 a task and timed out, it would never complete because the single
 task thread was stuck performing the synchronous transfer so couldn't
 process the timeout."

As of this commit, only following kernel APIs are changed:
- usbd_get_string_desc() takes one more argument which returns the actual
  size of the string description.
- usb_add_task() takes one more argument.  The extra arguemnt is used
  to specify to which task queue the task should be added.  There is
  two task queues defined, one for peripheral driver (USB_TASKQ_DRIVER),
  one for host controller (USB_TASKQ_HC).

ugen(4) is adapted according to the above kernel API changes.

Thank all of the folks for their work on the USB support.

Tested-by:
swildner@, vbd@, joerg@(1.6 backport), Max Herrgard <herrgard@gmail.com>

# Though VT6202 is supported by ehci(4), I still have problems with this
# chip, even with the updated ehci(4).

regen

- Add ids for RT2501USB/RT2601USB/RT2500USB
- Add ids for MGE UPS

- Use ieee80211_probe_resp_alloc() to setup probe response template.
- Check the return value of ieee80211_probe_resp_alloc() and
  ieee80211_beacon_alloc().  Since these two functions use MB_DONTWAIT
  to allocate mbuf, it is quite possible they will return NULL.
- Turn on IEEE80211_FC0_VERSION_0 when setup null data and probe request
  templates as what we do in netproto/802_11.
- Don't transmit probe responses injected by netproto/802_11 layer,
  firmware will handle them for us.
- Move acx100's TIM ie template setup into common templates initialization
  routine, so acx111 will get its TIM ie template properly set up.
  This makes firmware add well formatted TIM ies to the end of the beacons
  instead of junked ones.
Reported-by: Marcus Glocker <mglocker@openbsd.org>
- Obey DTIM period set in netproto/802_11, i.e. use ieee80211com.ic_dtim_period
- Reduce the length of Partial Virtual Bitmap in TIM template.

- Factor out _ieee80211_probe_resp_alloc() from ieee80211_send_mgmt().
  This function creates frame body of a Probe Response.
- Add ieee80211_probe_resp_alloc(), which utilizes
  _ieee80211_probe_resp_alloc() to create a complete Probe Response
  management frame (i.e. has MAC header).

Fix compilation warnings when compiling without DEVICE_POLLING.

Fix the paths in ata_if.m and the module Makefiles to reflect their
location in our tree, rather than my development tree at home.

Submitted-by: YONETANI Tomokazu <qwht+dfly@les.ath.cx>

Fix a stack overflow in ifconfig(8).

The stack overflow happens, if "-" is passed as the argument to 'ssid' or
'wepkey' commands.  The offender is ifieee80211.c:get_string()'s "-" special
handling:
...
len = p - buf;
/* The string "-" is treated as the empty string. */
if (!hexstr && len == 1 && buf[0] == '-')
len = 0;
if (len < *lenp)
memset(p, 0, *lenp - len);
...

If the string is "-", the 'p' will be 1 byte beyound 'buf' and 'len' is set to
0.  'len' must be less than '*lenp' here, so memset() will be called.  But the
length, used to clear the buffer, is 1 byte larger the buffer pointed by 'p'

Expand the Intel Brand ID table to cover all known brand IDs as mentioned
in Intel document AP-485, released September 2006, document number
241618-31, page 42.

Revert to zero'ing the objects we pull out of our objcaches ourselves.
Having it done by objcache_get() incurs too much of a penalty on the hot
path of it, that it isn't warranted, especially considering the fact that
pulling zero'ed objects out of it isn't taking advantage of the objcache
model. However, there are arguments for using it, like growability in
interrupt context (zones can't).

Fix some of the C++/Java-style comments in ata-usb.c. Adjust the default
pipe abort to our interface.

These changes allow natausb to compile.

Add a function to retrieve the speed a USB device is running on.

Pending enlightenment, specify confstr(3) to conform to SUSv3 instead of
POSIX 1003.2.

Add a SUSv3 symbol to our local mdoc(7) file. A patch has been submitted to
upstream's doc-syms.

Approved-by: Sascha Wildner <saw@online.de>

nfe_init() should be called with softc not ifnet

Fix a bug in our confstr(3) implementation, it did not conform to POSIX
1003.2. It returned -1 for errors where it should have returned 0.

Also, fix the only consumer of confstr(3) in our tree, getconf(1).

Dragonfly-bug: <http://bugs.dragonflybsd.org/issue393>
Reviewed-by: Victor Balada Diaz <victor@bsdes.net>

Correct a signedness bug which allowed members of the operator
group to read kernel memory.

Obtained-from: FreeBSD / FreeBSD-SA-06:25.kmem

Local variables that were improperly named 'errno' must be renamed so as
not to conflict with libc's errno, when building a virtual kernel.

For the moment conditionally remove the declaration of certain libc
functions when compiling with _KERNEL_VIRTUAL to avoid conflicts with
replicas in the kernel code.  This allows the virtual kernel source to
include standard libc header files.

Define _KERNEL_VIRTUAL in machine/vkernel/conf/kern.mk.

Begin fleshing out the virtual kernel init sequence.

Import of the port of the new(er) FreeBSD atacontrol(8), as natacontrol(8).
It has not yet been hooked into the build, though it does build.

Our cam_sim_free() does not have a flag to signify it should free the devq.
We can probably get away with it like this.

Also, make sure opt_scsi.h is generated for individual kmod builds. The CAM
header files need it.

Add more kmods to the Makefile after testing.

Use IODATA as pcmcia vendor id for the IO-Data CBIDE2. Actually, it should
be -1, because it is really identified by CIS data. This requires (at least)
a sync of our pccarddevs with Free-/NetBSD, because this vendor id actually
belongs to another company.

Also call pccard_get_function_number() instead of pccard_get_function() with
error recording, as we don't have that, and this works.

Fix a NULL pointer dereference introduced in the previous commit.

Reported-by: Emiel Kollof <coolvibe@hackerheaven.org>
Submitted-by: "Thomas E. Spanjaard" <tgen@netphreax.net>, "Simon 'corecode' Schubert" <corecode@fs.ei.tum.de>

Generate forwarding header files to mimic /usr/include -> /usr/include/sys
linkages for the benefit of virtual kernel builds and virtual kernel driver
builds.  Certain header files, such as <fcntl.h>, have to be generated this
way to allow virtual kernel and virtual kernel driver source files to do
standard #include's.

Add a generic interrupt controller type that the virtual kernel build can use.

Order ${_MACHINE_FWD}/include/machine and ${_FWDHDRS} so that intermittent
error messages bugging me during 'make -j N buildkernel' go away.

Rolution-from: y0netan1@

Clean up code.

Misc vkernel work.

Make int bootverbose and int cold declarations machine independant.

Now that the objcache supports M_ZERO for objcache_get() in the case of
simple object caches, use it.

Initial import of the port of the new(er) FreeBSD ATA code.

Note this code has not yet been hooked into the build as such, unless you (unwisely) specify the devices in your kernel config according to sys/conf/files. The modules are also excluded from the module build due to not having a SUBDIR entry in sys/dev/disk/Makefile. The PCI code isn't yet operation pending a patch for sys/bus/pci/pci.c I will send to kernel@ shortly. It short-circuits lazy resource allocation for PCI ATA controllers in legacy mode (i.e. on legacy ISA ATA addresses, which are not configured in the PCI BARs).

The userland utility used to control nata ('natacontrol') and documentation will follow later. Also, be aware only nata, natapci, natadisk and natapicd have seen testing on real hardware so far. nataraid, natausb and natacam are probably not compilable yet, I need to clean those up.

Hello, world!

Quick-fix some mdoc errors.

I'll do a more thorough run over it within the next few days.

Move the committer manpage (outlining the rules for committers) from man8
to man7.

Add a manual page outlining the rules for committers.