Merge patch series "scsi: ufs: Add support for the aggregated read query opcode"

Hyeoncheol Jeong <hyenc.jeong@samsung.com> says:

UFS 5.0 / JEDEC 220H introduces the AGGREGATED READ query opcode
(0x9), which retrieves an aggregated data packet bundling multiple
Descriptors, Attributes and Flags in a single QUERY RESPONSE
UPIU. Such a packet can be far larger than a single descriptor, so the
reserved (device management) tag gets a dedicated UCD with an enlarged
response area.

Patch 1 is a preparatory cleanup that switches the BSG query
descriptor length to unsigned types. Patch 2 adds the aggregated read
support.

v3: https://lore.kernel.org/linux-scsi/20260724030812epcms2p4eb2c77cb4dcd5fd51ca9c3eaa5ea4bfa@epcms2p4/
v2: https://lore.kernel.org/linux-scsi/20260722084819epcms2p49c27fce999e821385f7b5d7ea5a02868@epcms2p4/

Link: https://patch.msgid.link/20260728092208epcms2p881b17276fb41c006a4229c1d073b4ad0@epcms2p8
Signed-off-by: Martin K. Petersen (Oracle) <mkp@kernel.org>
This commit is contained in:
Martin K. Petersen (Oracle)
2026-08-07 11:34:35 -04:00
6 changed files with 143 additions and 48 deletions

View File

