[GitHub/mt8127/android_kernel_alcatel_ttab.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_WD_HDR_SIZE       4
#define MEI_WD_STOP_MSG_SIZE  MEI_WD_HDR_SIZE
#define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)

#define MEI_WD_DEFAULT_TIMEOUT   120  /* seconds */
#define MEI_WD_MIN_TIMEOUT       120  /* seconds */
#define MEI_WD_MAX_TIMEOUT     65535  /* seconds */

#define MEI_WD_STOP_TIMEOUT      10 /* msecs */

#define MEI_WD_STATE_INDEPENDENCE_MSG_SENT       (1 << 0)

#define MEI_RD_MSG_BUF_SIZE           (128 * sizeof(u32))


/*
 * 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 Maximum MEI Clients
 */
#define MEI_CLIENTS_MAX 256

/*
 * Number of File descriptors/handles
 * that can be opened to the driver.
 *
 * Limit to 253: 256 Total Clients
 * minus internal client for MEI Bus Messags
 * minus internal client for AMTHI
 * minus internal client for Watchdog
 */
#define  MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 3)


/* 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_dev_state {
	MEI_DEV_INITIALIZING = 0,
	MEI_DEV_INIT_CLIENTS,
	MEI_DEV_ENABLED,
	MEI_DEV_RESETING,
	MEI_DEV_DISABLED,
	MEI_DEV_RECOVERING_FROM_RESET,
	MEI_DEV_POWER_DOWN,
	MEI_DEV_POWER_UP
};

const char *mei_dev_state_str(int state);

/* 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
};

enum mei_wd_states {
	MEI_WD_IDLE,
	MEI_WD_RUNNING,
	MEI_WD_STOPPING,
};

/* 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;
};


struct mei_cl_cb {
	struct list_head 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 buf_idx;
	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_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_cl_cb read_list;		/* driver read queue */
	struct mei_cl_cb write_list;		/* driver write queue */
	struct mei_cl_cb write_waiting_list;	/* write waiting queue */
	struct mei_cl_cb ctrl_wr_list;		/* managed write IOCTL list */
	struct mei_cl_cb ctrl_rd_list;		/* managed read IOCTL list */
	struct mei_cl_cb amthi_cmd_list;	/* amthi list for cmd waiting */

	/* driver managed amthi list for reading completed amthi cmd data */
	struct mei_cl_cb 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_dev_state dev_state;
	enum mei_init_clients_states init_clients_state;
	u16 init_clients_timer;
	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;
	enum mei_wd_states wd_state;
	bool wd_interface_reg;
	bool wd_pending;
	u16 wd_timeout;
	unsigned char wd_data[MEI_WD_START_MSG_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;
};

static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
{
	return msecs_to_jiffies(sec * MSEC_PER_SEC);
}


/*
 * 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);


int mei_me_cl_update_filext(struct mei_device *dev, struct mei_cl *cl,
			const uuid_le *cguid, u8 host_client_id);
int mei_me_cl_by_uuid(const struct mei_device *dev, const uuid_le *cuuid);
int mei_me_cl_by_id(struct mei_device *dev, u8 client_id);

/*
 * MEI IO Functions
 */
struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp);
void mei_io_cb_free(struct mei_cl_cb *priv_cb);
int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length);
int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length);


/**
 * mei_io_list_init - Sets up a queue list.
 *
 * @list: An instance cl callback structure
 */
static inline void mei_io_list_init(struct mei_cl_cb *list)
{
	INIT_LIST_HEAD(&list->list);
}
void mei_io_list_flush(struct mei_cl_cb *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);


/*
 * 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	*/
248ffdf7 TW	28	#define MEI_WD_HDR_SIZE 4
	29	#define MEI_WD_STOP_MSG_SIZE MEI_WD_HDR_SIZE
	30	#define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)
	31
	32	#define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */
	33	#define MEI_WD_MIN_TIMEOUT 120 /* seconds */
	34	#define MEI_WD_MAX_TIMEOUT 65535 /* seconds */
	35
