Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Dong Aisheng <aisheng.dong@nxp.com>
To:     broonie@kernel.org
Cc:     linux-kernel@vger.kernel.org, dongas86@gmail.com,
        l.stach@pengutronix.de, peng.fan@nxp.com, shawnguo@kernel.org,
        Dong Aisheng <aisheng.dong@nxp.com>
Subject: [PATCH RFC 1/2] regmap: add option to disable debugfs
Date:   Mon, 20 Jun 2022 21:47:57 +0800
Message-Id: <20220620134758.1286480-2-aisheng.dong@nxp.com>
In-Reply-To: <20220620134758.1286480-1-aisheng.dong@nxp.com>
References: <20220620134758.1286480-1-aisheng.dong@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?LwqsyMEZSPF5lC1pHzvHI0+naIZfYN8h/EY4JDCAkHKigaq0ix+8AiYTohkc?=
 =?us-ascii?Q?kz4o5BOkdRJjSM3RQObtbqCd5IEVF3X5jlcDs8vmcZFiNuptVPtjSV94aPst?=
 =?us-ascii?Q?wjRve8tjV/LAIPfBx+SRjICwS2sU7/DP3ioFuFyBUEqJKoS0sL2+DtmvTK82?=
 =?us-ascii?Q?Drqh2MRr5S9mEnmwmFxJQN4TQMoVF7OitS1MijpxqjSu3vvdclf8yknr6O98?=
 =?us-ascii?Q?X9AA40PSROIuWUKKibrRtQQ9WaF05nRhN1+ZiM8C89lAUxsNbZbxJsdOHdVd?=
 =?us-ascii?Q?kZWz/YQl59xgbn1lZ/4hymmdbPFDLUgRs6YdlSxBe7wn6/QfdFmjgBgtHllf?=
 =?us-ascii?Q?CU4unvMbp/ReUGNb6sJ475gFZluyp91urxycvF8Gzt2XJ0J2QEmQzoqgLv+w?=
 =?us-ascii?Q?BaJf9mrT2jSbvtKiwkNvMFAUEfFBsxN/NeIEoyYZI71gqVouKQiExHvi+paE?=
 =?us-ascii?Q?RY5q+o1LQnpjJc8DutAVyniAuxx3uK7tVH1ZEY8zqcgWzwgFP4Kd9qTVWzUt?=
 =?us-ascii?Q?xwp9kYrR4J0TCoIpHl+7RqCRU1EUUSvfdr9sGWF8rkvXLG+A+/PFYXTFijOq?=
 =?us-ascii?Q?JomD2sVBt5/98Ai2dmXGADQfGMW9VyoOFJlgT2GOJ1LqUfgMHEQ4IkfGQhUY?=
 =?us-ascii?Q?V9qDybI6RSJkv+Q3F6dCowiYQXb9ZD3X7Sfo8j7QGsVAErjlWBpSuCln49uC?=
 =?us-ascii?Q?ah8pgTw4HMMti29I7r19dYqJi/4EB3CZKBtLR5rQvAUTKHPonggt8VnPYmMc?=
 =?us-ascii?Q?gKUPXQ2vdIQV9wIO1ohaOo147/JSvr+WzcYer+rNa2nvxkEWW+ZJzlrvYEKn?=
 =?us-ascii?Q?qLOEyCls4XqtTQxIjSHzBifrx/kh4b0lCOcirk1iZ6ncIfEYTh/eJVjcnGcu?=
 =?us-ascii?Q?imFn6qtQoXmBwDkRfVRVqDOGRF1+R8mqBi1k20v0Rcs4vvLvVW04Wlo6n4os?=
 =?us-ascii?Q?U7K1lgwnNgfFETta9cZbUKSbKbUJ+/B5WZ18W2WoBhlqqZBEfNB87PNxqKVV?=
 =?us-ascii?Q?t/d7Izw1NMO42Gv7msTKEnKgUna6KBHq6yMttneC8SaLopMBEKjyu04te68w?=
 =?us-ascii?Q?Wvvc2t5MCy3/zuTZQGxq+3TZnyGRAwrRNRmxjh/xuPAE9jTJZbh7yFy6V9ty?=
 =?us-ascii?Q?ZpoYQfBihuU90qWNbnrVRfmLJQL7JrEpu2Mz9Ftu68taX8X72Ml6LgKYAdFe?=
 =?us-ascii?Q?XacklJSAwWPOG/0H/h7rELtNNUtSlPliBE0Y3S25JXjc7NVmr1ApudED4kL4?=
 =?us-ascii?Q?dAQySUFydchbSpBl+sw2lksT0hhI6y0UurWUOVzgJ4Mo7cUB1YVRHqv/9oWw?=
 =?us-ascii?Q?E79GSV/LcA+iJUlZuj8phffEWRPa1LXOVpTAPyPdWdF9ZrXntcuC0PHtqE0k?=
 =?us-ascii?Q?uAX7IBT5axFWtimRHEURi/fPkW/7QuEkOpT/Mt3k5oZCB+YBKL4On1PP9A98?=
 =?us-ascii?Q?athvzOtPGqtHXRp1lLtB6eedr+JVAYEdVvM5kdWbZ/8cmrYQH+/bvpv7XvDQ?=
 =?us-ascii?Q?kyC7+7eBzRg2IDWVIuudb68bRjPIYT8F54G2a2teacFzlIPOFBr7Rx1hzFwv?=
 =?us-ascii?Q?OYJML8xaDSPIn/BGSLH1HSB3BWvinHZ7PRsBdTPvHN+adkxBIptAHGm41LN3?=
 =?us-ascii?Q?GLvgl31a8wGw4OP2edXVobWfqVz95wL0fIoitdsupy9ypOynB9q1i13L4497?=
 =?us-ascii?Q?DbaqEAj4epyp9B1nMwCdrdB/mApUL02K8CeuSKJCfYTnKBQ6qZZn1smbbtGw?=
 =?us-ascii?Q?+5HKXRcyhQ=3D=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 137b2cf6-d1f1-4b21-ede8-08da52c34472
