root/drivers/net/ethernet/chelsio/cxgb4/cxgb4_cudbg.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 *  Copyright (C) 2017 Chelsio Communications.  All rights reserved.
 */

#include "t4_regs.h"
#include "cxgb4.h"
#include "cxgb4_cudbg.h"
#include "cudbg_zlib.h"

static const struct cxgb4_collect_entity cxgb4_collect_mem_dump[] = {
        { CUDBG_EDC0, cudbg_collect_edc0_meminfo },
        { CUDBG_EDC1, cudbg_collect_edc1_meminfo },
        { CUDBG_MC0, cudbg_collect_mc0_meminfo },
        { CUDBG_MC1, cudbg_collect_mc1_meminfo },
        { CUDBG_HMA, cudbg_collect_hma_meminfo },
};

static const struct cxgb4_collect_entity cxgb4_collect_hw_dump[] = {
        { CUDBG_MBOX_LOG, cudbg_collect_mbox_log },
        { CUDBG_QDESC, cudbg_collect_qdesc },
        { CUDBG_DEV_LOG, cudbg_collect_fw_devlog },
        { CUDBG_REG_DUMP, cudbg_collect_reg_dump },
        { CUDBG_CIM_LA, cudbg_collect_cim_la },
        { CUDBG_CIM_MA_LA, cudbg_collect_cim_ma_la },
        { CUDBG_CIM_QCFG, cudbg_collect_cim_qcfg },
        { CUDBG_CIM_IBQ_TP0, cudbg_collect_cim_ibq_tp0 },
        { CUDBG_CIM_IBQ_TP1, cudbg_collect_cim_ibq_tp1 },
        { CUDBG_CIM_IBQ_ULP, cudbg_collect_cim_ibq_ulp },
        { CUDBG_CIM_IBQ_SGE0, cudbg_collect_cim_ibq_sge0 },
        { CUDBG_CIM_IBQ_SGE1, cudbg_collect_cim_ibq_sge1 },
        { CUDBG_CIM_IBQ_NCSI, cudbg_collect_cim_ibq_ncsi },
        { CUDBG_CIM_OBQ_ULP0, cudbg_collect_cim_obq_ulp0 },
        { CUDBG_CIM_OBQ_ULP1, cudbg_collect_cim_obq_ulp1 },
        { CUDBG_CIM_OBQ_ULP2, cudbg_collect_cim_obq_ulp2 },
        { CUDBG_CIM_OBQ_ULP3, cudbg_collect_cim_obq_ulp3 },
        { CUDBG_CIM_OBQ_SGE, cudbg_collect_cim_obq_sge },
        { CUDBG_CIM_OBQ_NCSI, cudbg_collect_cim_obq_ncsi },
        { CUDBG_RSS, cudbg_collect_rss },
        { CUDBG_RSS_VF_CONF, cudbg_collect_rss_vf_config },
        { CUDBG_PATH_MTU, cudbg_collect_path_mtu },
        { CUDBG_PM_STATS, cudbg_collect_pm_stats },
        { CUDBG_HW_SCHED, cudbg_collect_hw_sched },
        { CUDBG_TP_INDIRECT, cudbg_collect_tp_indirect },
        { CUDBG_SGE_INDIRECT, cudbg_collect_sge_indirect },
        { CUDBG_ULPRX_LA, cudbg_collect_ulprx_la },
        { CUDBG_TP_LA, cudbg_collect_tp_la },
        { CUDBG_MEMINFO, cudbg_collect_meminfo },
        { CUDBG_CIM_PIF_LA, cudbg_collect_cim_pif_la },
        { CUDBG_CLK, cudbg_collect_clk_info },
        { CUDBG_CIM_OBQ_RXQ0, cudbg_collect_obq_sge_rx_q0 },
        { CUDBG_CIM_OBQ_RXQ1, cudbg_collect_obq_sge_rx_q1 },
        { CUDBG_PCIE_INDIRECT, cudbg_collect_pcie_indirect },
        { CUDBG_PM_INDIRECT, cudbg_collect_pm_indirect },
        { CUDBG_TID_INFO, cudbg_collect_tid },
        { CUDBG_PCIE_CONFIG, cudbg_collect_pcie_config },
        { CUDBG_DUMP_CONTEXT, cudbg_collect_dump_context },
        { CUDBG_MPS_TCAM, cudbg_collect_mps_tcam },
        { CUDBG_VPD_DATA, cudbg_collect_vpd_data },
        { CUDBG_LE_TCAM, cudbg_collect_le_tcam },
        { CUDBG_CCTRL, cudbg_collect_cctrl },
        { CUDBG_MA_INDIRECT, cudbg_collect_ma_indirect },
        { CUDBG_ULPTX_LA, cudbg_collect_ulptx_la },
        { CUDBG_UP_CIM_INDIRECT, cudbg_collect_up_cim_indirect },
        { CUDBG_PBT_TABLE, cudbg_collect_pbt_tables },
        { CUDBG_HMA_INDIRECT, cudbg_collect_hma_indirect },
};

