[mirror_ubuntu-jammy-kernel.git] / drivers / nvme / host / lightnvm.c

/*
 * nvme-lightnvm.c - LightNVM NVMe device
 *
 * Copyright (C) 2014-2015 IT University of Copenhagen
 * Initial release: Matias Bjorling <mb@lightnvm.io>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version
 * 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; see the file COPYING.  If not, write to
 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
 * USA.
 *
 */

#include "nvme.h"

#include <linux/nvme.h>
#include <linux/bitops.h>
#include <linux/lightnvm.h>
#include <linux/vmalloc.h>

enum nvme_nvm_admin_opcode {
	nvme_nvm_admin_identity		= 0xe2,
	nvme_nvm_admin_get_l2p_tbl	= 0xea,
	nvme_nvm_admin_get_bb_tbl	= 0xf2,
	nvme_nvm_admin_set_bb_tbl	= 0xf1,
};

struct nvme_nvm_hb_rw {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__le32			nsid;
	__u64			rsvd2;
	__le64			metadata;
	__le64			prp1;
	__le64			prp2;
	__le64			spba;
	__le16			length;
	__le16			control;
	__le32			dsmgmt;
	__le64			slba;
};

struct nvme_nvm_ph_rw {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__le32			nsid;
	__u64			rsvd2;
	__le64			metadata;
	__le64			prp1;
	__le64			prp2;
	__le64			spba;
	__le16			length;
	__le16			control;
	__le32			dsmgmt;
	__le64			resv;
};

struct nvme_nvm_identity {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__le32			nsid;
	__u64			rsvd[2];
	__le64			prp1;
	__le64			prp2;
	__le32			chnl_off;
	__u32			rsvd11[5];
};

struct nvme_nvm_l2ptbl {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__le32			nsid;
	__le32			cdw2[4];
	__le64			prp1;
	__le64			prp2;
	__le64			slba;
	__le32			nlb;
	__le16			cdw14[6];
};

struct nvme_nvm_getbbtbl {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__le32			nsid;
	__u64			rsvd[2];
	__le64			prp1;
	__le64			prp2;
	__le64			spba;
	__u32			rsvd4[4];
};

struct nvme_nvm_setbbtbl {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__le32			nsid;
	__le64			rsvd[2];
	__le64			prp1;
	__le64			prp2;
	__le64			spba;
	__le16			nlb;
	__u8			value;
	__u8			rsvd3;
	__u32			rsvd4[3];
};

struct nvme_nvm_erase_blk {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__le32			nsid;
	__u64			rsvd[2];
	__le64			prp1;
	__le64			prp2;
	__le64			spba;
	__le16			length;
	__le16			control;
	__le32			dsmgmt;
	__le64			resv;
};

struct nvme_nvm_command {
	union {
		struct nvme_common_command common;
		struct nvme_nvm_identity identity;
		struct nvme_nvm_hb_rw hb_rw;
		struct nvme_nvm_ph_rw ph_rw;
		struct nvme_nvm_l2ptbl l2p;
		struct nvme_nvm_getbbtbl get_bb;
		struct nvme_nvm_setbbtbl set_bb;
		struct nvme_nvm_erase_blk erase;
	};
};

struct nvme_nvm_id_group {
	__u8			mtype;
	__u8			fmtype;
	__le16			res16;
	__u8			num_ch;
	__u8			num_lun;
	__u8			num_pln;
	__u8			rsvd1;
	__le16			num_blk;
	__le16			num_pg;
	__le16			fpg_sz;
	__le16			csecs;
	__le16			sos;
	__le16			rsvd2;
	__le32			trdt;
	__le32			trdm;
	__le32			tprt;
	__le32			tprm;
	__le32			tbet;
	__le32			tbem;
	__le32			mpos;
	__le32			mccap;
	__le16			cpar;
	__u8			reserved[906];
} __packed;

struct nvme_nvm_addr_format {
	__u8			ch_offset;
	__u8			ch_len;
	__u8			lun_offset;
	__u8			lun_len;
	__u8			pln_offset;
	__u8			pln_len;
	__u8			blk_offset;
	__u8			blk_len;
	__u8			pg_offset;
	__u8			pg_len;
	__u8			sect_offset;
	__u8			sect_len;
	__u8			res[4];
} __packed;

struct nvme_nvm_id {
	__u8			ver_id;
	__u8			vmnt;
	__u8			cgrps;
	__u8			res;
	__le32			cap;
	__le32			dom;
	struct nvme_nvm_addr_format ppaf;
	__u8			resv[228];
	struct nvme_nvm_id_group groups[4];
} __packed;

struct nvme_nvm_bb_tbl {
	__u8	tblid[4];
	__le16	verid;
	__le16	revid;
	__le32	rvsd1;
	__le32	tblks;
	__le32	tfact;
	__le32	tgrown;
	__le32	tdresv;
	__le32	thresv;
	__le32	rsvd2[8];
	__u8	blk[0];
};

/*
 * Check we didn't inadvertently grow the command struct
 */
static inline void _nvme_nvm_check_size(void)
{
	BUILD_BUG_ON(sizeof(struct nvme_nvm_identity) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_nvm_hb_rw) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_nvm_ph_rw) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_nvm_getbbtbl) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_nvm_setbbtbl) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_nvm_l2ptbl) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_nvm_erase_blk) != 64);
	BUILD_BUG_ON(sizeof(struct nvme_nvm_id_group) != 960);
	BUILD_BUG_ON(sizeof(struct nvme_nvm_addr_format) != 128);
	BUILD_BUG_ON(sizeof(struct nvme_nvm_id) != 4096);
	BUILD_BUG_ON(sizeof(struct nvme_nvm_bb_tbl) != 512);
}

