root/drivers/scsi/snic/snic_io.c
// SPDX-License-Identifier: GPL-2.0-only
// Copyright 2014 Cisco Systems, Inc.  All rights reserved.

#include <linux/errno.h>
#include <linux/pci.h>
#include <linux/slab.h>

#include <linux/interrupt.h>
#include <linux/workqueue.h>
#include <linux/spinlock.h>
#include <linux/mempool.h>
#include <scsi/scsi_tcq.h>

#include "snic_io.h"
#include "snic.h"
#include "cq_enet_desc.h"
#include "snic_fwint.h"

static void
snic_wq_cmpl_frame_send(struct vnic_wq *wq,
                            struct cq_desc *cq_desc,
                            struct vnic_wq_buf *buf,
                            void *opaque)
{
        struct snic *snic = svnic_dev_priv(wq->vdev);

        SNIC_BUG_ON(buf->os_buf == NULL);

        if (snic_log_level & SNIC_DESC_LOGGING)
                SNIC_HOST_INFO(snic->shost,
                               "Ack received for snic_host_req %p.\n",
                               buf->os_buf);

        SNIC_TRC(snic->shost->host_no, 0, 0,
                 ((ulong)(buf->os_buf) - sizeof(struct snic_req_info)), 0, 0,
                 0);

        buf->os_buf = NULL;
}

static int
snic_wq_cmpl_handler_cont(struct vnic_dev *vdev,
                          struct cq_desc *cq_desc,
                          u8 type,
                          u16 q_num,
                          u16 cmpl_idx,
                          void *opaque)
{
        struct snic *snic = svnic_dev_priv(vdev);
        unsigned long flags;

        SNIC_BUG_ON(q_num != 0);

        spin_lock_irqsave(&snic->wq_lock[q_num], flags);
        svnic_wq_service(&snic->wq[q_num],
                         cq_desc,
                         cmpl_idx,
                         snic_wq_cmpl_frame_send,
                         NULL);
        spin_unlock_irqrestore(&snic->wq_lock[q_num], flags);

        return 0;
} /* end of snic_cmpl_handler_cont */

int
snic_wq_cmpl_handler(struct snic *snic, int work_to_do)
{
        unsigned int work_done = 0;
        unsigned int i;

        snic->s_stats.misc.last_ack_time = jiffies;
        for (i = 0; i < snic->wq_count; i++) {
                work_done += svnic_cq_service(&snic->cq[i],
                                              work_to_do,
                                              snic_wq_cmpl_handler_cont,
                                              NULL);
        }

        return work_done;
} /* end of snic_wq_cmpl_handler */

void
snic_free_wq_buf(struct vnic_wq *wq, struct vnic_wq_buf *buf)
{

        struct snic_host_req *req = buf->os_buf;
        struct snic *snic = svnic_dev_priv(wq->vdev);
        struct snic_req_info *rqi = NULL;
        unsigned long flags;

        dma_unmap_single(&snic->pdev->dev, buf->dma_addr, buf->len,
                         DMA_TO_DEVICE);

        rqi = req_to_rqi(req);
        spin_lock_irqsave(&snic->spl_cmd_lock, flags);
        if (list_empty(&rqi->list)) {
                spin_unlock_irqrestore(&snic->spl_cmd_lock, flags);
                goto end;
        }

        SNIC_BUG_ON(rqi->list.next == NULL); /* if not added to spl_cmd_list */
        list_del_init(&rqi->list);
        spin_unlock_irqrestore(&snic->spl_cmd_lock, flags);

        if (rqi->sge_va) {
                snic_pci_unmap_rsp_buf(snic, rqi);
                kfree((void *)rqi->sge_va);
                rqi->sge_va = 0;
        }
        snic_req_free(snic, rqi);
        SNIC_HOST_INFO(snic->shost, "snic_free_wq_buf .. freed.\n");

end:
        return;
}

/* Criteria to select work queue in multi queue mode */
static int
snic_select_wq(struct snic *snic)
{
        /* No multi queue support for now */
        BUILD_BUG_ON(SNIC_WQ_MAX > 1);

        return 0;
}

