[people/ms/u-boot.git] / include / cros_ec.h

/*
 * Chromium OS cros_ec driver
 *
 * Copyright (c) 2012 The Chromium OS Authors.
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#ifndef _CROS_EC_H
#define _CROS_EC_H

#include <linux/compiler.h>
#include <ec_commands.h>
#include <cros_ec_message.h>
#include <asm/gpio.h>
#include <dm/of_extra.h>

/* Our configuration information */
struct cros_ec_dev {
	struct udevice *dev;		/* Transport device */
	struct gpio_desc ec_int;	/* GPIO used as EC interrupt line */
	int protocol_version;           /* Protocol version to use */
	int optimise_flash_write;	/* Don't write erased flash blocks */

	/*
	 * These two buffers will always be dword-aligned and include enough
	 * space for up to 7 word-alignment bytes also, so we can ensure that
	 * the body of the message is always dword-aligned (64-bit).
	 *
	 * We use this alignment to keep ARM and x86 happy. Probably word
	 * alignment would be OK, there might be a small performance advantage
	 * to using dword.
	 */
	uint8_t din[ALIGN(MSG_BYTES + sizeof(int64_t), sizeof(int64_t))]
		__aligned(sizeof(int64_t));
	uint8_t dout[ALIGN(MSG_BYTES + sizeof(int64_t), sizeof(int64_t))]
		__aligned(sizeof(int64_t));
};

/*
 * Hard-code the number of columns we happen to know we have right now.  It
 * would be more correct to call cros_ec_info() at startup and determine the
 * actual number of keyboard cols from there.
 */
#define CROS_EC_KEYSCAN_COLS 13

/* Information returned by a key scan */
struct mbkp_keyscan {
	uint8_t data[CROS_EC_KEYSCAN_COLS];
};

/* Holds information about the Chrome EC */
struct fdt_cros_ec {
	struct fmap_entry flash;	/* Address and size of EC flash */
	/*
	 * Byte value of erased flash, or -1 if not known. It is normally
	 * 0xff but some flash devices use 0 (e.g. STM32Lxxx)
	 */
	int flash_erase_value;
	struct fmap_entry region[EC_FLASH_REGION_COUNT];
};

/**
 * Read the ID of the CROS-EC device
 *
 * The ID is a string identifying the CROS-EC device.
 *
 * @param dev		CROS-EC device
 * @param id		Place to put the ID
 * @param maxlen	Maximum length of the ID field
 * @return 0 if ok, -1 on error
 */
int cros_ec_read_id(struct cros_ec_dev *dev, char *id, int maxlen);

/**
 * Read a keyboard scan from the CROS-EC device
 *
 * Send a message requesting a keyboard scan and return the result
 *
 * @param dev		CROS-EC device
 * @param scan		Place to put the scan results
 * @return 0 if ok, -1 on error
 */
int cros_ec_scan_keyboard(struct udevice *dev, struct mbkp_keyscan *scan);

/**
 * Read which image is currently running on the CROS-EC device.
 *
 * @param dev		CROS-EC device
 * @param image		Destination for image identifier
 * @return 0 if ok, <0 on error
 */
int cros_ec_read_current_image(struct cros_ec_dev *dev,
		enum ec_current_image *image);

/**
 * Read the hash of the CROS-EC device firmware.
 *
 * @param dev		CROS-EC device
 * @param hash		Destination for hash information
 * @return 0 if ok, <0 on error
 */
int cros_ec_read_hash(struct cros_ec_dev *dev,
		struct ec_response_vboot_hash *hash);

/**
 * Send a reboot command to the CROS-EC device.
 *
 * Note that some reboot commands (such as EC_REBOOT_COLD) also reboot the AP.
 *
 * @param dev		CROS-EC device
 * @param cmd		Reboot command
 * @param flags         Flags for reboot command (EC_REBOOT_FLAG_*)
 * @return 0 if ok, <0 on error
 */
int cros_ec_reboot(struct cros_ec_dev *dev, enum ec_reboot_cmd cmd,
		uint8_t flags);

/**
 * Check if the CROS-EC device has an interrupt pending.
 *
 * Read the status of the external interrupt connected to the CROS-EC device.
 * If no external interrupt is configured, this always returns 1.
 *
 * @param dev		CROS-EC device
 * @return 0 if no interrupt is pending
 */
