freebsd-dev/tools/kerneldoc/subsys
Eric Joyner 71d104536b ice(4): Introduce new driver for Intel E800 Ethernet controllers
The ice(4) driver is the driver for the Intel E8xx series Ethernet
controllers; currently with codenames Columbiaville and
Columbia Park.

These new controllers support 100G speeds, as well as introducing
more queues, better virtualization support, and more offload
capabilities. Future work will enable virtual functions (like
in ixl(4)) and the other functionality outlined above.

For full functionality, the kernel should be compiled with
"device ice_ddp" like in the amd64 NOTES file, and/or
ice_ddp_load="YES" should be added to /boot/loader.conf so that
the DDP package file included in this commit can be downloaded
to the adapter. Otherwise, the adapter will fall back to a single
queue mode with limited functionality.

A man page for this driver will be forthcoming.

MFC after:	1 month
Relnotes:	yes
Sponsored by:	Intel Corporation
Differential Revision:	https://reviews.freebsd.org/D21959
2020-05-26 23:35:10 +00:00
..
common-Doxyfile Remove deprecated options. 2020-03-26 09:23:16 +00:00
Dependencies
Doxyfile-cam
Doxyfile-crypto
Doxyfile-dev_aac
Doxyfile-dev_aacraid Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_acpi_support
Doxyfile-dev_acpica
Doxyfile-dev_adb
Doxyfile-dev_adlink
Doxyfile-dev_ae
Doxyfile-dev_age
Doxyfile-dev_agp
Doxyfile-dev_ahci
Doxyfile-dev_aic7xxx
Doxyfile-dev_al_eth Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_alc
Doxyfile-dev_ale
Doxyfile-dev_alpm Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_altera Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_amd_ecc_inject Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_amdgpio Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_amdpm Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_amdsbwd
Doxyfile-dev_amdsmb Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_amdsmn Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_amdtemp
Doxyfile-dev_amr
Doxyfile-dev_an
Doxyfile-dev_arcmsr
Doxyfile-dev_asmc
Doxyfile-dev_ata
Doxyfile-dev_ath
Doxyfile-dev_atkbdc
Doxyfile-dev_auxio
Doxyfile-dev_axgbe Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_bce
Doxyfile-dev_beri Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_bfe
Doxyfile-dev_bge
Doxyfile-dev_bhnd Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_bktr
Doxyfile-dev_bm
Doxyfile-dev_bnxt Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_bvm Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_bwi
Doxyfile-dev_bwn
Doxyfile-dev_bxe
Doxyfile-dev_cadence Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_cardbus
Doxyfile-dev_cas
Doxyfile-dev_ce
Doxyfile-dev_cesa
Doxyfile-dev_cfe
Doxyfile-dev_cfi
Doxyfile-dev_chromebook_platform Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_ciss
Doxyfile-dev_cmx
Doxyfile-dev_coretemp
Doxyfile-dev_cp
Doxyfile-dev_cpuctl
Doxyfile-dev_cpufreq
Doxyfile-dev_cs
Doxyfile-dev_ctau
Doxyfile-dev_cx
Doxyfile-dev_cxgb
Doxyfile-dev_cxgbe
Doxyfile-dev_cy
Doxyfile-dev_cyapa Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_dc
Doxyfile-dev_dcons
Doxyfile-dev_de
Doxyfile-dev_dme Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_dpaa Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_dpms
Doxyfile-dev_dwc Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_e1000
Doxyfile-dev_ed
Doxyfile-dev_efidev Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_ena Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_ep
Doxyfile-dev_esp
Doxyfile-dev_et
Doxyfile-dev_etherswitch Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_evdev Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_ex
Doxyfile-dev_exca
Doxyfile-dev_extres Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_fb
Doxyfile-dev_fdc
Doxyfile-dev_fdt
Doxyfile-dev_fe
Doxyfile-dev_ffec Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_filemon Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_firewire
Doxyfile-dev_flash
Doxyfile-dev_fxp
Doxyfile-dev_gem
Doxyfile-dev_glxiic
Doxyfile-dev_glxsb
Doxyfile-dev_gpio
Doxyfile-dev_gxemul Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_hdmi Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_hifn
Doxyfile-dev_hme
Doxyfile-dev_hpt27xx
Doxyfile-dev_hptiop
Doxyfile-dev_hptmv
Doxyfile-dev_hptnr Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_hptrr
Doxyfile-dev_hwpmc
Doxyfile-dev_hyperv Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_ic
Doxyfile-dev_ice ice(4): Introduce new driver for Intel E800 Ethernet controllers 2020-05-26 23:35:10 +00:00
Doxyfile-dev_ichiic Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_ichsmb
Doxyfile-dev_ichwd
Doxyfile-dev_ida
Doxyfile-dev_if_ndis
Doxyfile-dev_iicbus
Doxyfile-dev_iir
Doxyfile-dev_imcsmb Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_intel Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_intpm Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_io
Doxyfile-dev_ioat Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_ipmi
Doxyfile-dev_ips
Doxyfile-dev_ipw
Doxyfile-dev_isci Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_iscsi
Doxyfile-dev_iscsi_initiator Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_iser Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_isl Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_ismt Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_isp
Doxyfile-dev_ispfw
Doxyfile-dev_iwi
Doxyfile-dev_iwm Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_iwn
Doxyfile-dev_ixgbe
Doxyfile-dev_ixl Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_jedec_dimm Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_jme
Doxyfile-dev_kbd
Doxyfile-dev_kbdmux
Doxyfile-dev_ksyms
Doxyfile-dev_le
Doxyfile-dev_led
Doxyfile-dev_lge
Doxyfile-dev_liquidio Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_malo
Doxyfile-dev_mbox Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_mc146818
Doxyfile-dev_md
Doxyfile-dev_mdio Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_mem
Doxyfile-dev_mfi
Doxyfile-dev_mge
Doxyfile-dev_mii
Doxyfile-dev_mk48txx
Doxyfile-dev_mlx
Doxyfile-dev_mlx4 Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_mlx5 Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_mly
Doxyfile-dev_mmc
Doxyfile-dev_mmcnull Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_mn
Doxyfile-dev_mpr Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_mps
Doxyfile-dev_mpt
Doxyfile-dev_mrsas Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_msk
Doxyfile-dev_mthca Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_mvs
Doxyfile-dev_mwl
Doxyfile-dev_mxge
Doxyfile-dev_my
Doxyfile-dev_nand Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_nctgpio Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_neta Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_netfpga10g Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_netmap
Doxyfile-dev_nfe
Doxyfile-dev_nfsmb Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_nge
Doxyfile-dev_nmdm
Doxyfile-dev_ntb Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_null
Doxyfile-dev_nvd Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_nvdimm Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_nvme Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_nvram
Doxyfile-dev_nvram2env
Doxyfile-dev_oce Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_ocs_fc Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_ofw
Doxyfile-dev_otus Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_ow Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_pbio
Doxyfile-dev_pccard
Doxyfile-dev_pccbb
Doxyfile-dev_pcf
Doxyfile-dev_pci
Doxyfile-dev_pcn
Doxyfile-dev_pms Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_powermac_nvram
Doxyfile-dev_ppbus
Doxyfile-dev_ppc
Doxyfile-dev_proto Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_psci Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_pst
Doxyfile-dev_pty
Doxyfile-dev_puc
Doxyfile-dev_pwm Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_qlnx Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_qlxgb
Doxyfile-dev_qlxgbe Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_qlxge Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_quicc
Doxyfile-dev_ral
Doxyfile-dev_random
Doxyfile-dev_rc
Doxyfile-dev_rccgpio Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_re
Doxyfile-dev_rl Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_rndtest
Doxyfile-dev_rp
Doxyfile-dev_rt
Doxyfile-dev_rtwn Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_safe
Doxyfile-dev_sbni
Doxyfile-dev_scc
Doxyfile-dev_sdhci
Doxyfile-dev_sec
Doxyfile-dev_sf
Doxyfile-dev_sfxge
Doxyfile-dev_sge
Doxyfile-dev_siis
Doxyfile-dev_sio
Doxyfile-dev_sis
Doxyfile-dev_sk
Doxyfile-dev_smartpqi Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_smbus
Doxyfile-dev_smc
Doxyfile-dev_sn
Doxyfile-dev_snp
Doxyfile-dev_sound
Doxyfile-dev_speaker
Doxyfile-dev_spibus
Doxyfile-dev_ste
Doxyfile-dev_stge
Doxyfile-dev_sym
Doxyfile-dev_syscons
Doxyfile-dev_tcp_log Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_tdfx
Doxyfile-dev_terasic Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_ti
Doxyfile-dev_tl
Doxyfile-dev_tpm
Doxyfile-dev_trm
Doxyfile-dev_tsec
Doxyfile-dev_twa
Doxyfile-dev_twe
Doxyfile-dev_tws
Doxyfile-dev_tx
Doxyfile-dev_txp
Doxyfile-dev_uart
Doxyfile-dev_usb
Doxyfile-dev_veriexec Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_vge
Doxyfile-dev_viapm Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_viawd
Doxyfile-dev_videomode Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_virtio
Doxyfile-dev_vkbd
Doxyfile-dev_vmware Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_vnic Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_vr
Doxyfile-dev_vt Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_vte
Doxyfile-dev_vx
Doxyfile-dev_watchdog
Doxyfile-dev_wb
Doxyfile-dev_wbwd Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_wi
Doxyfile-dev_wpi
Doxyfile-dev_wtap
Doxyfile-dev_xdma Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_xe
Doxyfile-dev_xen
Doxyfile-dev_xilinx Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Doxyfile-dev_xl
Doxyfile-geom
Doxyfile-kern
Doxyfile-libkern
Doxyfile-linux
Doxyfile-net80211
Doxyfile-netgraph
Doxyfile-netinet
Doxyfile-netinet6
Doxyfile-netipsec
Doxyfile-opencrypto
Doxyfile-vm
Doxyfile-xen Catch up with some years of driver development. 2019-01-26 18:23:19 +00:00
Makefile Fix duplicate target warning. 2020-02-11 19:39:59 +00:00
notreviewed.dox
README

       The kernel subsystem API documentation generation framework.
      --------------------------------------------------------------

For every Doxyfile-(.*) the Makefile adds the public targets $1, pdf-$1 and
clean-$1. For e.g. Doxyfile-dev_pci this translates to the targets dev_pci,
pdf-dev_pci and clean-dev_pci.

Additionally, the targets 'all', 'pdf-all' and 'clean' to generate or remove
the documentation for all targets are available.

The file 'Dependencies' contains dependencies for the .tag files.

To add another part to the documentation just copy a Doxyfile and add
the necessary dependencies to the file 'Dependencies'.

The following environment variables can be used in the Doxyfile:
 - DOXYGEN_SRC_PATH		(/usr/src/sys)
 - DOXYGEN_DEST_PATH		(where the docs are generated)
 - DOXYGEN_TARGET_ARCH		(${TARGET_ARCH} if set, else ${MACHINE_ARCH})

For the PDF generation you may have to change some limits in the latex
configuration (the build may fail and an error about e.g. "pool size" is
shown), for print/teTeX this is done in
	/usr/local/share/texmf/web2c/texmf.cnf

Programs needed to generate the API docs:
 - devel/doxygen
 - print/teTeX
 - graphics/graphviz

-- 
$FreeBSD$