/*
 * aQuantia Corporation Network Driver
 * Copyright (C) 2017 aQuantia Corporation. All rights reserved
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 */

#ifndef _ATL_HW_H_
#define _ATL_HW_H_
#include <linux/pci.h>
#include <linux/if_ether.h>

#include "atl_regs.h"
#include "atl_fw.h"

#define PCI_VENDOR_ID_AQUANTIA 0x1d6a

/* clock is 3.2 ns*/
#define ATL_HW_CLOCK_TO_US(clk)  (clk * 32 / 10000)

#define busy_wait(tries, wait, lvalue, fetch, cond)	\
({							\
	uint32_t _dummy = 0;				\
	int i = (tries);				\
	int orig = i;					\
	(void)_dummy;					\
	do {						\
		wait;					\
		(lvalue) = (fetch);			\
	} while ((cond) && --i);			\
	(orig - i);					\
})

enum atl_board {
	ATL_UNKNOWN,
	ATL_AQC107,
	ATL_AQC108,
	ATL_AQC109,
	ATL_AQC100,
};

struct atl_hw {
	uint8_t __iomem *regs;
	struct pci_dev *pdev;
	struct atl_link_state link_state;
	struct {
		uint32_t fw_rev;
		bool poll_link;
		struct atl_fw_ops *ops;
		uint32_t fw_stat_addr;
		struct mutex lock;
	} mcp;
	uint32_t intr_mask;
	uint8_t mac_addr[ETH_ALEN];
#define ATL_RSS_KEY_SIZE 40
	uint8_t rss_key[ATL_RSS_KEY_SIZE];
#define ATL_RSS_TBL_SIZE (1 << 6)
	uint8_t rss_tbl[ATL_RSS_TBL_SIZE];
};

union atl_desc;
struct atl_hw_ring {
	union atl_desc *descs;
	uint32_t size;
	uint32_t reg_base;
	dma_addr_t daddr;
};

#define offset_ptr(ptr, ring, amount)					\
	({								\
		uint32_t size = ((struct atl_hw_ring *)(ring))->size;	\
									\
		uint32_t res = (ptr) + (amount);			\
		if ((int32_t)res < 0)					\
			res += size;					\
		else if (res >= size)					\
			res -= size;					\
		res;							\
	})

void atl_check_unplug(struct atl_hw *hw, uint32_t addr);

static inline uint32_t atl_read(struct atl_hw *hw, uint32_t addr)
{
	uint8_t __iomem *base = READ_ONCE(hw->regs);
	uint32_t val = 0xffffffff;

	if (unlikely(!base))
		return val;

	val = readl(base + addr);
	if (unlikely(val == 0xffffffff))
		atl_check_unplug(hw, addr);
	return val;
}

static inline void atl_write(struct atl_hw *hw, uint32_t addr, uint32_t val)
{
	uint8_t __iomem *base = READ_ONCE(hw->regs);

	if (unlikely(!base))
		return;

	writel(val, base + addr);
}

static inline void atl_write_bits(struct atl_hw *hw, uint32_t addr,
			     uint32_t shift, uint32_t width, uint32_t val)
{
	uint32_t mask = ((1u << width) - 1) << shift;

	atl_write(hw, addr,
		  (atl_read(hw, addr) & ~mask) | ((val << shift) & mask));
}

static inline void atl_write_bit(struct atl_hw *hw, uint32_t addr,
			    uint32_t shift, uint32_t val)
{
	atl_write_bits(hw, addr, shift, 1, val);
}

static inline void atl_set_bits(struct atl_hw *hw, uint32_t addr,
	uint32_t bits)
{
	atl_write(hw, addr, atl_read(hw, addr) | bits);
}

static inline void atl_clear_bits(struct atl_hw *hw, uint32_t addr,
	uint32_t bits)
{
	atl_write(hw, addr, atl_read(hw, addr) & ~bits);
}

static inline void atl_intr_enable(struct atl_hw *hw, uint32_t mask)
{
	atl_write(hw, ATL_INTR_MSK_SET, mask);
}

static inline void atl_intr_disable(struct atl_hw *hw, uint32_t mask)
{
	atl_write(hw, ATL_INTR_MSK_CLEAR, mask);
}

static inline void atl_intr_disable_all(struct atl_hw *hw)
{
	atl_intr_disable(hw, 0xffffffff);
}

static inline unsigned atl_fw_major(struct atl_hw *hw)
{
	return (hw->mcp.fw_rev >> 24) & 0xff;
}

static inline void atl_init_rss_table(struct atl_hw *hw, int nvecs)
{
	int i;

	for (i = 0; i < ATL_RSS_TBL_SIZE; i++)
		hw->rss_tbl[i] = i % nvecs;
}

static inline void atl_set_vlan_promisc(struct atl_hw *hw, int promisc)
{
	atl_write_bit(hw, ATL_RX_VLAN_FLT_CTRL1, 1, !!promisc);
}

int atl_read_mcp_mem(struct atl_hw *hw, uint32_t mcp_addr, void *host_addr,
	unsigned size);
int atl_hwinit(struct atl_nic *nic, enum atl_board brd_id);
void atl_refresh_link(struct atl_nic *nic);
void atl_set_rss_key(struct atl_hw *hw);
void atl_set_rss_tbl(struct atl_hw *hw);
void atl_set_uc_flt(struct atl_hw *hw, int idx, uint8_t mac_addr[ETH_ALEN]);

int atl_alloc_descs(struct atl_nic *nic, struct atl_hw_ring *ring);
void atl_free_descs(struct atl_nic *nic, struct atl_hw_ring *ring);
void atl_set_intr_bits(struct atl_hw *hw, int idx, int rxbit, int txbit);
int atl_alloc_link_intr(struct atl_nic *nic);
void atl_free_link_intr(struct atl_nic *nic);
int atl_write_mcp_mem(struct atl_hw *hw, uint32_t offt, void *addr,
	size_t size);

#endif