static int
snic_wqdesc_avail(struct snic *snic, int q_num, int req_type)
{
        int nr_wqdesc = snic->config.wq_enet_desc_count;

        if (q_num > 0) {
                /*
                 * Multi Queue case, additional care is required.
                 * Per WQ active requests need to be maintained.
                 */
                SNIC_HOST_INFO(snic->shost, "desc_avail: Multi Queue case.\n");
                SNIC_BUG_ON(q_num > 0);

                return -1;
        }

        nr_wqdesc -= atomic64_read(&snic->s_stats.fw.actv_reqs);

        return ((req_type == SNIC_REQ_HBA_RESET) ? nr_wqdesc : nr_wqdesc - 1);
}

int
snic_queue_wq_desc(struct snic *snic, void *os_buf, u16 len)
{
        dma_addr_t pa = 0;
        unsigned long flags;
        struct snic_fw_stats *fwstats = &snic->s_stats.fw;
        struct snic_host_req *req = (struct snic_host_req *) os_buf;
        long act_reqs;
        long desc_avail = 0;
        int q_num = 0;

        snic_print_desc(__func__, os_buf, len);

        /* Map request buffer */
        pa = dma_map_single(&snic->pdev->dev, os_buf, len, DMA_TO_DEVICE);
        if (dma_mapping_error(&snic->pdev->dev, pa)) {
                SNIC_HOST_ERR(snic->shost, "qdesc: PCI DMA Mapping Fail.\n");

                return -ENOMEM;
        }

        req->req_pa = (ulong)pa;

        q_num = snic_select_wq(snic);

        spin_lock_irqsave(&snic->wq_lock[q_num], flags);
        desc_avail = snic_wqdesc_avail(snic, q_num, req->hdr.type);
        if (desc_avail <= 0) {
                dma_unmap_single(&snic->pdev->dev, pa, len, DMA_TO_DEVICE);
                req->req_pa = 0;
                spin_unlock_irqrestore(&snic->wq_lock[q_num], flags);
                atomic64_inc(&snic->s_stats.misc.wq_alloc_fail);
                SNIC_DBG("host = %d, WQ is Full\n", snic->shost->host_no);

                return -ENOMEM;
        }

        snic_queue_wq_eth_desc(&snic->wq[q_num], os_buf, pa, len, 0, 0, 1);
        /*
         * Update stats
         * note: when multi queue enabled, fw actv_reqs should be per queue.
         */
        act_reqs = atomic64_inc_return(&fwstats->actv_reqs);
        spin_unlock_irqrestore(&snic->wq_lock[q_num], flags);

        if (act_reqs > atomic64_read(&fwstats->max_actv_reqs))
                atomic64_set(&fwstats->max_actv_reqs, act_reqs);

        return 0;
} /* end of snic_queue_wq_desc() */

/*
 * snic_handle_untagged_req: Adds snic specific requests to spl_cmd_list.
 * Purpose : Used during driver unload to clean up the requests.
 */
void
snic_handle_untagged_req(struct snic *snic, struct snic_req_info *rqi)
{
        unsigned long flags;

        INIT_LIST_HEAD(&rqi->list);

        spin_lock_irqsave(&snic->spl_cmd_lock, flags);
        list_add_tail(&rqi->list, &snic->spl_cmd_list);
        spin_unlock_irqrestore(&snic->spl_cmd_lock, flags);
}

/*
 * snic_req_init:
 * Allocates snic_req_info + snic_host_req + sgl data, and initializes.
 */
