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:   Colin Foster <colin.foster@in-advantage.com>
To:     linux-kernel@vger.kernel.org
Cc:     "Rafael J. Wysocki" <rafael@kernel.org>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Mark Brown <broonie@kernel.org>
Subject: [RFC v1 1/2] regmap: add configurable downshift for addresses
Date:   Sun, 13 Mar 2022 15:45:23 -0700
Message-Id: <20220313224524.399947-2-colin.foster@in-advantage.com>
In-Reply-To: <20220313224524.399947-1-colin.foster@in-advantage.com>
References: <20220313224524.399947-1-colin.foster@in-advantage.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?D/P0dpVYRyWnAEW3IbL18oPOPsgxYL+v1RO9K5nayUJu5kyac4fFWWY1wHQ4?=
 =?us-ascii?Q?LxxNtaUicOt4h9vNEPVcR4X3snQZDxVdww0u3k/O6qdAqvP/c+Ico479f3M/?=
 =?us-ascii?Q?2b69e5/eNOkTOb5TNOGw1HUCMuyFCKiE3G+y8881vvl8LzOK2hoLIpfAEe8h?=
 =?us-ascii?Q?ACgS4FGsvvKBbQs/nnoQs+5mai9hNwi5VPJOKunMkbn8aqZn4AjZ3GcYrNIr?=
 =?us-ascii?Q?z17qtRidFiZSl/8P4dpcTPIHRjB92oKxCkhqrdQxllyaOVvwli4bU60IOuEc?=
 =?us-ascii?Q?Ts+9MySpP3/ca3BI6FikIryX6cHnXhdR/GT4tLo8dauHozsycE/6jV4cilu/?=
 =?us-ascii?Q?Id2VSsajo2YuaAj22/ruIe5iCjDsvmI+DROvBcjDgrn16tFroTadAGwZzbrg?=
 =?us-ascii?Q?yYd+pRGAiRQ+70Xd3wZrAmGjD1sZWy5PZtmqHXWO8yKrfsLdquu0GQgUP4vu?=
 =?us-ascii?Q?oTPvE2QYPGf/wfhYSSksSr1vcVdvzLmV1olm78ETMZ+pwa89XpgjLmoS0lYN?=
 =?us-ascii?Q?H6DHxJkQNUMXgUZ001pXBp4fHDKLPN+tzHVkW+0QbOlyv5Ts5ULY03DIMl4K?=
 =?us-ascii?Q?KgD4+0A0Tjb00/VyOrzAIQpxOsOprYW9YVRyE+TT0kCwknM8R6G63muKuokx?=
 =?us-ascii?Q?Nw/ISh/H2ugLlv8V/GvQp55TD2kWiXfZamNeqETHxavR50ri5a8Mc0wYlP8+?=
 =?us-ascii?Q?hsAnejwmJnhm54UP+KAxaHAxiCKWAjtDecVre5vMtrI9HtTvkzMcfCQgeNMc?=
 =?us-ascii?Q?ut9jywQp8mKMraw8PAOag3Iw9aQugvApC/WGqsoYNkDEKyc3w5TyS087CNQ6?=
 =?us-ascii?Q?QALQuZBOD9rMo47K0Ojwktb2W0roIRbcz2xnlyrmzaZDd6hcMSsbcL+LjjwP?=
 =?us-ascii?Q?F2+e6ZFOA7a395lm0xEqGpHKMtUlIL8d9TVT7wPiPsJbia+INFFliXkwwThl?=
 =?us-ascii?Q?gyAKgK/NHBWYM54ZRWy7aRMoswyFTxLqRjUANRe9LWDTtXBHGWuQP5Sa1cEs?=
 =?us-ascii?Q?vlDkWzI4ciQ0gfu40ARQBd2DEgoW0zYEB60xOcjJ2P5Uw6S2KXEMm+otObFS?=
 =?us-ascii?Q?1HhRC3se4lzGvIxN8xoZ3Sew9U3qDqgr8BXSx+APrrESXP6VIUINO8ZqP1TC?=
 =?us-ascii?Q?uudItZulv6nU36mIZkPs32xeSWG2VYeJmM2W857RdvkzP0hr6HHZL3MP7JLD?=
 =?us-ascii?Q?CGRn4F1Tgt1jf7vjL3Al66EP9+x4GNXSvI9hG6f5M3eCigfAV3xj+n0luasl?=
 =?us-ascii?Q?dw11PU0CZwiexO6fLGafKqcPnRc/MIfvHwqdhDjW0tGc6tbbGr61zjj8GsAI?=
 =?us-ascii?Q?QRiTkfaLzxZrlxSlF7U64r4+b16njp4d7MMgfPCLi01CEM2rmYPOaXK1OM1L?=
 =?us-ascii?Q?8/HthW6BVqjV+gCFQLcBGOfUx7qWl4xHB7lkP5cCDoNHRfnNx8A8UCzNrjJq?=
 =?us-ascii?Q?NRGh1uek7hUhNJkwNSHd1UYefSTjeGpYNQVGV0X8Pb4zcvz49KkKQZkkR1QL?=
 =?us-ascii?Q?vdYd8VOIjL8qdcyca/kBSuf25WTeanJ1dBUl5ZGKdfRjBEhajG4NOyfHttI3?=
 =?us-ascii?Q?3H10L/+DJTsY14F1zD/c/QjjQCe7Kb7PiBnJiO/tCO7MB+cxFz4eyoR93GA+?=
 =?us-ascii?Q?T6k8Kw3I7271ZTJMYw3TVYNXBS9jlR+KoArBL86csrj7t7d0gx4my2UnMet/?=
 =?us-ascii?Q?exZ6bQ=3D=3D?=
