/*
 * Copyright (c) 2020 HiSilicon (Shanghai) Technologies CO., LIMITED.
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Description: Hieth ETH operation header file
 */


#ifndef __HIETH_H__
#define __HIETH_H__

#include <config.h>
#include <common.h>
#include <command.h>

#include <linux/list.h>
#include <asm/io.h>

#include <malloc.h> /* malloc, free, realloc */

#include <net.h>
#include <miiphy.h>
#include <asm/arch/platform.h>

#define OSDRV_MODULE_VERSION_STRING "Hisilicon ETH net controler"

#ifndef bit
#define bit(nr) (1UL << (nr))
#endif
#define mdelay(n) udelay((n)*1000)
/* ***********************************************************
 *
 * Global varibles and defintions
 *
 * ***********************************************************
 */

/* configuerable values */

#ifdef HIETH_RX_QUEUE_MULTI_DESC
#define HIETH_HW_DESC_DEPTH 72
#endif

#define ETH_MDIO_FRQDIV 2

/* mdiobus device name, such as platform device name */
#define HIETH_MDIOBUS_NAME "hieth_mdiobus"

/* eth device name, such as platform device name */
#define HIETH_SFV300_NAME     "hieth_sfv300"
#define MAX_PHY_NAME_LEN      16
#define HIETH_MAX_QUEUE_DEPTH 64
#ifdef HIETH_RX_QUEUE_MULTI_DESC
#define HIETH_HW_RXQ_DEPTH 52 /* uboot */
#else
#define HIETH_HW_RXQ_DEPTH 1 /* uboot */
#endif
#define HIETH_HW_TXQ_DEPTH 1 /* uboot */

#define HIETH_MAX_FRAME_SIZE PKTSIZE_ALIGN /* 1536 */

#define HIETH_TRACE_ETH		2
#define HIETH_TRACE_MDIO	4
#define HIETH_TRACE_DRV		7
#define HIETH_TRACE_LEVEL	8

/* Error number */
#define HIETH_E_QUEUE (-1)
#define HIETH_E_BUSY  (-2)
#define HIETH_E_FULL  (-3)
#define HIETH_E_EMPTY (-4)

struct hieth_frame_desc {
	unsigned long frm_addr; /* required by the controler */
	unsigned int frm_len : 11; /* required by the controler */
};

#define hieth_trace_fd(level, fd) hieth_trace(level, \
	#fd "<%p>={ .frm_addr=%08lx, .frm_len=%d}",      \
	&(fd), (fd).frm_addr, (fd).frm_len)

/* port */
#define UP_PORT		0
#define DOWN_PORT	1
#define MAX_PORT	2

enum if_mode {
	INTERFACE_MODE_MII,
	INTERFACE_MODE_RMII
};

struct hieth_netdev_local {
	unsigned long iobase_phys; /* physical io addr */
	int port : 1; /* 0 => up port,    1 => down port */

#ifdef HIETH_RX_QUEUE_MULTI_DESC
	int desc_hw_offset; /* the offset where we feed hw */
	int desc_rec_offset; /* the offset where we receve the package */
	struct hieth_frame_desc *hieth_desc_head;
#endif

	u32 link_stat;
	char *mii_name;
	unsigned char phy_addr;
	enum if_mode phy_intf;

	/* mdio_bus freq-div, 1 for 1/100, 0 for 1/50 */
	u32 mdio_frqdiv;
};

/* ***********************************************************
 *
 * Only for internal used!
 *
 * ***********************************************************
 */

/* read/write IO */

#define _readl(c)     ({ u32 __v = le32_to_cpu(__raw_readl(c)); __v; })
#define _writel(v, c) __raw_writel(cpu_to_le32(v), c)

#define mk_bits(shift, nbits) ((((shift) & 0x1F) << 16) | ((nbits) & 0x1F))

u32 hieth_readl(struct hieth_netdev_local *ld, u32 ofs);
void hieth_writel(struct hieth_netdev_local *ld, u32 v, u32 ofs);
u32 hieth_readl_bits(struct hieth_netdev_local *ld, u32 ofs, u32 bits_desc);
void hieth_writel_bits(struct hieth_netdev_local *ld, u32 v, u32 ofs, u32 bits_desc);

void hieth_trace(int level, const char *fmt, ...);
void hieth_error(const char *fmt, ...);
void hieth_assert(bool cond);

#define local_lock_init(ld)
#define local_lock_exit(ld)
#define local_lock(ld)
#define local_unlock(ld)

#define ud_reg_name(name) ((ld->port == UP_PORT) ? U_##name : D_##name)
#define ud_bit_name(name) ((ld->port == UP_PORT) ? name##_U : name##_D)

#endif