int cros_ec_interrupt_pending(struct udevice *dev);

enum {
	CROS_EC_OK,
	CROS_EC_ERR = 1,
	CROS_EC_ERR_FDT_DECODE,
	CROS_EC_ERR_CHECK_VERSION,
	CROS_EC_ERR_READ_ID,
	CROS_EC_ERR_DEV_INIT,
};

/**
 * Initialise the Chromium OS EC driver
 *
 * @param blob		Device tree blob containing setup information
 * @param cros_ecp        Returns pointer to the cros_ec device, or NULL if none
 * @return 0 if we got an cros_ec device and all is well (or no cros_ec is
 *	expected), -ve if we should have an cros_ec device but failed to find
 *	one, or init failed (-CROS_EC_ERR_...).
 */
int cros_ec_init(const void *blob, struct cros_ec_dev **cros_ecp);

/**
 * Read information about the keyboard matrix
 *
 * @param dev		CROS-EC device
 * @param info		Place to put the info structure
 */
int cros_ec_info(struct cros_ec_dev *dev,
		struct ec_response_mkbp_info *info);

/**
 * Read the host event flags
 *
 * @param dev		CROS-EC device
 * @param events_ptr	Destination for event flags.  Not changed on error.
 * @return 0 if ok, <0 on error
 */
int cros_ec_get_host_events(struct cros_ec_dev *dev, uint32_t *events_ptr);

/**
 * Clear the specified host event flags
 *
 * @param dev		CROS-EC device
 * @param events	Event flags to clear
 * @return 0 if ok, <0 on error
 */
int cros_ec_clear_host_events(struct cros_ec_dev *dev, uint32_t events);

/**
 * Get/set flash protection
 *
 * @param dev		CROS-EC device
 * @param set_mask	Mask of flags to set; if 0, just retrieves existing
 *                      protection state without changing it.
 * @param set_flags	New flag values; only bits in set_mask are applied;
 *                      ignored if set_mask=0.
 * @param prot          Destination for updated protection state from EC.
 * @return 0 if ok, <0 on error
 */
int cros_ec_flash_protect(struct cros_ec_dev *dev,
		       uint32_t set_mask, uint32_t set_flags,
		       struct ec_response_flash_protect *resp);


/**
 * Run internal tests on the cros_ec interface.
 *
 * @param dev		CROS-EC device
 * @return 0 if ok, <0 if the test failed
 */
int cros_ec_test(struct cros_ec_dev *dev);

/**
 * Update the EC RW copy.
 *
 * @param dev		CROS-EC device
 * @param image		the content to write
 * @param imafge_size	content length
 * @return 0 if ok, <0 if the test failed
 */
int cros_ec_flash_update_rw(struct cros_ec_dev *dev,
			 const uint8_t  *image, int image_size);

/**
 * Return a pointer to the board's CROS-EC device
 *
 * This should be implemented by board files.
 *
 * @return pointer to CROS-EC device, or NULL if none is available
 */
struct cros_ec_dev *board_get_cros_ec_dev(void);

struct dm_cros_ec_ops {
	int (*check_version)(struct udevice *dev);
	int (*command)(struct udevice *dev, uint8_t cmd, int cmd_version,
		       const uint8_t *dout, int dout_len,
		       uint8_t **dinp, int din_len);
	int (*packet)(struct udevice *dev, int out_bytes, int in_bytes);
};

#define dm_cros_ec_get_ops(dev) \
		((struct dm_cros_ec_ops *)(dev)->driver->ops)

int cros_ec_register(struct udevice *dev);

/**
 * Dump a block of data for a command.
 *
 * @param name	Name for data (e.g. 'in', 'out')
 * @param cmd	Command number associated with data, or -1 for none
 * @param data	Data block to dump
 * @param len	Length of data block to dump
 */
void cros_ec_dump_data(const char *name, int cmd, const uint8_t *data, int len);

/**
 * Calculate a simple 8-bit checksum of a data block
 *
 * @param data	Data block to checksum
 * @param size	Size of data block in bytes
 * @return checksum value (0 to 255)
 */
int cros_ec_calc_checksum(const uint8_t *data, int size);

int cros_ec_flash_erase(struct cros_ec_dev *dev, uint32_t offset,
		uint32_t size);

