/*
 * This file is part of the Chelsio T4 PCI-E SR-IOV Virtual Function Ethernet
 * driver for Linux.
 *
 * Copyright (c) 2009-2010 Chelsio Communications, Inc. All rights reserved.
 *
 * 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
 * OpenIB.org 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.
 */

#ifndef __T4VF_COMMON_H__
#define __T4VF_COMMON_H__

#include "../cxgb4/t4_hw.h"
#include "../cxgb4/t4fw_api.h"

#define CHELSIO_CHIP_CODE(version, revision) (((version) << 4) | (revision))
#define CHELSIO_CHIP_VERSION(code) (((code) >> 4) & 0xf)
#define CHELSIO_CHIP_RELEASE(code) ((code) & 0xf)

/* All T4 and later chips have their PCI-E Device IDs encoded as 0xVFPP where:
 *
 *   V  = "4" for T4; "5" for T5, etc. or
 *      = "a" for T4 FPGA; "b" for T4 FPGA, etc.
 *   F  = "0" for PF 0..3; "4".."7" for PF4..7; and "8" for VFs
 *   PP = adapter product designation
 */
#define CHELSIO_T4  0x4
#define CHELSIO_T5  0x5
#define CHELSIO_T6  0x6

enum chip_type {
 T4_A1 = CHELSIO_CHIP_CODE(CHELSIO_T4, 1),
 T4_A2 = CHELSIO_CHIP_CODE(CHELSIO_T4, 2),
 T4_FIRST_REV = T4_A1,
 T4_LAST_REV = T4_A2,

 T5_A0 = CHELSIO_CHIP_CODE(CHELSIO_T5, 0),
 T5_A1 = CHELSIO_CHIP_CODE(CHELSIO_T5, 1),
 T5_FIRST_REV = T5_A0,
 T5_LAST_REV = T5_A1,
};

/*
 * The "len16" field of a Firmware Command Structure ...
 */
#define FW_LEN16(fw_struct) FW_CMD_LEN16_V(sizeof(fw_struct) / 16)

/*
 * Per-VF statistics.
 */
struct t4vf_port_stats {
 /*
  * TX statistics.
 */
 u64 tx_bcast_bytes;  /* broadcast */
 u64 tx_bcast_frames;
 u64 tx_mcast_bytes;  /* multicast */
 u64 tx_mcast_frames;
 u64 tx_ucast_bytes;  /* unicast */
 u64 tx_ucast_frames;
 u64 tx_drop_frames;  /* TX dropped frames */
 u64 tx_offload_bytes;  /* offload */
 u64 tx_offload_frames;

 /*
  * RX statistics.
 */
 u64 rx_bcast_bytes;  /* broadcast */
 u64 rx_bcast_frames;
 u64 rx_mcast_bytes;  /* multicast */
 u64 rx_mcast_frames;
 u64 rx_ucast_bytes;
 u64 rx_ucast_frames;  /* unicast */

 u64 rx_err_frames;  /* RX error frames */
};

/*
 * Per-"port" (Virtual Interface) link configuration ...
 */
typedef u16 fw_port_cap16_t;    /* 16-bit Port Capabilities integral value */
typedef u32 fw_port_cap32_t;    /* 32-bit Port Capabilities integral value */

enum fw_caps {
 FW_CAPS_UNKNOWN = 0, /* 0'ed out initial state */
 FW_CAPS16 = 1, /* old Firmware: 16-bit Port Capabilities */
 FW_CAPS32 = 2, /* new Firmware: 32-bit Port Capabilities */
};

enum cc_pause {
 PAUSE_RX = 1 << 0,
 PAUSE_TX = 1 << 1,
 PAUSE_AUTONEG = 1 << 2
};

enum cc_fec {
 FEC_AUTO = 1 << 0, /* IEEE 802.3 "automatic" */
 FEC_RS  = 1 << 1, /* Reed-Solomon */
 FEC_BASER_RS = 1 << 2, /* BaseR/Reed-Solomon */
};

