[mirror_ubuntu-artful-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"
#include "hw-me-regs.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_amthif_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 255: 256 Total Clients
 * minus internal client for MEI Bus Messags
 */
#define  MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)

/*
 * Internal Clients Number
 */
#define MEI_HOST_CLIENT_ID_ANY        (-1)
#define MEI_HBM_HOST_CLIENT_ID         0 /* not used, just for documentation */
#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_me_client - representation of me (fw) client
 *
 * @props  - client properties
 * @client_id - me client id
 * @mei_flow_ctrl_creds - flow control credits
 */
struct mei_me_client {
	struct mei_client_properties props;
	u8 client_id;
	u8 mei_flow_ctrl_creds;
};


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 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
 * @mem_addr - mem mapped base register address
 * @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;

	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;

	unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];	/* control messages */
	u32 rd_msg_hdr;

	/* used for control messages */
	struct {
		struct mei_msg_hdr hdr;
		unsigned char data[128];
	} wr_msg;

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

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

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

int 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_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);


int mei_wd_send(struct mei_device *dev);
int mei_wd_stop(struct mei_device *dev);
int mei_wd_host_init(struct mei_device *dev);
/*
 * mei_watchdog_register  - Registering watchdog interface
 *   once we got connection to the WD Client
 * @dev - mei device
 */
void mei_watchdog_register(struct mei_device *dev);
/*
 * mei_watchdog_unregister  - Unregistering watchdog interface
 * @dev - mei device
 */
void mei_watchdog_unregister(struct mei_device *dev);


/*
 * Register Access Function
 */

void mei_hw_config(struct mei_device *dev);
void mei_hw_reset(struct mei_device *dev, bool intr_enable);
u32 mei_mecbrw_read(const struct mei_device *dev);


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

void mei_host_set_ready(struct mei_device *dev);
bool mei_host_is_ready(struct mei_device *dev);
bool mei_me_is_ready(struct mei_device *dev);


int mei_register(struct device *dev);
void mei_deregister(void);

#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>
66ef5ea9	24
ab841160	25	#include "hw.h"
9dc64d6a	26	#include "hw-me-regs.h"
ab841160	27
ab841160 OW	28	/*
	29	* watch dog definition
	30	*/
248ffdf7 TW	31	#define MEI_WD_HDR_SIZE 4
	32	#define MEI_WD_STOP_MSG_SIZE MEI_WD_HDR_SIZE
	33	#define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)
	34
	35	#define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */
	36	#define MEI_WD_MIN_TIMEOUT 120 /* seconds */
	37	#define MEI_WD_MAX_TIMEOUT 65535 /* seconds */
	38
c216fdeb TW	39	#define MEI_WD_STOP_TIMEOUT 10 /* msecs */
c216fdeb TW	40
ab841160 OW	41	#define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0)
ab841160 OW	42
edf1eed4 TW	43	#define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32))
edf1eed4 TW	44
9ce178e5	45
ab841160 OW	46	/*
	47	* AMTHI Client UUID
	48	*/
1a1aca42	49	extern const uuid_le mei_amthif_guid;
ab841160 OW	50
	51	/*
	52	* Watchdog Client UUID
	53	*/
	54	extern const uuid_le mei_wd_guid;
	55
	56	/*
	57	* Watchdog independence state message
	58	*/
	59	extern const u8 mei_wd_state_independence_msg[3][4];
	60
1e2776c3 TW	61	/*
	62	* Number of Maximum MEI Clients
	63	*/
	64	#define MEI_CLIENTS_MAX 256
	65
ab841160 OW	66	/*
	67	* Number of File descriptors/handles
	68	* that can be opened to the driver.
	69	*
781d0d89	70	* Limit to 255: 256 Total Clients
1e2776c3	71	* minus internal client for MEI Bus Messags
ab841160	72	*/
781d0d89	73	#define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
ab841160	74
1d3f3da3 TW	75	/*
	76	* Internal Clients Number
	77	*/
781d0d89 TW	78	#define MEI_HOST_CLIENT_ID_ANY (-1)
781d0d89 TW	79	#define MEI_HBM_HOST_CLIENT_ID 0 /* not used, just for documentation */
1d3f3da3 TW	80	#define MEI_WD_HOST_CLIENT_ID 1
	81	#define MEI_IAMTHIF_HOST_CLIENT_ID 2
	82
ab841160 OW	83
	84	/* File state */
	85	enum file_state {
	86	MEI_FILE_INITIALIZING = 0,
	87	MEI_FILE_CONNECTING,
	88	MEI_FILE_CONNECTED,
	89	MEI_FILE_DISCONNECTING,
	90	MEI_FILE_DISCONNECTED
	91	};
	92
	93	/* MEI device states */