c216fdeb TW	36	#define MEI_WD_STOP_TIMEOUT 10 /* msecs */
c216fdeb TW	37
ab841160 OW	38	#define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0)
ab841160 OW	39
edf1eed4 TW	40	#define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32))
edf1eed4 TW	41
9ce178e5	42
ab841160 OW	43	/*
	44	* AMTHI Client UUID
	45	*/
	46	extern const uuid_le mei_amthi_guid;
	47
	48	/*
	49	* Watchdog Client UUID
	50	*/
	51	extern const uuid_le mei_wd_guid;
	52
	53	/*
	54	* Watchdog independence state message
	55	*/
	56	extern const u8 mei_wd_state_independence_msg[3][4];
	57
1e2776c3 TW	58	/*
	59	* Number of Maximum MEI Clients
	60	*/
	61	#define MEI_CLIENTS_MAX 256
	62
ab841160 OW	63	/*
	64	* Number of File descriptors/handles
	65	* that can be opened to the driver.
	66	*
1e2776c3 TW	67	* Limit to 253: 256 Total Clients
1e2776c3 TW	68	* minus internal client for MEI Bus Messags
ab841160 OW	69	* minus internal client for AMTHI
	70	* minus internal client for Watchdog
	71	*/
1e2776c3	72	#define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 3)
ab841160	73
ab841160 OW	74
	75	/* File state */
	76	enum file_state {
	77	MEI_FILE_INITIALIZING = 0,
	78	MEI_FILE_CONNECTING,
	79	MEI_FILE_CONNECTED,
	80	MEI_FILE_DISCONNECTING,
	81	MEI_FILE_DISCONNECTED
	82	};
	83
	84	/* MEI device states */
b210d750 TW	85	enum mei_dev_state {
	86	MEI_DEV_INITIALIZING = 0,
	87	MEI_DEV_INIT_CLIENTS,
	88	MEI_DEV_ENABLED,
	89	MEI_DEV_RESETING,
	90	MEI_DEV_DISABLED,
	91	MEI_DEV_RECOVERING_FROM_RESET,
	92	MEI_DEV_POWER_DOWN,
	93	MEI_DEV_POWER_UP
ab841160 OW	94	};
ab841160 OW	95
b210d750 TW	96	const char *mei_dev_state_str(int state);
b210d750 TW	97
5f9092f3	98	/* init clients states*/
ab841160 OW	99	enum mei_init_clients_states {
	100	MEI_START_MESSAGE = 0,
	101	MEI_ENUM_CLIENTS_MESSAGE,
	102	MEI_CLIENT_PROPERTIES_MESSAGE
	103	};
	104
	105	enum iamthif_states {
	106	MEI_IAMTHIF_IDLE,
	107	MEI_IAMTHIF_WRITING,
	108	MEI_IAMTHIF_FLOW_CONTROL,
	109	MEI_IAMTHIF_READING,
	110	MEI_IAMTHIF_READ_COMPLETE
	111	};
	112
	113	enum mei_file_transaction_states {
	114	MEI_IDLE,
	115	MEI_WRITING,
	116	MEI_WRITE_COMPLETE,
	117	MEI_FLOW_CONTROL,
	118	MEI_READING,
	119	MEI_READ_COMPLETE
	120	};
	121
c216fdeb TW	122	enum mei_wd_states {
	123	MEI_WD_IDLE,
	124	MEI_WD_RUNNING,
	125	MEI_WD_STOPPING,
	126	};
	127