static const struct cxgb4_collect_entity cxgb4_collect_flash_dump[] = {
        { CUDBG_FLASH, cudbg_collect_flash },
};

u32 cxgb4_get_dump_length(struct adapter *adap, u32 flag)
{
        u32 i, entity;
        u32 len = 0;
        u32 wsize;

        if (flag & CXGB4_ETH_DUMP_HW) {
                for (i = 0; i < ARRAY_SIZE(cxgb4_collect_hw_dump); i++) {
                        entity = cxgb4_collect_hw_dump[i].entity;
                        len += cudbg_get_entity_length(adap, entity);
                }
        }

        if (flag & CXGB4_ETH_DUMP_MEM) {
                for (i = 0; i < ARRAY_SIZE(cxgb4_collect_mem_dump); i++) {
                        entity = cxgb4_collect_mem_dump[i].entity;
                        len += cudbg_get_entity_length(adap, entity);
                }
        }

        if (flag & CXGB4_ETH_DUMP_FLASH)
                len += adap->params.sf_size;

        /* If compression is enabled, a smaller destination buffer is enough */
        wsize = cudbg_get_workspace_size();
        if (wsize && len > CUDBG_DUMP_BUFF_SIZE)
                len = CUDBG_DUMP_BUFF_SIZE;

        return len;
}

static void cxgb4_cudbg_collect_entity(struct cudbg_init *pdbg_init,
                                       struct cudbg_buffer *dbg_buff,
                                       const struct cxgb4_collect_entity *e_arr,
                                       u32 arr_size, void *buf, u32 *tot_size)
{
        struct cudbg_error cudbg_err = { 0 };
        struct cudbg_entity_hdr *entity_hdr;
        u32 i, total_size = 0;
        int ret;

        for (i = 0; i < arr_size; i++) {
                const struct cxgb4_collect_entity *e = &e_arr[i];

                entity_hdr = cudbg_get_entity_hdr(buf, e->entity);
                entity_hdr->entity_type = e->entity;
                entity_hdr->start_offset = dbg_buff->offset;
                memset(&cudbg_err, 0, sizeof(struct cudbg_error));
                ret = e->collect_cb(pdbg_init, dbg_buff, &cudbg_err);
                if (ret) {
                        entity_hdr->size = 0;
                        dbg_buff->offset = entity_hdr->start_offset;
                } else {
                        cudbg_align_debug_buffer(dbg_buff, entity_hdr);
                }

                /* Log error and continue with next entity */
                if (cudbg_err.sys_err)
                        ret = CUDBG_SYSTEM_ERROR;

                entity_hdr->hdr_flags = ret;
                entity_hdr->sys_err = cudbg_err.sys_err;
                entity_hdr->sys_warn = cudbg_err.sys_warn;
                total_size += entity_hdr->size;
        }

        *tot_size += total_size;
}

static int cudbg_alloc_compress_buff(struct cudbg_init *pdbg_init)
{
        u32 workspace_size;

        workspace_size = cudbg_get_workspace_size();
        pdbg_init->compress_buff = vzalloc(CUDBG_COMPRESS_BUFF_SIZE +
                                           workspace_size);
        if (!pdbg_init->compress_buff)
                return -ENOMEM;

        pdbg_init->compress_buff_size = CUDBG_COMPRESS_BUFF_SIZE;
        pdbg_init->workspace = (u8 *)pdbg_init->compress_buff +
                               CUDBG_COMPRESS_BUFF_SIZE - workspace_size;
        return 0;
}

static void cudbg_free_compress_buff(struct cudbg_init *pdbg_init)
{
        vfree(pdbg_init->compress_buff);
}

