[deliverable/linux.git] / drivers / misc / mei / mei_dev.h

/*
 *
 * Intel Management Engine Interface (Intel MEI) Linux driver
 * Copyright (c) 2003-2012, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope 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.
 *
 */

#ifndef _MEI_DEV_H_
#define _MEI_DEV_H_

#include <linux/types.h>
#include <linux/watchdog.h>
#include <linux/mei.h>
#include "hw.h"

/*
 * watch dog definition
 */
#define MEI_WATCHDOG_DATA_SIZE         16
#define MEI_START_WD_DATA_SIZE         20
#define MEI_WD_PARAMS_SIZE             4
#define MEI_WD_STATE_INDEPENDENCE_MSG_SENT       (1 << 0)

#define MEI_RD_MSG_BUF_SIZE           (128 * sizeof(u32))

/*
 * MEI PCI Device object
 */
extern struct pci_dev *mei_device;


/*
 * AMTHI Client UUID
 */
extern const uuid_le mei_amthi_guid;

/*
 * Watchdog Client UUID
 */
extern const uuid_le mei_wd_guid;

/*
 * Watchdog independence state message
 */
extern const u8 mei_wd_state_independence_msg[3][4];

/*
 * Number of File descriptors/handles
 * that can be opened to the driver.
 *
 * Limit to 253: 255 Total Clients
 * minus internal client for AMTHI
 * minus internal client for Watchdog
 */
#define  MEI_MAX_OPEN_HANDLE_COUNT	253

/*
 * Number of Maximum MEI Clients
 */
#define MEI_CLIENTS_MAX 255

/* File state */
enum file_state {
	MEI_FILE_INITIALIZING = 0,
	MEI_FILE_CONNECTING,
	MEI_FILE_CONNECTED,
	MEI_FILE_DISCONNECTING,
	MEI_FILE_DISCONNECTED
};

/* MEI device states */
enum mei_states {
	MEI_INITIALIZING = 0,
	MEI_INIT_CLIENTS,
	MEI_ENABLED,
	MEI_RESETING,
	MEI_DISABLED,
	MEI_RECOVERING_FROM_RESET,
	MEI_POWER_DOWN,
	MEI_POWER_UP
};

/* init clients states*/
enum mei_init_clients_states {
	MEI_START_MESSAGE = 0,
	MEI_ENUM_CLIENTS_MESSAGE,
	MEI_CLIENT_PROPERTIES_MESSAGE
};

enum iamthif_states {
	MEI_IAMTHIF_IDLE,
	MEI_IAMTHIF_WRITING,
	MEI_IAMTHIF_FLOW_CONTROL,
	MEI_IAMTHIF_READING,
	MEI_IAMTHIF_READ_COMPLETE
};

enum mei_file_transaction_states {
	MEI_IDLE,
	MEI_WRITING,
	MEI_WRITE_COMPLETE,
	MEI_FLOW_CONTROL,
	MEI_READING,
	MEI_READ_COMPLETE
};

/* MEI CB */
enum mei_cb_major_types {
	MEI_READ = 0,
	MEI_WRITE,
	MEI_IOCTL,
	MEI_OPEN,
	MEI_CLOSE
};

/*
 * Intel MEI message data struct
 */
struct mei_message_data {
	u32 size;
	unsigned char *data;
} __packed;


struct mei_cl_cb {
	struct list_head cb_list;
	enum mei_cb_major_types major_file_operations;
	void *file_private;
	struct mei_message_data request_buffer;
	struct mei_message_data response_buffer;
	unsigned long information;
	unsigned long read_time;
	struct file *file_object;
};

/* MEI client instance carried as file->pirvate_data*/
struct mei_cl {
	struct list_head link;
	struct mei_device *dev;
	enum file_state state;
	wait_queue_head_t tx_wait;
	wait_queue_head_t rx_wait;
	wait_queue_head_t wait;
	int read_pending;
	int status;
	/* ID of client connected */
	u8 host_client_id;
	u8 me_client_id;
	u8 mei_flow_ctrl_creds;
	u8 timer_count;
	enum mei_file_transaction_states reading_state;
	enum mei_file_transaction_states writing_state;
	int sm_state;
	struct mei_cl_cb *read_cb;
};