struct link_config {
 fw_port_cap32_t pcaps;  /* link capabilities */
 fw_port_cap32_t acaps;  /* advertised capabilities */
 fw_port_cap32_t lpacaps; /* peer advertised capabilities */

 fw_port_cap32_t speed_caps; /* speed(s) user has requested */
 u32  speed;  /* actual link speed */

 enum cc_pause requested_fc; /* flow control user has requested */
 enum cc_pause fc;  /* actual link flow control */
 enum cc_pause   advertised_fc;  /* actual advertised flow control */

 enum cc_fec auto_fec; /* Forward Error Correction: */
 enum cc_fec requested_fec; /*   "automatic" (IEEE 802.3), */
 enum cc_fec fec;  /*   requested, and actual in use */

 unsigned char autoneg; /* autonegotiating? */

 unsigned char link_ok; /* link up? */
 unsigned char link_down_rc; /* link down reason */
};

/* Return true if the Link Configuration supports "High Speeds" (those greater
 * than 1Gb/s).
 */
static inline bool is_x_10g_port(const struct link_config *lc)
{
 fw_port_cap32_t speeds, high_speeds;

 speeds = FW_PORT_CAP32_SPEED_V(FW_PORT_CAP32_SPEED_G(lc->pcaps));
 high_speeds =
  speeds & ~(FW_PORT_CAP32_SPEED_100M | FW_PORT_CAP32_SPEED_1G);

 return high_speeds != 0;
}

/*
 * General device parameters ...
 */
struct dev_params {
 u32 fwrev;   /* firmware version */
 u32 tprev;   /* TP Microcode Version */
};

/*
 * Scatter Gather Engine parameters.  These are almost all determined by the
 * Physical Function Driver.  We just need to grab them to see within which
 * environment we're playing ...
 */
struct sge_params {
 u32 sge_control;  /* padding, boundaries, lengths, etc. */
 u32 sge_control2;  /* T5: more of the same */
 u32 sge_host_page_size;  /* PF0-7 page sizes */
 u32 sge_egress_queues_per_page; /* PF0-7 egress queues/page */
 u32 sge_ingress_queues_per_page;/* PF0-7 ingress queues/page */
 u32 sge_vf_hps;                 /* host page size for our vf */
 u32 sge_vf_eq_qpp;  /* egress queues/page for our VF */
 u32 sge_vf_iq_qpp;  /* ingress queues/page for our VF */
 u32 sge_fl_buffer_size[16]; /* free list buffer sizes */
 u32 sge_ingress_rx_threshold; /* RX counter interrupt threshold[4] */
 u32 sge_congestion_control;     /* congestion thresholds, etc. */
 u32 sge_timer_value_0_and_1; /* interrupt coalescing timer values */
 u32 sge_timer_value_2_and_3;
 u32 sge_timer_value_4_and_5;
};

/*
 * Vital Product Data parameters.
 */
struct vpd_params {
 u32 cclk;   /* Core Clock (KHz) */
};

/* Stores chip specific parameters */
struct arch_specific_params {
 u32 sge_fl_db;
 u16 mps_tcam_size;
};

/*
 * Global Receive Side Scaling (RSS) parameters in host-native format.
 */
struct rss_params {
 unsigned int mode;  /* RSS mode */
 union {
     struct {
  unsigned int synmapen:1; /* SYN Map Enable */
  unsigned int syn4tupenipv6:1; /* enable hashing 4-tuple IPv6 SYNs */
  unsigned int syn2tupenipv6:1; /* enable hashing 2-tuple IPv6 SYNs */
  unsigned int syn4tupenipv4:1; /* enable hashing 4-tuple IPv4 SYNs */
  unsigned int syn2tupenipv4:1; /* enable hashing 2-tuple IPv4 SYNs */
  unsigned int ofdmapen:1; /* Offload Map Enable */
  unsigned int tnlmapen:1; /* Tunnel Map Enable */
  unsigned int tnlalllookup:1; /* Tunnel All Lookup */
  unsigned int hashtoeplitz:1; /* use Toeplitz hash */
     } basicvirtual;
 } u;
};

/*
 * Virtual Interface RSS Configuration in host-native format.
 */