struct snic_req_info *
snic_req_init(struct snic *snic, int sg_cnt)
{
        u8 typ;
        struct snic_req_info *rqi = NULL;

        typ = (sg_cnt <= SNIC_REQ_CACHE_DFLT_SGL) ?
                SNIC_REQ_CACHE_DFLT_SGL : SNIC_REQ_CACHE_MAX_SGL;

        rqi = mempool_alloc(snic->req_pool[typ], GFP_ATOMIC);
        if (!rqi) {
                atomic64_inc(&snic->s_stats.io.alloc_fail);
                SNIC_HOST_ERR(snic->shost,
                              "Failed to allocate memory from snic req pool id = %d\n",
                              typ);
                return rqi;
        }

        memset(rqi, 0, sizeof(*rqi));
        rqi->rq_pool_type = typ;
        rqi->start_time = jiffies;
        rqi->req = (struct snic_host_req *) (rqi + 1);
        rqi->req_len = sizeof(struct snic_host_req);
        rqi->snic = snic;

        rqi->req = (struct snic_host_req *)(rqi + 1);

        if (sg_cnt == 0)
                goto end;

        rqi->req_len += (sg_cnt * sizeof(struct snic_sg_desc));

        if (sg_cnt > atomic64_read(&snic->s_stats.io.max_sgl))
                atomic64_set(&snic->s_stats.io.max_sgl, sg_cnt);

        SNIC_BUG_ON(sg_cnt > SNIC_MAX_SG_DESC_CNT);
        atomic64_inc(&snic->s_stats.io.sgl_cnt[sg_cnt - 1]);

end:
        memset(rqi->req, 0, rqi->req_len);

        /* pre initialization of init_ctx to support req_to_rqi */
        rqi->req->hdr.init_ctx = (ulong) rqi;

        SNIC_SCSI_DBG(snic->shost, "Req_alloc:rqi = %p allocatd.\n", rqi);

        return rqi;
} /* end of snic_req_init */

/*
 * snic_abort_req_init : Inits abort request.
 */
struct snic_host_req *
snic_abort_req_init(struct snic *snic, struct snic_req_info *rqi)
{
        struct snic_host_req *req = NULL;

        SNIC_BUG_ON(!rqi);

        /* If abort to be issued second time, then reuse */
        if (rqi->abort_req)
                return rqi->abort_req;


        req = mempool_alloc(snic->req_pool[SNIC_REQ_TM_CACHE], GFP_ATOMIC);
        if (!req) {
                SNIC_HOST_ERR(snic->shost, "abts:Failed to alloc tm req.\n");
                WARN_ON_ONCE(1);

                return NULL;
        }

        rqi->abort_req = req;
        memset(req, 0, sizeof(struct snic_host_req));
        /* pre initialization of init_ctx to support req_to_rqi */
        req->hdr.init_ctx = (ulong) rqi;

        return req;
} /* end of snic_abort_req_init */

/*
 * snic_dr_req_init : Inits device reset req
 */
struct snic_host_req *
snic_dr_req_init(struct snic *snic, struct snic_req_info *rqi)
{
        struct snic_host_req *req = NULL;

        SNIC_BUG_ON(!rqi);

        req = mempool_alloc(snic->req_pool[SNIC_REQ_TM_CACHE], GFP_ATOMIC);
        if (!req) {
                SNIC_HOST_ERR(snic->shost, "dr:Failed to alloc tm req.\n");
                WARN_ON_ONCE(1);

                return NULL;
        }

        SNIC_BUG_ON(rqi->dr_req != NULL);
        rqi->dr_req = req;
        memset(req, 0, sizeof(struct snic_host_req));
        /* pre initialization of init_ctx to support req_to_rqi */
        req->hdr.init_ctx = (ulong) rqi;

        return req;
} /* end of snic_dr_req_init */