struct mei_io_list {
	struct mei_cl_cb mei_cb;
};

/**
 * struct mei_deive -  MEI private device struct
 * @hbuf_depth - depth of host(write) buffer
 */
struct mei_device {
	struct pci_dev *pdev;	/* pointer to pci device struct */
	/*
	 * lists of queues
	 */
	 /* array of pointers to aio lists */
	struct mei_io_list read_list;		/* driver read queue */
	struct mei_io_list write_list;		/* driver write queue */
	struct mei_io_list write_waiting_list;	/* write waiting queue */
	struct mei_io_list ctrl_wr_list;	/* managed write IOCTL list */
	struct mei_io_list ctrl_rd_list;	/* managed read IOCTL list */
	struct mei_io_list amthi_cmd_list;	/* amthi list for cmd waiting */

	/* driver managed amthi list for reading completed amthi cmd data */
	struct mei_io_list amthi_read_complete_list;
	/*
	 * list of files
	 */
	struct list_head file_list;
	long open_handle_count;
	/*
	 * memory of device
	 */
	unsigned int mem_base;
	unsigned int mem_length;
	void __iomem *mem_addr;
	/*
	 * lock for the device
	 */
	struct mutex device_lock; /* device lock */
	struct delayed_work timer_work;	/* MEI timer delayed work (timeouts) */
	bool recvd_msg;
	/*
	 * hw states of host and fw(ME)
	 */
	u32 host_hw_state;
	u32 me_hw_state;
	u8  hbuf_depth;
	/*
	 * waiting queue for receive message from FW
	 */
	wait_queue_head_t wait_recvd_msg;
	wait_queue_head_t wait_stop_wd;

	/*
	 * mei device  states
	 */
	enum mei_states mei_state;
	enum mei_init_clients_states init_clients_state;
	u16 init_clients_timer;
	bool stop;
	bool need_reset;

	u32 extra_write_index;
	unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];	/* control messages */
	u32 wr_msg_buf[128];	/* used for control messages */
	u32 ext_msg_buf[8];	/* for control responses */
	u32 rd_msg_hdr;

	struct hbm_version version;

	struct mei_me_client *me_clients; /* Note: memory has to be allocated */
	DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
	DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
	u8 me_clients_num;
	u8 me_client_presentation_num;
	u8 me_client_index;
	bool mei_host_buffer_is_empty;

	struct mei_cl wd_cl;
	bool wd_interface_reg;
	bool wd_pending;
	bool wd_stopped;
	bool wd_bypass;	/* if false, don't refresh watchdog ME client */
	u16 wd_timeout;	/* seconds ((wd_data[1] << 8) + wd_data[0]) */
	unsigned char wd_data[MEI_START_WD_DATA_SIZE];


	struct file *iamthif_file_object;
	struct mei_cl iamthif_cl;
	struct mei_cl_cb *iamthif_current_cb;
	int iamthif_mtu;
	unsigned long iamthif_timer;
	u32 iamthif_stall_timer;
	unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
	u32 iamthif_msg_buf_size;
	u32 iamthif_msg_buf_index;
	enum iamthif_states iamthif_state;
	bool iamthif_flow_control_pending;
	bool iamthif_ioctl;
	bool iamthif_canceled;
};


/*
 * mei init function prototypes
 */
struct mei_device *mei_device_init(struct pci_dev *pdev);
void mei_reset(struct mei_device *dev, int interrupts);
int mei_hw_init(struct mei_device *dev);
int mei_task_initialize_clients(void *data);
int mei_initialize_clients(struct mei_device *dev);
int mei_disconnect_host_client(struct mei_device *dev, struct mei_cl *cl);
void mei_remove_client_from_file_list(struct mei_device *dev, u8 host_client_id);
void mei_host_init_iamthif(struct mei_device *dev);
void mei_allocate_me_clients_storage(struct mei_device *dev);


u8 mei_find_me_client_update_filext(struct mei_device *dev,
				struct mei_cl *priv,
				const uuid_le *cguid, u8 client_id);

