From patchwork Fri Oct 16 21:48:48 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Brendan Higgins X-Patchwork-Id: 1383544 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=vger.kernel.org (client-ip=23.128.96.18; helo=vger.kernel.org; envelope-from=linux-i2c-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=google.com header.i=@google.com header.a=rsa-sha256 header.s=20161025 header.b=S+El3eZy; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by ozlabs.org (Postfix) with ESMTP id 4CCftL62jyz9sTm for ; Sat, 17 Oct 2020 08:48:58 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730190AbgJPVs4 (ORCPT ); Fri, 16 Oct 2020 17:48:56 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37694 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729812AbgJPVsz (ORCPT ); Fri, 16 Oct 2020 17:48:55 -0400 Received: from mail-qt1-x84a.google.com (mail-qt1-x84a.google.com [IPv6:2607:f8b0:4864:20::84a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9125FC0613D3 for ; Fri, 16 Oct 2020 14:48:55 -0700 (PDT) Received: by mail-qt1-x84a.google.com with SMTP id r4so2230138qta.9 for ; Fri, 16 Oct 2020 14:48:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=sender:date:message-id:mime-version:subject:from:to:cc; bh=P6542iFjzIxhW/Ai7OlkTSTs7qsIdc5xSdhGTRbGtXc=; b=S+El3eZyVaVSqlz4/J5tkU8vPyNZy99wptSxALbU6IfNKWagH1b9X/3lI7psn4XcVl eKeoaVThIuCCMaltdOqct4ymIZjX3F3lyAqOVZVJzz3j/KfFtW3z64b0TCDQMPuUcPZA +Ey9Kavce9oCy3Sc5p/E5P4ROiAq7SlTdCWduOuDbM0tx6Jq61jw0KAw4ImqH5DQiMYz p+Pk7NaiCneFWkMhMWVWtlAABYb+U72i9F1Bf3/U74EPMkiBD/J0cExd3MDUlPCSZsTb jjcyI0Cs28y7+JMMlwu8K6MTKMLBN5rgDH2L4M8RCqG1TDTtSnBYHOWtXCKG2PSjixJ9 GmSg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:date:message-id:mime-version:subject:from :to:cc; bh=P6542iFjzIxhW/Ai7OlkTSTs7qsIdc5xSdhGTRbGtXc=; b=YDXoNI1NurgH7HULR3Pb5YSU/H6CAu6vo6p65j53QS/hGQVKGDSqdpNjtYdHUxn9YX TzVyHwKQDdUpZZWSVicLwCoxZF73l5Pe9MTev3cGx7c9KXwuwP7bakF7ob+gn47pJivl 0z+TgvQSC0r2EKE6zBnV03ZLUspK0mpNaL1GZcZ4Oo9duZ1RDV2Fj7IAwjzIrPxPRvbW PJdVlihMIyDhk+3CktqATUyzX2HbeKCL/R9mnQl79m4AR4/hW7jSgyi/sqNhPje/2gFf 2uumB68cY6L9MZDLJPSN8yzCEaba3Exn1HNAAGQtUQxcvbmjoXpces9CMuoqEFtIUkaF I79A== X-Gm-Message-State: AOAM532M62oUPqKWZdm3eO7cwUGySH/3lr3rRNWjPhqinCYbzNg52W6G gvEs5kKpgsftdnhcKnCnL0keyhA1XEj1g5N/+VvKUQ== X-Google-Smtp-Source: ABdhPJwJRry5vBRa1jfPAJOez+Y/ph2mkEMy723ZOXVSFN61OqeGxSgh+T4OCzOemdYUkmi46VcmmjE/4lQoh3AG38ZDnQ== Sender: "brendanhiggins via sendgmr" X-Received: from mactruck.svl.corp.google.com ([2620:15c:2cb:201:c634:6bff:fe71:d8d1]) (user=brendanhiggins job=sendgmr) by 2002:ad4:4e73:: with SMTP id ec19mr6256788qvb.58.1602884934546; Fri, 16 Oct 2020 14:48:54 -0700 (PDT) Date: Fri, 16 Oct 2020 14:48:48 -0700 Message-Id: <20201016214848.1365719-1-brendanhiggins@google.com> Mime-Version: 1.0 X-Mailer: git-send-email 2.29.0.rc1.297.gfa9743e501-goog Subject: [PATCH v1] i2c: aspeed: add KUnit tests for clock parameters From: Brendan Higgins To: shuah@kernel.org, davidgow@google.com, benh@kernel.crashing.org, joel@jms.id.au, andrew@aj.id.au, wsa@kernel.org Cc: linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, linux-i2c@vger.kernel.org, openbmc@lists.ozlabs.org, linux-aspeed@lists.ozlabs.org, benjaminfair@google.com, Brendan Higgins Precedence: bulk List-ID: X-Mailing-List: linux-i2c@vger.kernel.org Add KUnit tests for Aspeed I2C driver to test setting clock divider registers given an input clock speed. I wrote this test a while ago and it found a bug in the Aspeed I2C driver a couple years ago[1]. Link[1]: https://lore.kernel.org/patchwork/patch/989312/ Signed-off-by: Brendan Higgins --- MAINTAINERS | 1 + drivers/i2c/busses/Kconfig | 18 ++- drivers/i2c/busses/i2c-aspeed-test.c | 218 +++++++++++++++++++++++++++ drivers/i2c/busses/i2c-aspeed.c | 4 + 4 files changed, 240 insertions(+), 1 deletion(-) create mode 100644 drivers/i2c/busses/i2c-aspeed-test.c base-commit: 1abdd39f14b25dd2d69096b624a4f86f158a9feb diff --git a/MAINTAINERS b/MAINTAINERS index deaafb617361c..683382df2434a 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1653,6 +1653,7 @@ L: openbmc@lists.ozlabs.org (moderated for non-subscribers) S: Maintained F: Documentation/devicetree/bindings/i2c/i2c-aspeed.txt F: Documentation/devicetree/bindings/interrupt-controller/aspeed,ast2400-i2c-ic.txt +F: drivers/i2c/busses/i2c-aspeed-test.c F: drivers/i2c/busses/i2c-aspeed.c F: drivers/irqchip/irq-aspeed-i2c-ic.c diff --git a/drivers/i2c/busses/Kconfig b/drivers/i2c/busses/Kconfig index 293e7a0760e77..0f12090f9fe26 100644 --- a/drivers/i2c/busses/Kconfig +++ b/drivers/i2c/busses/Kconfig @@ -379,7 +379,7 @@ config I2C_ALTERA config I2C_ASPEED tristate "Aspeed I2C Controller" - depends on ARCH_ASPEED || COMPILE_TEST + depends on ARCH_ASPEED || COMPILE_TEST || KUNIT=y help If you say yes to this option, support will be included for the Aspeed I2C controller. @@ -387,6 +387,22 @@ config I2C_ASPEED This driver can also be built as a module. If so, the module will be called i2c-aspeed. +config I2C_ASPEED_KUNIT_TEST + bool "Aspeed I2C Controller KUnit test" + depends on I2C_ASPEED=y + help + This builds the Aspeed I2C KUnit tests. + + KUnit tests run during boot and output the results to the debug log + in TAP format (https://testanything.org/). Only useful for kernel devs + running KUnit test harness and are not for inclusion into a + production build. + + For more information on KUnit and unit tests in general please refer + to the KUnit documentation in Documentation/dev-tools/kunit/. + + If unsure, say N. + config I2C_AT91 tristate "Atmel AT91 I2C Two-Wire interface (TWI)" depends on ARCH_AT91 || COMPILE_TEST diff --git a/drivers/i2c/busses/i2c-aspeed-test.c b/drivers/i2c/busses/i2c-aspeed-test.c new file mode 100644 index 0000000000000..93e73af95b645 --- /dev/null +++ b/drivers/i2c/busses/i2c-aspeed-test.c @@ -0,0 +1,218 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* + * Aspeed 24XX/25XX I2C Controller KUnit tests. + * + * Copyright (C) 2020 Google LLC. + */ + +#include + +#define ASPEED_I2C_MAX_BASE_DIVISOR (1 << ASPEED_I2CD_TIME_BASE_DIVISOR_MASK) +#define ASPEED_I2C_24XX_CLK_HIGH_LOW_MASK GENMASK(2, 0) +#define ASPEED_I2C_24XX_CLK_HIGH_LOW_MAX ((ASPEED_I2C_24XX_CLK_HIGH_LOW_MASK + 1) * 2) +#define ASPEED_I2C_24XX_MAX_DIVISOR \ + (ASPEED_I2C_MAX_BASE_DIVISOR * ASPEED_I2C_24XX_CLK_HIGH_LOW_MAX) +#define ASPEED_I2C_25XX_CLK_HIGH_LOW_MASK GENMASK(3, 0) +#define ASPEED_I2C_25XX_CLK_HIGH_LOW_MAX ((ASPEED_I2C_25XX_CLK_HIGH_LOW_MASK + 1) * 2) +#define ASPEED_I2C_25XX_MAX_DIVISOR \ + (ASPEED_I2C_MAX_BASE_DIVISOR * ASPEED_I2C_25XX_CLK_HIGH_LOW_MAX) + +static u32 aspeed_i2c_get_base_clk(u32 reg_val) +{ + return reg_val & ASPEED_I2CD_TIME_BASE_DIVISOR_MASK; +} + +static u32 aspeed_i2c_get_clk_high(u32 reg_val) +{ + return (reg_val & ASPEED_I2CD_TIME_SCL_HIGH_MASK) >> + ASPEED_I2CD_TIME_SCL_HIGH_SHIFT; +} + +static u32 aspeed_i2c_get_clk_low(u32 reg_val) +{ + return (reg_val & ASPEED_I2CD_TIME_SCL_LOW_MASK) >> + ASPEED_I2CD_TIME_SCL_LOW_SHIFT; +} + +static void aspeed_i2c_get_clk_reg_val_params_test(struct kunit *test, + u32 (*get_clk_reg_val)(struct device *, u32), + u32 divisor, + u32 base_clk, + u32 clk_high, + u32 clk_low) +{ + u32 reg_val; + + reg_val = get_clk_reg_val(NULL, divisor); + KUNIT_ASSERT_EQ(test, + (u32)(reg_val & ~(ASPEED_I2CD_TIME_SCL_HIGH_MASK | + ASPEED_I2CD_TIME_SCL_LOW_MASK | + ASPEED_I2CD_TIME_BASE_DIVISOR_MASK)), + (u32)0); + KUNIT_EXPECT_EQ(test, aspeed_i2c_get_base_clk(reg_val), base_clk); + KUNIT_EXPECT_EQ(test, aspeed_i2c_get_clk_high(reg_val), clk_high); + KUNIT_EXPECT_EQ(test, aspeed_i2c_get_clk_low(reg_val), clk_low); +} + +static void aspeed_i2c_24xx_get_clk_reg_val_params_test(struct kunit *test, + u32 divisor, + u32 base_clk, + u32 clk_high, + u32 clk_low) +{ + aspeed_i2c_get_clk_reg_val_params_test(test, + aspeed_i2c_24xx_get_clk_reg_val, + divisor, + base_clk, + clk_high, + clk_low); +} + +/* + * Verify that smallest possible divisors are handled correctly. + */ +static void aspeed_i2c_24xx_get_clk_reg_val_test_min(struct kunit *test) +{ + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 0, 0, 0, 0); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 1, 0, 0, 0); +} + +/* + * Verify that largest possible divisors are handled correctly. + */ +static void aspeed_i2c_24xx_get_clk_reg_val_test_max(struct kunit *test) +{ + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, + ASPEED_I2C_24XX_MAX_DIVISOR, + ASPEED_I2CD_TIME_BASE_DIVISOR_MASK, + ASPEED_I2C_24XX_CLK_HIGH_LOW_MASK, + ASPEED_I2C_24XX_CLK_HIGH_LOW_MASK); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, + ASPEED_I2C_24XX_MAX_DIVISOR + 1, + ASPEED_I2CD_TIME_BASE_DIVISOR_MASK, + ASPEED_I2C_24XX_CLK_HIGH_LOW_MASK, + ASPEED_I2C_24XX_CLK_HIGH_LOW_MASK); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, + U32_MAX, + ASPEED_I2CD_TIME_BASE_DIVISOR_MASK, + ASPEED_I2C_24XX_CLK_HIGH_LOW_MASK, + ASPEED_I2C_24XX_CLK_HIGH_LOW_MASK); +} + +/* + * Spot check values from the datasheet table. + */ +static void aspeed_i2c_24xx_get_clk_reg_val_test_datasheet(struct kunit *test) +{ + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 6, 0, 2, 2); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 7, 0, 3, 2); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 16, 0, 7, 7); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 18, 1, 4, 3); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 491520, 15, 7, 6); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 524288, 15, 7, 7); +} + +/* + * Check that a divisor that cannot be represented exactly is rounded up to the + * next divisor that can be represented. + */ +static void aspeed_i2c_24xx_get_clk_reg_val_test_round_up(struct kunit *test) +{ + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 16, 0, 7, 7); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 17, 1, 4, 3); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 18, 1, 4, 3); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 19, 1, 4, 4); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 491519, 15, 7, 6); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 491520, 15, 7, 6); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 524287, 15, 7, 7); + aspeed_i2c_24xx_get_clk_reg_val_params_test(test, 524288, 15, 7, 7); +} + +static void aspeed_i2c_25xx_get_clk_reg_val_params_test(struct kunit *test, + u32 divisor, + u32 base_clk, + u32 clk_high, + u32 clk_low) +{ + aspeed_i2c_get_clk_reg_val_params_test(test, + aspeed_i2c_25xx_get_clk_reg_val, + divisor, + base_clk, + clk_high, + clk_low); +} + +/* + * Verify that smallest possible divisors are handled correctly. + */ +static void aspeed_i2c_25xx_get_clk_reg_val_test_min(struct kunit *test) +{ + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 0, 0, 0, 0); + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 1, 0, 0, 0); +} + +/* + * Verify that largest possible divisors are handled correctly. + */ +static void aspeed_i2c_25xx_get_clk_reg_val_test_max(struct kunit *test) +{ + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, + ASPEED_I2C_25XX_MAX_DIVISOR, + ASPEED_I2CD_TIME_BASE_DIVISOR_MASK, + ASPEED_I2C_25XX_CLK_HIGH_LOW_MASK, + ASPEED_I2C_25XX_CLK_HIGH_LOW_MASK); + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, + ASPEED_I2C_25XX_MAX_DIVISOR + 1, + ASPEED_I2CD_TIME_BASE_DIVISOR_MASK, + ASPEED_I2C_25XX_CLK_HIGH_LOW_MASK, + ASPEED_I2C_25XX_CLK_HIGH_LOW_MASK); + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, + U32_MAX, + ASPEED_I2CD_TIME_BASE_DIVISOR_MASK, + ASPEED_I2C_25XX_CLK_HIGH_LOW_MASK, + ASPEED_I2C_25XX_CLK_HIGH_LOW_MASK); +} + +/* + * Spot check values from the datasheet table. + */ +static void aspeed_i2c_25xx_get_clk_reg_val_test_datasheet(struct kunit *test) +{ + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 6, 0, 2, 2); + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 7, 0, 3, 2); + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 32, 0, 15, 15); + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 34, 1, 8, 7); + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 2048, 6, 15, 15); + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 2176, 7, 8, 7); + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 3072, 7, 11, 11); +} + +/* + * Check that a divisor that cannot be represented exactly is rounded up to the + * next divisor that can be represented. + */ +static void aspeed_i2c_25xx_get_clk_reg_val_test_round_up(struct kunit *test) +{ + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 2047, 6, 15, 15); + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 2048, 6, 15, 15); + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 2175, 7, 8, 7); + aspeed_i2c_25xx_get_clk_reg_val_params_test(test, 2176, 7, 8, 7); +} + +static struct kunit_case aspeed_i2c_test_cases[] = { + KUNIT_CASE(aspeed_i2c_24xx_get_clk_reg_val_test_min), + KUNIT_CASE(aspeed_i2c_24xx_get_clk_reg_val_test_max), + KUNIT_CASE(aspeed_i2c_24xx_get_clk_reg_val_test_datasheet), + KUNIT_CASE(aspeed_i2c_24xx_get_clk_reg_val_test_round_up), + KUNIT_CASE(aspeed_i2c_25xx_get_clk_reg_val_test_min), + KUNIT_CASE(aspeed_i2c_25xx_get_clk_reg_val_test_max), + KUNIT_CASE(aspeed_i2c_25xx_get_clk_reg_val_test_datasheet), + KUNIT_CASE(aspeed_i2c_25xx_get_clk_reg_val_test_round_up), + {}, +}; + +static struct kunit_suite aspeed_i2c_test = { + .name = "aspeed-i2c", + .test_cases = aspeed_i2c_test_cases, +}; +kunit_test_suite(aspeed_i2c_test); diff --git a/drivers/i2c/busses/i2c-aspeed.c b/drivers/i2c/busses/i2c-aspeed.c index 31268074c4221..68c460b7d4def 100644 --- a/drivers/i2c/busses/i2c-aspeed.c +++ b/drivers/i2c/busses/i2c-aspeed.c @@ -1082,6 +1082,10 @@ static struct platform_driver aspeed_i2c_bus_driver = { }; module_platform_driver(aspeed_i2c_bus_driver); +#ifdef CONFIG_I2C_ASPEED_KUNIT_TEST +#include "i2c-aspeed-test.c" +#endif /* CONFIG_I2C_ASPEED_KUNIT_TEST */ + MODULE_AUTHOR("Brendan Higgins "); MODULE_DESCRIPTION("Aspeed I2C Bus Driver"); MODULE_LICENSE("GPL v2");