int cxgb4_cudbg_collect(struct adapter *adap, void *buf, u32 *buf_size,
                        u32 flag)
{
        struct cudbg_buffer dbg_buff = { 0 };
        u32 size, min_size, total_size = 0;
        struct cudbg_init cudbg_init;
        struct cudbg_hdr *cudbg_hdr;
        int rc;

        size = *buf_size;

        memset(&cudbg_init, 0, sizeof(struct cudbg_init));
        cudbg_init.adap = adap;
        cudbg_init.outbuf = buf;
        cudbg_init.outbuf_size = size;

        dbg_buff.data = buf;
        dbg_buff.size = size;
        dbg_buff.offset = 0;

        cudbg_hdr = (struct cudbg_hdr *)buf;
        cudbg_hdr->signature = CUDBG_SIGNATURE;
        cudbg_hdr->hdr_len = sizeof(struct cudbg_hdr);
        cudbg_hdr->major_ver = CUDBG_MAJOR_VERSION;
        cudbg_hdr->minor_ver = CUDBG_MINOR_VERSION;
        cudbg_hdr->max_entities = CUDBG_MAX_ENTITY;
        cudbg_hdr->chip_ver = adap->params.chip;
        cudbg_hdr->dump_type = CUDBG_DUMP_TYPE_MINI;

        min_size = sizeof(struct cudbg_hdr) +
                   sizeof(struct cudbg_entity_hdr) *
                   cudbg_hdr->max_entities;
        if (size < min_size)
                return -ENOMEM;

        rc = cudbg_get_workspace_size();
        if (rc) {
                /* Zlib available.  So, use zlib deflate */
                cudbg_init.compress_type = CUDBG_COMPRESSION_ZLIB;
                rc = cudbg_alloc_compress_buff(&cudbg_init);
                if (rc) {
                        /* Ignore error and continue without compression. */
                        dev_warn(adap->pdev_dev,
                                 "Fail allocating compression buffer ret: %d.  Continuing without compression.\n",
                                 rc);
                        cudbg_init.compress_type = CUDBG_COMPRESSION_NONE;
                        rc = 0;
                }
        } else {
                cudbg_init.compress_type = CUDBG_COMPRESSION_NONE;
        }

        cudbg_hdr->compress_type = cudbg_init.compress_type;
        dbg_buff.offset += min_size;
        total_size = dbg_buff.offset;

        if (flag & CXGB4_ETH_DUMP_HW)
                cxgb4_cudbg_collect_entity(&cudbg_init, &dbg_buff,
                                           cxgb4_collect_hw_dump,
                                           ARRAY_SIZE(cxgb4_collect_hw_dump),
                                           buf,
                                           &total_size);

        if (flag & CXGB4_ETH_DUMP_MEM)
                cxgb4_cudbg_collect_entity(&cudbg_init, &dbg_buff,
                                           cxgb4_collect_mem_dump,
                                           ARRAY_SIZE(cxgb4_collect_mem_dump),
                                           buf,
                                           &total_size);

        if (flag & CXGB4_ETH_DUMP_FLASH)
                cxgb4_cudbg_collect_entity(&cudbg_init, &dbg_buff,
                                           cxgb4_collect_flash_dump,
                                           ARRAY_SIZE(cxgb4_collect_flash_dump),
                                           buf,
                                           &total_size);

        cudbg_free_compress_buff(&cudbg_init);
        cudbg_hdr->data_len = total_size;
        if (cudbg_init.compress_type != CUDBG_COMPRESSION_NONE)
                *buf_size = size;
        else
                *buf_size = total_size;
        return 0;
}

void cxgb4_init_ethtool_dump(struct adapter *adapter)
{
        adapter->eth_dump.flag = CXGB4_ETH_DUMP_NONE;
        adapter->eth_dump.version = adapter->params.fw_vers;
        adapter->eth_dump.len = 0;
}

static int cxgb4_cudbg_vmcoredd_collect(struct vmcoredd_data *data, void *buf)
{
        struct adapter *adap = container_of(data, struct adapter, vmcoredd);
        u32 len = data->size;

        return cxgb4_cudbg_collect(adap, buf, &len, CXGB4_ETH_DUMP_ALL);
}

int cxgb4_cudbg_vmcore_add_dump(struct adapter *adap)
{
        struct vmcoredd_data *data = &adap->vmcoredd;
        u32 len;

        len = sizeof(struct cudbg_hdr) +
              sizeof(struct cudbg_entity_hdr) * CUDBG_MAX_ENTITY;
        len += CUDBG_DUMP_BUFF_SIZE;

        data->size = len;
        snprintf(data->dump_name, sizeof(data->dump_name), "%s_%s",
                 cxgb4_driver_name, adap->name);
        data->vmcoredd_callback = cxgb4_cudbg_vmcoredd_collect;

        return vmcore_add_device_dump(data);
}