/*
 * MEI IO List Functions
 */
void mei_io_list_init(struct mei_io_list *list);
void mei_io_list_flush(struct mei_io_list *list, struct mei_cl *cl);

/*
 * MEI ME Client Functions
 */

struct mei_cl *mei_cl_allocate(struct mei_device *dev);
void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
int mei_cl_flush_queues(struct mei_cl *cl);
/**
 * mei_cl_cmp_id - tells if file private data have same id
 *
 * @fe1: private data of 1. file object
 * @fe2: private data of 2. file object
 *
 * returns true  - if ids are the same and not NULL
 */
static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
				const struct mei_cl *cl2)
{
	return cl1 && cl2 &&
		(cl1->host_client_id == cl2->host_client_id) &&
		(cl1->me_client_id == cl2->me_client_id);
}


/*
 * MEI Host Client Functions
 */
void mei_host_start_message(struct mei_device *dev);
void mei_host_enum_clients_message(struct mei_device *dev);
int mei_host_client_properties(struct mei_device *dev);

/*
 *  MEI interrupt functions prototype
 */
irqreturn_t mei_interrupt_quick_handler(int irq, void *dev_id);
irqreturn_t mei_interrupt_thread_handler(int irq, void *dev_id);
void mei_timer(struct work_struct *work);

/*
 *  MEI input output function prototype
 */
int mei_ioctl_connect_client(struct file *file,
			struct mei_connect_client_data *data);

int mei_start_read(struct mei_device *dev, struct mei_cl *cl);

int amthi_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);

int amthi_read(struct mei_device *dev, struct file *file,
	      char __user *ubuf, size_t length, loff_t *offset);

struct mei_cl_cb *find_amthi_read_list_entry(struct mei_device *dev,
						struct file *file);

void mei_run_next_iamthif_cmd(struct mei_device *dev);

void mei_free_cb_private(struct mei_cl_cb *priv_cb);

int mei_find_me_client_index(const struct mei_device *dev, uuid_le cuuid);

/*
 * Register Access Function
 */

/**
 * mei_reg_read - Reads 32bit data from the mei device
 *
 * @dev: the device structure
 * @offset: offset from which to read the data
 *
 * returns register value (u32)
 */
static inline u32 mei_reg_read(const struct mei_device *dev,
			       unsigned long offset)
{
	return ioread32(dev->mem_addr + offset);
}

/**
 * mei_reg_write - Writes 32bit data to the mei device
 *
 * @dev: the device structure
 * @offset: offset from which to write the data
 * @value: register value to write (u32)
 */
static inline void mei_reg_write(const struct mei_device *dev,
				 unsigned long offset, u32 value)
{
	iowrite32(value, dev->mem_addr + offset);
}

/**
 * mei_hcsr_read - Reads 32bit data from the host CSR
 *
 * @dev: the device structure
 *
 * returns the byte read.
 */
static inline u32 mei_hcsr_read(const struct mei_device *dev)
{
	return mei_reg_read(dev, H_CSR);
}

/**
 * mei_mecsr_read - Reads 32bit data from the ME CSR
 *
 * @dev: the device structure
 *
 * returns ME_CSR_HA register value (u32)
 */
static inline u32 mei_mecsr_read(const struct mei_device *dev)
{
	return mei_reg_read(dev, ME_CSR_HA);
}

/**
 * get_me_cb_rw - Reads 32bit data from the mei ME_CB_RW register
 *
 * @dev: the device structure
 *
 * returns ME_CB_RW register value (u32)
 */
static inline u32 mei_mecbrw_read(const struct mei_device *dev)
{
	return mei_reg_read(dev, ME_CB_RW);
}


/*
 * mei interface function prototypes
 */
void mei_hcsr_set(struct mei_device *dev);
void mei_csr_clear_his(struct mei_device *dev);

void mei_enable_interrupts(struct mei_device *dev);
void mei_disable_interrupts(struct mei_device *dev);

