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 6
 156 /* Minimal  buffer for FW status string (8 bytes in dw + space or '\0') */
 157 #define MEI_FW_STATUS_STR_SZ (MEI_FW_STATUS_MAX * (8 + 1))
 158
 159
 160 /*
 161  * struct mei_fw_status - storage of FW status data
 162  *
 163  * @count: number of actually available elements in array
 164  * @status: FW status registers
 165  */
 166 struct mei_fw_status {
 167         int count;
 168         u32 status[MEI_FW_STATUS_MAX];
 169 };
 170
 171 /**
 172  * struct mei_me_client - representation of me (fw) client
 173  *
 174  * @list: link in me client list
 175  * @refcnt: struct reference count
 176  * @props: client properties
 177  * @client_id: me client id
 178  * @mei_flow_ctrl_creds: flow control credits
 179  */
 180 struct mei_me_client {
 181         struct list_head list;
 182         struct kref refcnt;
 183         struct mei_client_properties props;
 184         u8 client_id;
 185         u8 mei_flow_ctrl_creds;
 186 };
 187
 188
 189 struct mei_cl;
 190
 191 /**
 192  * struct mei_cl_cb - file operation callback structure
 193  *
 194  * @list: link in callback queue
 195  * @cl: file client who is running this operation
 196  * @fop_type: file operation type
 197  * @buf: buffer for data associated with the callback
 198  * @buf_idx: last read index
 199  * @read_time: last read operation time stamp (iamthif)
 200  * @file_object: pointer to file structure
 201  * @status: io status of the cb
 202  * @internal: communication between driver and FW flag
 203  * @completed: the transfer or reception has completed
 204  */
 205 struct mei_cl_cb {
 206         struct list_head list;
 207         struct mei_cl *cl;
 208         enum mei_cb_file_ops fop_type;
 209         struct mei_msg_data buf;
 210         unsigned long buf_idx;
 211         unsigned long read_time;
 212         struct file *file_object;
 213         int status;
 214         u32 internal:1;
 215         u32 completed:1;
 216 };
 217
 218 /**
 219  * struct mei_cl - me client host representation
 220  *    carried in file->private_data
 221  *
 222  * @link: link in the clients list
 223  * @dev: mei parent device
 224  * @state: file operation state
 225  * @tx_wait: wait queue for tx completion
 226  * @rx_wait: wait queue for rx completion
 227  * @wait:  wait queue for management operation
 228  * @status: connection status
 229  * @cl_uuid: client uuid name
 230  * @host_client_id: host id
 231  * @me_client_id: me/fw id
 232  * @mei_flow_ctrl_creds: transmit flow credentials
 233  * @timer_count:  watchdog timer for operation completion
 234  * @writing_state: state of the tx
 235  * @rd_pending: pending read credits
 236  * @rd_completed: completed read
 237  *
 238  * @device: device on the mei client bus
 239  * @device_link:  link to bus clients
 240  */
 241 struct mei_cl {
 242         struct list_head link;
 243         struct mei_device *dev;
 244         enum file_state state;
 245         wait_queue_head_t tx_wait;
 246         wait_queue_head_t rx_wait;
 247         wait_queue_head_t wait;
 248         int status;
 249         uuid_le cl_uuid;
 250         u8 host_client_id;
 251         u8 me_client_id;
 252         u8 mei_flow_ctrl_creds;
 253         u8 timer_count;
 254         enum mei_file_transaction_states writing_state;
 255         struct list_head rd_pending;
 256         struct list_head rd_completed;
 257
 258         /* MEI CL bus data */
 259         struct mei_cl_device *device;
 260         struct list_head device_link;
 261 };
 262
 263 /** struct mei_hw_ops
 264  *
 265  * @host_is_ready    : query for host readiness
 266
 267  * @hw_is_ready      : query if hw is ready
 268  * @hw_reset         : reset hw
 269  * @hw_start         : start hw after reset
 270  * @hw_config        : configure hw
 271
 272  * @fw_status        : get fw status registers
 273  * @pg_state         : power gating state of the device
 274  * @pg_in_transition : is device now in pg transition
 275  * @pg_is_enabled    : is power gating enabled
 276
 277  * @intr_clear       : clear pending interrupts
 278  * @intr_enable      : enable interrupts
 279  * @intr_disable     : disable interrupts
 280
 281  * @hbuf_free_slots  : query for write buffer empty slots
 282  * @hbuf_is_ready    : query if write buffer is empty
 283  * @hbuf_max_len     : query for write buffer max len
 284
 285  * @write            : write a message to FW
 286
 287  * @rdbuf_full_slots : query how many slots are filled
 288
 289  * @read_hdr         : get first 4 bytes (header)
 290  * @read             : read a buffer from the FW
 291  */
 292 struct mei_hw_ops {
 293
 294         bool (*host_is_ready)(struct mei_device *dev);
 295
 296         bool (*hw_is_ready)(struct mei_device *dev);
 297         int (*hw_reset)(struct mei_device *dev, bool enable);
 298         int (*hw_start)(struct mei_device *dev);
 299         void (*hw_config)(struct mei_device *dev);
 300
 301
 302         int (*fw_status)(struct mei_device *dev, struct mei_fw_status *fw_sts);
 303         enum mei_pg_state (*pg_state)(struct mei_device *dev);
 304         bool (*pg_in_transition)(struct mei_device *dev);
 305         bool (*pg_is_enabled)(struct mei_device *dev);
 306
 307         void (*intr_clear)(struct mei_device *dev);
 308         void (*intr_enable)(struct mei_device *dev);
 309         void (*intr_disable)(struct mei_device *dev);
 310
 311         int (*hbuf_free_slots)(struct mei_device *dev);
 312         bool (*hbuf_is_ready)(struct mei_device *dev);
 313         size_t (*hbuf_max_len)(const struct mei_device *dev);
 314
 315         int (*write)(struct mei_device *dev,
 316                      struct mei_msg_hdr *hdr,
 317                      unsigned char *buf);
 318
 319         int (*rdbuf_full_slots)(struct mei_device *dev);
 320
 321         u32 (*read_hdr)(const struct mei_device *dev);
 322         int (*read)(struct mei_device *dev,
 323                      unsigned char *buf, unsigned long len);
 324 };
 325
 326 /* MEI bus API*/
 327
 328 /**
 329  * struct mei_cl_ops - MEI CL device ops
 330  * This structure allows ME host clients to implement technology
 331  * specific operations.
 332  *
 333  * @enable: Enable an MEI CL device. Some devices require specific
 334  *      HECI commands to initialize completely.
 335  * @disable: Disable an MEI CL device.
 336  * @send: Tx hook for the device. This allows ME host clients to trap
 337  *      the device driver buffers before actually physically
 338  *      pushing it to the ME.
 339  * @recv: Rx hook for the device. This allows ME host clients to trap the
 340  *      ME buffers before forwarding them to the device driver.
 341  */
 342 struct mei_cl_ops {
 343         int (*enable)(struct mei_cl_device *device);
 344         int (*disable)(struct mei_cl_device *device);
 345         int (*send)(struct mei_cl_device *device, u8 *buf, size_t length);
 346         int (*recv)(struct mei_cl_device *device, u8 *buf, size_t length);
 347 };
 348
 349 struct mei_cl_device *mei_cl_add_device(struct mei_device *dev,
 350                                         uuid_le uuid, char *name,
 351                                         struct mei_cl_ops *ops);
 352 void mei_cl_remove_device(struct mei_cl_device *device);
 353
 354 ssize_t __mei_cl_async_send(struct mei_cl *cl, u8 *buf, size_t length);
 355 ssize_t __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length);
 356 ssize_t __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length);
 357 void mei_cl_bus_rx_event(struct mei_cl *cl);
 358 void mei_cl_bus_remove_devices(struct mei_device *dev);
 359 int mei_cl_bus_init(void);
 360 void mei_cl_bus_exit(void);
 361 struct mei_cl *mei_cl_bus_find_cl_by_uuid(struct mei_device *dev, uuid_le uuid);
 362
 363
 364 /**
 365  * struct mei_cl_device - MEI device handle
 366  * An mei_cl_device pointer is returned from mei_add_device()
 367  * and links MEI bus clients to their actual ME host client pointer.
 368  * Drivers for MEI devices will get an mei_cl_device pointer
 369  * when being probed and shall use it for doing ME bus I/O.
 370  *
 371  * @dev: linux driver model device pointer
 372  * @cl: mei client
 373  * @ops: ME transport ops
 374  * @event_work: async work to execute event callback
 375  * @event_cb: Drivers register this callback to get asynchronous ME
 376  *      events (e.g. Rx buffer pending) notifications.
 377  * @event_context: event callback run context
 378  * @events: Events bitmask sent to the driver.
 379  * @priv_data: client private data
 380  */
 381 struct mei_cl_device {
 382         struct device dev;
 383
 384         struct mei_cl *cl;
 385
 386         const struct mei_cl_ops *ops;
 387
 388         struct work_struct event_work;
 389         mei_cl_event_cb_t event_cb;
 390         void *event_context;
 391         unsigned long events;
 392
 393         void *priv_data;
 394 };
 395
 396
 397 /**
 398  * enum mei_pg_event - power gating transition events
 399  *
 400  * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition
 401  * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete
 402  * @MEI_PG_EVENT_RECEIVED: the driver received pg event
 403  * @MEI_PG_EVENT_INTR_WAIT: the driver is waiting for a pg event interrupt
 404  * @MEI_PG_EVENT_INTR_RECEIVED: the driver received pg event interrupt
 405  */
 406 enum mei_pg_event {
 407         MEI_PG_EVENT_IDLE,
 408         MEI_PG_EVENT_WAIT,
 409         MEI_PG_EVENT_RECEIVED,
 410         MEI_PG_EVENT_INTR_WAIT,
 411         MEI_PG_EVENT_INTR_RECEIVED,
 412 };
 413
 414 /**
 415  * enum mei_pg_state - device internal power gating state
 416  *
 417  * @MEI_PG_OFF: device is not power gated - it is active
 418  * @MEI_PG_ON:  device is power gated - it is in lower power state
 419  */
 420 enum mei_pg_state {
 421         MEI_PG_OFF = 0,
 422         MEI_PG_ON =  1,
 423 };
 424
 425 const char *mei_pg_state_str(enum mei_pg_state state);
 426
 427 /**
 428  * struct mei_device -  MEI private device struct
 429  *
 430  * @dev         : device on a bus
 431  * @cdev        : character device
 432  * @minor       : minor number allocated for device
 433  *
 434  * @write_list  : write pending list
 435  * @write_waiting_list : write completion list
 436  * @ctrl_wr_list : pending control write list
 437  * @ctrl_rd_list : pending control read list
 438  *
 439  * @file_list   : list of opened handles
 440  * @open_handle_count: number of opened handles
 441  *
 442  * @device_lock : big device lock
 443  * @timer_work  : MEI timer delayed work (timeouts)
 444  *
 445  * @recvd_hw_ready : hw ready message received flag
 446  *
 447  * @wait_hw_ready : wait queue for receive HW ready message form FW
 448  * @wait_pg     : wait queue for receive PG message from FW
 449  * @wait_hbm_start : wait queue for receive HBM start message from FW
 450  * @wait_stop_wd : wait queue for receive WD stop message from FW
 451  *
 452  * @reset_count : number of consecutive resets
 453  * @dev_state   : device state
 454  * @hbm_state   : state of host bus message protocol
 455  * @init_clients_timer : HBM init handshake timeout
 456  *
 457  * @pg_event    : power gating event
 458  * @pg_domain   : runtime PM domain
 459  *
 460  * @rd_msg_buf  : control messages buffer
 461  * @rd_msg_hdr  : read message header storage
 462  *
 463  * @hbuf_depth  : depth of hardware host/write buffer is slots
 464  * @hbuf_is_ready : query if the host host/write buffer is ready
 465  * @wr_msg      : the buffer for hbm control messages
 466  *
 467  * @version     : HBM protocol version in use
 468  * @hbm_f_pg_supported : hbm feature pgi protocol
 469  *
 470  * @me_clients_rwsem: rw lock over me_clients list
 471  * @me_clients  : list of FW clients
 472  * @me_clients_map : FW clients bit map
 473  * @host_clients_map : host clients id pool
 474  * @me_client_index : last FW client index in enumeration
 475  *
 476  * @wd_cl       : watchdog client
 477  * @wd_state    : watchdog client state
 478  * @wd_pending  : watchdog command is pending
 479  * @wd_timeout  : watchdog expiration timeout
 480  * @wd_data     : watchdog message buffer
 481  *
 482  * @amthif_cmd_list : amthif list for cmd waiting
 483  * @amthif_rd_complete_list : amthif list for reading completed cmd data
 484  * @iamthif_file_object : file for current amthif operation
 485  * @iamthif_cl  : amthif host client
 486  * @iamthif_current_cb : amthif current operation callback
 487  * @iamthif_open_count : number of opened amthif connections
 488  * @iamthif_mtu : amthif client max message length
 489  * @iamthif_timer : time stamp of current amthif command completion
 490  * @iamthif_stall_timer : timer to detect amthif hang
 491  * @iamthif_state : amthif processor state
 492  * @iamthif_canceled : current amthif command is canceled
 493  *
 494  * @init_work   : work item for the device init
 495  * @reset_work  : work item for the device reset
 496  *
 497  * @device_list : mei client bus list
 498  *
 499  * @dbgfs_dir   : debugfs mei root directory
 500  *
 501  * @ops:        : hw specific operations
 502  * @hw          : hw specific data
 503  */
 504 struct mei_device {
 505         struct device *dev;
 506         struct cdev cdev;
 507         int minor;
 508
 509         struct mei_cl_cb write_list;
 510         struct mei_cl_cb write_waiting_list;
 511         struct mei_cl_cb ctrl_wr_list;
 512         struct mei_cl_cb ctrl_rd_list;
 513
 514         struct list_head file_list;
 515         long open_handle_count;
 516
 517         struct mutex device_lock;
 518         struct delayed_work timer_work;
 519
 520         bool recvd_hw_ready;
 521         /*
 522          * waiting queue for receive message from FW
 523          */
 524         wait_queue_head_t wait_hw_ready;
 525         wait_queue_head_t wait_pg;
 526         wait_queue_head_t wait_hbm_start;
 527         wait_queue_head_t wait_stop_wd;
 528
 529         /*
 530          * mei device  states
 531          */
 532         unsigned long reset_count;
 533         enum mei_dev_state dev_state;
 534         enum mei_hbm_state hbm_state;
 535         u16 init_clients_timer;
 536
 537         /*
 538          * Power Gating support
 539          */
 540         enum mei_pg_event pg_event;
 541 #ifdef CONFIG_PM
 542         struct dev_pm_domain pg_domain;
 543 #endif /* CONFIG_PM */
 544
 545         unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];
 546         u32 rd_msg_hdr;
 547
 548         /* write buffer */
 549         u8 hbuf_depth;
 550         bool hbuf_is_ready;
 551
 552         /* used for control messages */
 553         struct {
 554                 struct mei_msg_hdr hdr;
 555                 unsigned char data[128];
 556         } wr_msg;
 557
 558         struct hbm_version version;
 559         unsigned int hbm_f_pg_supported:1;
 560
 561         struct rw_semaphore me_clients_rwsem;
 562         struct list_head me_clients;
 563         DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
 564         DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
 565         unsigned long me_client_index;
 566
 567         struct mei_cl wd_cl;
 568         enum mei_wd_states wd_state;
 569         bool wd_pending;
 570         u16 wd_timeout;
 571         unsigned char wd_data[MEI_WD_START_MSG_SIZE];
 572
 573
 574         /* amthif list for cmd waiting */
 575         struct mei_cl_cb amthif_cmd_list;
 576         /* driver managed amthif list for reading completed amthif cmd data */
 577         struct mei_cl_cb amthif_rd_complete_list;
 578         struct file *iamthif_file_object;
 579         struct mei_cl iamthif_cl;
 580         struct mei_cl_cb *iamthif_current_cb;
 581         long iamthif_open_count;
 582         int iamthif_mtu;
 583         unsigned long iamthif_timer;
 584         u32 iamthif_stall_timer;
 585         enum iamthif_states iamthif_state;
 586         bool iamthif_canceled;
 587
 588         struct work_struct init_work;
 589         struct work_struct reset_work;
 590
 591         /* List of bus devices */
 592         struct list_head device_list;
 593
 594 #if IS_ENABLED(CONFIG_DEBUG_FS)
 595         struct dentry *dbgfs_dir;
 596 #endif /* CONFIG_DEBUG_FS */
 597
 598
 599         const struct mei_hw_ops *ops;
 600         char hw[0] __aligned(sizeof(void *));
 601 };
 602
 603 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
 604 {
 605         return msecs_to_jiffies(sec * MSEC_PER_SEC);
 606 }
 607
 608 /**
 609  * mei_data2slots - get slots - number of (dwords) from a message length
 610  *      + size of the mei header
 611  *
 612  * @length: size of the messages in bytes
 613  *
 614  * Return: number of slots
 615  */
 616 static inline u32 mei_data2slots(size_t length)
 617 {
 618         return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
 619 }
 620
 621 /**
 622  * mei_slots2data - get data in slots - bytes from slots
 623  *
 624  * @slots: number of available slots
 625  *
 626  * Return: number of bytes in slots
 627  */
 628 static inline u32 mei_slots2data(int slots)
 629 {
 630         return slots * 4;
 631 }
 632
 633 /*
 634  * mei init function prototypes
 635  */
 636 void mei_device_init(struct mei_device *dev,
 637                      struct device *device,
 638                      const struct mei_hw_ops *hw_ops);
 639 int mei_reset(struct mei_device *dev);
 640 int mei_start(struct mei_device *dev);
 641 int mei_restart(struct mei_device *dev);
 642 void mei_stop(struct mei_device *dev);
 643 void mei_cancel_work(struct mei_device *dev);
 644
 645 /*
 646  *  MEI interrupt functions prototype
 647  */
 648
 649 void mei_timer(struct work_struct *work);
 650 int mei_irq_read_handler(struct mei_device *dev,
 651                 struct mei_cl_cb *cmpl_list, s32 *slots);
 652
 653 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
 654 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
 655
 656 /*
 657  * AMTHIF - AMT Host Interface Functions
 658  */
 659 void mei_amthif_reset_params(struct mei_device *dev);
 660
 661 int mei_amthif_host_init(struct mei_device *dev);
 662
 663 int mei_amthif_read(struct mei_device *dev, struct file *file,
 664                 char __user *ubuf, size_t length, loff_t *offset);
 665
 666 unsigned int mei_amthif_poll(struct mei_device *dev,
 667                 struct file *file, poll_table *wait);
 668
 669 int mei_amthif_release(struct mei_device *dev, struct file *file);
 670
 671 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
 672                                                 struct file *file);
 673
 674 int mei_amthif_write(struct mei_cl *cl, struct mei_cl_cb *cb);
 675 int mei_amthif_run_next_cmd(struct mei_device *dev);
 676 int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
 677                         struct mei_cl_cb *cmpl_list);
 678
 679 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
 680 int mei_amthif_irq_read_msg(struct mei_cl *cl,
 681                             struct mei_msg_hdr *mei_hdr,
 682                             struct mei_cl_cb *complete_list);
 683 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
 684
 685 /*
 686  * NFC functions
 687  */
 688 int mei_nfc_host_init(struct mei_device *dev);
 689 void mei_nfc_host_exit(struct mei_device *dev);
 690
 691 /*
 692  * NFC Client UUID
 693  */
 694 extern const uuid_le mei_nfc_guid;
 695
 696 int mei_wd_send(struct mei_device *dev);
 697 int mei_wd_stop(struct mei_device *dev);
 698 int mei_wd_host_init(struct mei_device *dev);
 699 /*
 700  * mei_watchdog_register  - Registering watchdog interface
 701  *   once we got connection to the WD Client
 702  * @dev: mei device
 703  */
 704 int mei_watchdog_register(struct mei_device *dev);
 705 /*
 706  * mei_watchdog_unregister  - Unregistering watchdog interface
 707  * @dev: mei device
 708  */
 709 void mei_watchdog_unregister(struct mei_device *dev);
 710
 711 /*
 712  * Register Access Function
 713  */
 714
 715
 716 static inline void mei_hw_config(struct mei_device *dev)
 717 {
 718         dev->ops->hw_config(dev);
 719 }
 720
 721 static inline enum mei_pg_state mei_pg_state(struct mei_device *dev)
 722 {
 723         return dev->ops->pg_state(dev);
 724 }
 725
 726 static inline bool mei_pg_in_transition(struct mei_device *dev)
 727 {
 728         return dev->ops->pg_in_transition(dev);
 729 }
 730
 731 static inline bool mei_pg_is_enabled(struct mei_device *dev)
 732 {
 733         return dev->ops->pg_is_enabled(dev);
 734 }
 735
 736 static inline int mei_hw_reset(struct mei_device *dev, bool enable)
 737 {
 738         return dev->ops->hw_reset(dev, enable);
 739 }
 740
 741 static inline int mei_hw_start(struct mei_device *dev)
 742 {
 743         return dev->ops->hw_start(dev);
 744 }
 745
 746 static inline void mei_clear_interrupts(struct mei_device *dev)
 747 {
 748         dev->ops->intr_clear(dev);
 749 }
 750
 751 static inline void mei_enable_interrupts(struct mei_device *dev)
 752 {
 753         dev->ops->intr_enable(dev);
 754 }
 755
 756 static inline void mei_disable_interrupts(struct mei_device *dev)
 757 {
 758         dev->ops->intr_disable(dev);
 759 }
 760
 761 static inline bool mei_host_is_ready(struct mei_device *dev)
 762 {
 763         return dev->ops->host_is_ready(dev);
 764 }
 765 static inline bool mei_hw_is_ready(struct mei_device *dev)
 766 {
 767         return dev->ops->hw_is_ready(dev);
 768 }
 769
 770 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
 771 {
 772         return dev->ops->hbuf_is_ready(dev);
 773 }
 774
 775 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
 776 {
 777         return dev->ops->hbuf_free_slots(dev);
 778 }
 779
 780 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
 781 {
 782         return dev->ops->hbuf_max_len(dev);
 783 }
 784
 785 static inline int mei_write_message(struct mei_device *dev,
 786                         struct mei_msg_hdr *hdr,
 787                         unsigned char *buf)
 788 {
 789         return dev->ops->write(dev, hdr, buf);
 790 }
 791
 792 static inline u32 mei_read_hdr(const struct mei_device *dev)
 793 {
 794         return dev->ops->read_hdr(dev);
 795 }
 796
 797 static inline void mei_read_slots(struct mei_device *dev,
 798                      unsigned char *buf, unsigned long len)
 799 {
 800         dev->ops->read(dev, buf, len);
 801 }
 802
 803 static inline int mei_count_full_read_slots(struct mei_device *dev)
 804 {
 805         return dev->ops->rdbuf_full_slots(dev);
 806 }
 807
 808 static inline int mei_fw_status(struct mei_device *dev,
 809                                 struct mei_fw_status *fw_status)
 810 {
 811         return dev->ops->fw_status(dev, fw_status);
 812 }
 813
 814 bool mei_hbuf_acquire(struct mei_device *dev);
 815
 816 bool mei_write_is_idle(struct mei_device *dev);
 817
 818 #if IS_ENABLED(CONFIG_DEBUG_FS)
 819 int mei_dbgfs_register(struct mei_device *dev, const char *name);
 820 void mei_dbgfs_deregister(struct mei_device *dev);
 821 #else
 822 static inline int mei_dbgfs_register(struct mei_device *dev, const char *name)
 823 {
 824         return 0;
 825 }
 826 static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
 827 #endif /* CONFIG_DEBUG_FS */
 828
 829 int mei_register(struct mei_device *dev, struct device *parent);
 830 void mei_deregister(struct mei_device *dev);
 831
 832 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d"
 833 #define MEI_HDR_PRM(hdr)                  \
 834         (hdr)->host_addr, (hdr)->me_addr, \
 835         (hdr)->length, (hdr)->internal, (hdr)->msg_complete
 836
 837 ssize_t mei_fw_status2str(struct mei_fw_status *fw_sts, char *buf, size_t len);
 838 /**
 839  * mei_fw_status_str - fetch and convert fw status registers to printable string
 840  *
 841  * @dev: the device structure
 842  * @buf: string buffer at minimal size MEI_FW_STATUS_STR_SZ
 843  * @len: buffer len must be >= MEI_FW_STATUS_STR_SZ
 844  *
 845  * Return: number of bytes written or < 0 on failure
 846  */
 847 static inline ssize_t mei_fw_status_str(struct mei_device *dev,
 848                                         char *buf, size_t len)
 849 {
 850         struct mei_fw_status fw_status;
 851         int ret;
 852
 853         buf[0] = '\0';
 854
 855         ret = mei_fw_status(dev, &fw_status);
 856         if (ret)
 857                 return ret;
 858
 859         ret = mei_fw_status2str(&fw_status, buf, MEI_FW_STATUS_STR_SZ);
 860
 861         return ret;
 862 }
 863
 864
 865 #endif