/* frees snic_req_info and snic_host_req */
void
snic_req_free(struct snic *snic, struct snic_req_info *rqi)
{
        SNIC_BUG_ON(rqi->req == rqi->abort_req);
        SNIC_BUG_ON(rqi->req == rqi->dr_req);
        SNIC_BUG_ON(rqi->sge_va != 0);

        SNIC_SCSI_DBG(snic->shost,
                      "Req_free:rqi %p:ioreq %p:abt %p:dr %p\n",
                      rqi, rqi->req, rqi->abort_req, rqi->dr_req);

        if (rqi->abort_req) {
                if (rqi->abort_req->req_pa)
                        dma_unmap_single(&snic->pdev->dev,
                                         rqi->abort_req->req_pa,
                                         sizeof(struct snic_host_req),
                                         DMA_TO_DEVICE);

                mempool_free(rqi->abort_req, snic->req_pool[SNIC_REQ_TM_CACHE]);
        }

        if (rqi->dr_req) {
                if (rqi->dr_req->req_pa)
                        dma_unmap_single(&snic->pdev->dev,
                                         rqi->dr_req->req_pa,
                                         sizeof(struct snic_host_req),
                                         DMA_TO_DEVICE);

                mempool_free(rqi->dr_req, snic->req_pool[SNIC_REQ_TM_CACHE]);
        }

        if (rqi->req->req_pa)
                dma_unmap_single(&snic->pdev->dev,
                                 rqi->req->req_pa,
                                 rqi->req_len,
                                 DMA_TO_DEVICE);

        mempool_free(rqi, snic->req_pool[rqi->rq_pool_type]);
}

void
snic_pci_unmap_rsp_buf(struct snic *snic, struct snic_req_info *rqi)
{
        struct snic_sg_desc *sgd;

        sgd = req_to_sgl(rqi_to_req(rqi));
        SNIC_BUG_ON(sgd[0].addr == 0);
        dma_unmap_single(&snic->pdev->dev,
                         le64_to_cpu(sgd[0].addr),
                         le32_to_cpu(sgd[0].len),
                         DMA_FROM_DEVICE);
}

/*
 * snic_free_all_untagged_reqs: Walks through untagged reqs and frees them.
 */
void
snic_free_all_untagged_reqs(struct snic *snic)
{
        struct snic_req_info *rqi;
        struct list_head *cur, *nxt;
        unsigned long flags;

        spin_lock_irqsave(&snic->spl_cmd_lock, flags);
        list_for_each_safe(cur, nxt, &snic->spl_cmd_list) {
                rqi = list_entry(cur, struct snic_req_info, list);
                list_del_init(&rqi->list);
                if (rqi->sge_va) {
                        snic_pci_unmap_rsp_buf(snic, rqi);
                        kfree((void *)rqi->sge_va);
                        rqi->sge_va = 0;
                }

                snic_req_free(snic, rqi);
        }
        spin_unlock_irqrestore(&snic->spl_cmd_lock, flags);
}

/*
 * snic_release_untagged_req : Unlinks the untagged req and frees it.
 */
void
snic_release_untagged_req(struct snic *snic, struct snic_req_info *rqi)
{
        unsigned long flags;

        spin_lock_irqsave(&snic->snic_lock, flags);
        if (snic->in_remove) {
                spin_unlock_irqrestore(&snic->snic_lock, flags);
                goto end;
        }
        spin_unlock_irqrestore(&snic->snic_lock, flags);

        spin_lock_irqsave(&snic->spl_cmd_lock, flags);
        if (list_empty(&rqi->list)) {
                spin_unlock_irqrestore(&snic->spl_cmd_lock, flags);
                goto end;
        }
        list_del_init(&rqi->list);
        spin_unlock_irqrestore(&snic->spl_cmd_lock, flags);
        snic_req_free(snic, rqi);

end:
        return;
}

/* dump buf in hex fmt */
void
snic_hex_dump(char *pfx, char *data, int len)
{
        SNIC_INFO("%s Dumping Data of Len = %d\n", pfx, len);
        print_hex_dump_bytes(pfx, DUMP_PREFIX_NONE, data, len);
}