#endif
Commit	Line	Data
ab841160 OW	1	/*
	2	*
	3	* Intel Management Engine Interface (Intel MEI) Linux driver
733ba91c	4	* Copyright (c) 2003-2012, Intel Corporation.
ab841160 OW	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms and conditions of the GNU General Public License,
	8	* version 2, as published by the Free Software Foundation.
	9	*
	10	* This program is distributed in the hope it will be useful, but WITHOUT
	11	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	12	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	13	* more details.
	14	*
	15	*/
	16
	17	#ifndef _MEI_DEV_H_
	18	#define _MEI_DEV_H_
	19
	20	#include <linux/types.h>
9ce178e5	21	#include <linux/watchdog.h>
4f3afe1d	22	#include <linux/mei.h>
ab841160 OW	23	#include "hw.h"
ab841160 OW	24
ab841160 OW	25	/*
	26	* watch dog definition
	27	*/
	28	#define MEI_WATCHDOG_DATA_SIZE 16
	29	#define MEI_START_WD_DATA_SIZE 20
	30	#define MEI_WD_PARAMS_SIZE 4
	31	#define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0)
	32
edf1eed4 TW	33	#define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32))
edf1eed4 TW	34
4a3cafd5 OW	35	/*
	36	* MEI PCI Device object
	37	*/
	38	extern struct pci_dev *mei_device;
	39
9ce178e5	40
ab841160 OW	41	/*
	42	* AMTHI Client UUID
	43	*/
	44	extern const uuid_le mei_amthi_guid;
	45
	46	/*
	47	* Watchdog Client UUID
	48	*/
	49	extern const uuid_le mei_wd_guid;
	50
	51	/*
	52	* Watchdog independence state message
	53	*/
	54	extern const u8 mei_wd_state_independence_msg[3][4];
	55
	56	/*
	57	* Number of File descriptors/handles
	58	* that can be opened to the driver.
	59	*
	60	* Limit to 253: 255 Total Clients
	61	* minus internal client for AMTHI
	62	* minus internal client for Watchdog
	63	*/
	64	#define MEI_MAX_OPEN_HANDLE_COUNT 253
	65
ab841160 OW	66	/*
	67	* Number of Maximum MEI Clients
	68	*/
	69	#define MEI_CLIENTS_MAX 255
	70
	71	/* File state */
	72	enum file_state {
	73	MEI_FILE_INITIALIZING = 0,
	74	MEI_FILE_CONNECTING,
	75	MEI_FILE_CONNECTED,
	76	MEI_FILE_DISCONNECTING,
	77	MEI_FILE_DISCONNECTED
	78	};
	79
	80	/* MEI device states */
	81	enum mei_states {
	82	MEI_INITIALIZING = 0,
	83	MEI_INIT_CLIENTS,
	84	MEI_ENABLED,
	85	MEI_RESETING,
	86	MEI_DISABLED,
	87	MEI_RECOVERING_FROM_RESET,
	88	MEI_POWER_DOWN,
	89	MEI_POWER_UP
	90	};
	91
