drivers/scsi/ufs/ufs_bsg.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * bsg endpoint that supports UPIUs
   4  *
   5  * Copyright (C) 2018 Western Digital Corporation
   6  */
   7 #include "ufs_bsg.h"
   8
   9 static int ufs_bsg_get_query_desc_size(struct ufs_hba *hba, int *desc_len,
  10                                        struct utp_upiu_query *qr)
  11 {
  12         int desc_size = be16_to_cpu(qr->length);
  13         int desc_id = qr->idn;
  14         int ret;
  15
  16         if (desc_size <= 0)
  17                 return -EINVAL;
  18
  19         ret = ufshcd_map_desc_id_to_length(hba, desc_id, desc_len);
  20         if (ret || !*desc_len)
  21                 return -EINVAL;
  22
  23         *desc_len = min_t(int, *desc_len, desc_size);
  24
  25         return 0;
  26 }
  27
  28 static int ufs_bsg_verify_query_size(struct ufs_hba *hba,
  29                                      unsigned int request_len,
  30                                      unsigned int reply_len)
  31 {
  32         int min_req_len = sizeof(struct ufs_bsg_request);
  33         int min_rsp_len = sizeof(struct ufs_bsg_reply);
  34
  35         if (min_req_len > request_len || min_rsp_len > reply_len) {
  36                 dev_err(hba->dev, "not enough space assigned\n");
  37                 return -EINVAL;
  38         }
  39
  40         return 0;
  41 }
  42
  43 static int ufs_bsg_alloc_desc_buffer(struct ufs_hba *hba, struct bsg_job *job,
  44                                      uint8_t **desc_buff, int *desc_len,
  45                                      enum query_opcode desc_op)
  46 {
  47         struct ufs_bsg_request *bsg_request = job->request;
  48         struct utp_upiu_query *qr;
  49         u8 *descp;
  50
  51         if (desc_op != UPIU_QUERY_OPCODE_WRITE_DESC &&
  52             desc_op != UPIU_QUERY_OPCODE_READ_DESC)
  53                 goto out;
  54
  55         qr = &bsg_request->upiu_req.qr;
  56         if (ufs_bsg_get_query_desc_size(hba, desc_len, qr)) {
  57                 dev_err(hba->dev, "Illegal desc size\n");
  58                 return -EINVAL;
  59         }
  60
  61         if (*desc_len > job->request_payload.payload_len) {
  62                 dev_err(hba->dev, "Illegal desc size\n");
  63                 return -EINVAL;
  64         }
  65
  66         descp = kzalloc(*desc_len, GFP_KERNEL);
  67         if (!descp)
  68                 return -ENOMEM;
  69
  70         if (desc_op == UPIU_QUERY_OPCODE_WRITE_DESC)
  71                 sg_copy_to_buffer(job->request_payload.sg_list,
  72                                   job->request_payload.sg_cnt, descp,
  73                                   *desc_len);
  74
  75         *desc_buff = descp;
  76
  77 out:
  78         return 0;
  79 }
  80
  81 static int ufs_bsg_request(struct bsg_job *job)
  82 {
  83         struct ufs_bsg_request *bsg_request = job->request;
  84         struct ufs_bsg_reply *bsg_reply = job->reply;
  85         struct ufs_hba *hba = shost_priv(dev_to_shost(job->dev->parent));
  86         unsigned int req_len = job->request_len;
  87         unsigned int reply_len = job->reply_len;
  88         struct uic_command uc = {};
  89         int msgcode;
  90         uint8_t *desc_buff = NULL;
  91         int desc_len = 0;
  92         enum query_opcode desc_op = UPIU_QUERY_OPCODE_NOP;
  93         int ret;
  94
  95         ret = ufs_bsg_verify_query_size(hba, req_len, reply_len);
  96         if (ret)
  97                 goto out;
  98
  99         bsg_reply->reply_payload_rcv_len = 0;
 100
 101         pm_runtime_get_sync(hba->dev);
 102
 103         msgcode = bsg_request->msgcode;
 104         switch (msgcode) {
 105         case UPIU_TRANSACTION_QUERY_REQ:
 106                 desc_op = bsg_request->upiu_req.qr.opcode;
 107                 ret = ufs_bsg_alloc_desc_buffer(hba, job, &desc_buff,
 108                                                 &desc_len, desc_op);
 109                 if (ret) {
 110                         pm_runtime_put_sync(hba->dev);
 111                         goto out;
 112                 }
 113
 114                 /* fall through */
 115         case UPIU_TRANSACTION_NOP_OUT:
 116         case UPIU_TRANSACTION_TASK_REQ:
 117                 ret = ufshcd_exec_raw_upiu_cmd(hba, &bsg_request->upiu_req,
 118                                                &bsg_reply->upiu_rsp, msgcode,
 119                                                desc_buff, &desc_len, desc_op);
 120                 if (ret)
 121                         dev_err(hba->dev,
 122                                 "exe raw upiu: error code %d\n", ret);
 123
 124                 break;
 125         case UPIU_TRANSACTION_UIC_CMD:
 126                 memcpy(&uc, &bsg_request->upiu_req.uc, UIC_CMD_SIZE);
 127                 ret = ufshcd_send_uic_cmd(hba, &uc);
 128                 if (ret)
 129                         dev_err(hba->dev,
 130                                 "send uic cmd: error code %d\n", ret);
 131
 132                 memcpy(&bsg_reply->upiu_rsp.uc, &uc, UIC_CMD_SIZE);
 133
 134                 break;
 135         default:
 136                 ret = -ENOTSUPP;
 137                 dev_err(hba->dev, "unsupported msgcode 0x%x\n", msgcode);
 138
 139                 break;
 140         }
 141
 142         pm_runtime_put_sync(hba->dev);
 143
 144         if (!desc_buff)
 145                 goto out;
 146
 147         if (desc_op == UPIU_QUERY_OPCODE_READ_DESC && desc_len)
 148                 bsg_reply->reply_payload_rcv_len =
 149                         sg_copy_from_buffer(job->request_payload.sg_list,
 150                                             job->request_payload.sg_cnt,
 151                                             desc_buff, desc_len);
 152
 153         kfree(desc_buff);
 154
 155 out:
 156         bsg_reply->result = ret;
 157         job->reply_len = sizeof(struct ufs_bsg_reply);
 158         /* complete the job here only if no error */
 159         if (ret == 0)
 160                 bsg_job_done(job, ret, bsg_reply->reply_payload_rcv_len);
 161
 162         return ret;
 163 }
 164
 165 /**
 166  * ufs_bsg_remove - detach and remove the added ufs-bsg node
 167  *
 168  * Should be called when unloading the driver.
 169  */
 170 void ufs_bsg_remove(struct ufs_hba *hba)
 171 {
 172         struct device *bsg_dev = &hba->bsg_dev;
 173
 174         if (!hba->bsg_queue)
 175                 return;
 176
 177         bsg_remove_queue(hba->bsg_queue);
 178
 179         device_del(bsg_dev);
 180         put_device(bsg_dev);
 181 }
 182
 183 static inline void ufs_bsg_node_release(struct device *dev)
 184 {
 185         put_device(dev->parent);
 186 }
 187
 188 /**
 189  * ufs_bsg_probe - Add ufs bsg device node
 190  * @hba: per adapter object
 191  *
 192  * Called during initial loading of the driver, and before scsi_scan_host.
 193  */
 194 int ufs_bsg_probe(struct ufs_hba *hba)
 195 {
 196         struct device *bsg_dev = &hba->bsg_dev;
 197         struct Scsi_Host *shost = hba->host;
 198         struct device *parent = &shost->shost_gendev;
 199         struct request_queue *q;
 200         int ret;
 201
 202         device_initialize(bsg_dev);
 203
 204         bsg_dev->parent = get_device(parent);
 205         bsg_dev->release = ufs_bsg_node_release;
 206
 207         dev_set_name(bsg_dev, "ufs-bsg%u", shost->host_no);
 208
 209         ret = device_add(bsg_dev);
 210         if (ret)
 211                 goto out;
 212
 213         q = bsg_setup_queue(bsg_dev, dev_name(bsg_dev), ufs_bsg_request, NULL, 0);
 214         if (IS_ERR(q)) {
 215                 ret = PTR_ERR(q);
 216                 goto out;
 217         }
 218
 219         hba->bsg_queue = q;
 220
 221         return 0;
 222
 223 out:
 224         dev_err(bsg_dev, "fail to initialize a bsg dev %d\n", shost->host_no);
 225         put_device(bsg_dev);
 226         return ret;
 227 }