union rss_vi_config {
    struct {
 u16 defaultq;   /* Ingress Queue ID for !tnlalllookup */
 unsigned int ip6fourtupen:1; /* hash 4-tuple IPv6 ingress packets */
 unsigned int ip6twotupen:1; /* hash 2-tuple IPv6 ingress packets */
 unsigned int ip4fourtupen:1; /* hash 4-tuple IPv4 ingress packets */
 unsigned int ip4twotupen:1; /* hash 2-tuple IPv4 ingress packets */
 int udpen;   /* hash 4-tuple UDP ingress packets */
    } basicvirtual;
};

/*
 * Maximum resources provisioned for a PCI VF.
 */
struct vf_resources {
 unsigned int nvi;  /* N virtual interfaces */
 unsigned int neq;  /* N egress Qs */
 unsigned int nethctrl;  /* N egress ETH or CTRL Qs */
 unsigned int niqflint;  /* N ingress Qs/w free list(s) & intr */
 unsigned int niq;  /* N ingress Qs */
 unsigned int tc;  /* PCI-E traffic class */
 unsigned int pmask;  /* port access rights mask */
 unsigned int nexactf;  /* N exact MPS filters */
 unsigned int r_caps;  /* read capabilities */
 unsigned int wx_caps;  /* write/execute capabilities */
};

/*
 * Per-"adapter" (Virtual Function) parameters.
 */
struct adapter_params {
 struct dev_params dev;  /* general device parameters */
 struct sge_params sge;  /* Scatter Gather Engine */
 struct vpd_params vpd;  /* Vital Product Data */
 struct rss_params rss;  /* Receive Side Scaling */
 struct vf_resources vfres; /* Virtual Function Resource limits */
 struct arch_specific_params arch; /* chip specific params */
 enum chip_type chip;  /* chip code */
 u8 nports;   /* # of Ethernet "ports" */
 u8 fw_caps_support;  /* 32-bit Port Capabilities */
};

/* Firmware Mailbox Command/Reply log.  All values are in Host-Endian format.
 * The access and execute times are signed in order to accommodate negative
 * error returns.
 */
struct mbox_cmd {
 u64 cmd[MBOX_LEN / 8];  /* a Firmware Mailbox Command/Reply */
 u64 timestamp;   /* OS-dependent timestamp */
 u32 seqno;   /* sequence number */
 s16 access;   /* time (ms) to access mailbox */
 s16 execute;   /* time (ms) to execute */
};

struct mbox_cmd_log {
 unsigned int size;  /* number of entries in the log */
 unsigned int cursor;  /* next position in the log to write */
 u32 seqno;   /* next sequence number */
 /* variable length mailbox command log starts here */
};

/* Given a pointer to a Firmware Mailbox Command Log and a log entry index,
 * return a pointer to the specified entry.
 */
static inline struct mbox_cmd *mbox_cmd_log_entry(struct mbox_cmd_log *log,
        unsigned int entry_idx)
{
 return &((struct mbox_cmd *)&(log)[1])[entry_idx];
}

#include "adapter.h"

#ifndef PCI_VENDOR_ID_CHELSIO
# define PCI_VENDOR_ID_CHELSIO 0x1425
#endif

#define for_each_port(adapter, iter) \
 for (iter = 0; iter < (adapter)->params.nports; iter++)

static inline unsigned int core_ticks_per_usec(const struct adapter *adapter)
{
 return adapter->params.vpd.cclk / 1000;
}

static inline unsigned int us_to_core_ticks(const struct adapter *adapter,
         unsigned int us)
{
 return (us * adapter->params.vpd.cclk) / 1000;
}

static inline unsigned int core_ticks_to_us(const struct adapter *adapter,
         unsigned int ticks)
{
 return (ticks * 1000) / adapter->params.vpd.cclk;
}

int t4vf_wr_mbox_core(struct adapter *, const void *, int, void *, bool);

static inline int t4vf_wr_mbox(struct adapter *adapter, const void *cmd,
          int size, void *rpl)
{
 return t4vf_wr_mbox_core(adapter, cmd, size, rpl, true);
}