/**
 * Read data from the flash
 *
 * Read an arbitrary amount of data from the EC flash, by repeatedly reading
 * small blocks.
 *
 * The offset starts at 0. You can obtain the region information from
 * cros_ec_flash_offset() to find out where to read for a particular region.
 *
 * @param dev		CROS-EC device
 * @param data		Pointer to data buffer to read into
 * @param offset	Offset within flash to read from
 * @param size		Number of bytes to read
 * @return 0 if ok, -1 on error
 */
int cros_ec_flash_read(struct cros_ec_dev *dev, uint8_t *data, uint32_t offset,
		    uint32_t size);

/**
 * Read back flash parameters
 *
 * This function reads back parameters of the flash as reported by the EC
 *
 * @param dev  Pointer to device
 * @param info Pointer to output flash info struct
 */
int cros_ec_read_flashinfo(struct cros_ec_dev *dev,
			  struct ec_response_flash_info *info);

/**
 * Write data to the flash
 *
 * Write an arbitrary amount of data to the EC flash, by repeatedly writing
 * small blocks.
 *
 * The offset starts at 0. You can obtain the region information from
 * cros_ec_flash_offset() to find out where to write for a particular region.
 *
 * Attempting to write to the region where the EC is currently running from
 * will result in an error.
 *
 * @param dev		CROS-EC device
 * @param data		Pointer to data buffer to write
 * @param offset	Offset within flash to write to.
 * @param size		Number of bytes to write
 * @return 0 if ok, -1 on error
 */
int cros_ec_flash_write(struct cros_ec_dev *dev, const uint8_t *data,
		     uint32_t offset, uint32_t size);

/**
 * Obtain position and size of a flash region
 *
 * @param dev		CROS-EC device
 * @param region	Flash region to query
 * @param offset	Returns offset of flash region in EC flash
 * @param size		Returns size of flash region
 * @return 0 if ok, -1 on error
 */
int cros_ec_flash_offset(struct cros_ec_dev *dev, enum ec_flash_region region,
		      uint32_t *offset, uint32_t *size);

/**
 * Read/write VbNvContext from/to a CROS-EC device.
 *
 * @param dev		CROS-EC device
 * @param block		Buffer of VbNvContext to be read/write
 * @return 0 if ok, -1 on error
 */
int cros_ec_read_vbnvcontext(struct cros_ec_dev *dev, uint8_t *block);
int cros_ec_write_vbnvcontext(struct cros_ec_dev *dev, const uint8_t *block);

/**
 * Read the version information for the EC images
 *
 * @param dev		CROS-EC device
 * @param versionp	This is set to point to the version information
 * @return 0 if ok, -1 on error
 */
int cros_ec_read_version(struct cros_ec_dev *dev,
		       struct ec_response_get_version **versionp);

/**
 * Read the build information for the EC
 *
 * @param dev		CROS-EC device
 * @param versionp	This is set to point to the build string
 * @return 0 if ok, -1 on error
 */
int cros_ec_read_build_info(struct cros_ec_dev *dev, char **strp);

/**
 * Switch on/off a LDO / FET.
 *
 * @param dev		CROS-EC device
 * @param index		index of the LDO/FET to switch
 * @param state		new state of the LDO/FET : EC_LDO_STATE_ON|OFF
 * @return 0 if ok, -1 on error
 */
int cros_ec_set_ldo(struct udevice *dev, uint8_t index, uint8_t state);

/**
 * Read back a LDO / FET current state.
 *
 * @param dev		CROS-EC device
 * @param index		index of the LDO/FET to switch
 * @param state		current state of the LDO/FET : EC_LDO_STATE_ON|OFF
 * @return 0 if ok, -1 on error
 */
int cros_ec_get_ldo(struct udevice *dev, uint8_t index, uint8_t *state);

/**
 * Get access to the error reported when cros_ec_board_init() was called
 *
 * This permits delayed reporting of the EC error if it failed during
 * early init.
 *
 * @return error (0 if there was no error, -ve if there was an error)
 */
int cros_ec_get_error(void);

/**
 * Returns information from the FDT about the Chrome EC flash
 *
 * @param dev		Device to read from
 * @param config	Structure to use to return information
 */
