[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"
#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_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_hw_ops
 *
 * @host_is_ready    - query for host readiness

 * @hw_is_ready      - query if hw is ready
 * @hw_reset         - reset hw
 * @hw_start         - start hw after reset
 * @hw_config        - configure hw

 * @intr_clear       - clear pending interrupts
 * @intr_enable      - enable interrupts
 * @intr_disable     - disable interrupts

 * @hbuf_free_slots  - query for write buffer empty slots
 * @hbuf_is_ready    - query if write buffer is empty
 * @hbuf_max_len     - query for write buffer max len

 * @write            - write a message to FW

 * @rdbuf_full_slots - query how many slots are filled

 * @read_hdr         - get first 4 bytes (header)
 * @read             - read a buffer from the FW
 */
struct mei_hw_ops {

	bool (*host_is_ready) (struct mei_device *dev);

	bool (*hw_is_ready) (struct mei_device *dev);
	void (*hw_reset) (struct mei_device *dev, bool enable);
	int  (*hw_start) (struct mei_device *dev);
	void (*hw_config) (struct mei_device *dev);

	void (*intr_clear) (struct mei_device *dev);
	void (*intr_enable) (struct mei_device *dev);
	void (*intr_disable) (struct mei_device *dev);

	int (*hbuf_free_slots) (struct mei_device *dev);
	bool (*hbuf_is_ready) (struct mei_device *dev);
	size_t (*hbuf_max_len) (const struct mei_device *dev);

	int (*write)(struct mei_device *dev,
		     struct mei_msg_hdr *hdr,
		     unsigned char *buf);

	int (*rdbuf_full_slots)(struct mei_device *dev);

	u32 (*read_hdr)(const struct mei_device *dev);
	int (*read) (struct mei_device *dev,
		     unsigned char *buf, unsigned long len);
};

/**
 * struct mei_device -  MEI private device struct

 * @mem_addr - mem mapped base register address

 * @hbuf_depth - depth of hardware host/write buffer is slots
 * @hbuf_is_ready - query if the host host/write buffer is ready
 * @wr_msg - the buffer for hbm control messages
 * @wr_ext_msg - the 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;

	/*
	 * lock for the device
	 */
	struct mutex device_lock; /* device lock */
	struct delayed_work timer_work;	/* MEI timer delayed work (timeouts) */

	bool recvd_hw_ready;
	bool recvd_msg;

	/*
	 * waiting queue for receive message from FW
	 */
	wait_queue_head_t wait_hw_ready;
	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;

	/* write buffer */
	u8 hbuf_depth;
	bool hbuf_is_ready;

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

	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;

	const struct mei_hw_ops *ops;
	char hw[0] __aligned(sizeof(void *));
};

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

/**
 * mei_data2slots - get slots - number of (dwords) from a message length
 *	+ size of the mei header
 * @length - size of the messages in bytes
 * returns  - number of slots
 */
static inline u32 mei_data2slots(size_t length)
{
	return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
}


/*
 * mei init function prototypes
 */
void mei_device_init(struct mei_device *dev);
void mei_reset(struct mei_device *dev, int interrupts);
int mei_start(struct mei_device *dev);
void mei_stop(struct mei_device *dev);

/*
 *  MEI interrupt functions prototype
 */

void mei_timer(struct work_struct *work);
int mei_irq_read_handler(struct mei_device *dev,
		struct mei_cl_cb *cmpl_list, s32 *slots);

int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);

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

static inline void mei_hw_config(struct mei_device *dev)
{
	dev->ops->hw_config(dev);
}
static inline void mei_hw_reset(struct mei_device *dev, bool enable)
{
	dev->ops->hw_reset(dev, enable);
}

static inline void mei_hw_start(struct mei_device *dev)
{
	dev->ops->hw_start(dev);
}

static inline void mei_clear_interrupts(struct mei_device *dev)
{
	dev->ops->intr_clear(dev);
}