static inline int t4vf_wr_mbox_ns(struct adapter *adapter, const void *cmd,
      int size, void *rpl)
{
 return t4vf_wr_mbox_core(adapter, cmd, size, rpl, false);
}

#define CHELSIO_PCI_ID_VER(dev_id)  ((dev_id) >> 12)

static inline int is_t4(enum chip_type chip)
{
 return CHELSIO_CHIP_VERSION(chip) == CHELSIO_T4;
}

/**
 * hash_mac_addr - return the hash value of a MAC address
 * @addr: the 48-bit Ethernet MAC address
 *
 * Hashes a MAC address according to the hash function used by hardware
 * inexact (hash) address matching.
 */
static inline int hash_mac_addr(const u8 *addr)
{
 u32 a = ((u32)addr[0] << 16) | ((u32)addr[1] << 8) | addr[2];
 u32 b = ((u32)addr[3] << 16) | ((u32)addr[4] << 8) | addr[5];

 a ^= b;
 a ^= (a >> 12);
 a ^= (a >> 6);
 return a & 0x3f;
}

int t4vf_wait_dev_ready(struct adapter *);
int t4vf_port_init(struct adapter *, int);

int t4vf_fw_reset(struct adapter *);
int t4vf_set_params(struct adapter *, unsigned int, const u32 *, const u32 *);

int t4vf_fl_pkt_align(struct adapter *adapter);
enum t4_bar2_qtype { T4_BAR2_QTYPE_EGRESS, T4_BAR2_QTYPE_INGRESS };
int t4vf_bar2_sge_qregs(struct adapter *adapter,
   unsigned int qid,
   enum t4_bar2_qtype qtype,
   u64 *pbar2_qoffset,
   unsigned int *pbar2_qid);

unsigned int t4vf_get_pf_from_vf(struct adapter *);
int t4vf_get_sge_params(struct adapter *);
int t4vf_get_vpd_params(struct adapter *);
int t4vf_get_dev_params(struct adapter *);
int t4vf_get_rss_glb_config(struct adapter *);
int t4vf_get_vfres(struct adapter *);

int t4vf_read_rss_vi_config(struct adapter *, unsigned int,
       union rss_vi_config *);
int t4vf_write_rss_vi_config(struct adapter *, unsigned int,
        union rss_vi_config *);
int t4vf_config_rss_range(struct adapter *, unsigned int, int, int,
     const u16 *, int);

int t4vf_alloc_vi(struct adapter *, int);
int t4vf_free_vi(struct adapter *, int);
int t4vf_enable_vi(struct adapter *adapter, unsigned int viid, bool rx_en,
     bool tx_en);
int t4vf_enable_pi(struct adapter *adapter, struct port_info *pi, bool rx_en,
     bool tx_en);
int t4vf_identify_port(struct adapter *, unsigned int, unsigned int);

int t4vf_set_rxmode(struct adapter *, unsigned int, int, int, int, int, int,
      bool);
int t4vf_alloc_mac_filt(struct adapter *, unsigned int, bool, unsigned int,
   const u8 **, u16 *, u64 *, bool);
int t4vf_free_mac_filt(struct adapter *, unsigned int, unsigned int naddr,
         const u8 **, bool);
int t4vf_change_mac(struct adapter *, unsigned int, int, const u8 *, bool);
int t4vf_set_addr_hash(struct adapter *, unsigned int, bool, u64, bool);
int t4vf_get_port_stats(struct adapter *, int, struct t4vf_port_stats *);

int t4vf_iq_free(struct adapter *, unsigned int, unsigned int, unsigned int,
   unsigned int);
int t4vf_eth_eq_free(struct adapter *, unsigned int);

int t4vf_update_port_info(struct port_info *pi);
int t4vf_handle_fw_rpl(struct adapter *, const __be64 *);
int t4vf_prep_adapter(struct adapter *);
int t4vf_get_vf_mac_acl(struct adapter *adapter, unsigned int port,
   unsigned int *naddr, u8 *addr);
int t4vf_get_vf_vlan_acl(struct adapter *adapter);

#endif /* __T4VF_COMMON_H__ */