b210d750 TW	94	enum mei_dev_state {
	95	MEI_DEV_INITIALIZING = 0,
	96	MEI_DEV_INIT_CLIENTS,
	97	MEI_DEV_ENABLED,
	98	MEI_DEV_RESETING,
	99	MEI_DEV_DISABLED,
	100	MEI_DEV_RECOVERING_FROM_RESET,
	101	MEI_DEV_POWER_DOWN,
	102	MEI_DEV_POWER_UP
ab841160 OW	103	};
ab841160 OW	104
b210d750 TW	105	const char *mei_dev_state_str(int state);
b210d750 TW	106
5f9092f3	107	/* init clients states*/
ab841160 OW	108	enum mei_init_clients_states {
	109	MEI_START_MESSAGE = 0,
	110	MEI_ENUM_CLIENTS_MESSAGE,
	111	MEI_CLIENT_PROPERTIES_MESSAGE
	112	};
	113
	114	enum iamthif_states {
	115	MEI_IAMTHIF_IDLE,
	116	MEI_IAMTHIF_WRITING,
	117	MEI_IAMTHIF_FLOW_CONTROL,
	118	MEI_IAMTHIF_READING,
	119	MEI_IAMTHIF_READ_COMPLETE
	120	};
	121
	122	enum mei_file_transaction_states {
	123	MEI_IDLE,
	124	MEI_WRITING,
	125	MEI_WRITE_COMPLETE,
	126	MEI_FLOW_CONTROL,
	127	MEI_READING,
	128	MEI_READ_COMPLETE
	129	};
	130
c216fdeb TW	131	enum mei_wd_states {
	132	MEI_WD_IDLE,
	133	MEI_WD_RUNNING,
	134	MEI_WD_STOPPING,
	135	};
	136
4b8960b4 TW	137	/**
	138	* enum mei_cb_file_ops - file operation associated with the callback
	139	* @MEI_FOP_READ - read
	140	* @MEI_FOP_WRITE - write
	141	* @MEI_FOP_IOCTL - ioctl
	142	* @MEI_FOP_OPEN - open
	143	* @MEI_FOP_CLOSE - close
	144	*/
	145	enum mei_cb_file_ops {
	146	MEI_FOP_READ = 0,
	147	MEI_FOP_WRITE,
	148	MEI_FOP_IOCTL,
	149	MEI_FOP_OPEN,
	150	MEI_FOP_CLOSE
ab841160 OW	151	};
	152
	153	/*
	154	* Intel MEI message data struct
	155	*/
	156	struct mei_message_data {
	157	u32 size;
edf1eed4	158	unsigned char *data;
f060939d	159	};
ab841160	160
db7da79d TW	161	/**
	162	* struct mei_me_client - representation of me (fw) client
	163	*
	164	* @props - client properties
	165	* @client_id - me client id
	166	* @mei_flow_ctrl_creds - flow control credits
	167	*/
	168	struct mei_me_client {
	169	struct mei_client_properties props;
	170	u8 client_id;
	171	u8 mei_flow_ctrl_creds;
	172	};
	173
ab841160	174
db3ed431 TW	175	struct mei_cl;
db3ed431 TW	176
4b8960b4	177	/**
db3ed431 TW	178	* struct mei_cl_cb - file operation callback structure
	179	*
	180	* @cl - file client who is running this operation
4b8960b4	181	* @fop_type - file operation type
db3ed431	182	*/
ab841160	183	struct mei_cl_cb {
fb601adb	184	struct list_head list;
db3ed431	185	struct mei_cl *cl;
4b8960b4	186	enum mei_cb_file_ops fop_type;
ab841160 OW	187	struct mei_message_data request_buffer;
ab841160 OW	188	struct mei_message_data response_buffer;
ebb108ef	189	unsigned long buf_idx;
ab841160 OW	190	unsigned long read_time;
	191	struct file *file_object;
	192	};
	193
	194	/* MEI client instance carried as file->pirvate_data*/
	195	struct mei_cl {
	196	struct list_head link;
	197	struct mei_device *dev;
	198	enum file_state state;
	199	wait_queue_head_t tx_wait;
	200	wait_queue_head_t rx_wait;
	201	wait_queue_head_t wait;
ab841160 OW	202	int status;
	203	/* ID of client connected */
	204	u8 host_client_id;
	205	u8 me_client_id;
	206	u8 mei_flow_ctrl_creds;
	207	u8 timer_count;
	208	enum mei_file_transaction_states reading_state;
	209	enum mei_file_transaction_states writing_state;
	210	int sm_state;
	211	struct mei_cl_cb *read_cb;
	212	};
	213