static int init_grps(struct nvm_id *nvm_id, struct nvme_nvm_id *nvme_nvm_id)
{
	struct nvme_nvm_id_group *src;
	struct nvm_id_group *dst;
	int i, end;

	end = min_t(u32, 4, nvm_id->cgrps);

	for (i = 0; i < end; i++) {
		src = &nvme_nvm_id->groups[i];
		dst = &nvm_id->groups[i];

		dst->mtype = src->mtype;
		dst->fmtype = src->fmtype;
		dst->num_ch = src->num_ch;
		dst->num_lun = src->num_lun;
		dst->num_pln = src->num_pln;

		dst->num_pg = le16_to_cpu(src->num_pg);
		dst->num_blk = le16_to_cpu(src->num_blk);
		dst->fpg_sz = le16_to_cpu(src->fpg_sz);
		dst->csecs = le16_to_cpu(src->csecs);
		dst->sos = le16_to_cpu(src->sos);

		dst->trdt = le32_to_cpu(src->trdt);
		dst->trdm = le32_to_cpu(src->trdm);
		dst->tprt = le32_to_cpu(src->tprt);
		dst->tprm = le32_to_cpu(src->tprm);
		dst->tbet = le32_to_cpu(src->tbet);
		dst->tbem = le32_to_cpu(src->tbem);
		dst->mpos = le32_to_cpu(src->mpos);
		dst->mccap = le32_to_cpu(src->mccap);

		dst->cpar = le16_to_cpu(src->cpar);
	}

	return 0;
}

static int nvme_nvm_identity(struct nvm_dev *nvmdev, struct nvm_id *nvm_id)
{
	struct nvme_ns *ns = nvmdev->q->queuedata;
	struct nvme_dev *dev = ns->dev;
	struct nvme_nvm_id *nvme_nvm_id;
	struct nvme_nvm_command c = {};
	int ret;

	c.identity.opcode = nvme_nvm_admin_identity;
	c.identity.nsid = cpu_to_le32(ns->ns_id);
	c.identity.chnl_off = 0;

	nvme_nvm_id = kmalloc(sizeof(struct nvme_nvm_id), GFP_KERNEL);
	if (!nvme_nvm_id)
		return -ENOMEM;

	ret = nvme_submit_sync_cmd(dev->admin_q, (struct nvme_command *)&c,
				nvme_nvm_id, sizeof(struct nvme_nvm_id));
	if (ret) {
		ret = -EIO;
		goto out;
	}

	nvm_id->ver_id = nvme_nvm_id->ver_id;
	nvm_id->vmnt = nvme_nvm_id->vmnt;
	nvm_id->cgrps = nvme_nvm_id->cgrps;
	nvm_id->cap = le32_to_cpu(nvme_nvm_id->cap);
	nvm_id->dom = le32_to_cpu(nvme_nvm_id->dom);
	memcpy(&nvm_id->ppaf, &nvme_nvm_id->ppaf,
					sizeof(struct nvme_nvm_addr_format));

	ret = init_grps(nvm_id, nvme_nvm_id);
out:
	kfree(nvme_nvm_id);
	return ret;
}

static int nvme_nvm_get_l2p_tbl(struct nvm_dev *nvmdev, u64 slba, u32 nlb,
				nvm_l2p_update_fn *update_l2p, void *priv)
{
	struct nvme_ns *ns = nvmdev->q->queuedata;
	struct nvme_dev *dev = ns->dev;
	struct nvme_nvm_command c = {};
	u32 len = queue_max_hw_sectors(dev->admin_q) << 9;
	u32 nlb_pr_rq = len / sizeof(u64);
	u64 cmd_slba = slba;
	void *entries;
	int ret = 0;

	c.l2p.opcode = nvme_nvm_admin_get_l2p_tbl;
	c.l2p.nsid = cpu_to_le32(ns->ns_id);
	entries = kmalloc(len, GFP_KERNEL);
	if (!entries)
		return -ENOMEM;

	while (nlb) {
		u32 cmd_nlb = min(nlb_pr_rq, nlb);

		c.l2p.slba = cpu_to_le64(cmd_slba);
		c.l2p.nlb = cpu_to_le32(cmd_nlb);

		ret = nvme_submit_sync_cmd(dev->admin_q,
				(struct nvme_command *)&c, entries, len);
		if (ret) {
			dev_err(dev->dev, "L2P table transfer failed (%d)\n",
									ret);
			ret = -EIO;
			goto out;
		}

		if (update_l2p(cmd_slba, cmd_nlb, entries, priv)) {
			ret = -EINTR;
			goto out;
		}

		cmd_slba += cmd_nlb;
		nlb -= cmd_nlb;
	}

out:
	kfree(entries);
	return ret;
}

