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.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_amthi_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 253: 256 Total Clients
  71  * minus internal client for MEI Bus Messags
  72  * minus internal client for AMTHI
  73  * minus internal client for Watchdog
  74  */
  75 #define  MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 3)
  76
  77 /*
  78  * Internal Clients Number
  79  */
  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 read_pending;
 203         int status;
 204         /* ID of client connected */
 205         u8 host_client_id;
 206         u8 me_client_id;
 207         u8 mei_flow_ctrl_creds;
 208         u8 timer_count;
 209         enum mei_file_transaction_states reading_state;
 210         enum mei_file_transaction_states writing_state;
 211         int sm_state;
 212         struct mei_cl_cb *read_cb;
 213 };
 214
 215 /**
 216  * struct mei_device -  MEI private device struct
 217  * @mem_addr - mem mapped base register address
 218  * @hbuf_depth - depth of host(write) buffer
 219  * @wr_ext_msg - buffer for hbm control responses (set in read cycle)
 220  */
 221 struct mei_device {
 222         struct pci_dev *pdev;   /* pointer to pci device struct */
 223         /*
 224          * lists of queues
 225          */
 226         /* array of pointers to aio lists */
 227         struct mei_cl_cb read_list;             /* driver read queue */
 228         struct mei_cl_cb write_list;            /* driver write queue */
 229         struct mei_cl_cb write_waiting_list;    /* write waiting queue */
 230         struct mei_cl_cb ctrl_wr_list;          /* managed write IOCTL list */
 231         struct mei_cl_cb ctrl_rd_list;          /* managed read IOCTL list */
 232
 233         /*
 234          * list of files
 235          */
 236         struct list_head file_list;
 237         long open_handle_count;
 238
 239         void __iomem *mem_addr;
 240         /*
 241          * lock for the device
 242          */
 243         struct mutex device_lock; /* device lock */
 244         struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
 245         bool recvd_msg;
 246         /*
 247          * hw states of host and fw(ME)
 248          */
 249         u32 host_hw_state;
 250         u32 me_hw_state;
 251         u8  hbuf_depth;
 252         /*
 253          * waiting queue for receive message from FW
 254          */
 255         wait_queue_head_t wait_recvd_msg;
 256         wait_queue_head_t wait_stop_wd;
 257
 258         /*
 259          * mei device  states
 260          */
 261         enum mei_dev_state dev_state;
 262         enum mei_init_clients_states init_clients_state;
 263         u16 init_clients_timer;
 264         bool need_reset;
 265
 266         unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];  /* control messages */
 267         u32 rd_msg_hdr;
 268         u32 wr_msg_buf[128];    /* used for control messages */
 269         struct {
 270                 struct mei_msg_hdr hdr;
 271                 unsigned char data[4];  /* All HBM messages are 4 bytes */
 272         } wr_ext_msg;           /* for control responses */
 273
 274         struct hbm_version version;
 275
 276         struct mei_me_client *me_clients; /* Note: memory has to be allocated */
 277         DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
 278         DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
 279         u8 me_clients_num;
 280         u8 me_client_presentation_num;
 281         u8 me_client_index;
 282         bool mei_host_buffer_is_empty;
 283
 284         struct mei_cl wd_cl;
 285         enum mei_wd_states wd_state;
 286         bool wd_pending;
 287         u16 wd_timeout;
 288         unsigned char wd_data[MEI_WD_START_MSG_SIZE];
 289
 290
 291         /* amthif list for cmd waiting */
 292         struct mei_cl_cb amthif_cmd_list;
 293         /* driver managed amthif list for reading completed amthif cmd data */
 294         struct mei_cl_cb amthif_rd_complete_list;
 295         struct file *iamthif_file_object;
 296         struct mei_cl iamthif_cl;
 297         struct mei_cl_cb *iamthif_current_cb;
 298         int iamthif_mtu;
 299         unsigned long iamthif_timer;
 300         u32 iamthif_stall_timer;
 301         unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
 302         u32 iamthif_msg_buf_size;
 303         u32 iamthif_msg_buf_index;
 304         enum iamthif_states iamthif_state;
 305         bool iamthif_flow_control_pending;
 306         bool iamthif_ioctl;
 307         bool iamthif_canceled;
 308
 309         struct work_struct init_work;
 310 };
 311
 312 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
 313 {
 314         return msecs_to_jiffies(sec * MSEC_PER_SEC);
 315 }
 316
 317
 318 /*
 319  * mei init function prototypes
 320  */
 321 struct mei_device *mei_device_init(struct pci_dev *pdev);
 322 void mei_reset(struct mei_device *dev, int interrupts);
 323 int mei_hw_init(struct mei_device *dev);
 324 int mei_task_initialize_clients(void *data);
 325 int mei_initialize_clients(struct mei_device *dev);
 326 int mei_disconnect_host_client(struct mei_device *dev, struct mei_cl *cl);
 327 void mei_allocate_me_clients_storage(struct mei_device *dev);
 328
 329
 330 int mei_me_cl_link(struct mei_device *dev, struct mei_cl *cl,
 331                         const uuid_le *cguid, u8 host_client_id);
 332 void mei_me_cl_unlink(struct mei_device *dev, struct mei_cl *cl);
 333 int mei_me_cl_by_uuid(const struct mei_device *dev, const uuid_le *cuuid);
 334 int mei_me_cl_by_id(struct mei_device *dev, u8 client_id);
 335
 336 /*
 337  * MEI IO Functions
 338  */
 339 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp);
 340 void mei_io_cb_free(struct mei_cl_cb *priv_cb);
 341 int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length);
 342 int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length);
 343
 344
 345 /**
 346  * mei_io_list_init - Sets up a queue list.
 347  *
 348  * @list: An instance cl callback structure
 349  */
 350 static inline void mei_io_list_init(struct mei_cl_cb *list)
 351 {
 352         INIT_LIST_HEAD(&list->list);
 353 }
 354 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl);
 355
 356 /*
 357  * MEI ME Client Functions
 358  */
 359
 360 struct mei_cl *mei_cl_allocate(struct mei_device *dev);
 361 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
 362 int mei_cl_flush_queues(struct mei_cl *cl);
 363 /**
 364  * mei_cl_cmp_id - tells if file private data have same id
 365  *
 366  * @fe1: private data of 1. file object
 367  * @fe2: private data of 2. file object
 368  *
 369  * returns true  - if ids are the same and not NULL
 370  */
 371 static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
 372                                 const struct mei_cl *cl2)
 373 {
 374         return cl1 && cl2 &&
 375                 (cl1->host_client_id == cl2->host_client_id) &&
 376                 (cl1->me_client_id == cl2->me_client_id);
 377 }
 378
 379
 380
 381 /*
 382  * MEI Host Client Functions
 383  */
 384 void mei_host_start_message(struct mei_device *dev);
 385 void mei_host_enum_clients_message(struct mei_device *dev);
 386 int mei_host_client_enumerate(struct mei_device *dev);
 387 void mei_host_client_init(struct work_struct *work);
 388
 389 /*
 390  *  MEI interrupt functions prototype
 391  */
 392 irqreturn_t mei_interrupt_quick_handler(int irq, void *dev_id);
 393 irqreturn_t mei_interrupt_thread_handler(int irq, void *dev_id);
 394 void mei_timer(struct work_struct *work);
 395
 396 /*
 397  *  MEI input output function prototype
 398  */
 399 int mei_ioctl_connect_client(struct file *file,
 400                         struct mei_connect_client_data *data);
 401
 402 int mei_start_read(struct mei_device *dev, struct mei_cl *cl);
 403
 404
 405 /*
 406  * AMTHIF - AMT Host Interface Functions
 407  */
 408 void mei_amthif_reset_params(struct mei_device *dev);
 409
 410 void mei_amthif_host_init(struct mei_device *dev);
 411
 412 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
 413
 414 int mei_amthif_read(struct mei_device *dev, struct file *file,
 415                 char __user *ubuf, size_t length, loff_t *offset);
 416
 417 unsigned int mei_amthif_poll(struct mei_device *dev,
 418                 struct file *file, poll_table *wait);
 419
 420 int mei_amthif_release(struct mei_device *dev, struct file *file);
 421
 422 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
 423                                                 struct file *file);
 424
 425 void mei_amthif_run_next_cmd(struct mei_device *dev);
 426
 427
 428 int mei_amthif_read_message(struct mei_cl_cb *complete_list,
 429                 struct mei_device *dev, struct mei_msg_hdr *mei_hdr);
 430
 431 int mei_amthif_irq_write_complete(struct mei_device *dev, s32 *slots,
 432                         struct mei_cl_cb *cb, struct mei_cl_cb *cmpl_list);
 433
 434 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
 435 int mei_amthif_irq_read_message(struct mei_cl_cb *complete_list,
 436                 struct mei_device *dev, struct mei_msg_hdr *mei_hdr);
 437 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
 438
 439 /*
 440  * Register Access Function
 441  */
 442
 443 /**
 444  * mei_reg_read - Reads 32bit data from the mei device
 445  *
 446  * @dev: the device structure
 447  * @offset: offset from which to read the data
 448  *
 449  * returns register value (u32)
 450  */
 451 static inline u32 mei_reg_read(const struct mei_device *dev,
 452                                unsigned long offset)
 453 {
 454         return ioread32(dev->mem_addr + offset);
 455 }
 456
 457 /**
 458  * mei_reg_write - Writes 32bit data to the mei device
 459  *
 460  * @dev: the device structure
 461  * @offset: offset from which to write the data
 462  * @value: register value to write (u32)
 463  */
 464 static inline void mei_reg_write(const struct mei_device *dev,
 465                                  unsigned long offset, u32 value)
 466 {
 467         iowrite32(value, dev->mem_addr + offset);
 468 }
 469
 470 /**
 471  * mei_hcsr_read - Reads 32bit data from the host CSR
 472  *
 473  * @dev: the device structure
 474  *
 475  * returns the byte read.
 476  */
 477 static inline u32 mei_hcsr_read(const struct mei_device *dev)
 478 {
 479         return mei_reg_read(dev, H_CSR);
 480 }
 481
 482 /**
 483  * mei_mecsr_read - Reads 32bit data from the ME CSR
 484  *
 485  * @dev: the device structure
 486  *
 487  * returns ME_CSR_HA register value (u32)
 488  */
 489 static inline u32 mei_mecsr_read(const struct mei_device *dev)
 490 {
 491         return mei_reg_read(dev, ME_CSR_HA);
 492 }
 493
 494 /**
 495  * get_me_cb_rw - Reads 32bit data from the mei ME_CB_RW register
 496  *
 497  * @dev: the device structure
 498  *
 499  * returns ME_CB_RW register value (u32)
 500  */
 501 static inline u32 mei_mecbrw_read(const struct mei_device *dev)
 502 {
 503         return mei_reg_read(dev, ME_CB_RW);
 504 }
 505
 506
 507 /*
 508  * mei interface function prototypes
 509  */
 510 void mei_hcsr_set(struct mei_device *dev);
 511 void mei_csr_clear_his(struct mei_device *dev);
 512
 513 void mei_enable_interrupts(struct mei_device *dev);
 514 void mei_disable_interrupts(struct mei_device *dev);
 515
 516 static inline struct mei_msg_hdr *mei_hbm_hdr(u32 *buf, size_t length)
 517 {
 518         struct mei_msg_hdr *hdr = (struct mei_msg_hdr *)buf;
 519         hdr->host_addr = 0;
 520         hdr->me_addr = 0;
 521         hdr->length = length;
 522         hdr->msg_complete = 1;
 523         hdr->reserved = 0;
 524         return hdr;
 525 }
 526
 527 #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d comp=%1d"
 528 #define MEI_HDR_PRM(hdr)                  \
 529         (hdr)->host_addr, (hdr)->me_addr, \
 530         (hdr)->length, (hdr)->msg_complete
 531
 532 #endif