Re: [PATCH v5 1/3] platform/chrome: cros_ec_lpc: Merge cros_ec_lpc and cros_ec_lpc_reg

[Nick Crews]

Thanks Enric, this looks good to me. Thanks for cleaning this up!

On Fri, Jun 14, 2019 at 3:43 PM Enric Balletbo i Serra
<enric.balletbo@xxxxxxxxxxxxx> wrote:
>
> The cros_ec_lpc_reg files are only used by the cros_ec_lpc core and
> there isn't logical separation between them. So, merge those files into
> the cros_ec_lpc also allowing us to drop the header file used for the
> interface between the two.
>
> Signed-off-by: Enric Balletbo i Serra <enric.balletbo@xxxxxxxxxxxxx>
> ---
>
> Changes in v5:
> - Introduced this patch to fix the include mess.
>
> Changes in v4: None
> Changes in v3: None
> Changes in v2: None
>
>  drivers/platform/chrome/Makefile          |   2 +-
>  drivers/platform/chrome/cros_ec_lpc.c     |  97 ++++++++++++++++++++-
>  drivers/platform/chrome/cros_ec_lpc_reg.c | 101 ----------------------
>  drivers/platform/chrome/cros_ec_lpc_reg.h |  45 ----------
>  4 files changed, 97 insertions(+), 148 deletions(-)
>  delete mode 100644 drivers/platform/chrome/cros_ec_lpc_reg.c
>  delete mode 100644 drivers/platform/chrome/cros_ec_lpc_reg.h
>
> diff --git a/drivers/platform/chrome/Makefile b/drivers/platform/chrome/Makefile
> index 1b2f1dcfcd5c..e2a250892404 100644
> --- a/drivers/platform/chrome/Makefile
> +++ b/drivers/platform/chrome/Makefile
> @@ -9,7 +9,7 @@ obj-$(CONFIG_CHROMEOS_TBMC)             += chromeos_tbmc.o
>  obj-$(CONFIG_CROS_EC_I2C)              += cros_ec_i2c.o
>  obj-$(CONFIG_CROS_EC_RPMSG)            += cros_ec_rpmsg.o
>  obj-$(CONFIG_CROS_EC_SPI)              += cros_ec_spi.o
> -cros_ec_lpcs-objs                      := cros_ec_lpc.o cros_ec_lpc_reg.o
> +cros_ec_lpcs-objs                      := cros_ec_lpc.o
>  cros_ec_lpcs-$(CONFIG_CROS_EC_LPC_MEC) += cros_ec_lpc_mec.o
>  obj-$(CONFIG_CROS_EC_LPC)              += cros_ec_lpcs.o
>  obj-$(CONFIG_CROS_EC_PROTO)            += cros_ec_proto.o cros_ec_trace.o
> diff --git a/drivers/platform/chrome/cros_ec_lpc.c b/drivers/platform/chrome/cros_ec_lpc.c
> index c9c240fbe7c6..00a07c9337b7 100644
> --- a/drivers/platform/chrome/cros_ec_lpc.c
> +++ b/drivers/platform/chrome/cros_ec_lpc.c
> @@ -23,7 +23,7 @@
>  #include <linux/printk.h>
>  #include <linux/suspend.h>
>
> -#include "cros_ec_lpc_reg.h"
> +#include "cros_ec_lpc_mec.h"
>
>  #define DRV_NAME "cros_ec_lpcs"
>  #define ACPI_DRV_NAME "GOOG0004"
> @@ -31,6 +31,101 @@
>  /* True if ACPI device is present */
>  static bool cros_ec_lpc_acpi_device_found;
>
> +static u8 lpc_read_bytes(unsigned int offset, unsigned int length, u8 *dest)
> +{
> +       int sum = 0;
> +       int i;
> +
> +       for (i = 0; i < length; ++i) {
> +               dest[i] = inb(offset + i);
> +               sum += dest[i];
> +       }
> +
> +       /* Return checksum of all bytes read */
> +       return sum;
> +}
> +
> +static u8 lpc_write_bytes(unsigned int offset, unsigned int length, u8 *msg)
> +{
> +       int sum = 0;
> +       int i;
> +
> +       for (i = 0; i < length; ++i) {
> +               outb(msg[i], offset + i);
> +               sum += msg[i];
> +       }
> +
> +       /* Return checksum of all bytes written */
> +       return sum;
> +}
> +
> +#ifdef CONFIG_CROS_EC_LPC_MEC
> +
> +static u8 cros_ec_lpc_read_bytes(unsigned int offset, unsigned int length,
> +                                u8 *dest)
> +{
> +       int in_range = cros_ec_lpc_mec_in_range(offset, length);
> +
> +       if (in_range < 0)
> +               return 0;
> +
> +       return in_range ?
> +               cros_ec_lpc_io_bytes_mec(MEC_IO_READ,
> +                                        offset - EC_HOST_CMD_REGION0,
> +                                        length, dest) :
> +               lpc_read_bytes(offset, length, dest);
> +}
> +
> +static u8 cros_ec_lpc_write_bytes(unsigned int offset, unsigned int length,
> +                                 u8 *msg)
> +{
> +       int in_range = cros_ec_lpc_mec_in_range(offset, length);
> +
> +       if (in_range < 0)
> +               return 0;
> +
> +       return in_range ?
> +               cros_ec_lpc_io_bytes_mec(MEC_IO_WRITE,
> +                                        offset - EC_HOST_CMD_REGION0,
> +                                        length, msg) :
> +               lpc_write_bytes(offset, length, msg);
> +}
> +
> +static void cros_ec_lpc_reg_init(void)
> +{
> +       cros_ec_lpc_mec_init(EC_HOST_CMD_REGION0,
> +                            EC_LPC_ADDR_MEMMAP + EC_MEMMAP_SIZE);
> +}
> +
> +static void cros_ec_lpc_reg_destroy(void)
> +{
> +       cros_ec_lpc_mec_destroy();
> +}
> +
> +#else /* CONFIG_CROS_EC_LPC_MEC */
> +
> +static u8 cros_ec_lpc_read_bytes(unsigned int offset, unsigned int length,
> +                                u8 *dest)
> +{
> +       return lpc_read_bytes(offset, length, dest);
> +}
> +
> +static u8 cros_ec_lpc_write_bytes(unsigned int offset, unsigned int length,
> +                                 u8 *msg)
> +{
> +       return lpc_write_bytes(offset, length, msg);
> +}
> +
> +static void cros_ec_lpc_reg_init(void)
> +{
> +}
> +
> +static void cros_ec_lpc_reg_destroy(void)
> +{
> +}
> +
> +#endif /* CONFIG_CROS_EC_LPC_MEC */
> +
>  static int ec_response_timed_out(void)
>  {
>         unsigned long one_second = jiffies + HZ;
> diff --git a/drivers/platform/chrome/cros_ec_lpc_reg.c b/drivers/platform/chrome/cros_ec_lpc_reg.c
> deleted file mode 100644
> index 0f5cd0ac8b49..000000000000
> --- a/drivers/platform/chrome/cros_ec_lpc_reg.c
> +++ /dev/null
> @@ -1,101 +0,0 @@
> -// SPDX-License-Identifier: GPL-2.0
> -// LPC interface for ChromeOS Embedded Controller
> -//
> -// Copyright (C) 2016 Google, Inc
> -
> -#include <linux/io.h>
> -#include <linux/mfd/cros_ec.h>
> -#include <linux/mfd/cros_ec_commands.h>
> -
> -#include "cros_ec_lpc_mec.h"
> -
> -static u8 lpc_read_bytes(unsigned int offset, unsigned int length, u8 *dest)
> -{
> -       int i;
> -       int sum = 0;
> -
> -       for (i = 0; i < length; ++i) {
> -               dest[i] = inb(offset + i);
> -               sum += dest[i];
> -       }
> -
> -       /* Return checksum of all bytes read */
> -       return sum;
> -}
> -
> -static u8 lpc_write_bytes(unsigned int offset, unsigned int length, u8 *msg)
> -{
> -       int i;
> -       int sum = 0;
> -
> -       for (i = 0; i < length; ++i) {
> -               outb(msg[i], offset + i);
> -               sum += msg[i];
> -       }
> -
> -       /* Return checksum of all bytes written */
> -       return sum;
> -}
> -
> -#ifdef CONFIG_CROS_EC_LPC_MEC
> -
> -u8 cros_ec_lpc_read_bytes(unsigned int offset, unsigned int length, u8 *dest)
> -{
> -       int in_range = cros_ec_lpc_mec_in_range(offset, length);
> -
> -       if (in_range < 0)
> -               return 0;
> -
> -       return in_range ?
> -               cros_ec_lpc_io_bytes_mec(MEC_IO_READ,
> -                                        offset - EC_HOST_CMD_REGION0,
> -                                        length, dest) :
> -               lpc_read_bytes(offset, length, dest);
> -}
> -
> -u8 cros_ec_lpc_write_bytes(unsigned int offset, unsigned int length, u8 *msg)
> -{
> -       int in_range = cros_ec_lpc_mec_in_range(offset, length);
> -
> -       if (in_range < 0)
> -               return 0;
> -
> -       return in_range ?
> -               cros_ec_lpc_io_bytes_mec(MEC_IO_WRITE,
> -                                        offset - EC_HOST_CMD_REGION0,
> -                                        length, msg) :
> -               lpc_write_bytes(offset, length, msg);
> -}
> -
> -void cros_ec_lpc_reg_init(void)
> -{
> -       cros_ec_lpc_mec_init(EC_HOST_CMD_REGION0,
> -                            EC_LPC_ADDR_MEMMAP + EC_MEMMAP_SIZE);
> -}
> -
> -void cros_ec_lpc_reg_destroy(void)
> -{
> -       cros_ec_lpc_mec_destroy();
> -}
> -
> -#else /* CONFIG_CROS_EC_LPC_MEC */
> -
> -u8 cros_ec_lpc_read_bytes(unsigned int offset, unsigned int length, u8 *dest)
> -{
> -       return lpc_read_bytes(offset, length, dest);
> -}
> -
> -u8 cros_ec_lpc_write_bytes(unsigned int offset, unsigned int length, u8 *msg)
> -{
> -       return lpc_write_bytes(offset, length, msg);
> -}
> -
> -void cros_ec_lpc_reg_init(void)
> -{
> -}
> -
> -void cros_ec_lpc_reg_destroy(void)
> -{
> -}
> -
> -#endif /* CONFIG_CROS_EC_LPC_MEC */
> diff --git a/drivers/platform/chrome/cros_ec_lpc_reg.h b/drivers/platform/chrome/cros_ec_lpc_reg.h
> deleted file mode 100644
> index 416fd2572182..000000000000
> --- a/drivers/platform/chrome/cros_ec_lpc_reg.h
> +++ /dev/null
> @@ -1,45 +0,0 @@
> -/* SPDX-License-Identifier: GPL-2.0 */
> -/*
> - * LPC interface for ChromeOS Embedded Controller
> - *
> - * Copyright (C) 2016 Google, Inc
> - */
> -
> -#ifndef __CROS_EC_LPC_REG_H
> -#define __CROS_EC_LPC_REG_H
> -
> -/**
> - * cros_ec_lpc_read_bytes - Read bytes from a given LPC-mapped address.
> - * Returns 8-bit checksum of all bytes read.
> - *
> - * @offset: Base read address
> - * @length: Number of bytes to read
> - * @dest: Destination buffer
> - */
> -u8 cros_ec_lpc_read_bytes(unsigned int offset, unsigned int length, u8 *dest);
> -
> -/**
> - * cros_ec_lpc_write_bytes - Write bytes to a given LPC-mapped address.
> - * Returns 8-bit checksum of all bytes written.
> - *
> - * @offset: Base write address
> - * @length: Number of bytes to write
> - * @msg: Write data buffer
> - */
> -u8 cros_ec_lpc_write_bytes(unsigned int offset, unsigned int length, u8 *msg);
> -
> -/**
> - * cros_ec_lpc_reg_init
> - *
> - * Initialize register I/O.
> - */
> -void cros_ec_lpc_reg_init(void);
> -
> -/**
> - * cros_ec_lpc_reg_destroy
> - *
> - * Cleanup reg I/O.
> - */
> -void cros_ec_lpc_reg_destroy(void);
> -
> -#endif /* __CROS_EC_LPC_REG_H */

Reviewed-by: Nick Crews <ncrews@xxxxxxxxxxxx>

> --
> 2.20.1
>