static int nvme_nvm_get_bb_tbl(struct nvm_dev *nvmdev, struct ppa_addr ppa,
				int nr_blocks, nvm_bb_update_fn *update_bbtbl,
				void *priv)
{
	struct request_queue *q = nvmdev->q;
	struct nvme_ns *ns = q->queuedata;
	struct nvme_dev *dev = ns->dev;
	struct nvme_nvm_command c = {};
	struct nvme_nvm_bb_tbl *bb_tbl;
	int tblsz = sizeof(struct nvme_nvm_bb_tbl) + nr_blocks;
	int ret = 0;

	c.get_bb.opcode = nvme_nvm_admin_get_bb_tbl;
	c.get_bb.nsid = cpu_to_le32(ns->ns_id);
	c.get_bb.spba = cpu_to_le64(ppa.ppa);

	bb_tbl = kzalloc(tblsz, GFP_KERNEL);
	if (!bb_tbl)
		return -ENOMEM;

	ret = nvme_submit_sync_cmd(dev->admin_q, (struct nvme_command *)&c,
								bb_tbl, tblsz);
	if (ret) {
		dev_err(dev->dev, "get bad block table failed (%d)\n", ret);
		ret = -EIO;
		goto out;
	}

	if (bb_tbl->tblid[0] != 'B' || bb_tbl->tblid[1] != 'B' ||
		bb_tbl->tblid[2] != 'L' || bb_tbl->tblid[3] != 'T') {
		dev_err(dev->dev, "bbt format mismatch\n");
		ret = -EINVAL;
		goto out;
	}

	if (le16_to_cpu(bb_tbl->verid) != 1) {
		ret = -EINVAL;
		dev_err(dev->dev, "bbt version not supported\n");
		goto out;
	}

	if (le32_to_cpu(bb_tbl->tblks) != nr_blocks) {
		ret = -EINVAL;
		dev_err(dev->dev, "bbt unsuspected blocks returned (%u!=%u)",
					le32_to_cpu(bb_tbl->tblks), nr_blocks);
		goto out;
	}

	ppa = dev_to_generic_addr(nvmdev, ppa);
	ret = update_bbtbl(ppa, nr_blocks, bb_tbl->blk, priv);
out:
	kfree(bb_tbl);
	return ret;
}

static int nvme_nvm_set_bb_tbl(struct nvm_dev *nvmdev, struct nvm_rq *rqd,
								int type)
{
	struct nvme_ns *ns = nvmdev->q->queuedata;
	struct nvme_dev *dev = ns->dev;
	struct nvme_nvm_command c = {};
	int ret = 0;

	c.set_bb.opcode = nvme_nvm_admin_set_bb_tbl;
	c.set_bb.nsid = cpu_to_le32(ns->ns_id);
	c.set_bb.spba = cpu_to_le64(rqd->ppa_addr.ppa);
	c.set_bb.nlb = cpu_to_le16(rqd->nr_pages - 1);
	c.set_bb.value = type;

	ret = nvme_submit_sync_cmd(dev->admin_q, (struct nvme_command *)&c,
								NULL, 0);
	if (ret)
		dev_err(dev->dev, "set bad block table failed (%d)\n", ret);
	return ret;
}

static inline void nvme_nvm_rqtocmd(struct request *rq, struct nvm_rq *rqd,
				struct nvme_ns *ns, struct nvme_nvm_command *c)
{
	c->ph_rw.opcode = rqd->opcode;
	c->ph_rw.nsid = cpu_to_le32(ns->ns_id);
	c->ph_rw.spba = cpu_to_le64(rqd->ppa_addr.ppa);
	c->ph_rw.control = cpu_to_le16(rqd->flags);
	c->ph_rw.length = cpu_to_le16(rqd->nr_pages - 1);

	if (rqd->opcode == NVM_OP_HBWRITE || rqd->opcode == NVM_OP_HBREAD)
		c->hb_rw.slba = cpu_to_le64(nvme_block_nr(ns,
						rqd->bio->bi_iter.bi_sector));
}

static void nvme_nvm_end_io(struct request *rq, int error)
{
	struct nvm_rq *rqd = rq->end_io_data;

	nvm_end_io(rqd, error);

	kfree(rq->cmd);
	blk_mq_free_request(rq);
}

static int nvme_nvm_submit_io(struct nvm_dev *dev, struct nvm_rq *rqd)
{
	struct request_queue *q = dev->q;
	struct nvme_ns *ns = q->queuedata;
	struct request *rq;
	struct bio *bio = rqd->bio;
	struct nvme_nvm_command *cmd;

	rq = blk_mq_alloc_request(q, bio_rw(bio), GFP_KERNEL, 0);
	if (IS_ERR(rq))
		return -ENOMEM;

	cmd = kzalloc(sizeof(struct nvme_nvm_command), GFP_KERNEL);
	if (!cmd) {
		blk_mq_free_request(rq);
		return -ENOMEM;
	}

	rq->cmd_type = REQ_TYPE_DRV_PRIV;
	rq->ioprio = bio_prio(bio);

	if (bio_has_data(bio))
		rq->nr_phys_segments = bio_phys_segments(q, bio);

	rq->__data_len = bio->bi_iter.bi_size;
	rq->bio = rq->biotail = bio;

	nvme_nvm_rqtocmd(rq, rqd, ns, cmd);

	rq->cmd = (unsigned char *)cmd;
	rq->cmd_len = sizeof(struct nvme_nvm_command);
	rq->special = (void *)0;

	rq->end_io_data = rqd;

	blk_execute_rq_nowait(q, NULL, rq, 0, nvme_nvm_end_io);

	return 0;
}

static int nvme_nvm_erase_block(struct nvm_dev *dev, struct nvm_rq *rqd)
{
	struct request_queue *q = dev->q;
	struct nvme_ns *ns = q->queuedata;
	struct nvme_nvm_command c = {};

	c.erase.opcode = NVM_OP_ERASE;
	c.erase.nsid = cpu_to_le32(ns->ns_id);
	c.erase.spba = cpu_to_le64(rqd->ppa_addr.ppa);
	c.erase.length = cpu_to_le16(rqd->nr_pages - 1);

	return nvme_submit_sync_cmd(q, (struct nvme_command *)&c, NULL, 0);
}

static void *nvme_nvm_create_dma_pool(struct nvm_dev *nvmdev, char *name)
{
	struct nvme_ns *ns = nvmdev->q->queuedata;
	struct nvme_dev *dev = ns->dev;

	return dma_pool_create(name, dev->dev, PAGE_SIZE, PAGE_SIZE, 0);
}