5f9092f3	92	/* init clients states*/
ab841160 OW	93	enum mei_init_clients_states {
	94	MEI_START_MESSAGE = 0,
	95	MEI_ENUM_CLIENTS_MESSAGE,
	96	MEI_CLIENT_PROPERTIES_MESSAGE
	97	};
	98
	99	enum iamthif_states {
	100	MEI_IAMTHIF_IDLE,
	101	MEI_IAMTHIF_WRITING,
	102	MEI_IAMTHIF_FLOW_CONTROL,
	103	MEI_IAMTHIF_READING,
	104	MEI_IAMTHIF_READ_COMPLETE
	105	};
	106
	107	enum mei_file_transaction_states {
	108	MEI_IDLE,
	109	MEI_WRITING,
	110	MEI_WRITE_COMPLETE,
	111	MEI_FLOW_CONTROL,
	112	MEI_READING,
	113	MEI_READ_COMPLETE
	114	};
	115
	116	/* MEI CB */
	117	enum mei_cb_major_types {
	118	MEI_READ = 0,
	119	MEI_WRITE,
	120	MEI_IOCTL,
	121	MEI_OPEN,
	122	MEI_CLOSE
	123	};
	124
	125	/*
	126	* Intel MEI message data struct
	127	*/
	128	struct mei_message_data {
	129	u32 size;
edf1eed4	130	unsigned char *data;
ab841160 OW	131	} __packed;
	132
	133
	134	struct mei_cl_cb {
	135	struct list_head cb_list;
	136	enum mei_cb_major_types major_file_operations;
	137	void *file_private;
	138	struct mei_message_data request_buffer;
	139	struct mei_message_data response_buffer;
	140	unsigned long information;
	141	unsigned long read_time;
	142	struct file *file_object;
	143	};
	144
	145	/* MEI client instance carried as file->pirvate_data*/
	146	struct mei_cl {
	147	struct list_head link;
	148	struct mei_device *dev;
	149	enum file_state state;
	150	wait_queue_head_t tx_wait;
	151	wait_queue_head_t rx_wait;
	152	wait_queue_head_t wait;
	153	int read_pending;
	154	int status;
	155	/* ID of client connected */
	156	u8 host_client_id;
	157	u8 me_client_id;
	158	u8 mei_flow_ctrl_creds;
	159	u8 timer_count;
	160	enum mei_file_transaction_states reading_state;
	161	enum mei_file_transaction_states writing_state;
	162	int sm_state;
	163	struct mei_cl_cb *read_cb;
	164	};
	165
	166	struct mei_io_list {
	167	struct mei_cl_cb mei_cb;
ab841160 OW	168	};
ab841160 OW	169
24aadc80 TW	170	/**
	171	* struct mei_deive - MEI private device struct
	172	* @hbuf_depth - depth of host(write) buffer
	173	*/
ab841160 OW	174	struct mei_device {
	175	struct pci_dev pdev; / pointer to pci device struct */
	176	/*
	177	* lists of queues
	178	*/
	179	/* array of pointers to aio lists */
ab841160 OW	180	struct mei_io_list read_list; /* driver read queue */
	181	struct mei_io_list write_list; /* driver write queue */
	182	struct mei_io_list write_waiting_list; /* write waiting queue */
	183	struct mei_io_list ctrl_wr_list; /* managed write IOCTL list */
	184	struct mei_io_list ctrl_rd_list; /* managed read IOCTL list */
	185	struct mei_io_list amthi_cmd_list; /* amthi list for cmd waiting */
	186
	187	/* driver managed amthi list for reading completed amthi cmd data */
	188	struct mei_io_list amthi_read_complete_list;
	189	/*
	190	* list of files
	191	*/
	192	struct list_head file_list;
eb9af0ac	193	long open_handle_count;
ab841160 OW	194	/*
	195	* memory of device
	196	*/
	197	unsigned int mem_base;
	198	unsigned int mem_length;
	199	void __iomem *mem_addr;
	200	/*
	201	* lock for the device
	202	*/
	203	struct mutex device_lock; /* device lock */
a61c6530	204	struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
eb9af0ac	205	bool recvd_msg;
ab841160 OW	206	/*
	207	* hw states of host and fw(ME)
	208	*/
	209	u32 host_hw_state;
	210	u32 me_hw_state;
24aadc80	211	u8 hbuf_depth;
ab841160 OW	212	/*
	213	* waiting queue for receive message from FW
	214	*/
	215	wait_queue_head_t wait_recvd_msg;
	216	wait_queue_head_t wait_stop_wd;
	217
	218	/*
	219	* mei device states
	220	*/
	221	enum mei_states mei_state;
	222	enum mei_init_clients_states init_clients_state;
	223	u16 init_clients_timer;
eb9af0ac TW	224	bool stop;
eb9af0ac TW	225	bool need_reset;
ab841160 OW	226
ab841160 OW	227	u32 extra_write_index;
edf1eed4	228	unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
ab841160 OW	229	u32 wr_msg_buf[128]; /* used for control messages */
	230	u32 ext_msg_buf[8]; /* for control responses */
	231	u32 rd_msg_hdr;
	232
	233	struct hbm_version version;
	234
ab841160 OW	235	struct mei_me_client me_clients; / Note: memory has to be allocated */
	236	DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
	237	DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
cf9673da	238	u8 me_clients_num;
ab841160 OW	239	u8 me_client_presentation_num;
ab841160 OW	240	u8 me_client_index;
eb9af0ac	241	bool mei_host_buffer_is_empty;
ab841160	242
eb9af0ac	243	struct mei_cl wd_cl;
21c66d1b	244	bool wd_interface_reg;
eb9af0ac TW	245	bool wd_pending;
	246	bool wd_stopped;
	247	bool wd_bypass; /* if false, don't refresh watchdog ME client */
ab841160 OW	248	u16 wd_timeout; /* seconds ((wd_data[1] << 8) + wd_data[0]) */
	249	unsigned char wd_data[MEI_START_WD_DATA_SIZE];
	250
	251
ab841160 OW	252	struct file *iamthif_file_object;
ab841160 OW	253	struct mei_cl iamthif_cl;
eb9af0ac	254	struct mei_cl_cb *iamthif_current_cb;
ab841160 OW	255	int iamthif_mtu;
	256	unsigned long iamthif_timer;
	257	u32 iamthif_stall_timer;
	258	unsigned char iamthif_msg_buf; / Note: memory has to be allocated */
	259	u32 iamthif_msg_buf_size;
	260	u32 iamthif_msg_buf_index;
ab841160	261	enum iamthif_states iamthif_state;
eb9af0ac TW	262	bool iamthif_flow_control_pending;
	263	bool iamthif_ioctl;
	264	bool iamthif_canceled;
ab841160 OW	265	};
	266
	267
	268	/*
	269	* mei init function prototypes
	270	*/
