[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 <linux/mei_cl_bus.h>

#include "hw.h"
#include "hw-me-regs.h"
#include "hbm.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;

/*
 * 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_RESETTING,
	MEI_DEV_DISABLED,
	MEI_DEV_POWER_DOWN,
	MEI_DEV_POWER_UP
};

const char *mei_dev_state_str(int state);

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_msg_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_msg_data request_buffer;
	struct mei_msg_data response_buffer;
	unsigned long buf_idx;
	unsigned long read_time;
	struct file *file_object;
	u32 internal:1;
};

/* 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;
	struct mei_cl_cb *read_cb;

	/* MEI CL bus data */
	struct mei_cl_device *device;
	struct list_head device_link;
	uuid_le device_uuid;
};

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

/* MEI bus API*/

/**
 * struct mei_cl_ops - MEI CL device ops
 * This structure allows ME host clients to implement technology
 * specific operations.
 *
 * @enable: Enable an MEI CL device. Some devices require specific
 *	HECI commands to initialize completely.
 * @disable: Disable an MEI CL device.
 * @send: Tx hook for the device. This allows ME host clients to trap
 *	the device driver buffers before actually physically
 *	pushing it to the ME.
 * @recv: Rx hook for the device. This allows ME host clients to trap the
 *	ME buffers before forwarding them to the device driver.
 */
struct mei_cl_ops {
	int (*enable)(struct mei_cl_device *device);
	int (*disable)(struct mei_cl_device *device);
	int (*send)(struct mei_cl_device *device, u8 *buf, size_t length);
	int (*recv)(struct mei_cl_device *device, u8 *buf, size_t length);
};

struct mei_cl_device *mei_cl_add_device(struct mei_device *dev,
					uuid_le uuid, char *name,
					struct mei_cl_ops *ops);
void mei_cl_remove_device(struct mei_cl_device *device);

int __mei_cl_async_send(struct mei_cl *cl, u8 *buf, size_t length);
int __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length);
int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length);
void mei_cl_bus_rx_event(struct mei_cl *cl);
int mei_cl_bus_init(void);
void mei_cl_bus_exit(void);


/**
 * struct mei_cl_device - MEI device handle
 * An mei_cl_device pointer is returned from mei_add_device()
 * and links MEI bus clients to their actual ME host client pointer.
 * Drivers for MEI devices will get an mei_cl_device pointer
 * when being probed and shall use it for doing ME bus I/O.
 *
 * @dev: linux driver model device pointer
 * @uuid: me client uuid
 * @cl: mei client
 * @ops: ME transport ops
 * @event_cb: Drivers register this callback to get asynchronous ME
 *	events (e.g. Rx buffer pending) notifications.
 * @events: Events bitmask sent to the driver.
 * @priv_data: client private data
 */
struct mei_cl_device {
	struct device dev;

	struct mei_cl *cl;

	const struct mei_cl_ops *ops;

	struct work_struct event_work;
	mei_cl_event_cb_t event_cb;
	void *event_context;
	unsigned long events;

	void *priv_data;
};

/**
 * struct mei_device -  MEI private device struct

 * @hbm_state - state of host bus message protocol
 * @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;
	/*
	 * 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_hbm_state hbm_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);
	unsigned long me_clients_num;
	unsigned long me_client_presentation_num;
	unsigned long 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;
	long iamthif_open_count;
	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;
	struct work_struct reset_work;

	/* List of bus devices */
	struct list_head device_list;

#if IS_ENABLED(CONFIG_DEBUG_FS)
	struct dentry *dbgfs_dir;
#endif /* CONFIG_DEBUG_FS */


	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_slots2data- get data in slots - bytes from slots
 * @slots -  number of available slots
 * returns  - number of bytes in slots
 */
static inline u32 mei_slots2data(int slots)
{
	return slots * 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);
void mei_cancel_work(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_cl *cl, struct mei_cl_cb *cb,
				  s32 *slots, struct mei_cl_cb *cmpl_list);

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

/*
 * NFC functions
 */
int mei_nfc_host_init(struct mei_device *dev);
void mei_nfc_host_exit(struct mei_device *dev);

/*
 * NFC Client UUID
 */
extern const uuid_le mei_nfc_guid;

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 int mei_hw_reset(struct mei_device *dev, bool enable)
{
	return dev->ops->hw_reset(dev, enable);
}

static inline int mei_hw_start(struct mei_device *dev)
{
	return 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);
}