static void nvme_nvm_destroy_dma_pool(void *pool)
{
	struct dma_pool *dma_pool = pool;

	dma_pool_destroy(dma_pool);
}

static void *nvme_nvm_dev_dma_alloc(struct nvm_dev *dev, void *pool,
				    gfp_t mem_flags, dma_addr_t *dma_handler)
{
	return dma_pool_alloc(pool, mem_flags, dma_handler);
}

static void nvme_nvm_dev_dma_free(void *pool, void *ppa_list,
							dma_addr_t dma_handler)
{
	dma_pool_free(pool, ppa_list, dma_handler);
}

static struct nvm_dev_ops nvme_nvm_dev_ops = {
	.identity		= nvme_nvm_identity,

	.get_l2p_tbl		= nvme_nvm_get_l2p_tbl,

	.get_bb_tbl		= nvme_nvm_get_bb_tbl,
	.set_bb_tbl		= nvme_nvm_set_bb_tbl,

	.submit_io		= nvme_nvm_submit_io,
	.erase_block		= nvme_nvm_erase_block,

	.create_dma_pool	= nvme_nvm_create_dma_pool,
	.destroy_dma_pool	= nvme_nvm_destroy_dma_pool,
	.dev_dma_alloc		= nvme_nvm_dev_dma_alloc,
	.dev_dma_free		= nvme_nvm_dev_dma_free,

	.max_phys_sect		= 64,
};

int nvme_nvm_register(struct request_queue *q, char *disk_name)
{
	return nvm_register(q, disk_name, &nvme_nvm_dev_ops);
}

void nvme_nvm_unregister(struct request_queue *q, char *disk_name)
{
	nvm_unregister(disk_name);
}

/* move to shared place when used in multiple places. */
#define PCI_VENDOR_ID_CNEX 0x1d1d
#define PCI_DEVICE_ID_CNEX_WL 0x2807
#define PCI_DEVICE_ID_CNEX_QEMU 0x1f1f

int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id)
{
	struct nvme_dev *dev = ns->dev;
	struct pci_dev *pdev = to_pci_dev(dev->dev);

	/* QEMU NVMe simulator - PCI ID + Vendor specific bit */
	if (pdev->vendor == PCI_VENDOR_ID_CNEX &&
				pdev->device == PCI_DEVICE_ID_CNEX_QEMU &&
							id->vs[0] == 0x1)
		return 1;

	/* CNEX Labs - PCI ID + Vendor specific bit */
	if (pdev->vendor == PCI_VENDOR_ID_CNEX &&
				pdev->device == PCI_DEVICE_ID_CNEX_WL &&
							id->vs[0] == 0x1)
		return 1;

	return 0;
}
Commit	Line	Data
ca064085 MB	1	/*
	2	* nvme-lightnvm.c - LightNVM NVMe device
	3	*
	4	* Copyright (C) 2014-2015 IT University of Copenhagen
	5	* Initial release: Matias Bjorling <mb@lightnvm.io>
	6	*
	7	* This program is free software; you can redistribute it and/or
	8	* modify it under the terms of the GNU General Public License version
	9	* 2 as published by the Free Software Foundation.
	10	*
	11	* This program is distributed in the hope that it will be useful, but
	12	* WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	14	* General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; see the file COPYING. If not, write to
	18	* the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
	19	* USA.
	20	*
	21	*/
	22
	23	#include "nvme.h"
	24
