1dd11376bSBart Van Assche // SPDX-License-Identifier: GPL-2.0
2dd11376bSBart Van Assche /*
3dd11376bSBart Van Assche * bsg endpoint that supports UPIUs
4dd11376bSBart Van Assche *
5dd11376bSBart Van Assche * Copyright (C) 2018 Western Digital Corporation
6dd11376bSBart Van Assche */
7dd11376bSBart Van Assche
8dd11376bSBart Van Assche #include <linux/bsg-lib.h>
96ff265fcSBean Huo #include <linux/dma-mapping.h>
10dd11376bSBart Van Assche #include <scsi/scsi.h>
11dd11376bSBart Van Assche #include <scsi/scsi_host.h>
12dd11376bSBart Van Assche #include "ufs_bsg.h"
13dd11376bSBart Van Assche #include <ufs/ufshcd.h>
14dd11376bSBart Van Assche #include "ufshcd-priv.h"
15dd11376bSBart Van Assche
ufs_bsg_get_query_desc_size(struct ufs_hba * hba,int * desc_len,struct utp_upiu_query * qr)16dd11376bSBart Van Assche static int ufs_bsg_get_query_desc_size(struct ufs_hba *hba, int *desc_len,
17dd11376bSBart Van Assche struct utp_upiu_query *qr)
18dd11376bSBart Van Assche {
19dd11376bSBart Van Assche int desc_size = be16_to_cpu(qr->length);
20dd11376bSBart Van Assche
21dd11376bSBart Van Assche if (desc_size <= 0)
22dd11376bSBart Van Assche return -EINVAL;
23dd11376bSBart Van Assche
24f2a89b07SArthur Simchaev *desc_len = min_t(int, QUERY_DESC_MAX_SIZE, desc_size);
25dd11376bSBart Van Assche
26dd11376bSBart Van Assche return 0;
27dd11376bSBart Van Assche }
28dd11376bSBart Van Assche
ufs_bsg_alloc_desc_buffer(struct ufs_hba * hba,struct bsg_job * job,uint8_t ** desc_buff,int * desc_len,enum query_opcode desc_op)29dd11376bSBart Van Assche static int ufs_bsg_alloc_desc_buffer(struct ufs_hba *hba, struct bsg_job *job,
30dd11376bSBart Van Assche uint8_t **desc_buff, int *desc_len,
31dd11376bSBart Van Assche enum query_opcode desc_op)
32dd11376bSBart Van Assche {
33dd11376bSBart Van Assche struct ufs_bsg_request *bsg_request = job->request;
34dd11376bSBart Van Assche struct utp_upiu_query *qr;
35dd11376bSBart Van Assche u8 *descp;
36dd11376bSBart Van Assche
37dd11376bSBart Van Assche if (desc_op != UPIU_QUERY_OPCODE_WRITE_DESC &&
38dd11376bSBart Van Assche desc_op != UPIU_QUERY_OPCODE_READ_DESC)
39dd11376bSBart Van Assche goto out;
40dd11376bSBart Van Assche
41dd11376bSBart Van Assche qr = &bsg_request->upiu_req.qr;
42dd11376bSBart Van Assche if (ufs_bsg_get_query_desc_size(hba, desc_len, qr)) {
43dd11376bSBart Van Assche dev_err(hba->dev, "Illegal desc size\n");
44dd11376bSBart Van Assche return -EINVAL;
45dd11376bSBart Van Assche }
46dd11376bSBart Van Assche
47dd11376bSBart Van Assche if (*desc_len > job->request_payload.payload_len) {
48dd11376bSBart Van Assche dev_err(hba->dev, "Illegal desc size\n");
49dd11376bSBart Van Assche return -EINVAL;
50dd11376bSBart Van Assche }
51dd11376bSBart Van Assche
52dd11376bSBart Van Assche descp = kzalloc(*desc_len, GFP_KERNEL);
53dd11376bSBart Van Assche if (!descp)
54dd11376bSBart Van Assche return -ENOMEM;
55dd11376bSBart Van Assche
56dd11376bSBart Van Assche if (desc_op == UPIU_QUERY_OPCODE_WRITE_DESC)
57dd11376bSBart Van Assche sg_copy_to_buffer(job->request_payload.sg_list,
58dd11376bSBart Van Assche job->request_payload.sg_cnt, descp,
59dd11376bSBart Van Assche *desc_len);
60dd11376bSBart Van Assche
61dd11376bSBart Van Assche *desc_buff = descp;
62dd11376bSBart Van Assche
63dd11376bSBart Van Assche out:
64dd11376bSBart Van Assche return 0;
65dd11376bSBart Van Assche }
66dd11376bSBart Van Assche
ufs_bsg_exec_advanced_rpmb_req(struct ufs_hba * hba,struct bsg_job * job)676ff265fcSBean Huo static int ufs_bsg_exec_advanced_rpmb_req(struct ufs_hba *hba, struct bsg_job *job)
686ff265fcSBean Huo {
696ff265fcSBean Huo struct ufs_rpmb_request *rpmb_request = job->request;
706ff265fcSBean Huo struct ufs_rpmb_reply *rpmb_reply = job->reply;
716ff265fcSBean Huo struct bsg_buffer *payload = NULL;
726ff265fcSBean Huo enum dma_data_direction dir;
735e87c51fSBean Huo struct scatterlist *sg_list = NULL;
746ff265fcSBean Huo int rpmb_req_type;
755e87c51fSBean Huo int sg_cnt = 0;
766ff265fcSBean Huo int ret;
776ff265fcSBean Huo int data_len;
786ff265fcSBean Huo
79*c91e585cSBean Huo if (hba->ufs_version < ufshci_version(4, 0) || !hba->dev_info.b_advanced_rpmb_en)
806ff265fcSBean Huo return -EINVAL;
816ff265fcSBean Huo
826ff265fcSBean Huo if (rpmb_request->ehs_req.length != 2 || rpmb_request->ehs_req.ehs_type != 1)
836ff265fcSBean Huo return -EINVAL;
846ff265fcSBean Huo
856ff265fcSBean Huo rpmb_req_type = be16_to_cpu(rpmb_request->ehs_req.meta.req_resp_type);
866ff265fcSBean Huo
876ff265fcSBean Huo switch (rpmb_req_type) {
886ff265fcSBean Huo case UFS_RPMB_WRITE_KEY:
896ff265fcSBean Huo case UFS_RPMB_READ_CNT:
906ff265fcSBean Huo case UFS_RPMB_PURGE_ENABLE:
916ff265fcSBean Huo dir = DMA_NONE;
926ff265fcSBean Huo break;
936ff265fcSBean Huo case UFS_RPMB_WRITE:
946ff265fcSBean Huo case UFS_RPMB_SEC_CONF_WRITE:
956ff265fcSBean Huo dir = DMA_TO_DEVICE;
966ff265fcSBean Huo break;
976ff265fcSBean Huo case UFS_RPMB_READ:
986ff265fcSBean Huo case UFS_RPMB_SEC_CONF_READ:
996ff265fcSBean Huo case UFS_RPMB_PURGE_STATUS_READ:
1006ff265fcSBean Huo dir = DMA_FROM_DEVICE;
1016ff265fcSBean Huo break;
1026ff265fcSBean Huo default:
1036ff265fcSBean Huo return -EINVAL;
1046ff265fcSBean Huo }
1056ff265fcSBean Huo
1066ff265fcSBean Huo if (dir != DMA_NONE) {
1076ff265fcSBean Huo payload = &job->request_payload;
1086ff265fcSBean Huo if (!payload || !payload->payload_len || !payload->sg_cnt)
1096ff265fcSBean Huo return -EINVAL;
1106ff265fcSBean Huo
1116ff265fcSBean Huo sg_cnt = dma_map_sg(hba->host->dma_dev, payload->sg_list, payload->sg_cnt, dir);
1126ff265fcSBean Huo if (unlikely(!sg_cnt))
1136ff265fcSBean Huo return -ENOMEM;
1146ff265fcSBean Huo sg_list = payload->sg_list;
1156ff265fcSBean Huo data_len = payload->payload_len;
1166ff265fcSBean Huo }
1176ff265fcSBean Huo
1186ff265fcSBean Huo ret = ufshcd_advanced_rpmb_req_handler(hba, &rpmb_request->bsg_request.upiu_req,
1196ff265fcSBean Huo &rpmb_reply->bsg_reply.upiu_rsp, &rpmb_request->ehs_req,
1206ff265fcSBean Huo &rpmb_reply->ehs_rsp, sg_cnt, sg_list, dir);
1216ff265fcSBean Huo
1226ff265fcSBean Huo if (dir != DMA_NONE) {
1236ff265fcSBean Huo dma_unmap_sg(hba->host->dma_dev, payload->sg_list, payload->sg_cnt, dir);
1246ff265fcSBean Huo
1256ff265fcSBean Huo if (!ret)
1266ff265fcSBean Huo rpmb_reply->bsg_reply.reply_payload_rcv_len = data_len;
1276ff265fcSBean Huo }
1286ff265fcSBean Huo
1296ff265fcSBean Huo return ret;
1306ff265fcSBean Huo }
1316ff265fcSBean Huo
ufs_bsg_request(struct bsg_job * job)132dd11376bSBart Van Assche static int ufs_bsg_request(struct bsg_job *job)
133dd11376bSBart Van Assche {
134dd11376bSBart Van Assche struct ufs_bsg_request *bsg_request = job->request;
135dd11376bSBart Van Assche struct ufs_bsg_reply *bsg_reply = job->reply;
136dd11376bSBart Van Assche struct ufs_hba *hba = shost_priv(dev_to_shost(job->dev->parent));
137dd11376bSBart Van Assche struct uic_command uc = {};
138dd11376bSBart Van Assche int msgcode;
1396ff265fcSBean Huo uint8_t *buff = NULL;
140dd11376bSBart Van Assche int desc_len = 0;
141dd11376bSBart Van Assche enum query_opcode desc_op = UPIU_QUERY_OPCODE_NOP;
142dd11376bSBart Van Assche int ret;
1436ff265fcSBean Huo bool rpmb = false;
144dd11376bSBart Van Assche
145dd11376bSBart Van Assche bsg_reply->reply_payload_rcv_len = 0;
146dd11376bSBart Van Assche
147dd11376bSBart Van Assche ufshcd_rpm_get_sync(hba);
148dd11376bSBart Van Assche
149dd11376bSBart Van Assche msgcode = bsg_request->msgcode;
150dd11376bSBart Van Assche switch (msgcode) {
151dd11376bSBart Van Assche case UPIU_TRANSACTION_QUERY_REQ:
152dd11376bSBart Van Assche desc_op = bsg_request->upiu_req.qr.opcode;
1536ff265fcSBean Huo ret = ufs_bsg_alloc_desc_buffer(hba, job, &buff, &desc_len, desc_op);
154765ab00dSBean Huo if (ret)
155dd11376bSBart Van Assche goto out;
156dd11376bSBart Van Assche fallthrough;
157dd11376bSBart Van Assche case UPIU_TRANSACTION_NOP_OUT:
158dd11376bSBart Van Assche case UPIU_TRANSACTION_TASK_REQ:
159dd11376bSBart Van Assche ret = ufshcd_exec_raw_upiu_cmd(hba, &bsg_request->upiu_req,
160dd11376bSBart Van Assche &bsg_reply->upiu_rsp, msgcode,
1616ff265fcSBean Huo buff, &desc_len, desc_op);
162dd11376bSBart Van Assche if (ret)
163765ab00dSBean Huo dev_err(hba->dev, "exe raw upiu: error code %d\n", ret);
1646ff265fcSBean Huo else if (desc_op == UPIU_QUERY_OPCODE_READ_DESC && desc_len) {
165765ab00dSBean Huo bsg_reply->reply_payload_rcv_len =
166765ab00dSBean Huo sg_copy_from_buffer(job->request_payload.sg_list,
167765ab00dSBean Huo job->request_payload.sg_cnt,
1686ff265fcSBean Huo buff, desc_len);
1696ff265fcSBean Huo }
170dd11376bSBart Van Assche break;
171dd11376bSBart Van Assche case UPIU_TRANSACTION_UIC_CMD:
172dd11376bSBart Van Assche memcpy(&uc, &bsg_request->upiu_req.uc, UIC_CMD_SIZE);
173dd11376bSBart Van Assche ret = ufshcd_send_uic_cmd(hba, &uc);
174dd11376bSBart Van Assche if (ret)
1756ff265fcSBean Huo dev_err(hba->dev, "send uic cmd: error code %d\n", ret);
176dd11376bSBart Van Assche
177dd11376bSBart Van Assche memcpy(&bsg_reply->upiu_rsp.uc, &uc, UIC_CMD_SIZE);
178dd11376bSBart Van Assche
179dd11376bSBart Van Assche break;
1806ff265fcSBean Huo case UPIU_TRANSACTION_ARPMB_CMD:
1816ff265fcSBean Huo rpmb = true;
1826ff265fcSBean Huo ret = ufs_bsg_exec_advanced_rpmb_req(hba, job);
1836ff265fcSBean Huo if (ret)
1846ff265fcSBean Huo dev_err(hba->dev, "ARPMB OP failed: error code %d\n", ret);
1856ff265fcSBean Huo break;
186dd11376bSBart Van Assche default:
187dd11376bSBart Van Assche ret = -ENOTSUPP;
188dd11376bSBart Van Assche dev_err(hba->dev, "unsupported msgcode 0x%x\n", msgcode);
189dd11376bSBart Van Assche
190dd11376bSBart Van Assche break;
191dd11376bSBart Van Assche }
192dd11376bSBart Van Assche
193dd11376bSBart Van Assche out:
194765ab00dSBean Huo ufshcd_rpm_put_sync(hba);
1956ff265fcSBean Huo kfree(buff);
196dd11376bSBart Van Assche bsg_reply->result = ret;
1976ff265fcSBean Huo job->reply_len = !rpmb ? sizeof(struct ufs_bsg_reply) : sizeof(struct ufs_rpmb_reply);
198dd11376bSBart Van Assche /* complete the job here only if no error */
199dd11376bSBart Van Assche if (ret == 0)
200dd11376bSBart Van Assche bsg_job_done(job, ret, bsg_reply->reply_payload_rcv_len);
201dd11376bSBart Van Assche
202dd11376bSBart Van Assche return ret;
203dd11376bSBart Van Assche }
204dd11376bSBart Van Assche
205dd11376bSBart Van Assche /**
206dd11376bSBart Van Assche * ufs_bsg_remove - detach and remove the added ufs-bsg node
207dd11376bSBart Van Assche * @hba: per adapter object
208dd11376bSBart Van Assche *
209dd11376bSBart Van Assche * Should be called when unloading the driver.
210dd11376bSBart Van Assche */
ufs_bsg_remove(struct ufs_hba * hba)211dd11376bSBart Van Assche void ufs_bsg_remove(struct ufs_hba *hba)
212dd11376bSBart Van Assche {
213dd11376bSBart Van Assche struct device *bsg_dev = &hba->bsg_dev;
214dd11376bSBart Van Assche
215dd11376bSBart Van Assche if (!hba->bsg_queue)
216dd11376bSBart Van Assche return;
217dd11376bSBart Van Assche
218dd11376bSBart Van Assche bsg_remove_queue(hba->bsg_queue);
219dd11376bSBart Van Assche
220dd11376bSBart Van Assche device_del(bsg_dev);
221dd11376bSBart Van Assche put_device(bsg_dev);
222dd11376bSBart Van Assche }
223dd11376bSBart Van Assche
ufs_bsg_node_release(struct device * dev)224dd11376bSBart Van Assche static inline void ufs_bsg_node_release(struct device *dev)
225dd11376bSBart Van Assche {
226dd11376bSBart Van Assche put_device(dev->parent);
227dd11376bSBart Van Assche }
228dd11376bSBart Van Assche
229dd11376bSBart Van Assche /**
230dd11376bSBart Van Assche * ufs_bsg_probe - Add ufs bsg device node
231dd11376bSBart Van Assche * @hba: per adapter object
232dd11376bSBart Van Assche *
233dd11376bSBart Van Assche * Called during initial loading of the driver, and before scsi_scan_host.
234fd4bffb5SBart Van Assche *
235fd4bffb5SBart Van Assche * Returns: 0 (success).
236dd11376bSBart Van Assche */
ufs_bsg_probe(struct ufs_hba * hba)237dd11376bSBart Van Assche int ufs_bsg_probe(struct ufs_hba *hba)
238dd11376bSBart Van Assche {
239dd11376bSBart Van Assche struct device *bsg_dev = &hba->bsg_dev;
240dd11376bSBart Van Assche struct Scsi_Host *shost = hba->host;
241dd11376bSBart Van Assche struct device *parent = &shost->shost_gendev;
242dd11376bSBart Van Assche struct request_queue *q;
243dd11376bSBart Van Assche int ret;
244dd11376bSBart Van Assche
245dd11376bSBart Van Assche device_initialize(bsg_dev);
246dd11376bSBart Van Assche
247dd11376bSBart Van Assche bsg_dev->parent = get_device(parent);
248dd11376bSBart Van Assche bsg_dev->release = ufs_bsg_node_release;
249dd11376bSBart Van Assche
250dd11376bSBart Van Assche dev_set_name(bsg_dev, "ufs-bsg%u", shost->host_no);
251dd11376bSBart Van Assche
252dd11376bSBart Van Assche ret = device_add(bsg_dev);
253dd11376bSBart Van Assche if (ret)
254dd11376bSBart Van Assche goto out;
255dd11376bSBart Van Assche
256dd11376bSBart Van Assche q = bsg_setup_queue(bsg_dev, dev_name(bsg_dev), ufs_bsg_request, NULL, 0);
257dd11376bSBart Van Assche if (IS_ERR(q)) {
258dd11376bSBart Van Assche ret = PTR_ERR(q);
259dd11376bSBart Van Assche goto out;
260dd11376bSBart Van Assche }
261dd11376bSBart Van Assche
262dd11376bSBart Van Assche hba->bsg_queue = q;
263dd11376bSBart Van Assche
264dd11376bSBart Van Assche return 0;
265dd11376bSBart Van Assche
266dd11376bSBart Van Assche out:
267dd11376bSBart Van Assche dev_err(bsg_dev, "fail to initialize a bsg dev %d\n", shost->host_no);
268dd11376bSBart Van Assche put_device(bsg_dev);
269dd11376bSBart Van Assche return ret;
270dd11376bSBart Van Assche }
271