24aadc80	214	/**
5fb54fb4	215	* struct mei_device - MEI private device struct
fecb0d58	216	* @mem_addr - mem mapped base register address
24aadc80	217	* @hbuf_depth - depth of host(write) buffer
5fb54fb4	218	* @wr_ext_msg - buffer for hbm control responses (set in read cycle)
24aadc80	219	*/
ab841160 OW	220	struct mei_device {
	221	struct pci_dev pdev; / pointer to pci device struct */
	222	/*
	223	* lists of queues
	224	*/
e773efc4	225	/* array of pointers to aio lists */
fb601adb TW	226	struct mei_cl_cb read_list; /* driver read queue */
	227	struct mei_cl_cb write_list; /* driver write queue */
	228	struct mei_cl_cb write_waiting_list; /* write waiting queue */
	229	struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */
	230	struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */
ab841160	231
ab841160 OW	232	/*
	233	* list of files
	234	*/
	235	struct list_head file_list;
eb9af0ac	236	long open_handle_count;
fecb0d58	237
ab841160 OW	238	void __iomem *mem_addr;
	239	/*
	240	* lock for the device
	241	*/
	242	struct mutex device_lock; /* device lock */
a61c6530	243	struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
eb9af0ac	244	bool recvd_msg;
ab841160 OW	245	/*
	246	* hw states of host and fw(ME)
	247	*/
	248	u32 host_hw_state;
	249	u32 me_hw_state;
24aadc80	250	u8 hbuf_depth;
ab841160 OW	251	/*
	252	* waiting queue for receive message from FW
	253	*/
	254	wait_queue_head_t wait_recvd_msg;
	255	wait_queue_head_t wait_stop_wd;
	256
	257	/*
	258	* mei device states
	259	*/
b210d750	260	enum mei_dev_state dev_state;
ab841160 OW	261	enum mei_init_clients_states init_clients_state;
ab841160 OW	262	u16 init_clients_timer;
ab841160	263
edf1eed4	264	unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
ab841160	265	u32 rd_msg_hdr;
e46f1874 TW	266
	267	/* used for control messages */
	268	struct {
	269	struct mei_msg_hdr hdr;
	270	unsigned char data[128];
	271	} wr_msg;
	272
5fb54fb4 TW	273	struct {
	274	struct mei_msg_hdr hdr;
	275	unsigned char data[4]; /* All HBM messages are 4 bytes */
	276	} wr_ext_msg; /* for control responses */
ab841160 OW	277
	278	struct hbm_version version;
	279
ab841160 OW	280	struct mei_me_client me_clients; / Note: memory has to be allocated */
	281	DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
	282	DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
cf9673da	283	u8 me_clients_num;
ab841160 OW	284	u8 me_client_presentation_num;
ab841160 OW	285	u8 me_client_index;
eb9af0ac	286	bool mei_host_buffer_is_empty;
ab841160	287
eb9af0ac	288	struct mei_cl wd_cl;
c216fdeb	289	enum mei_wd_states wd_state;
eb9af0ac	290	bool wd_pending;
c216fdeb	291	u16 wd_timeout;
248ffdf7	292	unsigned char wd_data[MEI_WD_START_MSG_SIZE];
ab841160 OW	293
ab841160 OW	294
e773efc4 TW	295	/* amthif list for cmd waiting */
	296	struct mei_cl_cb amthif_cmd_list;
	297	/* driver managed amthif list for reading completed amthif cmd data */
	298	struct mei_cl_cb amthif_rd_complete_list;
ab841160 OW	299	struct file *iamthif_file_object;
ab841160 OW	300	struct mei_cl iamthif_cl;
eb9af0ac	301	struct mei_cl_cb *iamthif_current_cb;
ab841160 OW	302	int iamthif_mtu;
	303	unsigned long iamthif_timer;
	304	u32 iamthif_stall_timer;
	305	unsigned char iamthif_msg_buf; / Note: memory has to be allocated */
	306	u32 iamthif_msg_buf_size;
	307	u32 iamthif_msg_buf_index;
ab841160	308	enum iamthif_states iamthif_state;
eb9af0ac TW	309	bool iamthif_flow_control_pending;
	310	bool iamthif_ioctl;
	311	bool iamthif_canceled;
c1174c0e SO	312
c1174c0e SO	313	struct work_struct init_work;
ab841160 OW	314	};
ab841160 OW	315
3870c320 TW	316	static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
	317	{
	318	return msecs_to_jiffies(sec * MSEC_PER_SEC);
	319	}
	320
