From: Enric Balletbo i Serra <enric.balletbo@collabora.com>
To: Benson Leung <bleung@google.com>
Cc: linux-kernel@vger.kernel.org,
Collabora Kernel ML <kernel@collabora.com>,
groeck@chromium.org, bleung@chromium.org, dtor@chromium.org,
gwendal@chromium.org,
Jonathan Cameron <Jonathan.Cameron@huawei.com>,
Lee Jones <lee.jones@linaro.org>,
Evan Green <evgreen@chromium.org>
Subject: Re: [PATCH v2] platform/chrome: cros_ec: Match implementation with headers
Date: Wed, 22 Jan 2020 10:01:14 +0100 [thread overview]
Message-ID: <db7811ff-6888-aa44-82c0-4c7f0baf0175@collabora.com> (raw)
In-Reply-To: <20200121214649.GA31808@google.com>
Hi Benson,
On 21/1/20 22:46, Benson Leung wrote:
> Hi Enric!
>
> Thanks for V2!
>
> On Fri, Jan 17, 2020 at 03:43:56PM +0100, Enric Balletbo i Serra wrote:
>> The 'cros_ec' core driver is the common interface for the cros_ec
>> transport drivers to do the shared operations to register, unregister,
>> suspend and resume. The interface is provided by including the header
>> 'include/linux/platform_data/cros_ec_proto.h', however, instead of have
>> the implementation of these functions in cros_ec_proto.c, it is in
>> 'cros_ec.c', which is a different kernel module. Apart from being a bad
>> practice, this can induce confusions allowing the users of the cros_ec
>> protocol to call these functions.
>>
>> The register, unregister, suspend and resume functions *should* only be
>> called by the different transport drivers (i2c, spi, lpc, etc.), so make
>> this a bit less confusing by moving these functions from the public
>> in-kernel space to a private include in platform/chrome, and then, the
>> interface for cros_ec module and for the cros_ec_proto module is clean.
>>
>> Signed-off-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
>> ---
>>
>> Changes in v2:
>> - Mention that moves cros_ec_handle_event in commit description (Benson L.)
>
> Doesn't look like v2 has any commit message change. Could you double check?
>
Right, sorry, I did a rebase/rework mistake and send the incorrect one.
>> - Update copyright to 2020 (Benson L.)
>> - Do not move EC_REBOOT_DELAY_MS (Benson L.)
>>
>> drivers/platform/chrome/cros_ec.c | 2 ++
>> drivers/platform/chrome/cros_ec.h | 19 +++++++++++++++++++
>> drivers/platform/chrome/cros_ec_i2c.c | 2 ++
>> drivers/platform/chrome/cros_ec_ishtp.c | 2 ++
>> drivers/platform/chrome/cros_ec_lpc.c | 1 +
>> drivers/platform/chrome/cros_ec_rpmsg.c | 2 ++
>> drivers/platform/chrome/cros_ec_spi.c | 2 ++
>> include/linux/platform_data/cros_ec_proto.h | 12 +-----------
>> 8 files changed, 31 insertions(+), 11 deletions(-)
>> create mode 100644 drivers/platform/chrome/cros_ec.h
>>
>> diff --git a/drivers/platform/chrome/cros_ec.c b/drivers/platform/chrome/cros_ec.c
>> index 6d6ce86a1408..65c3207d2d90 100644
>> --- a/drivers/platform/chrome/cros_ec.c
>> +++ b/drivers/platform/chrome/cros_ec.c
>> @@ -18,6 +18,8 @@
>> #include <linux/suspend.h>
>> #include <asm/unaligned.h>
>>
>> +#include "cros_ec.h"
>> +
>> #define CROS_EC_DEV_EC_INDEX 0
>> #define CROS_EC_DEV_PD_INDEX 1
>>
>> diff --git a/drivers/platform/chrome/cros_ec.h b/drivers/platform/chrome/cros_ec.h
>> new file mode 100644
>> index 000000000000..e69fc1ff68b4
>> --- /dev/null
>> +++ b/drivers/platform/chrome/cros_ec.h
>> @@ -0,0 +1,19 @@
>> +/* SPDX-License-Identifier: GPL-2.0-only */
>> +/*
>> + * ChromeOS Embedded Controller core interface.
>> + *
>> + * Copyright (C) 2020 Google LLC
>> + */
>> +
>> +#ifndef __CROS_EC_H
>> +#define __CROS_EC_H
>> +
>> +int cros_ec_register(struct cros_ec_device *ec_dev);
>> +int cros_ec_unregister(struct cros_ec_device *ec_dev);
>> +
>> +int cros_ec_suspend(struct cros_ec_device *ec_dev);
>> +int cros_ec_resume(struct cros_ec_device *ec_dev);
>> +
>> +bool cros_ec_handle_event(struct cros_ec_device *ec_dev);
>> +
>> +#endif /* __CROS_EC_H */
>> diff --git a/drivers/platform/chrome/cros_ec_i2c.c b/drivers/platform/chrome/cros_ec_i2c.c
>> index 9bd97bc8454b..6119eccd8a18 100644
>> --- a/drivers/platform/chrome/cros_ec_i2c.c
>> +++ b/drivers/platform/chrome/cros_ec_i2c.c
>> @@ -14,6 +14,8 @@
>> #include <linux/platform_device.h>
>> #include <linux/slab.h>
>>
>> +#include "cros_ec.h"
>> +
>> /**
>> * Request format for protocol v3
>> * byte 0 0xda (EC_COMMAND_PROTOCOL_3)
>> diff --git a/drivers/platform/chrome/cros_ec_ishtp.c b/drivers/platform/chrome/cros_ec_ishtp.c
>> index e5996821d08b..e1fdb491a9a7 100644
>> --- a/drivers/platform/chrome/cros_ec_ishtp.c
>> +++ b/drivers/platform/chrome/cros_ec_ishtp.c
>> @@ -14,6 +14,8 @@
>> #include <linux/platform_data/cros_ec_proto.h>
>> #include <linux/intel-ish-client-if.h>
>>
>> +#include "cros_ec.h"
>> +
>> /*
>> * ISH TX/RX ring buffer pool size
>> *
>> diff --git a/drivers/platform/chrome/cros_ec_lpc.c b/drivers/platform/chrome/cros_ec_lpc.c
>> index dccf479c6625..3e8ddd84bc41 100644
>> --- a/drivers/platform/chrome/cros_ec_lpc.c
>> +++ b/drivers/platform/chrome/cros_ec_lpc.c
>> @@ -23,6 +23,7 @@
>> #include <linux/printk.h>
>> #include <linux/suspend.h>
>>
>> +#include "cros_ec.h"
>> #include "cros_ec_lpc_mec.h"
>>
>> #define DRV_NAME "cros_ec_lpcs"
>> diff --git a/drivers/platform/chrome/cros_ec_rpmsg.c b/drivers/platform/chrome/cros_ec_rpmsg.c
>> index bd068afe43b5..dbc3f5523b83 100644
>> --- a/drivers/platform/chrome/cros_ec_rpmsg.c
>> +++ b/drivers/platform/chrome/cros_ec_rpmsg.c
>> @@ -13,6 +13,8 @@
>> #include <linux/rpmsg.h>
>> #include <linux/slab.h>
>>
>> +#include "cros_ec.h"
>> +
>> #define EC_MSG_TIMEOUT_MS 200
>> #define HOST_COMMAND_MARK 1
>> #define HOST_EVENT_MARK 2
>> diff --git a/drivers/platform/chrome/cros_ec_spi.c b/drivers/platform/chrome/cros_ec_spi.c
>> index a831bd5a5b2f..46786d2d679a 100644
>> --- a/drivers/platform/chrome/cros_ec_spi.c
>> +++ b/drivers/platform/chrome/cros_ec_spi.c
>> @@ -14,6 +14,8 @@
>> #include <linux/spi/spi.h>
>> #include <uapi/linux/sched/types.h>
>>
>> +#include "cros_ec.h"
>> +
>> /* The header byte, which follows the preamble */
>> #define EC_MSG_HEADER 0xec
>>
>> diff --git a/include/linux/platform_data/cros_ec_proto.h b/include/linux/platform_data/cros_ec_proto.h
>> index 119b9951c055..35051da5a2fa 100644
>> --- a/include/linux/platform_data/cros_ec_proto.h
>> +++ b/include/linux/platform_data/cros_ec_proto.h
>> @@ -25,7 +25,7 @@
>> * The EC is unresponsive for a time after a reboot command. Add a
>> * simple delay to make sure that the bus stays locked.
>> */
>> -#define EC_REBOOT_DELAY_MS 50
>> +#define EC_REBOOT_DELAY_MS 50
>
> Looks like you put this back, but made a whitespace change in the process.
> Remove this diff, please!
>
Fixed in v3.
Thanks,
Enric
>>
>> /*
>> * Max bus-specific overhead incurred by request/responses.
>> @@ -206,10 +206,6 @@ struct cros_ec_dev {
>>
>> #define to_cros_ec_dev(dev) container_of(dev, struct cros_ec_dev, class_dev)
>>
>> -int cros_ec_suspend(struct cros_ec_device *ec_dev);
>> -
>> -int cros_ec_resume(struct cros_ec_device *ec_dev);
>> -
>> int cros_ec_prepare_tx(struct cros_ec_device *ec_dev,
>> struct cros_ec_command *msg);
>>
>> @@ -222,10 +218,6 @@ int cros_ec_cmd_xfer(struct cros_ec_device *ec_dev,
>> int cros_ec_cmd_xfer_status(struct cros_ec_device *ec_dev,
>> struct cros_ec_command *msg);
>>
>> -int cros_ec_register(struct cros_ec_device *ec_dev);
>> -
>> -int cros_ec_unregister(struct cros_ec_device *ec_dev);
>> -
>> int cros_ec_query_all(struct cros_ec_device *ec_dev);
>>
>> int cros_ec_get_next_event(struct cros_ec_device *ec_dev,
>> @@ -238,8 +230,6 @@ int cros_ec_check_features(struct cros_ec_dev *ec, int feature);
>>
>> int cros_ec_get_sensor_count(struct cros_ec_dev *ec);
>>
>> -bool cros_ec_handle_event(struct cros_ec_device *ec_dev);
>> -
>> /**
>> * cros_ec_get_time_ns() - Return time in ns.
>> *
>> --
>> 2.24.1
>>
>
prev parent reply other threads:[~2020-01-22 9:01 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-17 14:43 Enric Balletbo i Serra
2020-01-21 21:46 ` Benson Leung
2020-01-22 9:01 ` Enric Balletbo i Serra [this message]
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=db7811ff-6888-aa44-82c0-4c7f0baf0175@collabora.com \
--to=enric.balletbo@collabora.com \
--cc=Jonathan.Cameron@huawei.com \
--cc=bleung@chromium.org \
--cc=bleung@google.com \
--cc=dtor@chromium.org \
--cc=evgreen@chromium.org \
--cc=groeck@chromium.org \
--cc=gwendal@chromium.org \
--cc=kernel@collabora.com \
--cc=lee.jones@linaro.org \
--cc=linux-kernel@vger.kernel.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
all inboxes | Powered by JetHome®