[mirror_ubuntu-eoan-kernel.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/poll.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)

/*
 * Internal Clients Number
 */
#define MEI_WD_HOST_CLIENT_ID          1
#define MEI_IAMTHIF_HOST_CLIENT_ID     2


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

/**
 * enum mei_cb_file_ops  - file operation associated with the callback
 * @MEI_FOP_READ   - read
 * @MEI_FOP_WRITE  - write
 * @MEI_FOP_IOCTL  - ioctl
 * @MEI_FOP_OPEN   - open
 * @MEI_FOP_CLOSE  - close
 */
enum mei_cb_file_ops {
	MEI_FOP_READ = 0,
	MEI_FOP_WRITE,
	MEI_FOP_IOCTL,
	MEI_FOP_OPEN,
	MEI_FOP_CLOSE
};

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


struct mei_cl;

/**
 * struct mei_cl_cb - file operation callback structure
 *
 * @cl - file client who is running this operation
 * @fop_type - file operation type
 */
struct mei_cl_cb {
	struct list_head list;
	struct mei_cl *cl;
	enum mei_cb_file_ops fop_type;
	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_device -  MEI private device struct
 * @hbuf_depth - depth of host(write) buffer
 * @wr_ext_msg - buffer for hbm control responses (set in read cycle)
 */
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 */

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

	unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];	/* control messages */
	u32 rd_msg_hdr;
	u32 wr_msg_buf[128];	/* used for control messages */
	struct {
		struct mei_msg_hdr hdr;
		unsigned char data[4];	/* All HBM messages are 4 bytes */
	} wr_ext_msg;		/* for control responses */

	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_pending;
	u16 wd_timeout;
	unsigned char wd_data[MEI_WD_START_MSG_SIZE];


	/* amthif list for cmd waiting */
	struct mei_cl_cb amthif_cmd_list;
	/* driver managed amthif list for reading completed amthif cmd data */
	struct mei_cl_cb amthif_rd_complete_list;
	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;

	struct work_struct init_work;
};

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_allocate_me_clients_storage(struct mei_device *dev);


int mei_me_cl_link(struct mei_device *dev, struct mei_cl *cl,
			const uuid_le *cguid, u8 host_client_id);
void mei_me_cl_unlink(struct mei_device *dev, struct mei_cl *cl);
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_enumerate(struct mei_device *dev);
void mei_host_client_init(struct work_struct *work);

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


/*
 * AMTHIF - AMT Host Interface Functions
 */
void mei_amthif_reset_params(struct mei_device *dev);

void mei_amthif_host_init(struct mei_device *dev);

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

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

unsigned int mei_amthif_poll(struct mei_device *dev,
		struct file *file, poll_table *wait);

int mei_amthif_release(struct mei_device *dev, struct file *file);

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

void mei_amthif_run_next_cmd(struct mei_device *dev);


int mei_amthif_read_message(struct mei_cl_cb *complete_list,
		struct mei_device *dev, struct mei_msg_hdr *mei_hdr);

int mei_amthif_irq_write_complete(struct mei_device *dev, s32 *slots,
			struct mei_cl_cb *cb, struct mei_cl_cb *cmpl_list);

void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
int mei_amthif_irq_read_message(struct mei_cl_cb *complete_list,
		struct mei_device *dev, struct mei_msg_hdr *mei_hdr);
int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);

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

static inline struct mei_msg_hdr *mei_hbm_hdr(u32 *buf, size_t length)
{
	struct mei_msg_hdr *hdr = (struct mei_msg_hdr *)buf;
	hdr->host_addr = 0;
	hdr->me_addr = 0;
	hdr->length = length;
	hdr->msg_complete = 1;
	hdr->reserved = 0;
	return hdr;
}

#define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d comp=%1d"
#define MEI_HDR_PRM(hdr)                  \
	(hdr)->host_addr, (hdr)->me_addr, \
	(hdr)->length, (hdr)->msg_complete

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