2019-12-10 10:07:40

by Enric Balletbo i Serra

[permalink] [raw]

Subject: [PATCH] platform/chrome: cros_ec: Match implementation with headers

---

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 <[email protected]>
---

drivers/platform/chrome/cros_ec.c | 2 ++
drivers/platform/chrome/cros_ec.h | 25 +++++++++++++++++++++
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 | 16 -------------
8 files changed, 36 insertions(+), 16 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..dc80550f5eaa
--- /dev/null
+++ b/drivers/platform/chrome/cros_ec.h
@@ -0,0 +1,25 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+/*
+ * ChromeOS Embedded Controller core interface.
+ *
+ * Copyright (C) 2012 Google, Inc
+ */
+
+#ifndef __CROS_EC_H
+#define __CROS_EC_H
+
+/*
+ * 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
+
+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..f490e208540a 100644
--- a/include/linux/platform_data/cros_ec_proto.h
+++ b/include/linux/platform_data/cros_ec_proto.h
@@ -21,12 +21,6 @@
#define CROS_EC_DEV_SCP_NAME "cros_scp"
#define CROS_EC_DEV_TP_NAME "cros_tp"

-/*
- * 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
-
/*
* Max bus-specific overhead incurred by request/responses.
* I2C requires 1 additional byte for requests.
@@ -206,10 +200,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 +212,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 +224,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.20.1

2020-01-07 17:55:24

by Enric Balletbo Serra

[permalink] [raw]

Subject: Re: [PATCH] platform/chrome: cros_ec: Match implementation with headers

---

Hi Guenter, Benson,

Missatge de Enric Balletbo i Serra <[email protected]> del
dia dt., 10 de des. 2019 a les 11:09:
>
> 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 <[email protected]>

Can I get a review from you if you're fine with this change?

Thanks,
Enric


> ---
>
> drivers/platform/chrome/cros_ec.c | 2 ++
> drivers/platform/chrome/cros_ec.h | 25 +++++++++++++++++++++
> 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 | 16 -------------
> 8 files changed, 36 insertions(+), 16 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..dc80550f5eaa
> --- /dev/null
> +++ b/drivers/platform/chrome/cros_ec.h
> @@ -0,0 +1,25 @@
> +/* SPDX-License-Identifier: GPL-2.0-only */
> +/*
> + * ChromeOS Embedded Controller core interface.
> + *
> + * Copyright (C) 2012 Google, Inc
> + */
> +
> +#ifndef __CROS_EC_H
> +#define __CROS_EC_H
> +
> +/*
> + * 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
> +
> +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..f490e208540a 100644
> --- a/include/linux/platform_data/cros_ec_proto.h
> +++ b/include/linux/platform_data/cros_ec_proto.h
> @@ -21,12 +21,6 @@
> #define CROS_EC_DEV_SCP_NAME "cros_scp"
> #define CROS_EC_DEV_TP_NAME "cros_tp"
>
> -/*
> - * 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
> -
> /*
> * Max bus-specific overhead incurred by request/responses.
> * I2C requires 1 additional byte for requests.
> @@ -206,10 +200,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 +212,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 +224,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.20.1
>

2020-01-16 23:24:11

by Benson Leung

[permalink] [raw]

Subject: Re: [PATCH] platform/chrome: cros_ec: Match implementation with headers

---

Hi Enric,

On Tue, Dec 10, 2019 at 11:06:45AM +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

Also mention that this moves the cros_ec_handle_event definition too.

> 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 <[email protected]>
> ---
>
> drivers/platform/chrome/cros_ec.c | 2 ++
> drivers/platform/chrome/cros_ec.h | 25 +++++++++++++++++++++
> 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 | 16 -------------
> 8 files changed, 36 insertions(+), 16 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..dc80550f5eaa
> --- /dev/null
> +++ b/drivers/platform/chrome/cros_ec.h
> @@ -0,0 +1,25 @@
> +/* SPDX-License-Identifier: GPL-2.0-only */
> +/*
> + * ChromeOS Embedded Controller core interface.
> + *
> + * Copyright (C) 2012 Google, Inc

Set Copyright date to 2020, especially for new file.

> + */
> +
> +#ifndef __CROS_EC_H
> +#define __CROS_EC_H
> +
> +/*
> + * 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
> +
> +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..f490e208540a 100644
> --- a/include/linux/platform_data/cros_ec_proto.h
> +++ b/include/linux/platform_data/cros_ec_proto.h
> @@ -21,12 +21,6 @@
> #define CROS_EC_DEV_SCP_NAME "cros_scp"
> #define CROS_EC_DEV_TP_NAME "cros_tp"
>
> -/*
> - * 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
> -

Any reason why this define was moved?

> /*
> * Max bus-specific overhead incurred by request/responses.
> * I2C requires 1 additional byte for requests.
> @@ -206,10 +200,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 +212,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 +224,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.20.1
>

--
Benson Leung
Staff Software Engineer
Chrome OS Kernel
Google Inc.
[email protected]
Chromium OS Project
[email protected]

---

Attachments:

(No filename) (7.19 kB)
signature.asc (235.00 B)
Download all attachments

2020-01-17 11:43:56

by Enric Balletbo i Serra

[permalink] [raw]

Subject: Re: [PATCH] platform/chrome: cros_ec: Match implementation with headers

---

Hi Benson,

Many thanks for the review.

On 16/1/20 21:12, Benson Leung wrote:
> Hi Enric,
>
> On Tue, Dec 10, 2019 at 11:06:45AM +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
>
> Also mention that this moves the cros_ec_handle_event definition too.
>

Ack

>> 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 <[email protected]>
>> ---
>>
>> drivers/platform/chrome/cros_ec.c | 2 ++
>> drivers/platform/chrome/cros_ec.h | 25 +++++++++++++++++++++
>> 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 | 16 -------------
>> 8 files changed, 36 insertions(+), 16 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..dc80550f5eaa
>> --- /dev/null
>> +++ b/drivers/platform/chrome/cros_ec.h
>> @@ -0,0 +1,25 @@
>> +/* SPDX-License-Identifier: GPL-2.0-only */
>> +/*
>> + * ChromeOS Embedded Controller core interface.
>> + *
>> + * Copyright (C) 2012 Google, Inc
>
> Set Copyright date to 2020, especially for new file.
>

Ok.

>> + */
>> +
>> +#ifndef __CROS_EC_H
>> +#define __CROS_EC_H
>> +
>> +/*
>> + * 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
>> +
>> +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..f490e208540a 100644
>> --- a/include/linux/platform_data/cros_ec_proto.h
>> +++ b/include/linux/platform_data/cros_ec_proto.h
>> @@ -21,12 +21,6 @@
>> #define CROS_EC_DEV_SCP_NAME "cros_scp"
>> #define CROS_EC_DEV_TP_NAME "cros_tp"
>>
>> -/*
>> - * 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
>> -
>
> Any reason why this define was moved?
>

Hmm, no, right, I'll leave here. Preparing a v2.

Thanks,
Enric


>> /*
>> * Max bus-specific overhead incurred by request/responses.
>> * I2C requires 1 additional byte for requests.
>> @@ -206,10 +200,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 +212,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 +224,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.20.1
>>
>