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: disconnect
136 * @MEI_FOP_DISCONNECT_RSP: disconnect response
138 enum mei_cb_file_ops
{
143 MEI_FOP_DISCONNECT_RSP
,
147 * Intel MEI message data struct
149 struct mei_msg_data
{
154 /* Maximum number of processed FW status registers */
155 #define MEI_FW_STATUS_MAX 2
158 * struct mei_fw_status - storage of FW status data
160 * @count: number of actually available elements in array
161 * @status: FW status registers
163 struct mei_fw_status
{
165 u32 status
[MEI_FW_STATUS_MAX
];
169 * struct mei_me_client - representation of me (fw) client
171 * @list: link in me client list
172 * @props: client properties
173 * @client_id: me client id
174 * @mei_flow_ctrl_creds: flow control credits
176 struct mei_me_client
{
177 struct list_head list
;
178 struct mei_client_properties props
;
180 u8 mei_flow_ctrl_creds
;
187 * struct mei_cl_cb - file operation callback structure
189 * @list: link in callback queue
190 * @cl: file client who is running this operation
191 * @fop_type: file operation type
192 * @request_buffer: buffer to store request data
193 * @response_buffer: buffer to store response data
194 * @buf_idx: last read index
195 * @read_time: last read operation time stamp (iamthif)
196 * @file_object: pointer to file structure
197 * @internal: communication between driver and FW flag
200 struct list_head list
;
202 enum mei_cb_file_ops fop_type
;
203 struct mei_msg_data request_buffer
;
204 struct mei_msg_data response_buffer
;
205 unsigned long buf_idx
;
206 unsigned long read_time
;
207 struct file
*file_object
;
212 * struct mei_cl - me client host representation
213 * carried in file->private_data
215 * @link: link in the clients list
216 * @dev: mei parent device
217 * @state: file operation state
218 * @tx_wait: wait queue for tx completion
219 * @rx_wait: wait queue for rx completion
220 * @wait: wait queue for management operation
221 * @status: connection status
222 * @cl_uuid: client uuid name
223 * @host_client_id: host id
224 * @me_client_id: me/fw id
225 * @mei_flow_ctrl_creds: transmit flow credentials
226 * @timer_count: watchdog timer for operation completion
227 * @reading_state: state of the rx
228 * @writing_state: state of the tx
229 * @read_cb: current pending reading callback
231 * @device: device on the mei client bus
232 * @device_link: link to bus clients
235 struct list_head link
;
236 struct mei_device
*dev
;
237 enum file_state state
;
238 wait_queue_head_t tx_wait
;
239 wait_queue_head_t rx_wait
;
240 wait_queue_head_t wait
;
245 u8 mei_flow_ctrl_creds
;
247 enum mei_file_transaction_states reading_state
;
248 enum mei_file_transaction_states writing_state
;
249 struct mei_cl_cb
*read_cb
;
251 /* MEI CL bus data */
252 struct mei_cl_device
*device
;
253 struct list_head device_link
;
256 /** struct mei_hw_ops
258 * @host_is_ready : query for host readiness
260 * @hw_is_ready : query if hw is ready
261 * @hw_reset : reset hw
262 * @hw_start : start hw after reset
263 * @hw_config : configure hw
265 * @fw_status : get fw status registers
266 * @pg_state : power gating state of the device
267 * @pg_is_enabled : is power gating enabled
269 * @intr_clear : clear pending interrupts
270 * @intr_enable : enable interrupts
271 * @intr_disable : disable interrupts
273 * @hbuf_free_slots : query for write buffer empty slots
274 * @hbuf_is_ready : query if write buffer is empty
275 * @hbuf_max_len : query for write buffer max len
277 * @write : write a message to FW
279 * @rdbuf_full_slots : query how many slots are filled
281 * @read_hdr : get first 4 bytes (header)
282 * @read : read a buffer from the FW
286 bool (*host_is_ready
)(struct mei_device
*dev
);
288 bool (*hw_is_ready
)(struct mei_device
*dev
);
289 int (*hw_reset
)(struct mei_device
*dev
, bool enable
);
290 int (*hw_start
)(struct mei_device
*dev
);
291 void (*hw_config
)(struct mei_device
*dev
);
294 int (*fw_status
)(struct mei_device
*dev
, struct mei_fw_status
*fw_sts
);
295 enum mei_pg_state (*pg_state
)(struct mei_device
*dev
);
296 bool (*pg_is_enabled
)(struct mei_device
*dev
);
298 void (*intr_clear
)(struct mei_device
*dev
);
299 void (*intr_enable
)(struct mei_device
*dev
);
300 void (*intr_disable
)(struct mei_device
*dev
);
302 int (*hbuf_free_slots
)(struct mei_device
*dev
);
303 bool (*hbuf_is_ready
)(struct mei_device
*dev
);
304 size_t (*hbuf_max_len
)(const struct mei_device
*dev
);
306 int (*write
)(struct mei_device
*dev
,
307 struct mei_msg_hdr
*hdr
,
310 int (*rdbuf_full_slots
)(struct mei_device
*dev
);
312 u32 (*read_hdr
)(const struct mei_device
*dev
);
313 int (*read
)(struct mei_device
*dev
,
314 unsigned char *buf
, unsigned long len
);
320 * struct mei_cl_ops - MEI CL device ops
321 * This structure allows ME host clients to implement technology
322 * specific operations.
324 * @enable: Enable an MEI CL device. Some devices require specific
325 * HECI commands to initialize completely.
326 * @disable: Disable an MEI CL device.
327 * @send: Tx hook for the device. This allows ME host clients to trap
328 * the device driver buffers before actually physically
329 * pushing it to the ME.
330 * @recv: Rx hook for the device. This allows ME host clients to trap the
331 * ME buffers before forwarding them to the device driver.
334 int (*enable
)(struct mei_cl_device
*device
);
335 int (*disable
)(struct mei_cl_device
*device
);
336 int (*send
)(struct mei_cl_device
*device
, u8
*buf
, size_t length
);
337 int (*recv
)(struct mei_cl_device
*device
, u8
*buf
, size_t length
);
340 struct mei_cl_device
*mei_cl_add_device(struct mei_device
*dev
,
341 uuid_le uuid
, char *name
,
342 struct mei_cl_ops
*ops
);
343 void mei_cl_remove_device(struct mei_cl_device
*device
);
345 int __mei_cl_async_send(struct mei_cl
*cl
, u8
*buf
, size_t length
);
346 int __mei_cl_send(struct mei_cl
*cl
, u8
*buf
, size_t length
);
347 int __mei_cl_recv(struct mei_cl
*cl
, u8
*buf
, size_t length
);
348 void mei_cl_bus_rx_event(struct mei_cl
*cl
);
349 void mei_cl_bus_remove_devices(struct mei_device
*dev
);
350 int mei_cl_bus_init(void);
351 void mei_cl_bus_exit(void);
352 struct mei_cl
*mei_cl_bus_find_cl_by_uuid(struct mei_device
*dev
, uuid_le uuid
);
356 * struct mei_cl_device - MEI device handle
357 * An mei_cl_device pointer is returned from mei_add_device()
358 * and links MEI bus clients to their actual ME host client pointer.
359 * Drivers for MEI devices will get an mei_cl_device pointer
360 * when being probed and shall use it for doing ME bus I/O.
362 * @dev: linux driver model device pointer
364 * @ops: ME transport ops
365 * @event_work: async work to execute event callback
366 * @event_cb: Drivers register this callback to get asynchronous ME
367 * events (e.g. Rx buffer pending) notifications.
368 * @event_context: event callback run context
369 * @events: Events bitmask sent to the driver.
370 * @priv_data: client private data
372 struct mei_cl_device
{
377 const struct mei_cl_ops
*ops
;
379 struct work_struct event_work
;
380 mei_cl_event_cb_t event_cb
;
382 unsigned long events
;
389 * enum mei_pg_event - power gating transition events
391 * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition
392 * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete
393 * @MEI_PG_EVENT_RECEIVED: the driver received pg event
398 MEI_PG_EVENT_RECEIVED
,
402 * enum mei_pg_state - device internal power gating state
404 * @MEI_PG_OFF: device is not power gated - it is active
405 * @MEI_PG_ON: device is power gated - it is in lower power state
412 const char *mei_pg_state_str(enum mei_pg_state state
);
415 * struct mei_device - MEI private device struct
417 * @dev : device on a bus
418 * @cdev : character device
419 * @minor : minor number allocated for device
421 * @read_list : read completion list
422 * @write_list : write pending list
423 * @write_waiting_list : write completion list
424 * @ctrl_wr_list : pending control write list
425 * @ctrl_rd_list : pending control read list
427 * @file_list : list of opened handles
428 * @open_handle_count: number of opened handles
430 * @device_lock : big device lock
431 * @timer_work : MEI timer delayed work (timeouts)
433 * @recvd_hw_ready : hw ready message received flag
435 * @wait_hw_ready : wait queue for receive HW ready message form FW
436 * @wait_pg : wait queue for receive PG message from FW
437 * @wait_hbm_start : wait queue for receive HBM start message from FW
438 * @wait_stop_wd : wait queue for receive WD stop message from FW
440 * @reset_count : number of consecutive resets
441 * @dev_state : device state
442 * @hbm_state : state of host bus message protocol
443 * @init_clients_timer : HBM init handshake timeout
445 * @pg_event : power gating event
446 * @pg_domain : runtime PM domain
448 * @rd_msg_buf : control messages buffer
449 * @rd_msg_hdr : read message header storage
451 * @hbuf_depth : depth of hardware host/write buffer is slots
452 * @hbuf_is_ready : query if the host host/write buffer is ready
453 * @wr_msg : the buffer for hbm control messages
455 * @version : HBM protocol version in use
456 * @hbm_f_pg_supported : hbm feature pgi protocol
458 * @me_clients : list of FW clients
459 * @me_clients_map : FW clients bit map
460 * @host_clients_map : host clients id pool
461 * @me_client_index : last FW client index in enumeration
463 * @wd_cl : watchdog client
464 * @wd_state : watchdog client state
465 * @wd_pending : watchdog command is pending
466 * @wd_timeout : watchdog expiration timeout
467 * @wd_data : watchdog message buffer
469 * @amthif_cmd_list : amthif list for cmd waiting
470 * @amthif_rd_complete_list : amthif list for reading completed cmd data
471 * @iamthif_file_object : file for current amthif operation
472 * @iamthif_cl : amthif host client
473 * @iamthif_current_cb : amthif current operation callback
474 * @iamthif_open_count : number of opened amthif connections
475 * @iamthif_mtu : amthif client max message length
476 * @iamthif_timer : time stamp of current amthif command completion
477 * @iamthif_stall_timer : timer to detect amthif hang
478 * @iamthif_msg_buf : amthif current message buffer
479 * @iamthif_msg_buf_size : size of current amthif message request buffer
480 * @iamthif_msg_buf_index : current index in amthif message request buffer
481 * @iamthif_state : amthif processor state
482 * @iamthif_flow_control_pending: amthif waits for flow control
483 * @iamthif_ioctl : wait for completion if amthif control message
484 * @iamthif_canceled : current amthif command is canceled
486 * @init_work : work item for the device init
487 * @reset_work : work item for the device reset
489 * @device_list : mei client bus list
491 * @dbgfs_dir : debugfs mei root directory
493 * @ops: : hw specific operations
494 * @hw : hw specific data
501 struct mei_cl_cb read_list
;
502 struct mei_cl_cb write_list
;
503 struct mei_cl_cb write_waiting_list
;
504 struct mei_cl_cb ctrl_wr_list
;
505 struct mei_cl_cb ctrl_rd_list
;
507 struct list_head file_list
;
508 long open_handle_count
;
510 struct mutex device_lock
;
511 struct delayed_work timer_work
;
515 * waiting queue for receive message from FW
517 wait_queue_head_t wait_hw_ready
;
518 wait_queue_head_t wait_pg
;
519 wait_queue_head_t wait_hbm_start
;
520 wait_queue_head_t wait_stop_wd
;
525 unsigned long reset_count
;
526 enum mei_dev_state dev_state
;
527 enum mei_hbm_state hbm_state
;
528 u16 init_clients_timer
;
531 * Power Gating support
533 enum mei_pg_event pg_event
;
534 #ifdef CONFIG_PM_RUNTIME
535 struct dev_pm_domain pg_domain
;
536 #endif /* CONFIG_PM_RUNTIME */
538 unsigned char rd_msg_buf
[MEI_RD_MSG_BUF_SIZE
];
545 /* used for control messages */
547 struct mei_msg_hdr hdr
;
548 unsigned char data
[128];
551 struct hbm_version version
;
552 unsigned int hbm_f_pg_supported
:1;
554 struct list_head me_clients
;
555 DECLARE_BITMAP(me_clients_map
, MEI_CLIENTS_MAX
);
556 DECLARE_BITMAP(host_clients_map
, MEI_CLIENTS_MAX
);
557 unsigned long me_client_index
;
560 enum mei_wd_states wd_state
;
563 unsigned char wd_data
[MEI_WD_START_MSG_SIZE
];
566 /* amthif list for cmd waiting */
567 struct mei_cl_cb amthif_cmd_list
;
568 /* driver managed amthif list for reading completed amthif cmd data */
569 struct mei_cl_cb amthif_rd_complete_list
;
570 struct file
*iamthif_file_object
;
571 struct mei_cl iamthif_cl
;
572 struct mei_cl_cb
*iamthif_current_cb
;
573 long iamthif_open_count
;
575 unsigned long iamthif_timer
;
576 u32 iamthif_stall_timer
;
577 unsigned char *iamthif_msg_buf
; /* Note: memory has to be allocated */
578 u32 iamthif_msg_buf_size
;
579 u32 iamthif_msg_buf_index
;
580 enum iamthif_states iamthif_state
;
581 bool iamthif_flow_control_pending
;
583 bool iamthif_canceled
;
585 struct work_struct init_work
;
586 struct work_struct reset_work
;
588 /* List of bus devices */
589 struct list_head device_list
;
591 #if IS_ENABLED(CONFIG_DEBUG_FS)
592 struct dentry
*dbgfs_dir
;
593 #endif /* CONFIG_DEBUG_FS */
596 const struct mei_hw_ops
*ops
;
597 char hw
[0] __aligned(sizeof(void *));
600 static inline unsigned long mei_secs_to_jiffies(unsigned long sec
)
602 return msecs_to_jiffies(sec
* MSEC_PER_SEC
);
606 * mei_data2slots - get slots - number of (dwords) from a message length
607 * + size of the mei header
609 * @length: size of the messages in bytes
611 * Return: number of slots
613 static inline u32
mei_data2slots(size_t length
)
615 return DIV_ROUND_UP(sizeof(struct mei_msg_hdr
) + length
, 4);
619 * mei_slots2data - get data in slots - bytes from slots
621 * @slots: number of available slots
623 * Return: number of bytes in slots
625 static inline u32
mei_slots2data(int slots
)
631 * mei init function prototypes
633 void mei_device_init(struct mei_device
*dev
,
634 struct device
*device
,
635 const struct mei_hw_ops
*hw_ops
);
636 int mei_reset(struct mei_device
*dev
);
637 int mei_start(struct mei_device
*dev
);
638 int mei_restart(struct mei_device
*dev
);
639 void mei_stop(struct mei_device
*dev
);
640 void mei_cancel_work(struct mei_device
*dev
);
643 * MEI interrupt functions prototype
646 void mei_timer(struct work_struct
*work
);
647 int mei_irq_read_handler(struct mei_device
*dev
,
648 struct mei_cl_cb
*cmpl_list
, s32
*slots
);
650 int mei_irq_write_handler(struct mei_device
*dev
, struct mei_cl_cb
*cmpl_list
);
651 void mei_irq_compl_handler(struct mei_device
*dev
, struct mei_cl_cb
*cmpl_list
);
654 * AMTHIF - AMT Host Interface Functions
656 void mei_amthif_reset_params(struct mei_device
*dev
);
658 int mei_amthif_host_init(struct mei_device
*dev
);
660 int mei_amthif_write(struct mei_device
*dev
, struct mei_cl_cb
*priv_cb
);
662 int mei_amthif_read(struct mei_device
*dev
, struct file
*file
,
663 char __user
*ubuf
, size_t length
, loff_t
*offset
);
665 unsigned int mei_amthif_poll(struct mei_device
*dev
,
666 struct file
*file
, poll_table
*wait
);
668 int mei_amthif_release(struct mei_device
*dev
, struct file
*file
);
670 struct mei_cl_cb
*mei_amthif_find_read_list_entry(struct mei_device
*dev
,
673 void mei_amthif_run_next_cmd(struct mei_device
*dev
);
675 int mei_amthif_irq_write(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
676 struct mei_cl_cb
*cmpl_list
);
678 void mei_amthif_complete(struct mei_device
*dev
, struct mei_cl_cb
*cb
);
679 int mei_amthif_irq_read_msg(struct mei_device
*dev
,
680 struct mei_msg_hdr
*mei_hdr
,
681 struct mei_cl_cb
*complete_list
);
682 int mei_amthif_irq_read(struct mei_device
*dev
, s32
*slots
);
687 int mei_nfc_host_init(struct mei_device
*dev
);
688 void mei_nfc_host_exit(struct mei_device
*dev
);
693 extern const uuid_le mei_nfc_guid
;
695 int mei_wd_send(struct mei_device
*dev
);
696 int mei_wd_stop(struct mei_device
*dev
);
697 int mei_wd_host_init(struct mei_device
*dev
);
699 * mei_watchdog_register - Registering watchdog interface
700 * once we got connection to the WD Client
703 int mei_watchdog_register(struct mei_device
*dev
);
705 * mei_watchdog_unregister - Unregistering watchdog interface
708 void mei_watchdog_unregister(struct mei_device
*dev
);
711 * Register Access Function
715 static inline void mei_hw_config(struct mei_device
*dev
)
717 dev
->ops
->hw_config(dev
);
720 static inline enum mei_pg_state
mei_pg_state(struct mei_device
*dev
)
722 return dev
->ops
->pg_state(dev
);
725 static inline bool mei_pg_is_enabled(struct mei_device
*dev
)
727 return dev
->ops
->pg_is_enabled(dev
);
730 static inline int mei_hw_reset(struct mei_device
*dev
, bool enable
)
732 return dev
->ops
->hw_reset(dev
, enable
);
735 static inline int mei_hw_start(struct mei_device
*dev
)
737 return dev
->ops
->hw_start(dev
);
740 static inline void mei_clear_interrupts(struct mei_device
*dev
)
742 dev
->ops
->intr_clear(dev
);
745 static inline void mei_enable_interrupts(struct mei_device
*dev
)
747 dev
->ops
->intr_enable(dev
);
750 static inline void mei_disable_interrupts(struct mei_device
*dev
)
752 dev
->ops
->intr_disable(dev
);
755 static inline bool mei_host_is_ready(struct mei_device
*dev
)
757 return dev
->ops
->host_is_ready(dev
);
759 static inline bool mei_hw_is_ready(struct mei_device
*dev
)
761 return dev
->ops
->hw_is_ready(dev
);
764 static inline bool mei_hbuf_is_ready(struct mei_device
*dev
)
766 return dev
->ops
->hbuf_is_ready(dev
);
769 static inline int mei_hbuf_empty_slots(struct mei_device
*dev
)
771 return dev
->ops
->hbuf_free_slots(dev
);
774 static inline size_t mei_hbuf_max_len(const struct mei_device
*dev
)
776 return dev
->ops
->hbuf_max_len(dev
);
779 static inline int mei_write_message(struct mei_device
*dev
,
780 struct mei_msg_hdr
*hdr
,
783 return dev
->ops
->write(dev
, hdr
, buf
);
786 static inline u32
mei_read_hdr(const struct mei_device
*dev
)
788 return dev
->ops
->read_hdr(dev
);
791 static inline void mei_read_slots(struct mei_device
*dev
,
792 unsigned char *buf
, unsigned long len
)
794 dev
->ops
->read(dev
, buf
, len
);
797 static inline int mei_count_full_read_slots(struct mei_device
*dev
)
799 return dev
->ops
->rdbuf_full_slots(dev
);
802 static inline int mei_fw_status(struct mei_device
*dev
,
803 struct mei_fw_status
*fw_status
)
805 return dev
->ops
->fw_status(dev
, fw_status
);
808 #define FW_STS_FMT "%08X %08X"
809 #define FW_STS_PRM(fw_status) \
810 (fw_status).count > 0 ? (fw_status).status[0] : 0xDEADBEEF, \
811 (fw_status).count > 1 ? (fw_status).status[1] : 0xDEADBEEF
813 bool mei_hbuf_acquire(struct mei_device
*dev
);
815 bool mei_write_is_idle(struct mei_device
*dev
);
817 #if IS_ENABLED(CONFIG_DEBUG_FS)
818 int mei_dbgfs_register(struct mei_device
*dev
, const char *name
);
819 void mei_dbgfs_deregister(struct mei_device
*dev
);
821 static inline int mei_dbgfs_register(struct mei_device
*dev
, const char *name
)
825 static inline void mei_dbgfs_deregister(struct mei_device
*dev
) {}
826 #endif /* CONFIG_DEBUG_FS */
828 int mei_register(struct mei_device
*dev
, struct device
*parent
);
829 void mei_deregister(struct mei_device
*dev
);
831 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
832 #define MEI_HDR_PRM(hdr) \
833 (hdr)->host_addr, (hdr)->me_addr, \
834 (hdr)->length, (hdr)->internal, (hdr)->msg_complete