[deliverable/linux.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;

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

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

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

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

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

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

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

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

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