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
  25 #include "hw.h"
  26 #include "hw-me-regs.h"
  27
  28 /*
  29  * watch dog definition
  30  */
  31 #define MEI_WD_HDR_SIZE       4
  32 #define MEI_WD_STOP_MSG_SIZE  MEI_WD_HDR_SIZE
  33 #define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)
  34
  35 #define MEI_WD_DEFAULT_TIMEOUT   120  /* seconds */
  36 #define MEI_WD_MIN_TIMEOUT       120  /* seconds */
  37 #define MEI_WD_MAX_TIMEOUT     65535  /* seconds */
  38
  39 #define MEI_WD_STOP_TIMEOUT      10 /* msecs */
  40
  41 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT       (1 << 0)
  42
  43 #define MEI_RD_MSG_BUF_SIZE           (128 * sizeof(u32))
  44
  45
  46 /*
  47  * AMTHI Client UUID
  48  */
  49 extern const uuid_le mei_amthif_guid;
  50
  51 /*
  52  * Watchdog Client UUID
  53  */
  54 extern const uuid_le mei_wd_guid;
  55
  56 /*
  57  * Watchdog independence state message
  58  */
  59 extern const u8 mei_wd_state_independence_msg[3][4];
  60
  61 /*
  62  * Number of Maximum MEI Clients
  63  */
  64 #define MEI_CLIENTS_MAX 256
  65
  66 /*
  67  * Number of File descriptors/handles
  68  * that can be opened to the driver.
  69  *
  70  * Limit to 255: 256 Total Clients
  71  * minus internal client for MEI Bus Messags
  72  */
  73 #define  MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1)
  74
  75 /*
  76  * Internal Clients Number
  77  */
  78 #define MEI_HOST_CLIENT_ID_ANY        (-1)
  79 #define MEI_HBM_HOST_CLIENT_ID         0 /* not used, just for documentation */
  80 #define MEI_WD_HOST_CLIENT_ID          1
  81 #define MEI_IAMTHIF_HOST_CLIENT_ID     2
  82
  83
  84 /* File state */
  85 enum file_state {
  86         MEI_FILE_INITIALIZING = 0,
  87         MEI_FILE_CONNECTING,
  88         MEI_FILE_CONNECTED,
  89         MEI_FILE_DISCONNECTING,
  90         MEI_FILE_DISCONNECTED
  91 };
  92
  93 /* MEI device states */
  94 enum mei_dev_state {
  95         MEI_DEV_INITIALIZING = 0,
  96         MEI_DEV_INIT_CLIENTS,
  97         MEI_DEV_ENABLED,
  98         MEI_DEV_RESETING,
  99         MEI_DEV_DISABLED,
 100         MEI_DEV_RECOVERING_FROM_RESET,
 101         MEI_DEV_POWER_DOWN,
 102         MEI_DEV_POWER_UP
 103 };
 104
 105 const char *mei_dev_state_str(int state);
 106
 107 /* init clients states*/
 108 enum mei_init_clients_states {
 109         MEI_START_MESSAGE = 0,
 110         MEI_ENUM_CLIENTS_MESSAGE,
 111         MEI_CLIENT_PROPERTIES_MESSAGE
 112 };
 113
 114 enum iamthif_states {
 115         MEI_IAMTHIF_IDLE,
 116         MEI_IAMTHIF_WRITING,
 117         MEI_IAMTHIF_FLOW_CONTROL,
 118         MEI_IAMTHIF_READING,
 119         MEI_IAMTHIF_READ_COMPLETE
 120 };
 121
 122 enum mei_file_transaction_states {
 123         MEI_IDLE,
 124         MEI_WRITING,
 125         MEI_WRITE_COMPLETE,
 126         MEI_FLOW_CONTROL,
 127         MEI_READING,
 128         MEI_READ_COMPLETE
 129 };
 130
 131 enum mei_wd_states {
 132         MEI_WD_IDLE,
 133         MEI_WD_RUNNING,
 134         MEI_WD_STOPPING,
 135 };
 136
 137 /**
 138  * enum mei_cb_file_ops  - file operation associated with the callback
 139  * @MEI_FOP_READ   - read
 140  * @MEI_FOP_WRITE  - write
 141  * @MEI_FOP_IOCTL  - ioctl
 142  * @MEI_FOP_OPEN   - open
 143  * @MEI_FOP_CLOSE  - close
 144  */
 145 enum mei_cb_file_ops {
 146         MEI_FOP_READ = 0,
 147         MEI_FOP_WRITE,
 148         MEI_FOP_IOCTL,
 149         MEI_FOP_OPEN,
 150         MEI_FOP_CLOSE
 151 };
 152
 153 /*
 154  * Intel MEI message data struct
 155  */
 156 struct mei_message_data {
 157         u32 size;
 158         unsigned char *data;
 159 };
 160
 161 /**
 162  * struct mei_me_client - representation of me (fw) client
 163  *
 164  * @props  - client properties
 165  * @client_id - me client id
 166  * @mei_flow_ctrl_creds - flow control credits
 167  */
 168 struct mei_me_client {
 169         struct mei_client_properties props;
 170         u8 client_id;
 171         u8 mei_flow_ctrl_creds;
 172 };
 173
 174
 175 struct mei_cl;
 176
 177 /**
 178  * struct mei_cl_cb - file operation callback structure
 179  *
 180  * @cl - file client who is running this operation
 181  * @fop_type - file operation type
 182  */
 183 struct mei_cl_cb {
 184         struct list_head list;
 185         struct mei_cl *cl;
 186         enum mei_cb_file_ops fop_type;
 187         struct mei_message_data request_buffer;
 188         struct mei_message_data response_buffer;
 189         unsigned long buf_idx;
 190         unsigned long read_time;
 191         struct file *file_object;
 192 };
 193
 194 /* MEI client instance carried as file->pirvate_data*/
 195 struct mei_cl {
 196         struct list_head link;
 197         struct mei_device *dev;
 198         enum file_state state;
 199         wait_queue_head_t tx_wait;
 200         wait_queue_head_t rx_wait;
 201         wait_queue_head_t wait;
 202         int status;
 203         /* ID of client connected */
 204         u8 host_client_id;
 205         u8 me_client_id;
 206         u8 mei_flow_ctrl_creds;
 207         u8 timer_count;
 208         enum mei_file_transaction_states reading_state;
 209         enum mei_file_transaction_states writing_state;
 210         int sm_state;
 211         struct mei_cl_cb *read_cb;
 212 };
 213
 214 /** struct mei_hw_ops
 215  *
 216  * @host_set_ready   - notify FW that host side is ready
 217  * @host_is_ready    - query for host readiness
 218
 219  * @hw_is_ready      - query if hw is ready
 220  * @hw_reset         - reset hw
 221  * @hw_config        - configure hw
 222
 223  * @intr_clear       - clear pending interrupts
 224  * @intr_enable      - enable interrupts
 225  * @intr_disable     - disable interrupts
 226
 227  * @hbuf_free_slots  - query for write buffer empty slots
 228  * @hbuf_is_ready    - query if write buffer is empty
 229  * @hbuf_max_len     - query for write buffer max len
 230
 231  * @write            - write a message to FW
 232
 233  * @rdbuf_full_slots - query how many slots are filled
 234
 235  * @read_hdr         - get first 4 bytes (header)
 236  * @read             - read a buffer from the FW
 237  */
 238 struct mei_hw_ops {
 239
 240         void (*host_set_ready) (struct mei_device *dev);
 241         bool (*host_is_ready) (struct mei_device *dev);
 242
 243         bool (*hw_is_ready) (struct mei_device *dev);
 244         void (*hw_reset) (struct mei_device *dev, bool enable);
 245         void (*hw_config) (struct mei_device *dev);
 246
 247         void (*intr_clear) (struct mei_device *dev);
 248         void (*intr_enable) (struct mei_device *dev);
 249         void (*intr_disable) (struct mei_device *dev);
 250
 251         int (*hbuf_free_slots) (struct mei_device *dev);
 252         bool (*hbuf_is_ready) (struct mei_device *dev);
 253         size_t (*hbuf_max_len) (const struct mei_device *dev);
 254
 255         int (*write)(struct mei_device *dev,
 256                      struct mei_msg_hdr *hdr,
 257                      unsigned char *buf);
 258
 259         int (*rdbuf_full_slots)(struct mei_device *dev);
 260
 261         u32 (*read_hdr)(const struct mei_device *dev);
 262         int (*read) (struct mei_device *dev,
 263                      unsigned char *buf, unsigned long len);
 264 };
 265
 266 /**
 267  * struct mei_device -  MEI private device struct
 268  * @mem_addr - mem mapped base register address
 269  * @hbuf_depth - depth of host(write) buffer
 270  * @wr_ext_msg - buffer for hbm control responses (set in read cycle)
 271  */
 272 struct mei_device {
 273         struct pci_dev *pdev;   /* pointer to pci device struct */
 274         /*
 275          * lists of queues
 276          */
 277         /* array of pointers to aio lists */
 278         struct mei_cl_cb read_list;             /* driver read queue */
 279         struct mei_cl_cb write_list;            /* driver write queue */
 280         struct mei_cl_cb write_waiting_list;    /* write waiting queue */
 281         struct mei_cl_cb ctrl_wr_list;          /* managed write IOCTL list */
 282         struct mei_cl_cb ctrl_rd_list;          /* managed read IOCTL list */
 283
 284         /*
 285          * list of files
 286          */
 287         struct list_head file_list;
 288         long open_handle_count;
 289
 290         /*
 291          * lock for the device
 292          */
 293         struct mutex device_lock; /* device lock */
 294         struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
 295         bool recvd_msg;
 296
 297         u8  hbuf_depth;
 298         /*
 299          * waiting queue for receive message from FW
 300          */
 301         wait_queue_head_t wait_recvd_msg;
 302         wait_queue_head_t wait_stop_wd;
 303
 304         /*
 305          * mei device  states
 306          */
 307         enum mei_dev_state dev_state;
 308         enum mei_init_clients_states init_clients_state;
 309         u16 init_clients_timer;
 310
 311         unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];  /* control messages */
 312         u32 rd_msg_hdr;
 313
 314         /* used for control messages */
 315         struct {
 316                 struct mei_msg_hdr hdr;
 317                 unsigned char data[128];
 318         } wr_msg;
 319
 320         struct {
 321                 struct mei_msg_hdr hdr;
 322                 unsigned char data[4];  /* All HBM messages are 4 bytes */
 323         } wr_ext_msg;           /* for control responses */
 324
 325         struct hbm_version version;
 326
 327         struct mei_me_client *me_clients; /* Note: memory has to be allocated */
 328         DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
 329         DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
 330         u8 me_clients_num;
 331         u8 me_client_presentation_num;
 332         u8 me_client_index;
 333         bool mei_host_buffer_is_empty;
 334
 335         struct mei_cl wd_cl;
 336         enum mei_wd_states wd_state;
 337         bool wd_pending;
 338         u16 wd_timeout;
 339         unsigned char wd_data[MEI_WD_START_MSG_SIZE];
 340
 341
 342         /* amthif list for cmd waiting */
 343         struct mei_cl_cb amthif_cmd_list;
 344         /* driver managed amthif list for reading completed amthif cmd data */
 345         struct mei_cl_cb amthif_rd_complete_list;
 346         struct file *iamthif_file_object;
 347         struct mei_cl iamthif_cl;
 348         struct mei_cl_cb *iamthif_current_cb;
 349         int iamthif_mtu;
 350         unsigned long iamthif_timer;
 351         u32 iamthif_stall_timer;
 352         unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
 353         u32 iamthif_msg_buf_size;
 354         u32 iamthif_msg_buf_index;
 355         enum iamthif_states iamthif_state;
 356         bool iamthif_flow_control_pending;
 357         bool iamthif_ioctl;
 358         bool iamthif_canceled;
 359
 360         struct work_struct init_work;
 361
 362         const struct mei_hw_ops *ops;
 363         char hw[0] __aligned(sizeof(void *));
 364 };
 365
 366 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
 367 {
 368         return msecs_to_jiffies(sec * MSEC_PER_SEC);
 369 }
 370
 371
 372 /*
 373  * mei init function prototypes
 374  */
 375 void mei_device_init(struct mei_device *dev);
 376 void mei_reset(struct mei_device *dev, int interrupts);
 377 int mei_hw_init(struct mei_device *dev);
 378
 379 /*
 380  *  MEI interrupt functions prototype
 381  */
 382
 383 void mei_timer(struct work_struct *work);
 384 int mei_irq_read_handler(struct mei_device *dev,
 385                 struct mei_cl_cb *cmpl_list, s32 *slots);
 386
 387 int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list);
 388
 389 void mei_irq_complete_handler(struct mei_cl *cl, struct mei_cl_cb *cb_pos);
 390
 391 /*
 392  * AMTHIF - AMT Host Interface Functions
 393  */
 394 void mei_amthif_reset_params(struct mei_device *dev);
 395
 396 int mei_amthif_host_init(struct mei_device *dev);
 397
 398 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
 399
 400 int mei_amthif_read(struct mei_device *dev, struct file *file,
 401                 char __user *ubuf, size_t length, loff_t *offset);
 402
 403 unsigned int mei_amthif_poll(struct mei_device *dev,
 404                 struct file *file, poll_table *wait);
 405
 406 int mei_amthif_release(struct mei_device *dev, struct file *file);
 407
 408 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
 409                                                 struct file *file);
 410
 411 void mei_amthif_run_next_cmd(struct mei_device *dev);
 412
 413
 414 int mei_amthif_irq_write_complete(struct mei_device *dev, s32 *slots,
 415                         struct mei_cl_cb *cb, struct mei_cl_cb *cmpl_list);
 416
 417 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
 418 int mei_amthif_irq_read_message(struct mei_cl_cb *complete_list,
 419                 struct mei_device *dev, struct mei_msg_hdr *mei_hdr);
 420 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
 421
 422
 423 int mei_wd_send(struct mei_device *dev);
 424 int mei_wd_stop(struct mei_device *dev);
 425 int mei_wd_host_init(struct mei_device *dev);
 426 /*
 427  * mei_watchdog_register  - Registering watchdog interface
 428  *   once we got connection to the WD Client
 429  * @dev - mei device
 430  */
 431 void mei_watchdog_register(struct mei_device *dev);
 432 /*
 433  * mei_watchdog_unregister  - Unregistering watchdog interface
 434  * @dev - mei device
 435  */
 436 void mei_watchdog_unregister(struct mei_device *dev);
 437
 438 /*
 439  * Register Access Function
 440  */
 441
 442 static inline void mei_hw_config(struct mei_device *dev)
 443 {
 444         dev->ops->hw_config(dev);
 445 }
 446 static inline void mei_hw_reset(struct mei_device *dev, bool enable)
 447 {
 448         dev->ops->hw_reset(dev, enable);
 449 }
 450
 451 static inline void mei_clear_interrupts(struct mei_device *dev)
 452 {
 453         dev->ops->intr_clear(dev);
 454 }
 455
 456 static inline void mei_enable_interrupts(struct mei_device *dev)
 457 {
 458         dev->ops->intr_enable(dev);
 459 }
 460
 461 static inline void mei_disable_interrupts(struct mei_device *dev)
 462 {
 463         dev->ops->intr_disable(dev);
 464 }
 465
 466 static inline void mei_host_set_ready(struct mei_device *dev)
 467 {
 468         dev->ops->host_set_ready(dev);
 469 }
 470 static inline bool mei_host_is_ready(struct mei_device *dev)
 471 {
 472         return dev->ops->host_is_ready(dev);
 473 }
 474 static inline bool mei_hw_is_ready(struct mei_device *dev)
 475 {
 476         return dev->ops->hw_is_ready(dev);
 477 }
 478
 479 static inline bool mei_hbuf_is_ready(struct mei_device *dev)
 480 {
 481         return dev->ops->hbuf_is_ready(dev);
 482 }
 483
 484 static inline int mei_hbuf_empty_slots(struct mei_device *dev)
 485 {
 486         return dev->ops->hbuf_free_slots(dev);
 487 }
 488
 489 static inline size_t mei_hbuf_max_len(const struct mei_device *dev)
 490 {
 491         return dev->ops->hbuf_max_len(dev);
 492 }
 493
 494 static inline int mei_write_message(struct mei_device *dev,
 495                         struct mei_msg_hdr *hdr,
 496                         unsigned char *buf)
 497 {
 498         return dev->ops->write(dev, hdr, buf);
 499 }
 500
 501 static inline u32 mei_read_hdr(const struct mei_device *dev)
 502 {
 503         return dev->ops->read_hdr(dev);
 504 }
 505
 506 static inline void mei_read_slots(struct mei_device *dev,
 507                      unsigned char *buf, unsigned long len)
 508 {
 509         dev->ops->read(dev, buf, len);
 510 }
 511
 512 static inline int mei_count_full_read_slots(struct mei_device *dev)
 513 {
 514         return dev->ops->rdbuf_full_slots(dev);
 515 }
 516
 517 int mei_register(struct device *dev);
 518 void mei_deregister(void);
 519
 520 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d comp=%1d"
 521 #define MEI_HDR_PRM(hdr)                  \
 522         (hdr)->host_addr, (hdr)->me_addr, \
 523         (hdr)->length, (hdr)->msg_complete
 524
 525 #endif