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/cdev.h>
22 #include <linux/poll.h>
23 #include <linux/mei.h>
24 #include <linux/mei_cl_bus.h>
33 extern const uuid_le mei_amthif_guid
;
35 #define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32))
38 * Number of Maximum MEI Clients
40 #define MEI_CLIENTS_MAX 256
43 * maximum number of consecutive resets
45 #define MEI_MAX_CONSEC_RESET 3
48 * Number of File descriptors/handles
49 * that can be opened to the driver.
51 * Limit to 255: 256 Total Clients
52 * minus internal client for MEI Bus Messages
54 #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
58 MEI_FILE_INITIALIZING
= 0,
61 MEI_FILE_DISCONNECTING
,
62 MEI_FILE_DISCONNECT_REPLY
,
63 MEI_FILE_DISCONNECT_REQUIRED
,
64 MEI_FILE_DISCONNECTED
,
67 /* MEI device states */
69 MEI_DEV_INITIALIZING
= 0,
78 const char *mei_dev_state_str(int state
);
83 MEI_IAMTHIF_FLOW_CONTROL
,
85 MEI_IAMTHIF_READ_COMPLETE
88 enum mei_file_transaction_states
{
98 * enum mei_cb_file_ops - file operation associated with the callback
100 * @MEI_FOP_WRITE: write
101 * @MEI_FOP_CONNECT: connect
102 * @MEI_FOP_DISCONNECT: disconnect
103 * @MEI_FOP_DISCONNECT_RSP: disconnect response
104 * @MEI_FOP_NOTIFY_START: start notification
105 * @MEI_FOP_NOTIFY_STOP: stop notification
107 enum mei_cb_file_ops
{
112 MEI_FOP_DISCONNECT_RSP
,
113 MEI_FOP_NOTIFY_START
,
118 * Intel MEI message data struct
120 struct mei_msg_data
{
125 /* Maximum number of processed FW status registers */
126 #define MEI_FW_STATUS_MAX 6
127 /* Minimal buffer for FW status string (8 bytes in dw + space or '\0') */
128 #define MEI_FW_STATUS_STR_SZ (MEI_FW_STATUS_MAX * (8 + 1))
132 * struct mei_fw_status - storage of FW status data
134 * @count: number of actually available elements in array
135 * @status: FW status registers
137 struct mei_fw_status
{
139 u32 status
[MEI_FW_STATUS_MAX
];
143 * struct mei_me_client - representation of me (fw) client
145 * @list: link in me client list
146 * @refcnt: struct reference count
147 * @props: client properties
148 * @client_id: me client id
149 * @mei_flow_ctrl_creds: flow control credits
150 * @connect_count: number connections to this client
151 * @bus_added: added to bus
153 struct mei_me_client
{
154 struct list_head list
;
156 struct mei_client_properties props
;
158 u8 mei_flow_ctrl_creds
;
167 * struct mei_cl_cb - file operation callback structure
169 * @list: link in callback queue
170 * @cl: file client who is running this operation
171 * @fop_type: file operation type
172 * @buf: buffer for data associated with the callback
173 * @buf_idx: last read index
174 * @fp: pointer to file structure
175 * @status: io status of the cb
176 * @internal: communication between driver and FW flag
177 * @completed: the transfer or reception has completed
180 struct list_head list
;
182 enum mei_cb_file_ops fop_type
;
183 struct mei_msg_data buf
;
185 const struct file
*fp
;
192 * struct mei_cl - me client host representation
193 * carried in file->private_data
195 * @link: link in the clients list
196 * @dev: mei parent device
197 * @state: file operation state
198 * @tx_wait: wait queue for tx completion
199 * @rx_wait: wait queue for rx completion
200 * @wait: wait queue for management operation
201 * @ev_wait: notification wait queue
202 * @ev_async: event async notification
203 * @status: connection status
204 * @me_cl: fw client connected
205 * @host_client_id: host id
206 * @mei_flow_ctrl_creds: transmit flow credentials
207 * @timer_count: watchdog timer for operation completion
208 * @reserved: reserved for alignment
209 * @notify_en: notification - enabled/disabled
210 * @notify_ev: pending notification event
211 * @writing_state: state of the tx
212 * @rd_pending: pending read credits
213 * @rd_completed: completed read
215 * @cldev: device on the mei client bus
218 struct list_head link
;
219 struct mei_device
*dev
;
220 enum file_state state
;
221 wait_queue_head_t tx_wait
;
222 wait_queue_head_t rx_wait
;
223 wait_queue_head_t wait
;
224 wait_queue_head_t ev_wait
;
225 struct fasync_struct
*ev_async
;
227 struct mei_me_client
*me_cl
;
229 u8 mei_flow_ctrl_creds
;
234 enum mei_file_transaction_states writing_state
;
235 struct list_head rd_pending
;
236 struct list_head rd_completed
;
238 struct mei_cl_device
*cldev
;
242 * struct mei_hw_ops - hw specific ops
244 * @host_is_ready : query for host readiness
246 * @hw_is_ready : query if hw is ready
247 * @hw_reset : reset hw
248 * @hw_start : start hw after reset
249 * @hw_config : configure hw
251 * @fw_status : get fw status registers
252 * @pg_state : power gating state of the device
253 * @pg_in_transition : is device now in pg transition
254 * @pg_is_enabled : is power gating enabled
256 * @intr_clear : clear pending interrupts
257 * @intr_enable : enable interrupts
258 * @intr_disable : disable interrupts
260 * @hbuf_free_slots : query for write buffer empty slots
261 * @hbuf_is_ready : query if write buffer is empty
262 * @hbuf_max_len : query for write buffer max len
264 * @write : write a message to FW
266 * @rdbuf_full_slots : query how many slots are filled
268 * @read_hdr : get first 4 bytes (header)
269 * @read : read a buffer from the FW
273 bool (*host_is_ready
)(struct mei_device
*dev
);
275 bool (*hw_is_ready
)(struct mei_device
*dev
);
276 int (*hw_reset
)(struct mei_device
*dev
, bool enable
);
277 int (*hw_start
)(struct mei_device
*dev
);
278 void (*hw_config
)(struct mei_device
*dev
);
281 int (*fw_status
)(struct mei_device
*dev
, struct mei_fw_status
*fw_sts
);
282 enum mei_pg_state (*pg_state
)(struct mei_device
*dev
);
283 bool (*pg_in_transition
)(struct mei_device
*dev
);
284 bool (*pg_is_enabled
)(struct mei_device
*dev
);
286 void (*intr_clear
)(struct mei_device
*dev
);
287 void (*intr_enable
)(struct mei_device
*dev
);
288 void (*intr_disable
)(struct mei_device
*dev
);
290 int (*hbuf_free_slots
)(struct mei_device
*dev
);
291 bool (*hbuf_is_ready
)(struct mei_device
*dev
);
292 size_t (*hbuf_max_len
)(const struct mei_device
*dev
);
294 int (*write
)(struct mei_device
*dev
,
295 struct mei_msg_hdr
*hdr
,
298 int (*rdbuf_full_slots
)(struct mei_device
*dev
);
300 u32 (*read_hdr
)(const struct mei_device
*dev
);
301 int (*read
)(struct mei_device
*dev
,
302 unsigned char *buf
, unsigned long len
);
306 void mei_cl_bus_rescan(struct mei_device
*bus
);
307 void mei_cl_bus_rescan_work(struct work_struct
*work
);
308 void mei_cl_bus_dev_fixup(struct mei_cl_device
*dev
);
309 ssize_t
__mei_cl_send(struct mei_cl
*cl
, u8
*buf
, size_t length
,
311 ssize_t
__mei_cl_recv(struct mei_cl
*cl
, u8
*buf
, size_t length
);
312 bool mei_cl_bus_rx_event(struct mei_cl
*cl
);
313 bool mei_cl_bus_notify_event(struct mei_cl
*cl
);
314 void mei_cl_bus_remove_devices(struct mei_device
*bus
);
315 int mei_cl_bus_init(void);
316 void mei_cl_bus_exit(void);
319 * enum mei_pg_event - power gating transition events
321 * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition
322 * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete
323 * @MEI_PG_EVENT_RECEIVED: the driver received pg event
324 * @MEI_PG_EVENT_INTR_WAIT: the driver is waiting for a pg event interrupt
325 * @MEI_PG_EVENT_INTR_RECEIVED: the driver received pg event interrupt
330 MEI_PG_EVENT_RECEIVED
,
331 MEI_PG_EVENT_INTR_WAIT
,
332 MEI_PG_EVENT_INTR_RECEIVED
,
336 * enum mei_pg_state - device internal power gating state
338 * @MEI_PG_OFF: device is not power gated - it is active
339 * @MEI_PG_ON: device is power gated - it is in lower power state
346 const char *mei_pg_state_str(enum mei_pg_state state
);
349 * struct mei_device - MEI private device struct
351 * @dev : device on a bus
352 * @cdev : character device
353 * @minor : minor number allocated for device
355 * @write_list : write pending list
356 * @write_waiting_list : write completion list
357 * @ctrl_wr_list : pending control write list
358 * @ctrl_rd_list : pending control read list
360 * @file_list : list of opened handles
361 * @open_handle_count: number of opened handles
363 * @device_lock : big device lock
364 * @timer_work : MEI timer delayed work (timeouts)
366 * @recvd_hw_ready : hw ready message received flag
368 * @wait_hw_ready : wait queue for receive HW ready message form FW
369 * @wait_pg : wait queue for receive PG message from FW
370 * @wait_hbm_start : wait queue for receive HBM start message from FW
372 * @reset_count : number of consecutive resets
373 * @dev_state : device state
374 * @hbm_state : state of host bus message protocol
375 * @init_clients_timer : HBM init handshake timeout
377 * @pg_event : power gating event
378 * @pg_domain : runtime PM domain
380 * @rd_msg_buf : control messages buffer
381 * @rd_msg_hdr : read message header storage
383 * @hbuf_depth : depth of hardware host/write buffer is slots
384 * @hbuf_is_ready : query if the host host/write buffer is ready
385 * @wr_msg : the buffer for hbm control messages
387 * @version : HBM protocol version in use
388 * @hbm_f_pg_supported : hbm feature pgi protocol
389 * @hbm_f_dc_supported : hbm feature dynamic clients
390 * @hbm_f_dot_supported : hbm feature disconnect on timeout
391 * @hbm_f_ev_supported : hbm feature event notification
392 * @hbm_f_fa_supported : hbm feature fixed address client
393 * @hbm_f_ie_supported : hbm feature immediate reply to enum request
395 * @me_clients_rwsem: rw lock over me_clients list
396 * @me_clients : list of FW clients
397 * @me_clients_map : FW clients bit map
398 * @host_clients_map : host clients id pool
400 * @allow_fixed_address: allow user space to connect a fixed client
401 * @override_fixed_address: force allow fixed address behavior
403 * @amthif_cmd_list : amthif list for cmd waiting
404 * @iamthif_fp : file for current amthif operation
405 * @iamthif_cl : amthif host client
406 * @iamthif_current_cb : amthif current operation callback
407 * @iamthif_open_count : number of opened amthif connections
408 * @iamthif_stall_timer : timer to detect amthif hang
409 * @iamthif_state : amthif processor state
410 * @iamthif_canceled : current amthif command is canceled
412 * @reset_work : work item for the device reset
413 * @bus_rescan_work : work item for the bus rescan
415 * @device_list : mei client bus list
416 * @cl_bus_lock : client bus list lock
418 * @dbgfs_dir : debugfs mei root directory
420 * @ops: : hw specific operations
421 * @hw : hw specific data
428 struct mei_cl_cb write_list
;
429 struct mei_cl_cb write_waiting_list
;
430 struct mei_cl_cb ctrl_wr_list
;
431 struct mei_cl_cb ctrl_rd_list
;
433 struct list_head file_list
;
434 long open_handle_count
;
436 struct mutex device_lock
;
437 struct delayed_work timer_work
;
441 * waiting queue for receive message from FW
443 wait_queue_head_t wait_hw_ready
;
444 wait_queue_head_t wait_pg
;
445 wait_queue_head_t wait_hbm_start
;
450 unsigned long reset_count
;
451 enum mei_dev_state dev_state
;
452 enum mei_hbm_state hbm_state
;
453 u16 init_clients_timer
;
456 * Power Gating support
458 enum mei_pg_event pg_event
;
460 struct dev_pm_domain pg_domain
;
461 #endif /* CONFIG_PM */
463 unsigned char rd_msg_buf
[MEI_RD_MSG_BUF_SIZE
];
470 /* used for control messages */
472 struct mei_msg_hdr hdr
;
473 unsigned char data
[128];
476 struct hbm_version version
;
477 unsigned int hbm_f_pg_supported
:1;
478 unsigned int hbm_f_dc_supported
:1;
479 unsigned int hbm_f_dot_supported
:1;
480 unsigned int hbm_f_ev_supported
:1;
481 unsigned int hbm_f_fa_supported
:1;
482 unsigned int hbm_f_ie_supported
:1;
484 struct rw_semaphore me_clients_rwsem
;
485 struct list_head me_clients
;
486 DECLARE_BITMAP(me_clients_map
, MEI_CLIENTS_MAX
);
487 DECLARE_BITMAP(host_clients_map
, MEI_CLIENTS_MAX
);
489 bool allow_fixed_address
;
490 bool override_fixed_address
;
492 /* amthif list for cmd waiting */
493 struct mei_cl_cb amthif_cmd_list
;
494 /* driver managed amthif list for reading completed amthif cmd data */
495 const struct file
*iamthif_fp
;
496 struct mei_cl iamthif_cl
;
497 struct mei_cl_cb
*iamthif_current_cb
;
498 long iamthif_open_count
;
499 u32 iamthif_stall_timer
;
500 enum iamthif_states iamthif_state
;
501 bool iamthif_canceled
;
503 struct work_struct reset_work
;
504 struct work_struct bus_rescan_work
;
506 /* List of bus devices */
507 struct list_head device_list
;
508 struct mutex cl_bus_lock
;
510 #if IS_ENABLED(CONFIG_DEBUG_FS)
511 struct dentry
*dbgfs_dir
;
512 #endif /* CONFIG_DEBUG_FS */
515 const struct mei_hw_ops
*ops
;
516 char hw
[0] __aligned(sizeof(void *));
519 static inline unsigned long mei_secs_to_jiffies(unsigned long sec
)
521 return msecs_to_jiffies(sec
* MSEC_PER_SEC
);
525 * mei_data2slots - get slots - number of (dwords) from a message length
526 * + size of the mei header
528 * @length: size of the messages in bytes
530 * Return: number of slots
532 static inline u32
mei_data2slots(size_t length
)
534 return DIV_ROUND_UP(sizeof(struct mei_msg_hdr
) + length
, 4);
538 * mei_slots2data - get data in slots - bytes from slots
540 * @slots: number of available slots
542 * Return: number of bytes in slots
544 static inline u32
mei_slots2data(int slots
)
550 * mei init function prototypes
552 void mei_device_init(struct mei_device
*dev
,
553 struct device
*device
,
554 const struct mei_hw_ops
*hw_ops
);
555 int mei_reset(struct mei_device
*dev
);
556 int mei_start(struct mei_device
*dev
);
557 int mei_restart(struct mei_device
*dev
);
558 void mei_stop(struct mei_device
*dev
);
559 void mei_cancel_work(struct mei_device
*dev
);
562 * MEI interrupt functions prototype
565 void mei_timer(struct work_struct
*work
);
566 int mei_irq_read_handler(struct mei_device
*dev
,
567 struct mei_cl_cb
*cmpl_list
, s32
*slots
);
569 int mei_irq_write_handler(struct mei_device
*dev
, struct mei_cl_cb
*cmpl_list
);
570 void mei_irq_compl_handler(struct mei_device
*dev
, struct mei_cl_cb
*cmpl_list
);
573 * AMTHIF - AMT Host Interface Functions
575 void mei_amthif_reset_params(struct mei_device
*dev
);
577 int mei_amthif_host_init(struct mei_device
*dev
, struct mei_me_client
*me_cl
);
579 int mei_amthif_read(struct mei_device
*dev
, struct file
*file
,
580 char __user
*ubuf
, size_t length
, loff_t
*offset
);
582 unsigned int mei_amthif_poll(struct mei_device
*dev
,
583 struct file
*file
, poll_table
*wait
);
585 int mei_amthif_release(struct mei_device
*dev
, struct file
*file
);
587 int mei_amthif_write(struct mei_cl
*cl
, struct mei_cl_cb
*cb
);
588 int mei_amthif_run_next_cmd(struct mei_device
*dev
);
589 int mei_amthif_irq_write(struct mei_cl
*cl
, struct mei_cl_cb
*cb
,
590 struct mei_cl_cb
*cmpl_list
);
592 void mei_amthif_complete(struct mei_cl
*cl
, struct mei_cl_cb
*cb
);
593 int mei_amthif_irq_read_msg(struct mei_cl
*cl
,
594 struct mei_msg_hdr
*mei_hdr
,
595 struct mei_cl_cb
*complete_list
);
596 int mei_amthif_irq_read(struct mei_device
*dev
, s32
*slots
);
599 * Register Access Function
603 static inline void mei_hw_config(struct mei_device
*dev
)
605 dev
->ops
->hw_config(dev
);
608 static inline enum mei_pg_state
mei_pg_state(struct mei_device
*dev
)
610 return dev
->ops
->pg_state(dev
);
613 static inline bool mei_pg_in_transition(struct mei_device
*dev
)
615 return dev
->ops
->pg_in_transition(dev
);
618 static inline bool mei_pg_is_enabled(struct mei_device
*dev
)
620 return dev
->ops
->pg_is_enabled(dev
);
623 static inline int mei_hw_reset(struct mei_device
*dev
, bool enable
)
625 return dev
->ops
->hw_reset(dev
, enable
);
628 static inline int mei_hw_start(struct mei_device
*dev
)
630 return dev
->ops
->hw_start(dev
);
633 static inline void mei_clear_interrupts(struct mei_device
*dev
)
635 dev
->ops
->intr_clear(dev
);
638 static inline void mei_enable_interrupts(struct mei_device
*dev
)
640 dev
->ops
->intr_enable(dev
);
643 static inline void mei_disable_interrupts(struct mei_device
*dev
)
645 dev
->ops
->intr_disable(dev
);
648 static inline bool mei_host_is_ready(struct mei_device
*dev
)
650 return dev
->ops
->host_is_ready(dev
);
652 static inline bool mei_hw_is_ready(struct mei_device
*dev
)
654 return dev
->ops
->hw_is_ready(dev
);
657 static inline bool mei_hbuf_is_ready(struct mei_device
*dev
)
659 return dev
->ops
->hbuf_is_ready(dev
);
662 static inline int mei_hbuf_empty_slots(struct mei_device
*dev
)
664 return dev
->ops
->hbuf_free_slots(dev
);
667 static inline size_t mei_hbuf_max_len(const struct mei_device
*dev
)
669 return dev
->ops
->hbuf_max_len(dev
);
672 static inline int mei_write_message(struct mei_device
*dev
,
673 struct mei_msg_hdr
*hdr
,
676 return dev
->ops
->write(dev
, hdr
, buf
);
679 static inline u32
mei_read_hdr(const struct mei_device
*dev
)
681 return dev
->ops
->read_hdr(dev
);
684 static inline void mei_read_slots(struct mei_device
*dev
,
685 unsigned char *buf
, unsigned long len
)
687 dev
->ops
->read(dev
, buf
, len
);
690 static inline int mei_count_full_read_slots(struct mei_device
*dev
)
692 return dev
->ops
->rdbuf_full_slots(dev
);
695 static inline int mei_fw_status(struct mei_device
*dev
,
696 struct mei_fw_status
*fw_status
)
698 return dev
->ops
->fw_status(dev
, fw_status
);
701 bool mei_hbuf_acquire(struct mei_device
*dev
);
703 bool mei_write_is_idle(struct mei_device
*dev
);
705 void mei_irq_discard_msg(struct mei_device
*dev
, struct mei_msg_hdr
*hdr
);
707 #if IS_ENABLED(CONFIG_DEBUG_FS)
708 int mei_dbgfs_register(struct mei_device
*dev
, const char *name
);
709 void mei_dbgfs_deregister(struct mei_device
*dev
);
711 static inline int mei_dbgfs_register(struct mei_device
*dev
, const char *name
)
715 static inline void mei_dbgfs_deregister(struct mei_device
*dev
) {}
716 #endif /* CONFIG_DEBUG_FS */
718 int mei_register(struct mei_device
*dev
, struct device
*parent
);
719 void mei_deregister(struct mei_device
*dev
);
721 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
722 #define MEI_HDR_PRM(hdr) \
723 (hdr)->host_addr, (hdr)->me_addr, \
724 (hdr)->length, (hdr)->internal, (hdr)->msg_complete
726 ssize_t
mei_fw_status2str(struct mei_fw_status
*fw_sts
, char *buf
, size_t len
);
728 * mei_fw_status_str - fetch and convert fw status registers to printable string
730 * @dev: the device structure
731 * @buf: string buffer at minimal size MEI_FW_STATUS_STR_SZ
732 * @len: buffer len must be >= MEI_FW_STATUS_STR_SZ
734 * Return: number of bytes written or < 0 on failure
736 static inline ssize_t
mei_fw_status_str(struct mei_device
*dev
,
737 char *buf
, size_t len
)
739 struct mei_fw_status fw_status
;
744 ret
= mei_fw_status(dev
, &fw_status
);
748 ret
= mei_fw_status2str(&fw_status
, buf
, MEI_FW_STATUS_STR_SZ
);