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 "hw-me-regs.h"
  28 #include "hbm.h"
  29
  30 /*
  31  * watch dog definition
  32  */
  33 #define MEI_WD_HDR_SIZE       4
  34 #define MEI_WD_STOP_MSG_SIZE  MEI_WD_HDR_SIZE
  35 #define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)
  36
  37 #define MEI_WD_DEFAULT_TIMEOUT   120  /* seconds */
  38 #define MEI_WD_MIN_TIMEOUT       120  /* seconds */
  39 #define MEI_WD_MAX_TIMEOUT     65535  /* seconds */
  40
  41 #define MEI_WD_STOP_TIMEOUT      10 /* msecs */
  42
  43 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT       (1 << 0)
  44
  45 #define MEI_RD_MSG_BUF_SIZE           (128 * sizeof(u32))
  46
  47
  48 /*
  49  * AMTHI Client UUID
  50  */
  51 extern const uuid_le mei_amthif_guid;
  52
  53 /*
  54  * Watchdog Client UUID
  55  */
  56 extern const uuid_le mei_wd_guid;
  57
  58 /*
  59  * Number of Maximum MEI Clients
  60  */
  61 #define MEI_CLIENTS_MAX 256
  62
  63 /*
  64  * Number of File descriptors/handles
  65  * that can be opened to the driver.
  66  *
  67  * Limit to 255: 256 Total Clients
  68  * minus internal client for MEI Bus Messags
  69  */
  70 #define  MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
  71
  72 /*
  73  * Internal Clients Number
  74  */
  75 #define MEI_HOST_CLIENT_ID_ANY        (-1)
  76 #define MEI_HBM_HOST_CLIENT_ID         0 /* not used, just for documentation */
  77 #define MEI_WD_HOST_CLIENT_ID          1
  78 #define MEI_IAMTHIF_HOST_CLIENT_ID     2
  79
  80
  81 /* File state */
  82 enum file_state {
  83         MEI_FILE_INITIALIZING = 0,
  84         MEI_FILE_CONNECTING,
  85         MEI_FILE_CONNECTED,
  86         MEI_FILE_DISCONNECTING,
  87         MEI_FILE_DISCONNECTED
  88 };
  89
  90 /* MEI device states */
  91 enum mei_dev_state {
  92         MEI_DEV_INITIALIZING = 0,
  93         MEI_DEV_INIT_CLIENTS,
  94         MEI_DEV_ENABLED,
  95         MEI_DEV_RESETTING,
  96         MEI_DEV_DISABLED,
  97         MEI_DEV_POWER_DOWN,
  98         MEI_DEV_POWER_UP
  99 };
 100
 101 const char *mei_dev_state_str(int state);
 102
 103 enum iamthif_states {
 104         MEI_IAMTHIF_IDLE,
 105         MEI_IAMTHIF_WRITING,
 106         MEI_IAMTHIF_FLOW_CONTROL,
 107         MEI_IAMTHIF_READING,
 108         MEI_IAMTHIF_READ_COMPLETE
 109 };
 110
 111 enum mei_file_transaction_states {
 112         MEI_IDLE,
 113         MEI_WRITING,
 114         MEI_WRITE_COMPLETE,
 115         MEI_FLOW_CONTROL,
 116         MEI_READING,
 117         MEI_READ_COMPLETE
 118 };
 119
 120 enum mei_wd_states {
 121         MEI_WD_IDLE,
 122         MEI_WD_RUNNING,
 123         MEI_WD_STOPPING,
 124 };
 125
 126 /**
 127  * enum mei_cb_file_ops  - file operation associated with the callback
 128  * @MEI_FOP_READ   - read
 129  * @MEI_FOP_WRITE  - write
 130  * @MEI_FOP_IOCTL  - ioctl
 131  * @MEI_FOP_OPEN   - open
 132  * @MEI_FOP_CLOSE  - close
 133  */
 134 enum mei_cb_file_ops {
 135         MEI_FOP_READ = 0,
 136         MEI_FOP_WRITE,
 137         MEI_FOP_IOCTL,
 138         MEI_FOP_OPEN,
 139         MEI_FOP_CLOSE
 140 };
 141
 142 /*
 143  * Intel MEI message data struct
 144  */
 145 struct mei_msg_data {
 146         u32 size;
 147         unsigned char *data;
 148 };
 149
 150 /**
 151  * struct mei_me_client - representation of me (fw) client
 152  *
 153  * @props  - client properties
 154  * @client_id - me client id
 155  * @mei_flow_ctrl_creds - flow control credits
 156  */
 157 struct mei_me_client {
 158         struct mei_client_properties props;
 159         u8 client_id;
 160         u8 mei_flow_ctrl_creds;
 161 };
 162
 163
 164 struct mei_cl;
 165
 166 /**
 167  * struct mei_cl_cb - file operation callback structure
 168  *
 169  * @cl - file client who is running this operation
 170  * @fop_type - file operation type
 171  */
 172 struct mei_cl_cb {
 173         struct list_head list;
 174         struct mei_cl *cl;
 175         enum mei_cb_file_ops fop_type;
 176         struct mei_msg_data request_buffer;
 177         struct mei_msg_data response_buffer;
 178         unsigned long buf_idx;
 179         unsigned long read_time;
 180         struct file *file_object;
 181 };
 182
 183 /* MEI client instance carried as file->pirvate_data*/
 184 struct mei_cl {
 185         struct list_head link;
 186         struct mei_device *dev;
 187         enum file_state state;
 188         wait_queue_head_t tx_wait;
 189         wait_queue_head_t rx_wait;
 190         wait_queue_head_t wait;
 191         int status;
 192         /* ID of client connected */
 193         u8 host_client_id;
 194         u8 me_client_id;
 195         u8 mei_flow_ctrl_creds;
 196         u8 timer_count;
 197         enum mei_file_transaction_states reading_state;
 198         enum mei_file_transaction_states writing_state;
 199         struct mei_cl_cb *read_cb;
 200
 201         /* MEI CL bus data */
 202         struct mei_cl_device *device;
 203         struct list_head device_link;
 204         uuid_le device_uuid;
 205 };
 206
 207 /** struct mei_hw_ops
 208  *
 209  * @host_is_ready    - query for host readiness
 210
 211  * @hw_is_ready      - query if hw is ready
 212  * @hw_reset         - reset hw
 213  * @hw_start         - start hw after reset
 214  * @hw_config        - configure hw
 215
 216  * @intr_clear       - clear pending interrupts
 217  * @intr_enable      - enable interrupts
 218  * @intr_disable     - disable interrupts
 219
 220  * @hbuf_free_slots  - query for write buffer empty slots
 221  * @hbuf_is_ready    - query if write buffer is empty
 222  * @hbuf_max_len     - query for write buffer max len
 223
 224  * @write            - write a message to FW
 225
 226  * @rdbuf_full_slots - query how many slots are filled
 227
 228  * @read_hdr         - get first 4 bytes (header)
 229  * @read             - read a buffer from the FW
 230  */
 231 struct mei_hw_ops {
 232
 233         bool (*host_is_ready) (struct mei_device *dev);
 234
 235         bool (*hw_is_ready) (struct mei_device *dev);
 236         int (*hw_reset) (struct mei_device *dev, bool enable);
 237         int  (*hw_start) (struct mei_device *dev);
 238         void (*hw_config) (struct mei_device *dev);
 239
 240         void (*intr_clear) (struct mei_device *dev);
 241         void (*intr_enable) (struct mei_device *dev);
 242         void (*intr_disable) (struct mei_device *dev);
 243
 244         int (*hbuf_free_slots) (struct mei_device *dev);
 245         bool (*hbuf_is_ready) (struct mei_device *dev);
 246         size_t (*hbuf_max_len) (const struct mei_device *dev);
 247
 248         int (*write)(struct mei_device *dev,
 249                      struct mei_msg_hdr *hdr,
 250                      unsigned char *buf);
 251
 252         int (*rdbuf_full_slots)(struct mei_device *dev);
 253
 254         u32 (*read_hdr)(const struct mei_device *dev);
 255         int (*read) (struct mei_device *dev,
 256                      unsigned char *buf, unsigned long len);
 257 };
 258
 259 /* MEI bus API*/
 260
 261 /**
 262  * struct mei_cl_ops - MEI CL device ops
 263  * This structure allows ME host clients to implement technology
 264  * specific operations.
 265  *
 266  * @enable: Enable an MEI CL device. Some devices require specific
 267  *      HECI commands to initialize completely.
 268  * @disable: Disable an MEI CL device.
 269  * @send: Tx hook for the device. This allows ME host clients to trap
 270  *      the device driver buffers before actually physically
 271  *      pushing it to the ME.
 272  * @recv: Rx hook for the device. This allows ME host clients to trap the
 273  *      ME buffers before forwarding them to the device driver.
 274  */
 275 struct mei_cl_ops {
 276         int (*enable)(struct mei_cl_device *device);
 277         int (*disable)(struct mei_cl_device *device);
 278         int (*send)(struct mei_cl_device *device, u8 *buf, size_t length);
 279         int (*recv)(struct mei_cl_device *device, u8 *buf, size_t length);
 280 };
 281
 282 struct mei_cl_device *mei_cl_add_device(struct mei_device *dev,
 283                                         uuid_le uuid, char *name,
 284                                         struct mei_cl_ops *ops);
 285 void mei_cl_remove_device(struct mei_cl_device *device);
 286
 287 int __mei_cl_async_send(struct mei_cl *cl, u8 *buf, size_t length);
 288 int __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length);
 289 int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length);
 290 void mei_cl_bus_rx_event(struct mei_cl *cl);
 291 int mei_cl_bus_init(void);
 292 void mei_cl_bus_exit(void);
 293
 294
 295 /**
 296  * struct mei_cl_device - MEI device handle
 297  * An mei_cl_device pointer is returned from mei_add_device()
 298  * and links MEI bus clients to their actual ME host client pointer.
 299  * Drivers for MEI devices will get an mei_cl_device pointer
 300  * when being probed and shall use it for doing ME bus I/O.
 301  *
 302  * @dev: linux driver model device pointer
 303  * @uuid: me client uuid
 304  * @cl: mei client
 305  * @ops: ME transport ops
 306  * @event_cb: Drivers register this callback to get asynchronous ME
 307  *      events (e.g. Rx buffer pending) notifications.
 308  * @events: Events bitmask sent to the driver.
 309  * @priv_data: client private data
 310  */
 311 struct mei_cl_device {
 312         struct device dev;
 313
 314         struct mei_cl *cl;
 315
 316         const struct mei_cl_ops *ops;
 317
 318         struct work_struct event_work;
 319         mei_cl_event_cb_t event_cb;
 320         void *event_context;
 321         unsigned long events;
 322
 323         void *priv_data;
 324 };
 325
 326 /**
 327  * struct mei_device -  MEI private device struct
 328
 329  * @hbm_state - state of host bus message protocol
 330  * @mem_addr - mem mapped base register address
 331
 332  * @hbuf_depth - depth of hardware host/write buffer is slots
 333  * @hbuf_is_ready - query if the host host/write buffer is ready
 334  * @wr_msg - the buffer for hbm control messages
 335  * @wr_ext_msg - the buffer for hbm control responses (set in read cycle)
 336  */
 337 struct mei_device {
 338         struct pci_dev *pdev;   /* pointer to pci device struct */
 339         /*
 340          * lists of queues
 341          */
 342         /* array of pointers to aio lists */
 343         struct mei_cl_cb read_list;             /* driver read queue */
 344         struct mei_cl_cb write_list;            /* driver write queue */
 345         struct mei_cl_cb write_waiting_list;    /* write waiting queue */
 346         struct mei_cl_cb ctrl_wr_list;          /* managed write IOCTL list */
 347         struct mei_cl_cb ctrl_rd_list;          /* managed read IOCTL list */
 348
 349         /*
 350          * list of files
 351          */
 352         struct list_head file_list;
 353         long open_handle_count;
 354
 355         /*
 356          * lock for the device
 357          */
 358         struct mutex device_lock; /* device lock */
 359         struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
 360
 361         bool recvd_hw_ready;
 362         /*
 363          * waiting queue for receive message from FW
 364          */
 365         wait_queue_head_t wait_hw_ready;
 366         wait_queue_head_t wait_recvd_msg;
 367         wait_queue_head_t wait_stop_wd;
 368
 369         /*
 370          * mei device  states
 371          */
 372         enum mei_dev_state dev_state;
 373         enum mei_hbm_state hbm_state;
 374         u16 init_clients_timer;
 375
 376         unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];  /* control messages */
 377         u32 rd_msg_hdr;
 378
 379         /* write buffer */
 380         u8 hbuf_depth;
 381         bool hbuf_is_ready;
 382
 383         /* used for control messages */
 384         struct {
 385                 struct mei_msg_hdr hdr;
 386                 unsigned char data[128];
 387         } wr_msg;
 388
 389         struct {
 390                 struct mei_msg_hdr hdr;
 391                 unsigned char data[4];  /* All HBM messages are 4 bytes */
 392         } wr_ext_msg;           /* for control responses */
 393
 394         struct hbm_version version;
 395
 396         struct mei_me_client *me_clients; /* Note: memory has to be allocated */
 397         DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
 398         DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
 399         unsigned long me_clients_num;
 400         unsigned long me_client_presentation_num;
 401         unsigned long me_client_index;
 402
 403         struct mei_cl wd_cl;
 404         enum mei_wd_states wd_state;
 405         bool wd_pending;
 406         u16 wd_timeout;
 407         unsigned char wd_data[MEI_WD_START_MSG_SIZE];
 408
 409
 410         /* amthif list for cmd waiting */
 411         struct mei_cl_cb amthif_cmd_list;
 412         /* driver managed amthif list for reading completed amthif cmd data */
 413         struct mei_cl_cb amthif_rd_complete_list;
 414         struct file *iamthif_file_object;
 415         struct mei_cl iamthif_cl;
 416         struct mei_cl_cb *iamthif_current_cb;
 417         int iamthif_mtu;
 418         unsigned long iamthif_timer;
 419         u32 iamthif_stall_timer;
 420         unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
 421         u32 iamthif_msg_buf_size;
 422         u32 iamthif_msg_buf_index;
 423         enum iamthif_states iamthif_state;
 424         bool iamthif_flow_control_pending;
 425         bool iamthif_ioctl;
 426         bool iamthif_canceled;
 427
 428         struct work_struct init_work;
 429
 430         /* List of bus devices */
 431         struct list_head device_list;
 432
 433 #if IS_ENABLED(CONFIG_DEBUG_FS)
 434         struct dentry *dbgfs_dir;
 435 #endif /* CONFIG_DEBUG_FS */
 436
 437
 438         const struct mei_hw_ops *ops;
 439         char hw[0] __aligned(sizeof(void *));
 440 };
 441
 442 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
 443 {
 444         return msecs_to_jiffies(sec * MSEC_PER_SEC);
 445 }
 446
 447 /**
 448  * mei_data2slots - get slots - number of (dwords) from a message length
 449  *      + size of the mei header
 450  * @length - size of the messages in bytes
 451  * returns  - number of slots
 452  */
 453 static inline u32 mei_data2slots(size_t length)
 454 {
 455         return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4);
 456 }
 457
 458 /*
 459  * mei init function prototypes
 460  */
 461 void mei_device_init(struct mei_device *dev);
 462 void mei_reset(struct mei_device *dev, int interrupts);
 463 int mei_start(struct mei_device *dev);
 464 void mei_stop(struct mei_device *dev);
 465
 466 /*
 467  *  MEI interrupt functions prototype
 468  */
 469
 470 void mei_timer(struct work_struct *work);
 471 int mei_irq_read_handler(struct mei_device *dev,
 472                 struct mei_cl_cb *cmpl_list, s32 *slots);
 473
 474 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
 475 void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
 476
 477 /*
 478  * AMTHIF - AMT Host Interface Functions
 479  */
 480 void mei_amthif_reset_params(struct mei_device *dev);
 481
 482 int mei_amthif_host_init(struct mei_device *dev);
 483
 484 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
 485
 486 int mei_amthif_read(struct mei_device *dev, struct file *file,
 487                 char __user *ubuf, size_t length, loff_t *offset);
 488
 489 unsigned int mei_amthif_poll(struct mei_device *dev,
 490                 struct file *file, poll_table *wait);
 491
 492 int mei_amthif_release(struct mei_device *dev, struct file *file);
 493
 494 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
 495                                                 struct file *file);
 496
 497 void mei_amthif_run_next_cmd(struct mei_device *dev);
 498
 499 int mei_amthif_irq_write_complete(struct mei_cl *cl, struct mei_cl_cb *cb,
 500                                   s32 *slots, struct mei_cl_cb *cmpl_list);
 501
 502 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
 503 int mei_amthif_irq_read_msg(struct mei_device *dev,
 504                             struct mei_msg_hdr *mei_hdr,
 505                             struct mei_cl_cb *complete_list);
 506 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
 507
 508 /*
 509  * NFC functions
 510  */
 511 int mei_nfc_host_init(struct mei_device *dev);
 512 void mei_nfc_host_exit(void);
 513
 514 /*
 515  * NFC Client UUID
 516  */
 517 extern const uuid_le mei_nfc_guid;
 518
 519 int mei_wd_send(struct mei_device *dev);
 520 int mei_wd_stop(struct mei_device *dev);
 521 int mei_wd_host_init(struct mei_device *dev);
 522 /*
 523  * mei_watchdog_register  - Registering watchdog interface
 524  *   once we got connection to the WD Client
 525  * @dev - mei device
 526  */
 527 void mei_watchdog_register(struct mei_device *dev);
 528 /*
 529  * mei_watchdog_unregister  - Unregistering watchdog interface
 530  * @dev - mei device
 531  */
 532 void mei_watchdog_unregister(struct mei_device *dev);
 533
 534 /*
 535  * Register Access Function
 536  */
 537
 538 static inline void mei_hw_config(struct mei_device *dev)
 539 {
 540         dev->ops->hw_config(dev);
 541 }
 542 static inline int mei_hw_reset(struct mei_device *dev, bool enable)
 543 {
 544         return dev->ops->hw_reset(dev, enable);
 545 }
 546
 547 static inline int mei_hw_start(struct mei_device *dev)
 548 {
 549         return dev->ops->hw_start(dev);
 550 }
 551
 552 static inline void mei_clear_interrupts(struct mei_device *dev)
 553 {
 554         dev->ops->intr_clear(dev);
 555 }
 556
 557 static inline void mei_enable_interrupts(struct mei_device *dev)
 558 {
 559         dev->ops->intr_enable(dev);
 560 }
 561
 562 static inline void mei_disable_interrupts(struct mei_device *dev)
 563 {
 564         dev->ops->intr_disable(dev);
 565 }
 566
 567 static inline bool mei_host_is_ready(struct mei_device *dev)
 568 {
 569         return dev->ops->host_is_ready(dev);
 570 }
 571 static inline bool mei_hw_is_ready(struct mei_device *dev)
 572 {
 573         return dev->ops->hw_is_ready(dev);
 574 }
 575
 576 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
 577 {
 578         return dev->ops->hbuf_is_ready(dev);
 579 }
 580
 581 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
 582 {
 583         return dev->ops->hbuf_free_slots(dev);
 584 }
 585
 586 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
 587 {
 588         return dev->ops->hbuf_max_len(dev);
 589 }
 590
 591 static inline int mei_write_message(struct mei_device *dev,
 592                         struct mei_msg_hdr *hdr,
 593                         unsigned char *buf)
 594 {
 595         return dev->ops->write(dev, hdr, buf);
 596 }
 597
 598 static inline u32 mei_read_hdr(const struct mei_device *dev)
 599 {
 600         return dev->ops->read_hdr(dev);
 601 }
 602
 603 static inline void mei_read_slots(struct mei_device *dev,
 604                      unsigned char *buf, unsigned long len)
 605 {
 606         dev->ops->read(dev, buf, len);
 607 }
 608
 609 static inline int mei_count_full_read_slots(struct mei_device *dev)
 610 {
 611         return dev->ops->rdbuf_full_slots(dev);
 612 }
 613
 614 #if IS_ENABLED(CONFIG_DEBUG_FS)
 615 int mei_dbgfs_register(struct mei_device *dev, const char *name);
 616 void mei_dbgfs_deregister(struct mei_device *dev);
 617 #else
 618 static inline int mei_dbgfs_register(struct mei_device *dev, const char *name)
 619 {
 620         return 0;
 621 }
 622 static inline void mei_dbgfs_deregister(struct mei_device *dev) {}
 623 #endif /* CONFIG_DEBUG_FS */
 624
 625 int mei_register(struct mei_device *dev);
 626 void mei_deregister(struct mei_device *dev);
 627
 628 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d comp=%1d"
 629 #define MEI_HDR_PRM(hdr)                  \
 630         (hdr)->host_addr, (hdr)->me_addr, \
 631         (hdr)->length, (hdr)->msg_complete
 632
 633 #endif