xref: /linux/drivers/misc/mei/mei_dev.h (revision 3932b9ca55b0be314a36d3e84faff3e823c081f5)
1 /*
2  *
3  * Intel Management Engine Interface (Intel MEI) Linux driver
4  * Copyright (c) 2003-2012, Intel Corporation.
5  *
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.
9  *
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
13  * more details.
14  *
15  */
16 
17 #ifndef _MEI_DEV_H_
18 #define _MEI_DEV_H_
19 
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>
25 
26 #include "hw.h"
27 #include "hbm.h"
28 
29 /*
30  * watch dog definition
31  */
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)
35 
36 #define MEI_WD_DEFAULT_TIMEOUT   120  /* seconds */
37 #define MEI_WD_MIN_TIMEOUT       120  /* seconds */
38 #define MEI_WD_MAX_TIMEOUT     65535  /* seconds */
39 
40 #define MEI_WD_STOP_TIMEOUT      10 /* msecs */
41 
42 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT       (1 << 0)
43 
44 #define MEI_RD_MSG_BUF_SIZE           (128 * sizeof(u32))
45 
46 
47 /*
48  * AMTHI Client UUID
49  */
50 extern const uuid_le mei_amthif_guid;
51 
52 /*
53  * Watchdog Client UUID
54  */
55 extern const uuid_le mei_wd_guid;
56 
57 /*
58  * Number of Maximum MEI Clients
59  */
60 #define MEI_CLIENTS_MAX 256
61 
62 /*
63  * maximum number of consecutive resets
64  */
65 #define MEI_MAX_CONSEC_RESET  3
66 
67 /*
68  * Number of File descriptors/handles
69  * that can be opened to the driver.
70  *
71  * Limit to 255: 256 Total Clients
72  * minus internal client for MEI Bus Messages
73  */
74 #define  MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
75 
76 /*
77  * Internal Clients Number
78  */
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
83 
84 
85 /* File state */
86 enum file_state {
87 	MEI_FILE_INITIALIZING = 0,
88 	MEI_FILE_CONNECTING,
89 	MEI_FILE_CONNECTED,
90 	MEI_FILE_DISCONNECTING,
91 	MEI_FILE_DISCONNECTED
92 };
93 
94 /* MEI device states */
95 enum mei_dev_state {
96 	MEI_DEV_INITIALIZING = 0,
97 	MEI_DEV_INIT_CLIENTS,
98 	MEI_DEV_ENABLED,
99 	MEI_DEV_RESETTING,
100 	MEI_DEV_DISABLED,
101 	MEI_DEV_POWER_DOWN,
102 	MEI_DEV_POWER_UP
103 };
104 
105 const char *mei_dev_state_str(int state);
106 
107 enum iamthif_states {
108 	MEI_IAMTHIF_IDLE,
109 	MEI_IAMTHIF_WRITING,
110 	MEI_IAMTHIF_FLOW_CONTROL,
111 	MEI_IAMTHIF_READING,
112 	MEI_IAMTHIF_READ_COMPLETE
113 };
114 
115 enum mei_file_transaction_states {
116 	MEI_IDLE,
117 	MEI_WRITING,
118 	MEI_WRITE_COMPLETE,
119 	MEI_FLOW_CONTROL,
120 	MEI_READING,
121 	MEI_READ_COMPLETE
122 };
123 
124 enum mei_wd_states {
125 	MEI_WD_IDLE,
126 	MEI_WD_RUNNING,
127 	MEI_WD_STOPPING,
128 };
129 
130 /**
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
138  */
139 enum mei_cb_file_ops {
140 	MEI_FOP_READ = 0,
141 	MEI_FOP_WRITE,
142 	MEI_FOP_CONNECT,
143 	MEI_FOP_DISCONNECT_RSP,
144 	MEI_FOP_OPEN,
145 	MEI_FOP_CLOSE
146 };
147 
148 /*
149  * Intel MEI message data struct
150  */
151 struct mei_msg_data {
152 	u32 size;
153 	unsigned char *data;
154 };
155 
156 /* Maximum number of processed FW status registers */
157 #define MEI_FW_STATUS_MAX 2
158 
159 /*
160  * struct mei_fw_status - storage of FW status data
161  *
162  * @count - number of actually available elements in array
163  * @status - FW status registers
164  */
165 struct mei_fw_status {
166 	int count;
167 	u32 status[MEI_FW_STATUS_MAX];
168 };
169 
170 /**
171  * struct mei_me_client - representation of me (fw) client
172  *
173  * @props  - client properties
174  * @client_id - me client id
175  * @mei_flow_ctrl_creds - flow control credits
176  */
177 struct mei_me_client {
178 	struct mei_client_properties props;
179 	u8 client_id;
180 	u8 mei_flow_ctrl_creds;
181 };
182 
183 
184 struct mei_cl;
185 
186 /**
187  * struct mei_cl_cb - file operation callback structure
188  *
189  * @cl - file client who is running this operation
190  * @fop_type - file operation type
191  */
192 struct mei_cl_cb {
193 	struct list_head list;
194 	struct mei_cl *cl;
195 	enum mei_cb_file_ops fop_type;
196 	struct mei_msg_data request_buffer;
197 	struct mei_msg_data response_buffer;
198 	unsigned long buf_idx;
199 	unsigned long read_time;
200 	struct file *file_object;
201 	u32 internal:1;
202 };
203 
204 /* MEI client instance carried as file->private_data*/
205 struct mei_cl {
206 	struct list_head link;
207 	struct mei_device *dev;
208 	enum file_state state;
209 	wait_queue_head_t tx_wait;
210 	wait_queue_head_t rx_wait;
211 	wait_queue_head_t wait;
212 	int status;
213 	/* ID of client connected */
214 	u8 host_client_id;
215 	u8 me_client_id;
216 	u8 mei_flow_ctrl_creds;
217 	u8 timer_count;
218 	enum mei_file_transaction_states reading_state;
219 	enum mei_file_transaction_states writing_state;
220 	struct mei_cl_cb *read_cb;
221 
222 	/* MEI CL bus data */
223 	struct mei_cl_device *device;
224 	struct list_head device_link;
225 	uuid_le device_uuid;
226 };
227 
228 /** struct mei_hw_ops
229  *
230  * @host_is_ready    - query for host readiness
231 
232  * @hw_is_ready      - query if hw is ready
233  * @hw_reset         - reset hw
234  * @hw_start         - start hw after reset
235  * @hw_config        - configure hw
236 
237  * @pg_state         - power gating state of the device
238  * @pg_is_enabled    - is power gating enabled
239 
240  * @intr_clear       - clear pending interrupts
241  * @intr_enable      - enable interrupts
242  * @intr_disable     - disable interrupts
243 
244  * @hbuf_free_slots  - query for write buffer empty slots
245  * @hbuf_is_ready    - query if write buffer is empty
246  * @hbuf_max_len     - query for write buffer max len
247 
248  * @write            - write a message to FW
249 
250  * @rdbuf_full_slots - query how many slots are filled
251 
252  * @read_hdr         - get first 4 bytes (header)
253  * @read             - read a buffer from the FW
254  */
255 struct mei_hw_ops {
256 
257 	bool (*host_is_ready)(struct mei_device *dev);
258 
259 	bool (*hw_is_ready)(struct mei_device *dev);
260 	int (*hw_reset)(struct mei_device *dev, bool enable);
261 	int (*hw_start)(struct mei_device *dev);
262 	void (*hw_config)(struct mei_device *dev);
263 
264 	enum mei_pg_state (*pg_state)(struct mei_device *dev);
265 	bool (*pg_is_enabled)(struct mei_device *dev);
266 
267 	void (*intr_clear)(struct mei_device *dev);
268 	void (*intr_enable)(struct mei_device *dev);
269 	void (*intr_disable)(struct mei_device *dev);
270 
271 	int (*hbuf_free_slots)(struct mei_device *dev);
272 	bool (*hbuf_is_ready)(struct mei_device *dev);
273 	size_t (*hbuf_max_len)(const struct mei_device *dev);
274 
275 	int (*write)(struct mei_device *dev,
276 		     struct mei_msg_hdr *hdr,
277 		     unsigned char *buf);
278 
279 	int (*rdbuf_full_slots)(struct mei_device *dev);
280 
281 	u32 (*read_hdr)(const struct mei_device *dev);
282 	int (*read)(struct mei_device *dev,
283 		     unsigned char *buf, unsigned long len);
284 };
285 
286 /* MEI bus API*/
287 
288 /**
289  * struct mei_cl_ops - MEI CL device ops
290  * This structure allows ME host clients to implement technology
291  * specific operations.
292  *
293  * @enable: Enable an MEI CL device. Some devices require specific
294  *	HECI commands to initialize completely.
295  * @disable: Disable an MEI CL device.
296  * @send: Tx hook for the device. This allows ME host clients to trap
297  *	the device driver buffers before actually physically
298  *	pushing it to the ME.
299  * @recv: Rx hook for the device. This allows ME host clients to trap the
300  *	ME buffers before forwarding them to the device driver.
301  */
302 struct mei_cl_ops {
303 	int (*enable)(struct mei_cl_device *device);
304 	int (*disable)(struct mei_cl_device *device);
305 	int (*send)(struct mei_cl_device *device, u8 *buf, size_t length);
306 	int (*recv)(struct mei_cl_device *device, u8 *buf, size_t length);
307 };
308 
309 struct mei_cl_device *mei_cl_add_device(struct mei_device *dev,
310 					uuid_le uuid, char *name,
311 					struct mei_cl_ops *ops);
312 void mei_cl_remove_device(struct mei_cl_device *device);
313 
314 int __mei_cl_async_send(struct mei_cl *cl, u8 *buf, size_t length);
315 int __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length);
316 int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length);
317 void mei_cl_bus_rx_event(struct mei_cl *cl);
318 void mei_cl_bus_remove_devices(struct mei_device *dev);
319 int mei_cl_bus_init(void);
320 void mei_cl_bus_exit(void);
321 
322 
323 /**
324  * struct mei_cl_device - MEI device handle
325  * An mei_cl_device pointer is returned from mei_add_device()
326  * and links MEI bus clients to their actual ME host client pointer.
327  * Drivers for MEI devices will get an mei_cl_device pointer
328  * when being probed and shall use it for doing ME bus I/O.
329  *
330  * @dev: linux driver model device pointer
331  * @uuid: me client uuid
332  * @cl: mei client
333  * @ops: ME transport ops
334  * @event_cb: Drivers register this callback to get asynchronous ME
335  *	events (e.g. Rx buffer pending) notifications.
336  * @events: Events bitmask sent to the driver.
337  * @priv_data: client private data
338  */
339 struct mei_cl_device {
340 	struct device dev;
341 
342 	struct mei_cl *cl;
343 
344 	const struct mei_cl_ops *ops;
345 
346 	struct work_struct event_work;
347 	mei_cl_event_cb_t event_cb;
348 	void *event_context;
349 	unsigned long events;
350 
351 	void *priv_data;
352 };
353 
354 
355  /**
356  * enum mei_pg_event - power gating transition events
357  *
358  * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition
359  * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete
360  * @MEI_PG_EVENT_RECEIVED: the driver received pg event
361  */
362 enum mei_pg_event {
363 	MEI_PG_EVENT_IDLE,
364 	MEI_PG_EVENT_WAIT,
365 	MEI_PG_EVENT_RECEIVED,
366 };
367 
368 /**
369  * enum mei_pg_state - device internal power gating state
370  *
371  * @MEI_PG_OFF: device is not power gated - it is active
372  * @MEI_PG_ON:  device is power gated - it is in lower power state
373  */
374 enum mei_pg_state {
375 	MEI_PG_OFF = 0,
376 	MEI_PG_ON =  1,
377 };
378 
379 /*
380  * mei_cfg
381  *
382  * @fw_status - FW status
383  * @quirk_probe - device exclusion quirk
384  */
385 struct mei_cfg {
386 	const struct mei_fw_status fw_status;
387 	bool (*quirk_probe)(struct pci_dev *pdev);
388 };
389 
390 
391 #define MEI_PCI_DEVICE(dev, cfg) \
392 	.vendor = PCI_VENDOR_ID_INTEL, .device = (dev), \
393 	.subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, \
394 	.driver_data = (kernel_ulong_t)&(cfg)
395 
396 
397 /**
398  * struct mei_device -  MEI private device struct
399 
400  * @pdev - pointer to pci device struct
401  * @cdev - character device
402  * @minor - minor number allocated for device
403  *
404  * @reset_count - limits the number of consecutive resets
405  * @hbm_state - state of host bus message protocol
406  * @pg_event - power gating event
407  * @mem_addr - mem mapped base register address
408 
409  * @hbuf_depth - depth of hardware host/write buffer is slots
410  * @hbuf_is_ready - query if the host host/write buffer is ready
411  * @wr_msg - the buffer for hbm control messages
412  * @cfg - per device generation config and ops
413  */
414 struct mei_device {
415 	struct pci_dev *pdev;	/* pointer to pci device struct */
416 	struct cdev cdev;
417 	int minor;
418 
419 	/*
420 	 * lists of queues
421 	 */
422 	/* array of pointers to aio lists */
423 	struct mei_cl_cb read_list;		/* driver read queue */
424 	struct mei_cl_cb write_list;		/* driver write queue */
425 	struct mei_cl_cb write_waiting_list;	/* write waiting queue */
426 	struct mei_cl_cb ctrl_wr_list;		/* managed write IOCTL list */
427 	struct mei_cl_cb ctrl_rd_list;		/* managed read IOCTL list */
428 
429 	/*
430 	 * list of files
431 	 */
432 	struct list_head file_list;
433 	long open_handle_count;
434 
435 	/*
436 	 * lock for the device
437 	 */
438 	struct mutex device_lock; /* device lock */
439 	struct delayed_work timer_work;	/* MEI timer delayed work (timeouts) */
440 
441 	bool recvd_hw_ready;
442 	/*
443 	 * waiting queue for receive message from FW
444 	 */
445 	wait_queue_head_t wait_hw_ready;
446 	wait_queue_head_t wait_pg;
447 	wait_queue_head_t wait_recvd_msg;
448 	wait_queue_head_t wait_stop_wd;
449 
450 	/*
451 	 * mei device  states
452 	 */
453 	unsigned long reset_count;
454 	enum mei_dev_state dev_state;
455 	enum mei_hbm_state hbm_state;
456 	u16 init_clients_timer;
457 
458 	/*
459 	 * Power Gating support
460 	 */
461 	enum mei_pg_event pg_event;
462 #ifdef CONFIG_PM_RUNTIME
463 	struct dev_pm_domain pg_domain;
464 #endif /* CONFIG_PM_RUNTIME */
465 
466 	unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];	/* control messages */
467 	u32 rd_msg_hdr;
468 
469 	/* write buffer */
470 	u8 hbuf_depth;
471 	bool hbuf_is_ready;
472 
473 	/* used for control messages */
474 	struct {
475 		struct mei_msg_hdr hdr;
476 		unsigned char data[128];
477 	} wr_msg;
478 
479 	struct hbm_version version;
480 
481 	struct mei_me_client *me_clients; /* Note: memory has to be allocated */
482 	DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
483 	DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
484 	unsigned long me_clients_num;
485 	unsigned long me_client_presentation_num;
486 	unsigned long me_client_index;
487 
488 	struct mei_cl wd_cl;
489 	enum mei_wd_states wd_state;
490 	bool wd_pending;
491 	u16 wd_timeout;
492 	unsigned char wd_data[MEI_WD_START_MSG_SIZE];
493 
494 
495 	/* amthif list for cmd waiting */
496 	struct mei_cl_cb amthif_cmd_list;
497 	/* driver managed amthif list for reading completed amthif cmd data */
498 	struct mei_cl_cb amthif_rd_complete_list;
499 	struct file *iamthif_file_object;
500 	struct mei_cl iamthif_cl;
501 	struct mei_cl_cb *iamthif_current_cb;
502 	long iamthif_open_count;
503 	int iamthif_mtu;
504 	unsigned long iamthif_timer;
505 	u32 iamthif_stall_timer;
506 	unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
507 	u32 iamthif_msg_buf_size;
508 	u32 iamthif_msg_buf_index;
509 	enum iamthif_states iamthif_state;
510 	bool iamthif_flow_control_pending;
511 	bool iamthif_ioctl;
512 	bool iamthif_canceled;
513 
514 	struct work_struct init_work;
515 	struct work_struct reset_work;
516 
517 	/* List of bus devices */
518 	struct list_head device_list;
519 
520 #if IS_ENABLED(CONFIG_DEBUG_FS)
521 	struct dentry *dbgfs_dir;
522 #endif /* CONFIG_DEBUG_FS */
523 
524 
525 	const struct mei_hw_ops *ops;
526 	const struct mei_cfg *cfg;
527 	char hw[0] __aligned(sizeof(void *));
528 };
529 
530 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
531 {
532 	return msecs_to_jiffies(sec * MSEC_PER_SEC);
533 }
534 
535 /**
536  * mei_data2slots - get slots - number of (dwords) from a message length
537  *	+ size of the mei header
538  * @length - size of the messages in bytes
539  * returns  - number of slots
540  */
541 static inline u32 mei_data2slots(size_t length)
542 {
543 	return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
544 }
545 
546 /**
547  * mei_slots2data- get data in slots - bytes from slots
548  * @slots -  number of available slots
549  * returns  - number of bytes in slots
550  */
551 static inline u32 mei_slots2data(int slots)
552 {
553 	return slots * 4;
554 }
555 
556 /*
557  * mei init function prototypes
558  */
559 void mei_device_init(struct mei_device *dev, const struct mei_cfg *cfg);
560 int mei_reset(struct mei_device *dev);
561 int mei_start(struct mei_device *dev);
562 int mei_restart(struct mei_device *dev);
563 void mei_stop(struct mei_device *dev);
564 void mei_cancel_work(struct mei_device *dev);
565 
566 /*
567  *  MEI interrupt functions prototype
568  */
569 
570 void mei_timer(struct work_struct *work);
571 int mei_irq_read_handler(struct mei_device *dev,
572 		struct mei_cl_cb *cmpl_list, s32 *slots);
573 
574 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
575 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
576 
577 /*
578  * AMTHIF - AMT Host Interface Functions
579  */
580 void mei_amthif_reset_params(struct mei_device *dev);
581 
582 int mei_amthif_host_init(struct mei_device *dev);
583 
584 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
585 
586 int mei_amthif_read(struct mei_device *dev, struct file *file,
587 		char __user *ubuf, size_t length, loff_t *offset);
588 
589 unsigned int mei_amthif_poll(struct mei_device *dev,
590 		struct file *file, poll_table *wait);
591 
592 int mei_amthif_release(struct mei_device *dev, struct file *file);
593 
594 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
595 						struct file *file);
596 
597 void mei_amthif_run_next_cmd(struct mei_device *dev);
598 
599 int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
600 			struct mei_cl_cb *cmpl_list);
601 
602 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
603 int mei_amthif_irq_read_msg(struct mei_device *dev,
604 			    struct mei_msg_hdr *mei_hdr,
605 			    struct mei_cl_cb *complete_list);
606 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
607 
608 /*
609  * NFC functions
610  */
611 int mei_nfc_host_init(struct mei_device *dev);
612 void mei_nfc_host_exit(struct mei_device *dev);
613 
614 /*
615  * NFC Client UUID
616  */
617 extern const uuid_le mei_nfc_guid;
618 
619 int mei_wd_send(struct mei_device *dev);
620 int mei_wd_stop(struct mei_device *dev);
621 int mei_wd_host_init(struct mei_device *dev);
622 /*
623  * mei_watchdog_register  - Registering watchdog interface
624  *   once we got connection to the WD Client
625  * @dev - mei device
626  */
627 int mei_watchdog_register(struct mei_device *dev);
628 /*
629  * mei_watchdog_unregister  - Unregistering watchdog interface
630  * @dev - mei device
631  */
632 void mei_watchdog_unregister(struct mei_device *dev);
633 
634 /*
635  * Register Access Function
636  */
637 
638 
639 static inline void mei_hw_config(struct mei_device *dev)
640 {
641 	dev->ops->hw_config(dev);
642 }
643 
644 static inline enum mei_pg_state mei_pg_state(struct mei_device *dev)
645 {
646 	return dev->ops->pg_state(dev);
647 }
648 
649 static inline bool mei_pg_is_enabled(struct mei_device *dev)
650 {
651 	return dev->ops->pg_is_enabled(dev);
652 }
653 
654 static inline int mei_hw_reset(struct mei_device *dev, bool enable)
655 {
656 	return dev->ops->hw_reset(dev, enable);
657 }
658 
659 static inline int mei_hw_start(struct mei_device *dev)
660 {
661 	return dev->ops->hw_start(dev);
662 }
663 
664 static inline void mei_clear_interrupts(struct mei_device *dev)
665 {
666 	dev->ops->intr_clear(dev);
667 }
668 
669 static inline void mei_enable_interrupts(struct mei_device *dev)
670 {
671 	dev->ops->intr_enable(dev);
672 }
673 
674 static inline void mei_disable_interrupts(struct mei_device *dev)
675 {
676 	dev->ops->intr_disable(dev);
677 }
678 
679 static inline bool mei_host_is_ready(struct mei_device *dev)
680 {
681 	return dev->ops->host_is_ready(dev);
682 }
683 static inline bool mei_hw_is_ready(struct mei_device *dev)
684 {
685 	return dev->ops->hw_is_ready(dev);
686 }
687 
688 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
689 {
690 	return dev->ops->hbuf_is_ready(dev);
691 }
692 
693 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
694 {
695 	return dev->ops->hbuf_free_slots(dev);
696 }
697 
698 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
699 {
700 	return dev->ops->hbuf_max_len(dev);
701 }
702 
703 static inline int mei_write_message(struct mei_device *dev,
704 			struct mei_msg_hdr *hdr,
705 			unsigned char *buf)
706 {
707 	return dev->ops->write(dev, hdr, buf);
708 }
709 
710 static inline u32 mei_read_hdr(const struct mei_device *dev)
711 {
712 	return dev->ops->read_hdr(dev);
713 }
714 
715 static inline void mei_read_slots(struct mei_device *dev,
716 		     unsigned char *buf, unsigned long len)
717 {
718 	dev->ops->read(dev, buf, len);
719 }
720 
721 static inline int mei_count_full_read_slots(struct mei_device *dev)
722 {
723 	return dev->ops->rdbuf_full_slots(dev);
724 }
725 
726 int mei_fw_status(struct mei_device *dev, struct mei_fw_status *fw_status);
727 
728 #define FW_STS_FMT "%08X %08X"
729 #define FW_STS_PRM(fw_status) \
730 	(fw_status).count > 0 ? (fw_status).status[0] : 0xDEADBEEF, \
731 	(fw_status).count > 1 ? (fw_status).status[1] : 0xDEADBEEF
732 
733 bool mei_hbuf_acquire(struct mei_device *dev);
734 
735 bool mei_write_is_idle(struct mei_device *dev);
736 
737 #if IS_ENABLED(CONFIG_DEBUG_FS)
738 int mei_dbgfs_register(struct mei_device *dev, const char *name);
739 void mei_dbgfs_deregister(struct mei_device *dev);
740 #else
741 static inline int mei_dbgfs_register(struct mei_device *dev, const char *name)
742 {
743 	return 0;
744 }
745 static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
746 #endif /* CONFIG_DEBUG_FS */
747 
748 int mei_register(struct mei_device *dev, struct device *parent);
749 void mei_deregister(struct mei_device *dev);
750 
751 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
752 #define MEI_HDR_PRM(hdr)                  \
753 	(hdr)->host_addr, (hdr)->me_addr, \
754 	(hdr)->length, (hdr)->internal, (hdr)->msg_complete
755 
756 #endif
757