3 * Intel Management Engine Interface (Intel MEI) Linux driver
4 * Copyright (c) 2003-2012, Intel Corporation.
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.
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
20 #include <linux/types.h>
21 #include <linux/watchdog.h>
22 #include <linux/poll.h>
23 #include <linux/mei.h>
26 #include "hw-me-regs.h"
29 * watch dog definition
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)
35 #define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */
36 #define MEI_WD_MIN_TIMEOUT 120 /* seconds */
37 #define MEI_WD_MAX_TIMEOUT 65535 /* seconds */
39 #define MEI_WD_STOP_TIMEOUT 10 /* msecs */
41 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0)
43 #define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32))
49 extern const uuid_le mei_amthi_guid;
52 * Watchdog Client UUID
54 extern const uuid_le mei_wd_guid;
57 * Watchdog independence state message
59 extern const u8 mei_wd_state_independence_msg[3][4];
62 * Number of Maximum MEI Clients
64 #define MEI_CLIENTS_MAX 256
67 * Number of File descriptors/handles
68 * that can be opened to the driver.
70 * Limit to 253: 256 Total Clients
71 * minus internal client for MEI Bus Messags
72 * minus internal client for AMTHI
73 * minus internal client for Watchdog
75 #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 3)
78 * Internal Clients Number
80 #define MEI_WD_HOST_CLIENT_ID 1
81 #define MEI_IAMTHIF_HOST_CLIENT_ID 2
86 MEI_FILE_INITIALIZING = 0,
89 MEI_FILE_DISCONNECTING,
93 /* MEI device states */
95 MEI_DEV_INITIALIZING = 0,
100 MEI_DEV_RECOVERING_FROM_RESET,
105 const char *mei_dev_state_str(int state);
107 /* init clients states*/
108 enum mei_init_clients_states {
109 MEI_START_MESSAGE = 0,
110 MEI_ENUM_CLIENTS_MESSAGE,
111 MEI_CLIENT_PROPERTIES_MESSAGE
114 enum iamthif_states {
117 MEI_IAMTHIF_FLOW_CONTROL,
119 MEI_IAMTHIF_READ_COMPLETE
122 enum mei_file_transaction_states {
138 * enum mei_cb_file_ops - file operation associated with the callback
139 * @MEI_FOP_READ - read
140 * @MEI_FOP_WRITE - write
141 * @MEI_FOP_IOCTL - ioctl
142 * @MEI_FOP_OPEN - open
143 * @MEI_FOP_CLOSE - close
145 enum mei_cb_file_ops {
154 * Intel MEI message data struct
156 struct mei_message_data {
162 * struct mei_me_client - representation of me (fw) client
164 * @props - client properties
165 * @client_id - me client id
166 * @mei_flow_ctrl_creds - flow control credits
168 struct mei_me_client {
169 struct mei_client_properties props;
171 u8 mei_flow_ctrl_creds;
178 * struct mei_cl_cb - file operation callback structure
180 * @cl - file client who is running this operation
181 * @fop_type - file operation type
184 struct list_head list;
186 enum mei_cb_file_ops fop_type;
187 struct mei_message_data request_buffer;
188 struct mei_message_data response_buffer;
189 unsigned long buf_idx;
190 unsigned long read_time;
191 struct file *file_object;
194 /* MEI client instance carried as file->pirvate_data*/
196 struct list_head link;
197 struct mei_device *dev;
198 enum file_state state;
199 wait_queue_head_t tx_wait;
200 wait_queue_head_t rx_wait;
201 wait_queue_head_t wait;
203 /* ID of client connected */
206 u8 mei_flow_ctrl_creds;
208 enum mei_file_transaction_states reading_state;
209 enum mei_file_transaction_states writing_state;
211 struct mei_cl_cb *read_cb;
215 * struct mei_device - MEI private device struct
216 * @mem_addr - mem mapped base register address
217 * @hbuf_depth - depth of host(write) buffer
218 * @wr_ext_msg - buffer for hbm control responses (set in read cycle)
221 struct pci_dev *pdev; /* pointer to pci device struct */
225 /* array of pointers to aio lists */
226 struct mei_cl_cb read_list; /* driver read queue */
227 struct mei_cl_cb write_list; /* driver write queue */
228 struct mei_cl_cb write_waiting_list; /* write waiting queue */
229 struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */
230 struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */
235 struct list_head file_list;
236 long open_handle_count;
238 void __iomem *mem_addr;
240 * lock for the device
242 struct mutex device_lock; /* device lock */
243 struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
246 * hw states of host and fw(ME)
252 * waiting queue for receive message from FW
254 wait_queue_head_t wait_recvd_msg;
255 wait_queue_head_t wait_stop_wd;
260 enum mei_dev_state dev_state;
261 enum mei_init_clients_states init_clients_state;
262 u16 init_clients_timer;
265 unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
268 /* used for control messages */
270 struct mei_msg_hdr hdr;
271 unsigned char data[128];
275 struct mei_msg_hdr hdr;
276 unsigned char data[4]; /* All HBM messages are 4 bytes */
277 } wr_ext_msg; /* for control responses */
279 struct hbm_version version;
281 struct mei_me_client *me_clients; /* Note: memory has to be allocated */
282 DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
283 DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
285 u8 me_client_presentation_num;
287 bool mei_host_buffer_is_empty;
290 enum mei_wd_states wd_state;
293 unsigned char wd_data[MEI_WD_START_MSG_SIZE];
296 /* amthif list for cmd waiting */
297 struct mei_cl_cb amthif_cmd_list;
298 /* driver managed amthif list for reading completed amthif cmd data */
299 struct mei_cl_cb amthif_rd_complete_list;
300 struct file *iamthif_file_object;
301 struct mei_cl iamthif_cl;
302 struct mei_cl_cb *iamthif_current_cb;
304 unsigned long iamthif_timer;
305 u32 iamthif_stall_timer;
306 unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
307 u32 iamthif_msg_buf_size;
308 u32 iamthif_msg_buf_index;
309 enum iamthif_states iamthif_state;
310 bool iamthif_flow_control_pending;
312 bool iamthif_canceled;
314 struct work_struct init_work;
317 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
319 return msecs_to_jiffies(sec * MSEC_PER_SEC);
324 * mei init function prototypes
326 struct mei_device *mei_device_init(struct pci_dev *pdev);
327 void mei_reset(struct mei_device *dev, int interrupts);
328 int mei_hw_init(struct mei_device *dev);
329 int mei_task_initialize_clients(void *data);
330 int mei_initialize_clients(struct mei_device *dev);
331 void mei_allocate_me_clients_storage(struct mei_device *dev);
336 * MEI interrupt functions prototype
338 irqreturn_t mei_interrupt_quick_handler(int irq, void *dev_id);
339 irqreturn_t mei_interrupt_thread_handler(int irq, void *dev_id);
340 void mei_timer(struct work_struct *work);
343 * AMTHIF - AMT Host Interface Functions
345 void mei_amthif_reset_params(struct mei_device *dev);
347 void mei_amthif_host_init(struct mei_device *dev);
349 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
351 int mei_amthif_read(struct mei_device *dev, struct file *file,
352 char __user *ubuf, size_t length, loff_t *offset);
354 unsigned int mei_amthif_poll(struct mei_device *dev,
355 struct file *file, poll_table *wait);
357 int mei_amthif_release(struct mei_device *dev, struct file *file);
359 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
362 void mei_amthif_run_next_cmd(struct mei_device *dev);
365 int mei_amthif_irq_write_complete(struct mei_device *dev, s32 *slots,
366 struct mei_cl_cb *cb, struct mei_cl_cb *cmpl_list);
368 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
369 int mei_amthif_irq_read_message(struct mei_cl_cb *complete_list,
370 struct mei_device *dev, struct mei_msg_hdr *mei_hdr);
371 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
374 int mei_wd_send(struct mei_device *dev);
375 int mei_wd_stop(struct mei_device *dev);
376 int mei_wd_host_init(struct mei_device *dev);
378 * mei_watchdog_register - Registering watchdog interface
379 * once we got connection to the WD Client
382 void mei_watchdog_register(struct mei_device *dev);
384 * mei_watchdog_unregister - Unregistering watchdog interface
387 void mei_watchdog_unregister(struct mei_device *dev);
391 * Register Access Function
394 u32 mei_hcsr_read(const struct mei_device *dev);
395 u32 mei_mecsr_read(const struct mei_device *dev);
396 u32 mei_mecbrw_read(const struct mei_device *dev);
398 void mei_hcsr_set(struct mei_device *dev);
399 void mei_csr_clear_his(struct mei_device *dev);
401 void mei_clear_interrupts(struct mei_device *dev);
402 void mei_enable_interrupts(struct mei_device *dev);
403 void mei_disable_interrupts(struct mei_device *dev);
407 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d comp=%1d"
408 #define MEI_HDR_PRM(hdr) \
409 (hdr)->host_addr, (hdr)->me_addr, \
410 (hdr)->length, (hdr)->msg_complete