static inline void mei_enable_interrupts(struct mei_device *dev)
{
	dev->ops->intr_enable(dev);
}

static inline void mei_disable_interrupts(struct mei_device *dev)
{
	dev->ops->intr_disable(dev);
}

static inline bool mei_host_is_ready(struct mei_device *dev)
{
	return dev->ops->host_is_ready(dev);
}
static inline bool mei_hw_is_ready(struct mei_device *dev)
{
	return dev->ops->hw_is_ready(dev);
}

static inline bool mei_hbuf_is_ready(struct mei_device *dev)
{
	return dev->ops->hbuf_is_ready(dev);
}

static inline int mei_hbuf_empty_slots(struct mei_device *dev)
{
	return dev->ops->hbuf_free_slots(dev);
}

static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
{
	return dev->ops->hbuf_max_len(dev);
}

static inline int mei_write_message(struct mei_device *dev,
			struct mei_msg_hdr *hdr,
			unsigned char *buf)
{
	return dev->ops->write(dev, hdr, buf);
}

static inline u32 mei_read_hdr(const struct mei_device *dev)
{
	return dev->ops->read_hdr(dev);
}

static inline void mei_read_slots(struct mei_device *dev,
		     unsigned char *buf, unsigned long len)
{
	dev->ops->read(dev, buf, len);
}