ca064085 MB	25	#include <linux/nvme.h>
	26	#include <linux/bitops.h>
	27	#include <linux/lightnvm.h>
	28	#include <linux/vmalloc.h>
	29
	30	enum nvme_nvm_admin_opcode {
	31	nvme_nvm_admin_identity = 0xe2,
	32	nvme_nvm_admin_get_l2p_tbl = 0xea,
	33	nvme_nvm_admin_get_bb_tbl = 0xf2,
	34	nvme_nvm_admin_set_bb_tbl = 0xf1,
	35	};
	36
	37	struct nvme_nvm_hb_rw {
	38	__u8 opcode;
	39	__u8 flags;
	40	__u16 command_id;
	41	__le32 nsid;
	42	__u64 rsvd2;
	43	__le64 metadata;
	44	__le64 prp1;
	45	__le64 prp2;
	46	__le64 spba;
	47	__le16 length;
	48	__le16 control;
	49	__le32 dsmgmt;
	50	__le64 slba;
	51	};
	52
	53	struct nvme_nvm_ph_rw {
	54	__u8 opcode;
	55	__u8 flags;
	56	__u16 command_id;
	57	__le32 nsid;
	58	__u64 rsvd2;
	59	__le64 metadata;
	60	__le64 prp1;
	61	__le64 prp2;
	62	__le64 spba;
	63	__le16 length;
	64	__le16 control;
	65	__le32 dsmgmt;
	66	__le64 resv;
	67	};
	68
	69	struct nvme_nvm_identity {
	70	__u8 opcode;
	71	__u8 flags;
	72	__u16 command_id;
	73	__le32 nsid;
	74	__u64 rsvd[2];
	75	__le64 prp1;
	76	__le64 prp2;
	77	__le32 chnl_off;
	78	__u32 rsvd11[5];
	79	};
	80
	81	struct nvme_nvm_l2ptbl {
	82	__u8 opcode;
	83	__u8 flags;
	84	__u16 command_id;
	85	__le32 nsid;
	86	__le32 cdw2[4];
	87	__le64 prp1;
	88	__le64 prp2;
89	__le64 slba;
90	__le32 nlb;
91	__le16 cdw14[6];
92	};
93
11450469	94	struct nvme_nvm_getbbtbl {
ca064085 MB	95	__u8 opcode;
	96	__u8 flags;
	97	__u16 command_id;
	98	__le32 nsid;
	99	__u64 rsvd[2];
	100	__le64 prp1;
	101	__le64 prp2;
11450469 MB	102	__le64 spba;
	103	__u32 rsvd4[4];
	104	};
	105
	106	struct nvme_nvm_setbbtbl {
	107	__u8 opcode;
	108	__u8 flags;
	109	__u16 command_id;
	110	__le32 nsid;
	111	__le64 rsvd[2];
	112	__le64 prp1;
	113	__le64 prp2;
	114	__le64 spba;
	115	__le16 nlb;
	116	__u8 value;
	117	__u8 rsvd3;
	118	__u32 rsvd4[3];
ca064085 MB	119	};
	120
	121	struct nvme_nvm_erase_blk {
	122	__u8 opcode;
	123	__u8 flags;
	124	__u16 command_id;
	125	__le32 nsid;
	126	__u64 rsvd[2];
	127	__le64 prp1;
	128	__le64 prp2;
	129	__le64 spba;
	130	__le16 length;
	131	__le16 control;
	132	__le32 dsmgmt;
	133	__le64 resv;
	134	};
	135
	136	struct nvme_nvm_command {
	137	union {
	138	struct nvme_common_command common;
	139	struct nvme_nvm_identity identity;
	140	struct nvme_nvm_hb_rw hb_rw;
	141	struct nvme_nvm_ph_rw ph_rw;
	142	struct nvme_nvm_l2ptbl l2p;
11450469 MB	143	struct nvme_nvm_getbbtbl get_bb;
11450469 MB	144	struct nvme_nvm_setbbtbl set_bb;
ca064085 MB	145	struct nvme_nvm_erase_blk erase;
	146	};
	147	};
	148
	149	struct nvme_nvm_id_group {
	150	__u8 mtype;
	151	__u8 fmtype;
	152	__le16 res16;
	153	__u8 num_ch;
	154	__u8 num_lun;
	155	__u8 num_pln;
36d5dbc6	156	__u8 rsvd1;
ca064085 MB	157	__le16 num_blk;
	158	__le16 num_pg;
	159	__le16 fpg_sz;
	160	__le16 csecs;
	161	__le16 sos;
36d5dbc6	162	__le16 rsvd2;
ca064085 MB	163	__le32 trdt;
	164	__le32 trdm;
	165	__le32 tprt;
	166	__le32 tprm;
	167	__le32 tbet;
	168	__le32 tbem;
	169	__le32 mpos;
12be5edf	170	__le32 mccap;
ca064085	171	__le16 cpar;
12be5edf	172	__u8 reserved[906];
ca064085 MB	173	} __packed;
	174
	175	struct nvme_nvm_addr_format {
	176	__u8 ch_offset;
	177	__u8 ch_len;
	178	__u8 lun_offset;
	179	__u8 lun_len;
	180	__u8 pln_offset;
	181	__u8 pln_len;
	182	__u8 blk_offset;
	183	__u8 blk_len;
	184	__u8 pg_offset;
	185	__u8 pg_len;
	186	__u8 sect_offset;
	187	__u8 sect_len;
	188	__u8 res[4];
	189	} __packed;
	190
	191	struct nvme_nvm_id {
	192	__u8 ver_id;
	193	__u8 vmnt;
	194	__u8 cgrps;
dad1b009	195	__u8 res;
ca064085 MB	196	__le32 cap;
	197	__le32 dom;
	198	struct nvme_nvm_addr_format ppaf;
dad1b009	199	__u8 resv[228];
ca064085 MB	200	struct nvme_nvm_id_group groups[4];
	201	} __packed;
	202
11450469 MB	203	struct nvme_nvm_bb_tbl {
	204	__u8 tblid[4];
	205	__le16 verid;
	206	__le16 revid;
	207	__le32 rvsd1;
	208	__le32 tblks;
	209	__le32 tfact;
	210	__le32 tgrown;
	211	__le32 tdresv;
	212	__le32 thresv;
	213	__le32 rsvd2[8];
	214	__u8 blk[0];
	215	};
	216
ca064085 MB	217	/*
	218	* Check we didn't inadvertently grow the command struct
	219	*/
	220	static inline void _nvme_nvm_check_size(void)
	221	{
	222	BUILD_BUG_ON(sizeof(struct nvme_nvm_identity) != 64);
	223	BUILD_BUG_ON(sizeof(struct nvme_nvm_hb_rw) != 64);
	224	BUILD_BUG_ON(sizeof(struct nvme_nvm_ph_rw) != 64);
11450469 MB	225	BUILD_BUG_ON(sizeof(struct nvme_nvm_getbbtbl) != 64);
11450469 MB	226	BUILD_BUG_ON(sizeof(struct nvme_nvm_setbbtbl) != 64);
ca064085 MB	227	BUILD_BUG_ON(sizeof(struct nvme_nvm_l2ptbl) != 64);
	228	BUILD_BUG_ON(sizeof(struct nvme_nvm_erase_blk) != 64);
	229	BUILD_BUG_ON(sizeof(struct nvme_nvm_id_group) != 960);
	230	BUILD_BUG_ON(sizeof(struct nvme_nvm_addr_format) != 128);
	231	BUILD_BUG_ON(sizeof(struct nvme_nvm_id) != 4096);
11450469	232	BUILD_BUG_ON(sizeof(struct nvme_nvm_bb_tbl) != 512);
ca064085 MB	233	}
	234
	235	static int init_grps(struct nvm_id nvm_id, struct nvme_nvm_id nvme_nvm_id)
	236	{
	237	struct nvme_nvm_id_group *src;
	238	struct nvm_id_group *dst;
	239	int i, end;
	240
	241	end = min_t(u32, 4, nvm_id->cgrps);
	242
	243	for (i = 0; i < end; i++) {
	244	src = &nvme_nvm_id->groups[i];
	245	dst = &nvm_id->groups[i];
	246
	247	dst->mtype = src->mtype;
	248	dst->fmtype = src->fmtype;
	249	dst->num_ch = src->num_ch;
	250	dst->num_lun = src->num_lun;
	251	dst->num_pln = src->num_pln;
	252
	253	dst->num_pg = le16_to_cpu(src->num_pg);
	254	dst->num_blk = le16_to_cpu(src->num_blk);
	255	dst->fpg_sz = le16_to_cpu(src->fpg_sz);
	256	dst->csecs = le16_to_cpu(src->csecs);
	257	dst->sos = le16_to_cpu(src->sos);
	258
	259	dst->trdt = le32_to_cpu(src->trdt);
	260	dst->trdm = le32_to_cpu(src->trdm);
	261	dst->tprt = le32_to_cpu(src->tprt);
	262	dst->tprm = le32_to_cpu(src->tprm);
	263	dst->tbet = le32_to_cpu(src->tbet);
	264	dst->tbem = le32_to_cpu(src->tbem);
	265	dst->mpos = le32_to_cpu(src->mpos);
12be5edf	266	dst->mccap = le32_to_cpu(src->mccap);
ca064085 MB	267
	268	dst->cpar = le16_to_cpu(src->cpar);
	269	}
	270
	271	return 0;
	272	}
	273
