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 Messages
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
;
184 /* MEI client instance carried as file->private_data*/
186 struct list_head link
;
187 struct mei_device
*dev
;
188 enum file_state state
;
189 wait_queue_head_t tx_wait
;
190 wait_queue_head_t rx_wait
;
191 wait_queue_head_t wait
;
193 /* ID of client connected */
196 u8 mei_flow_ctrl_creds
;
198 enum mei_file_transaction_states reading_state
;
199 enum mei_file_transaction_states writing_state
;
200 struct mei_cl_cb
*read_cb
;
202 /* MEI CL bus data */
203 struct mei_cl_device
*device
;
204 struct list_head device_link
;
208 /** struct mei_hw_ops
210 * @host_is_ready - query for host readiness
212 * @hw_is_ready - query if hw is ready
213 * @hw_reset - reset hw
214 * @hw_start - start hw after reset
215 * @hw_config - configure hw
217 * @intr_clear - clear pending interrupts
218 * @intr_enable - enable interrupts
219 * @intr_disable - disable interrupts
221 * @hbuf_free_slots - query for write buffer empty slots
222 * @hbuf_is_ready - query if write buffer is empty
223 * @hbuf_max_len - query for write buffer max len
225 * @write - write a message to FW
227 * @rdbuf_full_slots - query how many slots are filled
229 * @read_hdr - get first 4 bytes (header)
230 * @read - read a buffer from the FW
234 bool (*host_is_ready
) (struct mei_device
*dev
);
236 bool (*hw_is_ready
) (struct mei_device
*dev
);
237 int (*hw_reset
) (struct mei_device
*dev
, bool enable
);
238 int (*hw_start
) (struct mei_device
*dev
);
239 void (*hw_config
) (struct mei_device
*dev
);
241 void (*intr_clear
) (struct mei_device
*dev
);
242 void (*intr_enable
) (struct mei_device
*dev
);
243 void (*intr_disable
) (struct mei_device
*dev
);
245 int (*hbuf_free_slots
) (struct mei_device
*dev
);
246 bool (*hbuf_is_ready
) (struct mei_device
*dev
);
247 size_t (*hbuf_max_len
) (const struct mei_device
*dev
);
249 int (*write
)(struct mei_device
*dev
,
250 struct mei_msg_hdr
*hdr
,
253 int (*rdbuf_full_slots
)(struct mei_device
*dev
);
255 u32 (*read_hdr
)(const struct mei_device
*dev
);
256 int (*read
) (struct mei_device
*dev
,
257 unsigned char *buf
, unsigned long len
);
263 * struct mei_cl_ops - MEI CL device ops
264 * This structure allows ME host clients to implement technology
265 * specific operations.
267 * @enable: Enable an MEI CL device. Some devices require specific
268 * HECI commands to initialize completely.
269 * @disable: Disable an MEI CL device.
270 * @send: Tx hook for the device. This allows ME host clients to trap
271 * the device driver buffers before actually physically
272 * pushing it to the ME.
273 * @recv: Rx hook for the device. This allows ME host clients to trap the
274 * ME buffers before forwarding them to the device driver.
277 int (*enable
)(struct mei_cl_device
*device
);
278 int (*disable
)(struct mei_cl_device
*device
);
279 int (*send
)(struct mei_cl_device
*device
, u8
*buf
, size_t length
);
280 int (*recv
)(struct mei_cl_device
*device
, u8
*buf
, size_t length
);
283 struct mei_cl_device
*mei_cl_add_device(struct mei_device
*dev
,
284 uuid_le uuid
, char *name
,
285 struct mei_cl_ops
*ops
);
286 void mei_cl_remove_device(struct mei_cl_device
*device
);
288 int __mei_cl_async_send(struct mei_cl
*cl
, u8
*buf
, size_t length
);
289 int __mei_cl_send(struct mei_cl
*cl
, u8
*buf
, size_t length
);
290 int __mei_cl_recv(struct mei_cl
*cl
, u8
*buf
, size_t length
);
291 void mei_cl_bus_rx_event(struct mei_cl
*cl
);
292 int mei_cl_bus_init(void);
293 void mei_cl_bus_exit(void);
297 * struct mei_cl_device - MEI device handle
298 * An mei_cl_device pointer is returned from mei_add_device()
299 * and links MEI bus clients to their actual ME host client pointer.
300 * Drivers for MEI devices will get an mei_cl_device pointer
301 * when being probed and shall use it for doing ME bus I/O.
303 * @dev: linux driver model device pointer
304 * @uuid: me client uuid
306 * @ops: ME transport ops
307 * @event_cb: Drivers register this callback to get asynchronous ME
308 * events (e.g. Rx buffer pending) notifications.
309 * @events: Events bitmask sent to the driver.
310 * @priv_data: client private data
312 struct mei_cl_device
{
317 const struct mei_cl_ops
*ops
;
319 struct work_struct event_work
;
320 mei_cl_event_cb_t event_cb
;
322 unsigned long events
;
328 * struct mei_device - MEI private device struct
330 * @hbm_state - state of host bus message protocol
331 * @mem_addr - mem mapped base register address
333 * @hbuf_depth - depth of hardware host/write buffer is slots
334 * @hbuf_is_ready - query if the host host/write buffer is ready
335 * @wr_msg - the buffer for hbm control messages
336 * @wr_ext_msg - the buffer for hbm control responses (set in read cycle)
339 struct pci_dev
*pdev
; /* pointer to pci device struct */
343 /* array of pointers to aio lists */
344 struct mei_cl_cb read_list
; /* driver read queue */
345 struct mei_cl_cb write_list
; /* driver write queue */
346 struct mei_cl_cb write_waiting_list
; /* write waiting queue */
347 struct mei_cl_cb ctrl_wr_list
; /* managed write IOCTL list */
348 struct mei_cl_cb ctrl_rd_list
; /* managed read IOCTL list */
353 struct list_head file_list
;
354 long open_handle_count
;
357 * lock for the device
359 struct mutex device_lock
; /* device lock */
360 struct delayed_work timer_work
; /* MEI timer delayed work (timeouts) */
364 * waiting queue for receive message from FW
366 wait_queue_head_t wait_hw_ready
;
367 wait_queue_head_t wait_recvd_msg
;
368 wait_queue_head_t wait_stop_wd
;
373 enum mei_dev_state dev_state
;
374 enum mei_hbm_state hbm_state
;
375 u16 init_clients_timer
;
377 unsigned char rd_msg_buf
[MEI_RD_MSG_BUF_SIZE
]; /* control messages */
384 /* used for control messages */
386 struct mei_msg_hdr hdr
;
387 unsigned char data
[128];
391 struct mei_msg_hdr hdr
;
392 unsigned char data
[4]; /* All HBM messages are 4 bytes */
393 } wr_ext_msg
; /* for control responses */
395 struct hbm_version version
;
397 struct mei_me_client
*me_clients
; /* Note: memory has to be allocated */
398 DECLARE_BITMAP(me_clients_map
, MEI_CLIENTS_MAX
);
399 DECLARE_BITMAP(host_clients_map
, MEI_CLIENTS_MAX
);
400 unsigned long me_clients_num
;
401 unsigned long me_client_presentation_num
;
402 unsigned long me_client_index
;
405 enum mei_wd_states wd_state
;
408 unsigned char wd_data
[MEI_WD_START_MSG_SIZE
];
411 /* amthif list for cmd waiting */
412 struct mei_cl_cb amthif_cmd_list
;
413 /* driver managed amthif list for reading completed amthif cmd data */
414 struct mei_cl_cb amthif_rd_complete_list
;
415 struct file
*iamthif_file_object
;
416 struct mei_cl iamthif_cl
;
417 struct mei_cl_cb
*iamthif_current_cb
;
418 long iamthif_open_count
;
420 unsigned long iamthif_timer
;
421 u32 iamthif_stall_timer
;
422 unsigned char *iamthif_msg_buf
; /* Note: memory has to be allocated */
423 u32 iamthif_msg_buf_size
;
424 u32 iamthif_msg_buf_index
;
425 enum iamthif_states iamthif_state
;
426 bool iamthif_flow_control_pending
;
428 bool iamthif_canceled
;
430 struct work_struct init_work
;
431 struct work_struct reset_work
;
433 /* List of bus devices */
434 struct list_head device_list
;
436 #if IS_ENABLED(CONFIG_DEBUG_FS)
437 struct dentry
*dbgfs_dir
;
438 #endif /* CONFIG_DEBUG_FS */
441 const struct mei_hw_ops
*ops
;
442 char hw
[0] __aligned(sizeof(void *));
445 static inline unsigned long mei_secs_to_jiffies(unsigned long sec
)
447 return msecs_to_jiffies(sec
* MSEC_PER_SEC
);
451 * mei_data2slots - get slots - number of (dwords) from a message length
452 * + size of the mei header
453 * @length - size of the messages in bytes
454 * returns - number of slots
456 static inline u32
mei_data2slots(size_t length
)
458 return DIV_ROUND_UP(sizeof(struct mei_msg_hdr
) + length
, 4);
462 * mei_slots2data- get data in slots - bytes from slots
463 * @slots - number of available slots
464 * returns - number of bytes in slots
466 static inline u32
mei_slots2data(int slots
)
472 * mei init function prototypes
474 void mei_device_init(struct mei_device
*dev
);
475 int mei_reset(struct mei_device
*dev
);
476 int mei_start(struct mei_device
*dev
);
477 int mei_restart(struct mei_device
*dev
);
478 void mei_stop(struct mei_device
*dev
);
479 void mei_cancel_work(struct mei_device
*dev
);
482 * MEI interrupt functions prototype
485 void mei_timer(struct work_struct
*work
);
486 int mei_irq_read_handler(struct mei_device
*dev
,
487 struct mei_cl_cb
*cmpl_list
, s32
*slots
);
489 int mei_irq_write_handler(struct mei_device
*dev
, struct mei_cl_cb
*cmpl_list
);
490 void mei_irq_compl_handler(struct mei_device
*dev
, struct mei_cl_cb
*cmpl_list
);
493 * AMTHIF - AMT Host Interface Functions
495 void mei_amthif_reset_params(struct mei_device
*dev
);
497 int mei_amthif_host_init(struct mei_device
*dev
);
499 int mei_amthif_write(struct mei_device
*dev
, struct mei_cl_cb
*priv_cb
);
501 int mei_amthif_read(struct mei_device
*dev
, struct file
*file
,
502 char __user
*ubuf
, size_t length
, loff_t
*offset
);
504 unsigned int mei_amthif_poll(struct mei_device
*dev
,
505 struct file
*file
, poll_table
*wait
);
507 int mei_amthif_release(struct mei_device
*dev
, struct file
*file
);
509 struct mei_cl_cb
*mei_amthif_find_read_list_entry(struct mei_device
*dev
,
512 void mei_amthif_run_next_cmd(struct mei_device
*dev
);
514 int mei_amthif_irq_write_complete(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
515 s32
*slots
, struct mei_cl_cb
*cmpl_list
);
517 void mei_amthif_complete(struct mei_device
*dev
, struct mei_cl_cb
*cb
);
518 int mei_amthif_irq_read_msg(struct mei_device
*dev
,
519 struct mei_msg_hdr
*mei_hdr
,
520 struct mei_cl_cb
*complete_list
);
521 int mei_amthif_irq_read(struct mei_device
*dev
, s32
*slots
);
526 int mei_nfc_host_init(struct mei_device
*dev
);
527 void mei_nfc_host_exit(struct mei_device
*dev
);
532 extern const uuid_le mei_nfc_guid
;
534 int mei_wd_send(struct mei_device
*dev
);
535 int mei_wd_stop(struct mei_device
*dev
);
536 int mei_wd_host_init(struct mei_device
*dev
);
538 * mei_watchdog_register - Registering watchdog interface
539 * once we got connection to the WD Client
542 void mei_watchdog_register(struct mei_device
*dev
);
544 * mei_watchdog_unregister - Unregistering watchdog interface
547 void mei_watchdog_unregister(struct mei_device
*dev
);
550 * Register Access Function
553 static inline void mei_hw_config(struct mei_device
*dev
)
555 dev
->ops
->hw_config(dev
);
557 static inline int mei_hw_reset(struct mei_device
*dev
, bool enable
)
559 return dev
->ops
->hw_reset(dev
, enable
);
562 static inline int mei_hw_start(struct mei_device
*dev
)
564 return dev
->ops
->hw_start(dev
);
567 static inline void mei_clear_interrupts(struct mei_device
*dev
)
569 dev
->ops
->intr_clear(dev
);
572 static inline void mei_enable_interrupts(struct mei_device
*dev
)
574 dev
->ops
->intr_enable(dev
);
577 static inline void mei_disable_interrupts(struct mei_device
*dev
)
579 dev
->ops
->intr_disable(dev
);
582 static inline bool mei_host_is_ready(struct mei_device
*dev
)
584 return dev
->ops
->host_is_ready(dev
);
586 static inline bool mei_hw_is_ready(struct mei_device
*dev
)
588 return dev
->ops
->hw_is_ready(dev
);
591 static inline bool mei_hbuf_is_ready(struct mei_device
*dev
)
593 return dev
->ops
->hbuf_is_ready(dev
);
596 static inline int mei_hbuf_empty_slots(struct mei_device
*dev
)
598 return dev
->ops
->hbuf_free_slots(dev
);
601 static inline size_t mei_hbuf_max_len(const struct mei_device
*dev
)
603 return dev
->ops
->hbuf_max_len(dev
);
606 static inline int mei_write_message(struct mei_device
*dev
,
607 struct mei_msg_hdr
*hdr
,
610 return dev
->ops
->write(dev
, hdr
, buf
);
613 static inline u32
mei_read_hdr(const struct mei_device
*dev
)
615 return dev
->ops
->read_hdr(dev
);
618 static inline void mei_read_slots(struct mei_device
*dev
,
619 unsigned char *buf
, unsigned long len
)
621 dev
->ops
->read(dev
, buf
, len
);
624 static inline int mei_count_full_read_slots(struct mei_device
*dev
)
626 return dev
->ops
->rdbuf_full_slots(dev
);
629 #if IS_ENABLED(CONFIG_DEBUG_FS)
630 int mei_dbgfs_register(struct mei_device
*dev
, const char *name
);
631 void mei_dbgfs_deregister(struct mei_device
*dev
);
633 static inline int mei_dbgfs_register(struct mei_device
*dev
, const char *name
)
637 static inline void mei_dbgfs_deregister(struct mei_device
*dev
) {}
638 #endif /* CONFIG_DEBUG_FS */
640 int mei_register(struct mei_device
*dev
);
641 void mei_deregister(struct mei_device
*dev
);
643 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
644 #define MEI_HDR_PRM(hdr) \
645 (hdr)->host_addr, (hdr)->me_addr, \
646 (hdr)->length, (hdr)->internal, (hdr)->msg_complete