#define LINE_BUFSZ      128     /* for snic_print_desc fn */
static void
snic_dump_desc(const char *fn, char *os_buf, int len)
{
        struct snic_host_req *req = (struct snic_host_req *) os_buf;
        struct snic_fw_req *fwreq = (struct snic_fw_req *) os_buf;
        struct snic_req_info *rqi = NULL;
        char line[LINE_BUFSZ] = { '\0' };
        char *cmd_str = NULL;

        if (req->hdr.type >= SNIC_RSP_REPORT_TGTS_CMPL)
                rqi = (struct snic_req_info *) fwreq->hdr.init_ctx;
        else
                rqi = (struct snic_req_info *) req->hdr.init_ctx;

        SNIC_BUG_ON(rqi == NULL || rqi->req == NULL);
        switch (req->hdr.type) {
        case SNIC_REQ_REPORT_TGTS:
                cmd_str = "report-tgt : ";
                snprintf(line, LINE_BUFSZ, "SNIC_REQ_REPORT_TGTS :");
                break;

        case SNIC_REQ_ICMND:
                cmd_str = "icmnd : ";
                snprintf(line, LINE_BUFSZ, "SNIC_REQ_ICMND : 0x%x :",
                         req->u.icmnd.cdb[0]);
                break;

        case SNIC_REQ_ITMF:
                cmd_str = "itmf : ";
                snprintf(line, LINE_BUFSZ, "SNIC_REQ_ITMF :");
                break;

        case SNIC_REQ_HBA_RESET:
                cmd_str = "hba reset :";
                snprintf(line, LINE_BUFSZ, "SNIC_REQ_HBA_RESET :");
                break;

        case SNIC_REQ_EXCH_VER:
                cmd_str = "exch ver : ";
                snprintf(line, LINE_BUFSZ, "SNIC_REQ_EXCH_VER :");
                break;

        case SNIC_REQ_TGT_INFO:
                cmd_str = "tgt info : ";
                break;

        case SNIC_RSP_REPORT_TGTS_CMPL:
                cmd_str = "report tgt cmpl : ";
                snprintf(line, LINE_BUFSZ, "SNIC_RSP_REPORT_TGTS_CMPL :");
                break;

        case SNIC_RSP_ICMND_CMPL:
                cmd_str = "icmnd_cmpl : ";
                snprintf(line, LINE_BUFSZ, "SNIC_RSP_ICMND_CMPL : 0x%x :",
                         rqi->req->u.icmnd.cdb[0]);
                break;

        case SNIC_RSP_ITMF_CMPL:
                cmd_str = "itmf_cmpl : ";
                snprintf(line, LINE_BUFSZ, "SNIC_RSP_ITMF_CMPL :");
                break;

        case SNIC_RSP_HBA_RESET_CMPL:
                cmd_str = "hba_reset_cmpl : ";
                snprintf(line, LINE_BUFSZ, "SNIC_RSP_HBA_RESET_CMPL :");
                break;

        case SNIC_RSP_EXCH_VER_CMPL:
                cmd_str = "exch_ver_cmpl : ";
                snprintf(line, LINE_BUFSZ, "SNIC_RSP_EXCH_VER_CMPL :");
                break;

        case SNIC_MSG_ACK:
                cmd_str = "msg ack : ";
                snprintf(line, LINE_BUFSZ, "SNIC_MSG_ACK :");
                break;

        case SNIC_MSG_ASYNC_EVNOTIFY:
                cmd_str = "async notify : ";
                snprintf(line, LINE_BUFSZ, "SNIC_MSG_ASYNC_EVNOTIFY :");
                break;

        default:
                cmd_str = "unknown : ";
                SNIC_BUG_ON(1);
                break;
        }

        SNIC_INFO("%s:%s >>cmndid=%x:sg_cnt = %x:status = %x:ctx = %lx.\n",
                  fn, line, req->hdr.cmnd_id, req->hdr.sg_cnt, req->hdr.status,
                  req->hdr.init_ctx);

        /* Enable it, to dump byte stream */
        if (snic_log_level & 0x20)
                snic_hex_dump(cmd_str, os_buf, len);
} /* end of __snic_print_desc */

void
snic_print_desc(const char *fn, char *os_buf, int len)
{
        if (snic_log_level & SNIC_DESC_LOGGING)
                snic_dump_desc(fn, os_buf, len);
}

void
snic_calc_io_process_time(struct snic *snic, struct snic_req_info *rqi)
{
        u64 duration;

        duration = jiffies - rqi->start_time;

        if (duration > atomic64_read(&snic->s_stats.io.max_time))
                atomic64_set(&snic->s_stats.io.max_time, duration);
}