16f26c3a	274	static int nvme_nvm_identity(struct nvm_dev nvmdev, struct nvm_id nvm_id)
ca064085	275	{
16f26c3a	276	struct nvme_ns *ns = nvmdev->q->queuedata;
47b3115a	277	struct nvme_dev *dev = ns->dev;
ca064085 MB	278	struct nvme_nvm_id *nvme_nvm_id;
	279	struct nvme_nvm_command c = {};
	280	int ret;
	281
	282	c.identity.opcode = nvme_nvm_admin_identity;
	283	c.identity.nsid = cpu_to_le32(ns->ns_id);
	284	c.identity.chnl_off = 0;
	285
	286	nvme_nvm_id = kmalloc(sizeof(struct nvme_nvm_id), GFP_KERNEL);
	287	if (!nvme_nvm_id)
	288	return -ENOMEM;
	289
47b3115a WT	290	ret = nvme_submit_sync_cmd(dev->admin_q, (struct nvme_command *)&c,
47b3115a WT	291	nvme_nvm_id, sizeof(struct nvme_nvm_id));
ca064085 MB	292	if (ret) {
	293	ret = -EIO;
	294	goto out;
	295	}
	296
	297	nvm_id->ver_id = nvme_nvm_id->ver_id;
	298	nvm_id->vmnt = nvme_nvm_id->vmnt;
	299	nvm_id->cgrps = nvme_nvm_id->cgrps;
	300	nvm_id->cap = le32_to_cpu(nvme_nvm_id->cap);
	301	nvm_id->dom = le32_to_cpu(nvme_nvm_id->dom);
2393bd39 MB	302	memcpy(&nvm_id->ppaf, &nvme_nvm_id->ppaf,
2393bd39 MB	303	sizeof(struct nvme_nvm_addr_format));
ca064085 MB	304
	305	ret = init_grps(nvm_id, nvme_nvm_id);
	306	out:
	307	kfree(nvme_nvm_id);
	308	return ret;
	309	}
	310
16f26c3a	311	static int nvme_nvm_get_l2p_tbl(struct nvm_dev *nvmdev, u64 slba, u32 nlb,
ca064085 MB	312	nvm_l2p_update_fn update_l2p, void priv)
ca064085 MB	313	{
16f26c3a	314	struct nvme_ns *ns = nvmdev->q->queuedata;
ca064085 MB	315	struct nvme_dev *dev = ns->dev;
ca064085 MB	316	struct nvme_nvm_command c = {};
47b3115a	317	u32 len = queue_max_hw_sectors(dev->admin_q) << 9;
5f436e5e	318	u32 nlb_pr_rq = len / sizeof(u64);
ca064085 MB	319	u64 cmd_slba = slba;
	320	void *entries;
	321	int ret = 0;
	322
	323	c.l2p.opcode = nvme_nvm_admin_get_l2p_tbl;
	324	c.l2p.nsid = cpu_to_le32(ns->ns_id);
	325	entries = kmalloc(len, GFP_KERNEL);
	326	if (!entries)
	327	return -ENOMEM;
	328
	329	while (nlb) {
5f436e5e	330	u32 cmd_nlb = min(nlb_pr_rq, nlb);
ca064085 MB	331
	332	c.l2p.slba = cpu_to_le64(cmd_slba);
	333	c.l2p.nlb = cpu_to_le32(cmd_nlb);
	334
47b3115a WT	335	ret = nvme_submit_sync_cmd(dev->admin_q,
47b3115a WT	336	(struct nvme_command *)&c, entries, len);
ca064085 MB	337	if (ret) {
	338	dev_err(dev->dev, "L2P table transfer failed (%d)\n",
	339	ret);
	340	ret = -EIO;
	341	goto out;
	342	}
	343
	344	if (update_l2p(cmd_slba, cmd_nlb, entries, priv)) {
	345	ret = -EINTR;
	346	goto out;
	347	}
	348
	349	cmd_slba += cmd_nlb;
	350	nlb -= cmd_nlb;
	351	}
	352
	353	out:
	354	kfree(entries);
	355	return ret;
	356	}
	357
