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:   Quan Nguyen <quan@os.amperecomputing.com>
To:     Quan Nguyen <quan@os.amperecomputing.com>,
        Corey Minyard <minyard@acm.org>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Brendan Higgins <brendanhiggins@google.com>,
        Benjamin Herrenschmidt <benh@kernel.crashing.org>,
        Joel Stanley <joel@jms.id.au>,
        Andrew Jeffery <andrew@aj.id.au>,
        Wolfram Sang <wsa@kernel.org>,
        openipmi-developer@lists.sourceforge.net,
        devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
        linux-i2c@vger.kernel.org, openbmc@lists.ozlabs.org,
        linux-arm-kernel@lists.infradead.org, linux-aspeed@lists.ozlabs.org
Cc:     Open Source Submission <patches@amperecomputing.com>,
        Phong Vo <phong@os.amperecomputing.com>,
        "Thang Q . Nguyen" <thang@os.amperecomputing.com>
Subject: [PATCH v8 0/3] Add SSIF BMC driver
Date:   Wed, 15 Jun 2022 16:02:56 +0700
Message-Id: <20220615090259.1121405-1-quan@os.amperecomputing.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?WK084hNYKVsV92t7eC7p8XCkRzs8MjfvMtWUYCiuus737+TwIpmukKF6ltDG?=
 =?us-ascii?Q?U4CBaAr2/rtP3OodqeyBfn0aLiyd/ryozOdhJchFvvSMLokEcWT5CtL1ETXR?=
 =?us-ascii?Q?mwr9Kr2jiVusOQRxF6W2KSlZYs7P0rGiwtJg359Xmqjo6BetlhSPoEqkCYN+?=
 =?us-ascii?Q?Jq2VBc2ktVYSAznVFS11lguOoIbZoJhtK2sRqcGOA0fsvTeVGqeDIwxvSX0o?=
 =?us-ascii?Q?d/zj9Yx7qGvC8MoEapdM5mWvFRJXPt2e9LjYEJ89AWs+4/vJFxk7UcdTDjDs?=
 =?us-ascii?Q?I7a/s2357ROgUBsEruMe0YQdQFubv7FToIhDox2FzjanKrrwq2CcZFIJG8Ba?=
 =?us-ascii?Q?kyuBfATJaVveDxE3EUwJNEDEO3gth82Wqlz4wy3bhrE5y4fnX+rpM9E1yilI?=
 =?us-ascii?Q?CTmzIYg687i2W95Mspzrlv0MdFc9UH6SwO0w0CGz+vr7Uy4YaNX0K/qQ+UJP?=
 =?us-ascii?Q?2gdGYwYIjDbcLo7wEQs6Yxgw+E2FA6CLyFjFlO21H4kiwvUp/NyV4qK+VqVr?=
 =?us-ascii?Q?FvUND2S8/8LTNedHznLtF2LLSINKpn7l8hbA0EyUB0X4r3WD68WKfw2PX9YA?=
 =?us-ascii?Q?ouYIM5Ne/j1HyV2zs7n3ZHGpk/UXnrgoh4tUaLTEYhJY3rcB0cWdx7qDLlud?=
 =?us-ascii?Q?ABLB2MfHa8nA/GnWhlGTZ68s9LHSvegwDQYDyjkf4ifVPxK+Af0W7N0ov8Kc?=
 =?us-ascii?Q?vBQMv+NgR7FMJdMWM/a5cyV8XQVk7AVfWC6cHuEnO+GYIxs42PuD4P4QvUM+?=
 =?us-ascii?Q?kUW9vjQ8l6gefE7PGKmJG7Ybk8Kw000YtsUUy4/In6OhMNuZngdP7hsRjmgZ?=
 =?us-ascii?Q?wSlyVfVw05Ns8fRh2RJCqOy5kZkVYHiGZScH+Ur3E1RkDw/JG+vamajfmRlO?=
 =?us-ascii?Q?vXS9BZxX1ENMgMIWUU/9Ce6NVViYYKUNiEJ964hSmkwI9iQ13VWuUGTAsTHn?=
 =?us-ascii?Q?kq96/v3kRzZF5wy3UrY9oa8zBkHMoAdXA7uzmmE+Lv8Yd6q+xL5brPT1tvgo?=
 =?us-ascii?Q?rc37g+CViJTyCtJuFd4VblfQ6NCaTha9cPhtiNzctEvx+sajJao/FRqXAUl3?=
 =?us-ascii?Q?Mur8EGqCZNTKHvogZpXKx9HCki5eO2vGokqWarBFkEMmp34H+rHureniYhB6?=
 =?us-ascii?Q?phPTPCAaX3Bsutp77pcV+JBa5OyMEheRMW1zm99YJi1+hNTZwp6BJTRI+8vW?=
 =?us-ascii?Q?sHNFyys2T+eZUIZUgeobbHiWYUZDcH7iaOGluKvwDHRnu1Rkh/J9ghzbMGK/?=
 =?us-ascii?Q?SNYADiVTu54hH0DZZ53I8cHdgh0ymcQJez13tm6P9g7+esqvgzrxzUYNkk4D?=
 =?us-ascii?Q?rNvqUSKb0zJmbS5LRVBE1jFvcDIDTn9GKeYOG2xyAI1tBhkNE2k9BUSjeZ+v?=
 =?us-ascii?Q?phxlNsjAZtLw8kNgf+Z8M2Ll2+HNcI6uGipTwjPWCawGaVkIvMtkoytdrV2G?=
 =?us-ascii?Q?bT8BSrE5vBPW3RUHQ/AsO4chuH+ywuBDjrTjOQrZRxW6xgroIKi1A/FqoTAe?=
 =?us-ascii?Q?69ZKO3DBHPfV+bH5SVRohHPAB5xnl3O7Jh67EJP93RvJh+z2gtF/CBZgrC1H?=
 =?us-ascii?Q?gPLqt3hvAL2RcUEzdyYlJddJQ3wk/xKSonsCoWhHyyeXY7HDb82wYOOyGmu/?=
 =?us-ascii?Q?zx7neuBbpyLhLWsIE/Ho2G1tLgcMqE0CqtJsPjFAGJ1u0Y6BFtOWUv3Gbxrw?=
 =?us-ascii?Q?3pIHetSo3JXORcbAb0MbNRQXktqd6KMbwlch/TrwdkTgNENkSOBYTc074SnG?=
 =?us-ascii?Q?0wP15tPh2YXGgBw2Lax9Nou1r0yrRwpMe36lqggJyS0rNX6B8xbC?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 86ba64fe-ffe4-41c9-db81-08da4eade872
