drivers/net/ethernet/sfc/filter.h

   1 /****************************************************************************
   2  * Driver for Solarflare Solarstorm network controllers and boards
   3  * Copyright 2005-2010 Solarflare Communications Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 as published
   7  * by the Free Software Foundation, incorporated herein by reference.
   8  */
   9
  10 #ifndef EFX_FILTER_H
  11 #define EFX_FILTER_H
  12
  13 #include <linux/types.h>
  14
  15 /**
  16  * enum efx_filter_type - type of hardware filter
  17  * @EFX_FILTER_TCP_FULL: Matching TCP/IPv4 4-tuple
  18  * @EFX_FILTER_TCP_WILD: Matching TCP/IPv4 destination (host, port)
  19  * @EFX_FILTER_UDP_FULL: Matching UDP/IPv4 4-tuple
  20  * @EFX_FILTER_UDP_WILD: Matching UDP/IPv4 destination (host, port)
  21  * @EFX_FILTER_MAC_FULL: Matching Ethernet destination MAC address, VID
  22  * @EFX_FILTER_MAC_WILD: Matching Ethernet destination MAC address
  23  * @EFX_FILTER_UC_DEF: Matching all otherwise unmatched unicast
  24  * @EFX_FILTER_MC_DEF: Matching all otherwise unmatched multicast
  25  * @EFX_FILTER_UNSPEC: Match type is unspecified
  26  *
  27  * Falcon NICs only support the TCP/IPv4 and UDP/IPv4 filter types.
  28  */
  29 enum efx_filter_type {
  30         EFX_FILTER_TCP_FULL = 0,
  31         EFX_FILTER_TCP_WILD,
  32         EFX_FILTER_UDP_FULL,
  33         EFX_FILTER_UDP_WILD,
  34         EFX_FILTER_MAC_FULL = 4,
  35         EFX_FILTER_MAC_WILD,
  36         EFX_FILTER_UC_DEF = 8,
  37         EFX_FILTER_MC_DEF,
  38         EFX_FILTER_TYPE_COUNT,          /* number of specific types */
  39         EFX_FILTER_UNSPEC = 0xf,
  40 };
  41
  42 /**
  43  * enum efx_filter_priority - priority of a hardware filter specification
  44  * @EFX_FILTER_PRI_HINT: Performance hint
  45  * @EFX_FILTER_PRI_MANUAL: Manually configured filter
  46  * @EFX_FILTER_PRI_REQUIRED: Required for correct behaviour (user-level
  47  *      networking and SR-IOV)
  48  */
  49 enum efx_filter_priority {
  50         EFX_FILTER_PRI_HINT = 0,
  51         EFX_FILTER_PRI_MANUAL,
  52         EFX_FILTER_PRI_REQUIRED,
  53 };
  54
  55 /**
  56  * enum efx_filter_flags - flags for hardware filter specifications
  57  * @EFX_FILTER_FLAG_RX_RSS: Use RSS to spread across multiple queues.
  58  *      By default, matching packets will be delivered only to the
  59  *      specified queue. If this flag is set, they will be delivered
  60  *      to a range of queues offset from the specified queue number
  61  *      according to the indirection table.
  62  * @EFX_FILTER_FLAG_RX_SCATTER: Enable DMA scatter on the receiving
  63  *      queue.
  64  * @EFX_FILTER_FLAG_RX_OVERRIDE_IP: Enables a MAC filter to override
  65  *      any IP filter that matches the same packet.  By default, IP
  66  *      filters take precedence.
  67  * @EFX_FILTER_FLAG_RX: Filter is for RX
  68  * @EFX_FILTER_FLAG_TX: Filter is for TX
  69  */
  70 enum efx_filter_flags {
  71         EFX_FILTER_FLAG_RX_RSS = 0x01,
  72         EFX_FILTER_FLAG_RX_SCATTER = 0x02,
  73         EFX_FILTER_FLAG_RX_OVERRIDE_IP = 0x04,
  74         EFX_FILTER_FLAG_RX = 0x08,
  75         EFX_FILTER_FLAG_TX = 0x10,
  76 };
  77
  78 /**
  79  * struct efx_filter_spec - specification for a hardware filter
  80  * @type: Type of match to be performed, from &enum efx_filter_type
  81  * @priority: Priority of the filter, from &enum efx_filter_priority
  82  * @flags: Miscellaneous flags, from &enum efx_filter_flags
  83  * @dmaq_id: Source/target queue index
  84  * @data: Match data (type-dependent)
  85  *
  86  * Use the efx_filter_set_*() functions to initialise the @type and
  87  * @data fields.
  88  *
  89  * The @priority field is used by software to determine whether a new
  90  * filter may replace an old one.  The hardware priority of a filter
  91  * depends on the filter type and %EFX_FILTER_FLAG_RX_OVERRIDE_IP
  92  * flag.
  93  */
  94 struct efx_filter_spec {
  95         u8      type:4;
  96         u8      priority:4;
  97         u8      flags;
  98         u16     dmaq_id;
  99         u32     data[3];
 100 };
 101
 102 static inline void efx_filter_init_rx(struct efx_filter_spec *spec,
 103                                       enum efx_filter_priority priority,
 104                                       enum efx_filter_flags flags,
 105                                       unsigned rxq_id)
 106 {
 107         spec->type = EFX_FILTER_UNSPEC;
 108         spec->priority = priority;
 109         spec->flags = EFX_FILTER_FLAG_RX | flags;
 110         spec->dmaq_id = rxq_id;
 111 }
 112
 113 static inline void efx_filter_init_tx(struct efx_filter_spec *spec,
 114                                       unsigned txq_id)
 115 {
 116         spec->type = EFX_FILTER_UNSPEC;
 117         spec->priority = EFX_FILTER_PRI_REQUIRED;
 118         spec->flags = EFX_FILTER_FLAG_TX;
 119         spec->dmaq_id = txq_id;
 120 }
 121
 122 extern int efx_filter_set_ipv4_local(struct efx_filter_spec *spec, u8 proto,
 123                                      __be32 host, __be16 port);
 124 extern int efx_filter_get_ipv4_local(const struct efx_filter_spec *spec,
 125                                      u8 *proto, __be32 *host, __be16 *port);
 126 extern int efx_filter_set_ipv4_full(struct efx_filter_spec *spec, u8 proto,
 127                                     __be32 host, __be16 port,
 128                                     __be32 rhost, __be16 rport);
 129 extern int efx_filter_get_ipv4_full(const struct efx_filter_spec *spec,
 130                                     u8 *proto, __be32 *host, __be16 *port,
 131                                     __be32 *rhost, __be16 *rport);
 132 extern int efx_filter_set_eth_local(struct efx_filter_spec *spec,
 133                                     u16 vid, const u8 *addr);
 134 extern int efx_filter_get_eth_local(const struct efx_filter_spec *spec,
 135                                     u16 *vid, u8 *addr);
 136 extern int efx_filter_set_uc_def(struct efx_filter_spec *spec);
 137 extern int efx_filter_set_mc_def(struct efx_filter_spec *spec);
 138 enum {
 139         EFX_FILTER_VID_UNSPEC = 0xffff,
 140 };
 141
 142 #endif /* EFX_FILTER_H */