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>
24 #include <linux/mei_cl_bus.h>
27 #include "hw-me-regs.h"
31 * watch dog definition
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)
37 #define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */
38 #define MEI_WD_MIN_TIMEOUT 120 /* seconds */
39 #define MEI_WD_MAX_TIMEOUT 65535 /* seconds */
41 #define MEI_WD_STOP_TIMEOUT 10 /* msecs */
43 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0)
45 #define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32))
51 extern const uuid_le mei_amthif_guid;
54 * Watchdog Client UUID
56 extern const uuid_le mei_wd_guid;
59 * Number of Maximum MEI Clients
61 #define MEI_CLIENTS_MAX 256
64 * Number of File descriptors/handles
65 * that can be opened to the driver.
67 * Limit to 255: 256 Total Clients
68 * minus internal client for MEI Bus Messags
70 #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
73 * Internal Clients Number
75 #define MEI_HOST_CLIENT_ID_ANY (-1)
76 #define MEI_HBM_HOST_CLIENT_ID 0 /* not used, just for documentation */
77 #define MEI_WD_HOST_CLIENT_ID 1
78 #define MEI_IAMTHIF_HOST_CLIENT_ID 2
83 MEI_FILE_INITIALIZING = 0,
86 MEI_FILE_DISCONNECTING,
90 /* MEI device states */
92 MEI_DEV_INITIALIZING = 0,
101 const char *mei_dev_state_str(int state);
103 enum iamthif_states {
106 MEI_IAMTHIF_FLOW_CONTROL,
108 MEI_IAMTHIF_READ_COMPLETE
111 enum mei_file_transaction_states {
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
134 enum mei_cb_file_ops {
143 * Intel MEI message data struct
145 struct mei_msg_data {
151 * struct mei_me_client - representation of me (fw) client
153 * @props - client properties
154 * @client_id - me client id
155 * @mei_flow_ctrl_creds - flow control credits
157 struct mei_me_client {
158 struct mei_client_properties props;
160 u8 mei_flow_ctrl_creds;
167 * struct mei_cl_cb - file operation callback structure
169 * @cl - file client who is running this operation
170 * @fop_type - file operation type
173 struct list_head list;
175 enum mei_cb_file_ops fop_type;
176 struct mei_msg_data request_buffer;
177 struct mei_msg_data response_buffer;
178 unsigned long buf_idx;
179 unsigned long read_time;
180 struct file *file_object;
183 /* MEI client instance carried as file->pirvate_data*/
185 struct list_head link;
186 struct mei_device *dev;
187 enum file_state state;
188 wait_queue_head_t tx_wait;
189 wait_queue_head_t rx_wait;
190 wait_queue_head_t wait;
192 /* ID of client connected */
195 u8 mei_flow_ctrl_creds;
197 enum mei_file_transaction_states reading_state;
198 enum mei_file_transaction_states writing_state;
199 struct mei_cl_cb *read_cb;
201 /* MEI CL bus data */
202 struct mei_cl_device *device;
203 struct list_head device_link;
207 /** struct mei_hw_ops
209 * @host_is_ready - query for host readiness
211 * @hw_is_ready - query if hw is ready
212 * @hw_reset - reset hw
213 * @hw_start - start hw after reset
214 * @hw_config - configure hw
216 * @intr_clear - clear pending interrupts
217 * @intr_enable - enable interrupts
218 * @intr_disable - disable interrupts
220 * @hbuf_free_slots - query for write buffer empty slots
221 * @hbuf_is_ready - query if write buffer is empty
222 * @hbuf_max_len - query for write buffer max len
224 * @write - write a message to FW
226 * @rdbuf_full_slots - query how many slots are filled
228 * @read_hdr - get first 4 bytes (header)
229 * @read - read a buffer from the FW
233 bool (*host_is_ready) (struct mei_device *dev);
235 bool (*hw_is_ready) (struct mei_device *dev);
236 int (*hw_reset) (struct mei_device *dev, bool enable);
237 int (*hw_start) (struct mei_device *dev);
238 void (*hw_config) (struct mei_device *dev);
240 void (*intr_clear) (struct mei_device *dev);
241 void (*intr_enable) (struct mei_device *dev);
242 void (*intr_disable) (struct mei_device *dev);
244 int (*hbuf_free_slots) (struct mei_device *dev);
245 bool (*hbuf_is_ready) (struct mei_device *dev);
246 size_t (*hbuf_max_len) (const struct mei_device *dev);
248 int (*write)(struct mei_device *dev,
249 struct mei_msg_hdr *hdr,
252 int (*rdbuf_full_slots)(struct mei_device *dev);
254 u32 (*read_hdr)(const struct mei_device *dev);
255 int (*read) (struct mei_device *dev,
256 unsigned char *buf, unsigned long len);
262 * struct mei_cl_ops - MEI CL device ops
263 * This structure allows ME host clients to implement technology
264 * specific operations.
266 * @enable: Enable an MEI CL device. Some devices require specific
267 * HECI commands to initialize completely.
268 * @disable: Disable an MEI CL device.
269 * @send: Tx hook for the device. This allows ME host clients to trap
270 * the device driver buffers before actually physically
271 * pushing it to the ME.
272 * @recv: Rx hook for the device. This allows ME host clients to trap the
273 * ME buffers before forwarding them to the device driver.
276 int (*enable)(struct mei_cl_device *device);
277 int (*disable)(struct mei_cl_device *device);
278 int (*send)(struct mei_cl_device *device, u8 *buf, size_t length);
279 int (*recv)(struct mei_cl_device *device, u8 *buf, size_t length);
282 struct mei_cl_device *mei_cl_add_device(struct mei_device *dev,
283 uuid_le uuid, char *name,
284 struct mei_cl_ops *ops);
285 void mei_cl_remove_device(struct mei_cl_device *device);
287 int __mei_cl_async_send(struct mei_cl *cl, u8 *buf, size_t length);
288 int __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length);
289 int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length);
290 void mei_cl_bus_rx_event(struct mei_cl *cl);
291 int mei_cl_bus_init(void);
292 void mei_cl_bus_exit(void);
296 * struct mei_cl_device - MEI device handle
297 * An mei_cl_device pointer is returned from mei_add_device()
298 * and links MEI bus clients to their actual ME host client pointer.
299 * Drivers for MEI devices will get an mei_cl_device pointer
300 * when being probed and shall use it for doing ME bus I/O.
302 * @dev: linux driver model device pointer
303 * @uuid: me client uuid
305 * @ops: ME transport ops
306 * @event_cb: Drivers register this callback to get asynchronous ME
307 * events (e.g. Rx buffer pending) notifications.
308 * @events: Events bitmask sent to the driver.
309 * @priv_data: client private data
311 struct mei_cl_device {
316 const struct mei_cl_ops *ops;
318 struct work_struct event_work;
319 mei_cl_event_cb_t event_cb;
321 unsigned long events;
327 * struct mei_device - MEI private device struct
329 * @hbm_state - state of host bus message protocol
330 * @mem_addr - mem mapped base register address
332 * @hbuf_depth - depth of hardware host/write buffer is slots
333 * @hbuf_is_ready - query if the host host/write buffer is ready
334 * @wr_msg - the buffer for hbm control messages
335 * @wr_ext_msg - the buffer for hbm control responses (set in read cycle)
338 struct pci_dev *pdev; /* pointer to pci device struct */
342 /* array of pointers to aio lists */
343 struct mei_cl_cb read_list; /* driver read queue */
344 struct mei_cl_cb write_list; /* driver write queue */
345 struct mei_cl_cb write_waiting_list; /* write waiting queue */
346 struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */
347 struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */
352 struct list_head file_list;
353 long open_handle_count;
356 * lock for the device
358 struct mutex device_lock; /* device lock */
359 struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
363 * waiting queue for receive message from FW
365 wait_queue_head_t wait_hw_ready;
366 wait_queue_head_t wait_recvd_msg;
367 wait_queue_head_t wait_stop_wd;
372 enum mei_dev_state dev_state;
373 enum mei_hbm_state hbm_state;
374 u16 init_clients_timer;
376 unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
383 /* used for control messages */
385 struct mei_msg_hdr hdr;
386 unsigned char data[128];
390 struct mei_msg_hdr hdr;
391 unsigned char data[4]; /* All HBM messages are 4 bytes */
392 } wr_ext_msg; /* for control responses */
394 struct hbm_version version;
396 struct mei_me_client *me_clients; /* Note: memory has to be allocated */
397 DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
398 DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
399 unsigned long me_clients_num;
400 unsigned long me_client_presentation_num;
401 unsigned long me_client_index;
404 enum mei_wd_states wd_state;
407 unsigned char wd_data[MEI_WD_START_MSG_SIZE];
410 /* amthif list for cmd waiting */
411 struct mei_cl_cb amthif_cmd_list;
412 /* driver managed amthif list for reading completed amthif cmd data */
413 struct mei_cl_cb amthif_rd_complete_list;
414 struct file *iamthif_file_object;
415 struct mei_cl iamthif_cl;
416 struct mei_cl_cb *iamthif_current_cb;
417 long iamthif_open_count;
419 unsigned long iamthif_timer;
420 u32 iamthif_stall_timer;
421 unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
422 u32 iamthif_msg_buf_size;
423 u32 iamthif_msg_buf_index;
424 enum iamthif_states iamthif_state;
425 bool iamthif_flow_control_pending;
427 bool iamthif_canceled;
429 struct work_struct init_work;
431 /* List of bus devices */
432 struct list_head device_list;
434 #if IS_ENABLED(CONFIG_DEBUG_FS)
435 struct dentry *dbgfs_dir;
436 #endif /* CONFIG_DEBUG_FS */
439 const struct mei_hw_ops *ops;
440 char hw[0] __aligned(sizeof(void *));
443 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
445 return msecs_to_jiffies(sec * MSEC_PER_SEC);
449 * mei_data2slots - get slots - number of (dwords) from a message length
450 * + size of the mei header
451 * @length - size of the messages in bytes
452 * returns - number of slots
454 static inline u32 mei_data2slots(size_t length)
456 return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
460 * mei init function prototypes
462 void mei_device_init(struct mei_device *dev);
463 void mei_reset(struct mei_device *dev, int interrupts);
464 int mei_start(struct mei_device *dev);
465 void mei_stop(struct mei_device *dev);
468 * MEI interrupt functions prototype
471 void mei_timer(struct work_struct *work);
472 int mei_irq_read_handler(struct mei_device *dev,
473 struct mei_cl_cb *cmpl_list, s32 *slots);
475 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
476 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
479 * AMTHIF - AMT Host Interface Functions
481 void mei_amthif_reset_params(struct mei_device *dev);
483 int mei_amthif_host_init(struct mei_device *dev);
485 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
487 int mei_amthif_read(struct mei_device *dev, struct file *file,
488 char __user *ubuf, size_t length, loff_t *offset);
490 unsigned int mei_amthif_poll(struct mei_device *dev,
491 struct file *file, poll_table *wait);
493 int mei_amthif_release(struct mei_device *dev, struct file *file);
495 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
498 void mei_amthif_run_next_cmd(struct mei_device *dev);
500 int mei_amthif_irq_write_complete(struct mei_cl *cl, struct mei_cl_cb *cb,
501 s32 *slots, struct mei_cl_cb *cmpl_list);
503 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
504 int mei_amthif_irq_read_msg(struct mei_device *dev,
505 struct mei_msg_hdr *mei_hdr,
506 struct mei_cl_cb *complete_list);
507 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
512 int mei_nfc_host_init(struct mei_device *dev);
513 void mei_nfc_host_exit(void);
518 extern const uuid_le mei_nfc_guid;
520 int mei_wd_send(struct mei_device *dev);
521 int mei_wd_stop(struct mei_device *dev);
522 int mei_wd_host_init(struct mei_device *dev);
524 * mei_watchdog_register - Registering watchdog interface
525 * once we got connection to the WD Client
528 void mei_watchdog_register(struct mei_device *dev);
530 * mei_watchdog_unregister - Unregistering watchdog interface
533 void mei_watchdog_unregister(struct mei_device *dev);
536 * Register Access Function
539 static inline void mei_hw_config(struct mei_device *dev)
541 dev->ops->hw_config(dev);
543 static inline int mei_hw_reset(struct mei_device *dev, bool enable)
545 return dev->ops->hw_reset(dev, enable);
548 static inline int mei_hw_start(struct mei_device *dev)
550 return dev->ops->hw_start(dev);
553 static inline void mei_clear_interrupts(struct mei_device *dev)
555 dev->ops->intr_clear(dev);
558 static inline void mei_enable_interrupts(struct mei_device *dev)
560 dev->ops->intr_enable(dev);
563 static inline void mei_disable_interrupts(struct mei_device *dev)
565 dev->ops->intr_disable(dev);
568 static inline bool mei_host_is_ready(struct mei_device *dev)
570 return dev->ops->host_is_ready(dev);
572 static inline bool mei_hw_is_ready(struct mei_device *dev)
574 return dev->ops->hw_is_ready(dev);
577 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
579 return dev->ops->hbuf_is_ready(dev);
582 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
584 return dev->ops->hbuf_free_slots(dev);
587 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
589 return dev->ops->hbuf_max_len(dev);
592 static inline int mei_write_message(struct mei_device *dev,
593 struct mei_msg_hdr *hdr,
596 return dev->ops->write(dev, hdr, buf);
599 static inline u32 mei_read_hdr(const struct mei_device *dev)
601 return dev->ops->read_hdr(dev);
604 static inline void mei_read_slots(struct mei_device *dev,
605 unsigned char *buf, unsigned long len)
607 dev->ops->read(dev, buf, len);
610 static inline int mei_count_full_read_slots(struct mei_device *dev)
612 return dev->ops->rdbuf_full_slots(dev);
615 #if IS_ENABLED(CONFIG_DEBUG_FS)
616 int mei_dbgfs_register(struct mei_device *dev, const char *name);
617 void mei_dbgfs_deregister(struct mei_device *dev);
619 static inline int mei_dbgfs_register(struct mei_device *dev, const char *name)
623 static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
624 #endif /* CONFIG_DEBUG_FS */
626 int mei_register(struct mei_device *dev);
627 void mei_deregister(struct mei_device *dev);
629 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d comp=%1d"
630 #define MEI_HDR_PRM(hdr) \
631 (hdr)->host_addr, (hdr)->me_addr, \
632 (hdr)->length, (hdr)->msg_complete