From: Brad Campbell <brad@fnarfbargle.com>
To: Guenter Roeck <linux@roeck-us.net>, Henrik Rydberg <rydberg@bitmath.org>
Cc: Arnd Bergmann <arnd@arndb.de>,
linux-hwmon@vger.kernel.org,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
hns@goldelico.com, Andreas Kemnade <andreas@kemnade.info>,
Jean Delvare <jdelvare@suse.com>
Subject: Re: [PATCH v3] applesmc: Re-work SMC comms
Date: Mon, 9 Nov 2020 11:25:15 +1100 [thread overview]
Message-ID: <b00cffd1-96ed-775f-cc18-a16e1fff3ca2@fnarfbargle.com> (raw)
In-Reply-To: <db65e8ba-80fd-2142-56f2-8f625defb160@roeck-us.net>
On 9/11/20 3:06 am, Guenter Roeck wrote:
> On 11/8/20 2:14 AM, Henrik Rydberg wrote:
>> On Sun, Nov 08, 2020 at 09:35:28AM +0100, Henrik Rydberg wrote:
>>> Hi Brad,
>>>
>>> On 2020-11-08 02:00, Brad Campbell wrote:
>>>> G'day Henrik,
>>>>
>>>> I noticed you'd also loosened up the requirement for SMC_STATUS_BUSY in read_smc(). I assume
>>>> that causes problems on the early Macbook. This is revised on the one sent earlier.
>>>> If you could test this on your Air1,1 it'd be appreciated.
>>>
>>> No, I managed to screw up the patch; you can see that I carefully added the
>>> same treatment for the read argument, being unsure if the BUSY state would
>>> remain during the AVAILABLE data phase. I can check that again, but
>>> unfortunately the patch in this email shows the same problem.
>>>
>>> I think it may be worthwhile to rethink the behavior of wait_status() here.
>>> If one machine shows no change after a certain status bit change, then
>>> perhaps the others share that behavior, and we are waiting in vain. Just
>>> imagine how many years of cpu that is, combined. ;-)
>>
>> Here is a modification along that line.
>>
>
> Please resend this patch as stand-alone v4 patch. If sent like it was sent here,
> it doesn't make it into patchwork, and is thus not only difficult to apply but
> may get lost, and it is all but impossible to find and apply all tags.
> Also, prior to Henrik's Signed=off-by: there should be a one-line explanation
> of the changes made.
G'day Guenter,
Yes, I'll do that. I still have some more testing to do before it's pushed forwards.
Regards,
Brad
>
>> Compared to your latest version, this one has wait_status() return the
>> actual status on success. Instead of waiting for BUSY, it waits for
>> the other status bits, and checks BUSY afterwards. So as not to wait
>> unneccesarily, the udelay() is placed together with the single
>> outb(). The return value of send_byte_data() is augmented with
>> -EAGAIN, which is then used in send_command() to create the resend
>> loop.
>>
>> I reach 41 reads per second on the MBA1,1 with this version, which is
>> getting close to the performance prior to the problems.
>>
>> >From b4405457f4ba07cff7b7e4f48c47668bee176a25 Mon Sep 17 00:00:00 2001
>> From: Brad Campbell <brad@fnarfbargle.com>
>> Date: Sun, 8 Nov 2020 12:00:03 +1100
>> Subject: [PATCH] hwmon: (applesmc) Re-work SMC comms
>>
>> Commit fff2d0f701e6 ("hwmon: (applesmc) avoid overlong udelay()")
>> introduced an issue whereby communication with the SMC became
>> unreliable with write errors like :
>>
>> [ 120.378614] applesmc: send_byte(0x00, 0x0300) fail: 0x40
>> [ 120.378621] applesmc: LKSB: write data fail
>> [ 120.512782] applesmc: send_byte(0x00, 0x0300) fail: 0x40
>> [ 120.512787] applesmc: LKSB: write data fail
>>
>> The original code appeared to be timing sensitive and was not reliable
>> with the timing changes in the aforementioned commit.
>>
>> This patch re-factors the SMC communication to remove the timing
>> dependencies and restore function with the changes previously
>> committed.
>>
>> Tested on : MacbookAir6,2 MacBookPro11,1 iMac12,2, MacBookAir1,1,
>> MacBookAir3,1
>>
>> Fixes: fff2d0f701e6 ("hwmon: (applesmc) avoid overlong udelay()")
>> Reported-by: Andreas Kemnade <andreas@kemnade.info>
>> Tested-by: Andreas Kemnade <andreas@kemnade.info> # MacBookAir6,2
>> Acked-by: Arnd Bergmann <arnd@arndb.de>
>> Signed-off-by: Brad Campbell <brad@fnarfbargle.com>
>> Signed-off-by: Henrik Rydberg <rydberg@bitmath.org>
>>
>> ---
>> Changelog :
>> v1 : Inital attempt
>> v2 : Address logic and coding style
>> v3 : Removed some debug hangover. Added tested-by. Modifications for MacBookAir1,1
>> v4 : Do not expect busy state to appear without other state changes
>>
>> diff --git a/drivers/hwmon/applesmc.c b/drivers/hwmon/applesmc.c
>> index a18887990f4a..ea7c66d5788e 100644
>> --- a/drivers/hwmon/applesmc.c
>> +++ b/drivers/hwmon/applesmc.c
>> @@ -32,6 +32,7 @@
>> #include <linux/hwmon.h>
>> #include <linux/workqueue.h>
>> #include <linux/err.h>
>> +#include <linux/bits.h>
>>
>> /* data port used by Apple SMC */
>> #define APPLESMC_DATA_PORT 0x300
>> @@ -42,6 +43,11 @@
>>
>> #define APPLESMC_MAX_DATA_LENGTH 32
>>
>> +/* Apple SMC status bits */
>> +#define SMC_STATUS_AWAITING_DATA BIT(0) /* SMC has data waiting */
>> +#define SMC_STATUS_IB_CLOSED BIT(1) /* Will ignore any input */
>> +#define SMC_STATUS_BUSY BIT(2) /* Command in progress */
>> +
>> /* wait up to 128 ms for a status change. */
>> #define APPLESMC_MIN_WAIT 0x0010
>> #define APPLESMC_RETRY_WAIT 0x0100
>> @@ -151,65 +157,78 @@ static unsigned int key_at_index;
>> static struct workqueue_struct *applesmc_led_wq;
>>
>> /*
>> - * wait_read - Wait for a byte to appear on SMC port. Callers must
>> - * hold applesmc_lock.
>> + * Wait for specific status bits with a mask on the SMC
>> + * Used before and after writes, and before reads
>> + * On success, returns the full status
>> + * On failure, returns a negative error
>> */
>> -static int wait_read(void)
>> +
>> +static int wait_status(u8 val, u8 mask)
>> {
>> unsigned long end = jiffies + (APPLESMC_MAX_WAIT * HZ) / USEC_PER_SEC;
>> u8 status;
>> int us;
>>
>> for (us = APPLESMC_MIN_WAIT; us < APPLESMC_MAX_WAIT; us <<= 1) {
>> - usleep_range(us, us * 16);
>> status = inb(APPLESMC_CMD_PORT);
>> - /* read: wait for smc to settle */
>> - if (status & 0x01)
>> - return 0;
>> + if ((status & mask) == val)
>> + return status;
>> /* timeout: give up */
>> if (time_after(jiffies, end))
>> break;
>> + usleep_range(us, us * 16);
>> }
>> -
>> - pr_warn("wait_read() fail: 0x%02x\n", status);
>> return -EIO;
>> }
>>
>> /*
>> - * send_byte - Write to SMC port, retrying when necessary. Callers
>> + * send_byte_data - Write to SMC data port. Callers
>> * must hold applesmc_lock.
>> + * Parameter skip must be true on the last write of any
>> + * command or it'll time out.
>> */
>> -static int send_byte(u8 cmd, u16 port)
>> +
>> +static int send_byte_data(u8 cmd, u16 port, bool skip)
>> {
>> - u8 status;
>> - int us;
>> - unsigned long end = jiffies + (APPLESMC_MAX_WAIT * HZ) / USEC_PER_SEC;
>> + int status;
>>
>> + status = wait_status(0, SMC_STATUS_IB_CLOSED);
>> + if (status < 0)
>> + return status;
>> outb(cmd, port);
>> - for (us = APPLESMC_MIN_WAIT; us < APPLESMC_MAX_WAIT; us <<= 1) {
>> - usleep_range(us, us * 16);
>> - status = inb(APPLESMC_CMD_PORT);
>> - /* write: wait for smc to settle */
>> - if (status & 0x02)
>> - continue;
>> - /* ready: cmd accepted, return */
>> - if (status & 0x04)
>> - return 0;
>> - /* timeout: give up */
>> - if (time_after(jiffies, end))
>> - break;
>> - /* busy: long wait and resend */
>> - udelay(APPLESMC_RETRY_WAIT);
>> - outb(cmd, port);
>> - }
>> + udelay(APPLESMC_MIN_WAIT);
>> + status = wait_status(0, SMC_STATUS_IB_CLOSED);
>> + if (status < 0)
>> + return status;
>> + if (skip || (status & SMC_STATUS_BUSY))
>> + return 0;
>> + return -EAGAIN;
>> +}
>>
>> - pr_warn("send_byte(0x%02x, 0x%04x) fail: 0x%02x\n", cmd, port, status);
>> - return -EIO;
>> +static int send_byte(u8 cmd, u16 port)
>> +{
>> + return send_byte_data(cmd, port, false);
>> }
>>
>> +/*
>> + * send_command - Write a command to the SMC. Callers must hold applesmc_lock.
>> + * If SMC is in undefined state, any new command write resets the state machine.
>> + */
>> +
>> static int send_command(u8 cmd)
>> {
>> - return send_byte(cmd, APPLESMC_CMD_PORT);
>> + int ret;
>> + int i;
>> +
>> + for (i = 0; i < 16; i++) {
>> + ret = send_byte(cmd, APPLESMC_CMD_PORT);
>> + if (!ret)
>> + return ret;
>> + if (ret != -EAGAIN)
>> + break;
>> + usleep_range(APPLESMC_MIN_WAIT, APPLESMC_MIN_WAIT * 16);
>> + }
>> + return -EIO;
>> }
>>
>> static int send_argument(const char *key)
>> @@ -239,7 +258,8 @@ static int read_smc(u8 cmd, const char *key, u8 *buffer, u8 len)
>> }
>>
>> for (i = 0; i < len; i++) {
>> - if (wait_read()) {
>> + if (wait_status(SMC_STATUS_AWAITING_DATA,
>> + SMC_STATUS_AWAITING_DATA | SMC_STATUS_IB_CLOSED) < 0) {
>> pr_warn("%.4s: read data[%d] fail\n", key, i);
>> return -EIO;
>> }
>> @@ -250,7 +270,7 @@ static int read_smc(u8 cmd, const char *key, u8 *buffer, u8 len)
>> for (i = 0; i < 16; i++) {
>> udelay(APPLESMC_MIN_WAIT);
>> status = inb(APPLESMC_CMD_PORT);
>> - if (!(status & 0x01))
>> + if (!(status & SMC_STATUS_AWAITING_DATA))
>> break;
>> data = inb(APPLESMC_DATA_PORT);
>> }
>> @@ -275,7 +295,7 @@ static int write_smc(u8 cmd, const char *key, const u8 *buffer, u8 len)
>> }
>>
>> for (i = 0; i < len; i++) {
>> - if (send_byte(buffer[i], APPLESMC_DATA_PORT)) {
>> + if (send_byte_data(buffer[i], APPLESMC_DATA_PORT, i == len - 1)) {
>> pr_warn("%s: write data fail\n", key);
>> return -EIO;
>> }
>>
>
>
next prev parent reply other threads:[~2020-11-09 0:26 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-30 8:54 [REGRESSION] hwmon: (applesmc) avoid overlong udelay() Andreas Kemnade
2020-09-30 16:44 ` Guenter Roeck
2020-09-30 20:00 ` Arnd Bergmann
2020-10-01 22:22 ` Andreas Kemnade
2020-10-02 4:07 ` Guenter Roeck
2020-10-06 7:02 ` Andreas Kemnade
2020-11-02 23:56 ` Brad Campbell
2020-11-03 5:56 ` Brad Campbell
2020-11-04 13:20 ` Andreas Kemnade
2020-11-05 2:18 ` Brad Campbell
2020-11-05 4:22 ` Brad Campbell
2020-11-05 4:43 ` Guenter Roeck
2020-11-05 5:05 ` Brad Campbell
2020-11-05 5:26 ` Guenter Roeck
2020-11-05 5:47 ` [PATCH] applesmc: Re-work SMC comms v1 Brad Campbell
2020-11-05 7:26 ` [PATCH] applesmc: Re-work SMC comms v2 Brad Campbell
2020-11-05 7:56 ` Henrik Rydberg
2020-11-05 8:15 ` Andreas Kemnade
2020-11-05 8:30 ` Brad Campbell
2020-11-05 10:31 ` Henrik Rydberg
2020-11-06 16:26 ` Henrik Rydberg
2020-11-06 20:02 ` Henrik Rydberg
2020-11-07 18:31 ` Henrik Rydberg
2020-11-08 0:09 ` Brad Campbell
2020-11-08 8:22 ` Henrik Rydberg
2020-11-08 1:00 ` [PATCH v3] applesmc: Re-work SMC comms Brad Campbell
2020-11-08 8:35 ` Henrik Rydberg
2020-11-08 10:14 ` Henrik Rydberg
2020-11-08 11:57 ` Brad Campbell
2020-11-08 12:04 ` Henrik Rydberg
2020-11-09 13:06 ` Brad Campbell
2020-11-09 17:08 ` Henrik Rydberg
2020-11-09 22:52 ` Brad Campbell
2020-11-08 16:06 ` Guenter Roeck
2020-11-09 0:25 ` Brad Campbell [this message]
2020-11-10 2:04 ` Brad Campbell
2020-11-10 4:55 ` Guenter Roeck
2020-11-10 5:40 ` Brad Campbell
2020-11-10 16:02 ` Guenter Roeck
2020-11-09 8:44 ` Andreas Kemnade
2020-11-09 9:51 ` Brad Campbell
2020-11-11 3:37 ` [PATCH v4 0/1] " Brad Campbell
2020-11-11 4:55 ` [PATCH v1] applesmc: Cleanups on top of re-work comms Brad Campbell
2020-11-11 3:38 ` [PATCH v4 1/1] applesmc: Re-work SMC comms Brad Campbell
2020-11-11 5:56 ` Guenter Roeck
2020-11-11 7:05 ` Brad Campbell
2020-11-11 13:06 ` [PATCH v5 " Brad Campbell
2020-11-11 20:05 ` Henrik Rydberg
2020-11-11 23:28 ` Brad Campbell
2020-11-12 3:08 ` [PATCH v6 " Brad Campbell
2020-11-12 17:20 ` Guenter Roeck
2020-11-06 23:11 ` [PATCH] applesmc: Re-work SMC comms v2 Brad Campbell
2020-11-05 8:12 ` Andreas Kemnade
2020-11-05 16:12 ` Guenter Roeck
2020-11-06 0:02 ` Brad Campbell
2020-11-06 3:08 ` Guenter Roeck
2020-11-09 9:27 ` [PATCH] applesmc: Re-work SMC comms v1 kernel test robot
2020-11-05 9:48 ` [REGRESSION] hwmon: (applesmc) avoid overlong udelay() Arnd Bergmann
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b00cffd1-96ed-775f-cc18-a16e1fff3ca2@fnarfbargle.com \
--to=brad@fnarfbargle.com \
--cc=andreas@kemnade.info \
--cc=arnd@arndb.de \
--cc=hns@goldelico.com \
--cc=jdelvare@suse.com \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=rydberg@bitmath.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).