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:     Vladimir Oltean <vladimir.oltean@nxp.com>,
        Lee Jones <lee@kernel.org>
Subject: [PATCH v1 mfd] mfd: ocelot-spi: fix bulk read
Date:   Wed, 22 Mar 2023 07:11:30 -0700
Message-Id: <20230322141130.2531256-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?V8IgH7P5BwE2oPx2XqfO+sO76Os4fO3o1EmrxnOTVh9mx2RhPpM2Ta8XLTJj?=
 =?us-ascii?Q?wIXVNKfpTX9OB8CWVPHzoAcxPWaBi9HLpC483yBamuoaxx6d7JOjuyNmVXMm?=
 =?us-ascii?Q?gxadznOwNvl0cCUubAF9YBbSgdAoqHIOycqakJH7KVPa+7FFmy25vx1DniYT?=
 =?us-ascii?Q?OHxg2AWGioQ6BlOiU+lOKgFhI4V2nkQF1DMewgzjp7kMTquGVuUxYq0XKMRk?=
 =?us-ascii?Q?v4yvcJqvXTUGNhcfUyHYQOxjZq0AXpFVTBg6A862RPWfjPSmV0vP/u/8Slr5?=
 =?us-ascii?Q?GQ8EPnm+hBcmgprNkjiC6bU0pFSDTW+VxLmSrqETyk/jyng8rSQ0Nh6T8Iai?=
 =?us-ascii?Q?gV5JDys5H53CHA4UolDSHbhHvlBkn8y+lUlGEembqIAA0b9LCwrmLykIPZ/V?=
 =?us-ascii?Q?/nctt/S4ijkQuLdVlCEMlhDu2TWEPlvs5Ie10a1U3vH77rjuqhoy6r/oa2/n?=
 =?us-ascii?Q?/fGnryOE8wdZzDf+LArOIJb5fhC+hTEl++SW2FHNTBQFi79Js+ZgyQ0raTRW?=
 =?us-ascii?Q?R+wZOVW9tv0uxVdGcYylRYtBO3F8We4Awn5r8oCP3Vo3Ug9n8EgeNxZ69NIl?=
 =?us-ascii?Q?YmsWtNahZPL/B3jm0rXV+hZfCa/bTh4NJdG5rQ1G0njEcxR121jqyd2ovaVG?=
 =?us-ascii?Q?YontjDJEWPF1W9iSZQlpoX39bXshKQlLKdJarRPOEpYQMgWyECenNHhBmG06?=
 =?us-ascii?Q?9YjisFtO3e0lSQK0Yw+s9DMfxyDXoELpEFWKg29zIvfRQjWG49DrINCfVWGd?=
 =?us-ascii?Q?D2Gn2WZl55V9RZGOGvQ9wjAo65L5cEspHHKI9XjSIyrtXdKmPyk1nwB9JFtx?=
 =?us-ascii?Q?JTj4k/qaP40lff0Tkt+rn9fD+RghT3XC6evirE5MKJ7VqGWrM2Fct4sSxcvf?=
 =?us-ascii?Q?BOyy/WINNiizI0Ukm1kvKILe1CJjMB3W2255PwLihFNyW7iq4uiL9DqFLQ+u?=
 =?us-ascii?Q?HDJJSbGwBtngN/EQXothbWabZHVD8gHxSVyXPDAMhwDojjUYPO1BJzW0ACik?=
 =?us-ascii?Q?TVIhdI9nzy8ErUEOuhLEO8MOYOdSWbbf5FuP492oaF7guhaAdNG52zMXzPz0?=
 =?us-ascii?Q?KeLmTiKmreXZsYc/DqzaGLwh/b12EQl9/yDG065oyGfMnaPWn7QNu7rGI0iJ?=
 =?us-ascii?Q?Z7+1+iRZHMVMrbJkBIv5sDLmyB3WDhHw0mM5OBgmpqmNLxt+mA+/fPI/6VnX?=
 =?us-ascii?Q?gr7c2rwP4QYFdtXwZp/z9dYNX7wwnpjkk1f0t/iEnWKsc51zXwhkDhOeAgiD?=
 =?us-ascii?Q?pENZedWr0Ncn0kkrOl3p0MvfZg/t4SJWT4QzYR+4H5ie49m/YNxdNr/KttoZ?=
 =?us-ascii?Q?HzYJIah2nfgceSM5cBh/o9UIoQPyEpAyz94mR9NMii86xt8pAB2nXT9Fv4ZF?=
 =?us-ascii?Q?iyMy/EmbItFVb2A9Skfb6iS09A+Y7qZjplAn+x8loGNkm2+3Ao73FN8udUXw?=
 =?us-ascii?Q?NwiuZ85ijQrJqqNzpndqr12S4b7gBy/3wNQ/H3foz61WUyt8F9zJ9fFQAad/?=
 =?us-ascii?Q?l0yGdz/o2WiMHTUyVMFvGmdM+ZllDE5W+J2H/aw3le0hnu/+oq3xF++GhVjI?=
 =?us-ascii?Q?wZ1EoR0DFst/sBlQHOcGQa9OpjMY1x5RR3KkIzpnKdY+QJQPsLo9j2uayV2b?=
 =?us-ascii?Q?OuoBHZnJ5HWRBckL6wHLB7E=3D?=