X-MS-Exchange-CrossTenant-AuthSource: SJ0PR01MB7282.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Jun 2022 09:03:26.7509
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 7Rfdniy5KGFaMAhJ+4b4luAEuSvLVta9oyVB75WaSHRIVkYygELBcElPEpPgQ616Sp7un9AzfphDi7mGKF2UFC1gYn7PHJCnVyxH3GIyL6E=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR01MB2666
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,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

This series add support the SSIF BMC driver which is to perform in-band
IPMI communication with their host in management (BMC) side.

SSIF BMC driver in this series is tested with Aspeed AST2500.

Discussion for v7: https://lkml.org/lkml/2022/4/22/4

v8:
  + Dropped ssif_bmc.h file and move its content to ssif_bmc.c   [Corey]
  + Add struct ipmi_ssif_msg to include/uapi/linux/ipmi_ssif_bmc.h
  header file                                                    [Corey]
  + Use unsigned int for len field in struct ipmi_ssif_msg       [Corey]
  + Avoid using packed structure                                 [Corey]
  + Add comment to clarify the logic flow                        [Corey]
  + Fix multipart read end with len=0 issue                      [Corey]
  + Refactor code handle the too big request message             [Corey]
  + Fix code indentation issue                                   [Corey]
  + Clean buffer before receiving request to avoid garbage        [Quan]
  + Fix the license to SPDX-License-Identifier: GPL-2.0-only      [Quan]

v7:
  + Remove unnecessary del_timer() in response_timeout()         [Corey]
  + Change compatible string from "ampere,ssif-bmc" to "ssif-bmc"  [Jae]
  + Dropped the use of ssif_msg_len() macro, use the len directly [Quan]
  + Solve possible issue if both response timer and ssif_bmc_write()
  occurred at the same time                                      [Corey]
  + Fix wrong return type of ssif_bmc_poll()         [kernel robot test]
  + Refactor and introduce ssif_part_buffer struct to replace the
  response_buf to manage each send/receive part of ssif           [Quan]
  + Change SSIF_BAD_SMBUS state to SSIF_ABORTING state           [Corey]
  + Support abort feature to skip the current bad request/response and
  wait until next new request                                    [Corey]
  + Refactor the PEC calculation to avoid the re-calculate the PEC on
  each I2C_SLAVE_WRITE_RECEIVED event                             [Quan]
  + Fix the use of error-proned idx                              [Corey]
  + Defer the test for valid SMBus command until the read/write part
  is determined                                                   [Quan]
  + Change/split unsupported_smbus_cmd() to
  supported_[write|read]_cmd()                                   [Corey]
  + Abort the request if somehow its size exceeded 255 bytes      [Quan]

