[mirror_ubuntu-eoan-kernel.git] / drivers / scsi / lpfc / lpfc_nvme.h

/*******************************************************************
 * This file is part of the Emulex Linux Device Driver for         *
 * Fibre Channel Host Bus Adapters.                                *
 * Copyright (C) 2017 Broadcom. All Rights Reserved. The term      *
 * “Broadcom” refers to Broadcom Limited and/or its subsidiaries.  *
 * Copyright (C) 2004-2016 Emulex.  All rights reserved.           *
 * EMULEX and SLI are trademarks of Emulex.                        *
 * www.broadcom.com                                                *
 * Portions Copyright (C) 2004-2005 Christoph Hellwig              *
 *                                                                 *
 * This program is free software; you can redistribute it and/or   *
 * modify it under the terms of version 2 of the GNU General       *
 * Public License as published by the Free Software Foundation.    *
 * This program is distributed in the hope that it will be useful. *
 * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
 * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
 * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
 * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
 * more details, a copy of which can be found in the file COPYING  *
 * included with this package.                                     *
 ********************************************************************/

#define LPFC_NVME_MIN_SEGS		16
#define LPFC_NVME_DEFAULT_SEGS		66	/* 256K IOs - 64 + 2 */
#define LPFC_NVME_MAX_SEGS		510
#define LPFC_NVMET_MIN_POSTBUF		16
#define LPFC_NVMET_DEFAULT_POSTBUF	1024
#define LPFC_NVMET_MAX_POSTBUF		4096
#define LPFC_NVME_WQSIZE		256

#define LPFC_NVME_ERSP_LEN		0x20

struct lpfc_nvme_qhandle {
	uint32_t index;		/* WQ index to use */
	uint32_t qidx;		/* queue index passed to create */
	uint32_t cpu_id;	/* current cpu id at time of create */
};

/* Declare nvme-based local and remote port definitions. */
struct lpfc_nvme_lport {
	struct lpfc_vport *vport;
	struct list_head rport_list;
	struct completion lport_unreg_done;
	/* Add sttats counters here */
};

struct lpfc_nvme_rport {
	struct list_head list;
	struct lpfc_nvme_lport *lport;
	struct nvme_fc_remote_port *remoteport;
	struct lpfc_nodelist *ndlp;
	struct completion rport_unreg_done;
};

struct lpfc_nvme_buf {
	struct list_head list;
	struct nvmefc_fcp_req *nvmeCmd;
	struct lpfc_nvme_rport *nrport;
	struct lpfc_nodelist *ndlp;

	uint32_t timeout;

	uint16_t flags;  /* TBD convert exch_busy to flags */
#define LPFC_SBUF_XBUSY         0x1     /* SLI4 hba reported XB on WCQE cmpl */
	uint16_t exch_busy;     /* SLI4 hba reported XB on complete WCQE */
	uint16_t status;	/* From IOCB Word 7- ulpStatus */
	uint16_t cpu;
	uint16_t qidx;
	uint16_t sqid;
	uint32_t result;	/* From IOCB Word 4. */

	uint32_t   seg_cnt;	/* Number of scatter-gather segments returned by
				 * dma_map_sg.  The driver needs this for calls
				 * to dma_unmap_sg.
				 */
	dma_addr_t nonsg_phys;	/* Non scatter-gather physical address. */

	/*
	 * data and dma_handle are the kernel virtual and bus address of the
	 * dma-able buffer containing the fcp_cmd, fcp_rsp and a scatter
	 * gather bde list that supports the sg_tablesize value.
	 */
	void *data;
	dma_addr_t dma_handle;

	struct sli4_sge *nvme_sgl;
	dma_addr_t dma_phys_sgl;

	/* cur_iocbq has phys of the dma-able buffer.
	 * Iotag is in here
	 */
	struct lpfc_iocbq cur_iocbq;

