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