root/usr/src/uts/common/io/ntxn/unm_nic_init.c
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2008 NetXen, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

/*
 * Copyright (c) 2018, Joyent, Inc.
 */

#include <sys/types.h>
#include <sys/conf.h>
#include <sys/debug.h>
#include <sys/stropts.h>
#include <sys/stream.h>
#include <sys/strlog.h>
#include <sys/kmem.h>
#include <sys/stat.h>
#include <sys/kstat.h>
#include <sys/vtrace.h>
#include <sys/dlpi.h>
#include <sys/strsun.h>
#include <sys/ethernet.h>
#include <sys/modctl.h>
#include <sys/errno.h>
#include <sys/dditypes.h>
#include <sys/ddi.h>
#include <sys/sunddi.h>
#include <sys/sysmacros.h>
#include <sys/pci.h>

#include "unm_nic.h"
#include "unm_nic_hw.h"
#include "nic_cmn.h"
#include "unm_nic_ioctl.h"
#include "nic_phan_reg.h"

struct crb_addr_pair {
        long    addr, data;
};

#define MAX_CRB_XFORM   60
#define ADDR_ERROR      ((unsigned long)0xffffffff)

#define crb_addr_transform(name)                                \
                crb_addr_xform[UNM_HW_PX_MAP_CRB_##name] =              \
                UNM_HW_CRB_HUB_AGT_ADR_##name << 20

static unsigned int crb_addr_xform[MAX_CRB_XFORM];

static void
crb_addr_transform_setup(void)
{
        crb_addr_transform(XDMA);
        crb_addr_transform(TIMR);
        crb_addr_transform(SRE);
        crb_addr_transform(SQN3);
        crb_addr_transform(SQN2);
        crb_addr_transform(SQN1);
        crb_addr_transform(SQN0);
        crb_addr_transform(SQS3);
        crb_addr_transform(SQS2);
        crb_addr_transform(SQS1);
        crb_addr_transform(SQS0);
        crb_addr_transform(RPMX7);
        crb_addr_transform(RPMX6);
        crb_addr_transform(RPMX5);
        crb_addr_transform(RPMX4);
        crb_addr_transform(RPMX3);
        crb_addr_transform(RPMX2);
        crb_addr_transform(RPMX1);
        crb_addr_transform(RPMX0);
        crb_addr_transform(ROMUSB);
        crb_addr_transform(SN);
        crb_addr_transform(QMN);
        crb_addr_transform(QMS);
        crb_addr_transform(PGNI);
        crb_addr_transform(PGND);
        crb_addr_transform(PGN3);
        crb_addr_transform(PGN2);
        crb_addr_transform(PGN1);
        crb_addr_transform(PGN0);
        crb_addr_transform(PGSI);
        crb_addr_transform(PGSD);
        crb_addr_transform(PGS3);
        crb_addr_transform(PGS2);
        crb_addr_transform(PGS1);
        crb_addr_transform(PGS0);
        crb_addr_transform(PS);
        crb_addr_transform(PH);
        crb_addr_transform(NIU);
        crb_addr_transform(I2Q);
        crb_addr_transform(EG);
        crb_addr_transform(MN);
        crb_addr_transform(MS);
        crb_addr_transform(CAS2);
        crb_addr_transform(CAS1);
        crb_addr_transform(CAS0);
        crb_addr_transform(CAM);
        crb_addr_transform(C2C1);
        crb_addr_transform(C2C0);
        crb_addr_transform(SMB);
        crb_addr_transform(OCM0);

        /*
         * Used only in P3 just define it for P2 also.
         */
        crb_addr_transform(I2C0);
}

/*
 * decode_crb_addr(0 - utility to translate from internal Phantom CRB address
 * to external PCI CRB address.
 */
static unsigned long
decode_crb_addr(unsigned long addr)
{
        int i;
        unsigned long base_addr, offset, pci_base;

        crb_addr_transform_setup();

        pci_base = ADDR_ERROR;
        base_addr = addr & 0xfff00000;
        offset = addr & 0x000fffff;

        for (i = 0; i < MAX_CRB_XFORM; i++) {
                if (crb_addr_xform[i] == base_addr) {
                        pci_base = i << 20;
                        break;
                }
        }

        if (pci_base == ADDR_ERROR) {
                return (pci_base);
        } else {
                return (pci_base + offset);
        }
}

static long rom_max_timeout = 100;
static long rom_lock_timeout = 10000;

static int
rom_lock(unm_adapter *adapter)
{
        uint32_t done = 0;
        long timeout = 0;

        while (!done) {
                /* acquire semaphore2 from PCI HW block */
                unm_nic_read_w0(adapter, UNM_PCIE_REG(PCIE_SEM2_LOCK), &done);
                if (done == 1)
                        break;
                if (timeout >= rom_lock_timeout) {
                        cmn_err(CE_WARN, "%s%d rom_lock timed out %d %ld\n",
                            adapter->name, adapter->instance, done, timeout);
                        return (-1);
                }
                timeout++;
        }
        unm_nic_reg_write(adapter, UNM_ROM_LOCK_ID, ROM_LOCK_DRIVER);
        return (0);
}

static void
rom_unlock(unm_adapter *adapter)
{
        uint32_t val;

        /* release semaphore2 */
        unm_nic_read_w0(adapter, UNM_PCIE_REG(PCIE_SEM2_UNLOCK), &val);
}

static int
wait_rom_done(unm_adapter *adapter)
{
        long timeout = 0;
        long done = 0;

        while (done == 0) {
                unm_nic_reg_read(adapter, UNM_ROMUSB_GLB_STATUS, &done);
                done &= 2;
                timeout++;
                if (timeout >= rom_max_timeout) {
                        cmn_err(CE_WARN,
                            "Timeout reached waiting for rom done");
                        return (-1);
                }
        }
        return (0);
}

static int
do_rom_fast_read(unm_adapter *adapter, int addr, int *valp)
{
        unm_nic_reg_write(adapter, UNM_ROMUSB_ROM_ADDRESS, addr);
        unm_nic_reg_write(adapter, UNM_ROMUSB_ROM_ABYTE_CNT, 3);
        drv_usecwait(100);   /* prevent bursting on CRB */
        unm_nic_reg_write(adapter, UNM_ROMUSB_ROM_DUMMY_BYTE_CNT, 0);
        unm_nic_reg_write(adapter, UNM_ROMUSB_ROM_INSTR_OPCODE, 0xb);
        if (wait_rom_done(adapter) != DDI_SUCCESS) {
                cmn_err(CE_WARN, "Error waiting for rom done\n");
                return (-1);
        }

        // reset abyte_cnt and dummy_byte_cnt
        unm_nic_reg_write(adapter, UNM_ROMUSB_ROM_ABYTE_CNT, 0);
        drv_usecwait(100);   /* prevent bursting on CRB */
        unm_nic_reg_write(adapter, UNM_ROMUSB_ROM_DUMMY_BYTE_CNT, 0);

        unm_nic_reg_read(adapter, UNM_ROMUSB_ROM_RDATA, valp);
        return (0);
}

int
rom_fast_read(struct unm_adapter_s *adapter, int addr, int *valp)
{
        int ret;

        if (rom_lock(adapter) != 0) {
                cmn_err(CE_WARN, "%s(%d)rom_lock failed\n",
                    __FUNCTION__, __LINE__);
                return (-1);
        }

        ret = do_rom_fast_read(adapter, addr, valp);
        if (ret != 0) {
                cmn_err(CE_WARN, "%s do_rom_fast_read returned: %d\n",
                    __FUNCTION__, __LINE__);
                return (-1);
        }
        rom_unlock(adapter);
        return (ret);
}

int
pinit_from_rom(struct unm_adapter_s *adapter, int verbose)
{
        int     addr, val, status, i, init_delay = 0, n;
        struct crb_addr_pair    *buf;
        unsigned long   off;
        unsigned int    offset;

        status = unm_nic_get_board_info(adapter);
        if (status)
                cmn_err(CE_WARN, "%s: pinit_from_rom: Error getting brdinfo\n",
                    unm_nic_driver_name);

        UNM_CRB_WRITELIT_ADAPTER(UNM_ROMUSB_GLB_SW_RESET, 0xffffffff, adapter);

        if (verbose) {
                int     val;
                if (rom_fast_read(adapter, 0x4008, &val) == 0)
                        cmn_err(CE_WARN, "P2 ROM board type: 0x%08x\n", val);
                else
                        cmn_err(CE_WARN, "Could not read board type\n");
                if (rom_fast_read(adapter, 0x400c, &val) == 0)
                        cmn_err(CE_WARN, "ROM board  num: 0x%08x\n", val);
                else
                        cmn_err(CE_WARN, "Could not read board number\n");
                if (rom_fast_read(adapter, 0x4010, &val) == 0)
                        cmn_err(CE_WARN, "ROM chip   num: 0x%08x\n", val);
                else
                        cmn_err(CE_WARN, "Could not read chip number\n");
        }

        if (NX_IS_REVISION_P3(adapter->ahw.revision_id)) {
                if (rom_fast_read(adapter, 0, &n) != 0 ||
                    (unsigned int)n != 0xcafecafe ||
                    rom_fast_read(adapter, 4, &n) != 0) {
                        cmn_err(CE_WARN, "%s: ERROR Reading crb_init area: "
                            "n: %08x\n", unm_nic_driver_name, n);
                        return (-1);
                }

                offset = n & 0xffffU;
                n = (n >> 16) & 0xffffU;
        } else {
                if (rom_fast_read(adapter, 0, &n) != 0 ||
                    !(n & 0x80000000)) {
                        cmn_err(CE_WARN, "%s: ERROR Reading crb_init area: "
                            "n: %08x\n", unm_nic_driver_name, n);
                        return (-1);
                }
                offset = 1;
                n &= ~0x80000000;
        }

        if (n  >= 1024) {
                cmn_err(CE_WARN, "%s: %s:n=0x%x Card flash not initialized\n",
                    unm_nic_driver_name, __FUNCTION__, n);
                return (-1);
        }

        if (verbose)
                cmn_err(CE_WARN, "%s: %d CRB init values found in ROM.\n",
                    unm_nic_driver_name, n);

        buf = kmem_zalloc(n * sizeof (struct crb_addr_pair), KM_SLEEP);
        if (buf == NULL) {
                cmn_err(CE_WARN, "%s: pinit_from_rom: Unable to get memory\n",
                    unm_nic_driver_name);
                return (-1);
        }

        for (i = 0; i < n; i++) {
                if (rom_fast_read(adapter, 8*i + 4*offset, &val) != 0 ||
                    rom_fast_read(adapter, 8*i + 4*offset + 4, &addr) != 0) {
                        kmem_free(buf, n * sizeof (struct crb_addr_pair));
                        return (-1);
                }

                buf[i].addr = addr;
                buf[i].data = val;

                if (verbose)
                        cmn_err(CE_WARN, "%s: PCI:     0x%08x == 0x%08x\n",
                            unm_nic_driver_name,
                            (unsigned int)decode_crb_addr(
                            (unsigned long)addr), val);
        }

        for (i = 0; i < n; i++) {
                off = decode_crb_addr((unsigned long)buf[i].addr) +
                    UNM_PCI_CRBSPACE;
                /* skipping cold reboot MAGIC */
                if (off == UNM_CAM_RAM(0x1fc)) {
                        continue;
                }

                if (NX_IS_REVISION_P3(adapter->ahw.revision_id)) {
                        /* do not reset PCI */
                        if (off == (ROMUSB_GLB + 0xbc)) {
                                continue;
                        }
                        if (off == (ROMUSB_GLB + 0xc8)) /* core clock */
                                continue;
                        if (off == (ROMUSB_GLB + 0x24)) /* MN clock */
                                continue;
                        if (off == (ROMUSB_GLB + 0x1c)) /* MS clock */
                                continue;
                        if (off == (UNM_CRB_PEG_NET_1 + 0x18)) {
                                buf[i].data = 0x1020;
                        }
                        /* skip the function enable register */
                        if (off == UNM_PCIE_REG(PCIE_SETUP_FUNCTION)) {
                                continue;
                        }
                        if (off == UNM_PCIE_REG(PCIE_SETUP_FUNCTION2)) {
                                continue;
                        }

                        if ((off & 0x0ff00000) == UNM_CRB_SMB) {
                                continue;
                        }

                }

                if (off == ADDR_ERROR) {
                        cmn_err(CE_WARN, "%s: Err: Unknown addr: 0x%08lx\n",
                            unm_nic_driver_name, buf[i].addr);
                        continue;
                }

                /* After writing this register, HW needs time for CRB */
                /* to quiet down (else crb_window returns 0xffffffff) */
                if (off == UNM_ROMUSB_GLB_SW_RESET) {
                        init_delay = 1;

                        if (NX_IS_REVISION_P2(adapter->ahw.revision_id)) {
                                /* hold xdma in reset also */
                                buf[i].data = 0x8000ff;
                        }
                }

                adapter->unm_nic_hw_write_wx(adapter, off, &buf[i].data, 4);

                if (init_delay == 1) {
                        nx_msleep(1000);        /* Sleep 1000 msecs */
                        init_delay = 0;
                }

                nx_msleep(1);                   /* Sleep 1 msec */
        }

        kmem_free(buf, n * sizeof (struct crb_addr_pair));

        // disable_peg_cache_all
        // unreset_net_cache
        if (NX_IS_REVISION_P2(adapter->ahw.revision_id)) {
                val = UNM_CRB_READ_VAL_ADAPTER(UNM_ROMUSB_GLB_SW_RESET,
                    adapter);
                UNM_CRB_WRITELIT_ADAPTER(UNM_ROMUSB_GLB_SW_RESET,
                    (val & 0xffffff0f), adapter);
        }

        // p2dn replyCount
        UNM_CRB_WRITELIT_ADAPTER(UNM_CRB_PEG_NET_D+0xec, 0x1e, adapter);
        // disable_peg_cache 0
        UNM_CRB_WRITELIT_ADAPTER(UNM_CRB_PEG_NET_D+0x4c, 8, adapter);
        // disable_peg_cache 1
        UNM_CRB_WRITELIT_ADAPTER(UNM_CRB_PEG_NET_I+0x4c, 8, adapter);

        // peg_clr_all
        // peg_clr 0
        UNM_CRB_WRITELIT_ADAPTER(UNM_CRB_PEG_NET_0+0x8, 0, adapter);
        UNM_CRB_WRITELIT_ADAPTER(UNM_CRB_PEG_NET_0+0xc, 0, adapter);
        // peg_clr 1
        UNM_CRB_WRITELIT_ADAPTER(UNM_CRB_PEG_NET_1+0x8, 0, adapter);
        UNM_CRB_WRITELIT_ADAPTER(UNM_CRB_PEG_NET_1+0xc, 0, adapter);
        // peg_clr 2
        UNM_CRB_WRITELIT_ADAPTER(UNM_CRB_PEG_NET_2+0x8, 0, adapter);
        UNM_CRB_WRITELIT_ADAPTER(UNM_CRB_PEG_NET_2+0xc, 0, adapter);
        // peg_clr 3
        UNM_CRB_WRITELIT_ADAPTER(UNM_CRB_PEG_NET_3+0x8, 0, adapter);
        UNM_CRB_WRITELIT_ADAPTER(UNM_CRB_PEG_NET_3+0xc, 0, adapter);

        return (0);
}

int
phantom_init(struct unm_adapter_s *adapter, int pegtune_val)
{
        u32     val = 0;
        int     retries = 120;

        if (!pegtune_val) {
                do {
                        val = adapter->unm_nic_pci_read_normalize(adapter,
                            CRB_CMDPEG_STATE);

                        if ((val == PHAN_INITIALIZE_COMPLETE) ||
                            (val == PHAN_INITIALIZE_ACK))
                                return (DDI_SUCCESS);

                        /* 500 msec wait */
                        drv_usecwait(500000);
                } while (--retries > 0);

                if (!retries) {
                        val = adapter->unm_nic_pci_read_normalize(adapter,
                            UNM_ROMUSB_GLB_PEGTUNE_DONE);
                        cmn_err(CE_WARN, "WARNING: Initial boot wait loop"
                            "failed...state:%d\n", val);
                        return (DDI_FAILURE);
                }
        }

        return (DDI_SUCCESS);
}

int
load_from_flash(struct unm_adapter_s *adapter)
{
        int  i;
        long data, size = 0;
        long flashaddr = BOOTLD_START, memaddr = BOOTLD_START;

        size = (IMAGE_START - BOOTLD_START)/4;

        if (NX_IS_REVISION_P2(adapter->ahw.revision_id)) {
                data = 1;
                adapter->unm_nic_hw_write_wx(adapter, UNM_ROMUSB_GLB_CAS_RST,
                    &data, 4);
        }

        for (i = 0; i < size; i++) {
                if (rom_fast_read(adapter, flashaddr, (int *)&data) != 0) {
                        cmn_err(CE_WARN, "Error in rom_fast_read: "
                            "Will skip loading flash image\n");
                        return (DDI_FAILURE);
                }

                adapter->unm_nic_pci_mem_write(adapter, memaddr, &data, 4);
                flashaddr += 4;
                memaddr += 4;
        }

        drv_usecwait(100);
        UNM_READ_LOCK(&adapter->adapter_lock);

        if (NX_IS_REVISION_P3(adapter->ahw.revision_id)) {
                data = 0x80001d;
                adapter->unm_nic_hw_write_wx(adapter, UNM_ROMUSB_GLB_SW_RESET,
                    &data, 4);
        } else {
                data = 0x3fff;
                adapter->unm_nic_hw_write_wx(adapter,
                    UNM_ROMUSB_GLB_CHIP_CLK_CTRL, &data, 4);
                data = 0;
                adapter->unm_nic_hw_write_wx(adapter, UNM_ROMUSB_GLB_CAS_RST,
                    &data, 4);
        }

        UNM_READ_UNLOCK(&adapter->adapter_lock);
        return (DDI_SUCCESS);
}