Commit c4f084ed authored by David S. Miller's avatar David S. Miller
Browse files

Merge branch 'Update-license-and-polish-ENA-driver-code' 



Shay Agroskin says:

====================
Update license and polish ENA driver code

This series adds the following:
- Change driver's license into SPDX format
- Capitalize all log prints in ENA driver
- Fix issues raised by static checkers
- Improve code readability by adding functions, fix spelling
  mistakes etc.
- Update driver's documentation

Changed from previous version:
v1->v2: dropped patch that transforms pr_* log prints into dev_* prints
====================

Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parents b696db59 c452f375

Documentation/networking/device_drivers/ethernet/amazon/ena.rst

+3 −22
Original line number Diff line number Diff line
@@ -39,16 +39,6 @@ debug logs. 
Some of the ENA devices support a working mode called Low-latency

Queue (LLQ), which saves several more microseconds.



Supported PCI vendor ID/device IDs

==================================



=========   =======================

1d0f:0ec2   ENA PF

1d0f:1ec2   ENA PF with LLQ support

1d0f:ec20   ENA VF

1d0f:ec21   ENA VF with LLQ support

=========   =======================



ENA Source Code Directory Structure

===================================
@@ -212,20 +202,11 @@ In adaptive interrupt moderation mode the interrupt delay value is 
updated by the driver dynamically and adjusted every NAPI cycle

according to the traffic nature.



By default ENA driver applies adaptive coalescing on Rx traffic and

conventional coalescing on Tx traffic.



Adaptive coalescing can be switched on/off through ethtool(8)

adaptive_rx on|off parameter.



The driver chooses interrupt delay value according to the number of

bytes and packets received between interrupt unmasking and interrupt

posting. The driver uses interrupt delay table that subdivides the

range of received bytes/packets into 5 levels and assigns interrupt

delay value to each level.



The user can enable/disable adaptive moderation, modify the interrupt

delay table and restore its default values through sysfs.

More information about Adaptive Interrupt Moderation (DIM) can be found in

Documentation/networking/net_dim.rst



RX copybreak

============
@@ -274,7 +255,7 @@ RSS 
  inputs for hash functions.

- The driver configures RSS settings using the AQ SetFeature command

  (ENA_ADMIN_RSS_HASH_FUNCTION, ENA_ADMIN_RSS_HASH_INPUT and

  ENA_ADMIN_RSS_REDIRECTION_TABLE_CONFIG properties).

  ENA_ADMIN_RSS_INDIRECTION_TABLE_CONFIG properties).

- If the NETIF_F_RXHASH flag is set, the 32-bit result of the hash

  function delivered in the Rx CQ descriptor is set in the received

  SKB.

drivers/net/ethernet/amazon/ena/ena_admin_defs.h

+33 −58
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */

/*

 * Copyright 2015 - 2016 Amazon.com, Inc. or its affiliates.

 *

 * This software is available to you under a choice of one of two

 * licenses.  You may choose to be licensed under the terms of the GNU

 * General Public License (GPL) Version 2, available from the file

 * COPYING in the main directory of this source tree, or the

 * BSD license below:

 *

 *     Redistribution and use in source and binary forms, with or

 *     without modification, are permitted provided that the following

 *     conditions are met:

 *

 *      - Redistributions of source code must retain the above

 *        copyright notice, this list of conditions and the following

 *        disclaimer.

 *

 *      - 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.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS

 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

 * SOFTWARE.

 * Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All rights reserved.

 */

#ifndef _ENA_ADMIN_H_

#define _ENA_ADMIN_H_



#define ENA_ADMIN_RSS_KEY_PARTS              10



enum ena_admin_aq_opcode {

	ENA_ADMIN_CREATE_SQ                         = 1,
@@ -55,6 +29,7 @@ enum ena_admin_aq_completion_status { 
	ENA_ADMIN_RESOURCE_BUSY                     = 7,

};



/* subcommands for the set/get feature admin commands */

enum ena_admin_aq_feature_id {

