]>
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> | |
fdd9b865 | 21 | #include <linux/cdev.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 | |
fdd9b865 | 29 | #define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32)) |
ab841160 | 30 | |
1e2776c3 TW |
31 | /* |
32 | * Number of Maximum MEI Clients | |
33 | */ | |
34 | #define MEI_CLIENTS_MAX 256 | |
35 | ||
6adb8efb TW |
36 | /* |
37 | * maximum number of consecutive resets | |
38 | */ | |
39 | #define MEI_MAX_CONSEC_RESET 3 | |
40 | ||
ab841160 OW |
41 | /* |
42 | * Number of File descriptors/handles | |
43 | * that can be opened to the driver. | |
44 | * | |
781d0d89 | 45 | * Limit to 255: 256 Total Clients |
83ce0741 | 46 | * minus internal client for MEI Bus Messages |
ab841160 | 47 | */ |
781d0d89 | 48 | #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1) |
ab841160 | 49 | |
ab841160 OW |
50 | /* File state */ |
51 | enum file_state { | |
bd47b526 AU |
52 | MEI_FILE_UNINITIALIZED = 0, |
53 | MEI_FILE_INITIALIZING, | |
ab841160 OW |
54 | MEI_FILE_CONNECTING, |
55 | MEI_FILE_CONNECTED, | |
56 | MEI_FILE_DISCONNECTING, | |
3c666182 | 57 | MEI_FILE_DISCONNECT_REPLY, |
18901357 | 58 | MEI_FILE_DISCONNECT_REQUIRED, |
3c666182 | 59 | MEI_FILE_DISCONNECTED, |
ab841160 OW |
60 | }; |
61 | ||
62 | /* MEI device states */ | |
b210d750 TW |
63 | enum mei_dev_state { |
64 | MEI_DEV_INITIALIZING = 0, | |
65 | MEI_DEV_INIT_CLIENTS, | |
66 | MEI_DEV_ENABLED, | |
0cfee51c | 67 | MEI_DEV_RESETTING, |
b210d750 | 68 | MEI_DEV_DISABLED, |
b210d750 TW |
69 | MEI_DEV_POWER_DOWN, |
70 | MEI_DEV_POWER_UP | |
ab841160 OW |
71 | }; |
72 | ||
b210d750 TW |
73 | const char *mei_dev_state_str(int state); |
74 | ||
ab841160 OW |
75 | enum mei_file_transaction_states { |
76 | MEI_IDLE, | |
77 | MEI_WRITING, | |
78 | MEI_WRITE_COMPLETE, | |
ab841160 OW |
79 | }; |
80 | ||
4b8960b4 TW |
81 | /** |
82 | * enum mei_cb_file_ops - file operation associated with the callback | |
ce23139c AU |
83 | * @MEI_FOP_READ: read |
84 | * @MEI_FOP_WRITE: write | |
85 | * @MEI_FOP_CONNECT: connect | |
86 | * @MEI_FOP_DISCONNECT: disconnect | |
87 | * @MEI_FOP_DISCONNECT_RSP: disconnect response | |
965ae37a TW |
88 | * @MEI_FOP_NOTIFY_START: start notification |
89 | * @MEI_FOP_NOTIFY_STOP: stop notification | |
4b8960b4 TW |
90 | */ |
91 | enum mei_cb_file_ops { | |
92 | MEI_FOP_READ = 0, | |
93 | MEI_FOP_WRITE, | |
02a7eecc | 94 | MEI_FOP_CONNECT, |
5a8373fb | 95 | MEI_FOP_DISCONNECT, |
6bb948c9 | 96 | MEI_FOP_DISCONNECT_RSP, |
965ae37a TW |
97 | MEI_FOP_NOTIFY_START, |
98 | MEI_FOP_NOTIFY_STOP, | |
ab841160 OW |
99 | }; |
100 | ||
e0cb6b2f AU |
101 | /** |
102 | * enum mei_cl_io_mode - io mode between driver and fw | |
103 | * | |
104 | * @MEI_CL_IO_TX_BLOCKING: send is blocking | |
105 | * @MEI_CL_IO_TX_INTERNAL: internal communication between driver and FW | |
076802d0 AU |
106 | * |
107 | * @MEI_CL_IO_RX_NONBLOCK: recv is non-blocking | |
e0cb6b2f AU |
108 | */ |
109 | enum mei_cl_io_mode { | |
110 | MEI_CL_IO_TX_BLOCKING = BIT(0), | |
111 | MEI_CL_IO_TX_INTERNAL = BIT(1), | |
076802d0 AU |
112 | |
113 | MEI_CL_IO_RX_NONBLOCK = BIT(2), | |
e0cb6b2f AU |
114 | }; |
115 | ||
ab841160 OW |
116 | /* |
117 | * Intel MEI message data struct | |
118 | */ | |
4234a6de | 119 | struct mei_msg_data { |
f862b6b2 | 120 | size_t size; |
edf1eed4 | 121 | unsigned char *data; |
f060939d | 122 | }; |
ab841160 | 123 | |
04dd3661 | 124 | /* Maximum number of processed FW status registers */ |
edca5ea3 AU |
125 | #define MEI_FW_STATUS_MAX 6 |
126 | /* Minimal buffer for FW status string (8 bytes in dw + space or '\0') */ | |
127 | #define MEI_FW_STATUS_STR_SZ (MEI_FW_STATUS_MAX * (8 + 1)) | |
128 | ||
04dd3661 AU |
129 | |
130 | /* | |
131 | * struct mei_fw_status - storage of FW status data | |
132 | * | |
a8605ea2 AU |
133 | * @count: number of actually available elements in array |
134 | * @status: FW status registers | |
04dd3661 AU |
135 | */ |
136 | struct mei_fw_status { | |
137 | int count; | |
138 | u32 status[MEI_FW_STATUS_MAX]; | |
139 | }; | |
140 | ||
db7da79d TW |
141 | /** |
142 | * struct mei_me_client - representation of me (fw) client | |
143 | * | |
a8605ea2 | 144 | * @list: link in me client list |
79563db9 | 145 | * @refcnt: struct reference count |
a8605ea2 AU |
146 | * @props: client properties |
147 | * @client_id: me client id | |
4034b81b | 148 | * @tx_flow_ctrl_creds: flow control credits |
a03d77f6 | 149 | * @connect_count: number connections to this client |
0ff0a8d8 | 150 | * @bus_added: added to bus |
db7da79d TW |
151 | */ |
152 | struct mei_me_client { | |
5ca2d388 | 153 | struct list_head list; |
79563db9 | 154 | struct kref refcnt; |
db7da79d TW |
155 | struct mei_client_properties props; |
156 | u8 client_id; | |
4034b81b | 157 | u8 tx_flow_ctrl_creds; |
a03d77f6 | 158 | u8 connect_count; |
0ff0a8d8 | 159 | u8 bus_added; |
db7da79d TW |
160 | }; |
161 | ||
ab841160 | 162 | |
db3ed431 TW |
163 | struct mei_cl; |
164 | ||
4b8960b4 | 165 | /** |
db3ed431 TW |
166 | * struct mei_cl_cb - file operation callback structure |
167 | * | |
a8605ea2 AU |
168 | * @list: link in callback queue |
169 | * @cl: file client who is running this operation | |
170 | * @fop_type: file operation type | |
5db7514d | 171 | * @buf: buffer for data associated with the callback |
ce23139c | 172 | * @buf_idx: last read index |
62e8e6ad | 173 | * @fp: pointer to file structure |
3d33ff24 | 174 | * @status: io status of the cb |
ce23139c | 175 | * @internal: communication between driver and FW flag |
e0cb6b2f | 176 | * @blocking: transmission blocking mode |
8660172e | 177 | * @completed: the transfer or reception has completed |
db3ed431 | 178 | */ |
ab841160 | 179 | struct mei_cl_cb { |
fb601adb | 180 | struct list_head list; |
db3ed431 | 181 | struct mei_cl *cl; |
4b8960b4 | 182 | enum mei_cb_file_ops fop_type; |
5db7514d | 183 | struct mei_msg_data buf; |
f862b6b2 | 184 | size_t buf_idx; |
62e8e6ad | 185 | const struct file *fp; |
3d33ff24 | 186 | int status; |
479327fc | 187 | u32 internal:1; |
e0cb6b2f | 188 | u32 blocking:1; |
8660172e | 189 | u32 completed:1; |
ab841160 OW |
190 | }; |
191 | ||
ce23139c AU |
192 | /** |
193 | * struct mei_cl - me client host representation | |
194 | * carried in file->private_data | |
195 | * | |
196 | * @link: link in the clients list | |
197 | * @dev: mei parent device | |
198 | * @state: file operation state | |
199 | * @tx_wait: wait queue for tx completion | |
200 | * @rx_wait: wait queue for rx completion | |
201 | * @wait: wait queue for management operation | |
b38a362f | 202 | * @ev_wait: notification wait queue |
237092bf | 203 | * @ev_async: event async notification |
ce23139c | 204 | * @status: connection status |
d49ed64a | 205 | * @me_cl: fw client connected |
97d549b4 | 206 | * @fp: file associated with client |
ce23139c | 207 | * @host_client_id: host id |
4034b81b | 208 | * @tx_flow_ctrl_creds: transmit flow credentials |
46978ada | 209 | * @rx_flow_ctrl_creds: receive flow credentials |
ce23139c | 210 | * @timer_count: watchdog timer for operation completion |
965ae37a TW |
211 | * @notify_en: notification - enabled/disabled |
212 | * @notify_ev: pending notification event | |
ce23139c | 213 | * @writing_state: state of the tx |
a9bed610 TW |
214 | * @rd_pending: pending read credits |
215 | * @rd_completed: completed read | |
ce23139c | 216 | * |
b37719c3 | 217 | * @cldev: device on the mei client bus |
ce23139c | 218 | */ |
ab841160 OW |
219 | struct mei_cl { |
220 | struct list_head link; | |
221 | struct mei_device *dev; | |
222 | enum file_state state; | |
223 | wait_queue_head_t tx_wait; | |
224 | wait_queue_head_t rx_wait; | |
225 | wait_queue_head_t wait; | |
b38a362f | 226 | wait_queue_head_t ev_wait; |
237092bf | 227 | struct fasync_struct *ev_async; |
ab841160 | 228 | int status; |
d49ed64a | 229 | struct mei_me_client *me_cl; |
97d549b4 | 230 | const struct file *fp; |
ab841160 | 231 | u8 host_client_id; |
4034b81b | 232 | u8 tx_flow_ctrl_creds; |
46978ada | 233 | u8 rx_flow_ctrl_creds; |
ab841160 | 234 | u8 timer_count; |
965ae37a TW |
235 | u8 notify_en; |
236 | u8 notify_ev; | |
ab841160 | 237 | enum mei_file_transaction_states writing_state; |
a9bed610 TW |
238 | struct list_head rd_pending; |
239 | struct list_head rd_completed; | |
a7b71bc0 | 240 | |
b37719c3 | 241 | struct mei_cl_device *cldev; |
ab841160 OW |
242 | }; |
243 | ||
99c2658f AU |
244 | /** |
245 | * struct mei_hw_ops - hw specific ops | |
827eef51 | 246 | * |
a8605ea2 | 247 | * @host_is_ready : query for host readiness |
99c2658f | 248 | * |
a8605ea2 AU |
249 | * @hw_is_ready : query if hw is ready |
250 | * @hw_reset : reset hw | |
251 | * @hw_start : start hw after reset | |
252 | * @hw_config : configure hw | |
99c2658f | 253 | * |
a8605ea2 AU |
254 | * @fw_status : get fw status registers |
255 | * @pg_state : power gating state of the device | |
3dc196ea | 256 | * @pg_in_transition : is device now in pg transition |
a8605ea2 | 257 | * @pg_is_enabled : is power gating enabled |
99c2658f | 258 | * |
a8605ea2 AU |
259 | * @intr_clear : clear pending interrupts |
260 | * @intr_enable : enable interrupts | |
261 | * @intr_disable : disable interrupts | |
4a8efd4a | 262 | * @synchronize_irq : synchronize irqs |
99c2658f | 263 | * |
a8605ea2 AU |
264 | * @hbuf_free_slots : query for write buffer empty slots |
265 | * @hbuf_is_ready : query if write buffer is empty | |
266 | * @hbuf_max_len : query for write buffer max len | |
99c2658f | 267 | * |
a8605ea2 | 268 | * @write : write a message to FW |
99c2658f | 269 | * |
a8605ea2 | 270 | * @rdbuf_full_slots : query how many slots are filled |
99c2658f | 271 | * |
a8605ea2 AU |
272 | * @read_hdr : get first 4 bytes (header) |
273 | * @read : read a buffer from the FW | |
827eef51 TW |
274 | */ |
275 | struct mei_hw_ops { | |
276 | ||
d63b3095 | 277 | bool (*host_is_ready)(struct mei_device *dev); |
827eef51 | 278 | |
d63b3095 TW |
279 | bool (*hw_is_ready)(struct mei_device *dev); |
280 | int (*hw_reset)(struct mei_device *dev, bool enable); | |
281 | int (*hw_start)(struct mei_device *dev); | |
282 | void (*hw_config)(struct mei_device *dev); | |
827eef51 | 283 | |
1bd30b6a | 284 | int (*fw_status)(struct mei_device *dev, struct mei_fw_status *fw_sts); |
964a2331 | 285 | enum mei_pg_state (*pg_state)(struct mei_device *dev); |
3dc196ea | 286 | bool (*pg_in_transition)(struct mei_device *dev); |
ee7e5afd TW |
287 | bool (*pg_is_enabled)(struct mei_device *dev); |
288 | ||
d63b3095 TW |
289 | void (*intr_clear)(struct mei_device *dev); |
290 | void (*intr_enable)(struct mei_device *dev); | |
291 | void (*intr_disable)(struct mei_device *dev); | |
4a8efd4a | 292 | void (*synchronize_irq)(struct mei_device *dev); |
827eef51 | 293 | |
d63b3095 TW |
294 | int (*hbuf_free_slots)(struct mei_device *dev); |
295 | bool (*hbuf_is_ready)(struct mei_device *dev); | |
296 | size_t (*hbuf_max_len)(const struct mei_device *dev); | |
827eef51 TW |
297 | int (*write)(struct mei_device *dev, |
298 | struct mei_msg_hdr *hdr, | |
4b9960d0 | 299 | const unsigned char *buf); |
827eef51 TW |
300 | |
301 | int (*rdbuf_full_slots)(struct mei_device *dev); | |
302 | ||
303 | u32 (*read_hdr)(const struct mei_device *dev); | |
d63b3095 | 304 | int (*read)(struct mei_device *dev, |
827eef51 TW |
305 | unsigned char *buf, unsigned long len); |
306 | }; | |
307 | ||
e5354107 | 308 | /* MEI bus API*/ |
a816a00e | 309 | void mei_cl_bus_rescan_work(struct work_struct *work); |
ae48d74d | 310 | void mei_cl_bus_dev_fixup(struct mei_cl_device *dev); |
be9b720a | 311 | ssize_t __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length, |
e0cb6b2f | 312 | unsigned int mode); |
076802d0 AU |
313 | ssize_t __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length, |
314 | unsigned int mode); | |
a1f9ae2b | 315 | bool mei_cl_bus_rx_event(struct mei_cl *cl); |
850f8940 | 316 | bool mei_cl_bus_notify_event(struct mei_cl *cl); |
b37719c3 | 317 | void mei_cl_bus_remove_devices(struct mei_device *bus); |
5d882460 AU |
318 | bool mei_cl_bus_module_get(struct mei_cl *cl); |
319 | void mei_cl_bus_module_put(struct mei_cl *cl); | |
cf3baefb SO |
320 | int mei_cl_bus_init(void); |
321 | void mei_cl_bus_exit(void); | |
322 | ||
ce23139c | 323 | /** |
964a2331 TW |
324 | * enum mei_pg_event - power gating transition events |
325 | * | |
326 | * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition | |
327 | * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete | |
328 | * @MEI_PG_EVENT_RECEIVED: the driver received pg event | |
3dc196ea AU |
329 | * @MEI_PG_EVENT_INTR_WAIT: the driver is waiting for a pg event interrupt |
330 | * @MEI_PG_EVENT_INTR_RECEIVED: the driver received pg event interrupt | |
964a2331 TW |
331 | */ |
332 | enum mei_pg_event { | |
333 | MEI_PG_EVENT_IDLE, | |
334 | MEI_PG_EVENT_WAIT, | |
335 | MEI_PG_EVENT_RECEIVED, | |
3dc196ea AU |
336 | MEI_PG_EVENT_INTR_WAIT, |
337 | MEI_PG_EVENT_INTR_RECEIVED, | |
964a2331 TW |
338 | }; |
339 | ||
340 | /** | |
341 | * enum mei_pg_state - device internal power gating state | |
342 | * | |
343 | * @MEI_PG_OFF: device is not power gated - it is active | |
344 | * @MEI_PG_ON: device is power gated - it is in lower power state | |
345 | */ | |
346 | enum mei_pg_state { | |
347 | MEI_PG_OFF = 0, | |
348 | MEI_PG_ON = 1, | |
349 | }; | |
350 | ||
1beeb4b9 AU |
351 | const char *mei_pg_state_str(enum mei_pg_state state); |
352 | ||
24aadc80 | 353 | /** |
5fb54fb4 | 354 | * struct mei_device - MEI private device struct |
ce23139c | 355 | * |
a8605ea2 AU |
356 | * @dev : device on a bus |
357 | * @cdev : character device | |
358 | * @minor : minor number allocated for device | |
f3d8e878 | 359 | * |
ce23139c AU |
360 | * @write_list : write pending list |
361 | * @write_waiting_list : write completion list | |
362 | * @ctrl_wr_list : pending control write list | |
363 | * @ctrl_rd_list : pending control read list | |
bae1cc7d | 364 | * |
ce23139c AU |
365 | * @file_list : list of opened handles |
366 | * @open_handle_count: number of opened handles | |
367 | * | |
368 | * @device_lock : big device lock | |
369 | * @timer_work : MEI timer delayed work (timeouts) | |
370 | * | |
371 | * @recvd_hw_ready : hw ready message received flag | |
372 | * | |
373 | * @wait_hw_ready : wait queue for receive HW ready message form FW | |
374 | * @wait_pg : wait queue for receive PG message from FW | |
375 | * @wait_hbm_start : wait queue for receive HBM start message from FW | |
ce23139c AU |
376 | * |
377 | * @reset_count : number of consecutive resets | |
378 | * @dev_state : device state | |
379 | * @hbm_state : state of host bus message protocol | |
380 | * @init_clients_timer : HBM init handshake timeout | |
bae1cc7d | 381 | * |
a8605ea2 | 382 | * @pg_event : power gating event |
ce23139c AU |
383 | * @pg_domain : runtime PM domain |
384 | * | |
385 | * @rd_msg_buf : control messages buffer | |
386 | * @rd_msg_hdr : read message header storage | |
387 | * | |
a8605ea2 AU |
388 | * @hbuf_depth : depth of hardware host/write buffer is slots |
389 | * @hbuf_is_ready : query if the host host/write buffer is ready | |
ce23139c AU |
390 | * |
391 | * @version : HBM protocol version in use | |
18901357 AU |
392 | * @hbm_f_pg_supported : hbm feature pgi protocol |
393 | * @hbm_f_dc_supported : hbm feature dynamic clients | |
394 | * @hbm_f_dot_supported : hbm feature disconnect on timeout | |
4d99877d | 395 | * @hbm_f_ev_supported : hbm feature event notification |
f4e06246 | 396 | * @hbm_f_fa_supported : hbm feature fixed address client |
27f476ea | 397 | * @hbm_f_ie_supported : hbm feature immediate reply to enum request |
7ee7f45a | 398 | * @hbm_f_os_supported : hbm feature support OS ver message |
ce23139c | 399 | * |
b7d88514 | 400 | * @me_clients_rwsem: rw lock over me_clients list |
ce23139c AU |
401 | * @me_clients : list of FW clients |
402 | * @me_clients_map : FW clients bit map | |
403 | * @host_clients_map : host clients id pool | |
ce23139c | 404 | * |
eeabfcf5 | 405 | * @allow_fixed_address: allow user space to connect a fixed client |
f4e06246 | 406 | * @override_fixed_address: force allow fixed address behavior |
eeabfcf5 | 407 | * |
ce23139c | 408 | * @reset_work : work item for the device reset |
a816a00e | 409 | * @bus_rescan_work : work item for the bus rescan |
ce23139c AU |
410 | * |
411 | * @device_list : mei client bus list | |
0ff0a8d8 | 412 | * @cl_bus_lock : client bus list lock |
ce23139c AU |
413 | * |
414 | * @dbgfs_dir : debugfs mei root directory | |
415 | * | |
416 | * @ops: : hw specific operations | |
417 | * @hw : hw specific data | |
24aadc80 | 418 | */ |
ab841160 | 419 | struct mei_device { |
3a7e9b6c | 420 | struct device *dev; |
f3d8e878 AU |
421 | struct cdev cdev; |
422 | int minor; | |
423 | ||
962ff7bc AU |
424 | struct list_head write_list; |
425 | struct list_head write_waiting_list; | |
426 | struct list_head ctrl_wr_list; | |
427 | struct list_head ctrl_rd_list; | |
ab841160 | 428 | |
ab841160 | 429 | struct list_head file_list; |
eb9af0ac | 430 | long open_handle_count; |
fecb0d58 | 431 | |
ce23139c AU |
432 | struct mutex device_lock; |
433 | struct delayed_work timer_work; | |
aafae7ec TW |
434 | |
435 | bool recvd_hw_ready; | |
ab841160 OW |
436 | /* |
437 | * waiting queue for receive message from FW | |
438 | */ | |
aafae7ec | 439 | wait_queue_head_t wait_hw_ready; |
4fcbc99b | 440 | wait_queue_head_t wait_pg; |
cb02efc3 | 441 | wait_queue_head_t wait_hbm_start; |
ab841160 OW |
442 | |
443 | /* | |
444 | * mei device states | |
445 | */ | |
6adb8efb | 446 | unsigned long reset_count; |
b210d750 | 447 | enum mei_dev_state dev_state; |
9b0d5efc | 448 | enum mei_hbm_state hbm_state; |
ab841160 | 449 | u16 init_clients_timer; |
ab841160 | 450 | |
964a2331 TW |
451 | /* |
452 | * Power Gating support | |
453 | */ | |
454 | enum mei_pg_event pg_event; | |
bbd6d050 | 455 | #ifdef CONFIG_PM |
e13fa90c | 456 | struct dev_pm_domain pg_domain; |
bbd6d050 | 457 | #endif /* CONFIG_PM */ |
964a2331 | 458 | |
ce23139c | 459 | unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; |
ab841160 | 460 | u32 rd_msg_hdr; |
e46f1874 | 461 | |
330dd7da TW |
462 | /* write buffer */ |
463 | u8 hbuf_depth; | |
464 | bool hbuf_is_ready; | |
465 | ||
ab841160 | 466 | struct hbm_version version; |
bae1cc7d | 467 | unsigned int hbm_f_pg_supported:1; |
70ef835c | 468 | unsigned int hbm_f_dc_supported:1; |
18901357 | 469 | unsigned int hbm_f_dot_supported:1; |
4d99877d | 470 | unsigned int hbm_f_ev_supported:1; |
f4e06246 | 471 | unsigned int hbm_f_fa_supported:1; |
27f476ea | 472 | unsigned int hbm_f_ie_supported:1; |
7ee7f45a | 473 | unsigned int hbm_f_os_supported:1; |
ab841160 | 474 | |
b7d88514 | 475 | struct rw_semaphore me_clients_rwsem; |
5ca2d388 | 476 | struct list_head me_clients; |
ab841160 OW |
477 | DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX); |
478 | DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX); | |
ab841160 | 479 | |
621a5f7a | 480 | bool allow_fixed_address; |
f4e06246 | 481 | bool override_fixed_address; |
eeabfcf5 | 482 | |
544f9460 | 483 | struct work_struct reset_work; |
a816a00e | 484 | struct work_struct bus_rescan_work; |
827eef51 | 485 | |
a7b71bc0 SO |
486 | /* List of bus devices */ |
487 | struct list_head device_list; | |
0ff0a8d8 | 488 | struct mutex cl_bus_lock; |
a7b71bc0 | 489 | |
30e53bb8 TW |
490 | #if IS_ENABLED(CONFIG_DEBUG_FS) |
491 | struct dentry *dbgfs_dir; | |
492 | #endif /* CONFIG_DEBUG_FS */ | |
493 | ||
494 | ||
827eef51 | 495 | const struct mei_hw_ops *ops; |
52c34561 | 496 | char hw[0] __aligned(sizeof(void *)); |
ab841160 OW |
497 | }; |
498 | ||
3870c320 TW |
499 | static inline unsigned long mei_secs_to_jiffies(unsigned long sec) |
500 | { | |
501 | return msecs_to_jiffies(sec * MSEC_PER_SEC); | |
502 | } | |
503 | ||
c8c8d080 TW |
504 | /** |
505 | * mei_data2slots - get slots - number of (dwords) from a message length | |
506 | * + size of the mei header | |
ce23139c | 507 | * |
a8605ea2 AU |
508 | * @length: size of the messages in bytes |
509 | * | |
510 | * Return: number of slots | |
c8c8d080 TW |
511 | */ |
512 | static inline u32 mei_data2slots(size_t length) | |
513 | { | |
514 | return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4); | |
515 | } | |
516 | ||
10ee9074 | 517 | /** |
ce23139c AU |
518 | * mei_slots2data - get data in slots - bytes from slots |
519 | * | |
a8605ea2 | 520 | * @slots: number of available slots |
ce23139c | 521 | * |
a8605ea2 | 522 | * Return: number of bytes in slots |
10ee9074 TW |
523 | */ |
524 | static inline u32 mei_slots2data(int slots) | |
525 | { | |
526 | return slots * 4; | |
527 | } | |
528 | ||
ab841160 OW |
529 | /* |
530 | * mei init function prototypes | |
531 | */ | |
3a7e9b6c TW |
532 | void mei_device_init(struct mei_device *dev, |
533 | struct device *device, | |
534 | const struct mei_hw_ops *hw_ops); | |
33ec0826 | 535 | int mei_reset(struct mei_device *dev); |
c4d589be | 536 | int mei_start(struct mei_device *dev); |
33ec0826 | 537 | int mei_restart(struct mei_device *dev); |
7cb035d9 | 538 | void mei_stop(struct mei_device *dev); |
dc844b0d | 539 | void mei_cancel_work(struct mei_device *dev); |
c95efb74 | 540 | |
c95efb74 TW |
541 | /* |
542 | * MEI interrupt functions prototype | |
ab841160 | 543 | */ |
06ecd645 | 544 | |
a61c6530 | 545 | void mei_timer(struct work_struct *work); |
1892fc2e | 546 | void mei_schedule_stall_timer(struct mei_device *dev); |
06ecd645 | 547 | int mei_irq_read_handler(struct mei_device *dev, |
962ff7bc | 548 | struct list_head *cmpl_list, s32 *slots); |
06ecd645 | 549 | |
962ff7bc AU |
550 | int mei_irq_write_handler(struct mei_device *dev, struct list_head *cmpl_list); |
551 | void mei_irq_compl_handler(struct mei_device *dev, struct list_head *cmpl_list); | |
ab841160 | 552 | |
ab841160 OW |
553 | /* |
554 | * Register Access Function | |
555 | */ | |
556 | ||
8d929d48 | 557 | |
827eef51 TW |
558 | static inline void mei_hw_config(struct mei_device *dev) |
559 | { | |
560 | dev->ops->hw_config(dev); | |
561 | } | |
ee7e5afd | 562 | |
964a2331 TW |
563 | static inline enum mei_pg_state mei_pg_state(struct mei_device *dev) |
564 | { | |
565 | return dev->ops->pg_state(dev); | |
566 | } | |
567 | ||
3dc196ea AU |
568 | static inline bool mei_pg_in_transition(struct mei_device *dev) |
569 | { | |
570 | return dev->ops->pg_in_transition(dev); | |
571 | } | |
572 | ||
ee7e5afd TW |
573 | static inline bool mei_pg_is_enabled(struct mei_device *dev) |
574 | { | |
575 | return dev->ops->pg_is_enabled(dev); | |
576 | } | |
577 | ||
c20c68d5 | 578 | static inline int mei_hw_reset(struct mei_device *dev, bool enable) |
827eef51 | 579 | { |
c20c68d5 | 580 | return dev->ops->hw_reset(dev, enable); |
827eef51 TW |
581 | } |
582 | ||
9049f793 | 583 | static inline int mei_hw_start(struct mei_device *dev) |
aafae7ec | 584 | { |
9049f793 | 585 | return dev->ops->hw_start(dev); |
aafae7ec TW |
586 | } |
587 | ||
827eef51 TW |
588 | static inline void mei_clear_interrupts(struct mei_device *dev) |
589 | { | |
590 | dev->ops->intr_clear(dev); | |
591 | } | |
592 | ||
593 | static inline void mei_enable_interrupts(struct mei_device *dev) | |
594 | { | |
595 | dev->ops->intr_enable(dev); | |
596 | } | |
ab841160 | 597 | |
827eef51 TW |
598 | static inline void mei_disable_interrupts(struct mei_device *dev) |
599 | { | |
600 | dev->ops->intr_disable(dev); | |
601 | } | |
ab841160 | 602 | |
4a8efd4a TW |
603 | static inline void mei_synchronize_irq(struct mei_device *dev) |
604 | { | |
605 | dev->ops->synchronize_irq(dev); | |
606 | } | |
607 | ||
827eef51 TW |
608 | static inline bool mei_host_is_ready(struct mei_device *dev) |
609 | { | |
610 | return dev->ops->host_is_ready(dev); | |
611 | } | |
612 | static inline bool mei_hw_is_ready(struct mei_device *dev) | |
613 | { | |
614 | return dev->ops->hw_is_ready(dev); | |
615 | } | |
e7e0c231 | 616 | |
827eef51 TW |
617 | static inline bool mei_hbuf_is_ready(struct mei_device *dev) |
618 | { | |
619 | return dev->ops->hbuf_is_ready(dev); | |
620 | } | |
ab841160 | 621 | |
827eef51 TW |
622 | static inline int mei_hbuf_empty_slots(struct mei_device *dev) |
623 | { | |
624 | return dev->ops->hbuf_free_slots(dev); | |
625 | } | |
115ba28c | 626 | |
827eef51 TW |
627 | static inline size_t mei_hbuf_max_len(const struct mei_device *dev) |
628 | { | |
629 | return dev->ops->hbuf_max_len(dev); | |
630 | } | |
3a65dd4e | 631 | |
827eef51 | 632 | static inline int mei_write_message(struct mei_device *dev, |
4b9960d0 | 633 | struct mei_msg_hdr *hdr, const void *buf) |
827eef51 TW |
634 | { |
635 | return dev->ops->write(dev, hdr, buf); | |
636 | } | |
637 | ||
638 | static inline u32 mei_read_hdr(const struct mei_device *dev) | |
639 | { | |
640 | return dev->ops->read_hdr(dev); | |
641 | } | |
642 | ||
643 | static inline void mei_read_slots(struct mei_device *dev, | |
644 | unsigned char *buf, unsigned long len) | |
645 | { | |
646 | dev->ops->read(dev, buf, len); | |
647 | } | |
648 | ||
649 | static inline int mei_count_full_read_slots(struct mei_device *dev) | |
650 | { | |
651 | return dev->ops->rdbuf_full_slots(dev); | |
652 | } | |
5bd64714 | 653 | |
1bd30b6a TW |
654 | static inline int mei_fw_status(struct mei_device *dev, |
655 | struct mei_fw_status *fw_status) | |
656 | { | |
657 | return dev->ops->fw_status(dev, fw_status); | |
658 | } | |
04dd3661 | 659 | |
6aae48ff TW |
660 | bool mei_hbuf_acquire(struct mei_device *dev); |
661 | ||
a532bbed TW |
662 | bool mei_write_is_idle(struct mei_device *dev); |
663 | ||
30e53bb8 TW |
664 | #if IS_ENABLED(CONFIG_DEBUG_FS) |
665 | int mei_dbgfs_register(struct mei_device *dev, const char *name); | |
666 | void mei_dbgfs_deregister(struct mei_device *dev); | |
667 | #else | |
668 | static inline int mei_dbgfs_register(struct mei_device *dev, const char *name) | |
669 | { | |
670 | return 0; | |
671 | } | |
672 | static inline void mei_dbgfs_deregister(struct mei_device *dev) {} | |
673 | #endif /* CONFIG_DEBUG_FS */ | |
674 | ||
f3d8e878 | 675 | int mei_register(struct mei_device *dev, struct device *parent); |
30e53bb8 | 676 | void mei_deregister(struct mei_device *dev); |
2703d4b2 | 677 | |
479327fc | 678 | #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d" |
15d4acc5 TW |
679 | #define MEI_HDR_PRM(hdr) \ |
680 | (hdr)->host_addr, (hdr)->me_addr, \ | |
479327fc | 681 | (hdr)->length, (hdr)->internal, (hdr)->msg_complete |
15d4acc5 | 682 | |
edca5ea3 AU |
683 | ssize_t mei_fw_status2str(struct mei_fw_status *fw_sts, char *buf, size_t len); |
684 | /** | |
685 | * mei_fw_status_str - fetch and convert fw status registers to printable string | |
686 | * | |
687 | * @dev: the device structure | |
688 | * @buf: string buffer at minimal size MEI_FW_STATUS_STR_SZ | |
689 | * @len: buffer len must be >= MEI_FW_STATUS_STR_SZ | |
690 | * | |
691 | * Return: number of bytes written or < 0 on failure | |
692 | */ | |
693 | static inline ssize_t mei_fw_status_str(struct mei_device *dev, | |
694 | char *buf, size_t len) | |
695 | { | |
696 | struct mei_fw_status fw_status; | |
697 | int ret; | |
698 | ||
699 | buf[0] = '\0'; | |
700 | ||
701 | ret = mei_fw_status(dev, &fw_status); | |
702 | if (ret) | |
703 | return ret; | |
704 | ||
705 | ret = mei_fw_status2str(&fw_status, buf, MEI_FW_STATUS_STR_SZ); | |
706 | ||
707 | return ret; | |
708 | } | |
709 | ||
710 | ||
ab841160 | 711 | #endif |