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 {
157 * struct mei_me_client - representation of me (fw) client
159 * @props - client properties
160 * @client_id - me client id
161 * @mei_flow_ctrl_creds - flow control credits
163 struct mei_me_client {
164 struct mei_client_properties props;
166 u8 mei_flow_ctrl_creds;
173 * struct mei_cl_cb - file operation callback structure
175 * @cl - file client who is running this operation
176 * @fop_type - file operation type
179 struct list_head list;
181 enum mei_cb_file_ops fop_type;
182 struct mei_msg_data request_buffer;
183 struct mei_msg_data response_buffer;
184 unsigned long buf_idx;
185 unsigned long read_time;
186 struct file *file_object;
190 /* MEI client instance carried as file->private_data*/
192 struct list_head link;
193 struct mei_device *dev;
194 enum file_state state;
195 wait_queue_head_t tx_wait;
196 wait_queue_head_t rx_wait;
197 wait_queue_head_t wait;
199 /* ID of client connected */
202 u8 mei_flow_ctrl_creds;
204 enum mei_file_transaction_states reading_state;
205 enum mei_file_transaction_states writing_state;
206 struct mei_cl_cb *read_cb;
208 /* MEI CL bus data */
209 struct mei_cl_device *device;
210 struct list_head device_link;
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 * @pg_state - power gating state of the device
224 * @pg_is_enabled - is power gating enabled
226 * @intr_clear - clear pending interrupts
227 * @intr_enable - enable interrupts
228 * @intr_disable - disable interrupts
230 * @hbuf_free_slots - query for write buffer empty slots
231 * @hbuf_is_ready - query if write buffer is empty
232 * @hbuf_max_len - query for write buffer max len
234 * @write - write a message to FW
236 * @rdbuf_full_slots - query how many slots are filled
238 * @read_hdr - get first 4 bytes (header)
239 * @read - read a buffer from the FW
243 bool (*host_is_ready)(struct mei_device *dev);
245 bool (*hw_is_ready)(struct mei_device *dev);
246 int (*hw_reset)(struct mei_device *dev, bool enable);
247 int (*hw_start)(struct mei_device *dev);
248 void (*hw_config)(struct mei_device *dev);
250 enum mei_pg_state (*pg_state)(struct mei_device *dev);
251 bool (*pg_is_enabled)(struct mei_device *dev);
253 void (*intr_clear)(struct mei_device *dev);
254 void (*intr_enable)(struct mei_device *dev);
255 void (*intr_disable)(struct mei_device *dev);
257 int (*hbuf_free_slots)(struct mei_device *dev);
258 bool (*hbuf_is_ready)(struct mei_device *dev);
259 size_t (*hbuf_max_len)(const struct mei_device *dev);
261 int (*write)(struct mei_device *dev,
262 struct mei_msg_hdr *hdr,
265 int (*rdbuf_full_slots)(struct mei_device *dev);
267 u32 (*read_hdr)(const struct mei_device *dev);
268 int (*read)(struct mei_device *dev,
269 unsigned char *buf, unsigned long len);
275 * struct mei_cl_ops - MEI CL device ops
276 * This structure allows ME host clients to implement technology
277 * specific operations.
279 * @enable: Enable an MEI CL device. Some devices require specific
280 * HECI commands to initialize completely.
281 * @disable: Disable an MEI CL device.
282 * @send: Tx hook for the device. This allows ME host clients to trap
283 * the device driver buffers before actually physically
284 * pushing it to the ME.
285 * @recv: Rx hook for the device. This allows ME host clients to trap the
286 * ME buffers before forwarding them to the device driver.
289 int (*enable)(struct mei_cl_device *device);
290 int (*disable)(struct mei_cl_device *device);
291 int (*send)(struct mei_cl_device *device, u8 *buf, size_t length);
292 int (*recv)(struct mei_cl_device *device, u8 *buf, size_t length);
295 struct mei_cl_device *mei_cl_add_device(struct mei_device *dev,
296 uuid_le uuid, char *name,
297 struct mei_cl_ops *ops);
298 void mei_cl_remove_device(struct mei_cl_device *device);
300 int __mei_cl_async_send(struct mei_cl *cl, u8 *buf, size_t length);
301 int __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length);
302 int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length);
303 void mei_cl_bus_rx_event(struct mei_cl *cl);
304 void mei_cl_bus_remove_devices(struct mei_device *dev);
305 int mei_cl_bus_init(void);
306 void mei_cl_bus_exit(void);
310 * struct mei_cl_device - MEI device handle
311 * An mei_cl_device pointer is returned from mei_add_device()
312 * and links MEI bus clients to their actual ME host client pointer.
313 * Drivers for MEI devices will get an mei_cl_device pointer
314 * when being probed and shall use it for doing ME bus I/O.
316 * @dev: linux driver model device pointer
317 * @uuid: me client uuid
319 * @ops: ME transport ops
320 * @event_cb: Drivers register this callback to get asynchronous ME
321 * events (e.g. Rx buffer pending) notifications.
322 * @events: Events bitmask sent to the driver.
323 * @priv_data: client private data
325 struct mei_cl_device {
330 const struct mei_cl_ops *ops;
332 struct work_struct event_work;
333 mei_cl_event_cb_t event_cb;
335 unsigned long events;
342 * enum mei_pg_event - power gating transition events
344 * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition
345 * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete
346 * @MEI_PG_EVENT_RECEIVED: the driver received pg event
351 MEI_PG_EVENT_RECEIVED,
355 * enum mei_pg_state - device internal power gating state
357 * @MEI_PG_OFF: device is not power gated - it is active
358 * @MEI_PG_ON: device is power gated - it is in lower power state
366 * struct mei_device - MEI private device struct
368 * @reset_count - limits the number of consecutive resets
369 * @hbm_state - state of host bus message protocol
370 * @pg_event - power gating event
371 * @mem_addr - mem mapped base register address
373 * @hbuf_depth - depth of hardware host/write buffer is slots
374 * @hbuf_is_ready - query if the host host/write buffer is ready
375 * @wr_msg - the buffer for hbm control messages
378 struct pci_dev *pdev; /* pointer to pci device struct */
382 /* array of pointers to aio lists */
383 struct mei_cl_cb read_list; /* driver read queue */
384 struct mei_cl_cb write_list; /* driver write queue */
385 struct mei_cl_cb write_waiting_list; /* write waiting queue */
386 struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */
387 struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */
392 struct list_head file_list;
393 long open_handle_count;
396 * lock for the device
398 struct mutex device_lock; /* device lock */
399 struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
403 * waiting queue for receive message from FW
405 wait_queue_head_t wait_hw_ready;
406 wait_queue_head_t wait_pg;
407 wait_queue_head_t wait_recvd_msg;
408 wait_queue_head_t wait_stop_wd;
413 unsigned long reset_count;
414 enum mei_dev_state dev_state;
415 enum mei_hbm_state hbm_state;
416 u16 init_clients_timer;
419 * Power Gating support
421 enum mei_pg_event pg_event;
423 unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
430 /* used for control messages */
432 struct mei_msg_hdr hdr;
433 unsigned char data[128];
436 struct hbm_version version;
438 struct mei_me_client *me_clients; /* Note: memory has to be allocated */
439 DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
440 DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
441 unsigned long me_clients_num;
442 unsigned long me_client_presentation_num;
443 unsigned long me_client_index;
446 enum mei_wd_states wd_state;
449 unsigned char wd_data[MEI_WD_START_MSG_SIZE];
452 /* amthif list for cmd waiting */
453 struct mei_cl_cb amthif_cmd_list;
454 /* driver managed amthif list for reading completed amthif cmd data */
455 struct mei_cl_cb amthif_rd_complete_list;
456 struct file *iamthif_file_object;
457 struct mei_cl iamthif_cl;
458 struct mei_cl_cb *iamthif_current_cb;
459 long iamthif_open_count;
461 unsigned long iamthif_timer;
462 u32 iamthif_stall_timer;
463 unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
464 u32 iamthif_msg_buf_size;
465 u32 iamthif_msg_buf_index;
466 enum iamthif_states iamthif_state;
467 bool iamthif_flow_control_pending;
469 bool iamthif_canceled;
471 struct work_struct init_work;
472 struct work_struct reset_work;
474 /* List of bus devices */
475 struct list_head device_list;
477 #if IS_ENABLED(CONFIG_DEBUG_FS)
478 struct dentry *dbgfs_dir;
479 #endif /* CONFIG_DEBUG_FS */
482 const struct mei_hw_ops *ops;
483 char hw[0] __aligned(sizeof(void *));
486 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
488 return msecs_to_jiffies(sec * MSEC_PER_SEC);
492 * mei_data2slots - get slots - number of (dwords) from a message length
493 * + size of the mei header
494 * @length - size of the messages in bytes
495 * returns - number of slots
497 static inline u32 mei_data2slots(size_t length)
499 return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
503 * mei_slots2data- get data in slots - bytes from slots
504 * @slots - number of available slots
505 * returns - number of bytes in slots
507 static inline u32 mei_slots2data(int slots)
513 * mei init function prototypes
515 void mei_device_init(struct mei_device *dev);
516 int mei_reset(struct mei_device *dev);
517 int mei_start(struct mei_device *dev);
518 int mei_restart(struct mei_device *dev);
519 void mei_stop(struct mei_device *dev);
520 void mei_cancel_work(struct mei_device *dev);
523 * MEI interrupt functions prototype
526 void mei_timer(struct work_struct *work);
527 int mei_irq_read_handler(struct mei_device *dev,
528 struct mei_cl_cb *cmpl_list, s32 *slots);
530 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
531 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
534 * AMTHIF - AMT Host Interface Functions
536 void mei_amthif_reset_params(struct mei_device *dev);
538 int mei_amthif_host_init(struct mei_device *dev);
540 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
542 int mei_amthif_read(struct mei_device *dev, struct file *file,
543 char __user *ubuf, size_t length, loff_t *offset);
545 unsigned int mei_amthif_poll(struct mei_device *dev,
546 struct file *file, poll_table *wait);
548 int mei_amthif_release(struct mei_device *dev, struct file *file);
550 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
553 void mei_amthif_run_next_cmd(struct mei_device *dev);
555 int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
556 struct mei_cl_cb *cmpl_list);
558 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
559 int mei_amthif_irq_read_msg(struct mei_device *dev,
560 struct mei_msg_hdr *mei_hdr,
561 struct mei_cl_cb *complete_list);
562 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
567 int mei_nfc_host_init(struct mei_device *dev);
568 void mei_nfc_host_exit(struct mei_device *dev);
573 extern const uuid_le mei_nfc_guid;
575 int mei_wd_send(struct mei_device *dev);
576 int mei_wd_stop(struct mei_device *dev);
577 int mei_wd_host_init(struct mei_device *dev);
579 * mei_watchdog_register - Registering watchdog interface
580 * once we got connection to the WD Client
583 int mei_watchdog_register(struct mei_device *dev);
585 * mei_watchdog_unregister - Unregistering watchdog interface
588 void mei_watchdog_unregister(struct mei_device *dev);
591 * Register Access Function
594 static inline void mei_hw_config(struct mei_device *dev)
596 dev->ops->hw_config(dev);
599 static inline enum mei_pg_state mei_pg_state(struct mei_device *dev)
601 return dev->ops->pg_state(dev);
604 static inline bool mei_pg_is_enabled(struct mei_device *dev)
606 return dev->ops->pg_is_enabled(dev);
609 static inline int mei_hw_reset(struct mei_device *dev, bool enable)
611 return dev->ops->hw_reset(dev, enable);
614 static inline int mei_hw_start(struct mei_device *dev)
616 return dev->ops->hw_start(dev);
619 static inline void mei_clear_interrupts(struct mei_device *dev)
621 dev->ops->intr_clear(dev);
624 static inline void mei_enable_interrupts(struct mei_device *dev)
626 dev->ops->intr_enable(dev);
629 static inline void mei_disable_interrupts(struct mei_device *dev)
631 dev->ops->intr_disable(dev);
634 static inline bool mei_host_is_ready(struct mei_device *dev)
636 return dev->ops->host_is_ready(dev);
638 static inline bool mei_hw_is_ready(struct mei_device *dev)
640 return dev->ops->hw_is_ready(dev);
643 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
645 return dev->ops->hbuf_is_ready(dev);
648 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
650 return dev->ops->hbuf_free_slots(dev);
653 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
655 return dev->ops->hbuf_max_len(dev);
658 static inline int mei_write_message(struct mei_device *dev,
659 struct mei_msg_hdr *hdr,
662 return dev->ops->write(dev, hdr, buf);
665 static inline u32 mei_read_hdr(const struct mei_device *dev)
667 return dev->ops->read_hdr(dev);
670 static inline void mei_read_slots(struct mei_device *dev,
671 unsigned char *buf, unsigned long len)
673 dev->ops->read(dev, buf, len);
676 static inline int mei_count_full_read_slots(struct mei_device *dev)
678 return dev->ops->rdbuf_full_slots(dev);
681 bool mei_hbuf_acquire(struct mei_device *dev);
683 bool mei_write_is_idle(struct mei_device *dev);
685 #if IS_ENABLED(CONFIG_DEBUG_FS)
686 int mei_dbgfs_register(struct mei_device *dev, const char *name);
687 void mei_dbgfs_deregister(struct mei_device *dev);
689 static inline int mei_dbgfs_register(struct mei_device *dev, const char *name)
693 static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
694 #endif /* CONFIG_DEBUG_FS */
696 int mei_register(struct mei_device *dev);
697 void mei_deregister(struct mei_device *dev);
699 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
700 #define MEI_HDR_PRM(hdr) \
701 (hdr)->host_addr, (hdr)->me_addr, \
702 (hdr)->length, (hdr)->internal, (hdr)->msg_complete