| Message ID | 20200618051344.516587-15-jeffrey.t.kirsher@intel.com |
|---|---|
| State | Changes Requested |
| Delegated to: | David Miller |
| Headers | show |
| Series | Intel Wired LAN Driver Updates 2020-06-17 | expand |
On Wed, 17 Jun 2020 22:13:43 -0700 Jeff Kirsher wrote: > From: Alice Michael <alice.michael@intel.com> > > This introduces iecm as a module to the kernel, and adds > relevant documentation. ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:45:17: warning: incorrect type in argument 2 (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:45:17: expected void volatile [noderef] <asn:2> *addr ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:45:17: got unsigned char [usertype] * ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:47:17: warning: incorrect type in argument 2 (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:47:17: expected void volatile [noderef] <asn:2> *addr ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:47:17: got unsigned char [usertype] * ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:54:9: warning: incorrect type in argument 2 (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:54:9: expected void volatile [noderef] <asn:2> *addr ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:54:9: got unsigned char [usertype] * ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:57:9: warning: incorrect type in argument 2 (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:57:9: expected void volatile [noderef] <asn:2> *addr ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:57:9: got unsigned char [usertype] * ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:58:9: warning: incorrect type in argument 2 (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:58:9: expected void volatile [noderef] <asn:2> *addr ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:58:9: got unsigned char [usertype] * ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:59:9: warning: incorrect type in argument 2 (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:59:9: expected void volatile [noderef] <asn:2> *addr ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:59:9: got unsigned char [usertype] * ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:62:15: warning: incorrect type in argument 1 (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:62:15: expected void const volatile [noderef] <asn:2> *addr ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:62:15: got unsigned char [usertype] * ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:321:33: warning: incorrect type in assignment (different base types) ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:321:33: expected restricted __le16 [usertype] pfid_vfid ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:321:33: got unsigned short [usertype] func_id ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:364:9: warning: incorrect type in argument 2 (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:364:9: expected void volatile [noderef] <asn:2> *addr ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:364:9: got unsigned char [usertype] * ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:563:17: warning: incorrect type in argument 2 (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:563:17: expected void volatile [noderef] <asn:2> *addr ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:563:17: got unsigned char [usertype] * ../drivers/net/ethernet/intel/iecm/iecm_lib.c:49:13: warning: symbol 'iecm_mb_intr_clean' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_lib.c:70:9: warning: incorrect type in argument 2 (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_lib.c:70:9: expected void volatile [noderef] <asn:2> *addr ../drivers/net/ethernet/intel/iecm/iecm_lib.c:70:9: got unsigned char [usertype] * ../drivers/net/ethernet/intel/iecm/iecm_lib.c:63:6: warning: symbol 'iecm_mb_irq_enable' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_lib.c:77:5: warning: symbol 'iecm_mb_intr_req_irq' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_lib.c:104:6: warning: symbol 'iecm_get_mb_vec_id' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_lib.c:122:5: warning: symbol 'iecm_mb_intr_init' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_lib.c:140:6: warning: symbol 'iecm_intr_distribute' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_lib.c:299:21: warning: incorrect type in assignment (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_lib.c:299:21: expected unsigned char [usertype] *hw_addr ../drivers/net/ethernet/intel/iecm/iecm_lib.c:299:21: got void [noderef] <asn:2> * ../drivers/net/ethernet/intel/iecm/iecm_lib.c:417:5: warning: symbol 'iecm_vport_rel' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_lib.c:748:6: warning: symbol 'iecm_deinit_task' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:84:6: warning: symbol 'iecm_tx_buf_rel_all' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:115:6: warning: symbol 'iecm_tx_desc_rel' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:136:6: warning: symbol 'iecm_tx_desc_rel_all' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:312:6: warning: symbol 'iecm_rx_buf_rel_all' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:341:6: warning: symbol 'iecm_rx_desc_rel' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:371:6: warning: symbol 'iecm_rx_desc_rel_all' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:486:6: warning: symbol 'iecm_rx_hdr_buf_hw_alloc' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:564:47: warning: incorrect type in assignment (different base types) ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:564:47: expected restricted __le16 [usertype] buf_id ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:564:47: got restricted __le64 [usertype] ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:2072:50: warning: Using plain integer as NULL pointer ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:2319:27: warning: cast to restricted __le32 ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:2319:27: warning: cast from restricted __le16 ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:2852:23: warning: cast to restricted __le16 ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3086:17: warning: incorrect type in argument 2 (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3086:17: expected void volatile [noderef] <asn:2> *addr ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3086:17: got unsigned char [usertype] * ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3414:9: warning: incorrect type in argument 2 (different address spaces) ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3414:9: expected void volatile [noderef] <asn:2> *addr ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3414:9: got unsigned char [usertype] * ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3565:5: warning: symbol 'iecm_vport_splitq_napi_poll' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3603:6: warning: symbol 'iecm_vport_intr_map_vector_to_qs' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3715:5: warning: symbol 'iecm_vport_intr_alloc' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:1702:34: warning: incorrect type in assignment (different base types) ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:1702:34: expected unsigned char [usertype] cmd_dtype ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:1702:34: got restricted __le16 [usertype] ../drivers/net/ethernet/intel/iecm/iecm_virtchnl.c:12:6: warning: symbol 'iecm_recv_event_msg' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_virtchnl.c:61:1: warning: symbol 'iecm_mb_clean' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_main.c:17:5: warning: symbol 'debug' was not declared. Should it be static? ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:144: warning: Function parameter or member 'qinfo' not described in 'iecm_ctlq_add' ../drivers/net/ethernet/intel/iecm/iecm_controlq.c:144: warning: Excess function parameter 'q_info' description in 'iecm_ctlq_add' In file included from ../include/linux/net/intel/iecm.h:50, from ../drivers/net/ethernet/intel/iecm/iecm_osdep.c:5: ../include/linux/net/intel/iecm_txrx.h:293:30: warning: ‘iecm_rx_ptype_lkup’ defined but not used [-Wunused-const-variable=] 293 | struct iecm_rx_ptype_decoded iecm_rx_ptype_lkup[IECM_RX_SUPP_PTYPE] = { | ^~~~~~~~~~~~~~~~~~ In file included from ../include/linux/net/intel/iecm.h:50, from ../drivers/net/ethernet/intel/iecm/iecm_singleq_txrx.c:5: ../include/linux/net/intel/iecm_txrx.h:293:30: warning: ‘iecm_rx_ptype_lkup’ defined but not used [-Wunused-const-variable=] 293 | struct iecm_rx_ptype_decoded iecm_rx_ptype_lkup[IECM_RX_SUPP_PTYPE] = { | ^~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_singleq_txrx.c:584: warning: Function parameter or member 'rx_desc' not described in 'iecm_rx_singleq_process_skb_fields' ../drivers/net/ethernet/intel/iecm/iecm_singleq_txrx.c:584: warning: Function parameter or member 'ptype' not described in 'iecm_rx_singleq_process_skb_fields' ../drivers/net/ethernet/intel/iecm/iecm_singleq_txrx.c:645: warning: bad line: ../drivers/net/ethernet/intel/iecm/iecm_singleq_txrx.c:689: warning: Function parameter or member 'dev' not described in 'iecm_singleq_rx_get_buf_page' ../drivers/net/ethernet/intel/iecm/iecm_lib.c:49:13: warning: no previous prototype for ‘iecm_mb_intr_clean’ [-Wmissing-prototypes] 49 | irqreturn_t iecm_mb_intr_clean(int __always_unused irq, void *data) | ^~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_lib.c:63:6: warning: no previous prototype for ‘iecm_mb_irq_enable’ [-Wmissing-prototypes] 63 | void iecm_mb_irq_enable(struct iecm_adapter *adapter) | ^~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_lib.c:77:5: warning: no previous prototype for ‘iecm_mb_intr_req_irq’ [-Wmissing-prototypes] 77 | int iecm_mb_intr_req_irq(struct iecm_adapter *adapter) | ^~~~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_lib.c:104:6: warning: no previous prototype for ‘iecm_get_mb_vec_id’ [-Wmissing-prototypes] 104 | void iecm_get_mb_vec_id(struct iecm_adapter *adapter) | ^~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_lib.c:122:5: warning: no previous prototype for ‘iecm_mb_intr_init’ [-Wmissing-prototypes] 122 | int iecm_mb_intr_init(struct iecm_adapter *adapter) | ^~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_lib.c:140:6: warning: no previous prototype for ‘iecm_intr_distribute’ [-Wmissing-prototypes] 140 | void iecm_intr_distribute(struct iecm_adapter *adapter) | ^~~~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_lib.c:417:5: warning: no previous prototype for ‘iecm_vport_rel’ [-Wmissing-prototypes] 417 | int iecm_vport_rel(struct iecm_vport *vport) | ^~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_lib.c:748:6: warning: no previous prototype for ‘iecm_deinit_task’ [-Wmissing-prototypes] 748 | void iecm_deinit_task(struct iecm_adapter *adapter) | ^~~~~~~~~~~~~~~~ In file included from ../include/linux/net/intel/iecm.h:50, from ../drivers/net/ethernet/intel/iecm/iecm_lib.c:6: ../include/linux/net/intel/iecm_txrx.h:293:30: warning: ‘iecm_rx_ptype_lkup’ defined but not used [-Wunused-const-variable=] 293 | struct iecm_rx_ptype_decoded iecm_rx_ptype_lkup[IECM_RX_SUPP_PTYPE] = { | ^~~~~~~~~~~~~~~~~~ In file included from ../include/linux/net/intel/iecm.h:50, from ../drivers/net/ethernet/intel/iecm/iecm_ethtool.c:4: ../include/linux/net/intel/iecm_txrx.h:293:30: warning: ‘iecm_rx_ptype_lkup’ defined but not used [-Wunused-const-variable=] 293 | struct iecm_rx_ptype_decoded iecm_rx_ptype_lkup[IECM_RX_SUPP_PTYPE] = { | ^~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_lib.c:490: warning: Function parameter or member 'vport_id' not described in 'iecm_vport_alloc' ../drivers/net/ethernet/intel/iecm/iecm_lib.c:490: warning: Excess function parameter 'vport_type' description in 'iecm_vport_alloc' ../drivers/net/ethernet/intel/iecm/iecm_ethtool.c:80: warning: Function parameter or member 'abs_rx_qid' not described in 'iecm_find_virtual_qid' ../drivers/net/ethernet/intel/iecm/iecm_ethtool.c:1031: warning: Function parameter or member 'cmd' not described in 'iecm_get_link_ksettings' ../drivers/net/ethernet/intel/iecm/iecm_ethtool.c:1031: warning: Excess function parameter 'ecmd' description in 'iecm_get_link_ksettings' In file included from ../include/linux/net/intel/iecm.h:50, from ../drivers/net/ethernet/intel/iecm/iecm_main.c:6: ../include/linux/net/intel/iecm_txrx.h:293:30: warning: ‘iecm_rx_ptype_lkup’ defined but not used [-Wunused-const-variable=] 293 | struct iecm_rx_ptype_decoded iecm_rx_ptype_lkup[IECM_RX_SUPP_PTYPE] = { | ^~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_virtchnl.c:12:6: warning: no previous prototype for ‘iecm_recv_event_msg’ [-Wmissing-prototypes] 12 | void iecm_recv_event_msg(struct iecm_vport *vport) | ^~~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_virtchnl.c:61:1: warning: no previous prototype for ‘iecm_mb_clean’ [-Wmissing-prototypes] 61 | iecm_mb_clean(struct iecm_adapter *adapter) | ^~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_virtchnl.c:1422: warning: Function parameter or member 'vport' not described in 'iecm_send_get_stats_msg' ../drivers/net/ethernet/intel/iecm/iecm_virtchnl.c:1422: warning: Excess function parameter 'adapter' description in 'iecm_send_get_stats_msg' ../drivers/net/ethernet/intel/iecm/iecm_virtchnl.c:1701: warning: Function parameter or member 'hw' not described in 'iecm_find_ctlq' ../drivers/net/ethernet/intel/iecm/iecm_virtchnl.c:1701: warning: Excess function parameter 'adapter' description in 'iecm_find_ctlq' ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:84:6: warning: no previous prototype for ‘iecm_tx_buf_rel_all’ [-Wmissing-prototypes] 84 | void iecm_tx_buf_rel_all(struct iecm_queue *txq) | ^~~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:115:6: warning: no previous prototype for ‘iecm_tx_desc_rel’ [-Wmissing-prototypes] 115 | void iecm_tx_desc_rel(struct iecm_queue *txq, bool bufq) | ^~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:136:6: warning: no previous prototype for ‘iecm_tx_desc_rel_all’ [-Wmissing-prototypes] 136 | void iecm_tx_desc_rel_all(struct iecm_vport *vport) | ^~~~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:312:6: warning: no previous prototype for ‘iecm_rx_buf_rel_all’ [-Wmissing-prototypes] 312 | void iecm_rx_buf_rel_all(struct iecm_queue *rxq) | ^~~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:341:6: warning: no previous prototype for ‘iecm_rx_desc_rel’ [-Wmissing-prototypes] 341 | void iecm_rx_desc_rel(struct iecm_queue *rxq, bool bufq, | ^~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:371:6: warning: no previous prototype for ‘iecm_rx_desc_rel_all’ [-Wmissing-prototypes] 371 | void iecm_rx_desc_rel_all(struct iecm_vport *vport) | ^~~~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:486:6: warning: no previous prototype for ‘iecm_rx_hdr_buf_hw_alloc’ [-Wmissing-prototypes] 486 | bool iecm_rx_hdr_buf_hw_alloc(struct iecm_queue *rxq, | ^~~~~~~~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3565:5: warning: no previous prototype for ‘iecm_vport_splitq_napi_poll’ [-Wmissing-prototypes] 3565 | int iecm_vport_splitq_napi_poll(struct napi_struct *napi, int budget) | ^~~~~~~~~~~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3603:6: warning: no previous prototype for ‘iecm_vport_intr_map_vector_to_qs’ [-Wmissing-prototypes] 3603 | void iecm_vport_intr_map_vector_to_qs(struct iecm_vport *vport) | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3715:5: warning: no previous prototype for ‘iecm_vport_intr_alloc’ [-Wmissing-prototypes] 3715 | int iecm_vport_intr_alloc(struct iecm_vport *vport) | ^~~~~~~~~~~~~~~~~~~~~ In file included from ../include/linux/net/intel/iecm.h:50, from ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:4: ../include/linux/net/intel/iecm_txrx.h:293:30: warning: ‘iecm_rx_ptype_lkup’ defined but not used [-Wunused-const-variable=] 293 | struct iecm_rx_ptype_decoded iecm_rx_ptype_lkup[IECM_RX_SUPP_PTYPE] = { | ^~~~~~~~~~~~~~~~~~ ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:2593: warning: Function parameter or member 'dev' not described in 'iecm_rx_get_buf_page' ../drivers/net/ethernet/intel/iecm/iecm_txrx.c:3841: warning: Function parameter or member 'qid_list' not described in 'iecm_get_rx_qid_list'
diff --git a/Documentation/networking/device_drivers/intel/iecm.rst b/Documentation/networking/device_drivers/intel/iecm.rst new file mode 100644 index 000000000000..5634e3e65c74 --- /dev/null +++ b/Documentation/networking/device_drivers/intel/iecm.rst @@ -0,0 +1,93 @@ +.. SPDX-License-Identifier: GPL-2.0 + +======================== +Intel Ethernet Common Module +======================== + +The Intel Ethernet Common Module is meant to serve as an abstraction layer +between device specific implementation details and common net device driver +flows. This library provides several function hooks which allow a device driver +to specify register addresses, control queue communications, and other device +specific functionality. Some functions are required to be implemented while +others have a default implementation that is used when none is supplied by the +device driver. Doing this, a device driver can be written to take advantage +of existing code while also giving the flexibility to implement device specific +features. + +The common use case for this library is for a network device driver that wants +specify its own device specific details but also leverage the more common +code flows found in network device drivers. + +Sections in this document: + Entry Point + Exit Point + Register Operations API + Virtchnl Operations API + +Entry Point +~~~~~~~~~~~ +The primary entry point to the library is the iecm_probe function. Prior to +calling this, device drivers must have allocated an iecm_adapter struct and +initialized it with the required API functions. The adapter struct, along with +the pci_dev struct and the pci_device_id struct, is provided to iecm_probe +which finalizes device initialization and prepares the device for open. + +The iecm_dev_ops struct within the iecm_adapter struct is the primary vehicle +for passing information from device drivers to the common module. A dependent +module must define and assign a reg_ops_init function which will assign the +respective function pointers to initialize register values (see iecm_reg_ops +struct). These are required to be provided by the dependent device driver as +no suitable default can be assumed for register addresses. + +The vc_ops_init function pointer and the related iecm_virtchnl_ops struct are +optional and should only be necessary for device drivers which use a different +method/timing for communicating across a mailbox to the hardware. Within iecm +is a default interface provided in the case where one is not provided by the +device driver. + +Exit Point +~~~~~~~~~~ +When the device driver is being prepared to be removed through the pci_driver +remove callback, it is required for the device driver to call iecm_remove with +the pci_dev struct provided. This is required to ensure all resources are +properly freed and returned to the operating system. + +Register Operations API +~~~~~~~~~~~~~~~~~~~~~~~ +iecm_reg_ops contains three different function pointers relating to initializing +registers for the specific net device using the library. + +ctlq_reg_init relates specifically to setting up registers related to control +queue/mailbox communications. Registers that should be defined include: head, +tail, len, bah, bal, len_mask, len_ena_mask, and head_mask. + +vportq_reg_init relates to setting up queue registers. The tail registers to +be assigned to the iecm_queue struct for each RX/TX queue. + +intr_reg_init relates to any registers needed to setup interrupts. These +include registers needed to enable the interrupt and change ITR settings. + +If the initialization function finds that one or more required function +pointers were not provided, an error will be issued and the device will be +inoperable. + + +Virtchnl Operations API +~~~~~~~~~~~~~~~~~~~~~~~ +The virtchnl is a conduit between driver and hardware that allows device +drivers to send and receive control messages to/from hardware. This is +optional to be specified as there is a general interface that can be assumed +when using this library. However, if a device deviates in some way to +communicate across the mailbox correctly, this interface is provided to allow +that. + +If vc_ops_init is set in the dev_ops field of the iecm_adapter struct, then it +is assumed the device driver is using providing it's own interface to do +virtchnl communications. While providing vc_ops_init is optional, if it is +provided, it is required that the device driver provide function pointers for +those functions in vc_ops, with exception for the enable_vport, disable_vport, +and destroy_vport functions which may not be required for all devices. + +If the initialization function finds that vc_ops_init was defined but one or +more required function pointers were not provided, an error will be issued and +the device will be inoperable. diff --git a/MAINTAINERS b/MAINTAINERS index 301330e02bca..102ee1e4aef0 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -8654,6 +8654,7 @@ F: Documentation/networking/device_drivers/intel/fm10k.rst F: Documentation/networking/device_drivers/intel/i40e.rst F: Documentation/networking/device_drivers/intel/iavf.rst F: Documentation/networking/device_drivers/intel/ice.rst +F: Documentation/networking/device_drivers/intel/iecm.rst F: Documentation/networking/device_drivers/intel/igb.rst F: Documentation/networking/device_drivers/intel/igbvf.rst F: Documentation/networking/device_drivers/intel/ixgb.rst @@ -8662,6 +8663,7 @@ F: Documentation/networking/device_drivers/intel/ixgbevf.rst F: drivers/net/ethernet/intel/ F: drivers/net/ethernet/intel/*/ F: include/linux/avf/virtchnl.h +F: include/linux/net/intel/ INTEL FRAMEBUFFER DRIVER (excluding 810 and 815) M: Maik Broemme <mbroemme@libmpq.org> diff --git a/drivers/net/ethernet/intel/Kconfig b/drivers/net/ethernet/intel/Kconfig index 48a8f9aa1dd0..6dd985cbdb6d 100644 --- a/drivers/net/ethernet/intel/Kconfig +++ b/drivers/net/ethernet/intel/Kconfig @@ -342,4 +342,11 @@ config IGC To compile this driver as a module, choose M here. The module will be called igc. +config IECM + tristate "Intel(R) Ethernet Common Module Support" + default n + depends on PCI + help + To compile this driver as a module, choose M here. The module + will be called iecm. MSI-X interrupt support is required endif # NET_VENDOR_INTEL diff --git a/drivers/net/ethernet/intel/Makefile b/drivers/net/ethernet/intel/Makefile index 3075290063f6..c9eba9cc5087 100644 --- a/drivers/net/ethernet/intel/Makefile +++ b/drivers/net/ethernet/intel/Makefile @@ -16,3 +16,4 @@ obj-$(CONFIG_IXGB) += ixgb/ obj-$(CONFIG_IAVF) += iavf/ obj-$(CONFIG_FM10K) += fm10k/ obj-$(CONFIG_ICE) += ice/ +obj-$(CONFIG_IECM) += iecm/ diff --git a/drivers/net/ethernet/intel/iecm/Makefile b/drivers/net/ethernet/intel/iecm/Makefile new file mode 100644 index 000000000000..61c814013582 --- /dev/null +++ b/drivers/net/ethernet/intel/iecm/Makefile @@ -0,0 +1,19 @@ +# SPDX-License-Identifier: GPL-2.0-only +# Copyright (C) 2020 Intel Corporation + +# +# Makefile for the Intel(R) Ethernet Common Module +# + +obj-$(CONFIG_IECM) += iecm.o + +iecm-y := \ + iecm_lib.o \ + iecm_virtchnl.o \ + iecm_txrx.o \ + iecm_singleq_txrx.o \ + iecm_ethtool.o \ + iecm_controlq.o \ + iecm_osdep.o \ + iecm_controlq_setup.o \ + iecm_main.o