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