#if IS_ENABLED(CONFIG_DEBUG_FS)
int mei_dbgfs_register(struct mei_device *dev, const char *name);
void mei_dbgfs_deregister(struct mei_device *dev);
#else
static inline int mei_dbgfs_register(struct mei_device *dev, const char *name)
{
	return 0;
}
static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
#endif /* CONFIG_DEBUG_FS */

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

#define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
#define MEI_HDR_PRM(hdr)                  \
	(hdr)->host_addr, (hdr)->me_addr, \
	(hdr)->length, (hdr)->internal, (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>
e5354107	24	#include <linux/mei_cl_bus.h>
66ef5ea9	25
ab841160	26	#include "hw.h"
9dc64d6a	27	#include "hw-me-regs.h"
9b0d5efc	28	#include "hbm.h"
ab841160	29
ab841160 OW	30	/*
	31	* watch dog definition
	32	*/
248ffdf7 TW	33	#define MEI_WD_HDR_SIZE 4
	34	#define MEI_WD_STOP_MSG_SIZE MEI_WD_HDR_SIZE
	35	#define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)
	36
	37	#define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */
	38	#define MEI_WD_MIN_TIMEOUT 120 /* seconds */
	39	#define MEI_WD_MAX_TIMEOUT 65535 /* seconds */
	40
c216fdeb TW	41	#define MEI_WD_STOP_TIMEOUT 10 /* msecs */
c216fdeb TW	42
ab841160 OW	43	#define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0)
ab841160 OW	44
edf1eed4 TW	45	#define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32))
edf1eed4 TW	46
9ce178e5	47
ab841160 OW	48	/*
	49	* AMTHI Client UUID
	50	*/
1a1aca42	51	extern const uuid_le mei_amthif_guid;
ab841160 OW	52
	53	/*
	54	* Watchdog Client UUID
	55	*/
	56	extern const uuid_le mei_wd_guid;
	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	*
781d0d89	67	* Limit to 255: 256 Total Clients
1e2776c3	68	* minus internal client for MEI Bus Messags
ab841160	69	*/
781d0d89	70	#define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
ab841160	71
1d3f3da3 TW	72	/*
	73	* Internal Clients Number
	74	*/
781d0d89 TW	75	#define MEI_HOST_CLIENT_ID_ANY (-1)
781d0d89 TW	76	#define MEI_HBM_HOST_CLIENT_ID 0 /* not used, just for documentation */
1d3f3da3 TW	77	#define MEI_WD_HOST_CLIENT_ID 1
	78	#define MEI_IAMTHIF_HOST_CLIENT_ID 2
	79
ab841160 OW	80
	81	/* File state */
	82	enum file_state {
	83	MEI_FILE_INITIALIZING = 0,
	84	MEI_FILE_CONNECTING,
	85	MEI_FILE_CONNECTED,
	86	MEI_FILE_DISCONNECTING,
	87	MEI_FILE_DISCONNECTED
	88	};
	89
	90	/* MEI device states */
b210d750 TW	91	enum mei_dev_state {
	92	MEI_DEV_INITIALIZING = 0,
	93	MEI_DEV_INIT_CLIENTS,
	94	MEI_DEV_ENABLED,
0cfee51c	95	MEI_DEV_RESETTING,
b210d750	96	MEI_DEV_DISABLED,
b210d750 TW	97	MEI_DEV_POWER_DOWN,
b210d750 TW	98	MEI_DEV_POWER_UP
ab841160 OW	99	};
ab841160 OW	100
b210d750 TW	101	const char *mei_dev_state_str(int state);
b210d750 TW	102
ab841160 OW	103	enum iamthif_states {
	104	MEI_IAMTHIF_IDLE,
	105	MEI_IAMTHIF_WRITING,
	106	MEI_IAMTHIF_FLOW_CONTROL,
	107	MEI_IAMTHIF_READING,
	108	MEI_IAMTHIF_READ_COMPLETE
	109	};
	110
	111	enum mei_file_transaction_states {
	112	MEI_IDLE,
	113	MEI_WRITING,
	114	MEI_WRITE_COMPLETE,
	115	MEI_FLOW_CONTROL,
	116	MEI_READING,
	117	MEI_READ_COMPLETE
	118	};
	119
c216fdeb TW	120	enum mei_wd_states {
	121	MEI_WD_IDLE,
	122	MEI_WD_RUNNING,
	123	MEI_WD_STOPPING,
	124	};
	125
4b8960b4 TW	126	/**
	127	* enum mei_cb_file_ops - file operation associated with the callback
	128	* @MEI_FOP_READ - read
	129	* @MEI_FOP_WRITE - write
	130	* @MEI_FOP_IOCTL - ioctl
	131	* @MEI_FOP_OPEN - open
	132	* @MEI_FOP_CLOSE - close
	133	*/
	134	enum mei_cb_file_ops {
	135	MEI_FOP_READ = 0,
	136	MEI_FOP_WRITE,
	137	MEI_FOP_IOCTL,
	138	MEI_FOP_OPEN,
	139	MEI_FOP_CLOSE
ab841160 OW	140	};
	141
	142	/*
	143	* Intel MEI message data struct
	144	*/
4234a6de	145	struct mei_msg_data {
ab841160	146	u32 size;
edf1eed4	147	unsigned char *data;
f060939d	148	};
ab841160	149
db7da79d TW	150	/**
	151	* struct mei_me_client - representation of me (fw) client
	152	*
	153	* @props - client properties
	154	* @client_id - me client id
	155	* @mei_flow_ctrl_creds - flow control credits
	156	*/
	157	struct mei_me_client {
	158	struct mei_client_properties props;
	159	u8 client_id;
	160	u8 mei_flow_ctrl_creds;
	161	};
	162
ab841160	163
db3ed431 TW	164	struct mei_cl;
db3ed431 TW	165
4b8960b4	166	/**
db3ed431 TW	167	* struct mei_cl_cb - file operation callback structure
	168	*
	169	* @cl - file client who is running this operation
4b8960b4	170	* @fop_type - file operation type
db3ed431	171	*/
ab841160	172	struct mei_cl_cb {
fb601adb	173	struct list_head list;
db3ed431	174	struct mei_cl *cl;
4b8960b4	175	enum mei_cb_file_ops fop_type;
4234a6de TW	176	struct mei_msg_data request_buffer;
4234a6de TW	177	struct mei_msg_data response_buffer;
ebb108ef	178	unsigned long buf_idx;
ab841160 OW	179	unsigned long read_time;
ab841160 OW	180	struct file *file_object;
479327fc	181	u32 internal:1;
ab841160 OW	182	};
	183
	184	/* MEI client instance carried as file->pirvate_data*/
	185	struct mei_cl {
	186	struct list_head link;
	187	struct mei_device *dev;
	188	enum file_state state;
	189	wait_queue_head_t tx_wait;
	190	wait_queue_head_t rx_wait;
	191	wait_queue_head_t wait;
ab841160 OW	192	int status;
	193	/* ID of client connected */
	194	u8 host_client_id;
	195	u8 me_client_id;
	196	u8 mei_flow_ctrl_creds;
	197	u8 timer_count;
	198	enum mei_file_transaction_states reading_state;
	199	enum mei_file_transaction_states writing_state;
ab841160	200	struct mei_cl_cb *read_cb;
a7b71bc0 SO	201
	202	/* MEI CL bus data */
	203	struct mei_cl_device *device;
	204	struct list_head device_link;
	205	uuid_le device_uuid;
ab841160 OW	206	};
ab841160 OW	207
827eef51 TW	208	/** struct mei_hw_ops
827eef51 TW	209	*
827eef51 TW	210	* @host_is_ready - query for host readiness
	211
	212	* @hw_is_ready - query if hw is ready
	213	* @hw_reset - reset hw
aafae7ec	214	* @hw_start - start hw after reset
827eef51 TW	215	* @hw_config - configure hw
	216
	217	* @intr_clear - clear pending interrupts
	218	* @intr_enable - enable interrupts
	219	* @intr_disable - disable interrupts
	220
	221	* @hbuf_free_slots - query for write buffer empty slots
	222	* @hbuf_is_ready - query if write buffer is empty
	223	* @hbuf_max_len - query for write buffer max len
	224
	225	* @write - write a message to FW
	226
	227	* @rdbuf_full_slots - query how many slots are filled
	228
	229	* @read_hdr - get first 4 bytes (header)
	230	* @read - read a buffer from the FW
	231	*/
	232	struct mei_hw_ops {
	233
827eef51 TW	234	bool (host_is_ready) (struct mei_device dev);
	235
	236	bool (hw_is_ready) (struct mei_device dev);
c20c68d5	237	int (hw_reset) (struct mei_device dev, bool enable);
aafae7ec	238	int (hw_start) (struct mei_device dev);
827eef51 TW	239	void (hw_config) (struct mei_device dev);
	240
	241	void (intr_clear) (struct mei_device dev);
	242	void (intr_enable) (struct mei_device dev);
	243	void (intr_disable) (struct mei_device dev);
	244
	245	int (hbuf_free_slots) (struct mei_device dev);
	246	bool (hbuf_is_ready) (struct mei_device dev);
	247	size_t (hbuf_max_len) (const struct mei_device dev);
	248
	249	int (write)(struct mei_device dev,
	250	struct mei_msg_hdr *hdr,
	251	unsigned char *buf);
	252
	253	int (rdbuf_full_slots)(struct mei_device dev);
	254
	255	u32 (read_hdr)(const struct mei_device dev);
	256	int (read) (struct mei_device dev,
	257	unsigned char *buf, unsigned long len);
	258	};
	259
e5354107	260	/* MEI bus API*/
3e833295 SO	261
3e833295 SO	262	/**
e46980a1	263	* struct mei_cl_ops - MEI CL device ops
3e833295	264	* This structure allows ME host clients to implement technology
e46980a1	265	* specific operations.
3e833295	266	*
e46980a1 SO	267	* @enable: Enable an MEI CL device. Some devices require specific
	268	* HECI commands to initialize completely.
	269	* @disable: Disable an MEI CL device.
3e833295 SO	270	* @send: Tx hook for the device. This allows ME host clients to trap
	271	* the device driver buffers before actually physically
	272	* pushing it to the ME.
	273	* @recv: Rx hook for the device. This allows ME host clients to trap the
	274	* ME buffers before forwarding them to the device driver.
	275	*/
e46980a1 SO	276	struct mei_cl_ops {
	277	int (enable)(struct mei_cl_device device);
	278	int (disable)(struct mei_cl_device device);
3e833295 SO	279	int (send)(struct mei_cl_device device, u8 *buf, size_t length);
	280	int (recv)(struct mei_cl_device device, u8 *buf, size_t length);
	281	};
	282
e46980a1 SO	283	struct mei_cl_device mei_cl_add_device(struct mei_device dev,
	284	uuid_le uuid, char *name,
	285	struct mei_cl_ops *ops);
	286	void mei_cl_remove_device(struct mei_cl_device *device);
	287
	288	int __mei_cl_async_send(struct mei_cl cl, u8 buf, size_t length);
	289	int __mei_cl_send(struct mei_cl cl, u8 buf, size_t length);
	290	int __mei_cl_recv(struct mei_cl cl, u8 buf, size_t length);
cf3baefb SO	291	void mei_cl_bus_rx_event(struct mei_cl *cl);
	292	int mei_cl_bus_init(void);
	293	void mei_cl_bus_exit(void);
	294
	295
e5354107 SO	296	/**
	297	* struct mei_cl_device - MEI device handle
	298	* An mei_cl_device pointer is returned from mei_add_device()
	299	* and links MEI bus clients to their actual ME host client pointer.
	300	* Drivers for MEI devices will get an mei_cl_device pointer
	301	* when being probed and shall use it for doing ME bus I/O.
	302	*
	303	* @dev: linux driver model device pointer
	304	* @uuid: me client uuid
	305	* @cl: mei client
3e833295 SO	306	* @ops: ME transport ops
	307	* @event_cb: Drivers register this callback to get asynchronous ME
	308	* events (e.g. Rx buffer pending) notifications.
	309	* @events: Events bitmask sent to the driver.
e5354107 SO	310	* @priv_data: client private data
	311	*/
	312	struct mei_cl_device {
	313	struct device dev;
	314
	315	struct mei_cl *cl;
	316
e46980a1	317	const struct mei_cl_ops *ops;
3e833295 SO	318
	319	struct work_struct event_work;
	320	mei_cl_event_cb_t event_cb;
	321	void *event_context;
	322	unsigned long events;
	323
e5354107 SO	324	void *priv_data;
	325	};
	326
24aadc80	327	/**
5fb54fb4	328	* struct mei_device - MEI private device struct
330dd7da	329
9b0d5efc	330	* @hbm_state - state of host bus message protocol
fecb0d58	331	* @mem_addr - mem mapped base register address
330dd7da TW	332
	333	* @hbuf_depth - depth of hardware host/write buffer is slots
	334	* @hbuf_is_ready - query if the host host/write buffer is ready
	335	* @wr_msg - the buffer for hbm control messages
	336	* @wr_ext_msg - the buffer for hbm control responses (set in read cycle)
24aadc80	337	*/
ab841160 OW	338	struct mei_device {
	339	struct pci_dev pdev; / pointer to pci device struct */
	340	/*
	341	* lists of queues
	342	*/
e773efc4	343	/* array of pointers to aio lists */
fb601adb TW	344	struct mei_cl_cb read_list; /* driver read queue */
	345	struct mei_cl_cb write_list; /* driver write queue */
	346	struct mei_cl_cb write_waiting_list; /* write waiting queue */
	347	struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */
	348	struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */
ab841160	349
ab841160 OW	350	/*
	351	* list of files
	352	*/
	353	struct list_head file_list;
eb9af0ac	354	long open_handle_count;
fecb0d58	355
ab841160 OW	356	/*
	357	* lock for the device
	358	*/
	359	struct mutex device_lock; /* device lock */
a61c6530	360	struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
aafae7ec TW	361
aafae7ec TW	362	bool recvd_hw_ready;
ab841160 OW	363	/*
	364	* waiting queue for receive message from FW
	365	*/
aafae7ec	366	wait_queue_head_t wait_hw_ready;
ab841160 OW	367	wait_queue_head_t wait_recvd_msg;
	368	wait_queue_head_t wait_stop_wd;
	369
	370	/*
	371	* mei device states
	372	*/
b210d750	373	enum mei_dev_state dev_state;
9b0d5efc	374	enum mei_hbm_state hbm_state;
ab841160	375	u16 init_clients_timer;
ab841160	376
edf1eed4	377	unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
ab841160	378	u32 rd_msg_hdr;
e46f1874	379
330dd7da TW	380	/* write buffer */
	381	u8 hbuf_depth;
	382	bool hbuf_is_ready;
	383
e46f1874 TW	384	/* used for control messages */
	385	struct {
	386	struct mei_msg_hdr hdr;
	387	unsigned char data[128];
	388	} wr_msg;
	389
5fb54fb4 TW	390	struct {
	391	struct mei_msg_hdr hdr;
	392	unsigned char data[4]; /* All HBM messages are 4 bytes */
	393	} wr_ext_msg; /* for control responses */
ab841160 OW	394
	395	struct hbm_version version;
	396
ab841160 OW	397	struct mei_me_client me_clients; / Note: memory has to be allocated */
	398	DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
	399	DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
1aee351a TW	400	unsigned long me_clients_num;
	401	unsigned long me_client_presentation_num;
	402	unsigned long me_client_index;
ab841160	403
eb9af0ac	404	struct mei_cl wd_cl;
c216fdeb	405	enum mei_wd_states wd_state;
eb9af0ac	406	bool wd_pending;
c216fdeb	407	u16 wd_timeout;
248ffdf7	408	unsigned char wd_data[MEI_WD_START_MSG_SIZE];
ab841160 OW	409
ab841160 OW	410
e773efc4 TW	411	/* amthif list for cmd waiting */
	412	struct mei_cl_cb amthif_cmd_list;
	413	/* driver managed amthif list for reading completed amthif cmd data */
	414	struct mei_cl_cb amthif_rd_complete_list;
ab841160 OW	415	struct file *iamthif_file_object;
ab841160 OW	416	struct mei_cl iamthif_cl;
eb9af0ac	417	struct mei_cl_cb *iamthif_current_cb;
22f96a0e	418	long iamthif_open_count;
ab841160 OW	419	int iamthif_mtu;
	420	unsigned long iamthif_timer;
	421	u32 iamthif_stall_timer;
	422	unsigned char iamthif_msg_buf; / Note: memory has to be allocated */
	423	u32 iamthif_msg_buf_size;
	424	u32 iamthif_msg_buf_index;
ab841160	425	enum iamthif_states iamthif_state;
eb9af0ac TW	426	bool iamthif_flow_control_pending;
	427	bool iamthif_ioctl;
	428	bool iamthif_canceled;
c1174c0e SO	429
c1174c0e SO	430	struct work_struct init_work;
544f9460	431	struct work_struct reset_work;
827eef51	432
a7b71bc0 SO	433	/* List of bus devices */
	434	struct list_head device_list;
	435
30e53bb8 TW	436	#if IS_ENABLED(CONFIG_DEBUG_FS)
	437	struct dentry *dbgfs_dir;
	438	#endif /* CONFIG_DEBUG_FS */
	439
	440
827eef51	441	const struct mei_hw_ops *ops;
52c34561	442	char hw[0] __aligned(sizeof(void *));
ab841160 OW	443	};
ab841160 OW	444
3870c320 TW	445	static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
	446	{
	447	return msecs_to_jiffies(sec * MSEC_PER_SEC);
	448	}
	449
c8c8d080 TW	450	/**
	451	* mei_data2slots - get slots - number of (dwords) from a message length
	452	* + size of the mei header
	453	* @length - size of the messages in bytes
	454	* returns - number of slots
	455	*/
	456	static inline u32 mei_data2slots(size_t length)
	457	{
	458	return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
	459	}
	460
10ee9074 TW	461	/**
	462	* mei_slots2data- get data in slots - bytes from slots
	463	* @slots - number of available slots
	464	* returns - number of bytes in slots
	465	*/
	466	static inline u32 mei_slots2data(int slots)
	467	{
	468	return slots * 4;
	469	}
	470
ab841160 OW	471	/*
	472	* mei init function prototypes
	473	*/
52c34561	474	void mei_device_init(struct mei_device *dev);
ab841160	475	void mei_reset(struct mei_device *dev, int interrupts);
c4d589be	476	int mei_start(struct mei_device *dev);
7cb035d9	477	void mei_stop(struct mei_device *dev);
dc844b0d	478	void mei_cancel_work(struct mei_device *dev);
c95efb74	479
c95efb74 TW	480	/*
c95efb74 TW	481	* MEI interrupt functions prototype
ab841160	482	*/
06ecd645	483
a61c6530	484	void mei_timer(struct work_struct *work);
06ecd645 TW	485	int mei_irq_read_handler(struct mei_device *dev,
	486	struct mei_cl_cb cmpl_list, s32 slots);
	487
	488	int mei_irq_write_handler(struct mei_device dev, struct mei_cl_cb cmpl_list);
4c6e22b8	489	void mei_irq_compl_handler(struct mei_device dev, struct mei_cl_cb cmpl_list);
ab841160	490
19838fb8 TW	491	/*
	492	* AMTHIF - AMT Host Interface Functions
	493	*/
	494	void mei_amthif_reset_params(struct mei_device *dev);
	495
781d0d89	496	int mei_amthif_host_init(struct mei_device *dev);
19838fb8 TW	497
	498	int mei_amthif_write(struct mei_device dev, struct mei_cl_cb priv_cb);
	499
	500	int mei_amthif_read(struct mei_device dev, struct file file,
744f0f2f TW	501	char __user ubuf, size_t length, loff_t offset);
	502
	503	unsigned int mei_amthif_poll(struct mei_device *dev,
	504	struct file file, poll_table wait);
ab841160	505
a562d5c2 TW	506	int mei_amthif_release(struct mei_device dev, struct file file);
a562d5c2 TW	507
19838fb8	508	struct mei_cl_cb mei_amthif_find_read_list_entry(struct mei_device dev,
ab841160 OW	509	struct file *file);
ab841160 OW	510
19838fb8 TW	511	void mei_amthif_run_next_cmd(struct mei_device *dev);
19838fb8 TW	512
6220d6a0 TW	513	int mei_amthif_irq_write_complete(struct mei_cl cl, struct mei_cl_cb cb,
6220d6a0 TW	514	s32 slots, struct mei_cl_cb cmpl_list);
5ceb46e2 TW	515
	516	void mei_amthif_complete(struct mei_device dev, struct mei_cl_cb cb);
	517	int mei_amthif_irq_read_msg(struct mei_device *dev,
	518	struct mei_msg_hdr *mei_hdr,
	519	struct mei_cl_cb *complete_list);
	520	int mei_amthif_irq_read(struct mei_device dev, s32 slots);
	521
59fcd7c6 SO	522	/*
	523	* NFC functions
	524	*/
	525	int mei_nfc_host_init(struct mei_device *dev);
dc844b0d	526	void mei_nfc_host_exit(struct mei_device *dev);
59fcd7c6 SO	527
	528	/*
	529	* NFC Client UUID
	530	*/
	531	extern const uuid_le mei_nfc_guid;
19838fb8	532
37e7d6e7 TW	533	int mei_wd_send(struct mei_device *dev);
	534	int mei_wd_stop(struct mei_device *dev);
	535	int mei_wd_host_init(struct mei_device *dev);
	536	/*
	537	* mei_watchdog_register - Registering watchdog interface
	538	* once we got connection to the WD Client
	539	* @dev - mei device
	540	*/
	541	void mei_watchdog_register(struct mei_device *dev);
	542	/*
	543	* mei_watchdog_unregister - Unregistering watchdog interface
	544	* @dev - mei device
	545	*/
	546	void mei_watchdog_unregister(struct mei_device *dev);
	547
ab841160 OW	548	/*
	549	* Register Access Function
	550	*/
	551
827eef51 TW	552	static inline void mei_hw_config(struct mei_device *dev)
	553	{
	554	dev->ops->hw_config(dev);
	555	}
c20c68d5	556	static inline int mei_hw_reset(struct mei_device *dev, bool enable)
827eef51	557	{
c20c68d5	558	return dev->ops->hw_reset(dev, enable);
827eef51 TW	559	}
827eef51 TW	560
9049f793	561	static inline int mei_hw_start(struct mei_device *dev)
aafae7ec	562	{
9049f793	563	return dev->ops->hw_start(dev);
aafae7ec TW	564	}
aafae7ec TW	565
827eef51 TW	566	static inline void mei_clear_interrupts(struct mei_device *dev)
	567	{
	568	dev->ops->intr_clear(dev);
	569	}
	570
	571	static inline void mei_enable_interrupts(struct mei_device *dev)
	572	{
	573	dev->ops->intr_enable(dev);
	574	}
ab841160	575
827eef51 TW	576	static inline void mei_disable_interrupts(struct mei_device *dev)
	577	{
	578	dev->ops->intr_disable(dev);
	579	}
ab841160	580
827eef51 TW	581	static inline bool mei_host_is_ready(struct mei_device *dev)
	582	{
	583	return dev->ops->host_is_ready(dev);
	584	}
	585	static inline bool mei_hw_is_ready(struct mei_device *dev)
	586	{
	587	return dev->ops->hw_is_ready(dev);
	588	}
e7e0c231	589
827eef51 TW	590	static inline bool mei_hbuf_is_ready(struct mei_device *dev)
	591	{
	592	return dev->ops->hbuf_is_ready(dev);
	593	}
ab841160	594
827eef51 TW	595	static inline int mei_hbuf_empty_slots(struct mei_device *dev)
	596	{
	597	return dev->ops->hbuf_free_slots(dev);
	598	}
115ba28c	599
827eef51 TW	600	static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
	601	{
	602	return dev->ops->hbuf_max_len(dev);
	603	}
3a65dd4e	604
827eef51 TW	605	static inline int mei_write_message(struct mei_device *dev,
	606	struct mei_msg_hdr *hdr,
	607	unsigned char *buf)
	608	{
	609	return dev->ops->write(dev, hdr, buf);
	610	}
	611
	612	static inline u32 mei_read_hdr(const struct mei_device *dev)
	613	{
	614	return dev->ops->read_hdr(dev);
	615	}
	616
	617	static inline void mei_read_slots(struct mei_device *dev,
	618	unsigned char *buf, unsigned long len)
	619	{
	620	dev->ops->read(dev, buf, len);
	621	}
	622
	623	static inline int mei_count_full_read_slots(struct mei_device *dev)
	624	{
	625	return dev->ops->rdbuf_full_slots(dev);
	626	}
5bd64714	627
30e53bb8 TW	628	#if IS_ENABLED(CONFIG_DEBUG_FS)
	629	int mei_dbgfs_register(struct mei_device dev, const char name);
	630	void mei_dbgfs_deregister(struct mei_device *dev);
	631	#else
	632	static inline int mei_dbgfs_register(struct mei_device dev, const char name)
	633	{
	634	return 0;
	635	}
	636	static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
	637	#endif /* CONFIG_DEBUG_FS */
	638
	639	int mei_register(struct mei_device *dev);
	640	void mei_deregister(struct mei_device *dev);
2703d4b2	641
479327fc	642	#define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
15d4acc5 TW	643	#define MEI_HDR_PRM(hdr) \
15d4acc5 TW	644	(hdr)->host_addr, (hdr)->me_addr, \
479327fc	645	(hdr)->length, (hdr)->internal, (hdr)->msg_complete
15d4acc5	646
ab841160	647	#endif