mi: Add initial Admin channel commands

This change adds Admin Channel commands, and the first admin channel
command to the MI transport: Identify. The admin functions have the
nvme_mi_admin_ prefix.

For this, we need a couple of definitions for Admin-Channel-over-MI
serialisation, and add individual admin commands using those.

Signed-off-by: Jeremy Kerr <[email protected]>

Author: jk-ozlabs

src/libnvme-mi.map

@@ -10,6 +10,9 @@ LIBNVME_MI_1_1 {
 		nvme_mi_mi_read_mi_data_ctrl_list;
 		nvme_mi_mi_read_mi_data_ctrl;
 		nvme_mi_mi_subsystem_health_status_poll;
+		nvme_mi_admin_identify_ctrl;
+		nvme_mi_admin_identify_ctrl_partial;
+		nvme_mi_admin_identify_ctrl_list;
 		nvme_mi_open_mctp;
 	local:
 		*;

src/nvme/mi.c

@@ -121,6 +121,104 @@ int nvme_mi_submit(nvme_mi_ep_t ep, struct nvme_mi_req *req,
 	return 0;
 }
 
+static void nvme_mi_admin_init_req(struct nvme_mi_req *req,
+				   struct nvme_mi_admin_req_hdr *hdr,
+				   __u16 ctrl_id, __u8 opcode)
+{
+	memset(req, 0, sizeof(*req));
+	memset(hdr, 0, sizeof(*hdr));
+
+	hdr->hdr.type = NVME_MI_MSGTYPE_NVME;
+	hdr->hdr.nmp = (NVME_MI_ROR_REQ << 7) |
+		(NVME_MI_MT_ADMIN << 3); /* we always use command slot 0 */
+	hdr->opcode = opcode;
+	hdr->ctrl_id = cpu_to_le16(ctrl_id);
+
+	req->hdr = &hdr->hdr;
+	req->hdr_len = sizeof(*hdr);
+}
+
+static void nvme_mi_admin_init_resp(struct nvme_mi_resp *resp,
+				    struct nvme_mi_admin_resp_hdr *hdr)
+{
+	memset(resp, 0, sizeof(*resp));
+	resp->hdr = &hdr->hdr;
+	resp->hdr_len = sizeof(*hdr);
+}
+
+static int nvme_mi_admin_identify(nvme_mi_ctrl_t ctrl,
+				  enum nvme_identify_cns cns,
+				  __u16 cid, __u16 nsid, void *id,
+				  off_t offset, size_t size)
+{
+	struct nvme_mi_admin_resp_hdr resp_hdr;
+	struct nvme_mi_admin_req_hdr req_hdr;
+	struct nvme_mi_resp resp;
+	struct nvme_mi_req req;
+	int rc;
+
+	if (!size || size > 0xffffffff)
+		return -EINVAL;
+
+	nvme_mi_admin_init_req(&req, &req_hdr, ctrl->id, nvme_admin_identify);
+	req_hdr.cdw10 = cpu_to_le16(cid) << 16 | cpu_to_le16(cns);
+	req_hdr.cdw11 = cpu_to_le16(nsid);
+	req_hdr.dlen = cpu_to_le32(size & 0xffffffff);
+	req_hdr.flags = 0x1;
+	if (offset) {
+		req_hdr.flags |= 0x2;
+		req_hdr.doff = offset;
+	}
+
+	nvme_mi_calc_req_mic(&req);
+
+	nvme_mi_admin_init_resp(&resp, &resp_hdr);
+	resp.data = id;
+	resp.data_len = size;
+
+	rc = nvme_mi_submit(ctrl->ep, &req, &resp);
+	if (rc)
+		return rc;
+
+	/* check status, map to return value */
+
+	return 0;
+}
+
+int nvme_mi_admin_identify_ctrl(nvme_mi_ctrl_t ctrl,
+				struct nvme_id_ctrl *id)
+{
+	return nvme_mi_admin_identify(ctrl, NVME_IDENTIFY_CNS_CTRL,
+				      0, 0, id, 0, sizeof(*id));
+}
+
+int nvme_mi_admin_identify_ctrl_partial(nvme_mi_ctrl_t ctrl,
+					struct nvme_id_ctrl *id,
+					off_t offset, size_t size)
+{
+	void *buf;
+
+	if (offset > sizeof(*id))
+		return -EINVAL;
+	if (size > sizeof(*id))
+		return -EINVAL;
+	if (offset + size > sizeof(*id))
+		return -EINVAL;
+
+	buf = id;
+	buf += offset;
+
+	return nvme_mi_admin_identify(ctrl, NVME_IDENTIFY_CNS_CTRL,
+				      0, 0, buf, offset, size);
+}
+
+int nvme_mi_admin_identify_ctrl_list(nvme_mi_ctrl_t ctrl,
+				     struct nvme_ctrl_list *ctrllist)
+{
+	return nvme_mi_admin_identify(ctrl, NVME_IDENTIFY_CNS_CTRL_LIST,
+					 0, 0, ctrllist, 0, sizeof(*ctrllist));
+}
+
 static int nvme_mi_read_data(nvme_mi_ep_t ep, __u32 cdw0,
 			     void *data, size_t *data_len)
 {

src/nvme/mi.h

@@ -68,6 +68,27 @@ enum nvme_mi_dtyp {
 	nvme_mi_dtyp_meb_support = 0x05,
 };
 
+/* Admin command definitions */
+
+struct nvme_mi_admin_req_hdr {
+	struct nvme_mi_msg_hdr hdr;
+	__u8	opcode;
+	__u8	flags;
+	__le16	ctrl_id;
+	__le32	cdw1, cdw2, cdw3, cdw4, cdw5;
+	__le32	doff;
+	__le32	dlen;
+	__le32	rsvd0, rsvd1;
+	__le32	cdw10, cdw11, cdw12, cdw13, cdw14, cdw15;
+} __attribute((packed));
+
+struct nvme_mi_admin_resp_hdr {
+	struct nvme_mi_msg_hdr hdr;
+	__u8	status;
+	__u8	rsvd0[3];
+	__le32	cdw0, cdw1, cdw3;
+} __attribute__((packed));
+
 /* MI Command API */
 
 /* library-level API object */
@@ -102,5 +123,13 @@ int nvme_mi_mi_read_mi_data_ctrl(nvme_mi_ep_t ep, __u16 ctrl_id,
 int nvme_mi_mi_subsystem_health_status_poll(nvme_mi_ep_t ep, bool clear,
 					    struct nvme_mi_nvm_ss_health_status *nshds);
 
+/* Admin channel functions */
+int nvme_mi_admin_identify_ctrl(nvme_mi_ctrl_t ctrl,
+				struct nvme_id_ctrl *id);
+int nvme_mi_admin_identify_ctrl_partial(nvme_mi_ctrl_t ctrl,
+					struct nvme_id_ctrl *id,
+					off_t offset, size_t size);
+int nvme_mi_admin_identify_ctrl_list(nvme_mi_ctrl_t ctrl,
+				     struct nvme_ctrl_list *ctrllist);
 
 #endif /* _LIBNVME_MI_MI_H */