532 lines
13 KiB
C
532 lines
13 KiB
C
/*
|
|
*
|
|
* Intel Management Engine Interface (Intel MEI) Linux driver
|
|
* Copyright (c) 2003-2012, Intel Corporation.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms and conditions of the GNU General Public License,
|
|
* version 2, as published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
|
* more details.
|
|
*
|
|
*/
|
|
|
|
#ifndef _MEI_DEV_H_
|
|
#define _MEI_DEV_H_
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/watchdog.h>
|
|
#include <linux/poll.h>
|
|
#include <linux/mei.h>
|
|
|
|
#include "hw.h"
|
|
#include "hw-me-regs.h"
|
|
|
|
/*
|
|
* watch dog definition
|
|
*/
|
|
#define MEI_WD_HDR_SIZE 4
|
|
#define MEI_WD_STOP_MSG_SIZE MEI_WD_HDR_SIZE
|
|
#define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)
|
|
|
|
#define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */
|
|
#define MEI_WD_MIN_TIMEOUT 120 /* seconds */
|
|
#define MEI_WD_MAX_TIMEOUT 65535 /* seconds */
|
|
|
|
#define MEI_WD_STOP_TIMEOUT 10 /* msecs */
|
|
|
|
#define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0)
|
|
|
|
#define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32))
|
|
|
|
|
|
/*
|
|
* AMTHI Client UUID
|
|
*/
|
|
extern const uuid_le mei_amthif_guid;
|
|
|
|
/*
|
|
* Watchdog Client UUID
|
|
*/
|
|
extern const uuid_le mei_wd_guid;
|
|
|
|
/*
|
|
* Watchdog independence state message
|
|
*/
|
|
extern const u8 mei_wd_state_independence_msg[3][4];
|
|
|
|
/*
|
|
* Number of Maximum MEI Clients
|
|
*/
|
|
#define MEI_CLIENTS_MAX 256
|
|
|
|
/*
|
|
* Number of File descriptors/handles
|
|
* that can be opened to the driver.
|
|
*
|
|
* Limit to 255: 256 Total Clients
|
|
* minus internal client for MEI Bus Messags
|
|
*/
|
|
#define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
|
|
|
|
/*
|
|
* Internal Clients Number
|
|
*/
|
|
#define MEI_HOST_CLIENT_ID_ANY (-1)
|
|
#define MEI_HBM_HOST_CLIENT_ID 0 /* not used, just for documentation */
|
|
#define MEI_WD_HOST_CLIENT_ID 1
|
|
#define MEI_IAMTHIF_HOST_CLIENT_ID 2
|
|
|
|
|
|
/* File state */
|
|
enum file_state {
|
|
MEI_FILE_INITIALIZING = 0,
|
|
MEI_FILE_CONNECTING,
|
|
MEI_FILE_CONNECTED,
|
|
MEI_FILE_DISCONNECTING,
|
|
MEI_FILE_DISCONNECTED
|
|
};
|
|
|
|
/* MEI device states */
|
|
enum mei_dev_state {
|
|
MEI_DEV_INITIALIZING = 0,
|
|
MEI_DEV_INIT_CLIENTS,
|
|
MEI_DEV_ENABLED,
|
|
MEI_DEV_RESETING,
|
|
MEI_DEV_DISABLED,
|
|
MEI_DEV_RECOVERING_FROM_RESET,
|
|
MEI_DEV_POWER_DOWN,
|
|
MEI_DEV_POWER_UP
|
|
};
|
|
|
|
const char *mei_dev_state_str(int state);
|
|
|
|
/* init clients states*/
|
|
enum mei_init_clients_states {
|
|
MEI_START_MESSAGE = 0,
|
|
MEI_ENUM_CLIENTS_MESSAGE,
|
|
MEI_CLIENT_PROPERTIES_MESSAGE
|
|
};
|
|
|
|
enum iamthif_states {
|
|
MEI_IAMTHIF_IDLE,
|
|
MEI_IAMTHIF_WRITING,
|
|
MEI_IAMTHIF_FLOW_CONTROL,
|
|
MEI_IAMTHIF_READING,
|
|
MEI_IAMTHIF_READ_COMPLETE
|
|
};
|
|
|
|
enum mei_file_transaction_states {
|
|
MEI_IDLE,
|
|
MEI_WRITING,
|
|
MEI_WRITE_COMPLETE,
|
|
MEI_FLOW_CONTROL,
|
|
MEI_READING,
|
|
MEI_READ_COMPLETE
|
|
};
|
|
|
|
enum mei_wd_states {
|
|
MEI_WD_IDLE,
|
|
MEI_WD_RUNNING,
|
|
MEI_WD_STOPPING,
|
|
};
|
|
|
|
/**
|
|
* enum mei_cb_file_ops - file operation associated with the callback
|
|
* @MEI_FOP_READ - read
|
|
* @MEI_FOP_WRITE - write
|
|
* @MEI_FOP_IOCTL - ioctl
|
|
* @MEI_FOP_OPEN - open
|
|
* @MEI_FOP_CLOSE - close
|
|
*/
|
|
enum mei_cb_file_ops {
|
|
MEI_FOP_READ = 0,
|
|
MEI_FOP_WRITE,
|
|
MEI_FOP_IOCTL,
|
|
MEI_FOP_OPEN,
|
|
MEI_FOP_CLOSE
|
|
};
|
|
|
|
/*
|
|
* Intel MEI message data struct
|
|
*/
|
|
struct mei_message_data {
|
|
u32 size;
|
|
unsigned char *data;
|
|
};
|
|
|
|
/**
|
|
* struct mei_me_client - representation of me (fw) client
|
|
*
|
|
* @props - client properties
|
|
* @client_id - me client id
|
|
* @mei_flow_ctrl_creds - flow control credits
|
|
*/
|
|
struct mei_me_client {
|
|
struct mei_client_properties props;
|
|
u8 client_id;
|
|
u8 mei_flow_ctrl_creds;
|
|
};
|
|
|
|
|
|
struct mei_cl;
|
|
|
|
/**
|
|
* struct mei_cl_cb - file operation callback structure
|
|
*
|
|
* @cl - file client who is running this operation
|
|
* @fop_type - file operation type
|
|
*/
|
|
struct mei_cl_cb {
|
|
struct list_head list;
|
|
struct mei_cl *cl;
|
|
enum mei_cb_file_ops fop_type;
|
|
struct mei_message_data request_buffer;
|
|
struct mei_message_data response_buffer;
|
|
unsigned long buf_idx;
|
|
unsigned long read_time;
|
|
struct file *file_object;
|
|
};
|
|
|
|
/* MEI client instance carried as file->pirvate_data*/
|
|
struct mei_cl {
|
|
struct list_head link;
|
|
struct mei_device *dev;
|
|
enum file_state state;
|
|
wait_queue_head_t tx_wait;
|
|
wait_queue_head_t rx_wait;
|
|
wait_queue_head_t wait;
|
|
int status;
|
|
/* ID of client connected */
|
|
u8 host_client_id;
|
|
u8 me_client_id;
|
|
u8 mei_flow_ctrl_creds;
|
|
u8 timer_count;
|
|
enum mei_file_transaction_states reading_state;
|
|
enum mei_file_transaction_states writing_state;
|
|
int sm_state;
|
|
struct mei_cl_cb *read_cb;
|
|
};
|
|
|
|
/** struct mei_hw_ops
|
|
*
|
|
* @host_set_ready - notify FW that host side is ready
|
|
* @host_is_ready - query for host readiness
|
|
|
|
* @hw_is_ready - query if hw is ready
|
|
* @hw_reset - reset hw
|
|
* @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 {
|
|
|
|
void (*host_set_ready) (struct mei_device *dev);
|
|
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);
|
|
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_msg;
|
|
|
|
/*
|
|
* waiting queue for receive message from FW
|
|
*/
|
|
wait_queue_head_t wait_recvd_msg;
|
|
wait_queue_head_t wait_stop_wd;
|
|
|
|
/*
|
|
* mei device states
|
|
*/
|
|
enum mei_dev_state dev_state;
|
|
enum mei_init_clients_states init_clients_state;
|
|
u16 init_clients_timer;
|
|
|
|
unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
|
|
u32 rd_msg_hdr;
|
|
|
|
/* 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 init function prototypes
|
|
*/
|
|
void mei_device_init(struct mei_device *dev);
|
|
void mei_reset(struct mei_device *dev, int interrupts);
|
|
int mei_hw_init(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_complete_handler(struct mei_cl *cl, struct mei_cl_cb *cb_pos);
|
|
|
|
/*
|
|
* 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_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 void mei_host_set_ready(struct mei_device *dev)
|
|
{
|
|
dev->ops->host_set_ready(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
|