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_amthif_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 255: 256 Total Clients
71 * minus internal client for MEI Bus Messags
73 #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
76 * Internal Clients Number
78 #define MEI_HOST_CLIENT_ID_ANY (-1)
79 #define MEI_HBM_HOST_CLIENT_ID 0 /* not used, just for documentation */
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;
214 /** struct mei_hw_ops
216 * @host_is_ready - query for host readiness
218 * @hw_is_ready - query if hw is ready
219 * @hw_reset - reset hw
220 * @hw_start - start hw after reset
221 * @hw_config - configure hw
223 * @intr_clear - clear pending interrupts
224 * @intr_enable - enable interrupts
225 * @intr_disable - disable interrupts
227 * @hbuf_free_slots - query for write buffer empty slots
228 * @hbuf_is_ready - query if write buffer is empty
229 * @hbuf_max_len - query for write buffer max len
231 * @write - write a message to FW
233 * @rdbuf_full_slots - query how many slots are filled
235 * @read_hdr - get first 4 bytes (header)
236 * @read - read a buffer from the FW
240 bool (*host_is_ready) (struct mei_device *dev);
242 bool (*hw_is_ready) (struct mei_device *dev);
243 void (*hw_reset) (struct mei_device *dev, bool enable);
244 int (*hw_start) (struct mei_device *dev);
245 void (*hw_config) (struct mei_device *dev);
247 void (*intr_clear) (struct mei_device *dev);
248 void (*intr_enable) (struct mei_device *dev);
249 void (*intr_disable) (struct mei_device *dev);
251 int (*hbuf_free_slots) (struct mei_device *dev);
252 bool (*hbuf_is_ready) (struct mei_device *dev);
253 size_t (*hbuf_max_len) (const struct mei_device *dev);
255 int (*write)(struct mei_device *dev,
256 struct mei_msg_hdr *hdr,
259 int (*rdbuf_full_slots)(struct mei_device *dev);
261 u32 (*read_hdr)(const struct mei_device *dev);
262 int (*read) (struct mei_device *dev,
263 unsigned char *buf, unsigned long len);
267 * struct mei_device - MEI private device struct
269 * @mem_addr - mem mapped base register address
271 * @hbuf_depth - depth of hardware host/write buffer is slots
272 * @hbuf_is_ready - query if the host host/write buffer is ready
273 * @wr_msg - the buffer for hbm control messages
274 * @wr_ext_msg - the buffer for hbm control responses (set in read cycle)
277 struct pci_dev *pdev; /* pointer to pci device struct */
281 /* array of pointers to aio lists */
282 struct mei_cl_cb read_list; /* driver read queue */
283 struct mei_cl_cb write_list; /* driver write queue */
284 struct mei_cl_cb write_waiting_list; /* write waiting queue */
285 struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */
286 struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */
291 struct list_head file_list;
292 long open_handle_count;
295 * lock for the device
297 struct mutex device_lock; /* device lock */
298 struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
304 * waiting queue for receive message from FW
306 wait_queue_head_t wait_hw_ready;
307 wait_queue_head_t wait_recvd_msg;
308 wait_queue_head_t wait_stop_wd;
313 enum mei_dev_state dev_state;
314 enum mei_init_clients_states init_clients_state;
315 u16 init_clients_timer;
317 unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
324 /* used for control messages */
326 struct mei_msg_hdr hdr;
327 unsigned char data[128];
331 struct mei_msg_hdr hdr;
332 unsigned char data[4]; /* All HBM messages are 4 bytes */
333 } wr_ext_msg; /* for control responses */
335 struct hbm_version version;
337 struct mei_me_client *me_clients; /* Note: memory has to be allocated */
338 DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
339 DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
341 u8 me_client_presentation_num;
345 enum mei_wd_states wd_state;
348 unsigned char wd_data[MEI_WD_START_MSG_SIZE];
351 /* amthif list for cmd waiting */
352 struct mei_cl_cb amthif_cmd_list;
353 /* driver managed amthif list for reading completed amthif cmd data */
354 struct mei_cl_cb amthif_rd_complete_list;
355 struct file *iamthif_file_object;
356 struct mei_cl iamthif_cl;
357 struct mei_cl_cb *iamthif_current_cb;
359 unsigned long iamthif_timer;
360 u32 iamthif_stall_timer;
361 unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
362 u32 iamthif_msg_buf_size;
363 u32 iamthif_msg_buf_index;
364 enum iamthif_states iamthif_state;
365 bool iamthif_flow_control_pending;
367 bool iamthif_canceled;
369 struct work_struct init_work;
371 const struct mei_hw_ops *ops;
372 char hw[0] __aligned(sizeof(void *));
375 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
377 return msecs_to_jiffies(sec * MSEC_PER_SEC);
381 * mei_data2slots - get slots - number of (dwords) from a message length
382 * + size of the mei header
383 * @length - size of the messages in bytes
384 * returns - number of slots
386 static inline u32 mei_data2slots(size_t length)
388 return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
393 * mei init function prototypes
395 void mei_device_init(struct mei_device *dev);
396 void mei_reset(struct mei_device *dev, int interrupts);
397 int mei_hw_init(struct mei_device *dev);
398 void mei_stop(struct mei_device *dev);
401 * MEI interrupt functions prototype
404 void mei_timer(struct work_struct *work);
405 int mei_irq_read_handler(struct mei_device *dev,
406 struct mei_cl_cb *cmpl_list, s32 *slots);
408 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
409 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
412 * AMTHIF - AMT Host Interface Functions
414 void mei_amthif_reset_params(struct mei_device *dev);
416 int mei_amthif_host_init(struct mei_device *dev);
418 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
420 int mei_amthif_read(struct mei_device *dev, struct file *file,
421 char __user *ubuf, size_t length, loff_t *offset);
423 unsigned int mei_amthif_poll(struct mei_device *dev,
424 struct file *file, poll_table *wait);
426 int mei_amthif_release(struct mei_device *dev, struct file *file);
428 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
431 void mei_amthif_run_next_cmd(struct mei_device *dev);
434 int mei_amthif_irq_write_complete(struct mei_device *dev, s32 *slots,
435 struct mei_cl_cb *cb, struct mei_cl_cb *cmpl_list);
437 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
438 int mei_amthif_irq_read_message(struct mei_cl_cb *complete_list,
439 struct mei_device *dev, struct mei_msg_hdr *mei_hdr);
440 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
443 int mei_wd_send(struct mei_device *dev);
444 int mei_wd_stop(struct mei_device *dev);
445 int mei_wd_host_init(struct mei_device *dev);
447 * mei_watchdog_register - Registering watchdog interface
448 * once we got connection to the WD Client
451 void mei_watchdog_register(struct mei_device *dev);
453 * mei_watchdog_unregister - Unregistering watchdog interface
456 void mei_watchdog_unregister(struct mei_device *dev);
459 * Register Access Function
462 static inline void mei_hw_config(struct mei_device *dev)
464 dev->ops->hw_config(dev);
466 static inline void mei_hw_reset(struct mei_device *dev, bool enable)
468 dev->ops->hw_reset(dev, enable);
471 static inline void mei_hw_start(struct mei_device *dev)
473 dev->ops->hw_start(dev);
476 static inline void mei_clear_interrupts(struct mei_device *dev)
478 dev->ops->intr_clear(dev);
481 static inline void mei_enable_interrupts(struct mei_device *dev)
483 dev->ops->intr_enable(dev);
486 static inline void mei_disable_interrupts(struct mei_device *dev)
488 dev->ops->intr_disable(dev);
491 static inline bool mei_host_is_ready(struct mei_device *dev)
493 return dev->ops->host_is_ready(dev);
495 static inline bool mei_hw_is_ready(struct mei_device *dev)
497 return dev->ops->hw_is_ready(dev);
500 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
502 return dev->ops->hbuf_is_ready(dev);
505 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
507 return dev->ops->hbuf_free_slots(dev);
510 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
512 return dev->ops->hbuf_max_len(dev);
515 static inline int mei_write_message(struct mei_device *dev,
516 struct mei_msg_hdr *hdr,
519 return dev->ops->write(dev, hdr, buf);
522 static inline u32 mei_read_hdr(const struct mei_device *dev)
524 return dev->ops->read_hdr(dev);
527 static inline void mei_read_slots(struct mei_device *dev,
528 unsigned char *buf, unsigned long len)
530 dev->ops->read(dev, buf, len);
533 static inline int mei_count_full_read_slots(struct mei_device *dev)
535 return dev->ops->rdbuf_full_slots(dev);
538 int mei_register(struct device *dev);
539 void mei_deregister(void);
541 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d comp=%1d"
542 #define MEI_HDR_PRM(hdr) \
543 (hdr)->host_addr, (hdr)->me_addr, \
544 (hdr)->length, (hdr)->msg_complete