3 * Intel Management Engine Interface (Intel MEI) Linux driver
4 * Copyright (c) 2003-2012, Intel Corporation.
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.
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
20 #include <linux/types.h>
21 #include <linux/watchdog.h>
22 #include <linux/mei.h>
26 * watch dog definition
28 #define MEI_WD_HDR_SIZE 4
29 #define MEI_WD_STOP_MSG_SIZE MEI_WD_HDR_SIZE
30 #define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)
32 #define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */
33 #define MEI_WD_MIN_TIMEOUT 120 /* seconds */
34 #define MEI_WD_MAX_TIMEOUT 65535 /* seconds */
36 #define MEI_WD_STOP_TIMEOUT 10 /* msecs */
38 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0)
40 #define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32))
46 extern const uuid_le mei_amthi_guid;
49 * Watchdog Client UUID
51 extern const uuid_le mei_wd_guid;
54 * Watchdog independence state message
56 extern const u8 mei_wd_state_independence_msg[3][4];
59 * Number of Maximum MEI Clients
61 #define MEI_CLIENTS_MAX 256
64 * Number of File descriptors/handles
65 * that can be opened to the driver.
67 * Limit to 253: 256 Total Clients
68 * minus internal client for MEI Bus Messags
69 * minus internal client for AMTHI
70 * minus internal client for Watchdog
72 #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 3)
77 MEI_FILE_INITIALIZING = 0,
80 MEI_FILE_DISCONNECTING,
84 /* MEI device states */
86 MEI_DEV_INITIALIZING = 0,
91 MEI_DEV_RECOVERING_FROM_RESET,
96 const char *mei_dev_state_str(int state);
98 /* init clients states*/
99 enum mei_init_clients_states {
100 MEI_START_MESSAGE = 0,
101 MEI_ENUM_CLIENTS_MESSAGE,
102 MEI_CLIENT_PROPERTIES_MESSAGE
105 enum iamthif_states {
108 MEI_IAMTHIF_FLOW_CONTROL,
110 MEI_IAMTHIF_READ_COMPLETE
113 enum mei_file_transaction_states {
129 enum mei_cb_major_types {
138 * Intel MEI message data struct
140 struct mei_message_data {
147 struct list_head list;
148 enum mei_cb_major_types major_file_operations;
150 struct mei_message_data request_buffer;
151 struct mei_message_data response_buffer;
152 unsigned long buf_idx;
153 unsigned long read_time;
154 struct file *file_object;
157 /* MEI client instance carried as file->pirvate_data*/
159 struct list_head link;
160 struct mei_device *dev;
161 enum file_state state;
162 wait_queue_head_t tx_wait;
163 wait_queue_head_t rx_wait;
164 wait_queue_head_t wait;
167 /* ID of client connected */
170 u8 mei_flow_ctrl_creds;
172 enum mei_file_transaction_states reading_state;
173 enum mei_file_transaction_states writing_state;
175 struct mei_cl_cb *read_cb;
179 * struct mei_deive - MEI private device struct
180 * @hbuf_depth - depth of host(write) buffer
183 struct pci_dev *pdev; /* pointer to pci device struct */
187 /* array of pointers to aio lists */
188 struct mei_cl_cb read_list; /* driver read queue */
189 struct mei_cl_cb write_list; /* driver write queue */
190 struct mei_cl_cb write_waiting_list; /* write waiting queue */
191 struct mei_cl_cb ctrl_wr_list; /* managed write IOCTL list */
192 struct mei_cl_cb ctrl_rd_list; /* managed read IOCTL list */
193 struct mei_cl_cb amthi_cmd_list; /* amthi list for cmd waiting */
195 /* driver managed amthi list for reading completed amthi cmd data */
196 struct mei_cl_cb amthi_read_complete_list;
200 struct list_head file_list;
201 long open_handle_count;
205 unsigned int mem_base;
206 unsigned int mem_length;
207 void __iomem *mem_addr;
209 * lock for the device
211 struct mutex device_lock; /* device lock */
212 struct delayed_work timer_work; /* MEI timer delayed work (timeouts) */
215 * hw states of host and fw(ME)
221 * waiting queue for receive message from FW
223 wait_queue_head_t wait_recvd_msg;
224 wait_queue_head_t wait_stop_wd;
229 enum mei_dev_state dev_state;
230 enum mei_init_clients_states init_clients_state;
231 u16 init_clients_timer;
234 u32 extra_write_index;
235 unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; /* control messages */
236 u32 wr_msg_buf[128]; /* used for control messages */
237 u32 ext_msg_buf[8]; /* for control responses */
240 struct hbm_version version;
242 struct mei_me_client *me_clients; /* Note: memory has to be allocated */
243 DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
244 DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
246 u8 me_client_presentation_num;
248 bool mei_host_buffer_is_empty;
251 enum mei_wd_states wd_state;
254 unsigned char wd_data[MEI_WD_START_MSG_SIZE];
257 struct file *iamthif_file_object;
258 struct mei_cl iamthif_cl;
259 struct mei_cl_cb *iamthif_current_cb;
261 unsigned long iamthif_timer;
262 u32 iamthif_stall_timer;
263 unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
264 u32 iamthif_msg_buf_size;
265 u32 iamthif_msg_buf_index;
266 enum iamthif_states iamthif_state;
267 bool iamthif_flow_control_pending;
269 bool iamthif_canceled;
272 static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
274 return msecs_to_jiffies(sec * MSEC_PER_SEC);
279 * mei init function prototypes
281 struct mei_device *mei_device_init(struct pci_dev *pdev);
282 void mei_reset(struct mei_device *dev, int interrupts);
283 int mei_hw_init(struct mei_device *dev);
284 int mei_task_initialize_clients(void *data);
285 int mei_initialize_clients(struct mei_device *dev);
286 int mei_disconnect_host_client(struct mei_device *dev, struct mei_cl *cl);
287 void mei_remove_client_from_file_list(struct mei_device *dev, u8 host_client_id);
288 void mei_allocate_me_clients_storage(struct mei_device *dev);
291 int mei_me_cl_update_filext(struct mei_device *dev, struct mei_cl *cl,
292 const uuid_le *cguid, u8 host_client_id);
293 int mei_me_cl_by_uuid(const struct mei_device *dev, const uuid_le *cuuid);
294 int mei_me_cl_by_id(struct mei_device *dev, u8 client_id);
299 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp);
300 void mei_io_cb_free(struct mei_cl_cb *priv_cb);
301 int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length);
302 int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length);
306 * mei_io_list_init - Sets up a queue list.
308 * @list: An instance cl callback structure
310 static inline void mei_io_list_init(struct mei_cl_cb *list)
312 INIT_LIST_HEAD(&list->list);
314 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl);
317 * MEI ME Client Functions
320 struct mei_cl *mei_cl_allocate(struct mei_device *dev);
321 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
322 int mei_cl_flush_queues(struct mei_cl *cl);
324 * mei_cl_cmp_id - tells if file private data have same id
326 * @fe1: private data of 1. file object
327 * @fe2: private data of 2. file object
329 * returns true - if ids are the same and not NULL
331 static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
332 const struct mei_cl *cl2)
335 (cl1->host_client_id == cl2->host_client_id) &&
336 (cl1->me_client_id == cl2->me_client_id);
342 * MEI Host Client Functions
344 void mei_host_start_message(struct mei_device *dev);
345 void mei_host_enum_clients_message(struct mei_device *dev);
346 int mei_host_client_properties(struct mei_device *dev);
349 * MEI interrupt functions prototype
351 irqreturn_t mei_interrupt_quick_handler(int irq, void *dev_id);
352 irqreturn_t mei_interrupt_thread_handler(int irq, void *dev_id);
353 void mei_timer(struct work_struct *work);
356 * MEI input output function prototype
358 int mei_ioctl_connect_client(struct file *file,
359 struct mei_connect_client_data *data);
361 int mei_start_read(struct mei_device *dev, struct mei_cl *cl);
365 * AMTHIF - AMT Host Interface Functions
367 void mei_amthif_reset_params(struct mei_device *dev);
369 void mei_amthif_host_init(struct mei_device *dev);
371 int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);
373 int mei_amthif_read(struct mei_device *dev, struct file *file,
374 char __user *ubuf, size_t length, loff_t *offset);
376 struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,
379 void mei_amthif_run_next_cmd(struct mei_device *dev);
382 int mei_amthif_read_message(struct mei_cl_cb *complete_list,
383 struct mei_device *dev, struct mei_msg_hdr *mei_hdr);
385 int mei_amthif_irq_process_completed(struct mei_device *dev, s32 *slots,
386 struct mei_cl_cb *cb_pos,
388 struct mei_cl_cb *cmpl_list);
390 void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb);
391 int mei_amthif_irq_read_message(struct mei_cl_cb *complete_list,
392 struct mei_device *dev, struct mei_msg_hdr *mei_hdr);
393 int mei_amthif_irq_read(struct mei_device *dev, s32 *slots);
396 * Register Access Function
400 * mei_reg_read - Reads 32bit data from the mei device
402 * @dev: the device structure
403 * @offset: offset from which to read the data
405 * returns register value (u32)
407 static inline u32 mei_reg_read(const struct mei_device *dev,
408 unsigned long offset)
410 return ioread32(dev->mem_addr + offset);
414 * mei_reg_write - Writes 32bit data to the mei device
416 * @dev: the device structure
417 * @offset: offset from which to write the data
418 * @value: register value to write (u32)
420 static inline void mei_reg_write(const struct mei_device *dev,
421 unsigned long offset, u32 value)
423 iowrite32(value, dev->mem_addr + offset);
427 * mei_hcsr_read - Reads 32bit data from the host CSR
429 * @dev: the device structure
431 * returns the byte read.
433 static inline u32 mei_hcsr_read(const struct mei_device *dev)
435 return mei_reg_read(dev, H_CSR);
439 * mei_mecsr_read - Reads 32bit data from the ME CSR
441 * @dev: the device structure
443 * returns ME_CSR_HA register value (u32)
445 static inline u32 mei_mecsr_read(const struct mei_device *dev)
447 return mei_reg_read(dev, ME_CSR_HA);
451 * get_me_cb_rw - Reads 32bit data from the mei ME_CB_RW register
453 * @dev: the device structure
455 * returns ME_CB_RW register value (u32)
457 static inline u32 mei_mecbrw_read(const struct mei_device *dev)
459 return mei_reg_read(dev, ME_CB_RW);
464 * mei interface function prototypes
466 void mei_hcsr_set(struct mei_device *dev);
467 void mei_csr_clear_his(struct mei_device *dev);
469 void mei_enable_interrupts(struct mei_device *dev);
470 void mei_disable_interrupts(struct mei_device *dev);