v6:
  + Drop the use of slave_enable()                             [Wolfram]
  + Make i2c-aspeed to issue RxCmdLast command on all
  I2C_SLAVE_WRITE_REQUESTED event to assert NAK when slave busy   [Quan]
  + Make i2c slave to return -EBUSY when it's busy                [Quan]
  + Drop the aborting feature as return Completion Code 0xFF may stop
  host to retry and make ipmi_ssif.so fails to load               [Quan]
  + Add timer to recover slave from busy state when no response   [Quan]
  + Clean request/response buffer appropriately                   [Quan]
  + Add some minor change on error and warning messages           [Quan]

v5:
  + Correct the patches order to fix the bisect issue found by
  kernel build robot

v4:
  + Fix recursive spinlock                                      [Graeme]
  + Send response with Completion code 0xFF when aborting         [Quan]
  + Fix warning with dt_binding_check                              [Rob]
  + Change aspeed-ssif-bmc.yaml to ssif-bmc.yaml                  [Quan]
  + Added bounding check on SMBus writes and the whole request     [Dan]
  + Moved buffer to end of struct ssif_bmc_ctx to avoid context
    corruption if somehow buffer is written past the end           [Dan]
  + Return -EINVAL if userspace buffer too small, don't
    silence truncate                                       [Corey, Joel]
  + Not necessary to check NONBLOCK in lock                      [Corey]
  + Enforce one user at a time                                    [Joel]
  + Reject write with invalid response length from userspace     [Corey]
  + Add state machines for better ssif bmc state handling         [Quan]
  + Drop ssif_bmc_aspeed.c and make ssif_bmc.c is generic
    SSIF BMC driver                                               [Quan]
  + Change compatible string "aspeed,ast2500-ssif-bmc" to
    "ampere,ssif-bmc"                                             [Quan]
  + Toggle Slave enable in i2c-aspeed to turn on/off slave mode   [Ryan]
  + Added slave_enable() to struct i2c_algorithm to control
    slave mode and to address the recursive spinlock      [Graeme, Ryan]
  + Abort current request with invalid SMBus write or
    invalid command                                               [Quan]
  + Abort all request if there is pending response                [Quan]
  + Changed validate_pec() to validate_request()                  [Quan]
  + Add unsupported_smbus_cmd() to handle unknown SMBus command   [Quan]
  + Print internal state string for ease investigating issue      [Quan]
  + Move to READY state on SLAVE_STOP event                       [Quan]
  + Change initilize_transfer() to process_smbus_cmd()            [Quan]
  + Introduce functions for each slave event                      [Quan]

v3:
  + Switched binding doc to use DT schema format                   [Rob]
  + Splited into generic ssif_bmc and aspeed-specific      [Corey, Joel]
  + Removed redundant license info                                [Joel]
  + Switched to use traditional if-else                           [Joel]
  + Removed unused ssif_bmc_ioctl()                               [Joel]
  + Made handle_request()/complete_response() to return void      [Joel]
  + Refactored send_ssif_bmc_response() and
  receive_ssif_bmc_request()                                     [Corey]
  + Remove mutex                                                 [Corey]
  + Use spin_lock/unlock_irqsave/restore in callback             [Corey]
  + Removed the unnecessary memset                               [Corey]
  + Switch to use dev_err()                                      [Corey]
  + Combine mask/unmask two interrupts together                  [Corey]
  + Fixed unhandled Tx done with NAK                              [Quan]
  + Late ack'ed Tx done w/wo Ack irq                              [Quan]
  + Use aspeed-specific exported aspeed_set_slave_busy() when
  slave busy to fix the deadlock                 [Graeme, Philipp, Quan]
  + Clean buffer for last multipart read                          [Quan]
  + Handle unknown incoming command                               [Quan]

v2:
  + Fixed compiling error with COMPILE_TEST for arc

Quan Nguyen (3):
  ipmi: ssif_bmc: Add SSIF BMC driver
  bindings: ipmi: Add binding for SSIF BMC driver
  i2c: aspeed: Assert NAK when slave is busy

 .../devicetree/bindings/ipmi/ssif-bmc.yaml    |  38 +
 drivers/char/ipmi/Kconfig                     |  11 +
 drivers/char/ipmi/Makefile                    |   1 +
 drivers/char/ipmi/ssif_bmc.c                  | 880 ++++++++++++++++++
 drivers/i2c/busses/i2c-aspeed.c               |   5 +-
 include/uapi/linux/ipmi_ssif_bmc.h            |  16 +
 6 files changed, 950 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/devicetree/bindings/ipmi/ssif-bmc.yaml
 create mode 100644 drivers/char/ipmi/ssif_bmc.c
 create mode 100644 include/uapi/linux/ipmi_ssif_bmc.h

-- 
2.35.1