ab841160 OW	128	/* MEI CB */
	129	enum mei_cb_major_types {
	130	MEI_READ = 0,
	131	MEI_WRITE,
	132	MEI_IOCTL,
	133	MEI_OPEN,
	134	MEI_CLOSE
	135	};
	136
	137	/*
	138	* Intel MEI message data struct
	139	*/
	140	struct mei_message_data {
	141	u32 size;
edf1eed4	142	unsigned char *data;
f060939d	143	};
ab841160 OW	144
	145
	146	struct mei_cl_cb {
fb601adb	147	struct list_head list;
ab841160 OW	148	enum mei_cb_major_types major_file_operations;
	149	void *file_private;
	150	struct mei_message_data request_buffer;
	151	struct mei_message_data response_buffer;
ebb108ef	152	unsigned long buf_idx;
ab841160 OW	153	unsigned long read_time;
	154	struct file *file_object;
	155	};
	156
	157	/* MEI client instance carried as file->pirvate_data*/
	158	struct mei_cl {
	159	struct list_head link;
	160	struct mei_device *dev;
	161	enum file_state state;
	162	wait_queue_head_t tx_wait;
	163	wait_queue_head_t rx_wait;
	164	wait_queue_head_t wait;
	165	int read_pending;
	166	int status;
	167	/* ID of client connected */
	168	u8 host_client_id;
	169	u8 me_client_id;
	170	u8 mei_flow_ctrl_creds;
	171	u8 timer_count;
	172	enum mei_file_transaction_states reading_state;
	173	enum mei_file_transaction_states writing_state;
	174	int sm_state;
	175	struct mei_cl_cb *read_cb;
	176	};
	177
24aadc80 TW	178	/**
	179	* struct mei_deive - MEI private device struct
	180	* @hbuf_depth - depth of host(write) buffer
	181	*/
ab841160 OW	182	struct mei_device {
	183	struct pci_dev pdev; / pointer to pci device struct */
	184	/*
	185	* lists of queues
	186	*/
	187	/* array of pointers to aio lists */
fb601adb TW	188	struct mei_cl_cb read_list; /* driver read queue */
	189	struct mei_cl_cb write_list; /* driver write queue */
	190	struct mei_cl_cb write_waiting_list; /* write waiting queue */
	191	struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */
	192	struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */
	193	struct mei_cl_cb amthi_cmd_list; /* amthi list for cmd waiting */
ab841160 OW	194
ab841160 OW	195	/* driver managed amthi list for reading completed amthi cmd data */
fb601adb	196	struct mei_cl_cb amthi_read_complete_list;
ab841160 OW	197	/*
	198	* list of files
	199	*/
	200	struct list_head file_list;
eb9af0ac	201	long open_handle_count;
ab841160 OW	202	/*
	203	* memory of device
	204	*/
	205	unsigned int mem_base;
	206	unsigned int mem_length;
	207	void __iomem *mem_addr;
	208	/*
	209	* lock for the device
	210	*/
	211	struct mutex device_lock; /* device lock */
a61c6530	212	struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
eb9af0ac	213	bool recvd_msg;
ab841160 OW	214	/*
	215	* hw states of host and fw(ME)
	216	*/
	217	u32 host_hw_state;
	218	u32 me_hw_state;
24aadc80	219	u8 hbuf_depth;
ab841160 OW	220	/*
	221	* waiting queue for receive message from FW
	222	*/
	223	wait_queue_head_t wait_recvd_msg;
	224	wait_queue_head_t wait_stop_wd;
	225
	226	/*
	227	* mei device states
	228	*/
b210d750	229	enum mei_dev_state dev_state;
ab841160 OW	230	enum mei_init_clients_states init_clients_state;
ab841160 OW	231	u16 init_clients_timer;
eb9af0ac	232	bool need_reset;
ab841160 OW	233
ab841160 OW	234	u32 extra_write_index;
edf1eed4	235	unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
ab841160 OW	236	u32 wr_msg_buf[128]; /* used for control messages */
	237	u32 ext_msg_buf[8]; /* for control responses */
	238	u32 rd_msg_hdr;
	239
	240	struct hbm_version version;
	241
ab841160 OW	242	struct mei_me_client me_clients; / Note: memory has to be allocated */
	243	DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
	244	DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
cf9673da	245	u8 me_clients_num;
ab841160 OW	246	u8 me_client_presentation_num;
ab841160 OW	247	u8 me_client_index;
eb9af0ac	248	bool mei_host_buffer_is_empty;
ab841160	249
eb9af0ac	250	struct mei_cl wd_cl;
c216fdeb	251	enum mei_wd_states wd_state;
21c66d1b	252	bool wd_interface_reg;
eb9af0ac	253	bool wd_pending;
c216fdeb	254	u16 wd_timeout;
248ffdf7	255	unsigned char wd_data[MEI_WD_START_MSG_SIZE];
ab841160 OW	256
ab841160 OW	257
ab841160 OW	258	struct file *iamthif_file_object;
ab841160 OW	259	struct mei_cl iamthif_cl;
eb9af0ac	260	struct mei_cl_cb *iamthif_current_cb;
ab841160 OW	261	int iamthif_mtu;
	262	unsigned long iamthif_timer;
	263	u32 iamthif_stall_timer;
	264	unsigned char iamthif_msg_buf; / Note: memory has to be allocated */
	265	u32 iamthif_msg_buf_size;
	266	u32 iamthif_msg_buf_index;
ab841160	267	enum iamthif_states iamthif_state;
eb9af0ac TW	268	bool iamthif_flow_control_pending;
	269	bool iamthif_ioctl;
	270	bool iamthif_canceled;
ab841160 OW	271	};
ab841160 OW	272
3870c320 TW	273	static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
	274	{
	275	return msecs_to_jiffies(sec * MSEC_PER_SEC);
	276	}
	277