int cros_ec_decode_ec_flash(struct udevice *dev, struct fdt_cros_ec *config);

/**
 * Check the current keyboard state, in case recovery mode is requested.
 * This function is for sandbox only.
 *
 * @param ec		CROS-EC device
 */
void cros_ec_check_keyboard(struct cros_ec_dev *dev);

struct i2c_msg;
/*
 * Tunnel an I2C transfer to the EC
 *
 * @param dev		CROS-EC device
 * @param port		The remote port on EC to use
 * @param msg		List of messages to transfer
 * @param nmsgs		Number of messages to transfer
 */
int cros_ec_i2c_tunnel(struct udevice *dev, int port, struct i2c_msg *msg,
		       int nmsgs);

#endif
Commit	Line	Data
88364387 HT	1	/*
	2	* Chromium OS cros_ec driver
	3	*
	4	* Copyright (c) 2012 The Chromium OS Authors.
88364387	5	*
1a459660	6	* SPDX-License-Identifier: GPL-2.0+
88364387 HT	7	*/
	8
	9	#ifndef _CROS_EC_H
	10	#define _CROS_EC_H
	11
	12	#include <linux/compiler.h>
	13	#include <ec_commands.h>
88364387	14	#include <cros_ec_message.h>
32f8a19f	15	#include <asm/gpio.h>
b7e0d73b	16	#include <dm/of_extra.h>
88364387	17
88364387 HT	18	/* Our configuration information */
88364387 HT	19	struct cros_ec_dev {
84d6cbd3	20	struct udevice dev; / Transport device */
32f8a19f	21	struct gpio_desc ec_int; /* GPIO used as EC interrupt line */
e8c12662	22	int protocol_version; /* Protocol version to use */
88364387 HT	23	int optimise_flash_write; /* Don't write erased flash blocks */
	24
	25	/*
	26	* These two buffers will always be dword-aligned and include enough
	27	* space for up to 7 word-alignment bytes also, so we can ensure that
	28	* the body of the message is always dword-aligned (64-bit).
	29	*
	30	* We use this alignment to keep ARM and x86 happy. Probably word
	31	* alignment would be OK, there might be a small performance advantage
	32	* to using dword.
	33	*/
	34	uint8_t din[ALIGN(MSG_BYTES + sizeof(int64_t), sizeof(int64_t))]
	35	__aligned(sizeof(int64_t));
	36	uint8_t dout[ALIGN(MSG_BYTES + sizeof(int64_t), sizeof(int64_t))]
	37	__aligned(sizeof(int64_t));
	38	};
	39
	40	/*
	41	* Hard-code the number of columns we happen to know we have right now. It
	42	* would be more correct to call cros_ec_info() at startup and determine the
	43	* actual number of keyboard cols from there.
	44	*/
	45	#define CROS_EC_KEYSCAN_COLS 13
	46
	47	/* Information returned by a key scan */
	48	struct mbkp_keyscan {
	49	uint8_t data[CROS_EC_KEYSCAN_COLS];
	50	};
	51
d7f25f35 SG	52	/* Holds information about the Chrome EC */
	53	struct fdt_cros_ec {
	54	struct fmap_entry flash; /* Address and size of EC flash */
	55	/*
	56	* Byte value of erased flash, or -1 if not known. It is normally
	57	* 0xff but some flash devices use 0 (e.g. STM32Lxxx)
	58	*/
	59	int flash_erase_value;
	60	struct fmap_entry region[EC_FLASH_REGION_COUNT];
	61	};
	62
88364387 HT	63	/**
	64	* Read the ID of the CROS-EC device
	65	*
	66	* The ID is a string identifying the CROS-EC device.
	67	*
	68	* @param dev CROS-EC device
	69	* @param id Place to put the ID
	70	* @param maxlen Maximum length of the ID field
	71	* @return 0 if ok, -1 on error
	72	*/
	73	int cros_ec_read_id(struct cros_ec_dev dev, char id, int maxlen);
	74
	75	/**
	76	* Read a keyboard scan from the CROS-EC device
	77	*
	78	* Send a message requesting a keyboard scan and return the result
	79	*
	80	* @param dev CROS-EC device
	81	* @param scan Place to put the scan results
	82	* @return 0 if ok, -1 on error
	83	*/