08236c6b	358	static int nvme_nvm_get_bb_tbl(struct nvm_dev *nvmdev, struct ppa_addr ppa,
11450469 MB	359	int nr_blocks, nvm_bb_update_fn *update_bbtbl,
11450469 MB	360	void *priv)
ca064085	361	{
08236c6b	362	struct request_queue *q = nvmdev->q;
ca064085 MB	363	struct nvme_ns *ns = q->queuedata;
	364	struct nvme_dev *dev = ns->dev;
	365	struct nvme_nvm_command c = {};
11450469 MB	366	struct nvme_nvm_bb_tbl *bb_tbl;
11450469 MB	367	int tblsz = sizeof(struct nvme_nvm_bb_tbl) + nr_blocks;
ca064085 MB	368	int ret = 0;
	369
	370	c.get_bb.opcode = nvme_nvm_admin_get_bb_tbl;
	371	c.get_bb.nsid = cpu_to_le32(ns->ns_id);
11450469	372	c.get_bb.spba = cpu_to_le64(ppa.ppa);
ca064085	373
11450469 MB	374	bb_tbl = kzalloc(tblsz, GFP_KERNEL);
	375	if (!bb_tbl)
	376	return -ENOMEM;
ca064085	377
47b3115a WT	378	ret = nvme_submit_sync_cmd(dev->admin_q, (struct nvme_command *)&c,
47b3115a WT	379	bb_tbl, tblsz);
ca064085 MB	380	if (ret) {
	381	dev_err(dev->dev, "get bad block table failed (%d)\n", ret);
	382	ret = -EIO;
	383	goto out;
	384	}
	385
11450469 MB	386	if (bb_tbl->tblid[0] != 'B' \|\| bb_tbl->tblid[1] != 'B' \|\|
	387	bb_tbl->tblid[2] != 'L' \|\| bb_tbl->tblid[3] != 'T') {
	388	dev_err(dev->dev, "bbt format mismatch\n");
	389	ret = -EINVAL;
	390	goto out;
	391	}
	392
	393	if (le16_to_cpu(bb_tbl->verid) != 1) {
	394	ret = -EINVAL;
	395	dev_err(dev->dev, "bbt version not supported\n");
	396	goto out;
	397	}
	398
	399	if (le32_to_cpu(bb_tbl->tblks) != nr_blocks) {
	400	ret = -EINVAL;
	401	dev_err(dev->dev, "bbt unsuspected blocks returned (%u!=%u)",
	402	le32_to_cpu(bb_tbl->tblks), nr_blocks);
	403	goto out;
	404	}
	405
08236c6b	406	ppa = dev_to_generic_addr(nvmdev, ppa);
11450469	407	ret = update_bbtbl(ppa, nr_blocks, bb_tbl->blk, priv);
ca064085	408	out:
11450469 MB	409	kfree(bb_tbl);
	410	return ret;
	411	}
	412
16f26c3a	413	static int nvme_nvm_set_bb_tbl(struct nvm_dev nvmdev, struct nvm_rq rqd,
11450469 MB	414	int type)
11450469 MB	415	{
16f26c3a	416	struct nvme_ns *ns = nvmdev->q->queuedata;
11450469 MB	417	struct nvme_dev *dev = ns->dev;
	418	struct nvme_nvm_command c = {};
	419	int ret = 0;
	420
	421	c.set_bb.opcode = nvme_nvm_admin_set_bb_tbl;
	422	c.set_bb.nsid = cpu_to_le32(ns->ns_id);
	423	c.set_bb.spba = cpu_to_le64(rqd->ppa_addr.ppa);
	424	c.set_bb.nlb = cpu_to_le16(rqd->nr_pages - 1);
	425	c.set_bb.value = type;
	426
47b3115a WT	427	ret = nvme_submit_sync_cmd(dev->admin_q, (struct nvme_command *)&c,
47b3115a WT	428	NULL, 0);
11450469 MB	429	if (ret)
11450469 MB	430	dev_err(dev->dev, "set bad block table failed (%d)\n", ret);
ca064085 MB	431	return ret;
	432	}
	433
	434	static inline void nvme_nvm_rqtocmd(struct request rq, struct nvm_rq rqd,
	435	struct nvme_ns ns, struct nvme_nvm_command c)
	436	{
	437	c->ph_rw.opcode = rqd->opcode;
	438	c->ph_rw.nsid = cpu_to_le32(ns->ns_id);
	439	c->ph_rw.spba = cpu_to_le64(rqd->ppa_addr.ppa);
	440	c->ph_rw.control = cpu_to_le16(rqd->flags);
	441	c->ph_rw.length = cpu_to_le16(rqd->nr_pages - 1);
	442
	443	if (rqd->opcode == NVM_OP_HBWRITE \|\| rqd->opcode == NVM_OP_HBREAD)
	444	c->hb_rw.slba = cpu_to_le64(nvme_block_nr(ns,
	445	rqd->bio->bi_iter.bi_sector));
	446	}
	447
	448	static void nvme_nvm_end_io(struct request *rq, int error)
	449	{
	450	struct nvm_rq *rqd = rq->end_io_data;
ca064085	451
91276162	452	nvm_end_io(rqd, error);
ca064085 MB	453
	454	kfree(rq->cmd);
	455	blk_mq_free_request(rq);
	456	}
	457
