From patchwork Tue May 29 18:17:35 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Evan Green X-Patchwork-Id: 10436697 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id DD03060327 for ; Tue, 29 May 2018 18:20:36 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id CE6962892C for ; Tue, 29 May 2018 18:20:36 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id C2FCF28947; Tue, 29 May 2018 18:20:36 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, MAILING_LIST_MULTI, T_DKIM_INVALID autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 8411C2892C for ; Tue, 29 May 2018 18:20:16 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S966047AbeE2STK (ORCPT ); Tue, 29 May 2018 14:19:10 -0400 Received: from mail-pl0-f65.google.com ([209.85.160.65]:40486 "EHLO mail-pl0-f65.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S937011AbeE2SSQ (ORCPT ); Tue, 29 May 2018 14:18:16 -0400 Received: by mail-pl0-f65.google.com with SMTP id t12-v6so9424611plo.7 for ; Tue, 29 May 2018 11:18:16 -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=o5VsAfAiBmvsD3XK4nK8xqHyxpD5nfaGdHlG3xlbm/0zTqN7W0OMRmsKttFviIH2CL nIP1EzgMbaPsT9DAsXE+ZCm1tV8ayvr+a52joa2irKkHjsPOnFxJjCjJsTP5ma5Fib0s JjeGuKt/l3i2JqpE59IuXmLAdsoB6uXKNYUwyyXYvKnY8pW9rPxRnXFZ8wFCVXaiMp43 c90X9C69Fv3On/qiPHX4odkAk7iN7vc4+ZqRIJyguJi+Qq1bynYfHasPPDYMBnROsYq0 pPum2g8/jrgGM2I/2T+kNRSId2Zuuks28GUPtUOgKRmyyPOTIHvnrfgRTzzOvTFw9wSP kJig== X-Gm-Message-State: ALKqPwcTqJcbpowWPLb/GgwKetAKUTYQOdguL87Kk4lmk3LW832UeyMa iXk0jGcGC86v0dAphOV7sRPBLQ== X-Google-Smtp-Source: ADUXVKLf2Lz6HzK3/q2vhfDHlSaKnYDyXofeWG5vPKKGLo/4A+SL1oQkdpr0Ymk2lPfcp2HAKCDRlw== 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-scsi-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-scsi@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP 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