745009c4	84	int cros_ec_scan_keyboard(struct udevice dev, struct mbkp_keyscan scan);
88364387 HT	85
	86	/**
	87	* Read which image is currently running on the CROS-EC device.
	88	*
	89	* @param dev CROS-EC device
	90	* @param image Destination for image identifier
	91	* @return 0 if ok, <0 on error
	92	*/
	93	int cros_ec_read_current_image(struct cros_ec_dev *dev,
	94	enum ec_current_image *image);
	95
	96	/**
	97	* Read the hash of the CROS-EC device firmware.
	98	*
	99	* @param dev CROS-EC device
	100	* @param hash Destination for hash information
	101	* @return 0 if ok, <0 on error
	102	*/
	103	int cros_ec_read_hash(struct cros_ec_dev *dev,
	104	struct ec_response_vboot_hash *hash);
	105
	106	/**
	107	* Send a reboot command to the CROS-EC device.
	108	*
	109	* Note that some reboot commands (such as EC_REBOOT_COLD) also reboot the AP.
	110	*
	111	* @param dev CROS-EC device
	112	* @param cmd Reboot command
	113	* @param flags Flags for reboot command (EC_REBOOT_FLAG_*)
	114	* @return 0 if ok, <0 on error
	115	*/
	116	int cros_ec_reboot(struct cros_ec_dev *dev, enum ec_reboot_cmd cmd,
	117	uint8_t flags);
	118
	119	/**
	120	* Check if the CROS-EC device has an interrupt pending.
	121	*
	122	* Read the status of the external interrupt connected to the CROS-EC device.
	123	* If no external interrupt is configured, this always returns 1.
	124	*
	125	* @param dev CROS-EC device
	126	* @return 0 if no interrupt is pending
	127	*/
745009c4	128	int cros_ec_interrupt_pending(struct udevice *dev);
88364387 HT	129
	130	enum {
	131	CROS_EC_OK,
	132	CROS_EC_ERR = 1,
	133	CROS_EC_ERR_FDT_DECODE,
	134	CROS_EC_ERR_CHECK_VERSION,
	135	CROS_EC_ERR_READ_ID,
	136	CROS_EC_ERR_DEV_INIT,
	137	};
	138
	139	/**
836bb6e8	140	* Initialise the Chromium OS EC driver
88364387 HT	141	*
	142	* @param blob Device tree blob containing setup information
	143	* @param cros_ecp Returns pointer to the cros_ec device, or NULL if none
	144	* @return 0 if we got an cros_ec device and all is well (or no cros_ec is
	145	* expected), -ve if we should have an cros_ec device but failed to find
	146	* one, or init failed (-CROS_EC_ERR_...).
	147	*/
	148	int cros_ec_init(const void blob, struct cros_ec_dev *cros_ecp);
	149
	150	/**
	151	* Read information about the keyboard matrix
	152	*
	153	* @param dev CROS-EC device
	154	* @param info Place to put the info structure
	155	*/
	156	int cros_ec_info(struct cros_ec_dev *dev,
836bb6e8	157	struct ec_response_mkbp_info *info);
88364387 HT	158
	159	/**
	160	* Read the host event flags
	161	*
	162	* @param dev CROS-EC device
	163	* @param events_ptr Destination for event flags. Not changed on error.
	164	* @return 0 if ok, <0 on error
	165	*/
	166	int cros_ec_get_host_events(struct cros_ec_dev dev, uint32_t events_ptr);
	167
	168	/**
	169	* Clear the specified host event flags
	170	*
	171	* @param dev CROS-EC device
	172	* @param events Event flags to clear
	173	* @return 0 if ok, <0 on error
	174	*/
	175	int cros_ec_clear_host_events(struct cros_ec_dev *dev, uint32_t events);
	176
	177	/**
	178	* Get/set flash protection
	179	*
	180	* @param dev CROS-EC device
	181	* @param set_mask Mask of flags to set; if 0, just retrieves existing
	182	* protection state without changing it.
	183	* @param set_flags New flag values; only bits in set_mask are applied;
	184	* ignored if set_mask=0.
	185	* @param prot Destination for updated protection state from EC.
	186	* @return 0 if ok, <0 on error
	187	*/
	188	int cros_ec_flash_protect(struct cros_ec_dev *dev,
	189	uint32_t set_mask, uint32_t set_flags,
	190	struct ec_response_flash_protect *resp);
	191
	192
	193	/**
	194	* Run internal tests on the cros_ec interface.
	195	*
	196	* @param dev CROS-EC device
	197	* @return 0 if ok, <0 if the test failed
	198	*/
	199	int cros_ec_test(struct cros_ec_dev *dev);
	200
	201	/**
	202	* Update the EC RW copy.
	203	*
	204	* @param dev CROS-EC device
	205	* @param image the content to write
	206	* @param imafge_size content length
	207	* @return 0 if ok, <0 if the test failed
	208	*/
	209	int cros_ec_flash_update_rw(struct cros_ec_dev *dev,
	210	const uint8_t *image, int image_size);
	211
	212	/**
	213	* Return a pointer to the board's CROS-EC device
	214	*
	215	* This should be implemented by board files.
	216	*
	217	* @return pointer to CROS-EC device, or NULL if none is available
	218	*/
	219	struct cros_ec_dev *board_get_cros_ec_dev(void);
	220