ab841160 OW	278
	279	/*
	280	* mei init function prototypes
	281	*/
c95efb74	282	struct mei_device mei_device_init(struct pci_dev pdev);
ab841160 OW	283	void mei_reset(struct mei_device *dev, int interrupts);
	284	int mei_hw_init(struct mei_device *dev);
	285	int mei_task_initialize_clients(void *data);
	286	int mei_initialize_clients(struct mei_device *dev);
ab841160	287	int mei_disconnect_host_client(struct mei_device dev, struct mei_cl cl);
106fb49f	288	void mei_remove_client_from_file_list(struct mei_device *dev, u8 host_client_id);
c95efb74 TW	289	void mei_host_init_iamthif(struct mei_device *dev);
c95efb74 TW	290	void mei_allocate_me_clients_storage(struct mei_device *dev);
ab841160	291
ab841160	292
07b509b7 TW	293	int mei_me_cl_update_filext(struct mei_device dev, struct mei_cl cl,
	294	const uuid_le *cguid, u8 host_client_id);
	295	int mei_me_cl_by_uuid(const struct mei_device dev, const uuid_le cuuid);
	296	int mei_me_cl_by_id(struct mei_device *dev, u8 client_id);
ab841160	297
0288c7c9	298	/*
601a1efa	299	* MEI IO Functions
0288c7c9	300	*/
664df38b	301	struct mei_cl_cb mei_io_cb_init(struct mei_cl cl, struct file *fp);
601a1efa	302	void mei_io_cb_free(struct mei_cl_cb *priv_cb);
664df38b TW	303	int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length);
	304	int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length);
	305
601a1efa	306
fb601adb TW	307	/**
	308	* mei_io_list_init - Sets up a queue list.
	309	*
	310	* @list: An instance cl callback structure
	311	*/
	312	static inline void mei_io_list_init(struct mei_cl_cb *list)
	313	{
	314	INIT_LIST_HEAD(&list->list);
	315	}
	316	void mei_io_list_flush(struct mei_cl_cb list, struct mei_cl cl);
0288c7c9	317
ab841160	318	/*
c95efb74 TW	319	* MEI ME Client Functions
	320	*/
	321
	322	struct mei_cl mei_cl_allocate(struct mei_device dev);
0288c7c9 TW	323	void mei_cl_init(struct mei_cl cl, struct mei_device dev);
	324	int mei_cl_flush_queues(struct mei_cl *cl);
	325	/**
	326	* mei_cl_cmp_id - tells if file private data have same id
	327	*
	328	* @fe1: private data of 1. file object
	329	* @fe2: private data of 2. file object
	330	*
	331	* returns true - if ids are the same and not NULL
	332	*/
	333	static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
	334	const struct mei_cl *cl2)
	335	{
	336	return cl1 && cl2 &&
	337	(cl1->host_client_id == cl2->host_client_id) &&
	338	(cl1->me_client_id == cl2->me_client_id);
	339	}
	340
c95efb74 TW	341
	342
	343	/*
	344	* MEI Host Client Functions
	345	*/
	346	void mei_host_start_message(struct mei_device *dev);
	347	void mei_host_enum_clients_message(struct mei_device *dev);
