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/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 list_head list;
 179         struct mei_client_properties props;
 180         u8 client_id;
 181         u8 mei_flow_ctrl_creds;
 182 };
 183
 184
 185 struct mei_cl;
 186
 187 /**
 188  * struct mei_cl_cb - file operation callback structure
 189  *
 190  * @cl - file client who is running this operation
 191  * @fop_type - file operation type
 192  */
 193 struct mei_cl_cb {
 194         struct list_head list;
 195         struct mei_cl *cl;
 196         enum mei_cb_file_ops fop_type;
 197         struct mei_msg_data request_buffer;
 198         struct mei_msg_data response_buffer;
 199         unsigned long buf_idx;
 200         unsigned long read_time;
 201         struct file *file_object;
 202         u32 internal:1;
 203 };
 204
 205 /* MEI client instance carried as file->private_data*/
 206 struct mei_cl {
 207         struct list_head link;
 208         struct mei_device *dev;
 209         enum file_state state;
 210         wait_queue_head_t tx_wait;
 211         wait_queue_head_t rx_wait;
 212         wait_queue_head_t wait;
 213         int status;
 214         /* ID of client connected */
 215         u8 host_client_id;
 216         u8 me_client_id;
 217         u8 mei_flow_ctrl_creds;
 218         u8 timer_count;
 219         enum mei_file_transaction_states reading_state;
 220         enum mei_file_transaction_states writing_state;
 221         struct mei_cl_cb *read_cb;
 222
 223         /* MEI CL bus data */
 224         struct mei_cl_device *device;
 225         struct list_head device_link;
 226         uuid_le device_uuid;
 227 };
 228
 229 /** struct mei_hw_ops
 230  *
 231  * @host_is_ready    - query for host readiness
 232
 233  * @hw_is_ready      - query if hw is ready
 234  * @hw_reset         - reset hw
 235  * @hw_start         - start hw after reset
 236  * @hw_config        - configure hw
 237
 238  * @pg_state         - power gating state of the device
 239  * @pg_is_enabled    - is power gating enabled
 240
 241  * @intr_clear       - clear pending interrupts
 242  * @intr_enable      - enable interrupts
 243  * @intr_disable     - disable interrupts
 244
 245  * @hbuf_free_slots  - query for write buffer empty slots
 246  * @hbuf_is_ready    - query if write buffer is empty
 247  * @hbuf_max_len     - query for write buffer max len
 248
 249  * @write            - write a message to FW
 250
 251  * @rdbuf_full_slots - query how many slots are filled
 252
 253  * @read_hdr         - get first 4 bytes (header)
 254  * @read             - read a buffer from the FW
 255  */
 256 struct mei_hw_ops {
 257
 258         bool (*host_is_ready)(struct mei_device *dev);
 259
 260         bool (*hw_is_ready)(struct mei_device *dev);
 261         int (*hw_reset)(struct mei_device *dev, bool enable);
 262         int (*hw_start)(struct mei_device *dev);
 263         void (*hw_config)(struct mei_device *dev);
 264
 265         enum mei_pg_state (*pg_state)(struct mei_device *dev);
 266         bool (*pg_is_enabled)(struct mei_device *dev);
 267
 268         void (*intr_clear)(struct mei_device *dev);
 269         void (*intr_enable)(struct mei_device *dev);
 270         void (*intr_disable)(struct mei_device *dev);
 271
 272         int (*hbuf_free_slots)(struct mei_device *dev);
 273         bool (*hbuf_is_ready)(struct mei_device *dev);
 274         size_t (*hbuf_max_len)(const struct mei_device *dev);
 275
 276         int (*write)(struct mei_device *dev,
 277                      struct mei_msg_hdr *hdr,
 278                      unsigned char *buf);
 279
 280         int (*rdbuf_full_slots)(struct mei_device *dev);
 281
 282         u32 (*read_hdr)(const struct mei_device *dev);
 283         int (*read)(struct mei_device *dev,
 284                      unsigned char *buf, unsigned long len);
 285 };
 286
 287 /* MEI bus API*/
 288
 289 /**
 290  * struct mei_cl_ops - MEI CL device ops
 291  * This structure allows ME host clients to implement technology
 292  * specific operations.
 293  *
 294  * @enable: Enable an MEI CL device. Some devices require specific
 295  *      HECI commands to initialize completely.
 296  * @disable: Disable an MEI CL device.
 297  * @send: Tx hook for the device. This allows ME host clients to trap
 298  *      the device driver buffers before actually physically
 299  *      pushing it to the ME.
 300  * @recv: Rx hook for the device. This allows ME host clients to trap the
 301  *      ME buffers before forwarding them to the device driver.
 302  */
 303 struct mei_cl_ops {
 304         int (*enable)(struct mei_cl_device *device);
 305         int (*disable)(struct mei_cl_device *device);
 306         int (*send)(struct mei_cl_device *device, u8 *buf, size_t length);
 307         int (*recv)(struct mei_cl_device *device, u8 *buf, size_t length);
 308 };
 309
 310 struct mei_cl_device *mei_cl_add_device(struct mei_device *dev,
 311                                         uuid_le uuid, char *name,
 312                                         struct mei_cl_ops *ops);
 313 void mei_cl_remove_device(struct mei_cl_device *device);
 314
 315 int __mei_cl_async_send(struct mei_cl *cl, u8 *buf, size_t length);
 316 int __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length);
 317 int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length);
 318 void mei_cl_bus_rx_event(struct mei_cl *cl);
 319 void mei_cl_bus_remove_devices(struct mei_device *dev);
 320 int mei_cl_bus_init(void);
 321 void mei_cl_bus_exit(void);
 322
 323
 324 /**
 325  * struct mei_cl_device - MEI device handle
 326  * An mei_cl_device pointer is returned from mei_add_device()
 327  * and links MEI bus clients to their actual ME host client pointer.
 328  * Drivers for MEI devices will get an mei_cl_device pointer
 329  * when being probed and shall use it for doing ME bus I/O.
 330  *
 331  * @dev: linux driver model device pointer
 332  * @uuid: me client uuid
 333  * @cl: mei client
 334  * @ops: ME transport ops
 335  * @event_cb: Drivers register this callback to get asynchronous ME
 336  *      events (e.g. Rx buffer pending) notifications.
 337  * @events: Events bitmask sent to the driver.
 338  * @priv_data: client private data
 339  */
 340 struct mei_cl_device {
 341         struct device dev;
 342
 343         struct mei_cl *cl;
 344
 345         const struct mei_cl_ops *ops;
 346
 347         struct work_struct event_work;
 348         mei_cl_event_cb_t event_cb;
 349         void *event_context;
 350         unsigned long events;
 351
 352         void *priv_data;
 353 };
 354
 355
 356  /**
 357  * enum mei_pg_event - power gating transition events
 358  *
 359  * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition
 360  * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete
 361  * @MEI_PG_EVENT_RECEIVED: the driver received pg event
 362  */
 363 enum mei_pg_event {
 364         MEI_PG_EVENT_IDLE,
 365         MEI_PG_EVENT_WAIT,
 366         MEI_PG_EVENT_RECEIVED,
 367 };
 368
 369 /**
 370  * enum mei_pg_state - device internal power gating state
 371  *
 372  * @MEI_PG_OFF: device is not power gated - it is active
 373  * @MEI_PG_ON:  device is power gated - it is in lower power state
 374  */
 375 enum mei_pg_state {
 376         MEI_PG_OFF = 0,
 377         MEI_PG_ON =  1,
 378 };
 379
 380 /*
 381  * mei_cfg
 382  *
 383  * @fw_status - FW status
 384  * @quirk_probe - device exclusion quirk
 385  */
 386 struct mei_cfg {
 387         const struct mei_fw_status fw_status;
 388         bool (*quirk_probe)(struct pci_dev *pdev);
 389 };
 390
 391
 392 #define MEI_PCI_DEVICE(dev, cfg) \
 393         .vendor = PCI_VENDOR_ID_INTEL, .device = (dev), \
 394         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, \
 395         .driver_data = (kernel_ulong_t)&(cfg)
 396
 397
 398 /**
 399  * struct mei_device -  MEI private device struct
 400
 401  * @pdev - pointer to pci device struct
 402  * @cdev - character device
 403  * @minor - minor number allocated for device
 404  *
 405  * @reset_count - limits the number of consecutive resets
 406  * @hbm_state - state of host bus message protocol
 407  * @pg_event - power gating event
 408  * @mem_addr - mem mapped base register address
 409
 410  * @hbuf_depth - depth of hardware host/write buffer is slots
 411  * @hbuf_is_ready - query if the host host/write buffer is ready
 412  * @wr_msg - the buffer for hbm control messages
 413  * @cfg - per device generation config and ops
 414  */
 415 struct mei_device {
 416         struct pci_dev *pdev;   /* pointer to pci device struct */
 417         struct cdev cdev;
 418         int minor;
 419
 420         /*
 421          * lists of queues
 422          */
 423         /* array of pointers to aio lists */
 424         struct mei_cl_cb read_list;             /* driver read queue */
 425         struct mei_cl_cb write_list;            /* driver write queue */
 426         struct mei_cl_cb write_waiting_list;    /* write waiting queue */
 427         struct mei_cl_cb ctrl_wr_list;          /* managed write IOCTL list */
 428         struct mei_cl_cb ctrl_rd_list;          /* managed read IOCTL list */
 429
 430         /*
 431          * list of files
 432          */
 433         struct list_head file_list;
 434         long open_handle_count;
 435
 436         /*
 437          * lock for the device
 438          */
 439         struct mutex device_lock; /* device lock */
 440         struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
 441
 442         bool recvd_hw_ready;
 443         /*
 444          * waiting queue for receive message from FW
 445          */
 446         wait_queue_head_t wait_hw_ready;
 447         wait_queue_head_t wait_pg;
 448         wait_queue_head_t wait_recvd_msg;
 449         wait_queue_head_t wait_stop_wd;
 450
 451         /*
 452          * mei device  states
 453          */
 454         unsigned long reset_count;
 455         enum mei_dev_state dev_state;
 456         enum mei_hbm_state hbm_state;
 457         u16 init_clients_timer;
 458
 459         /*
 460          * Power Gating support
 461          */
 462         enum mei_pg_event pg_event;
 463 #ifdef CONFIG_PM_RUNTIME
 464         struct dev_pm_domain pg_domain;
 465 #endif /* CONFIG_PM_RUNTIME */
 466
 467         unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];  /* control messages */
 468         u32 rd_msg_hdr;
 469
 470         /* write buffer */
 471         u8 hbuf_depth;
 472         bool hbuf_is_ready;
 473
 474         /* used for control messages */
 475         struct {
 476                 struct mei_msg_hdr hdr;
 477                 unsigned char data[128];
 478         } wr_msg;
 479
 480         struct hbm_version version;
 481
 482         struct list_head me_clients;
 483         DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
 484         DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
 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