target/linux/generic/files/crypto/ocf/kirkwood/mvHal/common/mv802_3.h

   1 /*******************************************************************************
   2 Copyright (C) Marvell International Ltd. and its affiliates
   3
   4 This software file (the "File") is owned and distributed by Marvell
   5 International Ltd. and/or its affiliates ("Marvell") under the following
   6 alternative licensing terms.  Once you have made an election to distribute the
   7 File under one of the following license alternatives, please (i) delete this
   8 introductory statement regarding license alternatives, (ii) delete the two
   9 license alternatives that you have not elected to use and (iii) preserve the
  10 Marvell copyright notice above.
  11
  12 ********************************************************************************
  13 Marvell Commercial License Option
  14
  15 If you received this File from Marvell and you have entered into a commercial
  16 license agreement (a "Commercial License") with Marvell, the File is licensed
  17 to you under the terms of the applicable Commercial License.
  18
  19 ********************************************************************************
  20 Marvell GPL License Option
  21
  22 If you received this File from Marvell, you may opt to use, redistribute and/or
  23 modify this File in accordance with the terms and conditions of the General
  24 Public License Version 2, June 1991 (the "GPL License"), a copy of which is
  25 available along with the File in the license.txt file or by writing to the Free
  26 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 or
  27 on the worldwide web at http://www.gnu.org/licenses/gpl.txt.
  28
  29 THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE IMPLIED
  30 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY
  31 DISCLAIMED.  The GPL License provides additional details about this warranty
  32 disclaimer.
  33 ********************************************************************************
  34 Marvell BSD License Option
  35
  36 If you received this File from Marvell, you may opt to use, redistribute and/or
  37 modify this File under the following licensing terms.
  38 Redistribution and use in source and binary forms, with or without modification,
  39 are permitted provided that the following conditions are met:
  40
  41     *   Redistributions of source code must retain the above copyright notice,
  42             this list of conditions and the following disclaimer.
  43
  44     *   Redistributions in binary form must reproduce the above copyright
  45         notice, this list of conditions and the following disclaimer in the
  46         documentation and/or other materials provided with the distribution.
  47
  48     *   Neither the name of Marvell nor the names of its contributors may be
  49         used to endorse or promote products derived from this software without
  50         specific prior written permission.
  51
  52 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  53 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  54 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  55 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  56 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  57 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  58 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  59 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  60 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  61 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  62
  63 *******************************************************************************/
  64
  65
  66 #ifndef __INCmv802_3h
  67 #define __INCmv802_3h
  68
  69
  70 /* includes */
  71 #include "mvTypes.h"
  72
  73 /* Defines */
  74 #define MV_MAX_ETH_DATA     1500
  75
  76 /* 802.3 types */
  77 #define MV_IP_TYPE                  0x0800
  78 #define MV_IP_ARP_TYPE              0x0806
  79 #define MV_APPLE_TALK_ARP_TYPE      0x80F3
  80 #define MV_NOVELL_IPX_TYPE          0x8137
  81 #define MV_EAPOL_TYPE                           0x888e
  82
  83
  84
  85 /* Encapsulation header for RFC1042 and Ethernet_tunnel */
  86
  87 #define MV_RFC1042_SNAP_HEADER     {0xAA, 0xAA, 0x03, 0x00, 0x00, 0x00}
  88
  89 #define MV_ETH_SNAP_LSB             0xF8
  90
  91
  92 #define MV_MAC_ADDR_SIZE        (6)
  93 #define MV_MAC_STR_SIZE         (20)
  94 #define MV_VLAN_HLEN            (4)
  95
  96 /* This macro checks for a multicast mac address    */
  97 #define MV_IS_MULTICAST_MAC(mac)  (((mac)[0] & 0x1) == 1)
  98
  99
 100 /* This macro checks for an broadcast mac address     */
 101 #define MV_IS_BROADCAST_MAC(mac)            \
 102        (((mac)[0] == 0xFF) &&       \
 103         ((mac)[1] == 0xFF) &&       \
 104         ((mac)[2] == 0xFF) &&       \
 105         ((mac)[3] == 0xFF) &&       \
 106         ((mac)[4] == 0xFF) &&       \
 107         ((mac)[5] == 0xFF))
 108
 109
 110 /* Typedefs */
 111 typedef struct
 112 {
 113     MV_U8     pDA[MV_MAC_ADDR_SIZE];
 114     MV_U8     pSA[MV_MAC_ADDR_SIZE];
 115     MV_U16    typeOrLen;
 116
 117 } MV_802_3_HEADER;
 118
 119 enum {
 120   MV_IP_PROTO_NULL      = 0,    /* Dummy protocol for TCP               */
 121   MV_IP_PROTO_ICMP      = 1,    /* Internet Control Message Protocol    */
 122   MV_IP_PROTO_IGMP      = 2,    /* Internet Group Management Protocol   */
 123   MV_IP_PROTO_IPIP      = 4,    /* IPIP tunnels (older KA9Q tunnels use 94) */
 124   MV_IP_PROTO_TCP       = 6,    /* Transmission Control Protocol        */
 125   MV_IP_PROTO_EGP       = 8,    /* Exterior Gateway Protocol            */
 126   MV_IP_PROTO_PUP       = 12,   /* PUP protocol                         */
 127   MV_IP_PROTO_UDP       = 17,   /* User Datagram Protocol               */
 128   MV_IP_PROTO_IDP       = 22,   /* XNS IDP protocol                     */
 129   MV_IP_PROTO_DCCP      = 33,   /* Datagram Congestion Control Protocol */
 130   MV_IP_PROTO_IPV6      = 41,   /* IPv6-in-IPv4 tunnelling              */
 131   MV_IP_PROTO_RSVP      = 46,   /* RSVP protocol                        */
 132   MV_IP_PROTO_GRE       = 47,   /* Cisco GRE tunnels (rfc 1701,1702)    */
 133   MV_IP_PROTO_ESP       = 50,   /* Encapsulation Security Payload protocol */
 134   MV_IP_PROTO_AH        = 51,   /* Authentication Header protocol       */
 135   MV_IP_PROTO_BEETPH    = 94,   /* IP option pseudo header for BEET     */
 136   MV_IP_PROTO_PIM       = 103,
 137   MV_IP_PROTO_COMP      = 108,  /* Compression Header protocol          */
 138   MV_IP_PROTO_ZERO_HOP  = 114,  /* Any 0 hop protocol (IANA)            */
 139   MV_IP_PROTO_SCTP      = 132,  /* Stream Control Transport Protocol    */
 140   MV_IP_PROTO_UDPLITE   = 136,  /* UDP-Lite (RFC 3828)                  */
 141
 142   MV_IP_PROTO_RAW       = 255,  /* Raw IP packets                       */
 143   MV_IP_PROTO_MAX
 144 };
 145
 146 typedef struct
 147 {
 148     MV_U8   version;
 149     MV_U8   tos;
 150     MV_U16  totalLength;
 151     MV_U16  identifier;
 152     MV_U16  fragmentCtrl;
 153     MV_U8   ttl;
 154     MV_U8   protocol;
 155     MV_U16  checksum;
 156     MV_U32  srcIP;
 157     MV_U32  dstIP;
 158
 159 } MV_IP_HEADER;
 160
 161 typedef struct
 162 {
 163     MV_U32 spi;
 164     MV_U32 seqNum;
 165 } MV_ESP_HEADER;
 166
 167 #define MV_ICMP_ECHOREPLY          0       /* Echo Reply                   */
 168 #define MV_ICMP_DEST_UNREACH       3       /* Destination Unreachable      */
 169 #define MV_ICMP_SOURCE_QUENCH      4       /* Source Quench                */
 170 #define MV_ICMP_REDIRECT           5       /* Redirect (change route)      */
 171 #define MV_ICMP_ECHO               8       /* Echo Request                 */
 172 #define MV_ICMP_TIME_EXCEEDED      11      /* Time Exceeded                */
 173 #define MV_ICMP_PARAMETERPROB      12      /* Parameter Problem            */
 174 #define MV_ICMP_TIMESTAMP          13      /* Timestamp Request            */
 175 #define MV_ICMP_TIMESTAMPREPLY     14      /* Timestamp Reply              */
 176 #define MV_ICMP_INFO_REQUEST       15      /* Information Request          */
 177 #define MV_ICMP_INFO_REPLY         16      /* Information Reply            */
 178 #define MV_ICMP_ADDRESS            17      /* Address Mask Request         */
 179 #define MV_ICMP_ADDRESSREPLY       18      /* Address Mask Reply           */
 180
 181 typedef struct
 182 {
 183     MV_U8   type;
 184     MV_U8   code;
 185     MV_U16  checksum;
 186     MV_U16  id;
 187     MV_U16  sequence;
 188
 189 } MV_ICMP_ECHO_HEADER;
 190
 191 typedef struct
 192 {
 193     MV_U16  source;
 194     MV_U16  dest;
 195     MV_U32  seq;
 196     MV_U32  ack_seq;
 197     MV_U16  flags;
 198     MV_U16  window;
 199     MV_U16  chksum;
 200     MV_U16  urg_offset;
 201
 202 } MV_TCP_HEADER;
 203
 204 typedef struct
 205 {
 206     MV_U16  source;
 207     MV_U16  dest;
 208     MV_U16  len;
 209     MV_U16  check;
 210
 211 } MV_UDP_HEADER;
 212
 213 #endif /* __INCmv802_3h */