Commit | Line | Data |
---|---|---|
ab841160 OW |
1 | /* |
2 | * | |
3 | * Intel Management Engine Interface (Intel MEI) Linux driver | |
733ba91c | 4 | * Copyright (c) 2003-2012, Intel Corporation. |
ab841160 OW |
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> | |
9ce178e5 | 21 | #include <linux/watchdog.h> |
744f0f2f | 22 | #include <linux/poll.h> |
4f3afe1d | 23 | #include <linux/mei.h> |
e5354107 | 24 | #include <linux/mei_cl_bus.h> |
66ef5ea9 | 25 | |
ab841160 | 26 | #include "hw.h" |
9b0d5efc | 27 | #include "hbm.h" |
ab841160 | 28 | |
ab841160 OW |
29 | /* |
30 | * watch dog definition | |
31 | */ | |
248ffdf7 TW |
32 | #define MEI_WD_HDR_SIZE 4 |
33 | #define MEI_WD_STOP_MSG_SIZE MEI_WD_HDR_SIZE | |
34 | #define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16) | |
35 | ||
36 | #define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */ | |
37 | #define MEI_WD_MIN_TIMEOUT 120 /* seconds */ | |
38 | #define MEI_WD_MAX_TIMEOUT 65535 /* seconds */ | |
39 | ||
c216fdeb TW |
40 | #define MEI_WD_STOP_TIMEOUT 10 /* msecs */ |
41 | ||
ab841160 OW |
42 | #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0) |
43 | ||
edf1eed4 TW |
44 | #define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32)) |
45 | ||
9ce178e5 | 46 | |
ab841160 OW |
47 | /* |
48 | * AMTHI Client UUID | |
49 | */ | |
1a1aca42 | 50 | extern const uuid_le mei_amthif_guid; |
ab841160 OW |
51 | |
52 | /* | |
53 | * Watchdog Client UUID | |
54 | */ | |
55 | extern const uuid_le mei_wd_guid; | |
56 | ||
1e2776c3 TW |
57 | /* |
58 | * Number of Maximum MEI Clients | |
59 | */ | |
60 | #define MEI_CLIENTS_MAX 256 | |
61 | ||
6adb8efb TW |
62 | /* |
63 | * maximum number of consecutive resets | |
64 | */ | |
65 | #define MEI_MAX_CONSEC_RESET 3 | |
66 | ||
ab841160 OW |
67 | /* |
68 | * Number of File descriptors/handles | |
69 | * that can be opened to the driver. | |
70 | * | |
781d0d89 | 71 | * Limit to 255: 256 Total Clients |
83ce0741 | 72 | * minus internal client for MEI Bus Messages |
ab841160 | 73 | */ |
781d0d89 | 74 | #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1) |
ab841160 | 75 | |
1d3f3da3 TW |
76 | /* |
77 | * Internal Clients Number | |
78 | */ | |
781d0d89 TW |
79 | #define MEI_HOST_CLIENT_ID_ANY (-1) |
80 | #define MEI_HBM_HOST_CLIENT_ID 0 /* not used, just for documentation */ | |
1d3f3da3 TW |
81 | #define MEI_WD_HOST_CLIENT_ID 1 |
82 | #define MEI_IAMTHIF_HOST_CLIENT_ID 2 | |
83 | ||
ab841160 OW |
84 | |
85 | /* File state */ | |
86 | enum file_state { | |
87 | MEI_FILE_INITIALIZING = 0, | |
88 | MEI_FILE_CONNECTING, | |
89 | MEI_FILE_CONNECTED, | |
90 | MEI_FILE_DISCONNECTING, | |
3c666182 | 91 | MEI_FILE_DISCONNECT_REPLY, |
18901357 | 92 | MEI_FILE_DISCONNECT_REQUIRED, |
3c666182 | 93 | MEI_FILE_DISCONNECTED, |
ab841160 OW |
94 | }; |
95 | ||
96 | /* MEI device states */ | |
b210d750 TW |
97 | enum mei_dev_state { |
98 | MEI_DEV_INITIALIZING = 0, | |
99 | MEI_DEV_INIT_CLIENTS, | |
100 | MEI_DEV_ENABLED, | |
0cfee51c | 101 | MEI_DEV_RESETTING, |
b210d750 | 102 | MEI_DEV_DISABLED, |
b210d750 TW |
103 | MEI_DEV_POWER_DOWN, |
104 | MEI_DEV_POWER_UP | |
ab841160 OW |
105 | }; |
106 | ||
b210d750 TW |
107 | const char *mei_dev_state_str(int state); |
108 | ||
ab841160 OW |
109 | enum iamthif_states { |
110 | MEI_IAMTHIF_IDLE, | |
111 | MEI_IAMTHIF_WRITING, | |
112 | MEI_IAMTHIF_FLOW_CONTROL, | |
113 | MEI_IAMTHIF_READING, | |
114 | MEI_IAMTHIF_READ_COMPLETE | |
115 | }; | |
116 | ||
117 | enum mei_file_transaction_states { | |
118 | MEI_IDLE, | |
119 | MEI_WRITING, | |
120 | MEI_WRITE_COMPLETE, | |
121 | MEI_FLOW_CONTROL, | |
122 | MEI_READING, | |
123 | MEI_READ_COMPLETE | |
124 | }; | |
125 | ||
c216fdeb TW |
126 | enum mei_wd_states { |
127 | MEI_WD_IDLE, | |
128 | MEI_WD_RUNNING, | |
129 | MEI_WD_STOPPING, | |
130 | }; | |
131 | ||
4b8960b4 TW |
132 | /** |
133 | * enum mei_cb_file_ops - file operation associated with the callback | |
ce23139c AU |
134 | * @MEI_FOP_READ: read |
135 | * @MEI_FOP_WRITE: write | |
136 | * @MEI_FOP_CONNECT: connect | |
137 | * @MEI_FOP_DISCONNECT: disconnect | |
138 | * @MEI_FOP_DISCONNECT_RSP: disconnect response | |
965ae37a TW |
139 | * @MEI_FOP_NOTIFY_START: start notification |
140 | * @MEI_FOP_NOTIFY_STOP: stop notification | |
4b8960b4 TW |
141 | */ |
142 | enum mei_cb_file_ops { | |
143 | MEI_FOP_READ = 0, | |
144 | MEI_FOP_WRITE, | |
02a7eecc | 145 | MEI_FOP_CONNECT, |
5a8373fb | 146 | MEI_FOP_DISCONNECT, |
6bb948c9 | 147 | MEI_FOP_DISCONNECT_RSP, |
965ae37a TW |
148 | MEI_FOP_NOTIFY_START, |
149 | MEI_FOP_NOTIFY_STOP, | |
ab841160 OW |
150 | }; |
151 | ||
152 | /* | |
153 | * Intel MEI message data struct | |
154 | */ | |
4234a6de | 155 | struct mei_msg_data { |
ab841160 | 156 | u32 size; |
edf1eed4 | 157 | unsigned char *data; |
f060939d | 158 | }; |
ab841160 | 159 | |
04dd3661 | 160 | /* Maximum number of processed FW status registers */ |
edca5ea3 AU |
161 | #define MEI_FW_STATUS_MAX 6 |
162 | /* Minimal buffer for FW status string (8 bytes in dw + space or '\0') */ | |
163 | #define MEI_FW_STATUS_STR_SZ (MEI_FW_STATUS_MAX * (8 + 1)) | |
164 | ||
04dd3661 AU |
165 | |
166 | /* | |
167 | * struct mei_fw_status - storage of FW status data | |
168 | * | |
a8605ea2 AU |
169 | * @count: number of actually available elements in array |
170 | * @status: FW status registers | |
04dd3661 AU |
171 | */ |
172 | struct mei_fw_status { | |
173 | int count; | |
174 | u32 status[MEI_FW_STATUS_MAX]; | |
175 | }; | |
176 | ||
db7da79d TW |
177 | /** |
178 | * struct mei_me_client - representation of me (fw) client | |
179 | * | |
a8605ea2 | 180 | * @list: link in me client list |
79563db9 | 181 | * @refcnt: struct reference count |
a8605ea2 AU |
182 | * @props: client properties |
183 | * @client_id: me client id | |
184 | * @mei_flow_ctrl_creds: flow control credits | |
a03d77f6 | 185 | * @connect_count: number connections to this client |
0ff0a8d8 | 186 | * @bus_added: added to bus |
db7da79d TW |
187 | */ |
188 | struct mei_me_client { | |
5ca2d388 | 189 | struct list_head list; |
79563db9 | 190 | struct kref refcnt; |
db7da79d TW |
191 | struct mei_client_properties props; |
192 | u8 client_id; | |
193 | u8 mei_flow_ctrl_creds; | |
a03d77f6 | 194 | u8 connect_count; |
0ff0a8d8 | 195 | u8 bus_added; |
db7da79d TW |
196 | }; |
197 | ||
ab841160 | 198 | |
db3ed431 TW |
199 | struct mei_cl; |
200 | ||
4b8960b4 | 201 | /** |
db3ed431 TW |
202 | * struct mei_cl_cb - file operation callback structure |
203 | * | |
a8605ea2 AU |
204 | * @list: link in callback queue |
205 | * @cl: file client who is running this operation | |
206 | * @fop_type: file operation type | |
5db7514d | 207 | * @buf: buffer for data associated with the callback |
ce23139c AU |
208 | * @buf_idx: last read index |
209 | * @read_time: last read operation time stamp (iamthif) | |
210 | * @file_object: pointer to file structure | |
3d33ff24 | 211 | * @status: io status of the cb |
ce23139c | 212 | * @internal: communication between driver and FW flag |
8660172e | 213 | * @completed: the transfer or reception has completed |
db3ed431 | 214 | */ |
ab841160 | 215 | struct mei_cl_cb { |
fb601adb | 216 | struct list_head list; |
db3ed431 | 217 | struct mei_cl *cl; |
4b8960b4 | 218 | enum mei_cb_file_ops fop_type; |
5db7514d | 219 | struct mei_msg_data buf; |
ebb108ef | 220 | unsigned long buf_idx; |
ab841160 OW |
221 | unsigned long read_time; |
222 | struct file *file_object; | |
3d33ff24 | 223 | int status; |
479327fc | 224 | u32 internal:1; |
8660172e | 225 | u32 completed:1; |
ab841160 OW |
226 | }; |
227 | ||
ce23139c AU |
228 | /** |
229 | * struct mei_cl - me client host representation | |
230 | * carried in file->private_data | |
231 | * | |
232 | * @link: link in the clients list | |
233 | * @dev: mei parent device | |
234 | * @state: file operation state | |
235 | * @tx_wait: wait queue for tx completion | |
236 | * @rx_wait: wait queue for rx completion | |
237 | * @wait: wait queue for management operation | |
b38a362f | 238 | * @ev_wait: notification wait queue |
237092bf | 239 | * @ev_async: event async notification |
ce23139c | 240 | * @status: connection status |
d49ed64a | 241 | * @me_cl: fw client connected |
ce23139c | 242 | * @host_client_id: host id |
ce23139c AU |
243 | * @mei_flow_ctrl_creds: transmit flow credentials |
244 | * @timer_count: watchdog timer for operation completion | |
d49ed64a | 245 | * @reserved: reserved for alignment |
965ae37a TW |
246 | * @notify_en: notification - enabled/disabled |
247 | * @notify_ev: pending notification event | |
ce23139c | 248 | * @writing_state: state of the tx |
a9bed610 TW |
249 | * @rd_pending: pending read credits |
250 | * @rd_completed: completed read | |
ce23139c | 251 | * |
b37719c3 | 252 | * @cldev: device on the mei client bus |
ce23139c | 253 | */ |
ab841160 OW |
254 | struct mei_cl { |
255 | struct list_head link; | |
256 | struct mei_device *dev; | |
257 | enum file_state state; | |
258 | wait_queue_head_t tx_wait; | |
259 | wait_queue_head_t rx_wait; | |
260 | wait_queue_head_t wait; | |
b38a362f | 261 | wait_queue_head_t ev_wait; |
237092bf | 262 | struct fasync_struct *ev_async; |
ab841160 | 263 | int status; |
d49ed64a | 264 | struct mei_me_client *me_cl; |
ab841160 | 265 | u8 host_client_id; |
ab841160 OW |
266 | u8 mei_flow_ctrl_creds; |
267 | u8 timer_count; | |
d49ed64a | 268 | u8 reserved; |
965ae37a TW |
269 | u8 notify_en; |
270 | u8 notify_ev; | |
ab841160 | 271 | enum mei_file_transaction_states writing_state; |
a9bed610 TW |
272 | struct list_head rd_pending; |
273 | struct list_head rd_completed; | |
a7b71bc0 | 274 | |
b37719c3 | 275 | struct mei_cl_device *cldev; |
ab841160 OW |
276 | }; |
277 | ||
827eef51 TW |
278 | /** struct mei_hw_ops |
279 | * | |
a8605ea2 | 280 | * @host_is_ready : query for host readiness |
827eef51 | 281 | |
a8605ea2 AU |
282 | * @hw_is_ready : query if hw is ready |
283 | * @hw_reset : reset hw | |
284 | * @hw_start : start hw after reset | |
285 | * @hw_config : configure hw | |
827eef51 | 286 | |
a8605ea2 AU |
287 | * @fw_status : get fw status registers |
288 | * @pg_state : power gating state of the device | |
3dc196ea | 289 | * @pg_in_transition : is device now in pg transition |
a8605ea2 | 290 | * @pg_is_enabled : is power gating enabled |
ee7e5afd | 291 | |
a8605ea2 AU |
292 | * @intr_clear : clear pending interrupts |
293 | * @intr_enable : enable interrupts | |
294 | * @intr_disable : disable interrupts | |
827eef51 | 295 | |
a8605ea2 AU |
296 | * @hbuf_free_slots : query for write buffer empty slots |
297 | * @hbuf_is_ready : query if write buffer is empty | |
298 | * @hbuf_max_len : query for write buffer max len | |
827eef51 | 299 | |
a8605ea2 | 300 | * @write : write a message to FW |
827eef51 | 301 | |
a8605ea2 | 302 | * @rdbuf_full_slots : query how many slots are filled |
827eef51 | 303 | |
a8605ea2 AU |
304 | * @read_hdr : get first 4 bytes (header) |
305 | * @read : read a buffer from the FW | |
827eef51 TW |
306 | */ |
307 | struct mei_hw_ops { | |
308 | ||
d63b3095 | 309 | bool (*host_is_ready)(struct mei_device *dev); |
827eef51 | 310 | |
d63b3095 TW |
311 | bool (*hw_is_ready)(struct mei_device *dev); |
312 | int (*hw_reset)(struct mei_device *dev, bool enable); | |
313 | int (*hw_start)(struct mei_device *dev); | |
314 | void (*hw_config)(struct mei_device *dev); | |
827eef51 | 315 | |
1bd30b6a TW |
316 | |
317 | int (*fw_status)(struct mei_device *dev, struct mei_fw_status *fw_sts); | |
964a2331 | 318 | enum mei_pg_state (*pg_state)(struct mei_device *dev); |
3dc196ea | 319 | bool (*pg_in_transition)(struct mei_device *dev); |
ee7e5afd TW |
320 | bool (*pg_is_enabled)(struct mei_device *dev); |
321 | ||
d63b3095 TW |
322 | void (*intr_clear)(struct mei_device *dev); |
323 | void (*intr_enable)(struct mei_device *dev); | |
324 | void (*intr_disable)(struct mei_device *dev); | |
827eef51 | 325 | |
d63b3095 TW |
326 | int (*hbuf_free_slots)(struct mei_device *dev); |
327 | bool (*hbuf_is_ready)(struct mei_device *dev); | |
328 | size_t (*hbuf_max_len)(const struct mei_device *dev); | |
827eef51 TW |
329 | |
330 | int (*write)(struct mei_device *dev, | |
331 | struct mei_msg_hdr *hdr, | |
332 | unsigned char *buf); | |
333 | ||
334 | int (*rdbuf_full_slots)(struct mei_device *dev); | |
335 | ||
336 | u32 (*read_hdr)(const struct mei_device *dev); | |
d63b3095 | 337 | int (*read)(struct mei_device *dev, |
827eef51 TW |
338 | unsigned char *buf, unsigned long len); |
339 | }; | |
340 | ||
e5354107 | 341 | /* MEI bus API*/ |
6009595a | 342 | void mei_cl_bus_rescan(struct mei_device *bus); |
71ce7891 | 343 | void mei_cl_dev_fixup(struct mei_cl_device *dev); |
be9b720a TW |
344 | ssize_t __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length, |
345 | bool blocking); | |
39db74ce | 346 | ssize_t __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length); |
cf3baefb | 347 | void mei_cl_bus_rx_event(struct mei_cl *cl); |
bb2ef9c3 | 348 | void mei_cl_bus_notify_event(struct mei_cl *cl); |
b37719c3 | 349 | void mei_cl_bus_remove_devices(struct mei_device *bus); |
cf3baefb SO |
350 | int mei_cl_bus_init(void); |
351 | void mei_cl_bus_exit(void); | |
352 | ||
ce23139c | 353 | /** |
964a2331 TW |
354 | * enum mei_pg_event - power gating transition events |
355 | * | |
356 | * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition | |
357 | * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete | |
358 | * @MEI_PG_EVENT_RECEIVED: the driver received pg event | |
3dc196ea AU |
359 | * @MEI_PG_EVENT_INTR_WAIT: the driver is waiting for a pg event interrupt |
360 | * @MEI_PG_EVENT_INTR_RECEIVED: the driver received pg event interrupt | |
964a2331 TW |
361 | */ |
362 | enum mei_pg_event { | |
363 | MEI_PG_EVENT_IDLE, | |
364 | MEI_PG_EVENT_WAIT, | |
365 | MEI_PG_EVENT_RECEIVED, | |
3dc196ea AU |
366 | MEI_PG_EVENT_INTR_WAIT, |
367 | MEI_PG_EVENT_INTR_RECEIVED, | |
964a2331 TW |
368 | }; |
369 | ||
370 | /** | |
371 | * enum mei_pg_state - device internal power gating state | |
372 | * | |
373 | * @MEI_PG_OFF: device is not power gated - it is active | |
374 | * @MEI_PG_ON: device is power gated - it is in lower power state | |
375 | */ | |
376 | enum mei_pg_state { | |
377 | MEI_PG_OFF = 0, | |
378 | MEI_PG_ON = 1, | |
379 | }; | |
380 | ||
1beeb4b9 AU |
381 | const char *mei_pg_state_str(enum mei_pg_state state); |
382 | ||
24aadc80 | 383 | /** |
5fb54fb4 | 384 | * struct mei_device - MEI private device struct |
ce23139c | 385 | * |
a8605ea2 AU |
386 | * @dev : device on a bus |
387 | * @cdev : character device | |
388 | * @minor : minor number allocated for device | |
f3d8e878 | 389 | * |
ce23139c AU |
390 | * @write_list : write pending list |
391 | * @write_waiting_list : write completion list | |
392 | * @ctrl_wr_list : pending control write list | |
393 | * @ctrl_rd_list : pending control read list | |
bae1cc7d | 394 | * |
ce23139c AU |
395 | * @file_list : list of opened handles |
396 | * @open_handle_count: number of opened handles | |
397 | * | |
398 | * @device_lock : big device lock | |
399 | * @timer_work : MEI timer delayed work (timeouts) | |
400 | * | |
401 | * @recvd_hw_ready : hw ready message received flag | |
402 | * | |
403 | * @wait_hw_ready : wait queue for receive HW ready message form FW | |
404 | * @wait_pg : wait queue for receive PG message from FW | |
405 | * @wait_hbm_start : wait queue for receive HBM start message from FW | |
406 | * @wait_stop_wd : wait queue for receive WD stop message from FW | |
407 | * | |
408 | * @reset_count : number of consecutive resets | |
409 | * @dev_state : device state | |
410 | * @hbm_state : state of host bus message protocol | |
411 | * @init_clients_timer : HBM init handshake timeout | |
bae1cc7d | 412 | * |
a8605ea2 | 413 | * @pg_event : power gating event |
ce23139c AU |
414 | * @pg_domain : runtime PM domain |
415 | * | |
416 | * @rd_msg_buf : control messages buffer | |
417 | * @rd_msg_hdr : read message header storage | |
418 | * | |
a8605ea2 AU |
419 | * @hbuf_depth : depth of hardware host/write buffer is slots |
420 | * @hbuf_is_ready : query if the host host/write buffer is ready | |
421 | * @wr_msg : the buffer for hbm control messages | |
ce23139c AU |
422 | * |
423 | * @version : HBM protocol version in use | |
18901357 AU |
424 | * @hbm_f_pg_supported : hbm feature pgi protocol |
425 | * @hbm_f_dc_supported : hbm feature dynamic clients | |
426 | * @hbm_f_dot_supported : hbm feature disconnect on timeout | |
4d99877d | 427 | * @hbm_f_ev_supported : hbm feature event notification |
ce23139c | 428 | * |
b7d88514 | 429 | * @me_clients_rwsem: rw lock over me_clients list |
ce23139c AU |
430 | * @me_clients : list of FW clients |
431 | * @me_clients_map : FW clients bit map | |
432 | * @host_clients_map : host clients id pool | |
433 | * @me_client_index : last FW client index in enumeration | |
434 | * | |
eeabfcf5 AU |
435 | * @allow_fixed_address: allow user space to connect a fixed client |
436 | * | |
ce23139c AU |
437 | * @wd_cl : watchdog client |
438 | * @wd_state : watchdog client state | |
439 | * @wd_pending : watchdog command is pending | |
440 | * @wd_timeout : watchdog expiration timeout | |
441 | * @wd_data : watchdog message buffer | |
442 | * | |
443 | * @amthif_cmd_list : amthif list for cmd waiting | |
444 | * @amthif_rd_complete_list : amthif list for reading completed cmd data | |
445 | * @iamthif_file_object : file for current amthif operation | |
446 | * @iamthif_cl : amthif host client | |
447 | * @iamthif_current_cb : amthif current operation callback | |
448 | * @iamthif_open_count : number of opened amthif connections | |
ce23139c AU |
449 | * @iamthif_timer : time stamp of current amthif command completion |
450 | * @iamthif_stall_timer : timer to detect amthif hang | |
ce23139c | 451 | * @iamthif_state : amthif processor state |
ce23139c AU |
452 | * @iamthif_canceled : current amthif command is canceled |
453 | * | |
454 | * @init_work : work item for the device init | |
455 | * @reset_work : work item for the device reset | |
456 | * | |
457 | * @device_list : mei client bus list | |
0ff0a8d8 | 458 | * @cl_bus_lock : client bus list lock |
ce23139c AU |
459 | * |
460 | * @dbgfs_dir : debugfs mei root directory | |
461 | * | |
462 | * @ops: : hw specific operations | |
463 | * @hw : hw specific data | |
24aadc80 | 464 | */ |
ab841160 | 465 | struct mei_device { |
3a7e9b6c | 466 | struct device *dev; |
f3d8e878 AU |
467 | struct cdev cdev; |
468 | int minor; | |
469 | ||
ce23139c AU |
470 | struct mei_cl_cb write_list; |
471 | struct mei_cl_cb write_waiting_list; | |
472 | struct mei_cl_cb ctrl_wr_list; | |
473 | struct mei_cl_cb ctrl_rd_list; | |
ab841160 | 474 | |
ab841160 | 475 | struct list_head file_list; |
eb9af0ac | 476 | long open_handle_count; |
fecb0d58 | 477 | |
ce23139c AU |
478 | struct mutex device_lock; |
479 | struct delayed_work timer_work; | |
aafae7ec TW |
480 | |
481 | bool recvd_hw_ready; | |
ab841160 OW |
482 | /* |
483 | * waiting queue for receive message from FW | |
484 | */ | |
aafae7ec | 485 | wait_queue_head_t wait_hw_ready; |
4fcbc99b | 486 | wait_queue_head_t wait_pg; |
cb02efc3 | 487 | wait_queue_head_t wait_hbm_start; |
ab841160 OW |
488 | wait_queue_head_t wait_stop_wd; |
489 | ||
490 | /* | |
491 | * mei device states | |
492 | */ | |
6adb8efb | 493 | unsigned long reset_count; |
b210d750 | 494 | enum mei_dev_state dev_state; |
9b0d5efc | 495 | enum mei_hbm_state hbm_state; |
ab841160 | 496 | u16 init_clients_timer; |
ab841160 | 497 | |
964a2331 TW |
498 | /* |
499 | * Power Gating support | |
500 | */ | |
501 | enum mei_pg_event pg_event; | |
bbd6d050 | 502 | #ifdef CONFIG_PM |
e13fa90c | 503 | struct dev_pm_domain pg_domain; |
bbd6d050 | 504 | #endif /* CONFIG_PM */ |
964a2331 | 505 | |
ce23139c | 506 | unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; |
ab841160 | 507 | u32 rd_msg_hdr; |
e46f1874 | 508 | |
330dd7da TW |
509 | /* write buffer */ |
510 | u8 hbuf_depth; | |
511 | bool hbuf_is_ready; | |
512 | ||
e46f1874 TW |
513 | /* used for control messages */ |
514 | struct { | |
515 | struct mei_msg_hdr hdr; | |
516 | unsigned char data[128]; | |
517 | } wr_msg; | |
518 | ||
ab841160 | 519 | struct hbm_version version; |
bae1cc7d | 520 | unsigned int hbm_f_pg_supported:1; |
70ef835c | 521 | unsigned int hbm_f_dc_supported:1; |
18901357 | 522 | unsigned int hbm_f_dot_supported:1; |
4d99877d | 523 | unsigned int hbm_f_ev_supported:1; |
ab841160 | 524 | |
b7d88514 | 525 | struct rw_semaphore me_clients_rwsem; |
5ca2d388 | 526 | struct list_head me_clients; |
ab841160 OW |
527 | DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX); |
528 | DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX); | |
1aee351a | 529 | unsigned long me_client_index; |
ab841160 | 530 | |
eeabfcf5 AU |
531 | u32 allow_fixed_address; |
532 | ||
eb9af0ac | 533 | struct mei_cl wd_cl; |
c216fdeb | 534 | enum mei_wd_states wd_state; |
eb9af0ac | 535 | bool wd_pending; |
c216fdeb | 536 | u16 wd_timeout; |
248ffdf7 | 537 | unsigned char wd_data[MEI_WD_START_MSG_SIZE]; |
ab841160 OW |
538 | |
539 | ||
e773efc4 TW |
540 | /* amthif list for cmd waiting */ |
541 | struct mei_cl_cb amthif_cmd_list; | |
542 | /* driver managed amthif list for reading completed amthif cmd data */ | |
543 | struct mei_cl_cb amthif_rd_complete_list; | |
ab841160 OW |
544 | struct file *iamthif_file_object; |
545 | struct mei_cl iamthif_cl; | |
eb9af0ac | 546 | struct mei_cl_cb *iamthif_current_cb; |
22f96a0e | 547 | long iamthif_open_count; |
ab841160 OW |
548 | unsigned long iamthif_timer; |
549 | u32 iamthif_stall_timer; | |
ab841160 | 550 | enum iamthif_states iamthif_state; |
eb9af0ac | 551 | bool iamthif_canceled; |
c1174c0e SO |
552 | |
553 | struct work_struct init_work; | |
544f9460 | 554 | struct work_struct reset_work; |
827eef51 | 555 | |
a7b71bc0 SO |
556 | /* List of bus devices */ |
557 | struct list_head device_list; | |
0ff0a8d8 | 558 | struct mutex cl_bus_lock; |
a7b71bc0 | 559 | |
30e53bb8 TW |
560 | #if IS_ENABLED(CONFIG_DEBUG_FS) |
561 | struct dentry *dbgfs_dir; | |
562 | #endif /* CONFIG_DEBUG_FS */ | |
563 | ||
564 | ||
827eef51 | 565 | const struct mei_hw_ops *ops; |
52c34561 | 566 | char hw[0] __aligned(sizeof(void *)); |
ab841160 OW |
567 | }; |
568 | ||
3870c320 TW |
569 | static inline unsigned long mei_secs_to_jiffies(unsigned long sec) |
570 | { | |
571 | return msecs_to_jiffies(sec * MSEC_PER_SEC); | |
572 | } | |
573 | ||
c8c8d080 TW |
574 | /** |
575 | * mei_data2slots - get slots - number of (dwords) from a message length | |
576 | * + size of the mei header | |
ce23139c | 577 | * |
a8605ea2 AU |
578 | * @length: size of the messages in bytes |
579 | * | |
580 | * Return: number of slots | |
c8c8d080 TW |
581 | */ |
582 | static inline u32 mei_data2slots(size_t length) | |
583 | { | |
584 | return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4); | |
585 | } | |
586 | ||
10ee9074 | 587 | /** |
ce23139c AU |
588 | * mei_slots2data - get data in slots - bytes from slots |
589 | * | |
a8605ea2 | 590 | * @slots: number of available slots |
ce23139c | 591 | * |
a8605ea2 | 592 | * Return: number of bytes in slots |
10ee9074 TW |
593 | */ |
594 | static inline u32 mei_slots2data(int slots) | |
595 | { | |
596 | return slots * 4; | |
597 | } | |
598 | ||
ab841160 OW |
599 | /* |
600 | * mei init function prototypes | |
601 | */ | |
3a7e9b6c TW |
602 | void mei_device_init(struct mei_device *dev, |
603 | struct device *device, | |
604 | const struct mei_hw_ops *hw_ops); | |
33ec0826 | 605 | int mei_reset(struct mei_device *dev); |
c4d589be | 606 | int mei_start(struct mei_device *dev); |
33ec0826 | 607 | int mei_restart(struct mei_device *dev); |
7cb035d9 | 608 | void mei_stop(struct mei_device *dev); |
dc844b0d | 609 | void mei_cancel_work(struct mei_device *dev); |
c95efb74 | 610 | |
c95efb74 TW |
611 | /* |
612 | * MEI interrupt functions prototype | |
ab841160 | 613 | */ |
06ecd645 | 614 | |
a61c6530 | 615 | void mei_timer(struct work_struct *work); |
06ecd645 TW |
616 | int mei_irq_read_handler(struct mei_device *dev, |
617 | struct mei_cl_cb *cmpl_list, s32 *slots); | |
618 | ||
619 | int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list); | |
4c6e22b8 | 620 | void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list); |
ab841160 | 621 | |
19838fb8 TW |
622 | /* |
623 | * AMTHIF - AMT Host Interface Functions | |
624 | */ | |
625 | void mei_amthif_reset_params(struct mei_device *dev); | |
626 | ||
d49ed64a | 627 | int mei_amthif_host_init(struct mei_device *dev, struct mei_me_client *me_cl); |
19838fb8 | 628 | |
19838fb8 | 629 | int mei_amthif_read(struct mei_device *dev, struct file *file, |
744f0f2f TW |
630 | char __user *ubuf, size_t length, loff_t *offset); |
631 | ||
632 | unsigned int mei_amthif_poll(struct mei_device *dev, | |
633 | struct file *file, poll_table *wait); | |
ab841160 | 634 | |
a562d5c2 TW |
635 | int mei_amthif_release(struct mei_device *dev, struct file *file); |
636 | ||
19838fb8 | 637 | struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev, |
ab841160 OW |
638 | struct file *file); |
639 | ||
8660172e TW |
640 | int mei_amthif_write(struct mei_cl *cl, struct mei_cl_cb *cb); |
641 | int mei_amthif_run_next_cmd(struct mei_device *dev); | |
9d098192 TW |
642 | int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb, |
643 | struct mei_cl_cb *cmpl_list); | |
5ceb46e2 TW |
644 | |
645 | void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb); | |
db4756fd | 646 | int mei_amthif_irq_read_msg(struct mei_cl *cl, |
5ceb46e2 TW |
647 | struct mei_msg_hdr *mei_hdr, |
648 | struct mei_cl_cb *complete_list); | |
649 | int mei_amthif_irq_read(struct mei_device *dev, s32 *slots); | |
650 | ||
59fcd7c6 SO |
651 | /* |
652 | * NFC functions | |
653 | */ | |
d49ed64a | 654 | int mei_nfc_host_init(struct mei_device *dev, struct mei_me_client *me_cl); |
dc844b0d | 655 | void mei_nfc_host_exit(struct mei_device *dev); |
59fcd7c6 SO |
656 | |
657 | /* | |
658 | * NFC Client UUID | |
659 | */ | |
660 | extern const uuid_le mei_nfc_guid; | |
19838fb8 | 661 | |
37e7d6e7 TW |
662 | int mei_wd_send(struct mei_device *dev); |
663 | int mei_wd_stop(struct mei_device *dev); | |
d49ed64a | 664 | int mei_wd_host_init(struct mei_device *dev, struct mei_me_client *me_cl); |
37e7d6e7 TW |
665 | /* |
666 | * mei_watchdog_register - Registering watchdog interface | |
667 | * once we got connection to the WD Client | |
a8605ea2 | 668 | * @dev: mei device |
37e7d6e7 | 669 | */ |
64092858 | 670 | int mei_watchdog_register(struct mei_device *dev); |
37e7d6e7 TW |
671 | /* |
672 | * mei_watchdog_unregister - Unregistering watchdog interface | |
a8605ea2 | 673 | * @dev: mei device |
37e7d6e7 TW |
674 | */ |
675 | void mei_watchdog_unregister(struct mei_device *dev); | |
676 | ||
ab841160 OW |
677 | /* |
678 | * Register Access Function | |
679 | */ | |
680 | ||
8d929d48 | 681 | |
827eef51 TW |
682 | static inline void mei_hw_config(struct mei_device *dev) |
683 | { | |
684 | dev->ops->hw_config(dev); | |
685 | } | |
ee7e5afd | 686 | |
964a2331 TW |
687 | static inline enum mei_pg_state mei_pg_state(struct mei_device *dev) |
688 | { | |
689 | return dev->ops->pg_state(dev); | |
690 | } | |
691 | ||
3dc196ea AU |
692 | static inline bool mei_pg_in_transition(struct mei_device *dev) |
693 | { | |
694 | return dev->ops->pg_in_transition(dev); | |
695 | } | |
696 | ||
ee7e5afd TW |
697 | static inline bool mei_pg_is_enabled(struct mei_device *dev) |
698 | { | |
699 | return dev->ops->pg_is_enabled(dev); | |
700 | } | |
701 | ||
c20c68d5 | 702 | static inline int mei_hw_reset(struct mei_device *dev, bool enable) |
827eef51 | 703 | { |
c20c68d5 | 704 | return dev->ops->hw_reset(dev, enable); |
827eef51 TW |
705 | } |
706 | ||
9049f793 | 707 | static inline int mei_hw_start(struct mei_device *dev) |
aafae7ec | 708 | { |
9049f793 | 709 | return dev->ops->hw_start(dev); |
aafae7ec TW |
710 | } |
711 | ||
827eef51 TW |
712 | static inline void mei_clear_interrupts(struct mei_device *dev) |
713 | { | |
714 | dev->ops->intr_clear(dev); | |
715 | } | |
716 | ||
717 | static inline void mei_enable_interrupts(struct mei_device *dev) | |
718 | { | |
719 | dev->ops->intr_enable(dev); | |
720 | } | |
ab841160 | 721 | |
827eef51 TW |
722 | static inline void mei_disable_interrupts(struct mei_device *dev) |
723 | { | |
724 | dev->ops->intr_disable(dev); | |
725 | } | |
ab841160 | 726 | |
827eef51 TW |
727 | static inline bool mei_host_is_ready(struct mei_device *dev) |
728 | { | |
729 | return dev->ops->host_is_ready(dev); | |
730 | } | |
731 | static inline bool mei_hw_is_ready(struct mei_device *dev) | |
732 | { | |
733 | return dev->ops->hw_is_ready(dev); | |
734 | } | |
e7e0c231 | 735 | |
827eef51 TW |
736 | static inline bool mei_hbuf_is_ready(struct mei_device *dev) |
737 | { | |
738 | return dev->ops->hbuf_is_ready(dev); | |
739 | } | |
ab841160 | 740 | |
827eef51 TW |
741 | static inline int mei_hbuf_empty_slots(struct mei_device *dev) |
742 | { | |
743 | return dev->ops->hbuf_free_slots(dev); | |
744 | } | |
115ba28c | 745 | |
827eef51 TW |
746 | static inline size_t mei_hbuf_max_len(const struct mei_device *dev) |
747 | { | |
748 | return dev->ops->hbuf_max_len(dev); | |
749 | } | |
3a65dd4e | 750 | |
827eef51 TW |
751 | static inline int mei_write_message(struct mei_device *dev, |
752 | struct mei_msg_hdr *hdr, | |
753 | unsigned char *buf) | |
754 | { | |
755 | return dev->ops->write(dev, hdr, buf); | |
756 | } | |
757 | ||
758 | static inline u32 mei_read_hdr(const struct mei_device *dev) | |
759 | { | |
760 | return dev->ops->read_hdr(dev); | |
761 | } | |
762 | ||
763 | static inline void mei_read_slots(struct mei_device *dev, | |
764 | unsigned char *buf, unsigned long len) | |
765 | { | |
766 | dev->ops->read(dev, buf, len); | |
767 | } | |
768 | ||
769 | static inline int mei_count_full_read_slots(struct mei_device *dev) | |
770 | { | |
771 | return dev->ops->rdbuf_full_slots(dev); | |
772 | } | |
5bd64714 | 773 | |
1bd30b6a TW |
774 | static inline int mei_fw_status(struct mei_device *dev, |
775 | struct mei_fw_status *fw_status) | |
776 | { | |
777 | return dev->ops->fw_status(dev, fw_status); | |
778 | } | |
04dd3661 | 779 | |
6aae48ff TW |
780 | bool mei_hbuf_acquire(struct mei_device *dev); |
781 | ||
a532bbed TW |
782 | bool mei_write_is_idle(struct mei_device *dev); |
783 | ||
30e53bb8 TW |
784 | #if IS_ENABLED(CONFIG_DEBUG_FS) |
785 | int mei_dbgfs_register(struct mei_device *dev, const char *name); | |
786 | void mei_dbgfs_deregister(struct mei_device *dev); | |
787 | #else | |
788 | static inline int mei_dbgfs_register(struct mei_device *dev, const char *name) | |
789 | { | |
790 | return 0; | |
791 | } | |
792 | static inline void mei_dbgfs_deregister(struct mei_device *dev) {} | |
793 | #endif /* CONFIG_DEBUG_FS */ | |
794 | ||
f3d8e878 | 795 | int mei_register(struct mei_device *dev, struct device *parent); |
30e53bb8 | 796 | void mei_deregister(struct mei_device *dev); |
2703d4b2 | 797 | |
479327fc | 798 | #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d" |
15d4acc5 TW |
799 | #define MEI_HDR_PRM(hdr) \ |
800 | (hdr)->host_addr, (hdr)->me_addr, \ | |
479327fc | 801 | (hdr)->length, (hdr)->internal, (hdr)->msg_complete |
15d4acc5 | 802 | |
edca5ea3 AU |
803 | ssize_t mei_fw_status2str(struct mei_fw_status *fw_sts, char *buf, size_t len); |
804 | /** | |
805 | * mei_fw_status_str - fetch and convert fw status registers to printable string | |
806 | * | |
807 | * @dev: the device structure | |
808 | * @buf: string buffer at minimal size MEI_FW_STATUS_STR_SZ | |
809 | * @len: buffer len must be >= MEI_FW_STATUS_STR_SZ | |
810 | * | |
811 | * Return: number of bytes written or < 0 on failure | |
812 | */ | |
813 | static inline ssize_t mei_fw_status_str(struct mei_device *dev, | |
814 | char *buf, size_t len) | |
815 | { | |
816 | struct mei_fw_status fw_status; | |
817 | int ret; | |
818 | ||
819 | buf[0] = '\0'; | |
820 | ||
821 | ret = mei_fw_status(dev, &fw_status); | |
822 | if (ret) | |
823 | return ret; | |
824 | ||
825 | ret = mei_fw_status2str(&fw_status, buf, MEI_FW_STATUS_STR_SZ); | |
826 | ||
827 | return ret; | |
828 | } | |
829 | ||
830 | ||
ab841160 | 831 | #endif |