Commit 034dbec1 authored by Enric Balletbo i Serra's avatar Enric Balletbo i Serra
Browse files

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, resume and handle_event. 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, resume and handle_event 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: default avatarEnric Balletbo i Serra <enric.balletbo@collabora.com>
Signed-off-by: default avatarBenson Leung <bleung@chromium.org>
parent 943063b6

drivers/platform/chrome/cros_ec.c

+2 −0
Original line number Diff line number Diff line
@@ -17,6 +17,8 @@ 
#include <linux/platform_data/cros_ec_proto.h>

#include <linux/suspend.h>



#include "cros_ec.h"



#define CROS_EC_DEV_EC_INDEX 0

#define CROS_EC_DEV_PD_INDEX 1

drivers/platform/chrome/cros_ec.h

0 → 100644
+19 −0
Original line number Diff line number Diff line 
/* 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 */

drivers/platform/chrome/cros_ec_i2c.c

+2 −0
Original line number Diff line number Diff line
@@ -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)

drivers/platform/chrome/cros_ec_ishtp.c

+2 −0
Original line number Diff line number Diff line
@@ -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

 *

drivers/platform/chrome/cros_ec_lpc.c

+1 −0
Original line number Diff line number Diff line
@@ -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"

CRA Git | Maintained and supported by SUSTech CRA and CCSE