	ENA_ADMIN_DEVICE_ATTRIBUTES                 = 1,

	ENA_ADMIN_MAX_QUEUES_NUM                    = 2,
@@ -63,7 +38,7 @@ enum ena_admin_aq_feature_id { 
	ENA_ADMIN_MAX_QUEUES_EXT                    = 7,

	ENA_ADMIN_RSS_HASH_FUNCTION                 = 10,

	ENA_ADMIN_STATELESS_OFFLOAD_CONFIG          = 11,

	ENA_ADMIN_RSS_REDIRECTION_TABLE_CONFIG      = 12,

	ENA_ADMIN_RSS_INDIRECTION_TABLE_CONFIG      = 12,

	ENA_ADMIN_MTU                               = 14,

	ENA_ADMIN_RSS_HASH_INPUT                    = 18,

	ENA_ADMIN_INTERRUPT_MODERATION              = 20,
@@ -240,8 +215,8 @@ struct ena_admin_aq_create_sq_cmd { 
	 */

	u8 sq_caps_3;



	/* associated completion queue id. This CQ must be created prior to

	 *    SQ creation

	/* associated completion queue id. This CQ must be created prior to SQ

	 * creation

	 */

	u16 cq_idx;
@@ -475,7 +450,9 @@ struct ena_admin_device_attr_feature_desc { 


	u32 device_version;



	/* bitmap of ena_admin_aq_feature_id */

	/* bitmap of ena_admin_aq_feature_id, which represents supported

	 * subcommands for the set/get feature admin commands.

	 */

	u32 supported_features;



	u32 reserved3;
@@ -561,32 +538,30 @@ struct ena_admin_feature_llq_desc { 


	u32 max_llq_depth;



	/*  specify the header locations the device supports. bitfield of

	 *    enum ena_admin_llq_header_location.

	/* specify the header locations the device supports. bitfield of enum

	 * ena_admin_llq_header_location.

	 */

	u16 header_location_ctrl_supported;



	/* the header location the driver selected to use. */

	u16 header_location_ctrl_enabled;



	/* if inline header is specified - this is the size of descriptor

	 *    list entry. If header in a separate ring is specified - this is

	 *    the size of header ring entry. bitfield of enum

	 *    ena_admin_llq_ring_entry_size. specify the entry sizes the device

	 *    supports

	/* if inline header is specified - this is the size of descriptor list

	 * entry. If header in a separate ring is specified - this is the size

	 * of header ring entry. bitfield of enum ena_admin_llq_ring_entry_size.

	 * specify the entry sizes the device supports

	 */

	u16 entry_size_ctrl_supported;



	/* the entry size the driver selected to use. */

	u16 entry_size_ctrl_enabled;



	/* valid only if inline header is specified. First entry associated

	 *    with the packet includes descriptors and header. Rest of the

	 *    entries occupied by descriptors. This parameter defines the max

	 *    number of descriptors precedding the header in the first entry.

	 *    The field is bitfield of enum

	 *    ena_admin_llq_num_descs_before_header and specify the values the

	 *    device supports

	/* valid only if inline header is specified. First entry associated with

	 * the packet includes descriptors and header. Rest of the entries

	 * occupied by descriptors. This parameter defines the max number of

	 * descriptors precedding the header in the first entry. The field is

	 * bitfield of enum ena_admin_llq_num_descs_before_header and specify

	 * the values the device supports

	 */

	u16 desc_num_before_header_supported;
@@ -629,8 +604,8 @@ struct ena_admin_queue_ext_feature_fields { 


	u32 max_tx_header_size;



	/* Maximum Descriptors number, including meta descriptor, allowed for

	 * a single Tx packet

	/* Maximum Descriptors number, including meta descriptor, allowed for a

	 * single Tx packet

	 */

	u16 max_per_packet_tx_descs;
@@ -653,8 +628,8 @@ struct ena_admin_queue_feature_desc { 


	u32 max_header_size;



	/* Maximum Descriptors number, including meta descriptor, allowed for

	 *    a single Tx packet

	/* Maximum Descriptors number, including meta descriptor, allowed for a

	 * single Tx packet

	 */

	u16 max_packet_tx_descs;
@@ -742,11 +717,11 @@ enum ena_admin_hash_functions { 
};



struct ena_admin_feature_rss_flow_hash_control {

	u32 keys_num;

	u32 key_parts;



	u32 reserved;



	u32 key[10];

	u32 key[ENA_ADMIN_RSS_KEY_PARTS];

};



struct ena_admin_feature_rss_flow_hash_function {
@@ -1042,7 +1017,7 @@ struct ena_admin_set_feat_resp { 
struct ena_admin_aenq_common_desc {

	u16 group;



	u16 syndrom;

	u16 syndrome;



	/* 0 : phase

	 * 7:1 : reserved - MBZ
@@ -1066,7 +1041,7 @@ enum ena_admin_aenq_group { 
	ENA_ADMIN_AENQ_GROUPS_NUM                   = 5,

};



enum ena_admin_aenq_notification_syndrom {

enum ena_admin_aenq_notification_syndrome {

	ENA_ADMIN_SUSPEND                           = 0,

	ENA_ADMIN_RESUME                            = 1,

	ENA_ADMIN_UPDATE_HINTS                      = 2,

drivers/net/ethernet/amazon/ena/ena_com.c

+108 −118

File changed.

Preview size limit exceeded, changes collapsed.

drivers/net/ethernet/amazon/ena/ena_com.h

+3 −30
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */

/*

 * Copyright 2015 Amazon.com, Inc. or its affiliates.

 *

 * This software is available to you under a choice of one of two

 * licenses.  You may choose to be licensed under the terms of the GNU

 * General Public License (GPL) Version 2, available from the file

 * COPYING in the main directory of this source tree, or the

 * BSD license below:

 *

 *     Redistribution and use in source and binary forms, with or

 *     without modification, are permitted provided that the following

 *     conditions are met:

 *

 *      - Redistributions of source code must retain the above

 *        copyright notice, this list of conditions and the following

 *        disclaimer.

 *

 *      - 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.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS

 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

 * SOFTWARE.

 * Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All rights reserved.

 */



#ifndef ENA_COM
@@ -536,7 +509,7 @@ void ena_com_admin_q_comp_intr_handler(struct ena_com_dev *ena_dev); 
 * This method goes over the async event notification queue and calls the proper

 * aenq handler.

 */

void ena_com_aenq_intr_handler(struct ena_com_dev *dev, void *data);

void ena_com_aenq_intr_handler(struct ena_com_dev *ena_dev, void *data);



/* ena_com_abort_admin_commands - Abort all the outstanding admin commands.

 * @ena_dev: ENA communication layer struct

drivers/net/ethernet/amazon/ena/ena_common_defs.h

+2 −29
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */

/*

 * Copyright 2015 - 2016 Amazon.com, Inc. or its affiliates.

 *

 * This software is available to you under a choice of one of two

 * licenses.  You may choose to be licensed under the terms of the GNU

 * General Public License (GPL) Version 2, available from the file

 * COPYING in the main directory of this source tree, or the

 * BSD license below:

 *

 *     Redistribution and use in source and binary forms, with or

 *     without modification, are permitted provided that the following

 *     conditions are met:

 *

 *      - Redistributions of source code must retain the above

 *        copyright notice, this list of conditions and the following

 *        disclaimer.

 *

 *      - 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.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS

 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

 * SOFTWARE.

 * Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All rights reserved.

 */

#ifndef _ENA_COMMON_H_

#define _ENA_COMMON_H_

CRA Git | Maintained and supported by SUSTech CRA and CCSE