abc51b6d	348	int mei_host_client_properties(struct mei_device *dev);
c95efb74 TW	349
	350	/*
	351	* MEI interrupt functions prototype
ab841160 OW	352	*/
ab841160 OW	353	irqreturn_t mei_interrupt_quick_handler(int irq, void *dev_id);
c95efb74	354	irqreturn_t mei_interrupt_thread_handler(int irq, void *dev_id);
a61c6530	355	void mei_timer(struct work_struct *work);
ab841160 OW	356
ab841160 OW	357	/*
c95efb74	358	* MEI input output function prototype
ab841160 OW	359	*/
	360	int mei_ioctl_connect_client(struct file *file,
	361	struct mei_connect_client_data *data);
	362
	363	int mei_start_read(struct mei_device dev, struct mei_cl cl);
	364
	365	int amthi_write(struct mei_device dev, struct mei_cl_cb priv_cb);
	366
	367	int amthi_read(struct mei_device dev, struct file file,
	368	char __user ubuf, size_t length, loff_t offset);
	369
	370	struct mei_cl_cb find_amthi_read_list_entry(struct mei_device dev,
	371	struct file *file);
	372
c95efb74	373	void mei_run_next_iamthif_cmd(struct mei_device *dev);
ab841160	374
ab841160	375
ab841160 OW	376
	377	/*
	378	* Register Access Function
	379	*/
	380
	381	/**
	382	* mei_reg_read - Reads 32bit data from the mei device
	383	*
	384	* @dev: the device structure
	385	* @offset: offset from which to read the data
	386	*
92eb4013	387	* returns register value (u32)
ab841160	388	*/
4a0d6a74 TW	389	static inline u32 mei_reg_read(const struct mei_device *dev,
4a0d6a74 TW	390	unsigned long offset)
ab841160 OW	391	{
	392	return ioread32(dev->mem_addr + offset);
	393	}
	394
	395	/**
	396	* mei_reg_write - Writes 32bit data to the mei device
	397	*
	398	* @dev: the device structure
	399	* @offset: offset from which to write the data
92eb4013	400	* @value: register value to write (u32)
ab841160	401	*/
4a0d6a74 TW	402	static inline void mei_reg_write(const struct mei_device *dev,
4a0d6a74 TW	403	unsigned long offset, u32 value)
ab841160 OW	404	{
	405	iowrite32(value, dev->mem_addr + offset);
	406	}
	407
	408	/**
	409	* mei_hcsr_read - Reads 32bit data from the host CSR
	410	*
	411	* @dev: the device structure
	412	*
	413	* returns the byte read.
	414	*/
4a0d6a74	415	static inline u32 mei_hcsr_read(const struct mei_device *dev)
ab841160 OW	416	{
	417	return mei_reg_read(dev, H_CSR);
	418	}
	419
	420	/**
	421	* mei_mecsr_read - Reads 32bit data from the ME CSR
	422	*
	423	* @dev: the device structure
	424	*
	425	* returns ME_CSR_HA register value (u32)
	426	*/
4a0d6a74	427	static inline u32 mei_mecsr_read(const struct mei_device *dev)
ab841160 OW	428	{
	429	return mei_reg_read(dev, ME_CSR_HA);
	430	}
	431
	432	/**
	433	* get_me_cb_rw - Reads 32bit data from the mei ME_CB_RW register
	434	*
	435	* @dev: the device structure
	436	*
	437	* returns ME_CB_RW register value (u32)
	438	*/
4a0d6a74	439	static inline u32 mei_mecbrw_read(const struct mei_device *dev)
ab841160 OW	440	{
	441	return mei_reg_read(dev, ME_CB_RW);
	442	}
	443
	444
	445	/*
	446	* mei interface function prototypes
	447	*/
	448	void mei_hcsr_set(struct mei_device *dev);
	449	void mei_csr_clear_his(struct mei_device *dev);
	450
	451	void mei_enable_interrupts(struct mei_device *dev);
	452	void mei_disable_interrupts(struct mei_device *dev);
	453
ab841160	454	#endif