Prepare for upstreaming Pixel 6 and 7 UFS support
Subsystems (2)
Bart Van Assche
reviewerv4 cover Prepare for upstreaming Pixel 6 and 7 UFS support
Hi Martin,
The Exynos UFS controller requires that SCSI command processing is suspended while reprogramming encryption keys. This UFS controller is used in e.g. Google Pixel 6 and 7 phones and also in Tesla cars. The patches in this series are a first step towards integrating support in the upstream kernel for the UFS controller in the Pixel 6 and 7. Please consider these patches for the next merge window.
Note: instructions for downloading the Pixel kernel source code are available at https://source.android.com/setup/build/building-kernels.
Thanks,
Bart.
Changes compared to v3:
- Changed SCSI_UFS_VARIABLE_SG_ENTRY_SIZE from user-selectable into selected only if needed.
Changes compared to v2:
- Addressed more review comments from Avri.
Changes compared to v1:
- Addressed Avri's review comments.
- Added patch "Allow UFS host drivers to override the sg entry size".
Bart Van Assche (4):
scsi: ufs: Reduce the clock scaling latency
scsi: ufs: Move a clock scaling check
scsi: ufs: Pass the clock scaling timeout as an argument
scsi: ufs: Add suspend/resume SCSI command processing support
Eric Biggers (1):
scsi: ufs: Allow UFS host drivers to override the sg entry size
drivers/ufs/core/ufshcd.c | 89 +++++++++++++++++++++++++++------------ drivers/ufs/host/Kconfig | 4 ++ include/ufs/ufshcd.h | 33 +++++++++++++++ include/ufs/ufshci.h | 9 +++- 4 files changed, 106 insertions(+), 29 deletions(-)
Bart Van Assche
reviewerPATCH v4 1/5 scsi: ufs: Reduce the clock scaling latency
Wait at most 20 ms before rechecking the doorbells instead of waiting for a potentially long time between doorbell checks.
--- drivers/ufs/core/ufshcd.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/ufs/core/ufshcd.c +1 -1
@@ -1154,7 +1154,7 @@ static int ufshcd_wait_for_doorbell_clr(struct ufs_hba *hba, }spin_unlock_irqrestore (hba->host->host_lock, flags); -schedule (); +io_schedule_timeout (msecs_to_jiffies (20 ));if (ktime_to_us (ktime_sub (ktime_get (), start)) > wait_timeout_us) { timeout = true;
Bart Van Assche
reviewerPATCH v4 2/5 scsi: ufs: Move a clock scaling check
In reply to Bart Van AsscheMove a check related to clock scaling into ufshcd_devfreq_scale(). This patch prepares for adding a second ufshcd_clock_scaling_prepare() caller in a function not related to clock scaling.
--- drivers/ufs/core/ufshcd.c | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-)
drivers/ufs/core/ufshcd.c +9 -2
@@ -1236,8 +1236,7 @@ static int ufshcd_clock_scaling_prepare(struct ufs_hba *hba)ufshcd_scsi_block_requests (hba);down_write (&hba->clk_scaling_lock); -if (!hba->clk_scaling.is_allowed || -ufshcd_wait_for_doorbell_clr (hba,DOORBELL_CLR_TOUT_US )) { +if (ufshcd_wait_for_doorbell_clr (hba,DOORBELL_CLR_TOUT_US )) { ret = -EBUSY ;up_write (&hba->clk_scaling_lock);ufshcd_scsi_unblock_requests (hba);
@@ -1275,10 +1274,18 @@ static int ufshcd_devfreq_scale(struct ufs_hba *hba, bool scale_up)int ret =0 ;bool is_writelock = true; +if (!hba->clk_scaling.is_allowed) +return -EBUSY ; + ret =ufshcd_clock_scaling_prepare (hba);if (ret)return ret; +if (!hba->clk_scaling.is_allowed) { + ret = -EBUSY ; + goto out_unprepare; + } +/* scale down the gear before scaling down clocks */ if (!scale_up) { ret =ufshcd_scale_gear (hba, false);
Bart Van Assche
reviewerPATCH v4 3/5 scsi: ufs: Pass the clock scaling timeout as an argument
In reply to Bart Van AsschePrepare for adding an additional ufshcd_clock_scaling_prepare() call with a different timeout.
--- drivers/ufs/core/ufshcd.c | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-)
drivers/ufs/core/ufshcd.c +15 -4
@@ -1121,6 +1121,12 @@ static u32 ufshcd_pending_cmds(struct ufs_hba *hba)return pending; } +/* +* Wait until all pending SCSI commands and TMFs have finished or the timeout +* has expired. +* +* Return: 0 upon success; -EBUSY upon timeout. +*/ static int ufshcd_wait_for_doorbell_clr (struct ufs_hba *hba,u64 wait_timeout_us) {
@@ -1225,9 +1231,14 @@ static int ufshcd_scale_gear(struct ufs_hba *hba, bool scale_up)return ret; } -static int ufshcd_clock_scaling_prepare (struct ufs_hba *hba) +/* +* Wait until all pending SCSI commands and TMFs have finished or the timeout +* has expired. +* +* Return: 0 upon success; -EBUSY upon timeout. +*/ +static int ufshcd_clock_scaling_prepare (struct ufs_hba *hba,u64 timeout_us) { -#define DOORBELL_CLR_TOUT_US (1000 * 1000)/* 1 sec */ int ret =0 ;/* * make sure that there are no outstanding requests when
@@ -1236,7 +1247,7 @@ static int ufshcd_clock_scaling_prepare(struct ufs_hba *hba)ufshcd_scsi_block_requests (hba);down_write (&hba->clk_scaling_lock); -if (ufshcd_wait_for_doorbell_clr (hba,DOORBELL_CLR_TOUT_US )) { +if (ufshcd_wait_for_doorbell_clr (hba, timeout_us)) { ret = -EBUSY ;up_write (&hba->clk_scaling_lock);ufshcd_scsi_unblock_requests (hba);
@@ -1277,7 +1288,7 @@ static int ufshcd_devfreq_scale(struct ufs_hba *hba, bool scale_up)if (!hba->clk_scaling.is_allowed)return -EBUSY ; - ret =ufshcd_clock_scaling_prepare (hba); + ret =ufshcd_clock_scaling_prepare (hba,1 *USEC_PER_SEC );if (ret)return ret;
Bart Van Assche
reviewerPATCH v4 4/5 scsi: ufs: Add suspend/resume SCSI command processing support
In reply to Bart Van AsscheThis functionality is needed by UFS drivers to e.g. suspend SCSI command processing while reprogramming encryption keys if the hardware does not support concurrent I/O and key reprogramming. This patch prepares for adding support in the upstream kernel for the Pixel 6 and 7 UFS controllers.
--- drivers/ufs/core/ufshcd.c | 20 ++++++++++++++++++++ include/ufs/ufshcd.h | 3 +++ 2 files changed, 23 insertions(+)
drivers/ufs/core/ufshcd.c +20 -0
@@ -1707,6 +1707,26 @@ static void ufshcd_ungate_work(struct work_struct *work)ufshcd_scsi_unblock_requests (hba); } +/* +* Block processing of new SCSI commands and wait until pending SCSI +* commands and TMFs have finished. ufshcd_exec_dev_cmd() and +* ufshcd_issue_devman_upiu_cmd() are not affected by this function. +* +* Return: 0 upon success; -EBUSY upon timeout. +*/ +int ufshcd_freeze_scsi_devs (struct ufs_hba *hba,u64 timeout_us) +{ +return ufshcd_clock_scaling_prepare (hba, timeout_us); +} +EXPORT_SYMBOL_GPL (ufshcd_freeze_scsi_devs); + +/* Resume processing of SCSI commands. */ +void ufshcd_unfreeze_scsi_devs (struct ufs_hba *hba) +{ +ufshcd_clock_scaling_unprepare (hba, true); +} +EXPORT_SYMBOL_GPL (ufshcd_unfreeze_scsi_devs); +/** * ufshcd_hold - Enable clocks that were gated earlier due to ufshcd_release. * Also, exit from hibern8 mode and set the link as active.
include/ufs/ufshcd.h +3 -0
@@ -1186,6 +1186,9 @@ void ufshcd_release(struct ufs_hba *hba);void ufshcd_clkgate_delay_set (struct device *dev,unsigned long value); +int ufshcd_freeze_scsi_devs (struct ufs_hba *hba,u64 timeout_us); +void ufshcd_unfreeze_scsi_devs (struct ufs_hba *hba); +void ufshcd_map_desc_id_to_length (struct ufs_hba *hba,enum desc_idn desc_id,int *desc_length);
Bart Van Assche
reviewerPATCH v4 5/5 scsi: ufs: Allow UFS host drivers to override the sg entry size
In reply to Bart Van AsscheFrom: Eric Biggers <[email protected]>
Modify the UFSHCD core to allow 'struct ufshcd_sg_entry' to be variable-length. The default is the standard length, but variants can override ufs_hba::sg_entry_size with a larger value if there are vendor-specific fields following the standard ones.
This is needed to support inline encryption with ufs-exynos (FMP).
--- drivers/ufs/core/ufshcd.c | 39 ++++++++++++++++++--------------------- drivers/ufs/host/Kconfig | 4 ++++ include/ufs/ufshcd.h | 30 ++++++++++++++++++++++++++++++ include/ufs/ufshci.h | 9 +++++++-- 4 files changed, 59 insertions(+), 23 deletions(-)
drivers/ufs/core/ufshcd.c +18 -21
@@ -528,7 +528,7 @@ void ufshcd_print_trs(struct ufs_hba *hba, unsigned long bitmap, bool pr_prdt) prdt_length =le16_to_cpu ( lrbp->utr_descriptor_ptr->prd_table_length);if (hba->quirks &UFSHCD_QUIRK_PRDT_BYTE_GRAN ) - prdt_length /=sizeof (struct ufshcd_sg_entry ); + prdt_length /=ufshcd_sg_entry_size (hba); dev_err(hba->dev, "UPIU[%d] - PRDT - %d entries phys@0x%llx\n",
@@ -537,7 +537,7 @@ void ufshcd_print_trs(struct ufs_hba *hba, unsigned long bitmap, bool pr_prdt)if (pr_prdt)ufshcd_hex_dump ("UPIU PRDT: " , lrbp->ucd_prdt_ptr, -sizeof (struct ufshcd_sg_entry ) * prdt_length); +ufshcd_sg_entry_size (hba) * prdt_length); } }
@@ -2445,7 +2445,7 @@ int ufshcd_send_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)*/ static int ufshcd_map_sg (struct ufs_hba *hba,struct ufshcd_lrb *lrbp) { -struct ufshcd_sg_entry *prd_table; +struct ufshcd_sg_entry *prd;struct scatterlist *sg;struct scsi_cmnd *cmd;int sg_segments;
@@ -2460,13 +2460,12 @@ static int ufshcd_map_sg(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)if (hba->quirks &UFSHCD_QUIRK_PRDT_BYTE_GRAN ) lrbp->utr_descriptor_ptr->prd_table_length = -cpu_to_le16 ((sg_segments * -sizeof (struct ufshcd_sg_entry ))); +cpu_to_le16 (sg_segments *ufshcd_sg_entry_size (hba));else lrbp->utr_descriptor_ptr->prd_table_length =cpu_to_le16 (sg_segments); - prd_table = lrbp->ucd_prdt_ptr; + prd = lrbp->ucd_prdt_ptr;scsi_for_each_sg (cmd, sg, sg_segments, i) {const unsigned int len =sg_dma_len (sg);
@@ -2480,9 +2479,10 @@ static int ufshcd_map_sg(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)* indicates 4 bytes, '7' indicates 8 bytes, etc." */ WARN_ONCE (len >256 *1024 ,"len = %#x\n" , len); - prd_table[i].size =cpu_to_le32 (len -1 ); - prd_table[i].addr =cpu_to_le64 (sg->dma_address); - prd_table[i].reserved =0 ; + prd->size =cpu_to_le32 (len -1 ); + prd->addr =cpu_to_le64 (sg->dma_address); + prd->reserved =0 ; + prd = (void *)prd +ufshcd_sg_entry_size (hba); } }else { lrbp->utr_descriptor_ptr->prd_table_length =0 ;
@@ -2772,10 +2772,11 @@ static void ufshcd_map_queues(struct Scsi_Host *shost)static void ufshcd_init_lrb (struct ufs_hba *hba,struct ufshcd_lrb *lrb,int i) { -struct utp_transfer_cmd_desc *cmd_descp = hba->ucdl_base_addr; +struct utp_transfer_cmd_desc *cmd_descp = (void *)hba->ucdl_base_addr + + i *sizeof_utp_transfer_cmd_desc (hba);struct utp_transfer_req_desc *utrdlp = hba->utrdl_base_addr;dma_addr_t cmd_desc_element_addr = hba->ucdl_dma_addr + - i *sizeof (struct utp_transfer_cmd_desc ); + i *sizeof_utp_transfer_cmd_desc (hba);u16 response_offset = offsetof(struct utp_transfer_cmd_desc , response_upiu);u16 prdt_offset = offsetof(struct utp_transfer_cmd_desc , prd_table);
@@ -2783,11 +2784,11 @@ static void ufshcd_init_lrb(struct ufs_hba *hba, struct ufshcd_lrb *lrb, int i) 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 + i); + lrb->ucd_req_ptr = (struct utp_upiu_req *)cmd_descp->command_upiu; lrb->ucd_req_dma_addr = cmd_desc_element_addr; - lrb->ucd_rsp_ptr = (struct utp_upiu_rsp *)cmd_descp[i].response_upiu; + lrb->ucd_rsp_ptr = (struct utp_upiu_rsp *)cmd_descp->response_upiu; lrb->ucd_rsp_dma_addr = cmd_desc_element_addr + response_offset; - lrb->ucd_prdt_ptr = cmd_descp[i].prd_table; + lrb->ucd_prdt_ptr = (struct ufshcd_sg_entry *)cmd_descp->prd_table; lrb->ucd_prdt_dma_addr = cmd_desc_element_addr + prdt_offset; }
@@ -3696,7 +3697,7 @@ 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 = (sizeof (struct utp_transfer_cmd_desc ) * hba->nutrs); + ucdl_size =sizeof_utp_transfer_cmd_desc (hba) * hba->nutrs; hba->ucdl_base_addr = dmam_alloc_coherent(hba->dev, ucdl_size, &hba->ucdl_dma_addr,
@@ -3790,7 +3791,7 @@ static void ufshcd_host_memory_configure(struct ufs_hba *hba) prdt_offset = offsetof(struct utp_transfer_cmd_desc , prd_table); - cmd_desc_size =sizeof (struct utp_transfer_cmd_desc ); + cmd_desc_size =sizeof_utp_transfer_cmd_desc (hba); cmd_desc_dma_addr = hba->ucdl_dma_addr;for (i =0 ; i < hba->nutrs; i++) {
@@ -9661,6 +9662,7 @@ int ufshcd_alloc_host(struct device *dev, struct ufs_hba **hba_handle) hba->dev = dev; hba->dev_ref_clk_freq =REF_CLK_FREQ_INVAL ; hba->nop_out_timeout =NOP_OUT_TIMEOUT ; +ufshcd_set_sg_entry_size (hba,sizeof (struct ufshcd_sg_entry ));INIT_LIST_HEAD (&hba->clk_list_head);spin_lock_init (&hba->outstanding_lock);
@@ -10039,11 +10041,6 @@ static int __init ufshcd_core_init(void) {int ret; -/* Verify that there are no gaps in struct utp_transfer_cmd_desc. */ -static_assert (sizeof (struct utp_transfer_cmd_desc ) == -2 *ALIGNED_UPIU_SIZE + -SG_ALL *sizeof (struct ufshcd_sg_entry )); -ufs_debugfs_init (); ret =scsi_register_driver (&ufs_dev_wlun_template.gendrv);
drivers/ufs/host/Kconfig +4 -0
@@ -124,3 +124,7 @@ config SCSI_UFS_EXYNOS Select this if you have UFS host controller on Samsung Exynos SoC. If unsure, say N. + +config SCSI_UFS_VARIABLE_SG_ENTRY_SIZE + bool + default y if SCSI_UFS_EXYNOS && SCSI_UFS_CRYPTO
include/ufs/ufshcd.h +30 -0
@@ -754,6 +754,7 @@ struct ufs_hba_monitor {* @vops: pointer to variant specific operations * @vps: pointer to variant specific parameters * @priv: pointer to variant specific private data +* @sg_entry_size: size of struct ufshcd_sg_entry (may include variant fields) * @irq: Irq number of the controller * @is_irq_enabled: whether or not the UFS controller interrupt is enabled. * @dev_ref_clk_freq: reference clock frequency
@@ -877,6 +878,9 @@ struct ufs_hba {const struct ufs_hba_variant_ops *vops;struct ufs_hba_variant_params *vps;void *priv; +#ifdef CONFIG_SCSI_UFS_VARIABLE_SG_ENTRY_SIZE +size_t sg_entry_size; +#endif unsigned int irq;bool is_irq_enabled;enum ufs_ref_clk_freq dev_ref_clk_freq;
@@ -980,6 +984,32 @@ struct ufs_hba {bool complete_put; }; +#ifdef CONFIG_SCSI_UFS_VARIABLE_SG_ENTRY_SIZE +static inline size_t ufshcd_sg_entry_size (const struct ufs_hba *hba) +{ +return hba->sg_entry_size; +} + +static inline void ufshcd_set_sg_entry_size (struct ufs_hba *hba,size_t sg_entry_size) +{ +WARN_ON_ONCE (sg_entry_size <sizeof (struct ufshcd_sg_entry )); + hba->sg_entry_size = sg_entry_size; +} +#else +static inline size_t ufshcd_sg_entry_size (const struct ufs_hba *hba) +{ +return sizeof (struct ufshcd_sg_entry ); +} + +#define ufshcd_set_sg_entry_size (hba, sg_entry_size) \ + ({ (void)(hba); BUILD_BUG_ON(sg_entry_size != sizeof(struct ufshcd_sg_entry)); }) +#endif + +static inline size_t sizeof_utp_transfer_cmd_desc (const struct ufs_hba *hba) +{ +return sizeof (struct utp_transfer_cmd_desc ) +SG_ALL *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) {
include/ufs/ufshci.h +7 -2
@@ -422,18 +422,23 @@ struct ufshcd_sg_entry {__le64 addr;__le32 reserved;__le32 size; +/* +* followed by variant-specific fields if +* CONFIG_SCSI_UFS_VARIABLE_SG_ENTRY_SIZE has been defined. +*/ };/** * struct utp_transfer_cmd_desc - UTP Command Descriptor (UCD) * @command_upiu: Command UPIU Frame address * @response_upiu: Response UPIU Frame address -* @prd_table: Physical Region Descriptor +* @prd_table: Physical Region Descriptor: an array of SG_ALL struct +* ufshcd_sg_entry's. Variant-specific fields may be present after each. */ struct utp_transfer_cmd_desc {u8 command_upiu[ALIGNED_UPIU_SIZE ];u8 response_upiu[ALIGNED_UPIU_SIZE ]; -struct ufshcd_sg_entry prd_table[SG_ALL ]; +u8 prd_table[]; };/**