84d6cbd3 SG	221	struct dm_cros_ec_ops {
	222	int (check_version)(struct udevice dev);
	223	int (command)(struct udevice dev, uint8_t cmd, int cmd_version,
	224	const uint8_t *dout, int dout_len,
	225	uint8_t **dinp, int din_len);
	226	int (packet)(struct udevice dev, int out_bytes, int in_bytes);
	227	};
	228
	229	#define dm_cros_ec_get_ops(dev) \
	230	((struct dm_cros_ec_ops *)(dev)->driver->ops)
	231
	232	int cros_ec_register(struct udevice *dev);
	233
88364387 HT	234	/**
	235	* Dump a block of data for a command.
	236	*
	237	* @param name Name for data (e.g. 'in', 'out')
	238	* @param cmd Command number associated with data, or -1 for none
	239	* @param data Data block to dump
	240	* @param len Length of data block to dump
	241	*/
	242	void cros_ec_dump_data(const char name, int cmd, const uint8_t data, int len);
	243
	244	/**
	245	* Calculate a simple 8-bit checksum of a data block
	246	*
	247	* @param data Data block to checksum
	248	* @param size Size of data block in bytes
	249	* @return checksum value (0 to 255)
	250	*/
	251	int cros_ec_calc_checksum(const uint8_t *data, int size);
	252
88364387 HT	253	int cros_ec_flash_erase(struct cros_ec_dev *dev, uint32_t offset,
	254	uint32_t size);
	255
	256	/**
	257	* Read data from the flash
	258	*
	259	* Read an arbitrary amount of data from the EC flash, by repeatedly reading
	260	* small blocks.
	261	*
	262	* The offset starts at 0. You can obtain the region information from
	263	* cros_ec_flash_offset() to find out where to read for a particular region.
	264	*
	265	* @param dev CROS-EC device
	266	* @param data Pointer to data buffer to read into
	267	* @param offset Offset within flash to read from
	268	* @param size Number of bytes to read
	269	* @return 0 if ok, -1 on error
	270	*/
	271	int cros_ec_flash_read(struct cros_ec_dev dev, uint8_t data, uint32_t offset,
	272	uint32_t size);
	273
bfeba017 MF	274	/**
	275	* Read back flash parameters
	276	*
	277	* This function reads back parameters of the flash as reported by the EC
	278	*
	279	* @param dev Pointer to device
	280	* @param info Pointer to output flash info struct
	281	*/
	282	int cros_ec_read_flashinfo(struct cros_ec_dev *dev,
	283	struct ec_response_flash_info *info);
	284
