xsk: Add overflow check for u64 division, stored into u32
[linux/fpc-iii.git] / drivers / misc / mei / hbm.c
blobd39cc2909474228b0e47be168e2e8e33663f8c4f
1 /*
3 * Intel Management Engine Interface (Intel MEI) Linux driver
4 * Copyright (c) 2003-2012, Intel Corporation.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
10 * This program is distributed in the hope it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
17 #include <linux/export.h>
18 #include <linux/sched.h>
19 #include <linux/wait.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/slab.h>
23 #include <linux/mei.h>
25 #include "mei_dev.h"
26 #include "hbm.h"
27 #include "client.h"
29 static const char *mei_hbm_status_str(enum mei_hbm_status status)
31 #define MEI_HBM_STATUS(status) case MEI_HBMS_##status: return #status
32 switch (status) {
33 MEI_HBM_STATUS(SUCCESS);
34 MEI_HBM_STATUS(CLIENT_NOT_FOUND);
35 MEI_HBM_STATUS(ALREADY_EXISTS);
36 MEI_HBM_STATUS(REJECTED);
37 MEI_HBM_STATUS(INVALID_PARAMETER);
38 MEI_HBM_STATUS(NOT_ALLOWED);
39 MEI_HBM_STATUS(ALREADY_STARTED);
40 MEI_HBM_STATUS(NOT_STARTED);
41 default: return "unknown";
43 #undef MEI_HBM_STATUS
46 static const char *mei_cl_conn_status_str(enum mei_cl_connect_status status)
48 #define MEI_CL_CS(status) case MEI_CL_CONN_##status: return #status
49 switch (status) {
50 MEI_CL_CS(SUCCESS);
51 MEI_CL_CS(NOT_FOUND);
52 MEI_CL_CS(ALREADY_STARTED);
53 MEI_CL_CS(OUT_OF_RESOURCES);
54 MEI_CL_CS(MESSAGE_SMALL);
55 MEI_CL_CS(NOT_ALLOWED);
56 default: return "unknown";
58 #undef MEI_CL_CCS
61 const char *mei_hbm_state_str(enum mei_hbm_state state)
63 #define MEI_HBM_STATE(state) case MEI_HBM_##state: return #state
64 switch (state) {
65 MEI_HBM_STATE(IDLE);
66 MEI_HBM_STATE(STARTING);
67 MEI_HBM_STATE(STARTED);
68 MEI_HBM_STATE(ENUM_CLIENTS);
69 MEI_HBM_STATE(CLIENT_PROPERTIES);
70 MEI_HBM_STATE(STOPPED);
71 default:
72 return "unknown";
74 #undef MEI_HBM_STATE
77 /**
78 * mei_cl_conn_status_to_errno - convert client connect response
79 * status to error code
81 * @status: client connect response status
83 * Return: corresponding error code
85 static int mei_cl_conn_status_to_errno(enum mei_cl_connect_status status)
87 switch (status) {
88 case MEI_CL_CONN_SUCCESS: return 0;
89 case MEI_CL_CONN_NOT_FOUND: return -ENOTTY;
90 case MEI_CL_CONN_ALREADY_STARTED: return -EBUSY;
91 case MEI_CL_CONN_OUT_OF_RESOURCES: return -EBUSY;
92 case MEI_CL_CONN_MESSAGE_SMALL: return -EINVAL;
93 case MEI_CL_CONN_NOT_ALLOWED: return -EBUSY;
94 default: return -EINVAL;
98 /**
99 * mei_hbm_write_message - wrapper for sending hbm messages.
101 * @dev: mei device
102 * @hdr: mei header
103 * @data: payload
105 static inline int mei_hbm_write_message(struct mei_device *dev,
106 struct mei_msg_hdr *hdr,
107 const void *data)
109 return mei_write_message(dev, hdr, sizeof(*hdr), data, hdr->length);
113 * mei_hbm_idle - set hbm to idle state
115 * @dev: the device structure
117 void mei_hbm_idle(struct mei_device *dev)
119 dev->init_clients_timer = 0;
120 dev->hbm_state = MEI_HBM_IDLE;
124 * mei_hbm_reset - reset hbm counters and book keeping data structurs
126 * @dev: the device structure
128 void mei_hbm_reset(struct mei_device *dev)
130 mei_me_cl_rm_all(dev);
132 mei_hbm_idle(dev);
136 * mei_hbm_hdr - construct hbm header
138 * @hdr: hbm header
139 * @length: payload length
142 static inline void mei_hbm_hdr(struct mei_msg_hdr *hdr, size_t length)
144 hdr->host_addr = 0;
145 hdr->me_addr = 0;
146 hdr->length = length;
147 hdr->msg_complete = 1;
148 hdr->dma_ring = 0;
149 hdr->reserved = 0;
150 hdr->internal = 0;
154 * mei_hbm_cl_hdr - construct client hbm header
156 * @cl: client
157 * @hbm_cmd: host bus message command
158 * @buf: buffer for cl header
159 * @len: buffer length
161 static inline
162 void mei_hbm_cl_hdr(struct mei_cl *cl, u8 hbm_cmd, void *buf, size_t len)
164 struct mei_hbm_cl_cmd *cmd = buf;
166 memset(cmd, 0, len);
168 cmd->hbm_cmd = hbm_cmd;
169 cmd->host_addr = mei_cl_host_addr(cl);
170 cmd->me_addr = mei_cl_me_id(cl);
174 * mei_hbm_cl_write - write simple hbm client message
176 * @dev: the device structure
177 * @cl: client
178 * @hbm_cmd: host bus message command
179 * @buf: message buffer
180 * @len: buffer length
182 * Return: 0 on success, <0 on failure.
184 static inline int mei_hbm_cl_write(struct mei_device *dev, struct mei_cl *cl,
185 u8 hbm_cmd, void *buf, size_t len)
187 struct mei_msg_hdr mei_hdr;
189 mei_hbm_hdr(&mei_hdr, len);
190 mei_hbm_cl_hdr(cl, hbm_cmd, buf, len);
192 return mei_hbm_write_message(dev, &mei_hdr, buf);
196 * mei_hbm_cl_addr_equal - check if the client's and
197 * the message address match
199 * @cl: client
200 * @cmd: hbm client message
202 * Return: true if addresses are the same
204 static inline
205 bool mei_hbm_cl_addr_equal(struct mei_cl *cl, struct mei_hbm_cl_cmd *cmd)
207 return mei_cl_host_addr(cl) == cmd->host_addr &&
208 mei_cl_me_id(cl) == cmd->me_addr;
212 * mei_hbm_cl_find_by_cmd - find recipient client
214 * @dev: the device structure
215 * @buf: a buffer with hbm cl command
217 * Return: the recipient client or NULL if not found
219 static inline
220 struct mei_cl *mei_hbm_cl_find_by_cmd(struct mei_device *dev, void *buf)
222 struct mei_hbm_cl_cmd *cmd = (struct mei_hbm_cl_cmd *)buf;
223 struct mei_cl *cl;
225 list_for_each_entry(cl, &dev->file_list, link)
226 if (mei_hbm_cl_addr_equal(cl, cmd))
227 return cl;
228 return NULL;
233 * mei_hbm_start_wait - wait for start response message.
235 * @dev: the device structure
237 * Return: 0 on success and < 0 on failure
239 int mei_hbm_start_wait(struct mei_device *dev)
241 int ret;
243 if (dev->hbm_state > MEI_HBM_STARTING)
244 return 0;
246 mutex_unlock(&dev->device_lock);
247 ret = wait_event_timeout(dev->wait_hbm_start,
248 dev->hbm_state != MEI_HBM_STARTING,
249 mei_secs_to_jiffies(MEI_HBM_TIMEOUT));
250 mutex_lock(&dev->device_lock);
252 if (ret == 0 && (dev->hbm_state <= MEI_HBM_STARTING)) {
253 dev->hbm_state = MEI_HBM_IDLE;
254 dev_err(dev->dev, "waiting for mei start failed\n");
255 return -ETIME;
257 return 0;
261 * mei_hbm_start_req - sends start request message.
263 * @dev: the device structure
265 * Return: 0 on success and < 0 on failure
267 int mei_hbm_start_req(struct mei_device *dev)
269 struct mei_msg_hdr mei_hdr;
270 struct hbm_host_version_request start_req;
271 const size_t len = sizeof(struct hbm_host_version_request);
272 int ret;
274 mei_hbm_reset(dev);
276 mei_hbm_hdr(&mei_hdr, len);
278 /* host start message */
279 memset(&start_req, 0, len);
280 start_req.hbm_cmd = HOST_START_REQ_CMD;
281 start_req.host_version.major_version = HBM_MAJOR_VERSION;
282 start_req.host_version.minor_version = HBM_MINOR_VERSION;
284 dev->hbm_state = MEI_HBM_IDLE;
285 ret = mei_hbm_write_message(dev, &mei_hdr, &start_req);
286 if (ret) {
287 dev_err(dev->dev, "version message write failed: ret = %d\n",
288 ret);
289 return ret;
292 dev->hbm_state = MEI_HBM_STARTING;
293 dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
294 mei_schedule_stall_timer(dev);
295 return 0;
299 * mei_hbm_enum_clients_req - sends enumeration client request message.
301 * @dev: the device structure
303 * Return: 0 on success and < 0 on failure
305 static int mei_hbm_enum_clients_req(struct mei_device *dev)
307 struct mei_msg_hdr mei_hdr;
308 struct hbm_host_enum_request enum_req;
309 const size_t len = sizeof(struct hbm_host_enum_request);
310 int ret;
312 /* enumerate clients */
313 mei_hbm_hdr(&mei_hdr, len);
315 memset(&enum_req, 0, len);
316 enum_req.hbm_cmd = HOST_ENUM_REQ_CMD;
317 enum_req.flags |= dev->hbm_f_dc_supported ?
318 MEI_HBM_ENUM_F_ALLOW_ADD : 0;
319 enum_req.flags |= dev->hbm_f_ie_supported ?
320 MEI_HBM_ENUM_F_IMMEDIATE_ENUM : 0;
322 ret = mei_hbm_write_message(dev, &mei_hdr, &enum_req);
323 if (ret) {
324 dev_err(dev->dev, "enumeration request write failed: ret = %d.\n",
325 ret);
326 return ret;
328 dev->hbm_state = MEI_HBM_ENUM_CLIENTS;
329 dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
330 mei_schedule_stall_timer(dev);
331 return 0;
335 * mei_hbm_me_cl_add - add new me client to the list
337 * @dev: the device structure
338 * @res: hbm property response
340 * Return: 0 on success and -ENOMEM on allocation failure
343 static int mei_hbm_me_cl_add(struct mei_device *dev,
344 struct hbm_props_response *res)
346 struct mei_me_client *me_cl;
347 const uuid_le *uuid = &res->client_properties.protocol_name;
349 mei_me_cl_rm_by_uuid(dev, uuid);
351 me_cl = kzalloc(sizeof(struct mei_me_client), GFP_KERNEL);
352 if (!me_cl)
353 return -ENOMEM;
355 mei_me_cl_init(me_cl);
357 me_cl->props = res->client_properties;
358 me_cl->client_id = res->me_addr;
359 me_cl->tx_flow_ctrl_creds = 0;
361 mei_me_cl_add(dev, me_cl);
363 return 0;
367 * mei_hbm_add_cl_resp - send response to fw on client add request
369 * @dev: the device structure
370 * @addr: me address
371 * @status: response status
373 * Return: 0 on success and < 0 on failure
375 static int mei_hbm_add_cl_resp(struct mei_device *dev, u8 addr, u8 status)
377 struct mei_msg_hdr mei_hdr;
378 struct hbm_add_client_response resp;
379 const size_t len = sizeof(struct hbm_add_client_response);
380 int ret;
382 dev_dbg(dev->dev, "adding client response\n");
384 mei_hbm_hdr(&mei_hdr, len);
386 memset(&resp, 0, sizeof(struct hbm_add_client_response));
387 resp.hbm_cmd = MEI_HBM_ADD_CLIENT_RES_CMD;
388 resp.me_addr = addr;
389 resp.status = status;
391 ret = mei_hbm_write_message(dev, &mei_hdr, &resp);
392 if (ret)
393 dev_err(dev->dev, "add client response write failed: ret = %d\n",
394 ret);
395 return ret;
399 * mei_hbm_fw_add_cl_req - request from the fw to add a client
401 * @dev: the device structure
402 * @req: add client request
404 * Return: 0 on success and < 0 on failure
406 static int mei_hbm_fw_add_cl_req(struct mei_device *dev,
407 struct hbm_add_client_request *req)
409 int ret;
410 u8 status = MEI_HBMS_SUCCESS;
412 BUILD_BUG_ON(sizeof(struct hbm_add_client_request) !=
413 sizeof(struct hbm_props_response));
415 ret = mei_hbm_me_cl_add(dev, (struct hbm_props_response *)req);
416 if (ret)
417 status = !MEI_HBMS_SUCCESS;
419 if (dev->dev_state == MEI_DEV_ENABLED)
420 schedule_work(&dev->bus_rescan_work);
422 return mei_hbm_add_cl_resp(dev, req->me_addr, status);
426 * mei_hbm_cl_notify_req - send notification request
428 * @dev: the device structure
429 * @cl: a client to disconnect from
430 * @start: true for start false for stop
432 * Return: 0 on success and -EIO on write failure
434 int mei_hbm_cl_notify_req(struct mei_device *dev,
435 struct mei_cl *cl, u8 start)
438 struct mei_msg_hdr mei_hdr;
439 struct hbm_notification_request req;
440 const size_t len = sizeof(struct hbm_notification_request);
441 int ret;
443 mei_hbm_hdr(&mei_hdr, len);
444 mei_hbm_cl_hdr(cl, MEI_HBM_NOTIFY_REQ_CMD, &req, len);
446 req.start = start;
448 ret = mei_hbm_write_message(dev, &mei_hdr, &req);
449 if (ret)
450 dev_err(dev->dev, "notify request failed: ret = %d\n", ret);
452 return ret;
456 * notify_res_to_fop - convert notification response to the proper
457 * notification FOP
459 * @cmd: client notification start response command
461 * Return: MEI_FOP_NOTIFY_START or MEI_FOP_NOTIFY_STOP;
463 static inline enum mei_cb_file_ops notify_res_to_fop(struct mei_hbm_cl_cmd *cmd)
465 struct hbm_notification_response *rs =
466 (struct hbm_notification_response *)cmd;
468 return mei_cl_notify_req2fop(rs->start);
472 * mei_hbm_cl_notify_start_res - update the client state according
473 * notify start response
475 * @dev: the device structure
476 * @cl: mei host client
477 * @cmd: client notification start response command
479 static void mei_hbm_cl_notify_start_res(struct mei_device *dev,
480 struct mei_cl *cl,
481 struct mei_hbm_cl_cmd *cmd)
483 struct hbm_notification_response *rs =
484 (struct hbm_notification_response *)cmd;
486 cl_dbg(dev, cl, "hbm: notify start response status=%d\n", rs->status);
488 if (rs->status == MEI_HBMS_SUCCESS ||
489 rs->status == MEI_HBMS_ALREADY_STARTED) {
490 cl->notify_en = true;
491 cl->status = 0;
492 } else {
493 cl->status = -EINVAL;
498 * mei_hbm_cl_notify_stop_res - update the client state according
499 * notify stop response
501 * @dev: the device structure
502 * @cl: mei host client
503 * @cmd: client notification stop response command
505 static void mei_hbm_cl_notify_stop_res(struct mei_device *dev,
506 struct mei_cl *cl,
507 struct mei_hbm_cl_cmd *cmd)
509 struct hbm_notification_response *rs =
510 (struct hbm_notification_response *)cmd;
512 cl_dbg(dev, cl, "hbm: notify stop response status=%d\n", rs->status);
514 if (rs->status == MEI_HBMS_SUCCESS ||
515 rs->status == MEI_HBMS_NOT_STARTED) {
516 cl->notify_en = false;
517 cl->status = 0;
518 } else {
519 /* TODO: spec is not clear yet about other possible issues */
520 cl->status = -EINVAL;
525 * mei_hbm_cl_notify - signal notification event
527 * @dev: the device structure
528 * @cmd: notification client message
530 static void mei_hbm_cl_notify(struct mei_device *dev,
531 struct mei_hbm_cl_cmd *cmd)
533 struct mei_cl *cl;
535 cl = mei_hbm_cl_find_by_cmd(dev, cmd);
536 if (cl)
537 mei_cl_notify(cl);
541 * mei_hbm_prop_req - request property for a single client
543 * @dev: the device structure
544 * @start_idx: client index to start search
546 * Return: 0 on success and < 0 on failure
548 static int mei_hbm_prop_req(struct mei_device *dev, unsigned long start_idx)
550 struct mei_msg_hdr mei_hdr;
551 struct hbm_props_request prop_req;
552 const size_t len = sizeof(struct hbm_props_request);
553 unsigned long addr;
554 int ret;
556 addr = find_next_bit(dev->me_clients_map, MEI_CLIENTS_MAX, start_idx);
558 /* We got all client properties */
559 if (addr == MEI_CLIENTS_MAX) {
560 dev->hbm_state = MEI_HBM_STARTED;
561 mei_host_client_init(dev);
563 return 0;
566 mei_hbm_hdr(&mei_hdr, len);
568 memset(&prop_req, 0, sizeof(struct hbm_props_request));
570 prop_req.hbm_cmd = HOST_CLIENT_PROPERTIES_REQ_CMD;
571 prop_req.me_addr = addr;
573 ret = mei_hbm_write_message(dev, &mei_hdr, &prop_req);
574 if (ret) {
575 dev_err(dev->dev, "properties request write failed: ret = %d\n",
576 ret);
577 return ret;
580 dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
581 mei_schedule_stall_timer(dev);
583 return 0;
587 * mei_hbm_pg - sends pg command
589 * @dev: the device structure
590 * @pg_cmd: the pg command code
592 * Return: -EIO on write failure
593 * -EOPNOTSUPP if the operation is not supported by the protocol
595 int mei_hbm_pg(struct mei_device *dev, u8 pg_cmd)
597 struct mei_msg_hdr mei_hdr;
598 struct hbm_power_gate req;
599 const size_t len = sizeof(struct hbm_power_gate);
600 int ret;
602 if (!dev->hbm_f_pg_supported)
603 return -EOPNOTSUPP;
605 mei_hbm_hdr(&mei_hdr, len);
607 memset(&req, 0, len);
608 req.hbm_cmd = pg_cmd;
610 ret = mei_hbm_write_message(dev, &mei_hdr, &req);
611 if (ret)
612 dev_err(dev->dev, "power gate command write failed.\n");
613 return ret;
615 EXPORT_SYMBOL_GPL(mei_hbm_pg);
618 * mei_hbm_stop_req - send stop request message
620 * @dev: mei device
622 * Return: -EIO on write failure
624 static int mei_hbm_stop_req(struct mei_device *dev)
626 struct mei_msg_hdr mei_hdr;
627 struct hbm_host_stop_request req;
628 const size_t len = sizeof(struct hbm_host_stop_request);
630 mei_hbm_hdr(&mei_hdr, len);
632 memset(&req, 0, len);
633 req.hbm_cmd = HOST_STOP_REQ_CMD;
634 req.reason = DRIVER_STOP_REQUEST;
636 return mei_hbm_write_message(dev, &mei_hdr, &req);
640 * mei_hbm_cl_flow_control_req - sends flow control request.
642 * @dev: the device structure
643 * @cl: client info
645 * Return: -EIO on write failure
647 int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl)
649 struct hbm_flow_control req;
651 cl_dbg(dev, cl, "sending flow control\n");
652 return mei_hbm_cl_write(dev, cl, MEI_FLOW_CONTROL_CMD,
653 &req, sizeof(req));
657 * mei_hbm_add_single_tx_flow_ctrl_creds - adds single buffer credentials.
659 * @dev: the device structure
660 * @fctrl: flow control response bus message
662 * Return: 0 on success, < 0 otherwise
664 static int mei_hbm_add_single_tx_flow_ctrl_creds(struct mei_device *dev,
665 struct hbm_flow_control *fctrl)
667 struct mei_me_client *me_cl;
668 int rets;
670 me_cl = mei_me_cl_by_id(dev, fctrl->me_addr);
671 if (!me_cl) {
672 dev_err(dev->dev, "no such me client %d\n", fctrl->me_addr);
673 return -ENOENT;
676 if (WARN_ON(me_cl->props.single_recv_buf == 0)) {
677 rets = -EINVAL;
678 goto out;
681 me_cl->tx_flow_ctrl_creds++;
682 dev_dbg(dev->dev, "recv flow ctrl msg ME %d (single) creds = %d.\n",
683 fctrl->me_addr, me_cl->tx_flow_ctrl_creds);
685 rets = 0;
686 out:
687 mei_me_cl_put(me_cl);
688 return rets;
692 * mei_hbm_cl_flow_control_res - flow control response from me
694 * @dev: the device structure
695 * @fctrl: flow control response bus message
697 static void mei_hbm_cl_tx_flow_ctrl_creds_res(struct mei_device *dev,
698 struct hbm_flow_control *fctrl)
700 struct mei_cl *cl;
702 if (!fctrl->host_addr) {
703 /* single receive buffer */
704 mei_hbm_add_single_tx_flow_ctrl_creds(dev, fctrl);
705 return;
708 cl = mei_hbm_cl_find_by_cmd(dev, fctrl);
709 if (cl) {
710 cl->tx_flow_ctrl_creds++;
711 cl_dbg(dev, cl, "flow control creds = %d.\n",
712 cl->tx_flow_ctrl_creds);
718 * mei_hbm_cl_disconnect_req - sends disconnect message to fw.
720 * @dev: the device structure
721 * @cl: a client to disconnect from
723 * Return: -EIO on write failure
725 int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl)
727 struct hbm_client_connect_request req;
729 return mei_hbm_cl_write(dev, cl, CLIENT_DISCONNECT_REQ_CMD,
730 &req, sizeof(req));
734 * mei_hbm_cl_disconnect_rsp - sends disconnect respose to the FW
736 * @dev: the device structure
737 * @cl: a client to disconnect from
739 * Return: -EIO on write failure
741 int mei_hbm_cl_disconnect_rsp(struct mei_device *dev, struct mei_cl *cl)
743 struct hbm_client_connect_response resp;
745 return mei_hbm_cl_write(dev, cl, CLIENT_DISCONNECT_RES_CMD,
746 &resp, sizeof(resp));
750 * mei_hbm_cl_disconnect_res - update the client state according
751 * disconnect response
753 * @dev: the device structure
754 * @cl: mei host client
755 * @cmd: disconnect client response host bus message
757 static void mei_hbm_cl_disconnect_res(struct mei_device *dev, struct mei_cl *cl,
758 struct mei_hbm_cl_cmd *cmd)
760 struct hbm_client_connect_response *rs =
761 (struct hbm_client_connect_response *)cmd;
763 cl_dbg(dev, cl, "hbm: disconnect response status=%d\n", rs->status);
765 if (rs->status == MEI_CL_DISCONN_SUCCESS)
766 cl->state = MEI_FILE_DISCONNECT_REPLY;
767 cl->status = 0;
771 * mei_hbm_cl_connect_req - send connection request to specific me client
773 * @dev: the device structure
774 * @cl: a client to connect to
776 * Return: -EIO on write failure
778 int mei_hbm_cl_connect_req(struct mei_device *dev, struct mei_cl *cl)
780 struct hbm_client_connect_request req;
782 return mei_hbm_cl_write(dev, cl, CLIENT_CONNECT_REQ_CMD,
783 &req, sizeof(req));
787 * mei_hbm_cl_connect_res - update the client state according
788 * connection response
790 * @dev: the device structure
791 * @cl: mei host client
792 * @cmd: connect client response host bus message
794 static void mei_hbm_cl_connect_res(struct mei_device *dev, struct mei_cl *cl,
795 struct mei_hbm_cl_cmd *cmd)
797 struct hbm_client_connect_response *rs =
798 (struct hbm_client_connect_response *)cmd;
800 cl_dbg(dev, cl, "hbm: connect response status=%s\n",
801 mei_cl_conn_status_str(rs->status));
803 if (rs->status == MEI_CL_CONN_SUCCESS)
804 cl->state = MEI_FILE_CONNECTED;
805 else {
806 cl->state = MEI_FILE_DISCONNECT_REPLY;
807 if (rs->status == MEI_CL_CONN_NOT_FOUND) {
808 mei_me_cl_del(dev, cl->me_cl);
809 if (dev->dev_state == MEI_DEV_ENABLED)
810 schedule_work(&dev->bus_rescan_work);
813 cl->status = mei_cl_conn_status_to_errno(rs->status);
817 * mei_hbm_cl_res - process hbm response received on behalf
818 * an client
820 * @dev: the device structure
821 * @rs: hbm client message
822 * @fop_type: file operation type
824 static void mei_hbm_cl_res(struct mei_device *dev,
825 struct mei_hbm_cl_cmd *rs,
826 enum mei_cb_file_ops fop_type)
828 struct mei_cl *cl;
829 struct mei_cl_cb *cb, *next;
831 cl = NULL;
832 list_for_each_entry_safe(cb, next, &dev->ctrl_rd_list, list) {
834 cl = cb->cl;
836 if (cb->fop_type != fop_type)
837 continue;
839 if (mei_hbm_cl_addr_equal(cl, rs)) {
840 list_del_init(&cb->list);
841 break;
845 if (!cl)
846 return;
848 switch (fop_type) {
849 case MEI_FOP_CONNECT:
850 mei_hbm_cl_connect_res(dev, cl, rs);
851 break;
852 case MEI_FOP_DISCONNECT:
853 mei_hbm_cl_disconnect_res(dev, cl, rs);
854 break;
855 case MEI_FOP_NOTIFY_START:
856 mei_hbm_cl_notify_start_res(dev, cl, rs);
857 break;
858 case MEI_FOP_NOTIFY_STOP:
859 mei_hbm_cl_notify_stop_res(dev, cl, rs);
860 break;
861 default:
862 return;
865 cl->timer_count = 0;
866 wake_up(&cl->wait);
871 * mei_hbm_fw_disconnect_req - disconnect request initiated by ME firmware
872 * host sends disconnect response
874 * @dev: the device structure.
875 * @disconnect_req: disconnect request bus message from the me
877 * Return: -ENOMEM on allocation failure
879 static int mei_hbm_fw_disconnect_req(struct mei_device *dev,
880 struct hbm_client_connect_request *disconnect_req)
882 struct mei_cl *cl;
883 struct mei_cl_cb *cb;
885 cl = mei_hbm_cl_find_by_cmd(dev, disconnect_req);
886 if (cl) {
887 cl_warn(dev, cl, "fw disconnect request received\n");
888 cl->state = MEI_FILE_DISCONNECTING;
889 cl->timer_count = 0;
891 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_DISCONNECT_RSP,
892 NULL);
893 if (!cb)
894 return -ENOMEM;
896 return 0;
900 * mei_hbm_pg_enter_res - PG enter response received
902 * @dev: the device structure.
904 * Return: 0 on success, -EPROTO on state mismatch
906 static int mei_hbm_pg_enter_res(struct mei_device *dev)
908 if (mei_pg_state(dev) != MEI_PG_OFF ||
909 dev->pg_event != MEI_PG_EVENT_WAIT) {
910 dev_err(dev->dev, "hbm: pg entry response: state mismatch [%s, %d]\n",
911 mei_pg_state_str(mei_pg_state(dev)), dev->pg_event);
912 return -EPROTO;
915 dev->pg_event = MEI_PG_EVENT_RECEIVED;
916 wake_up(&dev->wait_pg);
918 return 0;
922 * mei_hbm_pg_resume - process with PG resume
924 * @dev: the device structure.
926 void mei_hbm_pg_resume(struct mei_device *dev)
928 pm_request_resume(dev->dev);
930 EXPORT_SYMBOL_GPL(mei_hbm_pg_resume);
933 * mei_hbm_pg_exit_res - PG exit response received
935 * @dev: the device structure.
937 * Return: 0 on success, -EPROTO on state mismatch
939 static int mei_hbm_pg_exit_res(struct mei_device *dev)
941 if (mei_pg_state(dev) != MEI_PG_ON ||
942 (dev->pg_event != MEI_PG_EVENT_WAIT &&
943 dev->pg_event != MEI_PG_EVENT_IDLE)) {
944 dev_err(dev->dev, "hbm: pg exit response: state mismatch [%s, %d]\n",
945 mei_pg_state_str(mei_pg_state(dev)), dev->pg_event);
946 return -EPROTO;
949 switch (dev->pg_event) {
950 case MEI_PG_EVENT_WAIT:
951 dev->pg_event = MEI_PG_EVENT_RECEIVED;
952 wake_up(&dev->wait_pg);
953 break;
954 case MEI_PG_EVENT_IDLE:
956 * If the driver is not waiting on this then
957 * this is HW initiated exit from PG.
958 * Start runtime pm resume sequence to exit from PG.
960 dev->pg_event = MEI_PG_EVENT_RECEIVED;
961 mei_hbm_pg_resume(dev);
962 break;
963 default:
964 WARN(1, "hbm: pg exit response: unexpected pg event = %d\n",
965 dev->pg_event);
966 return -EPROTO;
969 return 0;
973 * mei_hbm_config_features - check what hbm features and commands
974 * are supported by the fw
976 * @dev: the device structure
978 static void mei_hbm_config_features(struct mei_device *dev)
980 /* Power Gating Isolation Support */
981 dev->hbm_f_pg_supported = 0;
982 if (dev->version.major_version > HBM_MAJOR_VERSION_PGI)
983 dev->hbm_f_pg_supported = 1;
985 if (dev->version.major_version == HBM_MAJOR_VERSION_PGI &&
986 dev->version.minor_version >= HBM_MINOR_VERSION_PGI)
987 dev->hbm_f_pg_supported = 1;
989 dev->hbm_f_dc_supported = 0;
990 if (dev->version.major_version >= HBM_MAJOR_VERSION_DC)
991 dev->hbm_f_dc_supported = 1;
993 dev->hbm_f_ie_supported = 0;
994 if (dev->version.major_version >= HBM_MAJOR_VERSION_IE)
995 dev->hbm_f_ie_supported = 1;
997 /* disconnect on connect timeout instead of link reset */
998 dev->hbm_f_dot_supported = 0;
999 if (dev->version.major_version >= HBM_MAJOR_VERSION_DOT)
1000 dev->hbm_f_dot_supported = 1;
1002 /* Notification Event Support */
1003 dev->hbm_f_ev_supported = 0;
1004 if (dev->version.major_version >= HBM_MAJOR_VERSION_EV)
1005 dev->hbm_f_ev_supported = 1;
1007 /* Fixed Address Client Support */
1008 dev->hbm_f_fa_supported = 0;
1009 if (dev->version.major_version >= HBM_MAJOR_VERSION_FA)
1010 dev->hbm_f_fa_supported = 1;
1012 /* OS ver message Support */
1013 dev->hbm_f_os_supported = 0;
1014 if (dev->version.major_version >= HBM_MAJOR_VERSION_OS)
1015 dev->hbm_f_os_supported = 1;
1017 /* DMA Ring Support */
1018 dev->hbm_f_dr_supported = 0;
1019 if (dev->version.major_version > HBM_MAJOR_VERSION_DR ||
1020 (dev->version.major_version == HBM_MAJOR_VERSION_DR &&
1021 dev->version.minor_version >= HBM_MINOR_VERSION_DR))
1022 dev->hbm_f_dr_supported = 1;
1026 * mei_hbm_version_is_supported - checks whether the driver can
1027 * support the hbm version of the device
1029 * @dev: the device structure
1030 * Return: true if driver can support hbm version of the device
1032 bool mei_hbm_version_is_supported(struct mei_device *dev)
1034 return (dev->version.major_version < HBM_MAJOR_VERSION) ||
1035 (dev->version.major_version == HBM_MAJOR_VERSION &&
1036 dev->version.minor_version <= HBM_MINOR_VERSION);
1040 * mei_hbm_dispatch - bottom half read routine after ISR to
1041 * handle the read bus message cmd processing.
1043 * @dev: the device structure
1044 * @hdr: header of bus message
1046 * Return: 0 on success and < 0 on failure
1048 int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr)
1050 struct mei_bus_message *mei_msg;
1051 struct hbm_host_version_response *version_res;
1052 struct hbm_props_response *props_res;
1053 struct hbm_host_enum_response *enum_res;
1054 struct hbm_add_client_request *add_cl_req;
1055 int ret;
1057 struct mei_hbm_cl_cmd *cl_cmd;
1058 struct hbm_client_connect_request *disconnect_req;
1059 struct hbm_flow_control *fctrl;
1061 /* read the message to our buffer */
1062 BUG_ON(hdr->length >= sizeof(dev->rd_msg_buf));
1063 mei_read_slots(dev, dev->rd_msg_buf, hdr->length);
1064 mei_msg = (struct mei_bus_message *)dev->rd_msg_buf;
1065 cl_cmd = (struct mei_hbm_cl_cmd *)mei_msg;
1067 /* ignore spurious message and prevent reset nesting
1068 * hbm is put to idle during system reset
1070 if (dev->hbm_state == MEI_HBM_IDLE) {
1071 dev_dbg(dev->dev, "hbm: state is idle ignore spurious messages\n");
1072 return 0;
1075 switch (mei_msg->hbm_cmd) {
1076 case HOST_START_RES_CMD:
1077 dev_dbg(dev->dev, "hbm: start: response message received.\n");
1079 dev->init_clients_timer = 0;
1081 version_res = (struct hbm_host_version_response *)mei_msg;
1083 dev_dbg(dev->dev, "HBM VERSION: DRIVER=%02d:%02d DEVICE=%02d:%02d\n",
1084 HBM_MAJOR_VERSION, HBM_MINOR_VERSION,
1085 version_res->me_max_version.major_version,
1086 version_res->me_max_version.minor_version);
1088 if (version_res->host_version_supported) {
1089 dev->version.major_version = HBM_MAJOR_VERSION;
1090 dev->version.minor_version = HBM_MINOR_VERSION;
1091 } else {
1092 dev->version.major_version =
1093 version_res->me_max_version.major_version;
1094 dev->version.minor_version =
1095 version_res->me_max_version.minor_version;
1098 if (!mei_hbm_version_is_supported(dev)) {
1099 dev_warn(dev->dev, "hbm: start: version mismatch - stopping the driver.\n");
1101 dev->hbm_state = MEI_HBM_STOPPED;
1102 if (mei_hbm_stop_req(dev)) {
1103 dev_err(dev->dev, "hbm: start: failed to send stop request\n");
1104 return -EIO;
1106 break;
1109 mei_hbm_config_features(dev);
1111 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
1112 dev->hbm_state != MEI_HBM_STARTING) {
1113 dev_err(dev->dev, "hbm: start: state mismatch, [%d, %d]\n",
1114 dev->dev_state, dev->hbm_state);
1115 return -EPROTO;
1118 if (mei_hbm_enum_clients_req(dev)) {
1119 dev_err(dev->dev, "hbm: start: failed to send enumeration request\n");
1120 return -EIO;
1123 wake_up(&dev->wait_hbm_start);
1124 break;
1126 case CLIENT_CONNECT_RES_CMD:
1127 dev_dbg(dev->dev, "hbm: client connect response: message received.\n");
1128 mei_hbm_cl_res(dev, cl_cmd, MEI_FOP_CONNECT);
1129 break;
1131 case CLIENT_DISCONNECT_RES_CMD:
1132 dev_dbg(dev->dev, "hbm: client disconnect response: message received.\n");
1133 mei_hbm_cl_res(dev, cl_cmd, MEI_FOP_DISCONNECT);
1134 break;
1136 case MEI_FLOW_CONTROL_CMD:
1137 dev_dbg(dev->dev, "hbm: client flow control response: message received.\n");
1139 fctrl = (struct hbm_flow_control *)mei_msg;
1140 mei_hbm_cl_tx_flow_ctrl_creds_res(dev, fctrl);
1141 break;
1143 case MEI_PG_ISOLATION_ENTRY_RES_CMD:
1144 dev_dbg(dev->dev, "hbm: power gate isolation entry response received\n");
1145 ret = mei_hbm_pg_enter_res(dev);
1146 if (ret)
1147 return ret;
1148 break;
1150 case MEI_PG_ISOLATION_EXIT_REQ_CMD:
1151 dev_dbg(dev->dev, "hbm: power gate isolation exit request received\n");
1152 ret = mei_hbm_pg_exit_res(dev);
1153 if (ret)
1154 return ret;
1155 break;
1157 case HOST_CLIENT_PROPERTIES_RES_CMD:
1158 dev_dbg(dev->dev, "hbm: properties response: message received.\n");
1160 dev->init_clients_timer = 0;
1162 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
1163 dev->hbm_state != MEI_HBM_CLIENT_PROPERTIES) {
1164 dev_err(dev->dev, "hbm: properties response: state mismatch, [%d, %d]\n",
1165 dev->dev_state, dev->hbm_state);
1166 return -EPROTO;
1169 props_res = (struct hbm_props_response *)mei_msg;
1171 if (props_res->status == MEI_HBMS_CLIENT_NOT_FOUND) {
1172 dev_dbg(dev->dev, "hbm: properties response: %d CLIENT_NOT_FOUND\n",
1173 props_res->me_addr);
1174 } else if (props_res->status) {
1175 dev_err(dev->dev, "hbm: properties response: wrong status = %d %s\n",
1176 props_res->status,
1177 mei_hbm_status_str(props_res->status));
1178 return -EPROTO;
1179 } else {
1180 mei_hbm_me_cl_add(dev, props_res);
1183 /* request property for the next client */
1184 if (mei_hbm_prop_req(dev, props_res->me_addr + 1))
1185 return -EIO;
1187 break;
1189 case HOST_ENUM_RES_CMD:
1190 dev_dbg(dev->dev, "hbm: enumeration response: message received\n");
1192 dev->init_clients_timer = 0;
1194 enum_res = (struct hbm_host_enum_response *) mei_msg;
1195 BUILD_BUG_ON(sizeof(dev->me_clients_map)
1196 < sizeof(enum_res->valid_addresses));
1197 memcpy(dev->me_clients_map, enum_res->valid_addresses,
1198 sizeof(enum_res->valid_addresses));
1200 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
1201 dev->hbm_state != MEI_HBM_ENUM_CLIENTS) {
1202 dev_err(dev->dev, "hbm: enumeration response: state mismatch, [%d, %d]\n",
1203 dev->dev_state, dev->hbm_state);
1204 return -EPROTO;
1207 dev->hbm_state = MEI_HBM_CLIENT_PROPERTIES;
1209 /* first property request */
1210 if (mei_hbm_prop_req(dev, 0))
1211 return -EIO;
1213 break;
1215 case HOST_STOP_RES_CMD:
1216 dev_dbg(dev->dev, "hbm: stop response: message received\n");
1218 dev->init_clients_timer = 0;
1220 if (dev->hbm_state != MEI_HBM_STOPPED) {
1221 dev_err(dev->dev, "hbm: stop response: state mismatch, [%d, %d]\n",
1222 dev->dev_state, dev->hbm_state);
1223 return -EPROTO;
1226 dev->dev_state = MEI_DEV_POWER_DOWN;
1227 dev_info(dev->dev, "hbm: stop response: resetting.\n");
1228 /* force the reset */
1229 return -EPROTO;
1230 break;
1232 case CLIENT_DISCONNECT_REQ_CMD:
1233 dev_dbg(dev->dev, "hbm: disconnect request: message received\n");
1235 disconnect_req = (struct hbm_client_connect_request *)mei_msg;
1236 mei_hbm_fw_disconnect_req(dev, disconnect_req);
1237 break;
1239 case ME_STOP_REQ_CMD:
1240 dev_dbg(dev->dev, "hbm: stop request: message received\n");
1241 dev->hbm_state = MEI_HBM_STOPPED;
1242 if (mei_hbm_stop_req(dev)) {
1243 dev_err(dev->dev, "hbm: stop request: failed to send stop request\n");
1244 return -EIO;
1246 break;
1248 case MEI_HBM_ADD_CLIENT_REQ_CMD:
1249 dev_dbg(dev->dev, "hbm: add client request received\n");
1251 * after the host receives the enum_resp
1252 * message clients may be added or removed
1254 if (dev->hbm_state <= MEI_HBM_ENUM_CLIENTS ||
1255 dev->hbm_state >= MEI_HBM_STOPPED) {
1256 dev_err(dev->dev, "hbm: add client: state mismatch, [%d, %d]\n",
1257 dev->dev_state, dev->hbm_state);
1258 return -EPROTO;
1260 add_cl_req = (struct hbm_add_client_request *)mei_msg;
1261 ret = mei_hbm_fw_add_cl_req(dev, add_cl_req);
1262 if (ret) {
1263 dev_err(dev->dev, "hbm: add client: failed to send response %d\n",
1264 ret);
1265 return -EIO;
1267 dev_dbg(dev->dev, "hbm: add client request processed\n");
1268 break;
1270 case MEI_HBM_NOTIFY_RES_CMD:
1271 dev_dbg(dev->dev, "hbm: notify response received\n");
1272 mei_hbm_cl_res(dev, cl_cmd, notify_res_to_fop(cl_cmd));
1273 break;
1275 case MEI_HBM_NOTIFICATION_CMD:
1276 dev_dbg(dev->dev, "hbm: notification\n");
1277 mei_hbm_cl_notify(dev, cl_cmd);
1278 break;
1280 default:
1281 BUG();
1282 break;
1285 return 0;