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