88364387 HT	285	/**
	286	* Write data to the flash
	287	*
	288	* Write an arbitrary amount of data to the EC flash, by repeatedly writing
	289	* small blocks.
	290	*
	291	* The offset starts at 0. You can obtain the region information from
	292	* cros_ec_flash_offset() to find out where to write for a particular region.
	293	*
	294	* Attempting to write to the region where the EC is currently running from
	295	* will result in an error.
	296	*
	297	* @param dev CROS-EC device
	298	* @param data Pointer to data buffer to write
	299	* @param offset Offset within flash to write to.
	300	* @param size Number of bytes to write
	301	* @return 0 if ok, -1 on error
	302	*/
	303	int cros_ec_flash_write(struct cros_ec_dev dev, const uint8_t data,
	304	uint32_t offset, uint32_t size);
	305
	306	/**
	307	* Obtain position and size of a flash region
	308	*
	309	* @param dev CROS-EC device
	310	* @param region Flash region to query
	311	* @param offset Returns offset of flash region in EC flash
	312	* @param size Returns size of flash region
	313	* @return 0 if ok, -1 on error
	314	*/
	315	int cros_ec_flash_offset(struct cros_ec_dev *dev, enum ec_flash_region region,
	316	uint32_t offset, uint32_t size);
	317
	318	/**
	319	* Read/write VbNvContext from/to a CROS-EC device.
	320	*
	321	* @param dev CROS-EC device
	322	* @param block Buffer of VbNvContext to be read/write
	323	* @return 0 if ok, -1 on error
	324	*/
	325	int cros_ec_read_vbnvcontext(struct cros_ec_dev dev, uint8_t block);
	326	int cros_ec_write_vbnvcontext(struct cros_ec_dev dev, const uint8_t block);
	327
	328	/**
	329	* Read the version information for the EC images
	330	*
	331	* @param dev CROS-EC device
	332	* @param versionp This is set to point to the version information
	333	* @return 0 if ok, -1 on error
	334	*/
	335	int cros_ec_read_version(struct cros_ec_dev *dev,
	336	struct ec_response_get_version **versionp);
	337
	338	/**
	339	* Read the build information for the EC
	340	*
	341	* @param dev CROS-EC device
	342	* @param versionp This is set to point to the build string
	343	* @return 0 if ok, -1 on error
	344	*/
	345	int cros_ec_read_build_info(struct cros_ec_dev dev, char *strp);
	346
	347	/**
	348	* Switch on/off a LDO / FET.
349	*
350	* @param dev CROS-EC device
351	* @param index index of the LDO/FET to switch
352	* @param state new state of the LDO/FET : EC_LDO_STATE_ON\|OFF
353	* @return 0 if ok, -1 on error
354	*/
f48eaf01	355	int cros_ec_set_ldo(struct udevice *dev, uint8_t index, uint8_t state);
88364387 HT	356
	357	/**
	358	* Read back a LDO / FET current state.
	359	*
	360	* @param dev CROS-EC device
	361	* @param index index of the LDO/FET to switch
	362	* @param state current state of the LDO/FET : EC_LDO_STATE_ON\|OFF
	363	* @return 0 if ok, -1 on error
	364	*/
f48eaf01	365	int cros_ec_get_ldo(struct udevice dev, uint8_t index, uint8_t state);
41364f0f	366
41364f0f VB	367	/**
	368	* Get access to the error reported when cros_ec_board_init() was called
	369	*
	370	* This permits delayed reporting of the EC error if it failed during
	371	* early init.
	372	*
	373	* @return error (0 if there was no error, -ve if there was an error)
	374	*/
	375	int cros_ec_get_error(void);
	376
d7f25f35 SG	377	/**
	378	* Returns information from the FDT about the Chrome EC flash
	379	*
2ec9d171	380	* @param dev Device to read from
d7f25f35 SG	381	* @param config Structure to use to return information
d7f25f35 SG	382	*/
2ec9d171	383	int cros_ec_decode_ec_flash(struct udevice dev, struct fdt_cros_ec config);
d7f25f35	384
df93d90a SG	385	/**
	386	* Check the current keyboard state, in case recovery mode is requested.
	387	* This function is for sandbox only.
	388	*
	389	* @param ec CROS-EC device
	390	*/
	391	void cros_ec_check_keyboard(struct cros_ec_dev *dev);
	392
cc456bd7 SG	393	struct i2c_msg;
	394	/*
	395	* Tunnel an I2C transfer to the EC
	396	*
	397	* @param dev CROS-EC device
6d1a718f	398	* @param port The remote port on EC to use
cc456bd7 SG	399	* @param msg List of messages to transfer
	400	* @param nmsgs Number of messages to transfer
	401	*/
6d1a718f MF	402	int cros_ec_i2c_tunnel(struct udevice dev, int port, struct i2c_msg msg,
6d1a718f MF	403	int nmsgs);
cc456bd7	404
88364387	405	#endif