	wait_queue_head_t *waitq;
	unsigned long start_time;
#ifdef CONFIG_SCSI_LPFC_DEBUG_FS
	uint64_t ts_cmd_start;
	uint64_t ts_last_cmd;
	uint64_t ts_cmd_wqput;
	uint64_t ts_isr_cmpl;
	uint64_t ts_data_nvme;
#endif
};
Commit	Line	Data
895427bd JS	1	/*******************************************************************
	2	* This file is part of the Emulex Linux Device Driver for *
	3	* Fibre Channel Host Bus Adapters. *
d080abe0 JS	4	* Copyright (C) 2017 Broadcom. All Rights Reserved. The term *
d080abe0 JS	5	* “Broadcom” refers to Broadcom Limited and/or its subsidiaries. *
895427bd JS	6	* Copyright (C) 2004-2016 Emulex. All rights reserved. *
895427bd JS	7	* EMULEX and SLI are trademarks of Emulex. *
d080abe0	8	* www.broadcom.com *
895427bd JS	9	* Portions Copyright (C) 2004-2005 Christoph Hellwig *
	10	* *
	11	* This program is free software; you can redistribute it and/or *
	12	* modify it under the terms of version 2 of the GNU General *
	13	* Public License as published by the Free Software Foundation. *
	14	* This program is distributed in the hope that it will be useful. *
	15	* ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND *
	16	* WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, *
	17	* FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE *
	18	* DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
	19	* TO BE LEGALLY INVALID. See the GNU General Public License for *
	20	* more details, a copy of which can be found in the file COPYING *
	21	* included with this package. *
	22	********************************************************************/
	23
	24	#define LPFC_NVME_MIN_SEGS 16
	25	#define LPFC_NVME_DEFAULT_SEGS 66 /* 256K IOs - 64 + 2 */
	26	#define LPFC_NVME_MAX_SEGS 510
	27	#define LPFC_NVMET_MIN_POSTBUF 16
	28	#define LPFC_NVMET_DEFAULT_POSTBUF 1024
	29	#define LPFC_NVMET_MAX_POSTBUF 4096
	30	#define LPFC_NVME_WQSIZE 256
	31
	32	#define LPFC_NVME_ERSP_LEN 0x20
	33
01649561 JS	34	struct lpfc_nvme_qhandle {
	35	uint32_t index; /* WQ index to use */
	36	uint32_t qidx; /* queue index passed to create */
	37	uint32_t cpu_id; /* current cpu id at time of create */
	38	};
	39
895427bd JS	40	/* Declare nvme-based local and remote port definitions. */
	41	struct lpfc_nvme_lport {
	42	struct lpfc_vport *vport;
	43	struct list_head rport_list;
	44	struct completion lport_unreg_done;
	45	/* Add sttats counters here */
	46	};
	47
	48	struct lpfc_nvme_rport {
	49	struct list_head list;
	50	struct lpfc_nvme_lport *lport;
	51	struct nvme_fc_remote_port *remoteport;
	52	struct lpfc_nodelist *ndlp;
	53	struct completion rport_unreg_done;
	54	};
	55
	56	struct lpfc_nvme_buf {
	57	struct list_head list;
	58	struct nvmefc_fcp_req *nvmeCmd;
	59	struct lpfc_nvme_rport *nrport;
318083ad	60	struct lpfc_nodelist *ndlp;
895427bd JS	61
	62	uint32_t timeout;
	63
	64	uint16_t flags; /* TBD convert exch_busy to flags */
	65	#define LPFC_SBUF_XBUSY 0x1 /* SLI4 hba reported XB on WCQE cmpl */
	66	uint16_t exch_busy; /* SLI4 hba reported XB on complete WCQE */
	67	uint16_t status; /* From IOCB Word 7- ulpStatus */
	68	uint16_t cpu;
	69	uint16_t qidx;
	70	uint16_t sqid;
	71	uint32_t result; /* From IOCB Word 4. */
	72
	73	uint32_t seg_cnt; /* Number of scatter-gather segments returned by
	74	* dma_map_sg. The driver needs this for calls
	75	* to dma_unmap_sg.
	76	*/
	77	dma_addr_t nonsg_phys; /* Non scatter-gather physical address. */
	78
	79	/*
	80	* data and dma_handle are the kernel virtual and bus address of the
	81	* dma-able buffer containing the fcp_cmd, fcp_rsp and a scatter
	82	* gather bde list that supports the sg_tablesize value.
	83	*/
	84	void *data;
	85	dma_addr_t dma_handle;
	86
	87	struct sli4_sge *nvme_sgl;
	88	dma_addr_t dma_phys_sgl;
	89
	90	/* cur_iocbq has phys of the dma-able buffer.
	91	* Iotag is in here
	92	*/
	93	struct lpfc_iocbq cur_iocbq;
	94
	95	wait_queue_head_t *waitq;
	96	unsigned long start_time;
bd2cdd5e JS	97	#ifdef CONFIG_SCSI_LPFC_DEBUG_FS
	98	uint64_t ts_cmd_start;
	99	uint64_t ts_last_cmd;
	100	uint64_t ts_cmd_wqput;
	101	uint64_t ts_isr_cmpl;
	102	uint64_t ts_data_nvme;
	103	#endif
895427bd	104	};