From patchwork Wed Jan 11 05:57:25 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tzung-Bi Shih X-Patchwork-Id: 13096073 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 8A9E417D0 for ; Wed, 11 Jan 2023 05:57:50 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 77F0AC4339E; Wed, 11 Jan 2023 05:57:49 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1673416670; bh=gZJkRd+YwpeXHFlqbFLXdbv2NUdIsovMBCE6wHT9zYc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=tBToO+aOq18OuqeYtEvIsF6JLyI6oCXYYUsiIbAYKLHqtLdmZBhIOIChaw+QGQQgE w1Qh8HqXBajqs5fG7d42rUntZmSvFqUrKU+V370V1pyDaG0F8CiQ3likggRX7qf7TN 9s+SVqHMke0DPS71fVoDC52Bcu4V8wF+7kyvafL7gssi+u8JfkXTSW0ejYabyiublL 5jKBwz67qw2cp/AghCJrf1Pj2mWNXQS3lCwiUbqk/8NNzJdnpEwvqic2BBVrJyIB21 JrqfArzStIhM6JOVT4kzoT384IkH1YkB1dpcrzSf4HwGN0WTrq9M4wUH5A9JySoLdW Dt0m0kNFs6t8w== From: Tzung-Bi Shih To: bleung@chromium.org, groeck@chromium.org Cc: chrome-platform@lists.linux.dev, tzungbi@kernel.org, Rob Barnes Subject: [PATCH 1/4] platform/chrome: fix kernel-doc warnings for panic notifier Date: Wed, 11 Jan 2023 13:57:25 +0800 Message-Id: <20230111055728.708990-2-tzungbi@kernel.org> X-Mailer: git-send-email 2.39.0.314.g84b9a713c41-goog In-Reply-To: <20230111055728.708990-1-tzungbi@kernel.org> References: <20230111055728.708990-1-tzungbi@kernel.org> Precedence: bulk X-Mailing-List: chrome-platform@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fix the following kernel-doc warnings: $ ./scripts/kernel-doc -none drivers/platform/chrome/* drivers/platform/chrome/cros_ec_debugfs.c:54: warning: Function parameter or member 'notifier_panic' not described in 'cros_ec_debugfs' $ ./scripts/kernel-doc -none include/linux/platform_data/cros_ec_proto.h include/linux/platform_data/cros_ec_proto.h:187: warning: Function parameter or member 'panic_notifier' not described in 'cros_ec_device' Cc: Rob Barnes Fixes: d90fa2c64d59 ("platform/chrome: cros_ec: Poll EC log on EC panic") Signed-off-by: Tzung-Bi Shih Reviewed-by: Guenter Roeck --- drivers/platform/chrome/cros_ec_debugfs.c | 2 ++ include/linux/platform_data/cros_ec_proto.h | 1 + 2 files changed, 3 insertions(+) diff --git a/drivers/platform/chrome/cros_ec_debugfs.c b/drivers/platform/chrome/cros_ec_debugfs.c index 34f7b46f8761..a98c529d8c69 100644 --- a/drivers/platform/chrome/cros_ec_debugfs.c +++ b/drivers/platform/chrome/cros_ec_debugfs.c @@ -38,6 +38,8 @@ static DECLARE_WAIT_QUEUE_HEAD(cros_ec_debugfs_log_wq); * @log_mutex: mutex to protect circular buffer * @log_poll_work: recurring task to poll EC for new console log data * @panicinfo_blob: panicinfo debugfs blob + * @notifier_panic: notifier_block to let kernel to flush buffered log + * when EC panic */ struct cros_ec_debugfs { struct cros_ec_dev *ec; diff --git a/include/linux/platform_data/cros_ec_proto.h b/include/linux/platform_data/cros_ec_proto.h index 017d502ed66e..a4a3fec15504 100644 --- a/include/linux/platform_data/cros_ec_proto.h +++ b/include/linux/platform_data/cros_ec_proto.h @@ -140,6 +140,7 @@ struct cros_ec_command { * main EC. * @pd: The platform_device used by the mfd driver to interface with the * PD behind an EC. + * @panic_notifier: EC panic notifier. */ struct cros_ec_device { /* These are used by other drivers that want to talk to the EC */ From patchwork Wed Jan 11 05:57:26 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tzung-Bi Shih X-Patchwork-Id: 13096074 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id C94AB17D0 for ; Wed, 11 Jan 2023 05:57:51 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id B780DC433EF; Wed, 11 Jan 2023 05:57:50 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1673416671; bh=21dMGHoId7gi9efAX9NuJf+S3vLBcVm9tLrr+orU57I=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=hmpG4mycjXsWItX4LQ2qGMziie4f25zWYzNKaysLcRTGbGKpNQj6FMmby6rCTNFDT erxL8BgnVSRsw2OWPw86K0xEC4y+SGx+jE7nWpxLwgaP3D+A8uoi3vmafwruKtFeyb 5VXhyBHPfRhq+BPUIk8wbOhjxYqhOW2hrqxUvs1ZYAUHRkujO/5dxPGPnEpOUbvLe+ qc5k1RifWni86Epmpc3SLU9mAhJV6z2fn78yuKT5Lcp64/SYId8fMV3VErKJtTsQJs dw1OhkaF2Lv5/kB/eBPx1FIHPhubmV+MYVS2o1639UUlRSyirFetpidiz0J2C6djR9 DAIaAM639DESA== From: Tzung-Bi Shih To: bleung@chromium.org, groeck@chromium.org Cc: chrome-platform@lists.linux.dev, tzungbi@kernel.org, Evan Green Subject: [PATCH 2/4] platform/chrome: fix kernel-doc warning for suspend_timeout_ms Date: Wed, 11 Jan 2023 13:57:26 +0800 Message-Id: <20230111055728.708990-3-tzungbi@kernel.org> X-Mailer: git-send-email 2.39.0.314.g84b9a713c41-goog In-Reply-To: <20230111055728.708990-1-tzungbi@kernel.org> References: <20230111055728.708990-1-tzungbi@kernel.org> Precedence: bulk X-Mailing-List: chrome-platform@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fix the following kernel-doc warning: $ ./scripts/kernel-doc -none include/linux/platform_data/cros_ec_proto.h include/linux/platform_data/cros_ec_proto.h:187: warning: Function parameter or member 'suspend_timeout_ms' not described in 'cros_ec_device' Cc: Evan Green Fixes: e8bf17d58a4d ("platform/chrome: cros_ec: Expose suspend_timeout_ms in debugfs") Signed-off-by: Tzung-Bi Shih Reviewed-by: Guenter Roeck --- include/linux/platform_data/cros_ec_proto.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/include/linux/platform_data/cros_ec_proto.h b/include/linux/platform_data/cros_ec_proto.h index a4a3fec15504..805dcb19a36d 100644 --- a/include/linux/platform_data/cros_ec_proto.h +++ b/include/linux/platform_data/cros_ec_proto.h @@ -131,6 +131,11 @@ struct cros_ec_command { * @event_data: Raw payload transferred with the MKBP event. * @event_size: Size in bytes of the event data. * @host_event_wake_mask: Mask of host events that cause wake from suspend. + * @suspend_timeout_ms: The timeout in milliseconds between when sleep event + * is received and when the EC will declare sleep + * transition failure if the sleep signal is not + * asserted. See also struct + * ec_params_host_sleep_event_v1 in cros_ec_commands.h. * @last_event_time: exact time from the hard irq when we got notified of * a new event. * @notifier_ready: The notifier_block to let the kernel re-query EC From patchwork Wed Jan 11 05:57:27 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tzung-Bi Shih X-Patchwork-Id: 13096075 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 1787217D0 for ; Wed, 11 Jan 2023 05:57:53 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 0364DC433F0; Wed, 11 Jan 2023 05:57:51 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1673416672; bh=b5DLEJVqYwKoFXxvAyztyTc02fDB5soZPzUlX9HIQmw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=nTOSAz+N/h/noLFQcybAun3dU9MjN0W+ukDMHIng9I0Vch5j9+1iO9FVhgVTOMew0 4pyTjP341Dy29F03fG8mMvuunTqsHpwmpz2FtuTTggBDUctaCDI7s6Cm0sGO2TgkgO xzOwwhSd9UNcjc9vgKY+MhnpaH9BXJkWb9a7FlxROb3Etpv9kkrQVx2Zv27zq8ajyU 42PgzJABq0LRuVGfcKQLe+n+HLgoGF6FR0C/irtJcA99Kp/S0w8dqbLrT5gOrBPiB+ zLIXfnaE/VrrRzjr/1YrxTLo2nbw+n58LLwa9MfeFE0PJzr2a3QBMKY7UTdiB48DrI vW9AFjxVTPKQA== From: Tzung-Bi Shih To: bleung@chromium.org, groeck@chromium.org Cc: chrome-platform@lists.linux.dev, tzungbi@kernel.org, Evan Green Subject: [PATCH 3/4] platform/chrome: fix kernel-doc warning for last_resume_result Date: Wed, 11 Jan 2023 13:57:27 +0800 Message-Id: <20230111055728.708990-4-tzungbi@kernel.org> X-Mailer: git-send-email 2.39.0.314.g84b9a713c41-goog In-Reply-To: <20230111055728.708990-1-tzungbi@kernel.org> References: <20230111055728.708990-1-tzungbi@kernel.org> Precedence: bulk X-Mailing-List: chrome-platform@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fix the following kernel-doc warning: $ ./scripts/kernel-doc -none include/linux/platform_data/cros_ec_proto.h include/linux/platform_data/cros_ec_proto.h:187: warning: Function parameter or member 'last_resume_result' not described in 'cros_ec_device' Cc: Evan Green Fixes: 8c3166e17cf1 ("mfd / platform: cros_ec_debugfs: Expose resume result via debugfs") Signed-off-by: Tzung-Bi Shih Reviewed-by: Guenter Roeck --- include/linux/platform_data/cros_ec_proto.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/include/linux/platform_data/cros_ec_proto.h b/include/linux/platform_data/cros_ec_proto.h index 805dcb19a36d..4865c54d4af1 100644 --- a/include/linux/platform_data/cros_ec_proto.h +++ b/include/linux/platform_data/cros_ec_proto.h @@ -136,6 +136,10 @@ struct cros_ec_command { * transition failure if the sleep signal is not * asserted. See also struct * ec_params_host_sleep_event_v1 in cros_ec_commands.h. + * @last_resume_result: The number of sleep power signal transitions that + * occurred since the suspend message. The high bit + * indicates a timeout occurred. See also struct + * ec_response_host_sleep_event_v1 in cros_ec_commands.h. * @last_event_time: exact time from the hard irq when we got notified of * a new event. * @notifier_ready: The notifier_block to let the kernel re-query EC From patchwork Wed Jan 11 05:57:28 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tzung-Bi Shih X-Patchwork-Id: 13096076 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5161C17D0 for ; Wed, 11 Jan 2023 05:57:54 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 44BDEC433F2; Wed, 11 Jan 2023 05:57:53 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1673416674; bh=de0WESFS2rsisXq8QwQ4tzbqzLKAECqzr79yACXqNDM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=t0Mi5fdq6Mhui/Kni8OlT3i1sZSW/HZSbWV8GDFGXEsJIbFa1BR/a/WN2Qd7CVmKK 7/63vgj/tBySzLyIbyjZccwptxzNyD4gxabU40s2XYmHUjtblK3ZLP2IOvYvb6jU4u myppjUurvqvk01RBzCrDyWbusCmEGxD9DunqvChIZlb+VW3hX9zyMwY4ly4MDTzjTq B2e38pVUFgx3tMspGvoJyp2bDU9oE2NIxmiY1mnM2N+WOIYjcK+c+we8zBpaHmYX8J YEox7S3MNO2bTZJV8AVr+CWvpD5TAFDW2VQzXVlhYKmZmpK7VqQ4xZs4TXtXIFWg3E RXf7zZSJLJqCQ== From: Tzung-Bi Shih To: bleung@chromium.org, groeck@chromium.org Cc: chrome-platform@lists.linux.dev, tzungbi@kernel.org Subject: [PATCH 4/4] platform/chrome: fix kernel-doc warnings for cros_ec_command Date: Wed, 11 Jan 2023 13:57:28 +0800 Message-Id: <20230111055728.708990-5-tzungbi@kernel.org> X-Mailer: git-send-email 2.39.0.314.g84b9a713c41-goog In-Reply-To: <20230111055728.708990-1-tzungbi@kernel.org> References: <20230111055728.708990-1-tzungbi@kernel.org> Precedence: bulk X-Mailing-List: chrome-platform@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fix the following kernel-doc warnings: $ ./scripts/kernel-doc -none \ include/linux/platform_data/cros_ec_commands.h include/linux/platform_data/cros_ec_commands.h:1092: warning: expecting prototype for struct ec_response_get_cmd_version. Prototype was for struct ec_response_get_cmd_versions instead include/linux/platform_data/cros_ec_commands.h:5485: warning: This comment starts with '/**', but isn't a kernel-doc comment. include/linux/platform_data/cros_ec_commands.h:5496: warning: This comment starts with '/**', but isn't a kernel-doc comment. Signed-off-by: Tzung-Bi Shih Reviewed-by: Guenter Roeck --- include/linux/platform_data/cros_ec_commands.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/include/linux/platform_data/cros_ec_commands.h b/include/linux/platform_data/cros_ec_commands.h index 6665e7da6ee2..b9c4a3964247 100644 --- a/include/linux/platform_data/cros_ec_commands.h +++ b/include/linux/platform_data/cros_ec_commands.h @@ -1082,7 +1082,7 @@ struct ec_params_get_cmd_versions_v1 { } __ec_align2; /** - * struct ec_response_get_cmd_version - Response to the get command versions. + * struct ec_response_get_cmd_versions - Response to the get command versions. * @version_mask: Mask of supported versions; use EC_VER_MASK() to compare with * a desired version. */ @@ -5480,7 +5480,7 @@ struct ec_response_rollback_info { /* Issue AP reset */ #define EC_CMD_AP_RESET 0x0125 -/** +/* * Get the number of peripheral charge ports */ #define EC_CMD_PCHG_COUNT 0x0134 @@ -5491,7 +5491,7 @@ struct ec_response_pchg_count { uint8_t port_count; } __ec_align1; -/** +/* * Get the status of a peripheral charge port */ #define EC_CMD_PCHG 0x0135