16f26c3a	458	static int nvme_nvm_submit_io(struct nvm_dev dev, struct nvm_rq rqd)
ca064085	459	{
16f26c3a	460	struct request_queue *q = dev->q;
ca064085 MB	461	struct nvme_ns *ns = q->queuedata;
	462	struct request *rq;
	463	struct bio *bio = rqd->bio;
	464	struct nvme_nvm_command *cmd;
	465
	466	rq = blk_mq_alloc_request(q, bio_rw(bio), GFP_KERNEL, 0);
	467	if (IS_ERR(rq))
	468	return -ENOMEM;
	469
	470	cmd = kzalloc(sizeof(struct nvme_nvm_command), GFP_KERNEL);
	471	if (!cmd) {
	472	blk_mq_free_request(rq);
	473	return -ENOMEM;
	474	}
	475
	476	rq->cmd_type = REQ_TYPE_DRV_PRIV;
	477	rq->ioprio = bio_prio(bio);
	478
	479	if (bio_has_data(bio))
	480	rq->nr_phys_segments = bio_phys_segments(q, bio);
	481
	482	rq->__data_len = bio->bi_iter.bi_size;
	483	rq->bio = rq->biotail = bio;
	484
	485	nvme_nvm_rqtocmd(rq, rqd, ns, cmd);
	486
	487	rq->cmd = (unsigned char *)cmd;
	488	rq->cmd_len = sizeof(struct nvme_nvm_command);
	489	rq->special = (void *)0;
	490
	491	rq->end_io_data = rqd;
	492
	493	blk_execute_rq_nowait(q, NULL, rq, 0, nvme_nvm_end_io);
	494
	495	return 0;
	496	}
	497
16f26c3a	498	static int nvme_nvm_erase_block(struct nvm_dev dev, struct nvm_rq rqd)
ca064085	499	{
16f26c3a	500	struct request_queue *q = dev->q;
ca064085 MB	501	struct nvme_ns *ns = q->queuedata;
	502	struct nvme_nvm_command c = {};
	503
	504	c.erase.opcode = NVM_OP_ERASE;
	505	c.erase.nsid = cpu_to_le32(ns->ns_id);
	506	c.erase.spba = cpu_to_le64(rqd->ppa_addr.ppa);
	507	c.erase.length = cpu_to_le16(rqd->nr_pages - 1);
	508
	509	return nvme_submit_sync_cmd(q, (struct nvme_command *)&c, NULL, 0);
	510	}
	511
16f26c3a	512	static void nvme_nvm_create_dma_pool(struct nvm_dev nvmdev, char *name)
ca064085	513	{
16f26c3a	514	struct nvme_ns *ns = nvmdev->q->queuedata;
ca064085 MB	515	struct nvme_dev *dev = ns->dev;
	516
	517	return dma_pool_create(name, dev->dev, PAGE_SIZE, PAGE_SIZE, 0);
	518	}
	519
	520	static void nvme_nvm_destroy_dma_pool(void *pool)
	521	{
	522	struct dma_pool *dma_pool = pool;
	523
	524	dma_pool_destroy(dma_pool);
	525	}
	526
16f26c3a	527	static void nvme_nvm_dev_dma_alloc(struct nvm_dev dev, void *pool,
ca064085 MB	528	gfp_t mem_flags, dma_addr_t *dma_handler)
	529	{
	530	return dma_pool_alloc(pool, mem_flags, dma_handler);
	531	}
	532
	533	static void nvme_nvm_dev_dma_free(void pool, void ppa_list,
	534	dma_addr_t dma_handler)
	535	{
	536	dma_pool_free(pool, ppa_list, dma_handler);
	537	}
	538
	539	static struct nvm_dev_ops nvme_nvm_dev_ops = {
	540	.identity = nvme_nvm_identity,
	541
	542	.get_l2p_tbl = nvme_nvm_get_l2p_tbl,
	543
	544	.get_bb_tbl = nvme_nvm_get_bb_tbl,
11450469	545	.set_bb_tbl = nvme_nvm_set_bb_tbl,
ca064085 MB	546
	547	.submit_io = nvme_nvm_submit_io,
	548	.erase_block = nvme_nvm_erase_block,
	549
	550	.create_dma_pool = nvme_nvm_create_dma_pool,
	551	.destroy_dma_pool = nvme_nvm_destroy_dma_pool,
	552	.dev_dma_alloc = nvme_nvm_dev_dma_alloc,
	553	.dev_dma_free = nvme_nvm_dev_dma_free,
	554
	555	.max_phys_sect = 64,
	556	};
	557
	558	int nvme_nvm_register(struct request_queue q, char disk_name)
	559	{
	560	return nvm_register(q, disk_name, &nvme_nvm_dev_ops);
	561	}
	562
	563	void nvme_nvm_unregister(struct request_queue q, char disk_name)
	564	{
	565	nvm_unregister(disk_name);
	566	}
	567
09f2e716 MB	568	/* move to shared place when used in multiple places. */
	569	#define PCI_VENDOR_ID_CNEX 0x1d1d
	570	#define PCI_DEVICE_ID_CNEX_WL 0x2807
	571	#define PCI_DEVICE_ID_CNEX_QEMU 0x1f1f
	572
ca064085 MB	573	int nvme_nvm_ns_supported(struct nvme_ns ns, struct nvme_id_ns id)
	574	{
	575	struct nvme_dev *dev = ns->dev;
	576	struct pci_dev *pdev = to_pci_dev(dev->dev);
	577
	578	/* QEMU NVMe simulator - PCI ID + Vendor specific bit */
09f2e716 MB	579	if (pdev->vendor == PCI_VENDOR_ID_CNEX &&
09f2e716 MB	580	pdev->device == PCI_DEVICE_ID_CNEX_QEMU &&
ca064085 MB	581	id->vs[0] == 0x1)
	582	return 1;
	583
	584	/* CNEX Labs - PCI ID + Vendor specific bit */
09f2e716 MB	585	if (pdev->vendor == PCI_VENDOR_ID_CNEX &&
09f2e716 MB	586	pdev->device == PCI_DEVICE_ID_CNEX_WL &&
ca064085 MB	587	id->vs[0] == 0x1)
	588	return 1;
	589
	590	return 0;
	591	}