c95efb74	271	struct mei_device mei_device_init(struct pci_dev pdev);
ab841160 OW	272	void mei_reset(struct mei_device *dev, int interrupts);
	273	int mei_hw_init(struct mei_device *dev);
	274	int mei_task_initialize_clients(void *data);
	275	int mei_initialize_clients(struct mei_device *dev);
ab841160	276	int mei_disconnect_host_client(struct mei_device dev, struct mei_cl cl);
106fb49f	277	void mei_remove_client_from_file_list(struct mei_device *dev, u8 host_client_id);
c95efb74 TW	278	void mei_host_init_iamthif(struct mei_device *dev);
c95efb74 TW	279	void mei_allocate_me_clients_storage(struct mei_device *dev);
ab841160	280
ab841160 OW	281
	282	u8 mei_find_me_client_update_filext(struct mei_device *dev,
	283	struct mei_cl *priv,
	284	const uuid_le *cguid, u8 client_id);
	285
0288c7c9 TW	286	/*
	287	* MEI IO List Functions
	288	*/
	289	void mei_io_list_init(struct mei_io_list *list);
	290	void mei_io_list_flush(struct mei_io_list list, struct mei_cl cl);
	291
ab841160	292	/*
c95efb74 TW	293	* MEI ME Client Functions
	294	*/
	295
	296	struct mei_cl mei_cl_allocate(struct mei_device dev);
0288c7c9 TW	297	void mei_cl_init(struct mei_cl cl, struct mei_device dev);
	298	int mei_cl_flush_queues(struct mei_cl *cl);
	299	/**
	300	* mei_cl_cmp_id - tells if file private data have same id
	301	*
	302	* @fe1: private data of 1. file object
	303	* @fe2: private data of 2. file object
	304	*
	305	* returns true - if ids are the same and not NULL
	306	*/
	307	static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
	308	const struct mei_cl *cl2)
	309	{
	310	return cl1 && cl2 &&
	311	(cl1->host_client_id == cl2->host_client_id) &&
	312	(cl1->me_client_id == cl2->me_client_id);
	313	}
	314
c95efb74 TW	315
	316
	317	/*
	318	* MEI Host Client Functions
	319	*/
	320	void mei_host_start_message(struct mei_device *dev);
	321	void mei_host_enum_clients_message(struct mei_device *dev);
