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 * Watchdog independence state message
61 extern const u8 mei_wd_state_independence_msg
[3][4];
64 * Number of Maximum MEI Clients
66 #define MEI_CLIENTS_MAX 256
69 * Number of File descriptors/handles
70 * that can be opened to the driver.
72 * Limit to 255: 256 Total Clients
73 * minus internal client for MEI Bus Messags
75 #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
78 * Internal Clients Number
80 #define MEI_HOST_CLIENT_ID_ANY (-1)
81 #define MEI_HBM_HOST_CLIENT_ID 0 /* not used, just for documentation */
82 #define MEI_WD_HOST_CLIENT_ID 1
83 #define MEI_IAMTHIF_HOST_CLIENT_ID 2
88 MEI_FILE_INITIALIZING
= 0,
91 MEI_FILE_DISCONNECTING
,
95 /* MEI device states */
97 MEI_DEV_INITIALIZING
= 0,
106 const char *mei_dev_state_str(int state
);
108 enum iamthif_states
{
111 MEI_IAMTHIF_FLOW_CONTROL
,
113 MEI_IAMTHIF_READ_COMPLETE
116 enum mei_file_transaction_states
{
132 * enum mei_cb_file_ops - file operation associated with the callback
133 * @MEI_FOP_READ - read
134 * @MEI_FOP_WRITE - write
135 * @MEI_FOP_IOCTL - ioctl
136 * @MEI_FOP_OPEN - open
137 * @MEI_FOP_CLOSE - close
139 enum mei_cb_file_ops
{
148 * Intel MEI message data struct
150 struct mei_msg_data
{
156 * struct mei_me_client - representation of me (fw) client
158 * @props - client properties
159 * @client_id - me client id
160 * @mei_flow_ctrl_creds - flow control credits
162 struct mei_me_client
{
163 struct mei_client_properties props
;
165 u8 mei_flow_ctrl_creds
;
172 * struct mei_cl_cb - file operation callback structure
174 * @cl - file client who is running this operation
175 * @fop_type - file operation type
178 struct list_head list
;
180 enum mei_cb_file_ops fop_type
;
181 struct mei_msg_data request_buffer
;
182 struct mei_msg_data response_buffer
;
183 unsigned long buf_idx
;
184 unsigned long read_time
;
185 struct file
*file_object
;
188 /* MEI client instance carried as file->pirvate_data*/
190 struct list_head link
;
191 struct mei_device
*dev
;
192 enum file_state state
;
193 wait_queue_head_t tx_wait
;
194 wait_queue_head_t rx_wait
;
195 wait_queue_head_t wait
;
197 /* ID of client connected */
200 u8 mei_flow_ctrl_creds
;
202 enum mei_file_transaction_states reading_state
;
203 enum mei_file_transaction_states writing_state
;
205 struct mei_cl_cb
*read_cb
;
207 /* MEI CL bus data */
208 struct mei_cl_device
*device
;
209 struct list_head device_link
;
213 /** struct mei_hw_ops
215 * @host_is_ready - query for host readiness
217 * @hw_is_ready - query if hw is ready
218 * @hw_reset - reset hw
219 * @hw_start - start hw after reset
220 * @hw_config - configure hw
222 * @intr_clear - clear pending interrupts
223 * @intr_enable - enable interrupts
224 * @intr_disable - disable interrupts
226 * @hbuf_free_slots - query for write buffer empty slots
227 * @hbuf_is_ready - query if write buffer is empty
228 * @hbuf_max_len - query for write buffer max len
230 * @write - write a message to FW
232 * @rdbuf_full_slots - query how many slots are filled
234 * @read_hdr - get first 4 bytes (header)
235 * @read - read a buffer from the FW
239 bool (*host_is_ready
) (struct mei_device
*dev
);
241 bool (*hw_is_ready
) (struct mei_device
*dev
);
242 void (*hw_reset
) (struct mei_device
*dev
, bool enable
);
243 int (*hw_start
) (struct mei_device
*dev
);
244 void (*hw_config
) (struct mei_device
*dev
);
246 void (*intr_clear
) (struct mei_device
*dev
);
247 void (*intr_enable
) (struct mei_device
*dev
);
248 void (*intr_disable
) (struct mei_device
*dev
);
250 int (*hbuf_free_slots
) (struct mei_device
*dev
);
251 bool (*hbuf_is_ready
) (struct mei_device
*dev
);
252 size_t (*hbuf_max_len
) (const struct mei_device
*dev
);
254 int (*write
)(struct mei_device
*dev
,
255 struct mei_msg_hdr
*hdr
,
258 int (*rdbuf_full_slots
)(struct mei_device
*dev
);
260 u32 (*read_hdr
)(const struct mei_device
*dev
);
261 int (*read
) (struct mei_device
*dev
,
262 unsigned char *buf
, unsigned long len
);
268 * struct mei_cl_ops - MEI CL device ops
269 * This structure allows ME host clients to implement technology
270 * specific operations.
272 * @enable: Enable an MEI CL device. Some devices require specific
273 * HECI commands to initialize completely.
274 * @disable: Disable an MEI CL device.
275 * @send: Tx hook for the device. This allows ME host clients to trap
276 * the device driver buffers before actually physically
277 * pushing it to the ME.
278 * @recv: Rx hook for the device. This allows ME host clients to trap the
279 * ME buffers before forwarding them to the device driver.
282 int (*enable
)(struct mei_cl_device
*device
);
283 int (*disable
)(struct mei_cl_device
*device
);
284 int (*send
)(struct mei_cl_device
*device
, u8
*buf
, size_t length
);
285 int (*recv
)(struct mei_cl_device
*device
, u8
*buf
, size_t length
);
288 struct mei_cl_device
*mei_cl_add_device(struct mei_device
*dev
,
289 uuid_le uuid
, char *name
,
290 struct mei_cl_ops
*ops
);
291 void mei_cl_remove_device(struct mei_cl_device
*device
);
293 int __mei_cl_async_send(struct mei_cl
*cl
, u8
*buf
, size_t length
);
294 int __mei_cl_send(struct mei_cl
*cl
, u8
*buf
, size_t length
);
295 int __mei_cl_recv(struct mei_cl
*cl
, u8
*buf
, size_t length
);
296 void mei_cl_bus_rx_event(struct mei_cl
*cl
);
297 int mei_cl_bus_init(void);
298 void mei_cl_bus_exit(void);
302 * struct mei_cl_device - MEI device handle
303 * An mei_cl_device pointer is returned from mei_add_device()
304 * and links MEI bus clients to their actual ME host client pointer.
305 * Drivers for MEI devices will get an mei_cl_device pointer
306 * when being probed and shall use it for doing ME bus I/O.
308 * @dev: linux driver model device pointer
309 * @uuid: me client uuid
311 * @ops: ME transport ops
312 * @event_cb: Drivers register this callback to get asynchronous ME
313 * events (e.g. Rx buffer pending) notifications.
314 * @events: Events bitmask sent to the driver.
315 * @priv_data: client private data
317 struct mei_cl_device
{
322 const struct mei_cl_ops
*ops
;
324 struct work_struct event_work
;
325 mei_cl_event_cb_t event_cb
;
327 unsigned long events
;
333 * struct mei_device - MEI private device struct
335 * @hbm_state - state of host bus message protocol
336 * @mem_addr - mem mapped base register address
338 * @hbuf_depth - depth of hardware host/write buffer is slots
339 * @hbuf_is_ready - query if the host host/write buffer is ready
340 * @wr_msg - the buffer for hbm control messages
341 * @wr_ext_msg - the buffer for hbm control responses (set in read cycle)
344 struct pci_dev
*pdev
; /* pointer to pci device struct */
348 /* array of pointers to aio lists */
349 struct mei_cl_cb read_list
; /* driver read queue */
350 struct mei_cl_cb write_list
; /* driver write queue */
351 struct mei_cl_cb write_waiting_list
; /* write waiting queue */
352 struct mei_cl_cb ctrl_wr_list
; /* managed write IOCTL list */
353 struct mei_cl_cb ctrl_rd_list
; /* managed read IOCTL list */
358 struct list_head file_list
;
359 long open_handle_count
;
362 * lock for the device
364 struct mutex device_lock
; /* device lock */
365 struct delayed_work timer_work
; /* MEI timer delayed work (timeouts) */
369 * waiting queue for receive message from FW
371 wait_queue_head_t wait_hw_ready
;
372 wait_queue_head_t wait_recvd_msg
;
373 wait_queue_head_t wait_stop_wd
;
378 enum mei_dev_state dev_state
;
379 enum mei_hbm_state hbm_state
;
380 u16 init_clients_timer
;
382 unsigned char rd_msg_buf
[MEI_RD_MSG_BUF_SIZE
]; /* control messages */
389 /* used for control messages */
391 struct mei_msg_hdr hdr
;
392 unsigned char data
[128];
396 struct mei_msg_hdr hdr
;
397 unsigned char data
[4]; /* All HBM messages are 4 bytes */
398 } wr_ext_msg
; /* for control responses */
400 struct hbm_version version
;
402 struct mei_me_client
*me_clients
; /* Note: memory has to be allocated */
403 DECLARE_BITMAP(me_clients_map
, MEI_CLIENTS_MAX
);
404 DECLARE_BITMAP(host_clients_map
, MEI_CLIENTS_MAX
);
405 unsigned long me_clients_num
;
406 unsigned long me_client_presentation_num
;
407 unsigned long me_client_index
;
410 enum mei_wd_states wd_state
;
413 unsigned char wd_data
[MEI_WD_START_MSG_SIZE
];
416 /* amthif list for cmd waiting */
417 struct mei_cl_cb amthif_cmd_list
;
418 /* driver managed amthif list for reading completed amthif cmd data */
419 struct mei_cl_cb amthif_rd_complete_list
;
420 struct file
*iamthif_file_object
;
421 struct mei_cl iamthif_cl
;
422 struct mei_cl_cb
*iamthif_current_cb
;
424 unsigned long iamthif_timer
;
425 u32 iamthif_stall_timer
;
426 unsigned char *iamthif_msg_buf
; /* Note: memory has to be allocated */
427 u32 iamthif_msg_buf_size
;
428 u32 iamthif_msg_buf_index
;
429 enum iamthif_states iamthif_state
;
430 bool iamthif_flow_control_pending
;
432 bool iamthif_canceled
;
434 struct work_struct init_work
;
436 /* List of bus devices */
437 struct list_head device_list
;
439 #if IS_ENABLED(CONFIG_DEBUG_FS)
440 struct dentry
*dbgfs_dir
;
441 #endif /* CONFIG_DEBUG_FS */
444 const struct mei_hw_ops
*ops
;
445 char hw
[0] __aligned(sizeof(void *));
448 static inline unsigned long mei_secs_to_jiffies(unsigned long sec
)
450 return msecs_to_jiffies(sec
* MSEC_PER_SEC
);
454 * mei_data2slots - get slots - number of (dwords) from a message length
455 * + size of the mei header
456 * @length - size of the messages in bytes
457 * returns - number of slots
459 static inline u32
mei_data2slots(size_t length
)
461 return DIV_ROUND_UP(sizeof(struct mei_msg_hdr
) + length
, 4);
465 * mei init function prototypes
467 void mei_device_init(struct mei_device
*dev
);
468 void mei_reset(struct mei_device
*dev
, int interrupts
);
469 int mei_start(struct mei_device
*dev
);
470 void mei_stop(struct mei_device
*dev
);
473 * MEI interrupt functions prototype
476 void mei_timer(struct work_struct
*work
);
477 int mei_irq_read_handler(struct mei_device
*dev
,
478 struct mei_cl_cb
*cmpl_list
, s32
*slots
);
480 int mei_irq_write_handler(struct mei_device
*dev
, struct mei_cl_cb
*cmpl_list
);
481 void mei_irq_compl_handler(struct mei_device
*dev
, struct mei_cl_cb
*cmpl_list
);
484 * AMTHIF - AMT Host Interface Functions
486 void mei_amthif_reset_params(struct mei_device
*dev
);
488 int mei_amthif_host_init(struct mei_device
*dev
);
490 int mei_amthif_write(struct mei_device
*dev
, struct mei_cl_cb
*priv_cb
);
492 int mei_amthif_read(struct mei_device
*dev
, struct file
*file
,
493 char __user
*ubuf
, size_t length
, loff_t
*offset
);
495 unsigned int mei_amthif_poll(struct mei_device
*dev
,
496 struct file
*file
, poll_table
*wait
);
498 int mei_amthif_release(struct mei_device
*dev
, struct file
*file
);
500 struct mei_cl_cb
*mei_amthif_find_read_list_entry(struct mei_device
*dev
,
503 void mei_amthif_run_next_cmd(struct mei_device
*dev
);
505 int mei_amthif_irq_write_complete(struct mei_device
*dev
, s32
*slots
,
506 struct mei_cl_cb
*cb
, struct mei_cl_cb
*cmpl_list
);
508 void mei_amthif_complete(struct mei_device
*dev
, struct mei_cl_cb
*cb
);
509 int mei_amthif_irq_read_msg(struct mei_device
*dev
,
510 struct mei_msg_hdr
*mei_hdr
,
511 struct mei_cl_cb
*complete_list
);
512 int mei_amthif_irq_read(struct mei_device
*dev
, s32
*slots
);
517 int mei_nfc_host_init(struct mei_device
*dev
);
518 void mei_nfc_host_exit(void);
523 extern const uuid_le mei_nfc_guid
;
525 int mei_amthif_irq_write_complete(struct mei_device
*dev
, s32
*slots
,
526 struct mei_cl_cb
*cb
, struct mei_cl_cb
*cmpl_list
);
528 void mei_amthif_complete(struct mei_device
*dev
, struct mei_cl_cb
*cb
);
529 int mei_amthif_irq_read_message(struct mei_cl_cb
*complete_list
,
530 struct mei_device
*dev
, struct mei_msg_hdr
*mei_hdr
);
531 int mei_amthif_irq_read(struct mei_device
*dev
, s32
*slots
);
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 void mei_hw_reset(struct mei_device
*dev
, bool enable
)
559 dev
->ops
->hw_reset(dev
, enable
);
562 static inline void mei_hw_start(struct mei_device
*dev
)
564 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 comp=%1d"
644 #define MEI_HDR_PRM(hdr) \
645 (hdr)->host_addr, (hdr)->me_addr, \
646 (hdr)->length, (hdr)->msg_complete