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