abc51b6d	322	int mei_host_client_properties(struct mei_device *dev);
c95efb74 TW	323
	324	/*
	325	* MEI interrupt functions prototype
ab841160 OW	326	*/
ab841160 OW	327	irqreturn_t mei_interrupt_quick_handler(int irq, void *dev_id);
c95efb74	328	irqreturn_t mei_interrupt_thread_handler(int irq, void *dev_id);
a61c6530	329	void mei_timer(struct work_struct *work);
ab841160 OW	330
ab841160 OW	331	/*
c95efb74	332	* MEI input output function prototype
ab841160 OW	333	*/
	334	int mei_ioctl_connect_client(struct file *file,
	335	struct mei_connect_client_data *data);
	336
	337	int mei_start_read(struct mei_device dev, struct mei_cl cl);
	338
	339	int amthi_write(struct mei_device dev, struct mei_cl_cb priv_cb);
	340
	341	int amthi_read(struct mei_device dev, struct file file,
	342	char __user ubuf, size_t length, loff_t offset);
	343
	344	struct mei_cl_cb find_amthi_read_list_entry(struct mei_device dev,
	345	struct file *file);
	346
c95efb74	347	void mei_run_next_iamthif_cmd(struct mei_device *dev);
ab841160 OW	348
	349	void mei_free_cb_private(struct mei_cl_cb *priv_cb);
	350
	351	int mei_find_me_client_index(const struct mei_device *dev, uuid_le cuuid);
	352
	353	/*
	354	* Register Access Function
	355	*/
	356
	357	/**
	358	* mei_reg_read - Reads 32bit data from the mei device
	359	*
	360	* @dev: the device structure
	361	* @offset: offset from which to read the data
	362	*
92eb4013	363	* returns register value (u32)
ab841160	364	*/
4a0d6a74 TW	365	static inline u32 mei_reg_read(const struct mei_device *dev,
4a0d6a74 TW	366	unsigned long offset)
ab841160 OW	367	{
	368	return ioread32(dev->mem_addr + offset);
	369	}
	370
	371	/**
	372	* mei_reg_write - Writes 32bit data to the mei device
	373	*
	374	* @dev: the device structure
	375	* @offset: offset from which to write the data
92eb4013	376	* @value: register value to write (u32)
ab841160	377	*/
4a0d6a74 TW	378	static inline void mei_reg_write(const struct mei_device *dev,
4a0d6a74 TW	379	unsigned long offset, u32 value)
ab841160 OW	380	{
	381	iowrite32(value, dev->mem_addr + offset);
	382	}
	383
	384	/**
	385	* mei_hcsr_read - Reads 32bit data from the host CSR
	386	*
	387	* @dev: the device structure
	388	*
	389	* returns the byte read.
	390	*/
4a0d6a74	391	static inline u32 mei_hcsr_read(const struct mei_device *dev)
ab841160 OW	392	{
	393	return mei_reg_read(dev, H_CSR);
	394	}
	395
	396	/**
	397	* mei_mecsr_read - Reads 32bit data from the ME CSR
	398	*
	399	* @dev: the device structure
	400	*
	401	* returns ME_CSR_HA register value (u32)
	402	*/
4a0d6a74	403	static inline u32 mei_mecsr_read(const struct mei_device *dev)
ab841160 OW	404	{
	405	return mei_reg_read(dev, ME_CSR_HA);
	406	}
	407
	408	/**
	409	* get_me_cb_rw - Reads 32bit data from the mei ME_CB_RW register
	410	*
	411	* @dev: the device structure
	412	*
	413	* returns ME_CB_RW register value (u32)
	414	*/
4a0d6a74	415	static inline u32 mei_mecbrw_read(const struct mei_device *dev)
ab841160 OW	416	{
	417	return mei_reg_read(dev, ME_CB_RW);
	418	}
	419
	420
	421	/*
	422	* mei interface function prototypes
	423	*/
	424	void mei_hcsr_set(struct mei_device *dev);
	425	void mei_csr_clear_his(struct mei_device *dev);
	426
	427	void mei_enable_interrupts(struct mei_device *dev);
	428	void mei_disable_interrupts(struct mei_device *dev);
	429
ab841160	430	#endif