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>
30 * watch dog definition
32 #define MEI_WD_HDR_SIZE 4
33 #define MEI_WD_STOP_MSG_SIZE MEI_WD_HDR_SIZE
34 #define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)
36 #define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */
37 #define MEI_WD_MIN_TIMEOUT 120 /* seconds */
38 #define MEI_WD_MAX_TIMEOUT 65535 /* seconds */
40 #define MEI_WD_STOP_TIMEOUT 10 /* msecs */
42 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0)
44 #define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32))
50 extern const uuid_le mei_amthif_guid;
53 * Watchdog Client UUID
55 extern const uuid_le mei_wd_guid;
58 * Number of Maximum MEI Clients
60 #define MEI_CLIENTS_MAX 256
63 * maximum number of consecutive resets
65 #define MEI_MAX_CONSEC_RESET 3
68 * Number of File descriptors/handles
69 * that can be opened to the driver.
71 * Limit to 255: 256 Total Clients
72 * minus internal client for MEI Bus Messages
74 #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
77 * Internal Clients Number
79 #define MEI_HOST_CLIENT_ID_ANY (-1)
80 #define MEI_HBM_HOST_CLIENT_ID 0 /* not used, just for documentation */
81 #define MEI_WD_HOST_CLIENT_ID 1
82 #define MEI_IAMTHIF_HOST_CLIENT_ID 2
87 MEI_FILE_INITIALIZING = 0,
90 MEI_FILE_DISCONNECTING,
94 /* MEI device states */
96 MEI_DEV_INITIALIZING = 0,
105 const char *mei_dev_state_str(int state);
107 enum iamthif_states {
110 MEI_IAMTHIF_FLOW_CONTROL,
112 MEI_IAMTHIF_READ_COMPLETE
115 enum mei_file_transaction_states {
131 * enum mei_cb_file_ops - file operation associated with the callback
132 * @MEI_FOP_READ - read
133 * @MEI_FOP_WRITE - write
134 * @MEI_FOP_CONNECT - connect
135 * @MEI_FOP_DISCONNECT_RSP - disconnect response
136 * @MEI_FOP_OPEN - open
137 * @MEI_FOP_CLOSE - close
139 enum mei_cb_file_ops {
143 MEI_FOP_DISCONNECT_RSP,
149 * Intel MEI message data struct
151 struct mei_msg_data {
156 /* Maximum number of processed FW status registers */
157 #define MEI_FW_STATUS_MAX 2
160 * struct mei_fw_status - storage of FW status data
162 * @count - number of actually available elements in array
163 * @status - FW status registers
165 struct mei_fw_status {
167 u32 status[MEI_FW_STATUS_MAX];
171 * struct mei_me_client - representation of me (fw) client
173 * @props - client properties
174 * @client_id - me client id
175 * @mei_flow_ctrl_creds - flow control credits
177 struct mei_me_client {
178 struct mei_client_properties props;
180 u8 mei_flow_ctrl_creds;
187 * struct mei_cl_cb - file operation callback structure
189 * @cl - file client who is running this operation
190 * @fop_type - file operation type
193 struct list_head list;
195 enum mei_cb_file_ops fop_type;
196 struct mei_msg_data request_buffer;
197 struct mei_msg_data response_buffer;
198 unsigned long buf_idx;
199 unsigned long read_time;
200 struct file *file_object;
204 /* MEI client instance carried as file->private_data*/
206 struct list_head link;
207 struct mei_device *dev;
208 enum file_state state;
209 wait_queue_head_t tx_wait;
210 wait_queue_head_t rx_wait;
211 wait_queue_head_t wait;
213 /* ID of client connected */
216 u8 mei_flow_ctrl_creds;
218 enum mei_file_transaction_states reading_state;
219 enum mei_file_transaction_states writing_state;
220 struct mei_cl_cb *read_cb;
222 /* MEI CL bus data */
223 struct mei_cl_device *device;
224 struct list_head device_link;
228 /** struct mei_hw_ops
230 * @fw_status - read FW status from PCI config space
231 * @host_is_ready - query for host readiness
233 * @hw_is_ready - query if hw is ready
234 * @hw_reset - reset hw
235 * @hw_start - start hw after reset
236 * @hw_config - configure hw
238 * @pg_state - power gating state of the device
239 * @pg_is_enabled - is power gating enabled
241 * @intr_clear - clear pending interrupts
242 * @intr_enable - enable interrupts
243 * @intr_disable - disable interrupts
245 * @hbuf_free_slots - query for write buffer empty slots
246 * @hbuf_is_ready - query if write buffer is empty
247 * @hbuf_max_len - query for write buffer max len
249 * @write - write a message to FW
251 * @rdbuf_full_slots - query how many slots are filled
253 * @read_hdr - get first 4 bytes (header)
254 * @read - read a buffer from the FW
258 int (*fw_status)(struct mei_device *dev,
259 struct mei_fw_status *fw_status);
260 bool (*host_is_ready)(struct mei_device *dev);
262 bool (*hw_is_ready)(struct mei_device *dev);
263 int (*hw_reset)(struct mei_device *dev, bool enable);
264 int (*hw_start)(struct mei_device *dev);
265 void (*hw_config)(struct mei_device *dev);
267 enum mei_pg_state (*pg_state)(struct mei_device *dev);
268 bool (*pg_is_enabled)(struct mei_device *dev);
270 void (*intr_clear)(struct mei_device *dev);
271 void (*intr_enable)(struct mei_device *dev);
272 void (*intr_disable)(struct mei_device *dev);
274 int (*hbuf_free_slots)(struct mei_device *dev);
275 bool (*hbuf_is_ready)(struct mei_device *dev);
276 size_t (*hbuf_max_len)(const struct mei_device *dev);
278 int (*write)(struct mei_device *dev,
279 struct mei_msg_hdr *hdr,
282 int (*rdbuf_full_slots)(struct mei_device *dev);
284 u32 (*read_hdr)(const struct mei_device *dev);
285 int (*read)(struct mei_device *dev,
286 unsigned char *buf, unsigned long len);
292 * struct mei_cl_ops - MEI CL device ops
293 * This structure allows ME host clients to implement technology
294 * specific operations.
296 * @enable: Enable an MEI CL device. Some devices require specific
297 * HECI commands to initialize completely.
298 * @disable: Disable an MEI CL device.
299 * @send: Tx hook for the device. This allows ME host clients to trap
300 * the device driver buffers before actually physically
301 * pushing it to the ME.
302 * @recv: Rx hook for the device. This allows ME host clients to trap the
303 * ME buffers before forwarding them to the device driver.
306 int (*enable)(struct mei_cl_device *device);
307 int (*disable)(struct mei_cl_device *device);
308 int (*send)(struct mei_cl_device *device, u8 *buf, size_t length);
309 int (*recv)(struct mei_cl_device *device, u8 *buf, size_t length);
312 struct mei_cl_device *mei_cl_add_device(struct mei_device *dev,
313 uuid_le uuid, char *name,
314 struct mei_cl_ops *ops);
315 void mei_cl_remove_device(struct mei_cl_device *device);
317 int __mei_cl_async_send(struct mei_cl *cl, u8 *buf, size_t length);
318 int __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length);
319 int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length);
320 void mei_cl_bus_rx_event(struct mei_cl *cl);
321 void mei_cl_bus_remove_devices(struct mei_device *dev);
322 int mei_cl_bus_init(void);
323 void mei_cl_bus_exit(void);
327 * struct mei_cl_device - MEI device handle
328 * An mei_cl_device pointer is returned from mei_add_device()
329 * and links MEI bus clients to their actual ME host client pointer.
330 * Drivers for MEI devices will get an mei_cl_device pointer
331 * when being probed and shall use it for doing ME bus I/O.
333 * @dev: linux driver model device pointer
334 * @uuid: me client uuid
336 * @ops: ME transport ops
337 * @event_cb: Drivers register this callback to get asynchronous ME
338 * events (e.g. Rx buffer pending) notifications.
339 * @events: Events bitmask sent to the driver.
340 * @priv_data: client private data
342 struct mei_cl_device {
347 const struct mei_cl_ops *ops;
349 struct work_struct event_work;
350 mei_cl_event_cb_t event_cb;
352 unsigned long events;
359 * enum mei_pg_event - power gating transition events
361 * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition
362 * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete
363 * @MEI_PG_EVENT_RECEIVED: the driver received pg event
368 MEI_PG_EVENT_RECEIVED,
372 * enum mei_pg_state - device internal power gating state
374 * @MEI_PG_OFF: device is not power gated - it is active
375 * @MEI_PG_ON: device is power gated - it is in lower power state
385 * @fw_status - FW status
386 * @quirk_probe - device exclusion quirk
389 const struct mei_fw_status fw_status;
390 bool (*quirk_probe)(struct pci_dev *pdev);
394 #define MEI_PCI_DEVICE(dev, cfg) \
395 .vendor = PCI_VENDOR_ID_INTEL, .device = (dev), \
396 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, \
397 .driver_data = (kernel_ulong_t)&(cfg)
401 * struct mei_device - MEI private device struct
403 * @reset_count - limits the number of consecutive resets
404 * @hbm_state - state of host bus message protocol
405 * @pg_event - power gating event
406 * @mem_addr - mem mapped base register address
408 * @hbuf_depth - depth of hardware host/write buffer is slots
409 * @hbuf_is_ready - query if the host host/write buffer is ready
410 * @wr_msg - the buffer for hbm control messages
411 * @cfg - per device generation config and ops
414 struct pci_dev *pdev; /* pointer to pci device struct */
418 /* array of pointers to aio lists */
419 struct mei_cl_cb read_list; /* driver read queue */
420 struct mei_cl_cb write_list; /* driver write queue */
421 struct mei_cl_cb write_waiting_list; /* write waiting queue */
422 struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */
423 struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */
428 struct list_head file_list;
429 long open_handle_count;
432 * lock for the device
434 struct mutex device_lock; /* device lock */
435 struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
439 * waiting queue for receive message from FW
441 wait_queue_head_t wait_hw_ready;
442 wait_queue_head_t wait_pg;
443 wait_queue_head_t wait_recvd_msg;
444 wait_queue_head_t wait_stop_wd;
449 unsigned long reset_count;
450 enum mei_dev_state dev_state;
451 enum mei_hbm_state hbm_state;
452 u16 init_clients_timer;
455 * Power Gating support
457 enum mei_pg_event pg_event;
458 #ifdef CONFIG_PM_RUNTIME
459 struct dev_pm_domain pg_domain;
460 #endif /* CONFIG_PM_RUNTIME */
462 unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
469 /* used for control messages */
471 struct mei_msg_hdr hdr;
472 unsigned char data[128];
475 struct hbm_version version;
477 struct mei_me_client *me_clients; /* Note: memory has to be allocated */
478 DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
479 DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
480 unsigned long me_clients_num;
481 unsigned long me_client_presentation_num;
482 unsigned long me_client_index;
485 enum mei_wd_states wd_state;
488 unsigned char wd_data[MEI_WD_START_MSG_SIZE];
491 /* amthif list for cmd waiting */
492 struct mei_cl_cb amthif_cmd_list;
493 /* driver managed amthif list for reading completed amthif cmd data */
494 struct mei_cl_cb amthif_rd_complete_list;
495 struct file *iamthif_file_object;
496 struct mei_cl iamthif_cl;
497 struct mei_cl_cb *iamthif_current_cb;
498 long iamthif_open_count;
500 unsigned long iamthif_timer;
501 u32 iamthif_stall_timer;
502 unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
503 u32 iamthif_msg_buf_size;
504 u32 iamthif_msg_buf_index;
505 enum iamthif_states iamthif_state;
506 bool iamthif_flow_control_pending;
508 bool iamthif_canceled;
510 struct work_struct init_work;
511 struct work_struct reset_work;
513 /* List of bus devices */
514 struct list_head device_list;
516 #if IS_ENABLED(CONFIG_DEBUG_FS)
517 struct dentry *dbgfs_dir;
518 #endif /* CONFIG_DEBUG_FS */
521 const struct mei_hw_ops *ops;
522 const struct mei_cfg *cfg;
523 char hw[0] __aligned(sizeof(void *));
526 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
528 return msecs_to_jiffies(sec * MSEC_PER_SEC);
532 * mei_data2slots - get slots - number of (dwords) from a message length
533 * + size of the mei header
534 * @length - size of the messages in bytes
535 * returns - number of slots
537 static inline u32 mei_data2slots(size_t length)
539 return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
543 * mei_slots2data- get data in slots - bytes from slots
544 * @slots - number of available slots
545 * returns - number of bytes in slots
547 static inline u32 mei_slots2data(int slots)
553 * mei init function prototypes
555 void mei_device_init(struct mei_device *dev, const struct mei_cfg *cfg);
556 int mei_reset(struct mei_device *dev);
557 int mei_start(struct mei_device *dev);
558 int mei_restart(struct mei_device *dev);
559 void mei_stop(struct mei_device *dev);
560 void mei_cancel_work(struct mei_device *dev);
563 * MEI interrupt functions prototype
566 void mei_timer(struct work_struct *work);
567 int mei_irq_read_handler(struct mei_device *dev,
568 struct mei_cl_cb *cmpl_list, s32 *slots);
570 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
571 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
574 * AMTHIF - AMT Host Interface Functions
576 void mei_amthif_reset_params(struct mei_device *dev);
578 int mei_amthif_host_init(struct mei_device *dev);
580 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
582 int mei_amthif_read(struct mei_device *dev, struct file *file,
583 char __user *ubuf, size_t length, loff_t *offset);
585 unsigned int mei_amthif_poll(struct mei_device *dev,
586 struct file *file, poll_table *wait);
588 int mei_amthif_release(struct mei_device *dev, struct file *file);
590 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
593 void mei_amthif_run_next_cmd(struct mei_device *dev);
595 int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
596 struct mei_cl_cb *cmpl_list);
598 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
599 int mei_amthif_irq_read_msg(struct mei_device *dev,
600 struct mei_msg_hdr *mei_hdr,
601 struct mei_cl_cb *complete_list);
602 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
607 int mei_nfc_host_init(struct mei_device *dev);
608 void mei_nfc_host_exit(struct mei_device *dev);
613 extern const uuid_le mei_nfc_guid;
615 int mei_wd_send(struct mei_device *dev);
616 int mei_wd_stop(struct mei_device *dev);
617 int mei_wd_host_init(struct mei_device *dev);
619 * mei_watchdog_register - Registering watchdog interface
620 * once we got connection to the WD Client
623 int mei_watchdog_register(struct mei_device *dev);
625 * mei_watchdog_unregister - Unregistering watchdog interface
628 void mei_watchdog_unregister(struct mei_device *dev);
631 * Register Access Function
635 static inline void mei_hw_config(struct mei_device *dev)
637 dev->ops->hw_config(dev);
640 static inline enum mei_pg_state mei_pg_state(struct mei_device *dev)
642 return dev->ops->pg_state(dev);
645 static inline bool mei_pg_is_enabled(struct mei_device *dev)
647 return dev->ops->pg_is_enabled(dev);
650 static inline int mei_hw_reset(struct mei_device *dev, bool enable)
652 return dev->ops->hw_reset(dev, enable);
655 static inline int mei_hw_start(struct mei_device *dev)
657 return dev->ops->hw_start(dev);
660 static inline void mei_clear_interrupts(struct mei_device *dev)
662 dev->ops->intr_clear(dev);
665 static inline void mei_enable_interrupts(struct mei_device *dev)
667 dev->ops->intr_enable(dev);
670 static inline void mei_disable_interrupts(struct mei_device *dev)
672 dev->ops->intr_disable(dev);
675 static inline bool mei_host_is_ready(struct mei_device *dev)
677 return dev->ops->host_is_ready(dev);
679 static inline bool mei_hw_is_ready(struct mei_device *dev)
681 return dev->ops->hw_is_ready(dev);
684 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
686 return dev->ops->hbuf_is_ready(dev);
689 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
691 return dev->ops->hbuf_free_slots(dev);
694 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
696 return dev->ops->hbuf_max_len(dev);
699 static inline int mei_write_message(struct mei_device *dev,
700 struct mei_msg_hdr *hdr,
703 return dev->ops->write(dev, hdr, buf);
706 static inline u32 mei_read_hdr(const struct mei_device *dev)
708 return dev->ops->read_hdr(dev);
711 static inline void mei_read_slots(struct mei_device *dev,
712 unsigned char *buf, unsigned long len)
714 dev->ops->read(dev, buf, len);
717 static inline int mei_count_full_read_slots(struct mei_device *dev)
719 return dev->ops->rdbuf_full_slots(dev);
722 int mei_fw_status(struct mei_device *dev, struct mei_fw_status *fw_status);
724 #define FW_STS_FMT "%08X %08X"
725 #define FW_STS_PRM(fw_status) \
726 (fw_status).count > 0 ? (fw_status).status[0] : 0xDEADBEEF, \
727 (fw_status).count > 1 ? (fw_status).status[1] : 0xDEADBEEF
729 bool mei_hbuf_acquire(struct mei_device *dev);
731 bool mei_write_is_idle(struct mei_device *dev);
733 #if IS_ENABLED(CONFIG_DEBUG_FS)
734 int mei_dbgfs_register(struct mei_device *dev, const char *name);
735 void mei_dbgfs_deregister(struct mei_device *dev);
737 static inline int mei_dbgfs_register(struct mei_device *dev, const char *name)
741 static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
742 #endif /* CONFIG_DEBUG_FS */
744 int mei_register(struct mei_device *dev);
745 void mei_deregister(struct mei_device *dev);
747 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
748 #define MEI_HDR_PRM(hdr) \
749 (hdr)->host_addr, (hdr)->me_addr, \
750 (hdr)->length, (hdr)->internal, (hdr)->msg_complete