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