X-OriginatorOrg: in-advantage.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 49a7a36c-3c43-411c-d466-08db2adf5d03
X-MS-Exchange-CrossTenant-AuthSource: MWHPR1001MB2351.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Mar 2023 14:11:43.1850
 (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: CvZBX+EKS0YBsbZfvlDrJSncB5rYhESCkacQIFKO3aaOkyjSLWHQLxbhObOZSuXCoGgkvb1oVyc68LwPUkAXLlgmWm0/YKG8QjdvDtKuJdI=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW4PR10MB6462
X-Spam-Status: No, score=-0.0 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
        RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS
        autolearn=unavailable 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

Ocelot chips (VSC7511, VSC7512, VSC7513, VSC7514) don't support bulk read
operations over SPI.

Many SPI buses have hardware that can optimize consecutive reads.
Essentially an address is written to the chip, and if the SPI controller
continues to toggle the clock, subsequent register values are reported.
This can lead to significant optimizations, because the time between
"address is written to the chip" and "chip starts to report data" can often
take a fixed amount of time.

When support for Ocelot chips were added in commit f3e893626abe ("mfd:
ocelot: Add support for the vsc7512 chip via spi") it was believed that
this optimization was supported. However it is not.

Most register transactions with the Ocelot chips are not done in bulk, so
this bug could go unnoticed. The one scenario where bulk register
operations _are_ performed is when polling port statistics counters, which
was added in commit d87b1c08f38a ("net: mscc: ocelot: use bulk reads for
stats").

Things get slightly more complicated here...

A bug was introduced in commit d4c367650704 ("net: mscc: ocelot: keep
ocelot_stat_layout by reg address, not offset") that broke the optimization
of bulk reads. This means that when Ethernet support for the VSC7512 chip
was added in commit 3d7316ac81ac ("net: dsa: ocelot: add external ocelot
switch control") things were actually working "as expected".

The bulk read opmtimization was discovered, and fixed in commit
6acc72a43eac ("net: mscc: ocelot: fix stats region batching") and the
timing optimizations for SPI were noticed. A bulk read went from ~14ms to
~2ms. But this timing improvement came at the cost of every register
reading zero due the fact that bulk reads don't work.

The read timings increase back to 13-14ms, but that's a price worth paying
in order to receive valid data. This is verified in a DSA setup (cpsw-new
switch tied to port 0 on the VSC7512, after having been running overnight)

     Rx Octets: 16222055 # Counters from CPSW switch
     Tx Octets: 12034702
     Net Octets: 28256757
     p00_rx_octets: 12034702 # Counters from Ocelot switch
     p00_rx_frames_below_65_octets: 0
     p00_rx_frames_65_to_127_octets: 88188
     p00_rx_frames_128_to_255_octets: 13
     p00_rx_frames_256_to_511_octets: 0
     p00_rx_frames_512_to_1023_octets: 0
     p00_rx_frames_over_1526_octets: 3306
     p00_tx_octets: 16222055

Fixes: f3e893626abe ("mfd: ocelot: Add support for the vsc7512 chip via spi")
Signed-off-by: Colin Foster <colin.foster@in-advantage.com>
---
 drivers/mfd/ocelot-spi.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/mfd/ocelot-spi.c b/drivers/mfd/ocelot-spi.c
index 2ecd271de2fb..85021f94e587 100644
--- a/drivers/mfd/ocelot-spi.c
+++ b/drivers/mfd/ocelot-spi.c
@@ -130,6 +130,7 @@ static const struct regmap_config ocelot_spi_regmap_config = {
 
 	.write_flag_mask = 0x80,
 
+	.use_single_read = true,
 	.use_single_write = true,
 	.can_multi_write = false,
 
-- 
2.25.1