X-MS-Exchange-CrossTenant-AuthSource: DB9PR04MB8477.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Jun 2022 13:46:24.9485
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: JnIQ0xP9UKW7m+Yx3snrLO+XxnZshBSgrt9cCOsHz8kKCI+uRyij94s8okA7tklU63eLNMHvPMnJpGBTbdN6jw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB6190
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE
        autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

The regmap core will create debugfs by default for each instance.
However, it's fairly possible that some devices may not work properly
with regmap registers dump via debugfs due to it may be in suspend
state (e.g. Power domain is off).

Current regmap core does not support runtime pm for MMIO bus.
Although there have been several retries [1] in community but finally
didn't get accepted.

This patch adds an option to allow drivers to claim no debugfs support
due to possible platform limitations.

1. Link: https://lkml.iu.edu/hypermail/linux/kernel/1204.0/01646.html

Cc: Mark Brown <broonie@kernel.org>
Cc: Lucas Stach <l.stach@pengutronix.de>
Signed-off-by: Dong Aisheng <aisheng.dong@nxp.com>
---
 drivers/base/regmap/regmap-debugfs.c | 3 ++-
 drivers/base/regmap/regmap.c         | 3 +++
 include/linux/regmap.h               | 2 ++
 3 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/drivers/base/regmap/regmap-debugfs.c b/drivers/base/regmap/regmap-debugfs.c
index 817eda2075aa..82082a5f1729 100644
--- a/drivers/base/regmap/regmap-debugfs.c
+++ b/drivers/base/regmap/regmap-debugfs.c
@@ -556,9 +556,10 @@ void regmap_debugfs_init(struct regmap *map)
 	 * a mutex or a spinlock, but if the regmap owner decided to disable
 	 * all locking mechanisms, this is no longer the case. For safety:
 	 * don't create the debugfs entries if locking is disabled.
+	 * Or disabled explicitly in driver.
 	 */
 	if (map->debugfs_disable) {
-		dev_dbg(map->dev, "regmap locking disabled - not creating debugfs entries\n");
+		dev_dbg(map->dev, "regmap debugfs disabled - not creating debugfs entries\n");
 		return;
 	}
 
diff --git a/drivers/base/regmap/regmap.c b/drivers/base/regmap/regmap.c
index cb0be5e7b100..bb603b4271ef 100644
--- a/drivers/base/regmap/regmap.c
+++ b/drivers/base/regmap/regmap.c
@@ -812,6 +812,9 @@ struct regmap *__regmap_init(struct device *dev,
 		map->lock_arg = map;
 	}
 
+	if (config->disable_debugfs && !config->disable_locking)
+		regmap_debugfs_disable(map);
+
 	/*
 	 * When we write in fast-paths with regmap_bulk_write() don't allocate
 	 * scratch buffers with sleeping allocations.
diff --git a/include/linux/regmap.h b/include/linux/regmap.h
index d5b08f4f0dc0..db967a331d36 100644
--- a/include/linux/regmap.h
+++ b/include/linux/regmap.h
@@ -282,6 +282,7 @@ typedef void (*regmap_unlock)(void *);
  * @disable_locking: This regmap is either protected by external means or
  *                   is guaranteed not to be accessed from multiple threads.
  *                   Don't use any locking mechanisms.
+ * @disable_debugfs: Optional, don't create debugfs entries for this regmap.
  * @lock:	  Optional lock callback (overrides regmap's default lock
  *		  function, based on spinlock or mutex).
  * @unlock:	  As above for unlocking.
@@ -383,6 +384,7 @@ struct regmap_config {
 	bool (*readable_noinc_reg)(struct device *dev, unsigned int reg);
 
 	bool disable_locking;
+	bool disable_debugfs;
 	regmap_lock lock;
 	regmap_unlock unlock;
 	void *lock_arg;
-- 
2.25.1