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
  47  */
  48 enum efx_filter_priority {
  49         EFX_FILTER_PRI_HINT = 0,
  50         EFX_FILTER_PRI_MANUAL,
  51         EFX_FILTER_PRI_REQUIRED,
  52 };
  53
  54 /**
  55  * enum efx_filter_flags - flags for hardware filter specifications
  56  * @EFX_FILTER_FLAG_RX_RSS: Use RSS to spread across multiple queues.
  57  *      By default, matching packets will be delivered only to the
  58  *      specified queue. If this flag is set, they will be delivered
  59  *      to a range of queues offset from the specified queue number
  60  *      according to the indirection table.
  61  * @EFX_FILTER_FLAG_RX_SCATTER: Enable DMA scatter on the receiving
  62  *      queue.
  63  * @EFX_FILTER_FLAG_RX_OVERRIDE_IP: Enables a MAC filter to override
  64  *      any IP filter that matches the same packet.  By default, IP
  65  *      filters take precedence.
  66  * @EFX_FILTER_FLAG_RX: Filter is for RX
  67  */
  68 enum efx_filter_flags {
  69         EFX_FILTER_FLAG_RX_RSS = 0x01,
  70         EFX_FILTER_FLAG_RX_SCATTER = 0x02,
  71         EFX_FILTER_FLAG_RX_OVERRIDE_IP = 0x04,
  72         EFX_FILTER_FLAG_RX = 0x08,
  73 };
  74
  75 /**
  76  * struct efx_filter_spec - specification for a hardware filter
  77  * @type: Type of match to be performed, from &enum efx_filter_type
  78  * @priority: Priority of the filter, from &enum efx_filter_priority
  79  * @flags: Miscellaneous flags, from &enum efx_filter_flags
  80  * @dmaq_id: Source/target queue index
  81  * @data: Match data (type-dependent)
  82  *
  83  * Use the efx_filter_set_*() functions to initialise the @type and
  84  * @data fields.
  85  *
  86  * The @priority field is used by software to determine whether a new
  87  * filter may replace an old one.  The hardware priority of a filter
  88  * depends on the filter type and %EFX_FILTER_FLAG_RX_OVERRIDE_IP
  89  * flag.
  90  */
  91 struct efx_filter_spec {
  92         u8      type:4;
  93         u8      priority:4;
  94         u8      flags;
  95         u16     dmaq_id;
  96         u32     data[3];
  97 };
  98
  99 static inline void efx_filter_init_rx(struct efx_filter_spec *spec,
 100                                       enum efx_filter_priority priority,
 101                                       enum efx_filter_flags flags,
 102                                       unsigned rxq_id)
 103 {
 104         spec->type = EFX_FILTER_UNSPEC;
 105         spec->priority = priority;
 106         spec->flags = EFX_FILTER_FLAG_RX | flags;
 107         spec->dmaq_id = rxq_id;
 108 }
 109
 110 extern int efx_filter_set_ipv4_local(struct efx_filter_spec *spec, u8 proto,
 111                                      __be32 host, __be16 port);
 112 extern int efx_filter_get_ipv4_local(const struct efx_filter_spec *spec,
 113                                      u8 *proto, __be32 *host, __be16 *port);
 114 extern int efx_filter_set_ipv4_full(struct efx_filter_spec *spec, u8 proto,
 115                                     __be32 host, __be16 port,
 116                                     __be32 rhost, __be16 rport);
 117 extern int efx_filter_get_ipv4_full(const struct efx_filter_spec *spec,
 118                                     u8 *proto, __be32 *host, __be16 *port,
 119                                     __be32 *rhost, __be16 *rport);
 120 extern int efx_filter_set_eth_local(struct efx_filter_spec *spec,
 121                                     u16 vid, const u8 *addr);
 122 extern int efx_filter_get_eth_local(const struct efx_filter_spec *spec,
 123                                     u16 *vid, u8 *addr);
 124 extern int efx_filter_set_uc_def(struct efx_filter_spec *spec);
 125 extern int efx_filter_set_mc_def(struct efx_filter_spec *spec);
 126 enum {
 127         EFX_FILTER_VID_UNSPEC = 0xffff,
 128 };
 129
 130 #endif /* EFX_FILTER_H */