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