X-OriginatorOrg: in-advantage.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 8653be31-db17-4cdc-2855-08da05433114
X-MS-Exchange-CrossTenant-AuthSource: MWHPR1001MB2351.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Mar 2022 22:45:37.4136
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 48e842ca-fbd8-4633-a79d-0c955a7d3aae
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: avgMjuFNwGHv2l02JeGVI8onx5CZwiUFB1xqLghYGjhmTgmstYuB4N3ZkkDF7vCPMh9FbZ+2cyQF3xuy09BpXc4tmoDHb78/pzvy0WDWsJs=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR1001MB2379
X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,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

Add an additional reg_downshift to be applied to register addresses before
any register accesses. An example of a device that uses this is a VSC7514
chip, which require each register address to be downshifted by two if the
access is performed over a SPI bus.

Signed-off-by: Colin Foster <colin.foster@in-advantage.com>
---
 drivers/base/regmap/internal.h | 1 +
 drivers/base/regmap/regmap.c   | 5 +++++
 include/linux/regmap.h         | 3 +++
 3 files changed, 9 insertions(+)

diff --git a/drivers/base/regmap/internal.h b/drivers/base/regmap/internal.h
index b1905916f7af..88f710e7ce31 100644
--- a/drivers/base/regmap/internal.h
+++ b/drivers/base/regmap/internal.h
@@ -31,6 +31,7 @@ struct regmap_format {
 	size_t buf_size;
 	size_t reg_bytes;
 	size_t pad_bytes;
+	size_t reg_downshift;
 	size_t val_bytes;
 	void (*format_write)(struct regmap *map,
 			     unsigned int reg, unsigned int val);
diff --git a/drivers/base/regmap/regmap.c b/drivers/base/regmap/regmap.c
index 8f9fe5fd4707..1c7c6d6361af 100644
--- a/drivers/base/regmap/regmap.c
+++ b/drivers/base/regmap/regmap.c
@@ -823,6 +823,7 @@ struct regmap *__regmap_init(struct device *dev,
 
 	map->format.reg_bytes = DIV_ROUND_UP(config->reg_bits, 8);
 	map->format.pad_bytes = config->pad_bits / 8;
+	map->format.reg_downshift = config->reg_downshift;
 	map->format.val_bytes = DIV_ROUND_UP(config->val_bits, 8);
 	map->format.buf_size = DIV_ROUND_UP(config->reg_bits +
 			config->val_bits + config->pad_bits, 8);
@@ -1735,6 +1736,7 @@ static int _regmap_raw_write_impl(struct regmap *map, unsigned int reg,
 			return ret;
 	}
 
+	reg >>= map->format.reg_downshift;
 	map->format.format_reg(map->work_buf, reg, map->reg_shift);
 	regmap_set_work_buf_flag_mask(map, map->format.reg_bytes,
 				      map->write_flag_mask);
@@ -1905,6 +1907,7 @@ static int _regmap_bus_formatted_write(void *context, unsigned int reg,
 			return ret;
 	}
 
+	reg >>= map->format.reg_downshift;
 	map->format.format_write(map, reg, val);
 
 	trace_regmap_hw_write_start(map, reg, 1);
@@ -2346,6 +2349,7 @@ static int _regmap_raw_multi_reg_write(struct regmap *map,
 		unsigned int reg = regs[i].reg;
 		unsigned int val = regs[i].def;
 		trace_regmap_hw_write_start(map, reg, 1);
+		reg >>= map->format.reg_downshift;
 		map->format.format_reg(u8, reg, map->reg_shift);
 		u8 += reg_bytes + pad_bytes;
 		map->format.format_val(u8, val, 0);
@@ -2673,6 +2677,7 @@ static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
 			return ret;
 	}
 
+	reg >>= map->format.reg_downshift;
 	map->format.format_reg(map->work_buf, reg, map->reg_shift);
 	regmap_set_work_buf_flag_mask(map, map->format.reg_bytes,
 				      map->read_flag_mask);
diff --git a/include/linux/regmap.h b/include/linux/regmap.h
index 22652e5fbc38..40fb9399add6 100644
--- a/include/linux/regmap.h
+++ b/include/linux/regmap.h
@@ -237,6 +237,8 @@ typedef void (*regmap_unlock)(void *);
  * @reg_stride: The register address stride. Valid register addresses are a
  *              multiple of this value. If set to 0, a value of 1 will be
  *              used.
+ * @reg_downshift: The number of bits to downshift the register before
+ *		   performing any operations.
  * @pad_bits: Number of bits of padding between register and value.
  * @val_bits: Number of bits in a register value, mandatory.
  *
@@ -360,6 +362,7 @@ struct regmap_config {
 
 	int reg_bits;
 	int reg_stride;
+	int reg_downshift;
 	int pad_bits;
 	int val_bits;
 
-- 
2.25.1