Received: by 2002:ac0:a5b6:0:0:0:0:0 with SMTP id m51-v6csp3674698imm; Tue, 29 May 2018 11:21:30 -0700 (PDT) X-Google-Smtp-Source: ADUXVKIwnL8/4GaQ2ct+5fJMQYJgkYra0qR9Z7gYFCckNxd9aixP7rpDi2jqHGJG1ztpS0WeoCYy X-Received: by 2002:a62:5004:: with SMTP id e4-v6mr6313778pfb.71.1527618090190; Tue, 29 May 2018 11:21:30 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1527618090; cv=none; d=google.com; s=arc-20160816; b=uT0eA2i09J9+4JwoKUuuJjYuFKnmobUeMqBS7XByAaofE6qZsNlAezRdjA/Df2gGr+ odjFlgqqwxN1D28VnFjCKl8SX+KsKORNOkO7v62nCwELMi1XRWgx4/8B/bHzAkp8xi+I yGXywiADXAEmqgzgKeiJjFyFhiWTmDlKiJq9gpkz54LmAd5qGJP8pf4BBLxNivWeo1aA st/Cy9vniCsW2LO563rT2dapJKrIxNEmrZCfictiGSRjjYnRbPhgm/6Tyoaw/9UL65AC cZLBt2oIhNbkk0evtL2X8BK6rRJSdu6+X7H8lGkkVFKsQh1sqelKf+IAN6EMb+fMVn8p 8rvg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:references:in-reply-to:message-id:date :subject:cc:to:from:dkim-signature:arc-authentication-results; bh=ilsyRltMkU/Zwoypg/7JEYiSkmksvaiwBqVGDePkBdM=; b=qgKE0zqlLSSEpOug1ZOwqRWDuh0oKLT1vrE0cuVRbfyRnMssHE7BOn8JPdJsMyysW7 Xp/gq+wftNkJaZJ4rEHSes0borxMYaEK1Hdoi/kzXwuqCvnVw0lZ68lZdzpAp2qUPds9 ZIpds4d0GWLAMvI8zZpZnHc8A2WVL5Kx/3k/KjAbfNDcsvvZItXlPItUxxqeqeaP4mpo CTiGIY1K/MMjaReD39+wa2tt/qY1p5Y9CWarNYaYVZI6e1edM9YiQTR02y+LxafWNtXy 0YFoINbE/XKlHl2vqjw7uAqd6ZEpqXAtzNfP84B/uN0/cXGICYuplZbRO6VMOI6WFiyq AZ+w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=YW973qgs; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id p1-v6si22398408plo.363.2018.05.29.11.21.16; Tue, 29 May 2018 11:21:30 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=YW973qgs; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S966175AbeE2STY (ORCPT + 99 others); Tue, 29 May 2018 14:19:24 -0400 Received: from mail-pl0-f65.google.com ([209.85.160.65]:42441 "EHLO mail-pl0-f65.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S937009AbeE2SSQ (ORCPT ); Tue, 29 May 2018 14:18:16 -0400 Received: by mail-pl0-f65.google.com with SMTP id u6-v6so9429508pls.9 for ; Tue, 29 May 2018 11:18:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=ilsyRltMkU/Zwoypg/7JEYiSkmksvaiwBqVGDePkBdM=; b=YW973qgsPmzzEjH/AW7iCkuAxN+NJkfnKnozz0VVtEQpmI3CucxXKl/5VzA2jBq+dm G772Po4gd/QI8l7jLIsUQ1X192RBL8wB1+0PWWLcP9o48nH9FcXUx74ei74EZ8L4pMTs XcRzOEbUiGTNv/bQYodk9ACEevjCuG98DdGnw= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=ilsyRltMkU/Zwoypg/7JEYiSkmksvaiwBqVGDePkBdM=; b=VkBzJnceWPkmUpECY5i/faPYyDVHjr+8ufG28iMUvpz5OFYz7THJELV1A3HqKwitag SiJ2HGia9YHaMb1QznINDD2qWG1DTAzVNpGFGdg1zwEDhgaWzDorKFqcWMzqX+KfuuYu Bw7VwnEOcBtpcc7BcAvMRUlKhtI0pxUfc28i0EzpbpueKZ3rBYfxXVRfxMYhf+cN/8sy RpOk6R4phW7wm0KpgO3zm5D1fphUGxgA96wU9L7KSOd+QhGrv5Xfd9n0dIILEoeMW+lk nlN/3E3h8/AJhOzckOxa7aalhSCRQSfxKcGPOuTf86l9l8wUEedmnz0Cd6G8fuCYODjN rrCA== X-Gm-Message-State: ALKqPwcLTaScqXcn69nfvzI98sB2IEzaO1ODeOvRzvFb9uS2H1Cgrt5y 8rGFXZaSkzJjEaKZmgKn43GwBw== X-Received: by 2002:a17:902:8b8c:: with SMTP id ay12-v6mr13778176plb.74.1527617895468; Tue, 29 May 2018 11:18:15 -0700 (PDT) Received: from evgreen2.mtv.corp.google.com ([2620:0:1000:1511:116f:8bf3:133b:f7fd]) by smtp.gmail.com with ESMTPSA id b74-v6sm18255704pfl.138.2018.05.29.11.18.13 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 29 May 2018 11:18:14 -0700 (PDT) From: Evan Green To: Vinayak Holikatti , "James E.J. Bottomley" , "Martin K. Petersen" , Stanislav Nijnikov , linux-kernel@vger.kernel.org, linux-scsi@vger.kernel.org Cc: Gwendal Grignou , Evan Green Subject: [PATCH 2/7] scsi: ufs: Add config descriptor documentation Date: Tue, 29 May 2018 11:17:35 -0700 Message-Id: <20180529181740.195362-3-evgreen@chromium.org> X-Mailer: git-send-email 2.13.5 In-Reply-To: <20180529181740.195362-1-evgreen@chromium.org> References: <20180529181740.195362-1-evgreen@chromium.org> Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This change adds the documentation for the new sysfs files plumbed out for the UFS configuration descriptor. Signed-off-by: Evan Green --- Documentation/ABI/testing/sysfs-driver-ufs | 174 +++++++++++++++++++++++++++++ 1 file changed, 174 insertions(+) diff --git a/Documentation/ABI/testing/sysfs-driver-ufs b/Documentation/ABI/testing/sysfs-driver-ufs index 016724ec26d5..a1336194628f 100644 --- a/Documentation/ABI/testing/sysfs-driver-ufs +++ b/Documentation/ABI/testing/sysfs-driver-ufs @@ -237,6 +237,180 @@ Description: This file shows the command maximum timeout for a change The file is read only. +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/cfg_boot_enable +Date: May 2018 +Contact: Evan Green +Description: This file shows whether or not the UFS boot feature is enabled. + This is one of the UFS configuration descriptor parameters. + More information about the descriptor can be found in the UFS + 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/cfg_descriptor_access_enable +Date: May 2018 +Contact: Evan Green +Description: This file shows whether or not access will be permitted to the + Device Descriptor after the partial initialization phase of the + boot sequence. This is one of the UFS configuration descriptor + parameters. More information about the descriptor can be found + in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/cfg_high_priority_lun +Date: May 2018 +Contact: Evan Green +Description: This file shows the identifier of the high priority logical + unit. This is one of the UFS configuration descriptor + parameters. More information about the descriptor can be found + in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/cfg_init_active_icc_level +Date: May 2018 +Contact: Evan Green +Description: This file shows the ICC level in active mode after device + initialization or hardware reset. This is one of the UFS + configuration descriptor parameters. More information about the + descriptor can be found in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/cfg_initial_power_mode +Date: May 2018 +Contact: Evan Green +Description: This file shows the power mode after device initialization or + hardware reset. This is one of the UFS configuration descriptor + parameters. More information about the descriptor can be found + in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/cfg_number_of_luns +Date: May 2018 +Contact: Evan Green +Description: This file shows the number of logical units that the device will + support. This is one of the UFS configuration descriptor + parameters. More information about the descriptor can be found + in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/cfg_periodic_rtc_update +Date: May 2018 +Contact: Evan Green +Description: This file shows the frequency and method of real time clock + updates. This is one of the UFS configuration descriptor + parameters. More information about the descriptor can be found + in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/cfg_secure_removal_type +Date: May 2018 +Contact: Evan Green +Description: This file shows the secure removal type of the UFS device. This + is one of the UFS configuration descriptor parameters. More + information about the descriptor can be found in the UFS 2.1 + specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/cfg_unit +Date: May 2018 +Contact: Evan Green +Description: This file identifies the logical unit number whose parameters + are being displayed by the unit_* files in this directory. This + file can be set to different numerical values in order to + interact with configuration unit descriptors from additional + LUNs. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/unit_allocation_units +Date: May 2018 +Contact: Evan Green +Description: This file shows the number of allocation units assigned to the + logical unit. The cfg_unit file controls which logical unit is + being displayed. This is one of the UFS configuration unit + descriptor parameters. More information about the descriptor + can be found in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/unit_boot_lun_id +Date: May 2018 +Contact: Evan Green +Description: This file shows the boot LUN ID for this logical unit, + indicating whether it is Boot A, Boot B, or not special. The + cfg_unit file controls which logical unit is being displayed. + This is one of the UFS configuration unit descriptor parameters. + More information about the descriptor can be found in the UFS + 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/unit_context_capabilities +Date: May 2018 +Contact: Evan Green +Description: This file shows the context capabilities for the logical unit. + The cfg_unit file controls which logical unit is + being displayed. This is one of the UFS configuration unit + descriptor parameters. More information about the descriptor + can be found in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/unit_data_reliability +Date: May 2018 +Contact: Evan Green +Description: This file shows the data reliability for the logical unit. + The cfg_unit file controls which logical unit is + being displayed. This is one of the UFS configuration unit + descriptor parameters. More information about the descriptor + can be found in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/unit_logical_block_size +Date: May 2018 +Contact: Evan Green +Description: This file shows the logical block size for the logical unit as + a power of two. The cfg_unit file controls which logical unit is + being displayed. This is one of the UFS configuration unit + descriptor parameters. More information about the descriptor + can be found in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/unit_lu_enable +Date: May 2018 +Contact: Evan Green +Description: This file shows whether or not the logical unit is enabled. + The cfg_unit file controls which logical unit is + being displayed. This is one of the UFS configuration unit + descriptor parameters. More information about the descriptor + can be found in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/unit_lu_write_protect +Date: May 2018 +Contact: Evan Green +Description: This file shows the write protect status for the logical unit. + The cfg_unit file controls which logical unit is + being displayed. This is one of the UFS configuration unit + descriptor parameters. More information about the descriptor + can be found in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/unit_memory_type +Date: May 2018 +Contact: Evan Green +Description: This file shows the memory type for the logical unit. + The cfg_unit file controls which logical unit is + being displayed. This is one of the UFS configuration unit + descriptor parameters. More information about the descriptor + can be found in the UFS 2.1 specification. + The file is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/config_descriptor/unit_provisioning_type +Date: May 2018 +Contact: Evan Green +Description: This file shows the provisioning type information for the + logical unit. The cfg_unit file controls which logical unit is + being displayed. This is one of the UFS configuration unit + descriptor parameters. More information about the descriptor + can be found in the UFS 2.1 specification. + The file is read only. + + What: /sys/bus/platform/drivers/ufshcd/*/interconnect_descriptor/unipro_version Date: February 2018 Contact: Stanislav Nijnikov -- 2.13.5