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 const char *mei_pg_state_str(enum mei_pg_state state);
 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  * @dev  - device on a bus
 403  * @cdev - character device
 404  * @minor - minor number allocated for device
 405  *
 406  * @reset_count - limits the number of consecutive resets
 407  * @hbm_state - state of host bus message protocol
 408  *
 409  * @hbm_f_pg_supported - hbm feature pgi protocol
 410  *
 411  * @pg_event - power gating event
 412  * @mem_addr - mem mapped base register address
 413
 414  * @hbuf_depth - depth of hardware host/write buffer is slots
 415  * @hbuf_is_ready - query if the host host/write buffer is ready
 416  * @wr_msg - the buffer for hbm control messages
 417  * @cfg - per device generation config and ops
 418  */
 419 struct mei_device {
 420         struct pci_dev *pdev;   /* pointer to pci device struct */
 421         struct device *dev;
 422         struct cdev cdev;
 423         int minor;
 424
 425         /*
 426          * lists of queues
 427          */
 428         /* array of pointers to aio lists */
 429         struct mei_cl_cb read_list;             /* driver read queue */
 430         struct mei_cl_cb write_list;            /* driver write queue */
 431         struct mei_cl_cb write_waiting_list;    /* write waiting queue */
 432         struct mei_cl_cb ctrl_wr_list;          /* managed write IOCTL list */
 433         struct mei_cl_cb ctrl_rd_list;          /* managed read IOCTL list */
 434
 435         /*
 436          * list of files
 437          */
 438         struct list_head file_list;
 439         long open_handle_count;
 440
 441         /*
 442          * lock for the device
 443          */
 444         struct mutex device_lock; /* device lock */
 445         struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
 446
 447         bool recvd_hw_ready;
 448         /*
 449          * waiting queue for receive message from FW
 450          */
 451         wait_queue_head_t wait_hw_ready;
 452         wait_queue_head_t wait_pg;
 453         wait_queue_head_t wait_hbm_start;
 454         wait_queue_head_t wait_stop_wd;
 455
 456         /*
 457          * mei device  states
 458          */
 459         unsigned long reset_count;
 460         enum mei_dev_state dev_state;
 461         enum mei_hbm_state hbm_state;
 462         u16 init_clients_timer;
 463
 464         /*
 465          * Power Gating support
 466          */
 467         enum mei_pg_event pg_event;
 468 #ifdef CONFIG_PM_RUNTIME
 469         struct dev_pm_domain pg_domain;
 470 #endif /* CONFIG_PM_RUNTIME */
 471
 472         unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];  /* control messages */
 473         u32 rd_msg_hdr;
 474
 475         /* write buffer */
 476         u8 hbuf_depth;
 477         bool hbuf_is_ready;
 478
 479         /* used for control messages */
 480         struct {
 481                 struct mei_msg_hdr hdr;
 482                 unsigned char data[128];
 483         } wr_msg;
 484
 485         struct hbm_version version;
 486         unsigned int hbm_f_pg_supported:1;
 487
 488         struct list_head me_clients;
 489         DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
 490         DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
 491         unsigned long me_client_presentation_num;
 492         unsigned long me_client_index;
 493
 494         struct mei_cl wd_cl;
 495         enum mei_wd_states wd_state;
 496         bool wd_pending;
 497         u16 wd_timeout;
 498         unsigned char wd_data[MEI_WD_START_MSG_SIZE];
 499
 500
 501         /* amthif list for cmd waiting */
 502         struct mei_cl_cb amthif_cmd_list;
 503         /* driver managed amthif list for reading completed amthif cmd data */
 504         struct mei_cl_cb amthif_rd_complete_list;
 505         struct file *iamthif_file_object;
 506         struct mei_cl iamthif_cl;
 507         struct mei_cl_cb *iamthif_current_cb;
 508         long iamthif_open_count;
 509         int iamthif_mtu;
 510         unsigned long iamthif_timer;
 511         u32 iamthif_stall_timer;
 512         unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
 513         u32 iamthif_msg_buf_size;
 514         u32 iamthif_msg_buf_index;
 515         enum iamthif_states iamthif_state;
 516         bool iamthif_flow_control_pending;
 517         bool iamthif_ioctl;
 518         bool iamthif_canceled;
 519
 520         struct work_struct init_work;
 521         struct work_struct reset_work;
 522
 523         /* List of bus devices */
 524         struct list_head device_list;
 525
 526 #if IS_ENABLED(CONFIG_DEBUG_FS)
 527         struct dentry *dbgfs_dir;
 528 #endif /* CONFIG_DEBUG_FS */
 529
 530
 531         const struct mei_hw_ops *ops;
 532         const struct mei_cfg *cfg;
 533         char hw[0] __aligned(sizeof(void *));
 534 };
 535
 536 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
 537 {
 538         return msecs_to_jiffies(sec * MSEC_PER_SEC);
 539 }
 540
 541 /**
 542  * mei_data2slots - get slots - number of (dwords) from a message length
 543  *      + size of the mei header
 544  * @length - size of the messages in bytes
 545  * returns  - number of slots
 546  */
 547 static inline u32 mei_data2slots(size_t length)
 548 {
 549         return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
 550 }
 551
 552 /**
 553  * mei_slots2data- get data in slots - bytes from slots
 554  * @slots -  number of available slots
 555  * returns  - number of bytes in slots
 556  */
 557 static inline u32 mei_slots2data(int slots)
 558 {
 559         return slots * 4;
 560 }
 561
 562 /*
 563  * mei init function prototypes
 564  */
 565 void mei_device_init(struct mei_device *dev,
 566                      struct device *device,
 567                      const struct mei_hw_ops *hw_ops);
 568 int mei_reset(struct mei_device *dev);
 569 int mei_start(struct mei_device *dev);
 570 int mei_restart(struct mei_device *dev);
 571 void mei_stop(struct mei_device *dev);
 572 void mei_cancel_work(struct mei_device *dev);
 573
 574 /*
 575  *  MEI interrupt functions prototype
 576  */
 577
 578 void mei_timer(struct work_struct *work);
 579 int mei_irq_read_handler(struct mei_device *dev,
 580                 struct mei_cl_cb *cmpl_list, s32 *slots);
 581
 582 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
 583 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
 584
 585 /*
 586  * AMTHIF - AMT Host Interface Functions
 587  */
 588 void mei_amthif_reset_params(struct mei_device *dev);
 589
 590 int mei_amthif_host_init(struct mei_device *dev);
 591
 592 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
 593
 594 int mei_amthif_read(struct mei_device *dev, struct file *file,
 595                 char __user *ubuf, size_t length, loff_t *offset);
 596
 597 unsigned int mei_amthif_poll(struct mei_device *dev,
 598                 struct file *file, poll_table *wait);
 599
 600 int mei_amthif_release(struct mei_device *dev, struct file *file);
 601
 602 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
 603                                                 struct file *file);
 604
 605 void mei_amthif_run_next_cmd(struct mei_device *dev);
 606
 607 int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
 608                         struct mei_cl_cb *cmpl_list);
 609
 610 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
 611 int mei_amthif_irq_read_msg(struct mei_device *dev,
 612                             struct mei_msg_hdr *mei_hdr,
 613                             struct mei_cl_cb *complete_list);
 614 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
 615
 616 /*
 617  * NFC functions
 618  */
 619 int mei_nfc_host_init(struct mei_device *dev);
 620 void mei_nfc_host_exit(struct mei_device *dev);
 621
 622 /*
 623  * NFC Client UUID
 624  */
 625 extern const uuid_le mei_nfc_guid;
 626
 627 int mei_wd_send(struct mei_device *dev);
 628 int mei_wd_stop(struct mei_device *dev);
 629 int mei_wd_host_init(struct mei_device *dev);
 630 /*
 631  * mei_watchdog_register  - Registering watchdog interface
 632  *   once we got connection to the WD Client
 633  * @dev - mei device
 634  */
 635 int mei_watchdog_register(struct mei_device *dev);
 636 /*
 637  * mei_watchdog_unregister  - Unregistering watchdog interface
 638  * @dev - mei device
 639  */
 640 void mei_watchdog_unregister(struct mei_device *dev);
 641
 642 /*
 643  * Register Access Function
 644  */
 645
 646
 647 static inline void mei_hw_config(struct mei_device *dev)
 648 {
 649         dev->ops->hw_config(dev);
 650 }
 651
 652 static inline enum mei_pg_state mei_pg_state(struct mei_device *dev)
 653 {
 654         return dev->ops->pg_state(dev);
 655 }
 656
 657 static inline bool mei_pg_is_enabled(struct mei_device *dev)
 658 {
 659         return dev->ops->pg_is_enabled(dev);
 660 }
 661
 662 static inline int mei_hw_reset(struct mei_device *dev, bool enable)
 663 {
 664         return dev->ops->hw_reset(dev, enable);
 665 }
 666
 667 static inline int mei_hw_start(struct mei_device *dev)
 668 {
 669         return dev->ops->hw_start(dev);
 670 }
 671
 672 static inline void mei_clear_interrupts(struct mei_device *dev)
 673 {
 674         dev->ops->intr_clear(dev);
 675 }
 676
 677 static inline void mei_enable_interrupts(struct mei_device *dev)
 678 {
 679         dev->ops->intr_enable(dev);
 680 }
 681
 682 static inline void mei_disable_interrupts(struct mei_device *dev)
 683 {
 684         dev->ops->intr_disable(dev);
 685 }
 686
 687 static inline bool mei_host_is_ready(struct mei_device *dev)
 688 {
 689         return dev->ops->host_is_ready(dev);
 690 }
 691 static inline bool mei_hw_is_ready(struct mei_device *dev)
 692 {
 693         return dev->ops->hw_is_ready(dev);
 694 }
 695
 696 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
 697 {
 698         return dev->ops->hbuf_is_ready(dev);
 699 }
 700
 701 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
 702 {
 703         return dev->ops->hbuf_free_slots(dev);
 704 }
 705
 706 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
 707 {
 708         return dev->ops->hbuf_max_len(dev);
 709 }
 710
 711 static inline int mei_write_message(struct mei_device *dev,
 712                         struct mei_msg_hdr *hdr,
 713                         unsigned char *buf)
 714 {
 715         return dev->ops->write(dev, hdr, buf);
 716 }
 717
 718 static inline u32 mei_read_hdr(const struct mei_device *dev)
 719 {
 720         return dev->ops->read_hdr(dev);
 721 }
 722
 723 static inline void mei_read_slots(struct mei_device *dev,
 724                      unsigned char *buf, unsigned long len)
 725 {
 726         dev->ops->read(dev, buf, len);
 727 }
 728
 729 static inline int mei_count_full_read_slots(struct mei_device *dev)
 730 {
 731         return dev->ops->rdbuf_full_slots(dev);
 732 }
 733
 734 int mei_fw_status(struct mei_device *dev, struct mei_fw_status *fw_status);
 735
 736 #define FW_STS_FMT "%08X %08X"
 737 #define FW_STS_PRM(fw_status) \
 738         (fw_status).count > 0 ? (fw_status).status[0] : 0xDEADBEEF, \
 739         (fw_status).count > 1 ? (fw_status).status[1] : 0xDEADBEEF
 740
 741 bool mei_hbuf_acquire(struct mei_device *dev);
 742
 743 bool mei_write_is_idle(struct mei_device *dev);
 744
 745 #if IS_ENABLED(CONFIG_DEBUG_FS)
 746 int mei_dbgfs_register(struct mei_device *dev, const char *name);
 747 void mei_dbgfs_deregister(struct mei_device *dev);
 748 #else
 749 static inline int mei_dbgfs_register(struct mei_device *dev, const char *name)
 750 {
 751         return 0;
 752 }
 753 static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
 754 #endif /* CONFIG_DEBUG_FS */
 755
 756 int mei_register(struct mei_device *dev, struct device *parent);
 757 void mei_deregister(struct mei_device *dev);
 758
 759 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
 760 #define MEI_HDR_PRM(hdr)                  \
 761         (hdr)->host_addr, (hdr)->me_addr, \
 762         (hdr)->length, (hdr)->internal, (hdr)->msg_complete
 763
 764 #endif