static inline int mei_count_full_read_slots(struct mei_device *dev)
{
	return dev->ops->rdbuf_full_slots(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,
b210d750 TW	100	MEI_DEV_POWER_DOWN,
b210d750 TW	101	MEI_DEV_POWER_UP
ab841160 OW	102	};
ab841160 OW	103
b210d750 TW	104	const char *mei_dev_state_str(int state);
b210d750 TW	105
5f9092f3	106	/* init clients states*/
ab841160 OW	107	enum mei_init_clients_states {
	108	MEI_START_MESSAGE = 0,
	109	MEI_ENUM_CLIENTS_MESSAGE,
	110	MEI_CLIENT_PROPERTIES_MESSAGE
	111	};
	112
	113	enum iamthif_states {
	114	MEI_IAMTHIF_IDLE,
	115	MEI_IAMTHIF_WRITING,
	116	MEI_IAMTHIF_FLOW_CONTROL,
	117	MEI_IAMTHIF_READING,
	118	MEI_IAMTHIF_READ_COMPLETE
	119	};
	120
	121	enum mei_file_transaction_states {
	122	MEI_IDLE,
	123	MEI_WRITING,
	124	MEI_WRITE_COMPLETE,
	125	MEI_FLOW_CONTROL,
	126	MEI_READING,
	127	MEI_READ_COMPLETE
	128	};
	129
c216fdeb TW	130	enum mei_wd_states {
	131	MEI_WD_IDLE,
	132	MEI_WD_RUNNING,
	133	MEI_WD_STOPPING,
	134	};
	135
4b8960b4 TW	136	/**
	137	* enum mei_cb_file_ops - file operation associated with the callback
	138	* @MEI_FOP_READ - read
	139	* @MEI_FOP_WRITE - write
	140	* @MEI_FOP_IOCTL - ioctl
	141	* @MEI_FOP_OPEN - open
	142	* @MEI_FOP_CLOSE - close
	143	*/
	144	enum mei_cb_file_ops {
	145	MEI_FOP_READ = 0,
	146	MEI_FOP_WRITE,
	147	MEI_FOP_IOCTL,
	148	MEI_FOP_OPEN,
	149	MEI_FOP_CLOSE
ab841160 OW	150	};
	151
	152	/*
	153	* Intel MEI message data struct
	154	*/
	155	struct mei_message_data {
	156	u32 size;
edf1eed4	157	unsigned char *data;
f060939d	158	};
ab841160	159
db7da79d TW	160	/**
	161	* struct mei_me_client - representation of me (fw) client
	162	*
	163	* @props - client properties
	164	* @client_id - me client id
	165	* @mei_flow_ctrl_creds - flow control credits
	166	*/
	167	struct mei_me_client {
	168	struct mei_client_properties props;
	169	u8 client_id;
	170	u8 mei_flow_ctrl_creds;
	171	};
	172
ab841160	173
db3ed431 TW	174	struct mei_cl;
db3ed431 TW	175
4b8960b4	176	/**
db3ed431 TW	177	* struct mei_cl_cb - file operation callback structure
	178	*
	179	* @cl - file client who is running this operation
4b8960b4	180	* @fop_type - file operation type
db3ed431	181	*/
ab841160	182	struct mei_cl_cb {
fb601adb	183	struct list_head list;
db3ed431	184	struct mei_cl *cl;
4b8960b4	185	enum mei_cb_file_ops fop_type;
ab841160 OW	186	struct mei_message_data request_buffer;
ab841160 OW	187	struct mei_message_data response_buffer;
ebb108ef	188	unsigned long buf_idx;
ab841160 OW	189	unsigned long read_time;
	190	struct file *file_object;
	191	};
	192
	193	/* MEI client instance carried as file->pirvate_data*/
	194	struct mei_cl {
	195	struct list_head link;
	196	struct mei_device *dev;
	197	enum file_state state;
	198	wait_queue_head_t tx_wait;
	199	wait_queue_head_t rx_wait;
	200	wait_queue_head_t wait;
ab841160 OW	201	int status;
	202	/* ID of client connected */
	203	u8 host_client_id;
	204	u8 me_client_id;
	205	u8 mei_flow_ctrl_creds;
	206	u8 timer_count;
	207	enum mei_file_transaction_states reading_state;
	208	enum mei_file_transaction_states writing_state;
	209	int sm_state;
	210	struct mei_cl_cb *read_cb;
	211	};
	212
827eef51 TW	213	/** struct mei_hw_ops
827eef51 TW	214	*
827eef51 TW	215	* @host_is_ready - query for host readiness
	216
	217	* @hw_is_ready - query if hw is ready
	218	* @hw_reset - reset hw
aafae7ec	219	* @hw_start - start hw after reset
827eef51 TW	220	* @hw_config - configure hw
	221
	222	* @intr_clear - clear pending interrupts
	223	* @intr_enable - enable interrupts
	224	* @intr_disable - disable interrupts
	225
	226	* @hbuf_free_slots - query for write buffer empty slots
	227	* @hbuf_is_ready - query if write buffer is empty
	228	* @hbuf_max_len - query for write buffer max len
	229
	230	* @write - write a message to FW
	231
	232	* @rdbuf_full_slots - query how many slots are filled
	233
	234	* @read_hdr - get first 4 bytes (header)
	235	* @read - read a buffer from the FW
	236	*/
	237	struct mei_hw_ops {
	238
827eef51 TW	239	bool (host_is_ready) (struct mei_device dev);
	240
	241	bool (hw_is_ready) (struct mei_device dev);
	242	void (hw_reset) (struct mei_device dev, bool enable);
aafae7ec	243	int (hw_start) (struct mei_device dev);
827eef51 TW	244	void (hw_config) (struct mei_device dev);
	245
	246	void (intr_clear) (struct mei_device dev);
	247	void (intr_enable) (struct mei_device dev);
	248	void (intr_disable) (struct mei_device dev);
	249
	250	int (hbuf_free_slots) (struct mei_device dev);
	251	bool (hbuf_is_ready) (struct mei_device dev);
	252	size_t (hbuf_max_len) (const struct mei_device dev);
	253
	254	int (write)(struct mei_device dev,
	255	struct mei_msg_hdr *hdr,
	256	unsigned char *buf);
	257
	258	int (rdbuf_full_slots)(struct mei_device dev);
	259
	260	u32 (read_hdr)(const struct mei_device dev);
	261	int (read) (struct mei_device dev,
	262	unsigned char *buf, unsigned long len);
	263	};
	264
24aadc80	265	/**
5fb54fb4	266	* struct mei_device - MEI private device struct
330dd7da	267
fecb0d58	268	* @mem_addr - mem mapped base register address
330dd7da TW	269
	270	* @hbuf_depth - depth of hardware host/write buffer is slots
	271	* @hbuf_is_ready - query if the host host/write buffer is ready
	272	* @wr_msg - the buffer for hbm control messages
	273	* @wr_ext_msg - the buffer for hbm control responses (set in read cycle)
24aadc80	274	*/
ab841160 OW	275	struct mei_device {
	276	struct pci_dev pdev; / pointer to pci device struct */
	277	/*
	278	* lists of queues
	279	*/
e773efc4	280	/* array of pointers to aio lists */
fb601adb TW	281	struct mei_cl_cb read_list; /* driver read queue */
	282	struct mei_cl_cb write_list; /* driver write queue */
	283	struct mei_cl_cb write_waiting_list; /* write waiting queue */
	284	struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */
	285	struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */
ab841160	286
ab841160 OW	287	/*
	288	* list of files
	289	*/
	290	struct list_head file_list;
eb9af0ac	291	long open_handle_count;
fecb0d58	292
ab841160 OW	293	/*
	294	* lock for the device
	295	*/
	296	struct mutex device_lock; /* device lock */
a61c6530	297	struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
aafae7ec TW	298
aafae7ec TW	299	bool recvd_hw_ready;
eb9af0ac	300	bool recvd_msg;
52c34561	301
ab841160 OW	302	/*
	303	* waiting queue for receive message from FW
	304	*/
aafae7ec	305	wait_queue_head_t wait_hw_ready;
ab841160 OW	306	wait_queue_head_t wait_recvd_msg;
	307	wait_queue_head_t wait_stop_wd;
	308
	309	/*
	310	* mei device states
	311	*/
b210d750	312	enum mei_dev_state dev_state;
ab841160 OW	313	enum mei_init_clients_states init_clients_state;
ab841160 OW	314	u16 init_clients_timer;
ab841160	315
edf1eed4	316	unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
ab841160	317	u32 rd_msg_hdr;
e46f1874	318
330dd7da TW	319	/* write buffer */
	320	u8 hbuf_depth;
	321	bool hbuf_is_ready;
	322
e46f1874 TW	323	/* used for control messages */
	324	struct {
	325	struct mei_msg_hdr hdr;
	326	unsigned char data[128];
	327	} wr_msg;
	328
5fb54fb4 TW	329	struct {
	330	struct mei_msg_hdr hdr;
	331	unsigned char data[4]; /* All HBM messages are 4 bytes */
	332	} wr_ext_msg; /* for control responses */
ab841160 OW	333
	334	struct hbm_version version;
	335
ab841160 OW	336	struct mei_me_client me_clients; / Note: memory has to be allocated */
	337	DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
	338	DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
cf9673da	339	u8 me_clients_num;
ab841160 OW	340	u8 me_client_presentation_num;
	341	u8 me_client_index;
	342
eb9af0ac	343	struct mei_cl wd_cl;
c216fdeb	344	enum mei_wd_states wd_state;
eb9af0ac	345	bool wd_pending;
c216fdeb	346	u16 wd_timeout;
248ffdf7	347	unsigned char wd_data[MEI_WD_START_MSG_SIZE];
ab841160 OW	348
ab841160 OW	349
e773efc4 TW	350	/* amthif list for cmd waiting */
	351	struct mei_cl_cb amthif_cmd_list;
	352	/* driver managed amthif list for reading completed amthif cmd data */
	353	struct mei_cl_cb amthif_rd_complete_list;
ab841160 OW	354	struct file *iamthif_file_object;
ab841160 OW	355	struct mei_cl iamthif_cl;
eb9af0ac	356	struct mei_cl_cb *iamthif_current_cb;
ab841160 OW	357	int iamthif_mtu;
	358	unsigned long iamthif_timer;
	359	u32 iamthif_stall_timer;
	360	unsigned char iamthif_msg_buf; / Note: memory has to be allocated */
	361	u32 iamthif_msg_buf_size;
	362	u32 iamthif_msg_buf_index;
ab841160	363	enum iamthif_states iamthif_state;
eb9af0ac TW	364	bool iamthif_flow_control_pending;
	365	bool iamthif_ioctl;
	366	bool iamthif_canceled;
c1174c0e SO	367
c1174c0e SO	368	struct work_struct init_work;
827eef51 TW	369
827eef51 TW	370	const struct mei_hw_ops *ops;
52c34561	371	char hw[0] __aligned(sizeof(void *));
ab841160 OW	372	};
ab841160 OW	373
3870c320 TW	374	static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
	375	{
	376	return msecs_to_jiffies(sec * MSEC_PER_SEC);
	377	}
	378
c8c8d080 TW	379	/**
	380	* mei_data2slots - get slots - number of (dwords) from a message length
	381	* + size of the mei header
	382	* @length - size of the messages in bytes
	383	* returns - number of slots
	384	*/
	385	static inline u32 mei_data2slots(size_t length)
	386	{
	387	return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
	388	}
	389
ab841160 OW	390
	391	/*
	392	* mei init function prototypes
	393	*/
52c34561	394	void mei_device_init(struct mei_device *dev);
ab841160	395	void mei_reset(struct mei_device *dev, int interrupts);
c4d589be	396	int mei_start(struct mei_device *dev);
7cb035d9	397	void mei_stop(struct mei_device *dev);
c95efb74	398
c95efb74 TW	399	/*
c95efb74 TW	400	* MEI interrupt functions prototype
ab841160	401	*/
06ecd645	402
a61c6530	403	void mei_timer(struct work_struct *work);
06ecd645 TW	404	int mei_irq_read_handler(struct mei_device *dev,
	405	struct mei_cl_cb cmpl_list, s32 slots);
	406
	407	int mei_irq_write_handler(struct mei_device dev, struct mei_cl_cb cmpl_list);
4c6e22b8	408	void mei_irq_compl_handler(struct mei_device dev, struct mei_cl_cb cmpl_list);
ab841160	409
19838fb8 TW	410	/*
	411	* AMTHIF - AMT Host Interface Functions
	412	*/
	413	void mei_amthif_reset_params(struct mei_device *dev);
	414
781d0d89	415	int mei_amthif_host_init(struct mei_device *dev);
19838fb8 TW	416
	417	int mei_amthif_write(struct mei_device dev, struct mei_cl_cb priv_cb);
	418
	419	int mei_amthif_read(struct mei_device dev, struct file file,
744f0f2f TW	420	char __user ubuf, size_t length, loff_t offset);
	421
	422	unsigned int mei_amthif_poll(struct mei_device *dev,
	423	struct file file, poll_table wait);
ab841160	424
a562d5c2 TW	425	int mei_amthif_release(struct mei_device dev, struct file file);
a562d5c2 TW	426
19838fb8	427	struct mei_cl_cb mei_amthif_find_read_list_entry(struct mei_device dev,
ab841160 OW	428	struct file *file);
ab841160 OW	429
19838fb8 TW	430	void mei_amthif_run_next_cmd(struct mei_device *dev);
	431
	432
24c656e5 TW	433	int mei_amthif_irq_write_complete(struct mei_device dev, s32 slots,
24c656e5 TW	434	struct mei_cl_cb cb, struct mei_cl_cb cmpl_list);
ab841160	435
19838fb8 TW	436	void mei_amthif_complete(struct mei_device dev, struct mei_cl_cb cb);
	437	int mei_amthif_irq_read_message(struct mei_cl_cb *complete_list,
	438	struct mei_device dev, struct mei_msg_hdr mei_hdr);
	439	int mei_amthif_irq_read(struct mei_device dev, s32 slots);
ab841160	440
37e7d6e7 TW	441
	442	int mei_wd_send(struct mei_device *dev);
	443	int mei_wd_stop(struct mei_device *dev);
	444	int mei_wd_host_init(struct mei_device *dev);
	445	/*
	446	* mei_watchdog_register - Registering watchdog interface
	447	* once we got connection to the WD Client
	448	* @dev - mei device
	449	*/
	450	void mei_watchdog_register(struct mei_device *dev);
	451	/*
	452	* mei_watchdog_unregister - Unregistering watchdog interface
	453	* @dev - mei device
	454	*/
	455	void mei_watchdog_unregister(struct mei_device *dev);
	456
ab841160 OW	457	/*
	458	* Register Access Function
	459	*/
	460
827eef51 TW	461	static inline void mei_hw_config(struct mei_device *dev)
	462	{
	463	dev->ops->hw_config(dev);
	464	}
	465	static inline void mei_hw_reset(struct mei_device *dev, bool enable)
	466	{
	467	dev->ops->hw_reset(dev, enable);
	468	}
	469
aafae7ec TW	470	static inline void mei_hw_start(struct mei_device *dev)
	471	{
	472	dev->ops->hw_start(dev);
	473	}
	474
827eef51 TW	475	static inline void mei_clear_interrupts(struct mei_device *dev)
	476	{
	477	dev->ops->intr_clear(dev);
	478	}
	479
	480	static inline void mei_enable_interrupts(struct mei_device *dev)
	481	{
	482	dev->ops->intr_enable(dev);
	483	}
ab841160	484
827eef51 TW	485	static inline void mei_disable_interrupts(struct mei_device *dev)
	486	{
	487	dev->ops->intr_disable(dev);
	488	}
ab841160	489
827eef51 TW	490	static inline bool mei_host_is_ready(struct mei_device *dev)
	491	{
	492	return dev->ops->host_is_ready(dev);
	493	}
	494	static inline bool mei_hw_is_ready(struct mei_device *dev)
	495	{
	496	return dev->ops->hw_is_ready(dev);
	497	}
e7e0c231	498
827eef51 TW	499	static inline bool mei_hbuf_is_ready(struct mei_device *dev)
	500	{
	501	return dev->ops->hbuf_is_ready(dev);
	502	}
ab841160	503
827eef51 TW	504	static inline int mei_hbuf_empty_slots(struct mei_device *dev)
	505	{
	506	return dev->ops->hbuf_free_slots(dev);
	507	}
115ba28c	508
827eef51 TW	509	static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
	510	{
	511	return dev->ops->hbuf_max_len(dev);
	512	}
3a65dd4e	513
827eef51 TW	514	static inline int mei_write_message(struct mei_device *dev,
	515	struct mei_msg_hdr *hdr,
	516	unsigned char *buf)
	517	{
	518	return dev->ops->write(dev, hdr, buf);
	519	}
	520
	521	static inline u32 mei_read_hdr(const struct mei_device *dev)
	522	{
	523	return dev->ops->read_hdr(dev);
	524	}
	525
	526	static inline void mei_read_slots(struct mei_device *dev,
	527	unsigned char *buf, unsigned long len)
	528	{
	529	dev->ops->read(dev, buf, len);
	530	}
	531
	532	static inline int mei_count_full_read_slots(struct mei_device *dev)
	533	{
	534	return dev->ops->rdbuf_full_slots(dev);
	535	}
5bd64714	536
2703d4b2 TW	537	int mei_register(struct device *dev);
	538	void mei_deregister(void);
	539
15d4acc5 TW	540	#define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d comp=%1d"
	541	#define MEI_HDR_PRM(hdr) \
	542	(hdr)->host_addr, (hdr)->me_addr, \
	543	(hdr)->length, (hdr)->msg_complete
	544
ab841160	545	#endif