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_is_enabled - is power gating enabled
225 * @intr_clear - clear pending interrupts
226 * @intr_enable - enable interrupts
227 * @intr_disable - disable interrupts
229 * @hbuf_free_slots - query for write buffer empty slots
230 * @hbuf_is_ready - query if write buffer is empty
231 * @hbuf_max_len - query for write buffer max len
233 * @write - write a message to FW
235 * @rdbuf_full_slots - query how many slots are filled
237 * @read_hdr - get first 4 bytes (header)
238 * @read - read a buffer from the FW
242 bool (*host_is_ready)(struct mei_device *dev);
244 bool (*hw_is_ready)(struct mei_device *dev);
245 int (*hw_reset)(struct mei_device *dev, bool enable);
246 int (*hw_start)(struct mei_device *dev);
247 void (*hw_config)(struct mei_device *dev);
249 bool (*pg_is_enabled)(struct mei_device *dev);
251 void (*intr_clear)(struct mei_device *dev);
252 void (*intr_enable)(struct mei_device *dev);
253 void (*intr_disable)(struct mei_device *dev);
255 int (*hbuf_free_slots)(struct mei_device *dev);
256 bool (*hbuf_is_ready)(struct mei_device *dev);
257 size_t (*hbuf_max_len)(const struct mei_device *dev);
259 int (*write)(struct mei_device *dev,
260 struct mei_msg_hdr *hdr,
263 int (*rdbuf_full_slots)(struct mei_device *dev);
265 u32 (*read_hdr)(const struct mei_device *dev);
266 int (*read)(struct mei_device *dev,
267 unsigned char *buf, unsigned long len);
273 * struct mei_cl_ops - MEI CL device ops
274 * This structure allows ME host clients to implement technology
275 * specific operations.
277 * @enable: Enable an MEI CL device. Some devices require specific
278 * HECI commands to initialize completely.
279 * @disable: Disable an MEI CL device.
280 * @send: Tx hook for the device. This allows ME host clients to trap
281 * the device driver buffers before actually physically
282 * pushing it to the ME.
283 * @recv: Rx hook for the device. This allows ME host clients to trap the
284 * ME buffers before forwarding them to the device driver.
287 int (*enable)(struct mei_cl_device *device);
288 int (*disable)(struct mei_cl_device *device);
289 int (*send)(struct mei_cl_device *device, u8 *buf, size_t length);
290 int (*recv)(struct mei_cl_device *device, u8 *buf, size_t length);
293 struct mei_cl_device *mei_cl_add_device(struct mei_device *dev,
294 uuid_le uuid, char *name,
295 struct mei_cl_ops *ops);
296 void mei_cl_remove_device(struct mei_cl_device *device);
298 int __mei_cl_async_send(struct mei_cl *cl, u8 *buf, size_t length);
299 int __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length);
300 int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length);
301 void mei_cl_bus_rx_event(struct mei_cl *cl);
302 void mei_cl_bus_remove_devices(struct mei_device *dev);
303 int mei_cl_bus_init(void);
304 void mei_cl_bus_exit(void);
308 * struct mei_cl_device - MEI device handle
309 * An mei_cl_device pointer is returned from mei_add_device()
310 * and links MEI bus clients to their actual ME host client pointer.
311 * Drivers for MEI devices will get an mei_cl_device pointer
312 * when being probed and shall use it for doing ME bus I/O.
314 * @dev: linux driver model device pointer
315 * @uuid: me client uuid
317 * @ops: ME transport ops
318 * @event_cb: Drivers register this callback to get asynchronous ME
319 * events (e.g. Rx buffer pending) notifications.
320 * @events: Events bitmask sent to the driver.
321 * @priv_data: client private data
323 struct mei_cl_device {
328 const struct mei_cl_ops *ops;
330 struct work_struct event_work;
331 mei_cl_event_cb_t event_cb;
333 unsigned long events;
339 * struct mei_device - MEI private device struct
341 * @reset_count - limits the number of consecutive resets
342 * @hbm_state - state of host bus message protocol
343 * @mem_addr - mem mapped base register address
345 * @hbuf_depth - depth of hardware host/write buffer is slots
346 * @hbuf_is_ready - query if the host host/write buffer is ready
347 * @wr_msg - the buffer for hbm control messages
350 struct pci_dev *pdev; /* pointer to pci device struct */
354 /* array of pointers to aio lists */
355 struct mei_cl_cb read_list; /* driver read queue */
356 struct mei_cl_cb write_list; /* driver write queue */
357 struct mei_cl_cb write_waiting_list; /* write waiting queue */
358 struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */
359 struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */
364 struct list_head file_list;
365 long open_handle_count;
368 * lock for the device
370 struct mutex device_lock; /* device lock */
371 struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
375 * waiting queue for receive message from FW
377 wait_queue_head_t wait_hw_ready;
378 wait_queue_head_t wait_pg;
379 wait_queue_head_t wait_recvd_msg;
380 wait_queue_head_t wait_stop_wd;
385 unsigned long reset_count;
386 enum mei_dev_state dev_state;
387 enum mei_hbm_state hbm_state;
388 u16 init_clients_timer;
390 unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
397 /* used for control messages */
399 struct mei_msg_hdr hdr;
400 unsigned char data[128];
403 struct hbm_version version;
405 struct mei_me_client *me_clients; /* Note: memory has to be allocated */
406 DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
407 DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
408 unsigned long me_clients_num;
409 unsigned long me_client_presentation_num;
410 unsigned long me_client_index;
413 enum mei_wd_states wd_state;
416 unsigned char wd_data[MEI_WD_START_MSG_SIZE];
419 /* amthif list for cmd waiting */
420 struct mei_cl_cb amthif_cmd_list;
421 /* driver managed amthif list for reading completed amthif cmd data */
422 struct mei_cl_cb amthif_rd_complete_list;
423 struct file *iamthif_file_object;
424 struct mei_cl iamthif_cl;
425 struct mei_cl_cb *iamthif_current_cb;
426 long iamthif_open_count;
428 unsigned long iamthif_timer;
429 u32 iamthif_stall_timer;
430 unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
431 u32 iamthif_msg_buf_size;
432 u32 iamthif_msg_buf_index;
433 enum iamthif_states iamthif_state;
434 bool iamthif_flow_control_pending;
436 bool iamthif_canceled;
438 struct work_struct init_work;
439 struct work_struct reset_work;
441 /* List of bus devices */
442 struct list_head device_list;
444 #if IS_ENABLED(CONFIG_DEBUG_FS)
445 struct dentry *dbgfs_dir;
446 #endif /* CONFIG_DEBUG_FS */
449 const struct mei_hw_ops *ops;
450 char hw[0] __aligned(sizeof(void *));
453 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
455 return msecs_to_jiffies(sec * MSEC_PER_SEC);
459 * mei_data2slots - get slots - number of (dwords) from a message length
460 * + size of the mei header
461 * @length - size of the messages in bytes
462 * returns - number of slots
464 static inline u32 mei_data2slots(size_t length)
466 return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
470 * mei_slots2data- get data in slots - bytes from slots
471 * @slots - number of available slots
472 * returns - number of bytes in slots
474 static inline u32 mei_slots2data(int slots)
480 * mei init function prototypes
482 void mei_device_init(struct mei_device *dev);
483 int mei_reset(struct mei_device *dev);
484 int mei_start(struct mei_device *dev);
485 int mei_restart(struct mei_device *dev);
486 void mei_stop(struct mei_device *dev);
487 void mei_cancel_work(struct mei_device *dev);
490 * MEI interrupt functions prototype
493 void mei_timer(struct work_struct *work);
494 int mei_irq_read_handler(struct mei_device *dev,
495 struct mei_cl_cb *cmpl_list, s32 *slots);
497 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
498 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
501 * AMTHIF - AMT Host Interface Functions
503 void mei_amthif_reset_params(struct mei_device *dev);
505 int mei_amthif_host_init(struct mei_device *dev);
507 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
509 int mei_amthif_read(struct mei_device *dev, struct file *file,
510 char __user *ubuf, size_t length, loff_t *offset);
512 unsigned int mei_amthif_poll(struct mei_device *dev,
513 struct file *file, poll_table *wait);
515 int mei_amthif_release(struct mei_device *dev, struct file *file);
517 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
520 void mei_amthif_run_next_cmd(struct mei_device *dev);
522 int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
523 struct mei_cl_cb *cmpl_list);
525 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
526 int mei_amthif_irq_read_msg(struct mei_device *dev,
527 struct mei_msg_hdr *mei_hdr,
528 struct mei_cl_cb *complete_list);
529 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
534 int mei_nfc_host_init(struct mei_device *dev);
535 void mei_nfc_host_exit(struct mei_device *dev);
540 extern const uuid_le mei_nfc_guid;
542 int mei_wd_send(struct mei_device *dev);
543 int mei_wd_stop(struct mei_device *dev);
544 int mei_wd_host_init(struct mei_device *dev);
546 * mei_watchdog_register - Registering watchdog interface
547 * once we got connection to the WD Client
550 int mei_watchdog_register(struct mei_device *dev);
552 * mei_watchdog_unregister - Unregistering watchdog interface
555 void mei_watchdog_unregister(struct mei_device *dev);
558 * Register Access Function
561 static inline void mei_hw_config(struct mei_device *dev)
563 dev->ops->hw_config(dev);
566 static inline bool mei_pg_is_enabled(struct mei_device *dev)
568 return dev->ops->pg_is_enabled(dev);
571 static inline int mei_hw_reset(struct mei_device *dev, bool enable)
573 return dev->ops->hw_reset(dev, enable);
576 static inline int mei_hw_start(struct mei_device *dev)
578 return dev->ops->hw_start(dev);
581 static inline void mei_clear_interrupts(struct mei_device *dev)
583 dev->ops->intr_clear(dev);
586 static inline void mei_enable_interrupts(struct mei_device *dev)
588 dev->ops->intr_enable(dev);
591 static inline void mei_disable_interrupts(struct mei_device *dev)
593 dev->ops->intr_disable(dev);
596 static inline bool mei_host_is_ready(struct mei_device *dev)
598 return dev->ops->host_is_ready(dev);
600 static inline bool mei_hw_is_ready(struct mei_device *dev)
602 return dev->ops->hw_is_ready(dev);
605 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
607 return dev->ops->hbuf_is_ready(dev);
610 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
612 return dev->ops->hbuf_free_slots(dev);
615 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
617 return dev->ops->hbuf_max_len(dev);
620 static inline int mei_write_message(struct mei_device *dev,
621 struct mei_msg_hdr *hdr,
624 return dev->ops->write(dev, hdr, buf);
627 static inline u32 mei_read_hdr(const struct mei_device *dev)
629 return dev->ops->read_hdr(dev);
632 static inline void mei_read_slots(struct mei_device *dev,
633 unsigned char *buf, unsigned long len)
635 dev->ops->read(dev, buf, len);
638 static inline int mei_count_full_read_slots(struct mei_device *dev)
640 return dev->ops->rdbuf_full_slots(dev);
643 bool mei_hbuf_acquire(struct mei_device *dev);
645 #if IS_ENABLED(CONFIG_DEBUG_FS)
646 int mei_dbgfs_register(struct mei_device *dev, const char *name);
647 void mei_dbgfs_deregister(struct mei_device *dev);
649 static inline int mei_dbgfs_register(struct mei_device *dev, const char *name)
653 static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
654 #endif /* CONFIG_DEBUG_FS */
656 int mei_register(struct mei_device *dev);
657 void mei_deregister(struct mei_device *dev);
659 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
660 #define MEI_HDR_PRM(hdr) \
661 (hdr)->host_addr, (hdr)->me_addr, \
662 (hdr)->length, (hdr)->internal, (hdr)->msg_complete