lib/librte_pmd_enic/vnic/wq_enet_desc.h

   1 /*
   2  * Copyright 2008-2010 Cisco Systems, Inc.  All rights reserved.
   3  * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
   4  *
   5  * Copyright (c) 2014, Cisco Systems, Inc.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  * notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  * notice, this list of conditions and the following disclaimer in
  17  * the documentation and/or other materials provided with the
  18  * distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34 #ident "$Id: wq_enet_desc.h 59839 2010-09-27 20:36:31Z roprabhu $"
  35
  36 #ifndef _WQ_ENET_DESC_H_
  37 #define _WQ_ENET_DESC_H_
  38
  39 /* Ethernet work queue descriptor: 16B */
  40 struct wq_enet_desc {
  41         __le64 address;
  42         __le16 length;
  43         __le16 mss_loopback;
  44         __le16 header_length_flags;
  45         __le16 vlan_tag;
  46 };
  47
  48 #define WQ_ENET_ADDR_BITS               64
  49 #define WQ_ENET_LEN_BITS                14
  50 #define WQ_ENET_LEN_MASK                ((1 << WQ_ENET_LEN_BITS) - 1)
  51 #define WQ_ENET_MSS_BITS                14
  52 #define WQ_ENET_MSS_MASK                ((1 << WQ_ENET_MSS_BITS) - 1)
  53 #define WQ_ENET_MSS_SHIFT               2
  54 #define WQ_ENET_LOOPBACK_SHIFT          1
  55 #define WQ_ENET_HDRLEN_BITS             10
  56 #define WQ_ENET_HDRLEN_MASK             ((1 << WQ_ENET_HDRLEN_BITS) - 1)
  57 #define WQ_ENET_FLAGS_OM_BITS           2
  58 #define WQ_ENET_FLAGS_OM_MASK           ((1 << WQ_ENET_FLAGS_OM_BITS) - 1)
  59 #define WQ_ENET_FLAGS_EOP_SHIFT         12
  60 #define WQ_ENET_FLAGS_CQ_ENTRY_SHIFT    13
  61 #define WQ_ENET_FLAGS_FCOE_ENCAP_SHIFT  14
  62 #define WQ_ENET_FLAGS_VLAN_TAG_INSERT_SHIFT     15
  63
  64 #define WQ_ENET_OFFLOAD_MODE_CSUM       0
  65 #define WQ_ENET_OFFLOAD_MODE_RESERVED   1
  66 #define WQ_ENET_OFFLOAD_MODE_CSUM_L4    2
  67 #define WQ_ENET_OFFLOAD_MODE_TSO        3
  68
  69 static inline void wq_enet_desc_enc(struct wq_enet_desc *desc,
  70         u64 address, u16 length, u16 mss, u16 header_length,
  71         u8 offload_mode, u8 eop, u8 cq_entry, u8 fcoe_encap,
  72         u8 vlan_tag_insert, u16 vlan_tag, u8 loopback)
  73 {
  74         desc->address = cpu_to_le64(address);
  75         desc->length = cpu_to_le16(length & WQ_ENET_LEN_MASK);
  76         desc->mss_loopback = cpu_to_le16((mss & WQ_ENET_MSS_MASK) <<
  77                 WQ_ENET_MSS_SHIFT | (loopback & 1) << WQ_ENET_LOOPBACK_SHIFT);
  78         desc->header_length_flags = cpu_to_le16(
  79                 (header_length & WQ_ENET_HDRLEN_MASK) |
  80                 (offload_mode & WQ_ENET_FLAGS_OM_MASK) << WQ_ENET_HDRLEN_BITS |
  81                 (eop & 1) << WQ_ENET_FLAGS_EOP_SHIFT |
  82                 (cq_entry & 1) << WQ_ENET_FLAGS_CQ_ENTRY_SHIFT |
  83                 (fcoe_encap & 1) << WQ_ENET_FLAGS_FCOE_ENCAP_SHIFT |
  84                 (vlan_tag_insert & 1) << WQ_ENET_FLAGS_VLAN_TAG_INSERT_SHIFT);
  85         desc->vlan_tag = cpu_to_le16(vlan_tag);
  86 }
  87
  88 static inline void wq_enet_desc_dec(struct wq_enet_desc *desc,
  89         u64 *address, u16 *length, u16 *mss, u16 *header_length,
  90         u8 *offload_mode, u8 *eop, u8 *cq_entry, u8 *fcoe_encap,
  91         u8 *vlan_tag_insert, u16 *vlan_tag, u8 *loopback)
  92 {
  93         *address = le64_to_cpu(desc->address);
  94         *length = le16_to_cpu(desc->length) & WQ_ENET_LEN_MASK;
  95         *mss = (le16_to_cpu(desc->mss_loopback) >> WQ_ENET_MSS_SHIFT) &
  96                 WQ_ENET_MSS_MASK;
  97         *loopback = (u8)((le16_to_cpu(desc->mss_loopback) >>
  98                 WQ_ENET_LOOPBACK_SHIFT) & 1);
  99         *header_length = le16_to_cpu(desc->header_length_flags) &
 100                 WQ_ENET_HDRLEN_MASK;
 101         *offload_mode = (u8)((le16_to_cpu(desc->header_length_flags) >>
 102                 WQ_ENET_HDRLEN_BITS) & WQ_ENET_FLAGS_OM_MASK);
 103         *eop = (u8)((le16_to_cpu(desc->header_length_flags) >>
 104                 WQ_ENET_FLAGS_EOP_SHIFT) & 1);
 105         *cq_entry = (u8)((le16_to_cpu(desc->header_length_flags) >>
 106                 WQ_ENET_FLAGS_CQ_ENTRY_SHIFT) & 1);
 107         *fcoe_encap = (u8)((le16_to_cpu(desc->header_length_flags) >>
 108                 WQ_ENET_FLAGS_FCOE_ENCAP_SHIFT) & 1);
 109         *vlan_tag_insert = (u8)((le16_to_cpu(desc->header_length_flags) >>
 110                 WQ_ENET_FLAGS_VLAN_TAG_INSERT_SHIFT) & 1);
 111         *vlan_tag = le16_to_cpu(desc->vlan_tag);
 112 }
 113
 114 #endif /* _WQ_ENET_DESC_H_ */