ab841160 OW	321
	322	/*
	323	* mei init function prototypes
	324	*/
c95efb74	325	struct mei_device mei_device_init(struct pci_dev pdev);
ab841160 OW	326	void mei_reset(struct mei_device *dev, int interrupts);
ab841160 OW	327	int mei_hw_init(struct mei_device *dev);
c95efb74	328
c95efb74 TW	329	/*
c95efb74 TW	330	* MEI interrupt functions prototype
ab841160 OW	331	*/
ab841160 OW	332	irqreturn_t mei_interrupt_quick_handler(int irq, void *dev_id);
c95efb74	333	irqreturn_t mei_interrupt_thread_handler(int irq, void *dev_id);
a61c6530	334	void mei_timer(struct work_struct *work);
ab841160	335
19838fb8 TW	336	/*
	337	* AMTHIF - AMT Host Interface Functions
	338	*/
	339	void mei_amthif_reset_params(struct mei_device *dev);
	340
781d0d89	341	int mei_amthif_host_init(struct mei_device *dev);
19838fb8 TW	342
	343	int mei_amthif_write(struct mei_device dev, struct mei_cl_cb priv_cb);
	344
	345	int mei_amthif_read(struct mei_device dev, struct file file,
744f0f2f TW	346	char __user ubuf, size_t length, loff_t offset);
	347
	348	unsigned int mei_amthif_poll(struct mei_device *dev,
	349	struct file file, poll_table wait);
ab841160	350
a562d5c2 TW	351	int mei_amthif_release(struct mei_device dev, struct file file);
a562d5c2 TW	352
19838fb8	353	struct mei_cl_cb mei_amthif_find_read_list_entry(struct mei_device dev,
ab841160 OW	354	struct file *file);
ab841160 OW	355
19838fb8 TW	356	void mei_amthif_run_next_cmd(struct mei_device *dev);
	357
	358
24c656e5 TW	359	int mei_amthif_irq_write_complete(struct mei_device dev, s32 slots,
24c656e5 TW	360	struct mei_cl_cb cb, struct mei_cl_cb cmpl_list);
ab841160	361
19838fb8 TW	362	void mei_amthif_complete(struct mei_device dev, struct mei_cl_cb cb);
	363	int mei_amthif_irq_read_message(struct mei_cl_cb *complete_list,
	364	struct mei_device dev, struct mei_msg_hdr mei_hdr);
	365	int mei_amthif_irq_read(struct mei_device dev, s32 slots);
ab841160	366
37e7d6e7 TW	367
	368	int mei_wd_send(struct mei_device *dev);
	369	int mei_wd_stop(struct mei_device *dev);
	370	int mei_wd_host_init(struct mei_device *dev);
	371	/*
	372	* mei_watchdog_register - Registering watchdog interface
	373	* once we got connection to the WD Client
	374	* @dev - mei device
	375	*/
	376	void mei_watchdog_register(struct mei_device *dev);
	377	/*
	378	* mei_watchdog_unregister - Unregistering watchdog interface
	379	* @dev - mei device
	380	*/
	381	void mei_watchdog_unregister(struct mei_device *dev);
	382
	383
ab841160 OW	384	/*
	385	* Register Access Function
	386	*/
	387
e7e0c231	388	void mei_hw_config(struct mei_device *dev);
adfba322	389	void mei_hw_reset(struct mei_device *dev, bool intr_enable);
3a65dd4e	390	u32 mei_mecbrw_read(const struct mei_device *dev);
ab841160	391
ab841160	392
e7e0c231	393
3a65dd4e	394	void mei_clear_interrupts(struct mei_device *dev);
ab841160 OW	395	void mei_enable_interrupts(struct mei_device *dev);
	396	void mei_disable_interrupts(struct mei_device *dev);
	397
115ba28c TW	398	void mei_host_set_ready(struct mei_device *dev);
	399	bool mei_host_is_ready(struct mei_device *dev);
	400	bool mei_me_is_ready(struct mei_device *dev);
	401
3a65dd4e	402
5bd64714	403
2703d4b2 TW	404	int mei_register(struct device *dev);
	405	void mei_deregister(void);
	406
15d4acc5 TW	407	#define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d comp=%1d"
	408	#define MEI_HDR_PRM(hdr) \
	409	(hdr)->host_addr, (hdr)->me_addr, \
	410	(hdr)->length, (hdr)->msg_complete
	411
ab841160	412	#endif