[linux-2.6-block.git] / drivers / mfd / cros_ec_dev.h

/*
 * cros_ec_dev - expose the Chrome OS Embedded Controller to userspace
 *
 * Copyright (C) 2014 Google, Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _CROS_EC_DEV_H_
#define _CROS_EC_DEV_H_

#include <linux/ioctl.h>
#include <linux/types.h>
#include <linux/mfd/cros_ec.h>

#define CROS_EC_DEV_VERSION "1.0.0"

/*
 * @offset: within EC_LPC_ADDR_MEMMAP region
 * @bytes: number of bytes to read. zero means "read a string" (including '\0')
 *         (at most only EC_MEMMAP_SIZE bytes can be read)
 * @buffer: where to store the result
 * ioctl returns the number of bytes read, negative on error
 */
struct cros_ec_readmem {
	uint32_t offset;
	uint32_t bytes;
	uint8_t buffer[EC_MEMMAP_SIZE];
};

#define CROS_EC_DEV_IOC       0xEC
#define CROS_EC_DEV_IOCXCMD   _IOWR(CROS_EC_DEV_IOC, 0, struct cros_ec_command)
#define CROS_EC_DEV_IOCRDMEM  _IOWR(CROS_EC_DEV_IOC, 1, struct cros_ec_readmem)

/* Lightbar utilities */
extern bool ec_has_lightbar(struct cros_ec_dev *ec);
extern int lb_manual_suspend_ctrl(struct cros_ec_dev *ec, uint8_t enable);
extern int lb_suspend(struct cros_ec_dev *ec);
extern int lb_resume(struct cros_ec_dev *ec);

#endif /* _CROS_EC_DEV_H_ */
Commit	Line	Data
e7c256fb BR	1	/*
	2	* cros_ec_dev - expose the Chrome OS Embedded Controller to userspace
	3	*
	4	* Copyright (C) 2014 Google, Inc.
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#ifndef _CROS_EC_DEV_H_
	21	#define _CROS_EC_DEV_H_
	22
	23	#include <linux/ioctl.h>
	24	#include <linux/types.h>
	25	#include <linux/mfd/cros_ec.h>
	26
e7c256fb BR	27	#define CROS_EC_DEV_VERSION "1.0.0"
	28
	29	/*
	30	* @offset: within EC_LPC_ADDR_MEMMAP region
	31	* @bytes: number of bytes to read. zero means "read a string" (including '\0')
	32	* (at most only EC_MEMMAP_SIZE bytes can be read)
	33	* @buffer: where to store the result
	34	* ioctl returns the number of bytes read, negative on error
	35	*/
	36	struct cros_ec_readmem {
	37	uint32_t offset;
	38	uint32_t bytes;
	39	uint8_t buffer[EC_MEMMAP_SIZE];
	40	};
	41
	42	#define CROS_EC_DEV_IOC 0xEC
	43	#define CROS_EC_DEV_IOCXCMD _IOWR(CROS_EC_DEV_IOC, 0, struct cros_ec_command)
	44	#define CROS_EC_DEV_IOCRDMEM _IOWR(CROS_EC_DEV_IOC, 1, struct cros_ec_readmem)
	45
405c8430 EC	46	/* Lightbar utilities */
	47	extern bool ec_has_lightbar(struct cros_ec_dev *ec);
	48	extern int lb_manual_suspend_ctrl(struct cros_ec_dev *ec, uint8_t enable);
	49	extern int lb_suspend(struct cros_ec_dev *ec);
	50	extern int lb_resume(struct cros_ec_dev *ec);
	51
e7c256fb	52	#endif /* _CROS_EC_DEV_H_ */