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