/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (c) 2020 Synopsys, Inc. and/or its affiliates.
 * Synopsys DesignWare XPCS helpers
 */

#ifndef __LINUX_PCS_XPCS_H
#define __LINUX_PCS_XPCS_H

#include <linux/clk.h>
#include <linux/fwnode.h>
#include <linux/mdio.h>
#include <linux/phy.h>
#include <linux/phylink.h>
#include <linux/types.h>

/* AN mode */
#define DW_AN_C73                       1
#define DW_AN_C37_SGMII                 2
#define DW_2500BASEX                    3
#define DW_AN_C37_1000BASEX             4
#define DW_10GBASER                     5

enum dw_xpcs_pcs_id {
        DW_XPCS_ID_NATIVE = 0,
        NXP_SJA1105_XPCS_ID = 0x00000010,
        NXP_SJA1110_XPCS_ID = 0x00000020,
        DW_XPCS_ID = 0x7996ced0,
        DW_XPCS_ID_MASK = 0xffffffff,
};

enum dw_xpcs_pma_id {
        DW_XPCS_PMA_ID_NATIVE = 0,
        DW_XPCS_PMA_GEN1_3G_ID,
        DW_XPCS_PMA_GEN2_3G_ID,
        DW_XPCS_PMA_GEN2_6G_ID,
        DW_XPCS_PMA_GEN4_3G_ID,
        DW_XPCS_PMA_GEN4_6G_ID,
        DW_XPCS_PMA_GEN5_10G_ID,
        DW_XPCS_PMA_GEN5_12G_ID,
        WX_TXGBE_XPCS_PMA_10G_ID = 0xfc806000,
        /* Meta Platforms OUI 88:25:08, model 0, revision 0 */
        MP_FBNIC_XPCS_PMA_100G_ID = 0x46904000,
};

struct dw_xpcs_info {
        u32 pcs;
        u32 pma;
};

struct dw_xpcs;

struct phylink_pcs *xpcs_to_phylink_pcs(struct dw_xpcs *xpcs);
int xpcs_get_an_mode(struct dw_xpcs *xpcs, phy_interface_t interface);
void xpcs_config_eee_mult_fact(struct dw_xpcs *xpcs, u8 mult_fact);
struct dw_xpcs *xpcs_create_mdiodev(struct mii_bus *bus, int addr);
struct dw_xpcs *xpcs_create_fwnode(struct fwnode_handle *fwnode);
void xpcs_destroy(struct dw_xpcs *xpcs);

struct phylink_pcs *xpcs_create_pcs_mdiodev(struct mii_bus *bus, int addr);
void xpcs_destroy_pcs(struct phylink_pcs *pcs);

#endif /* __LINUX_PCS_XPCS_H */