mei: use consistent naming for TX control flow credits
[muen/linux.git] / drivers / misc / mei / mei_dev.h
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/cdev.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 /*
31  * AMTHI Client UUID
32  */
33 extern const uuid_le mei_amthif_guid;
34
35 #define MEI_RD_MSG_BUF_SIZE           (128 * sizeof(u32))
36
37 /*
38  * Number of Maximum MEI Clients
39  */
40 #define MEI_CLIENTS_MAX 256
41
42 /*
43  * maximum number of consecutive resets
44  */
45 #define MEI_MAX_CONSEC_RESET  3
46
47 /*
48  * Number of File descriptors/handles
49  * that can be opened to the driver.
50  *
51  * Limit to 255: 256 Total Clients
52  * minus internal client for MEI Bus Messages
53  */
54 #define  MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
55
56 /* File state */
57 enum file_state {
58         MEI_FILE_INITIALIZING = 0,
59         MEI_FILE_CONNECTING,
60         MEI_FILE_CONNECTED,
61         MEI_FILE_DISCONNECTING,
62         MEI_FILE_DISCONNECT_REPLY,
63         MEI_FILE_DISCONNECT_REQUIRED,
64         MEI_FILE_DISCONNECTED,
65 };
66
67 /* MEI device states */
68 enum mei_dev_state {
69         MEI_DEV_INITIALIZING = 0,
70         MEI_DEV_INIT_CLIENTS,
71         MEI_DEV_ENABLED,
72         MEI_DEV_RESETTING,
73         MEI_DEV_DISABLED,
74         MEI_DEV_POWER_DOWN,
75         MEI_DEV_POWER_UP
76 };
77
78 const char *mei_dev_state_str(int state);
79
80 enum iamthif_states {
81         MEI_IAMTHIF_IDLE,
82         MEI_IAMTHIF_WRITING,
83         MEI_IAMTHIF_READING,
84 };
85
86 enum mei_file_transaction_states {
87         MEI_IDLE,
88         MEI_WRITING,
89         MEI_WRITE_COMPLETE,
90         MEI_FLOW_CONTROL,
91         MEI_READING,
92         MEI_READ_COMPLETE
93 };
94
95 /**
96  * enum mei_cb_file_ops  - file operation associated with the callback
97  * @MEI_FOP_READ:       read
98  * @MEI_FOP_WRITE:      write
99  * @MEI_FOP_CONNECT:    connect
100  * @MEI_FOP_DISCONNECT: disconnect
101  * @MEI_FOP_DISCONNECT_RSP: disconnect response
102  * @MEI_FOP_NOTIFY_START:   start notification
103  * @MEI_FOP_NOTIFY_STOP:    stop notification
104  */
105 enum mei_cb_file_ops {
106         MEI_FOP_READ = 0,
107         MEI_FOP_WRITE,
108         MEI_FOP_CONNECT,
109         MEI_FOP_DISCONNECT,
110         MEI_FOP_DISCONNECT_RSP,
111         MEI_FOP_NOTIFY_START,
112         MEI_FOP_NOTIFY_STOP,
113 };
114
115 /*
116  * Intel MEI message data struct
117  */
118 struct mei_msg_data {
119         size_t size;
120         unsigned char *data;
121 };
122
123 /* Maximum number of processed FW status registers */
124 #define MEI_FW_STATUS_MAX 6
125 /* Minimal  buffer for FW status string (8 bytes in dw + space or '\0') */
126 #define MEI_FW_STATUS_STR_SZ (MEI_FW_STATUS_MAX * (8 + 1))
127
128
129 /*
130  * struct mei_fw_status - storage of FW status data
131  *
132  * @count: number of actually available elements in array
133  * @status: FW status registers
134  */
135 struct mei_fw_status {
136         int count;
137         u32 status[MEI_FW_STATUS_MAX];
138 };
139
140 /**
141  * struct mei_me_client - representation of me (fw) client
142  *
143  * @list: link in me client list
144  * @refcnt: struct reference count
145  * @props: client properties
146  * @client_id: me client id
147  * @tx_flow_ctrl_creds: flow control credits
148  * @connect_count: number connections to this client
149  * @bus_added: added to bus
150  */
151 struct mei_me_client {
152         struct list_head list;
153         struct kref refcnt;
154         struct mei_client_properties props;
155         u8 client_id;
156         u8 tx_flow_ctrl_creds;
157         u8 connect_count;
158         u8 bus_added;
159 };
160
161
162 struct mei_cl;
163
164 /**
165  * struct mei_cl_cb - file operation callback structure
166  *
167  * @list: link in callback queue
168  * @cl: file client who is running this operation
169  * @fop_type: file operation type
170  * @buf: buffer for data associated with the callback
171  * @buf_idx: last read index
172  * @fp: pointer to file structure
173  * @status: io status of the cb
174  * @internal: communication between driver and FW flag
175  * @completed: the transfer or reception has completed
176  */
177 struct mei_cl_cb {
178         struct list_head list;
179         struct mei_cl *cl;
180         enum mei_cb_file_ops fop_type;
181         struct mei_msg_data buf;
182         size_t buf_idx;
183         const struct file *fp;
184         int status;
185         u32 internal:1;
186         u32 completed:1;
187 };
188
189 /**
190  * struct mei_cl - me client host representation
191  *    carried in file->private_data
192  *
193  * @link: link in the clients list
194  * @dev: mei parent device
195  * @state: file operation state
196  * @tx_wait: wait queue for tx completion
197  * @rx_wait: wait queue for rx completion
198  * @wait:  wait queue for management operation
199  * @ev_wait: notification wait queue
200  * @ev_async: event async notification
201  * @status: connection status
202  * @me_cl: fw client connected
203  * @fp: file associated with client
204  * @host_client_id: host id
205  * @tx_flow_ctrl_creds: transmit flow credentials
206  * @rx_flow_ctrl_creds: receive flow credentials
207  * @timer_count:  watchdog timer for operation completion
208  * @notify_en: notification - enabled/disabled
209  * @notify_ev: pending notification event
210  * @writing_state: state of the tx
211  * @rd_pending: pending read credits
212  * @rd_completed: completed read
213  *
214  * @cldev: device on the mei client bus
215  */
216 struct mei_cl {
217         struct list_head link;
218         struct mei_device *dev;
219         enum file_state state;
220         wait_queue_head_t tx_wait;
221         wait_queue_head_t rx_wait;
222         wait_queue_head_t wait;
223         wait_queue_head_t ev_wait;
224         struct fasync_struct *ev_async;
225         int status;
226         struct mei_me_client *me_cl;
227         const struct file *fp;
228         u8 host_client_id;
229         u8 tx_flow_ctrl_creds;
230         u8 rx_flow_ctrl_creds;
231         u8 timer_count;
232         u8 notify_en;
233         u8 notify_ev;
234         enum mei_file_transaction_states writing_state;
235         struct list_head rd_pending;
236         struct list_head rd_completed;
237
238         struct mei_cl_device *cldev;
239 };
240
241 /**
242  * struct mei_hw_ops - hw specific ops
243  *
244  * @host_is_ready    : query for host readiness
245  *
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
250  *
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
255  *
256  * @intr_clear       : clear pending interrupts
257  * @intr_enable      : enable interrupts
258  * @intr_disable     : disable interrupts
259  *
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
263  *
264  * @write            : write a message to FW
265  *
266  * @rdbuf_full_slots : query how many slots are filled
267  *
268  * @read_hdr         : get first 4 bytes (header)
269  * @read             : read a buffer from the FW
270  */
271 struct mei_hw_ops {
272
273         bool (*host_is_ready)(struct mei_device *dev);
274
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);
279
280
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);
285
286         void (*intr_clear)(struct mei_device *dev);
287         void (*intr_enable)(struct mei_device *dev);
288         void (*intr_disable)(struct mei_device *dev);
289
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);
293
294         int (*write)(struct mei_device *dev,
295                      struct mei_msg_hdr *hdr,
296                      unsigned char *buf);
297
298         int (*rdbuf_full_slots)(struct mei_device *dev);
299
300         u32 (*read_hdr)(const struct mei_device *dev);
301         int (*read)(struct mei_device *dev,
302                      unsigned char *buf, unsigned long len);
303 };
304
305 /* MEI bus API*/
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,
310                         bool blocking);
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);
317
318 /**
319  * enum mei_pg_event - power gating transition events
320  *
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
326  */
327 enum mei_pg_event {
328         MEI_PG_EVENT_IDLE,
329         MEI_PG_EVENT_WAIT,
330         MEI_PG_EVENT_RECEIVED,
331         MEI_PG_EVENT_INTR_WAIT,
332         MEI_PG_EVENT_INTR_RECEIVED,
333 };
334
335 /**
336  * enum mei_pg_state - device internal power gating state
337  *
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
340  */
341 enum mei_pg_state {
342         MEI_PG_OFF = 0,
343         MEI_PG_ON =  1,
344 };
345
346 const char *mei_pg_state_str(enum mei_pg_state state);
347
348 /**
349  * struct mei_device -  MEI private device struct
350  *
351  * @dev         : device on a bus
352  * @cdev        : character device
353  * @minor       : minor number allocated for device
354  *
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
359  *
360  * @file_list   : list of opened handles
361  * @open_handle_count: number of opened handles
362  *
363  * @device_lock : big device lock
364  * @timer_work  : MEI timer delayed work (timeouts)
365  *
366  * @recvd_hw_ready : hw ready message received flag
367  *
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
371  *
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
376  *
377  * @pg_event    : power gating event
378  * @pg_domain   : runtime PM domain
379  *
380  * @rd_msg_buf  : control messages buffer
381  * @rd_msg_hdr  : read message header storage
382  *
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  *
386  * @version     : HBM protocol version in use
387  * @hbm_f_pg_supported  : hbm feature pgi protocol
388  * @hbm_f_dc_supported  : hbm feature dynamic clients
389  * @hbm_f_dot_supported : hbm feature disconnect on timeout
390  * @hbm_f_ev_supported  : hbm feature event notification
391  * @hbm_f_fa_supported  : hbm feature fixed address client
392  * @hbm_f_ie_supported  : hbm feature immediate reply to enum request
393  *
394  * @me_clients_rwsem: rw lock over me_clients list
395  * @me_clients  : list of FW clients
396  * @me_clients_map : FW clients bit map
397  * @host_clients_map : host clients id pool
398  *
399  * @allow_fixed_address: allow user space to connect a fixed client
400  * @override_fixed_address: force allow fixed address behavior
401  *
402  * @amthif_cmd_list : amthif list for cmd waiting
403  * @iamthif_cl  : amthif host client
404  * @iamthif_open_count : number of opened amthif connections
405  * @iamthif_stall_timer : timer to detect amthif hang
406  * @iamthif_state : amthif processor state
407  * @iamthif_canceled : current amthif command is canceled
408  *
409  * @reset_work  : work item for the device reset
410  * @bus_rescan_work : work item for the bus rescan
411  *
412  * @device_list : mei client bus list
413  * @cl_bus_lock : client bus list lock
414  *
415  * @dbgfs_dir   : debugfs mei root directory
416  *
417  * @ops:        : hw specific operations
418  * @hw          : hw specific data
419  */
420 struct mei_device {
421         struct device *dev;
422         struct cdev cdev;
423         int minor;
424
425         struct mei_cl_cb write_list;
426         struct mei_cl_cb write_waiting_list;
427         struct mei_cl_cb ctrl_wr_list;
428         struct mei_cl_cb ctrl_rd_list;
429
430         struct list_head file_list;
431         long open_handle_count;
432
433         struct mutex device_lock;
434         struct delayed_work timer_work;
435
436         bool recvd_hw_ready;
437         /*
438          * waiting queue for receive message from FW
439          */
440         wait_queue_head_t wait_hw_ready;
441         wait_queue_head_t wait_pg;
442         wait_queue_head_t wait_hbm_start;
443
444         /*
445          * mei device  states
446          */
447         unsigned long reset_count;
448         enum mei_dev_state dev_state;
449         enum mei_hbm_state hbm_state;
450         u16 init_clients_timer;
451
452         /*
453          * Power Gating support
454          */
455         enum mei_pg_event pg_event;
456 #ifdef CONFIG_PM
457         struct dev_pm_domain pg_domain;
458 #endif /* CONFIG_PM */
459
460         unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];
461         u32 rd_msg_hdr;
462
463         /* write buffer */
464         u8 hbuf_depth;
465         bool hbuf_is_ready;
466
467         struct hbm_version version;
468         unsigned int hbm_f_pg_supported:1;
469         unsigned int hbm_f_dc_supported:1;
470         unsigned int hbm_f_dot_supported:1;
471         unsigned int hbm_f_ev_supported:1;
472         unsigned int hbm_f_fa_supported:1;
473         unsigned int hbm_f_ie_supported:1;
474
475         struct rw_semaphore me_clients_rwsem;
476         struct list_head me_clients;
477         DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
478         DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
479
480         bool allow_fixed_address;
481         bool override_fixed_address;
482
483         /* amthif list for cmd waiting */
484         struct mei_cl_cb amthif_cmd_list;
485         struct mei_cl iamthif_cl;
486         long iamthif_open_count;
487         u32 iamthif_stall_timer;
488         enum iamthif_states iamthif_state;
489         bool iamthif_canceled;
490
491         struct work_struct reset_work;
492         struct work_struct bus_rescan_work;
493
494         /* List of bus devices */
495         struct list_head device_list;
496         struct mutex cl_bus_lock;
497
498 #if IS_ENABLED(CONFIG_DEBUG_FS)
499         struct dentry *dbgfs_dir;
500 #endif /* CONFIG_DEBUG_FS */
501
502
503         const struct mei_hw_ops *ops;
504         char hw[0] __aligned(sizeof(void *));
505 };
506
507 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
508 {
509         return msecs_to_jiffies(sec * MSEC_PER_SEC);
510 }
511
512 /**
513  * mei_data2slots - get slots - number of (dwords) from a message length
514  *      + size of the mei header
515  *
516  * @length: size of the messages in bytes
517  *
518  * Return: number of slots
519  */
520 static inline u32 mei_data2slots(size_t length)
521 {
522         return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
523 }
524
525 /**
526  * mei_slots2data - get data in slots - bytes from slots
527  *
528  * @slots: number of available slots
529  *
530  * Return: number of bytes in slots
531  */
532 static inline u32 mei_slots2data(int slots)
533 {
534         return slots * 4;
535 }
536
537 /*
538  * mei init function prototypes
539  */
540 void mei_device_init(struct mei_device *dev,
541                      struct device *device,
542                      const struct mei_hw_ops *hw_ops);
543 int mei_reset(struct mei_device *dev);
544 int mei_start(struct mei_device *dev);
545 int mei_restart(struct mei_device *dev);
546 void mei_stop(struct mei_device *dev);
547 void mei_cancel_work(struct mei_device *dev);
548
549 /*
550  *  MEI interrupt functions prototype
551  */
552
553 void mei_timer(struct work_struct *work);
554 int mei_irq_read_handler(struct mei_device *dev,
555                 struct mei_cl_cb *cmpl_list, s32 *slots);
556
557 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
558 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
559
560 /*
561  * AMTHIF - AMT Host Interface Functions
562  */
563 void mei_amthif_reset_params(struct mei_device *dev);
564
565 int mei_amthif_host_init(struct mei_device *dev, struct mei_me_client *me_cl);
566
567 int mei_amthif_read(struct mei_device *dev, struct file *file,
568                 char __user *ubuf, size_t length, loff_t *offset);
569
570 unsigned int mei_amthif_poll(struct file *file, poll_table *wait);
571
572 int mei_amthif_release(struct mei_device *dev, struct file *file);
573
574 int mei_amthif_write(struct mei_cl *cl, struct mei_cl_cb *cb);
575 int mei_amthif_run_next_cmd(struct mei_device *dev);
576 int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
577                         struct mei_cl_cb *cmpl_list);
578
579 void mei_amthif_complete(struct mei_cl *cl, struct mei_cl_cb *cb);
580 int mei_amthif_irq_read_msg(struct mei_cl *cl,
581                             struct mei_msg_hdr *mei_hdr,
582                             struct mei_cl_cb *complete_list);
583 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
584
585 /*
586  * Register Access Function
587  */
588
589
590 static inline void mei_hw_config(struct mei_device *dev)
591 {
592         dev->ops->hw_config(dev);
593 }
594
595 static inline enum mei_pg_state mei_pg_state(struct mei_device *dev)
596 {
597         return dev->ops->pg_state(dev);
598 }
599
600 static inline bool mei_pg_in_transition(struct mei_device *dev)
601 {
602         return dev->ops->pg_in_transition(dev);
603 }
604
605 static inline bool mei_pg_is_enabled(struct mei_device *dev)
606 {
607         return dev->ops->pg_is_enabled(dev);
608 }
609
610 static inline int mei_hw_reset(struct mei_device *dev, bool enable)
611 {
612         return dev->ops->hw_reset(dev, enable);
613 }
614
615 static inline int mei_hw_start(struct mei_device *dev)
616 {
617         return dev->ops->hw_start(dev);
618 }
619
620 static inline void mei_clear_interrupts(struct mei_device *dev)
621 {
622         dev->ops->intr_clear(dev);
623 }
624
625 static inline void mei_enable_interrupts(struct mei_device *dev)
626 {
627         dev->ops->intr_enable(dev);
628 }
629
630 static inline void mei_disable_interrupts(struct mei_device *dev)
631 {
632         dev->ops->intr_disable(dev);
633 }
634
635 static inline bool mei_host_is_ready(struct mei_device *dev)
636 {
637         return dev->ops->host_is_ready(dev);
638 }
639 static inline bool mei_hw_is_ready(struct mei_device *dev)
640 {
641         return dev->ops->hw_is_ready(dev);
642 }
643
644 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
645 {
646         return dev->ops->hbuf_is_ready(dev);
647 }
648
649 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
650 {
651         return dev->ops->hbuf_free_slots(dev);
652 }
653
654 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
655 {
656         return dev->ops->hbuf_max_len(dev);
657 }
658
659 static inline int mei_write_message(struct mei_device *dev,
660                         struct mei_msg_hdr *hdr, void *buf)
661 {
662         return dev->ops->write(dev, hdr, buf);
663 }
664
665 static inline u32 mei_read_hdr(const struct mei_device *dev)
666 {
667         return dev->ops->read_hdr(dev);
668 }
669
670 static inline void mei_read_slots(struct mei_device *dev,
671                      unsigned char *buf, unsigned long len)
672 {
673         dev->ops->read(dev, buf, len);
674 }
675
676 static inline int mei_count_full_read_slots(struct mei_device *dev)
677 {
678         return dev->ops->rdbuf_full_slots(dev);
679 }
680
681 static inline int mei_fw_status(struct mei_device *dev,
682                                 struct mei_fw_status *fw_status)
683 {
684         return dev->ops->fw_status(dev, fw_status);
685 }
686
687 bool mei_hbuf_acquire(struct mei_device *dev);
688
689 bool mei_write_is_idle(struct mei_device *dev);
690
691 void mei_irq_discard_msg(struct mei_device *dev, struct mei_msg_hdr *hdr);
692
693 #if IS_ENABLED(CONFIG_DEBUG_FS)
694 int mei_dbgfs_register(struct mei_device *dev, const char *name);
695 void mei_dbgfs_deregister(struct mei_device *dev);
696 #else
697 static inline int mei_dbgfs_register(struct mei_device *dev, const char *name)
698 {
699         return 0;
700 }
701 static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
702 #endif /* CONFIG_DEBUG_FS */
703
704 int mei_register(struct mei_device *dev, struct device *parent);
705 void mei_deregister(struct mei_device *dev);
706
707 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
708 #define MEI_HDR_PRM(hdr)                  \
709         (hdr)->host_addr, (hdr)->me_addr, \
710         (hdr)->length, (hdr)->internal, (hdr)->msg_complete
711
712 ssize_t mei_fw_status2str(struct mei_fw_status *fw_sts, char *buf, size_t len);
713 /**
714  * mei_fw_status_str - fetch and convert fw status registers to printable string
715  *
716  * @dev: the device structure
717  * @buf: string buffer at minimal size MEI_FW_STATUS_STR_SZ
718  * @len: buffer len must be >= MEI_FW_STATUS_STR_SZ
719  *
720  * Return: number of bytes written or < 0 on failure
721  */
722 static inline ssize_t mei_fw_status_str(struct mei_device *dev,
723                                         char *buf, size_t len)
724 {
725         struct mei_fw_status fw_status;
726         int ret;
727
728         buf[0] = '\0';
729
730         ret = mei_fw_status(dev, &fw_status);
731         if (ret)
732                 return ret;
733
734         ret = mei_fw_status2str(&fw_status, buf, MEI_FW_STATUS_STR_SZ);
735
736         return ret;
737 }
738
739
740 #endif