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_WATCHDOG_DATA_SIZE 16
29 #define MEI_START_WD_DATA_SIZE 20
30 #define MEI_WD_PARAMS_SIZE 4
31 #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0)
33 #define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32))
36 * MEI PCI Device object
38 extern struct pci_dev
*mei_device
;
44 extern const uuid_le mei_amthi_guid
;
47 * Watchdog Client UUID
49 extern const uuid_le mei_wd_guid
;
52 * Watchdog independence state message
54 extern const u8 mei_wd_state_independence_msg
[3][4];
57 * Number of File descriptors/handles
58 * that can be opened to the driver.
60 * Limit to 253: 255 Total Clients
61 * minus internal client for AMTHI
62 * minus internal client for Watchdog
64 #define MEI_MAX_OPEN_HANDLE_COUNT 253
67 * Number of Maximum MEI Clients
69 #define MEI_CLIENTS_MAX 255
73 MEI_FILE_INITIALIZING
= 0,
76 MEI_FILE_DISCONNECTING
,
80 /* MEI device states */
87 MEI_RECOVERING_FROM_RESET
,
92 /* init clients states*/
93 enum mei_init_clients_states
{
94 MEI_START_MESSAGE
= 0,
95 MEI_ENUM_CLIENTS_MESSAGE
,
96 MEI_CLIENT_PROPERTIES_MESSAGE
102 MEI_IAMTHIF_FLOW_CONTROL
,
104 MEI_IAMTHIF_READ_COMPLETE
107 enum mei_file_transaction_states
{
117 enum mei_cb_major_types
{
126 * Intel MEI message data struct
128 struct mei_message_data
{
135 struct list_head cb_list
;
136 enum mei_cb_major_types major_file_operations
;
138 struct mei_message_data request_buffer
;
139 struct mei_message_data response_buffer
;
140 unsigned long information
;
141 unsigned long read_time
;
142 struct file
*file_object
;
145 /* MEI client instance carried as file->pirvate_data*/
147 struct list_head link
;
148 struct mei_device
*dev
;
149 enum file_state state
;
150 wait_queue_head_t tx_wait
;
151 wait_queue_head_t rx_wait
;
152 wait_queue_head_t wait
;
155 /* ID of client connected */
158 u8 mei_flow_ctrl_creds
;
160 enum mei_file_transaction_states reading_state
;
161 enum mei_file_transaction_states writing_state
;
163 struct mei_cl_cb
*read_cb
;
167 struct mei_cl_cb mei_cb
;
171 * struct mei_deive - MEI private device struct
172 * @hbuf_depth - depth of host(write) buffer
175 struct pci_dev
*pdev
; /* pointer to pci device struct */
179 /* array of pointers to aio lists */
180 struct mei_io_list read_list
; /* driver read queue */
181 struct mei_io_list write_list
; /* driver write queue */
182 struct mei_io_list write_waiting_list
; /* write waiting queue */
183 struct mei_io_list ctrl_wr_list
; /* managed write IOCTL list */
184 struct mei_io_list ctrl_rd_list
; /* managed read IOCTL list */
185 struct mei_io_list amthi_cmd_list
; /* amthi list for cmd waiting */
187 /* driver managed amthi list for reading completed amthi cmd data */
188 struct mei_io_list amthi_read_complete_list
;
192 struct list_head file_list
;
193 long open_handle_count
;
197 unsigned int mem_base
;
198 unsigned int mem_length
;
199 void __iomem
*mem_addr
;
201 * lock for the device
203 struct mutex device_lock
; /* device lock */
204 struct delayed_work timer_work
; /* MEI timer delayed work (timeouts) */
207 * hw states of host and fw(ME)
213 * waiting queue for receive message from FW
215 wait_queue_head_t wait_recvd_msg
;
216 wait_queue_head_t wait_stop_wd
;
221 enum mei_states mei_state
;
222 enum mei_init_clients_states init_clients_state
;
223 u16 init_clients_timer
;
227 u32 extra_write_index
;
228 unsigned char rd_msg_buf
[MEI_RD_MSG_BUF_SIZE
]; /* control messages */
229 u32 wr_msg_buf
[128]; /* used for control messages */
230 u32 ext_msg_buf
[8]; /* for control responses */
233 struct hbm_version version
;
235 struct mei_me_client
*me_clients
; /* Note: memory has to be allocated */
236 DECLARE_BITMAP(me_clients_map
, MEI_CLIENTS_MAX
);
237 DECLARE_BITMAP(host_clients_map
, MEI_CLIENTS_MAX
);
239 u8 me_client_presentation_num
;
241 bool mei_host_buffer_is_empty
;
244 bool wd_interface_reg
;
247 bool wd_bypass
; /* if false, don't refresh watchdog ME client */
248 u16 wd_timeout
; /* seconds ((wd_data[1] << 8) + wd_data[0]) */
249 unsigned char wd_data
[MEI_START_WD_DATA_SIZE
];
252 struct file
*iamthif_file_object
;
253 struct mei_cl iamthif_cl
;
254 struct mei_cl_cb
*iamthif_current_cb
;
256 unsigned long iamthif_timer
;
257 u32 iamthif_stall_timer
;
258 unsigned char *iamthif_msg_buf
; /* Note: memory has to be allocated */
259 u32 iamthif_msg_buf_size
;
260 u32 iamthif_msg_buf_index
;
261 enum iamthif_states iamthif_state
;
262 bool iamthif_flow_control_pending
;
264 bool iamthif_canceled
;
269 * mei init function prototypes
271 struct mei_device
*mei_device_init(struct pci_dev
*pdev
);
272 void mei_reset(struct mei_device
*dev
, int interrupts
);
273 int mei_hw_init(struct mei_device
*dev
);
274 int mei_task_initialize_clients(void *data
);
275 int mei_initialize_clients(struct mei_device
*dev
);
276 int mei_disconnect_host_client(struct mei_device
*dev
, struct mei_cl
*cl
);
277 void mei_remove_client_from_file_list(struct mei_device
*dev
, u8 host_client_id
);
278 void mei_host_init_iamthif(struct mei_device
*dev
);
279 void mei_allocate_me_clients_storage(struct mei_device
*dev
);
282 int mei_me_cl_update_filext(struct mei_device
*dev
, struct mei_cl
*cl
,
283 const uuid_le
*cguid
, u8 host_client_id
);
284 int mei_me_cl_by_uuid(const struct mei_device
*dev
, const uuid_le
*cuuid
);
285 int mei_me_cl_by_id(struct mei_device
*dev
, u8 client_id
);
288 * MEI IO List Functions
290 void mei_io_list_init(struct mei_io_list
*list
);
291 void mei_io_list_flush(struct mei_io_list
*list
, struct mei_cl
*cl
);
294 * MEI ME Client Functions
297 struct mei_cl
*mei_cl_allocate(struct mei_device
*dev
);
298 void mei_cl_init(struct mei_cl
*cl
, struct mei_device
*dev
);
299 int mei_cl_flush_queues(struct mei_cl
*cl
);
301 * mei_cl_cmp_id - tells if file private data have same id
303 * @fe1: private data of 1. file object
304 * @fe2: private data of 2. file object
306 * returns true - if ids are the same and not NULL
308 static inline bool mei_cl_cmp_id(const struct mei_cl
*cl1
,
309 const struct mei_cl
*cl2
)
312 (cl1
->host_client_id
== cl2
->host_client_id
) &&
313 (cl1
->me_client_id
== cl2
->me_client_id
);
319 * MEI Host Client Functions
321 void mei_host_start_message(struct mei_device
*dev
);
322 void mei_host_enum_clients_message(struct mei_device
*dev
);
323 int mei_host_client_properties(struct mei_device
*dev
);
326 * MEI interrupt functions prototype
328 irqreturn_t
mei_interrupt_quick_handler(int irq
, void *dev_id
);
329 irqreturn_t
mei_interrupt_thread_handler(int irq
, void *dev_id
);
330 void mei_timer(struct work_struct
*work
);
333 * MEI input output function prototype
335 int mei_ioctl_connect_client(struct file
*file
,
336 struct mei_connect_client_data
*data
);
338 int mei_start_read(struct mei_device
*dev
, struct mei_cl
*cl
);
340 int amthi_write(struct mei_device
*dev
, struct mei_cl_cb
*priv_cb
);
342 int amthi_read(struct mei_device
*dev
, struct file
*file
,
343 char __user
*ubuf
, size_t length
, loff_t
*offset
);
345 struct mei_cl_cb
*find_amthi_read_list_entry(struct mei_device
*dev
,
348 void mei_run_next_iamthif_cmd(struct mei_device
*dev
);
350 void mei_free_cb_private(struct mei_cl_cb
*priv_cb
);
354 * Register Access Function
358 * mei_reg_read - Reads 32bit data from the mei device
360 * @dev: the device structure
361 * @offset: offset from which to read the data
363 * returns register value (u32)
365 static inline u32
mei_reg_read(const struct mei_device
*dev
,
366 unsigned long offset
)
368 return ioread32(dev
->mem_addr
+ offset
);
372 * mei_reg_write - Writes 32bit data to the mei device
374 * @dev: the device structure
375 * @offset: offset from which to write the data
376 * @value: register value to write (u32)
378 static inline void mei_reg_write(const struct mei_device
*dev
,
379 unsigned long offset
, u32 value
)
381 iowrite32(value
, dev
->mem_addr
+ offset
);
385 * mei_hcsr_read - Reads 32bit data from the host CSR
387 * @dev: the device structure
389 * returns the byte read.
391 static inline u32
mei_hcsr_read(const struct mei_device
*dev
)
393 return mei_reg_read(dev
, H_CSR
);
397 * mei_mecsr_read - Reads 32bit data from the ME CSR
399 * @dev: the device structure
401 * returns ME_CSR_HA register value (u32)
403 static inline u32
mei_mecsr_read(const struct mei_device
*dev
)
405 return mei_reg_read(dev
, ME_CSR_HA
);
409 * get_me_cb_rw - Reads 32bit data from the mei ME_CB_RW register
411 * @dev: the device structure
413 * returns ME_CB_RW register value (u32)
415 static inline u32
mei_mecbrw_read(const struct mei_device
*dev
)
417 return mei_reg_read(dev
, ME_CB_RW
);
422 * mei interface function prototypes
424 void mei_hcsr_set(struct mei_device
*dev
);
425 void mei_csr_clear_his(struct mei_device
*dev
);
427 void mei_enable_interrupts(struct mei_device
*dev
);
428 void mei_disable_interrupts(struct mei_device
*dev
);