@@ -296,14 +296,20 @@ static int ufshcd_mcq_get_tag(struct ufs_hba *hba, struct cq_entry *cqe)
if (hba->ufs_version >= ufshci_version(4, 1))
return cqe->task_tag;
/* sizeof(struct utp_transfer_cmd_desc) must be a multiple of 128 */
/* Both UCD types must have a size that is a multiple of 128 bytes */
BUILD_BUG_ON(sizeof(struct utp_transfer_cmd_desc) & GENMASK(6, 0));
BUILD_BUG_ON(sizeof(struct utp_devman_cmd_desc) & GENMASK(6, 0));
/* Bits 63:7 UCD base address, 6:5 are reserved, 4:0 is SQ ID */
addr = (le64_to_cpu(cqe->command_desc_base_addr) & CQE_UCD_BA) -
hba->ucdl_dma_addr;
addr = le64_to_cpu(cqe->command_desc_base_addr) & CQE_UCD_BA;
return div_u64(addr, ufshcd_get_ucd_size(hba));
/* The devman UCD is outside the pool; return its reserved tag. */
if (unlikely(addr == hba->devman_ucd_dma_addr))
return hba->dev_cmd.tag;
/* Pool entries follow the reserved tags. */
return div_u64(addr - hba->ucdl_dma_addr, ufshcd_get_ucd_size(hba)) +
UFSHCD_NUM_RESERVED;
}
static void ufshcd_mcq_process_cqe(struct ufs_hba *hba,

View File

@@ -13,37 +13,31 @@
#include <ufs/ufshcd.h>
#include "ufshcd-priv.h"
static int ufs_bsg_get_query_desc_size(struct ufs_hba *hba, int *desc_len,
struct utp_upiu_query *qr)
{
int desc_size = be16_to_cpu(qr->length);
if (desc_size <= 0)
return -EINVAL;
*desc_len = min_t(int, QUERY_DESC_MAX_SIZE, desc_size);
return 0;
}
static int ufs_bsg_alloc_desc_buffer(struct ufs_hba *hba, struct bsg_job *job,
uint8_t **desc_buff, int *desc_len,
u8 **desc_buff, u16 *desc_len,
enum query_opcode desc_op)
{
struct ufs_bsg_request *bsg_request = job->request;
struct utp_upiu_query *qr;
u16 max_desc_len;
u8 *descp;
if (desc_op != UPIU_QUERY_OPCODE_WRITE_DESC &&
desc_op != UPIU_QUERY_OPCODE_READ_DESC)
desc_op != UPIU_QUERY_OPCODE_READ_DESC &&
desc_op != UPIU_QUERY_OPCODE_AGGREGATED_READ)
goto out;
qr = &bsg_request->upiu_req.qr;
if (ufs_bsg_get_query_desc_size(hba, desc_len, qr)) {
*desc_len = be16_to_cpu(qr->length);
if (*desc_len == 0) {
dev_err(hba->dev, "Illegal desc size\n");
return -EINVAL;
}
max_desc_len = desc_op == UPIU_QUERY_OPCODE_AGGREGATED_READ ?
QUERY_AGGREGATED_MAX_SIZE : QUERY_DESC_MAX_SIZE;
*desc_len = min(*desc_len, max_desc_len);
if (*desc_len > job->request_payload.payload_len) {
dev_err(hba->dev, "Illegal desc size\n");
return -EINVAL;
@@ -108,6 +102,9 @@ static int ufs_bsg_exec_advanced_rpmb_req(struct ufs_hba *hba, struct bsg_job *j
if (!payload->payload_len || !payload->sg_cnt)
return -EINVAL;
if (payload->sg_cnt > UFSHCD_DEVMAN_SG_ENTRIES)
return -EINVAL;
sg_cnt = dma_map_sg(hba->host->dma_dev, payload->sg_list, payload->sg_cnt, dir);
if (unlikely(!sg_cnt))
return -ENOMEM;
@@ -136,8 +133,9 @@ static int ufs_bsg_request(struct bsg_job *job)
struct ufs_hba *hba = shost_priv(dev_to_shost(job->dev->parent));
struct uic_command uc = {};
int msgcode;
uint8_t *buff = NULL;
int desc_len = 0;
u8 *buff = NULL;
u16 desc_len = 0;
int buff_len;
enum query_opcode desc_op = UPIU_QUERY_OPCODE_NOP;
int ret;
bool rpmb = false;
@@ -156,12 +154,15 @@ static int ufs_bsg_request(struct bsg_job *job)
fallthrough;
case UPIU_TRANSACTION_NOP_OUT:
case UPIU_TRANSACTION_TASK_REQ:
buff_len = desc_len;
ret = ufshcd_exec_raw_upiu_cmd(hba, &bsg_request->upiu_req,
&bsg_reply->upiu_rsp, msgcode,
buff, &desc_len, desc_op);
buff, &buff_len, desc_op);
desc_len = buff_len;
if (ret)
dev_err(hba->dev, "exe raw upiu: error code %d\n", ret);
else if (desc_op == UPIU_QUERY_OPCODE_READ_DESC && desc_len) {
else if ((desc_op == UPIU_QUERY_OPCODE_READ_DESC ||
desc_op == UPIU_QUERY_OPCODE_AGGREGATED_READ) && desc_len) {
bsg_reply->reply_payload_rcv_len =
sg_copy_from_buffer(job->request_payload.sg_list,
job->request_payload.sg_cnt,

View File

@@ -2947,23 +2947,44 @@ static void ufshcd_comp_scsi_upiu(struct ufs_hba *hba, struct scsi_cmnd *cmd)
static void ufshcd_init_lrb(struct ufs_hba *hba, struct scsi_cmnd *cmd)
{
const int i = scsi_cmd_to_rq(cmd)->tag;
struct utp_transfer_cmd_desc *cmd_descp =
(void *)hba->ucdl_base_addr + i * ufshcd_get_ucd_size(hba);
struct utp_transfer_req_desc *utrdlp = hba->utrdl_base_addr;
dma_addr_t cmd_desc_element_addr =
hba->ucdl_dma_addr + i * ufshcd_get_ucd_size(hba);
u16 response_offset = le16_to_cpu(utrdlp[i].response_upiu_offset);
u16 prdt_offset = le16_to_cpu(utrdlp[i].prd_table_offset);
struct ufshcd_lrb *lrb = scsi_cmd_priv(cmd);
u8 *command_upiu, *response_upiu, *prd_table;
dma_addr_t cmd_desc_element_addr;
/* The reserved tag uses a dedicated UCD outside the pool. */
if (unlikely(blk_mq_is_reserved_rq(scsi_cmd_to_rq(cmd)))) {
struct utp_devman_cmd_desc *cmd_descp = hba->devman_ucd_base_addr;
cmd_desc_element_addr = hba->devman_ucd_dma_addr;
command_upiu = cmd_descp->command_upiu;
response_upiu = cmd_descp->response_upiu;
prd_table = cmd_descp->prd_table;
} else {
int slot = i - UFSHCD_NUM_RESERVED;
struct utp_transfer_cmd_desc *cmd_descp;
/* Non-reserved tags start at UFSHCD_NUM_RESERVED, so slot >= 0. */
WARN_ON_ONCE(slot < 0);
cmd_descp = (void *)hba->ucdl_base_addr + slot * ufshcd_get_ucd_size(hba);
cmd_desc_element_addr =
hba->ucdl_dma_addr + slot * ufshcd_get_ucd_size(hba);
command_upiu = cmd_descp->command_upiu;
response_upiu = cmd_descp->response_upiu;
prd_table = cmd_descp->prd_table;
}
lrb->utr_descriptor_ptr = utrdlp + i;
lrb->utrd_dma_addr =
hba->utrdl_dma_addr + i * sizeof(struct utp_transfer_req_desc);
lrb->ucd_req_ptr = (struct utp_upiu_req *)cmd_descp->command_upiu;
lrb->ucd_req_ptr = (struct utp_upiu_req *)command_upiu;
lrb->ucd_req_dma_addr = cmd_desc_element_addr;
lrb->ucd_rsp_ptr = (struct utp_upiu_rsp *)cmd_descp->response_upiu;
lrb->ucd_rsp_ptr = (struct utp_upiu_rsp *)response_upiu;
lrb->ucd_rsp_dma_addr = cmd_desc_element_addr + response_offset;
lrb->ucd_prdt_ptr = (struct ufshcd_sg_entry *)cmd_descp->prd_table;
lrb->ucd_prdt_ptr = (struct ufshcd_sg_entry *)prd_table;
lrb->ucd_prdt_dma_addr = cmd_desc_element_addr + prdt_offset;
}
@@ -3160,6 +3181,7 @@ static void ufshcd_setup_dev_cmd(struct ufs_hba *hba, struct scsi_cmnd *cmd,
__ufshcd_setup_cmd(hba, cmd, lun, tag);
lrbp->intr_cmd = true; /* No interrupt aggregation */
hba->dev_cmd.type = cmd_type;
hba->dev_cmd.tag = tag;
}
/*
@@ -4015,8 +4037,8 @@ static int ufshcd_memory_alloc(struct ufs_hba *hba)
{
size_t utmrdl_size, utrdl_size, ucdl_size;
/* Allocate memory for UTP command descriptors */
ucdl_size = ufshcd_get_ucd_size(hba) * hba->nutrs;
/* The reserved tag uses the dedicated UCD below, not this pool. */
ucdl_size = ufshcd_get_ucd_size(hba) * (hba->nutrs - UFSHCD_NUM_RESERVED);
hba->ucdl_base_addr = dmam_alloc_coherent(hba->dev,
ucdl_size,
&hba->ucdl_dma_addr,
@@ -4032,6 +4054,21 @@ static int ufshcd_memory_alloc(struct ufs_hba *hba)
goto out;
}
/* Dedicated UCD for the reserved tag; allocate once (survives MCQ re-init). */
if (!hba->devman_ucd_base_addr) {
hba->devman_ucd_base_addr =
dmam_alloc_coherent(hba->dev,
ufshcd_get_devman_ucd_size(hba),
&hba->devman_ucd_dma_addr,
GFP_KERNEL);
if (!hba->devman_ucd_base_addr ||
WARN_ON(hba->devman_ucd_dma_addr & (128 - 1))) {
dev_err(hba->dev,
"Devman Command Descriptor Memory allocation failed\n");
goto out;
}
}
/*
* Allocate memory for UTP Transfer descriptors
* UFSHCI requires 1KB alignment of UTRD
@@ -4098,23 +4135,38 @@ static void ufshcd_host_memory_configure(struct ufs_hba *hba)
dma_addr_t cmd_desc_element_addr;
u16 response_offset;
u16 prdt_offset;
u16 response_len;
int cmd_desc_size;
int i;
utrdlp = hba->utrdl_base_addr;
response_offset =
offsetof(struct utp_transfer_cmd_desc, response_upiu);
prdt_offset =
offsetof(struct utp_transfer_cmd_desc, prd_table);
cmd_desc_size = ufshcd_get_ucd_size(hba);
cmd_desc_dma_addr = hba->ucdl_dma_addr;
for (i = 0; i < hba->nutrs; i++) {
/*
* Reserved tags (low end) use the dedicated devman UCD with a
* larger response area; other tags index the pool at i - RESERVED.
*/
if (i < UFSHCD_NUM_RESERVED) {
cmd_desc_element_addr = hba->devman_ucd_dma_addr;
response_offset = offsetof(struct utp_devman_cmd_desc,
response_upiu);
prdt_offset = offsetof(struct utp_devman_cmd_desc,
prd_table);
response_len = ALIGNED_DEVMAN_RSP_SIZE;
} else {
cmd_desc_element_addr = cmd_desc_dma_addr +
cmd_desc_size * (i - UFSHCD_NUM_RESERVED);
response_offset = offsetof(struct utp_transfer_cmd_desc,
response_upiu);
prdt_offset = offsetof(struct utp_transfer_cmd_desc,
prd_table);
response_len = ALIGNED_UPIU_SIZE;
}
/* Configure UTRD with command descriptor base address */
cmd_desc_element_addr =
(cmd_desc_dma_addr + (cmd_desc_size * i));
utrdlp[i].command_desc_base_addr =
cpu_to_le64(cmd_desc_element_addr);
@@ -4125,14 +4177,14 @@ static void ufshcd_host_memory_configure(struct ufs_hba *hba)
utrdlp[i].prd_table_offset =
cpu_to_le16(prdt_offset);
utrdlp[i].response_upiu_length =
cpu_to_le16(ALIGNED_UPIU_SIZE);
cpu_to_le16(response_len);
} else {
utrdlp[i].response_upiu_offset =
cpu_to_le16(response_offset >> 2);
utrdlp[i].prd_table_offset =
cpu_to_le16(prdt_offset >> 2);
utrdlp[i].response_upiu_length =
cpu_to_le16(ALIGNED_UPIU_SIZE >> 2);
cpu_to_le16(response_len >> 2);
}
}
}
@@ -7657,7 +7709,8 @@ static int ufshcd_issue_devman_upiu_cmd(struct ufs_hba *hba,
/* just copy the upiu response as it is */
memcpy(rsp_upiu, lrbp->ucd_rsp_ptr, sizeof(*rsp_upiu));
if (desc_buff && desc_op == UPIU_QUERY_OPCODE_READ_DESC) {
if (desc_buff && (desc_op == UPIU_QUERY_OPCODE_READ_DESC ||
desc_op == UPIU_QUERY_OPCODE_AGGREGATED_READ)) {
u8 *descp = (u8 *)lrbp->ucd_rsp_ptr + sizeof(*rsp_upiu);
u16 resp_len = be16_to_cpu(lrbp->ucd_rsp_ptr->header
.data_segment_length);
@@ -7829,10 +7882,7 @@ int ufshcd_advanced_rpmb_req_handler(struct ufs_hba *hba, struct utp_upiu_req *r
* Message is 02h
*/
if (ehs_len == 2 && rsp_ehs) {
/*
* ucd_rsp_ptr points to a buffer with a length of 512 bytes
* (ALIGNED_UPIU_SIZE = 512), and the EHS data just starts from byte32
*/
/* EHS data starts from byte32 of the devman UCD response area. */
ehs_data = (u8 *)lrbp->ucd_rsp_ptr + EHS_OFFSET_IN_RESPONSE;
memcpy(rsp_ehs, ehs_data, ehs_len * 32);
}
@@ -9256,7 +9306,7 @@ static void ufshcd_release_sdb_queue(struct ufs_hba *hba, int nutrs)
{
size_t ucdl_size, utrdl_size;
ucdl_size = ufshcd_get_ucd_size(hba) * nutrs;
ucdl_size = ufshcd_get_ucd_size(hba) * (nutrs - UFSHCD_NUM_RESERVED);
dmam_free_coherent(hba->dev, ucdl_size, hba->ucdl_base_addr,
hba->ucdl_dma_addr);

View File

@@ -25,6 +25,11 @@ static_assert(sizeof(struct utp_upiu_query) == 20);
#define GENERAL_UPIU_REQUEST_SIZE (sizeof(struct utp_upiu_req))
#define QUERY_DESC_MAX_SIZE 255
/*
* Max aggregated read data segment: the devman response area
* (ALIGNED_DEVMAN_RSP_SIZE) minus the fixed UPIU header it follows.
*/
#define QUERY_AGGREGATED_MAX_SIZE (4096 - GENERAL_UPIU_REQUEST_SIZE)
#define QUERY_DESC_MIN_SIZE 2
#define QUERY_DESC_HDR_SIZE 2
#define QUERY_OSF_SIZE (GENERAL_UPIU_REQUEST_SIZE - \
@@ -464,6 +469,7 @@ enum query_opcode {
UPIU_QUERY_OPCODE_SET_FLAG = 0x6,
UPIU_QUERY_OPCODE_CLEAR_FLAG = 0x7,
UPIU_QUERY_OPCODE_TOGGLE_FLAG = 0x8,
UPIU_QUERY_OPCODE_AGGREGATED_READ = 0x9,
};
/* bRefClkFreq attribute values */

View File

@@ -235,11 +235,13 @@ struct ufs_query {
* @type: device management command type - Query, NOP OUT
* @lock: lock to allow one command at a time
* @query: Device management query information
* @tag: tag of the reserved request in use
*/
struct ufs_dev_cmd {
enum dev_cmd_type type;
struct mutex lock;
struct ufs_query query;
u8 tag;
};
/**
@@ -954,9 +956,13 @@ enum ufshcd_mcq_opr {
* @ucdl_base_addr: UFS Command Descriptor base address
* @utrdl_base_addr: UTP Transfer Request Descriptor base address
* @utmrdl_base_addr: UTP Task Management Descriptor base address
* @devman_ucd_base_addr: UFS Command Descriptor base address for the reserved
* device management tag (has a larger response area)
* @ucdl_dma_addr: UFS Command Descriptor DMA address
* @utrdl_dma_addr: UTRDL DMA address
* @utmrdl_dma_addr: UTMRDL DMA address
* @devman_ucd_dma_addr: UFS Command Descriptor DMA address for the reserved
* device management tag
* @host: Scsi_Host instance of the driver
* @dev: device handle
* @ufs_device_wlun: WLUN that controls the entire UFS device.
@@ -1098,11 +1104,13 @@ struct ufs_hba {
struct utp_transfer_cmd_desc *ucdl_base_addr;
struct utp_transfer_req_desc *utrdl_base_addr;
struct utp_task_req_desc *utmrdl_base_addr;
struct utp_devman_cmd_desc *devman_ucd_base_addr;
/* DMA memory reference */
dma_addr_t ucdl_dma_addr;
dma_addr_t utrdl_dma_addr;
dma_addr_t utmrdl_dma_addr;
dma_addr_t devman_ucd_dma_addr;
struct Scsi_Host *host;
struct device *dev;
@@ -1361,6 +1369,18 @@ static inline size_t ufshcd_get_ucd_size(const struct ufs_hba *hba)
return sizeof(struct utp_transfer_cmd_desc) + SG_ALL * ufshcd_sg_entry_size(hba);
}
/*
* Two entries should be enough for the largest devman PRDT transfer (4 KiB),
* like advanced RPMB.
*/
#define UFSHCD_DEVMAN_SG_ENTRIES 2
static inline size_t ufshcd_get_devman_ucd_size(const struct ufs_hba *hba)
{
return sizeof(struct utp_devman_cmd_desc) +
UFSHCD_DEVMAN_SG_ENTRIES * ufshcd_sg_entry_size(hba);
}
/* Returns true if clocks can be gated. Otherwise false */
static inline bool ufshcd_is_clkgating_allowed(struct ufs_hba *hba)
{

View File

@@ -18,6 +18,8 @@ enum {
TASK_REQ_UPIU_SIZE_DWORDS = 8,
TASK_RSP_UPIU_SIZE_DWORDS = 8,
ALIGNED_UPIU_SIZE = 512,
/* Larger response area, only for the devman UCD */
ALIGNED_DEVMAN_RSP_SIZE = 4096,
};
/* UFSHCI Registers */
@@ -501,6 +503,16 @@ struct utp_transfer_cmd_desc {
u8 prd_table[];
};
/* Dedicated UCD for the devman/reserved slot */
struct utp_devman_cmd_desc {
u8 command_upiu[ALIGNED_UPIU_SIZE];
u8 response_upiu[ALIGNED_DEVMAN_RSP_SIZE];
u8 prd_table[];
};
static_assert(sizeof(struct utp_upiu_req) + QUERY_AGGREGATED_MAX_SIZE <=
ALIGNED_DEVMAN_RSP_SIZE);
/**
* struct request_desc_header - Descriptor Header common to both UTRD and UTMRD
*/