1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2003-2020, Intel Corporation. All rights reserved.
4 * Intel Management Engine Interface (Intel MEI) Linux driver
6 #include <linux/export.h>
7 #include <linux/sched.h>
8 #include <linux/wait.h>
9 #include <linux/pm_runtime.h>
10 #include <linux/slab.h>
12 #include <linux/mei.h>
18 static const char *mei_hbm_status_str(enum mei_hbm_status status)
20 #define MEI_HBM_STATUS(status) case MEI_HBMS_##status: return #status
22 MEI_HBM_STATUS(SUCCESS);
23 MEI_HBM_STATUS(CLIENT_NOT_FOUND);
24 MEI_HBM_STATUS(ALREADY_EXISTS);
25 MEI_HBM_STATUS(REJECTED);
26 MEI_HBM_STATUS(INVALID_PARAMETER);
27 MEI_HBM_STATUS(NOT_ALLOWED);
28 MEI_HBM_STATUS(ALREADY_STARTED);
29 MEI_HBM_STATUS(NOT_STARTED);
30 default: return "unknown";
35 static const char *mei_cl_conn_status_str(enum mei_cl_connect_status status)
37 #define MEI_CL_CS(status) case MEI_CL_CONN_##status: return #status
41 MEI_CL_CS(ALREADY_STARTED);
42 MEI_CL_CS(OUT_OF_RESOURCES);
43 MEI_CL_CS(MESSAGE_SMALL);
44 MEI_CL_CS(NOT_ALLOWED);
45 default: return "unknown";
50 const char *mei_hbm_state_str(enum mei_hbm_state state)
52 #define MEI_HBM_STATE(state) case MEI_HBM_##state: return #state
55 MEI_HBM_STATE(STARTING);
56 MEI_HBM_STATE(STARTED);
57 MEI_HBM_STATE(DR_SETUP);
58 MEI_HBM_STATE(ENUM_CLIENTS);
59 MEI_HBM_STATE(CLIENT_PROPERTIES);
60 MEI_HBM_STATE(STOPPED);
68 * mei_cl_conn_status_to_errno - convert client connect response
69 * status to error code
71 * @status: client connect response status
73 * Return: corresponding error code
75 static int mei_cl_conn_status_to_errno(enum mei_cl_connect_status status)
78 case MEI_CL_CONN_SUCCESS: return 0;
79 case MEI_CL_CONN_NOT_FOUND: return -ENOTTY;
80 case MEI_CL_CONN_ALREADY_STARTED: return -EBUSY;
81 case MEI_CL_CONN_OUT_OF_RESOURCES: return -EBUSY;
82 case MEI_CL_CONN_MESSAGE_SMALL: return -EINVAL;
83 case MEI_CL_CONN_NOT_ALLOWED: return -EBUSY;
84 default: return -EINVAL;
89 * mei_hbm_write_message - wrapper for sending hbm messages.
95 static inline int mei_hbm_write_message(struct mei_device *dev,
96 struct mei_msg_hdr *hdr,
99 return mei_write_message(dev, hdr, sizeof(*hdr), data, hdr->length);
103 * mei_hbm_idle - set hbm to idle state
105 * @dev: the device structure
107 void mei_hbm_idle(struct mei_device *dev)
109 dev->init_clients_timer = 0;
110 dev->hbm_state = MEI_HBM_IDLE;
114 * mei_hbm_reset - reset hbm counters and book keeping data structurs
116 * @dev: the device structure
118 void mei_hbm_reset(struct mei_device *dev)
120 mei_me_cl_rm_all(dev);
126 * mei_hbm_hdr - construct hbm header
128 * @mei_hdr: hbm header
129 * @length: payload length
132 static inline void mei_hbm_hdr(struct mei_msg_hdr *mei_hdr, size_t length)
134 memset(mei_hdr, 0, sizeof(*mei_hdr));
135 mei_hdr->length = length;
136 mei_hdr->msg_complete = 1;
140 * mei_hbm_cl_hdr - construct client hbm header
143 * @hbm_cmd: host bus message command
144 * @buf: buffer for cl header
145 * @len: buffer length
148 void mei_hbm_cl_hdr(struct mei_cl *cl, u8 hbm_cmd, void *buf, size_t len)
150 struct mei_hbm_cl_cmd *cmd = buf;
154 cmd->hbm_cmd = hbm_cmd;
155 cmd->host_addr = mei_cl_host_addr(cl);
156 cmd->me_addr = mei_cl_me_id(cl);
160 * mei_hbm_cl_write - write simple hbm client message
162 * @dev: the device structure
164 * @hbm_cmd: host bus message command
165 * @buf: message buffer
166 * @len: buffer length
168 * Return: 0 on success, <0 on failure.
170 static inline int mei_hbm_cl_write(struct mei_device *dev, struct mei_cl *cl,
171 u8 hbm_cmd, void *buf, size_t len)
173 struct mei_msg_hdr mei_hdr;
175 mei_hbm_hdr(&mei_hdr, len);
176 mei_hbm_cl_hdr(cl, hbm_cmd, buf, len);
178 return mei_hbm_write_message(dev, &mei_hdr, buf);
182 * mei_hbm_cl_addr_equal - check if the client's and
183 * the message address match
186 * @cmd: hbm client message
188 * Return: true if addresses are the same
191 bool mei_hbm_cl_addr_equal(struct mei_cl *cl, struct mei_hbm_cl_cmd *cmd)
193 return mei_cl_host_addr(cl) == cmd->host_addr &&
194 mei_cl_me_id(cl) == cmd->me_addr;
198 * mei_hbm_cl_find_by_cmd - find recipient client
200 * @dev: the device structure
201 * @buf: a buffer with hbm cl command
203 * Return: the recipient client or NULL if not found
206 struct mei_cl *mei_hbm_cl_find_by_cmd(struct mei_device *dev, void *buf)
208 struct mei_hbm_cl_cmd *cmd = (struct mei_hbm_cl_cmd *)buf;
211 list_for_each_entry(cl, &dev->file_list, link)
212 if (mei_hbm_cl_addr_equal(cl, cmd))
219 * mei_hbm_start_wait - wait for start response message.
221 * @dev: the device structure
223 * Return: 0 on success and < 0 on failure
225 int mei_hbm_start_wait(struct mei_device *dev)
229 if (dev->hbm_state > MEI_HBM_STARTING)
232 mutex_unlock(&dev->device_lock);
233 ret = wait_event_timeout(dev->wait_hbm_start,
234 dev->hbm_state != MEI_HBM_STARTING,
235 mei_secs_to_jiffies(MEI_HBM_TIMEOUT));
236 mutex_lock(&dev->device_lock);
238 if (ret == 0 && (dev->hbm_state <= MEI_HBM_STARTING)) {
239 dev->hbm_state = MEI_HBM_IDLE;
240 dev_err(dev->dev, "waiting for mei start failed\n");
247 * mei_hbm_start_req - sends start request message.
249 * @dev: the device structure
251 * Return: 0 on success and < 0 on failure
253 int mei_hbm_start_req(struct mei_device *dev)
255 struct mei_msg_hdr mei_hdr;
256 struct hbm_host_version_request req;
261 mei_hbm_hdr(&mei_hdr, sizeof(req));
263 /* host start message */
264 memset(&req, 0, sizeof(req));
265 req.hbm_cmd = HOST_START_REQ_CMD;
266 req.host_version.major_version = HBM_MAJOR_VERSION;
267 req.host_version.minor_version = HBM_MINOR_VERSION;
269 dev->hbm_state = MEI_HBM_IDLE;
270 ret = mei_hbm_write_message(dev, &mei_hdr, &req);
272 dev_err(dev->dev, "version message write failed: ret = %d\n",
277 dev->hbm_state = MEI_HBM_STARTING;
278 dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
279 mei_schedule_stall_timer(dev);
284 * mei_hbm_dma_setup_req() - setup DMA request
285 * @dev: the device structure
287 * Return: 0 on success and < 0 on failure
289 static int mei_hbm_dma_setup_req(struct mei_device *dev)
291 struct mei_msg_hdr mei_hdr;
292 struct hbm_dma_setup_request req;
296 mei_hbm_hdr(&mei_hdr, sizeof(req));
298 memset(&req, 0, sizeof(req));
299 req.hbm_cmd = MEI_HBM_DMA_SETUP_REQ_CMD;
300 for (i = 0; i < DMA_DSCR_NUM; i++) {
303 paddr = dev->dr_dscr[i].daddr;
304 req.dma_dscr[i].addr_hi = upper_32_bits(paddr);
305 req.dma_dscr[i].addr_lo = lower_32_bits(paddr);
306 req.dma_dscr[i].size = dev->dr_dscr[i].size;
309 mei_dma_ring_reset(dev);
311 ret = mei_hbm_write_message(dev, &mei_hdr, &req);
313 dev_err(dev->dev, "dma setup request write failed: ret = %d.\n",
318 dev->hbm_state = MEI_HBM_DR_SETUP;
319 dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
320 mei_schedule_stall_timer(dev);
325 * mei_hbm_capabilities_req - request capabilities
327 * @dev: the device structure
329 * Return: 0 on success and < 0 on failure
331 static int mei_hbm_capabilities_req(struct mei_device *dev)
333 struct mei_msg_hdr mei_hdr;
334 struct hbm_capability_request req;
337 mei_hbm_hdr(&mei_hdr, sizeof(req));
339 memset(&req, 0, sizeof(req));
340 req.hbm_cmd = MEI_HBM_CAPABILITIES_REQ_CMD;
341 if (dev->hbm_f_vt_supported)
342 req.capability_requested[0] |= HBM_CAP_VT;
343 if (dev->hbm_f_cd_supported)
344 req.capability_requested[0] |= HBM_CAP_CD;
346 ret = mei_hbm_write_message(dev, &mei_hdr, &req);
349 "capabilities request write failed: ret = %d.\n", ret);
353 dev->hbm_state = MEI_HBM_CAP_SETUP;
354 dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
355 mei_schedule_stall_timer(dev);
360 * mei_hbm_enum_clients_req - sends enumeration client request message.
362 * @dev: the device structure
364 * Return: 0 on success and < 0 on failure
366 static int mei_hbm_enum_clients_req(struct mei_device *dev)
368 struct mei_msg_hdr mei_hdr;
369 struct hbm_host_enum_request req;
372 /* enumerate clients */
373 mei_hbm_hdr(&mei_hdr, sizeof(req));
375 memset(&req, 0, sizeof(req));
376 req.hbm_cmd = HOST_ENUM_REQ_CMD;
377 req.flags |= dev->hbm_f_dc_supported ? MEI_HBM_ENUM_F_ALLOW_ADD : 0;
378 req.flags |= dev->hbm_f_ie_supported ?
379 MEI_HBM_ENUM_F_IMMEDIATE_ENUM : 0;
381 ret = mei_hbm_write_message(dev, &mei_hdr, &req);
383 dev_err(dev->dev, "enumeration request write failed: ret = %d.\n",
387 dev->hbm_state = MEI_HBM_ENUM_CLIENTS;
388 dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
389 mei_schedule_stall_timer(dev);
394 * mei_hbm_me_cl_add - add new me client to the list
396 * @dev: the device structure
397 * @res: hbm property response
399 * Return: 0 on success and -ENOMEM on allocation failure
402 static int mei_hbm_me_cl_add(struct mei_device *dev,
403 struct hbm_props_response *res)
405 struct mei_me_client *me_cl;
406 const uuid_le *uuid = &res->client_properties.protocol_name;
408 mei_me_cl_rm_by_uuid(dev, uuid);
410 me_cl = kzalloc(sizeof(*me_cl), GFP_KERNEL);
414 mei_me_cl_init(me_cl);
416 me_cl->props = res->client_properties;
417 me_cl->client_id = res->me_addr;
418 me_cl->tx_flow_ctrl_creds = 0;
420 mei_me_cl_add(dev, me_cl);
426 * mei_hbm_add_cl_resp - send response to fw on client add request
428 * @dev: the device structure
430 * @status: response status
432 * Return: 0 on success and < 0 on failure
434 static int mei_hbm_add_cl_resp(struct mei_device *dev, u8 addr, u8 status)
436 struct mei_msg_hdr mei_hdr;
437 struct hbm_add_client_response resp;
440 dev_dbg(dev->dev, "adding client response\n");
442 mei_hbm_hdr(&mei_hdr, sizeof(resp));
444 memset(&resp, 0, sizeof(resp));
445 resp.hbm_cmd = MEI_HBM_ADD_CLIENT_RES_CMD;
447 resp.status = status;
449 ret = mei_hbm_write_message(dev, &mei_hdr, &resp);
451 dev_err(dev->dev, "add client response write failed: ret = %d\n",
457 * mei_hbm_fw_add_cl_req - request from the fw to add a client
459 * @dev: the device structure
460 * @req: add client request
462 * Return: 0 on success and < 0 on failure
464 static int mei_hbm_fw_add_cl_req(struct mei_device *dev,
465 struct hbm_add_client_request *req)
468 u8 status = MEI_HBMS_SUCCESS;
470 BUILD_BUG_ON(sizeof(struct hbm_add_client_request) !=
471 sizeof(struct hbm_props_response));
473 ret = mei_hbm_me_cl_add(dev, (struct hbm_props_response *)req);
475 status = !MEI_HBMS_SUCCESS;
477 if (dev->dev_state == MEI_DEV_ENABLED)
478 schedule_work(&dev->bus_rescan_work);
480 return mei_hbm_add_cl_resp(dev, req->me_addr, status);
484 * mei_hbm_cl_notify_req - send notification request
486 * @dev: the device structure
487 * @cl: a client to disconnect from
488 * @start: true for start false for stop
490 * Return: 0 on success and -EIO on write failure
492 int mei_hbm_cl_notify_req(struct mei_device *dev,
493 struct mei_cl *cl, u8 start)
496 struct mei_msg_hdr mei_hdr;
497 struct hbm_notification_request req;
500 mei_hbm_hdr(&mei_hdr, sizeof(req));
501 mei_hbm_cl_hdr(cl, MEI_HBM_NOTIFY_REQ_CMD, &req, sizeof(req));
505 ret = mei_hbm_write_message(dev, &mei_hdr, &req);
507 dev_err(dev->dev, "notify request failed: ret = %d\n", ret);
513 * notify_res_to_fop - convert notification response to the proper
516 * @cmd: client notification start response command
518 * Return: MEI_FOP_NOTIFY_START or MEI_FOP_NOTIFY_STOP;
520 static inline enum mei_cb_file_ops notify_res_to_fop(struct mei_hbm_cl_cmd *cmd)
522 struct hbm_notification_response *rs =
523 (struct hbm_notification_response *)cmd;
525 return mei_cl_notify_req2fop(rs->start);
529 * mei_hbm_cl_notify_start_res - update the client state according
530 * notify start response
532 * @dev: the device structure
533 * @cl: mei host client
534 * @cmd: client notification start response command
536 static void mei_hbm_cl_notify_start_res(struct mei_device *dev,
538 struct mei_hbm_cl_cmd *cmd)
540 struct hbm_notification_response *rs =
541 (struct hbm_notification_response *)cmd;
543 cl_dbg(dev, cl, "hbm: notify start response status=%d\n", rs->status);
545 if (rs->status == MEI_HBMS_SUCCESS ||
546 rs->status == MEI_HBMS_ALREADY_STARTED) {
547 cl->notify_en = true;
550 cl->status = -EINVAL;
555 * mei_hbm_cl_notify_stop_res - update the client state according
556 * notify stop response
558 * @dev: the device structure
559 * @cl: mei host client
560 * @cmd: client notification stop response command
562 static void mei_hbm_cl_notify_stop_res(struct mei_device *dev,
564 struct mei_hbm_cl_cmd *cmd)
566 struct hbm_notification_response *rs =
567 (struct hbm_notification_response *)cmd;
569 cl_dbg(dev, cl, "hbm: notify stop response status=%d\n", rs->status);
571 if (rs->status == MEI_HBMS_SUCCESS ||
572 rs->status == MEI_HBMS_NOT_STARTED) {
573 cl->notify_en = false;
576 /* TODO: spec is not clear yet about other possible issues */
577 cl->status = -EINVAL;
582 * mei_hbm_cl_notify - signal notification event
584 * @dev: the device structure
585 * @cmd: notification client message
587 static void mei_hbm_cl_notify(struct mei_device *dev,
588 struct mei_hbm_cl_cmd *cmd)
592 cl = mei_hbm_cl_find_by_cmd(dev, cmd);
598 * mei_hbm_cl_dma_map_req - send client dma map request
600 * @dev: the device structure
601 * @cl: mei host client
603 * Return: 0 on success and -EIO on write failure
605 int mei_hbm_cl_dma_map_req(struct mei_device *dev, struct mei_cl *cl)
607 struct mei_msg_hdr mei_hdr;
608 struct hbm_client_dma_map_request req;
611 mei_hbm_hdr(&mei_hdr, sizeof(req));
613 memset(&req, 0, sizeof(req));
615 req.hbm_cmd = MEI_HBM_CLIENT_DMA_MAP_REQ_CMD;
616 req.client_buffer_id = cl->dma.buffer_id;
617 req.address_lsb = lower_32_bits(cl->dma.daddr);
618 req.address_msb = upper_32_bits(cl->dma.daddr);
619 req.size = cl->dma.size;
621 ret = mei_hbm_write_message(dev, &mei_hdr, &req);
623 dev_err(dev->dev, "dma map request failed: ret = %d\n", ret);
629 * mei_hbm_cl_dma_unmap_req - send client dma unmap request
631 * @dev: the device structure
632 * @cl: mei host client
634 * Return: 0 on success and -EIO on write failure
636 int mei_hbm_cl_dma_unmap_req(struct mei_device *dev, struct mei_cl *cl)
638 struct mei_msg_hdr mei_hdr;
639 struct hbm_client_dma_unmap_request req;
642 mei_hbm_hdr(&mei_hdr, sizeof(req));
644 memset(&req, 0, sizeof(req));
646 req.hbm_cmd = MEI_HBM_CLIENT_DMA_UNMAP_REQ_CMD;
647 req.client_buffer_id = cl->dma.buffer_id;
649 ret = mei_hbm_write_message(dev, &mei_hdr, &req);
651 dev_err(dev->dev, "dma unmap request failed: ret = %d\n", ret);
656 static void mei_hbm_cl_dma_map_res(struct mei_device *dev,
657 struct hbm_client_dma_response *res)
660 struct mei_cl_cb *cb, *next;
663 list_for_each_entry_safe(cb, next, &dev->ctrl_rd_list, list) {
664 if (cb->fop_type != MEI_FOP_DMA_MAP)
666 if (!cb->cl->dma.buffer_id || cb->cl->dma_mapped)
675 dev_dbg(dev->dev, "cl dma map result = %d\n", res->status);
676 cl->status = res->status;
682 static void mei_hbm_cl_dma_unmap_res(struct mei_device *dev,
683 struct hbm_client_dma_response *res)
686 struct mei_cl_cb *cb, *next;
689 list_for_each_entry_safe(cb, next, &dev->ctrl_rd_list, list) {
690 if (cb->fop_type != MEI_FOP_DMA_UNMAP)
692 if (!cb->cl->dma.buffer_id || !cb->cl->dma_mapped)
701 dev_dbg(dev->dev, "cl dma unmap result = %d\n", res->status);
702 cl->status = res->status;
709 * mei_hbm_prop_req - request property for a single client
711 * @dev: the device structure
712 * @start_idx: client index to start search
714 * Return: 0 on success and < 0 on failure
716 static int mei_hbm_prop_req(struct mei_device *dev, unsigned long start_idx)
718 struct mei_msg_hdr mei_hdr;
719 struct hbm_props_request req;
723 addr = find_next_bit(dev->me_clients_map, MEI_CLIENTS_MAX, start_idx);
725 /* We got all client properties */
726 if (addr == MEI_CLIENTS_MAX) {
727 dev->hbm_state = MEI_HBM_STARTED;
728 mei_host_client_init(dev);
732 mei_hbm_hdr(&mei_hdr, sizeof(req));
734 memset(&req, 0, sizeof(req));
736 req.hbm_cmd = HOST_CLIENT_PROPERTIES_REQ_CMD;
739 ret = mei_hbm_write_message(dev, &mei_hdr, &req);
741 dev_err(dev->dev, "properties request write failed: ret = %d\n",
746 dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
747 mei_schedule_stall_timer(dev);
753 * mei_hbm_pg - sends pg command
755 * @dev: the device structure
756 * @pg_cmd: the pg command code
758 * Return: -EIO on write failure
759 * -EOPNOTSUPP if the operation is not supported by the protocol
761 int mei_hbm_pg(struct mei_device *dev, u8 pg_cmd)
763 struct mei_msg_hdr mei_hdr;
764 struct hbm_power_gate req;
767 if (!dev->hbm_f_pg_supported)
770 mei_hbm_hdr(&mei_hdr, sizeof(req));
772 memset(&req, 0, sizeof(req));
773 req.hbm_cmd = pg_cmd;
775 ret = mei_hbm_write_message(dev, &mei_hdr, &req);
777 dev_err(dev->dev, "power gate command write failed.\n");
780 EXPORT_SYMBOL_GPL(mei_hbm_pg);
783 * mei_hbm_stop_req - send stop request message
787 * Return: -EIO on write failure
789 static int mei_hbm_stop_req(struct mei_device *dev)
791 struct mei_msg_hdr mei_hdr;
792 struct hbm_host_stop_request req;
794 mei_hbm_hdr(&mei_hdr, sizeof(req));
796 memset(&req, 0, sizeof(req));
797 req.hbm_cmd = HOST_STOP_REQ_CMD;
798 req.reason = DRIVER_STOP_REQUEST;
800 return mei_hbm_write_message(dev, &mei_hdr, &req);
804 * mei_hbm_cl_flow_control_req - sends flow control request.
806 * @dev: the device structure
809 * Return: -EIO on write failure
811 int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl)
813 struct hbm_flow_control req;
815 cl_dbg(dev, cl, "sending flow control\n");
816 return mei_hbm_cl_write(dev, cl, MEI_FLOW_CONTROL_CMD,
821 * mei_hbm_add_single_tx_flow_ctrl_creds - adds single buffer credentials.
823 * @dev: the device structure
824 * @fctrl: flow control response bus message
826 * Return: 0 on success, < 0 otherwise
828 static int mei_hbm_add_single_tx_flow_ctrl_creds(struct mei_device *dev,
829 struct hbm_flow_control *fctrl)
831 struct mei_me_client *me_cl;
834 me_cl = mei_me_cl_by_id(dev, fctrl->me_addr);
836 dev_err(dev->dev, "no such me client %d\n", fctrl->me_addr);
840 if (WARN_ON(me_cl->props.single_recv_buf == 0)) {
845 me_cl->tx_flow_ctrl_creds++;
846 dev_dbg(dev->dev, "recv flow ctrl msg ME %d (single) creds = %d.\n",
847 fctrl->me_addr, me_cl->tx_flow_ctrl_creds);
851 mei_me_cl_put(me_cl);
856 * mei_hbm_cl_tx_flow_ctrl_creds_res - flow control response from me
858 * @dev: the device structure
859 * @fctrl: flow control response bus message
861 static void mei_hbm_cl_tx_flow_ctrl_creds_res(struct mei_device *dev,
862 struct hbm_flow_control *fctrl)
866 if (!fctrl->host_addr) {
867 /* single receive buffer */
868 mei_hbm_add_single_tx_flow_ctrl_creds(dev, fctrl);
872 cl = mei_hbm_cl_find_by_cmd(dev, fctrl);
874 cl->tx_flow_ctrl_creds++;
875 cl_dbg(dev, cl, "flow control creds = %d.\n",
876 cl->tx_flow_ctrl_creds);
882 * mei_hbm_cl_disconnect_req - sends disconnect message to fw.
884 * @dev: the device structure
885 * @cl: a client to disconnect from
887 * Return: -EIO on write failure
889 int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl)
891 struct hbm_client_connect_request req;
893 return mei_hbm_cl_write(dev, cl, CLIENT_DISCONNECT_REQ_CMD,
898 * mei_hbm_cl_disconnect_rsp - sends disconnect respose to the FW
900 * @dev: the device structure
901 * @cl: a client to disconnect from
903 * Return: -EIO on write failure
905 int mei_hbm_cl_disconnect_rsp(struct mei_device *dev, struct mei_cl *cl)
907 struct hbm_client_connect_response resp;
909 return mei_hbm_cl_write(dev, cl, CLIENT_DISCONNECT_RES_CMD,
910 &resp, sizeof(resp));
914 * mei_hbm_cl_disconnect_res - update the client state according
915 * disconnect response
917 * @dev: the device structure
918 * @cl: mei host client
919 * @cmd: disconnect client response host bus message
921 static void mei_hbm_cl_disconnect_res(struct mei_device *dev, struct mei_cl *cl,
922 struct mei_hbm_cl_cmd *cmd)
924 struct hbm_client_connect_response *rs =
925 (struct hbm_client_connect_response *)cmd;
927 cl_dbg(dev, cl, "hbm: disconnect response status=%d\n", rs->status);
929 if (rs->status == MEI_CL_DISCONN_SUCCESS)
930 cl->state = MEI_FILE_DISCONNECT_REPLY;
935 * mei_hbm_cl_connect_req - send connection request to specific me client
937 * @dev: the device structure
938 * @cl: a client to connect to
940 * Return: -EIO on write failure
942 int mei_hbm_cl_connect_req(struct mei_device *dev, struct mei_cl *cl)
944 struct hbm_client_connect_request req;
946 return mei_hbm_cl_write(dev, cl, CLIENT_CONNECT_REQ_CMD,
951 * mei_hbm_cl_connect_res - update the client state according
952 * connection response
954 * @dev: the device structure
955 * @cl: mei host client
956 * @cmd: connect client response host bus message
958 static void mei_hbm_cl_connect_res(struct mei_device *dev, struct mei_cl *cl,
959 struct mei_hbm_cl_cmd *cmd)
961 struct hbm_client_connect_response *rs =
962 (struct hbm_client_connect_response *)cmd;
964 cl_dbg(dev, cl, "hbm: connect response status=%s\n",
965 mei_cl_conn_status_str(rs->status));
967 if (rs->status == MEI_CL_CONN_SUCCESS)
968 cl->state = MEI_FILE_CONNECTED;
970 cl->state = MEI_FILE_DISCONNECT_REPLY;
971 if (rs->status == MEI_CL_CONN_NOT_FOUND) {
972 mei_me_cl_del(dev, cl->me_cl);
973 if (dev->dev_state == MEI_DEV_ENABLED)
974 schedule_work(&dev->bus_rescan_work);
977 cl->status = mei_cl_conn_status_to_errno(rs->status);
981 * mei_hbm_cl_res - process hbm response received on behalf
984 * @dev: the device structure
985 * @rs: hbm client message
986 * @fop_type: file operation type
988 static void mei_hbm_cl_res(struct mei_device *dev,
989 struct mei_hbm_cl_cmd *rs,
990 enum mei_cb_file_ops fop_type)
993 struct mei_cl_cb *cb, *next;
996 list_for_each_entry_safe(cb, next, &dev->ctrl_rd_list, list) {
1000 if (cb->fop_type != fop_type)
1003 if (mei_hbm_cl_addr_equal(cl, rs)) {
1004 list_del_init(&cb->list);
1013 case MEI_FOP_CONNECT:
1014 mei_hbm_cl_connect_res(dev, cl, rs);
1016 case MEI_FOP_DISCONNECT:
1017 mei_hbm_cl_disconnect_res(dev, cl, rs);
1019 case MEI_FOP_NOTIFY_START:
1020 mei_hbm_cl_notify_start_res(dev, cl, rs);
1022 case MEI_FOP_NOTIFY_STOP:
1023 mei_hbm_cl_notify_stop_res(dev, cl, rs);
1029 cl->timer_count = 0;
1035 * mei_hbm_fw_disconnect_req - disconnect request initiated by ME firmware
1036 * host sends disconnect response
1038 * @dev: the device structure.
1039 * @disconnect_req: disconnect request bus message from the me
1041 * Return: -ENOMEM on allocation failure
1043 static int mei_hbm_fw_disconnect_req(struct mei_device *dev,
1044 struct hbm_client_connect_request *disconnect_req)
1047 struct mei_cl_cb *cb;
1049 cl = mei_hbm_cl_find_by_cmd(dev, disconnect_req);
1051 cl_warn(dev, cl, "fw disconnect request received\n");
1052 cl->state = MEI_FILE_DISCONNECTING;
1053 cl->timer_count = 0;
1055 cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_DISCONNECT_RSP,
1064 * mei_hbm_pg_enter_res - PG enter response received
1066 * @dev: the device structure.
1068 * Return: 0 on success, -EPROTO on state mismatch
1070 static int mei_hbm_pg_enter_res(struct mei_device *dev)
1072 if (mei_pg_state(dev) != MEI_PG_OFF ||
1073 dev->pg_event != MEI_PG_EVENT_WAIT) {
1074 dev_err(dev->dev, "hbm: pg entry response: state mismatch [%s, %d]\n",
1075 mei_pg_state_str(mei_pg_state(dev)), dev->pg_event);
1079 dev->pg_event = MEI_PG_EVENT_RECEIVED;
1080 wake_up(&dev->wait_pg);
1086 * mei_hbm_pg_resume - process with PG resume
1088 * @dev: the device structure.
1090 void mei_hbm_pg_resume(struct mei_device *dev)
1092 pm_request_resume(dev->dev);
1094 EXPORT_SYMBOL_GPL(mei_hbm_pg_resume);
1097 * mei_hbm_pg_exit_res - PG exit response received
1099 * @dev: the device structure.
1101 * Return: 0 on success, -EPROTO on state mismatch
1103 static int mei_hbm_pg_exit_res(struct mei_device *dev)
1105 if (mei_pg_state(dev) != MEI_PG_ON ||
1106 (dev->pg_event != MEI_PG_EVENT_WAIT &&
1107 dev->pg_event != MEI_PG_EVENT_IDLE)) {
1108 dev_err(dev->dev, "hbm: pg exit response: state mismatch [%s, %d]\n",
1109 mei_pg_state_str(mei_pg_state(dev)), dev->pg_event);
1113 switch (dev->pg_event) {
1114 case MEI_PG_EVENT_WAIT:
1115 dev->pg_event = MEI_PG_EVENT_RECEIVED;
1116 wake_up(&dev->wait_pg);
1118 case MEI_PG_EVENT_IDLE:
1120 * If the driver is not waiting on this then
1121 * this is HW initiated exit from PG.
1122 * Start runtime pm resume sequence to exit from PG.
1124 dev->pg_event = MEI_PG_EVENT_RECEIVED;
1125 mei_hbm_pg_resume(dev);
1128 WARN(1, "hbm: pg exit response: unexpected pg event = %d\n",
1137 * mei_hbm_config_features - check what hbm features and commands
1138 * are supported by the fw
1140 * @dev: the device structure
1142 static void mei_hbm_config_features(struct mei_device *dev)
1144 /* Power Gating Isolation Support */
1145 dev->hbm_f_pg_supported = 0;
1146 if (dev->version.major_version > HBM_MAJOR_VERSION_PGI)
1147 dev->hbm_f_pg_supported = 1;
1149 if (dev->version.major_version == HBM_MAJOR_VERSION_PGI &&
1150 dev->version.minor_version >= HBM_MINOR_VERSION_PGI)
1151 dev->hbm_f_pg_supported = 1;
1153 dev->hbm_f_dc_supported = 0;
1154 if (dev->version.major_version >= HBM_MAJOR_VERSION_DC)
1155 dev->hbm_f_dc_supported = 1;
1157 dev->hbm_f_ie_supported = 0;
1158 if (dev->version.major_version >= HBM_MAJOR_VERSION_IE)
1159 dev->hbm_f_ie_supported = 1;
1161 /* disconnect on connect timeout instead of link reset */
1162 dev->hbm_f_dot_supported = 0;
1163 if (dev->version.major_version >= HBM_MAJOR_VERSION_DOT)
1164 dev->hbm_f_dot_supported = 1;
1166 /* Notification Event Support */
1167 dev->hbm_f_ev_supported = 0;
1168 if (dev->version.major_version >= HBM_MAJOR_VERSION_EV)
1169 dev->hbm_f_ev_supported = 1;
1171 /* Fixed Address Client Support */
1172 dev->hbm_f_fa_supported = 0;
1173 if (dev->version.major_version >= HBM_MAJOR_VERSION_FA)
1174 dev->hbm_f_fa_supported = 1;
1176 /* OS ver message Support */
1177 dev->hbm_f_os_supported = 0;
1178 if (dev->version.major_version >= HBM_MAJOR_VERSION_OS)
1179 dev->hbm_f_os_supported = 1;
1181 /* DMA Ring Support */
1182 dev->hbm_f_dr_supported = 0;
1183 if (dev->version.major_version > HBM_MAJOR_VERSION_DR ||
1184 (dev->version.major_version == HBM_MAJOR_VERSION_DR &&
1185 dev->version.minor_version >= HBM_MINOR_VERSION_DR))
1186 dev->hbm_f_dr_supported = 1;
1189 dev->hbm_f_vt_supported = 0;
1190 if (dev->version.major_version > HBM_MAJOR_VERSION_VT ||
1191 (dev->version.major_version == HBM_MAJOR_VERSION_VT &&
1192 dev->version.minor_version >= HBM_MINOR_VERSION_VT))
1193 dev->hbm_f_vt_supported = 1;
1195 /* Capability message Support */
1196 dev->hbm_f_cap_supported = 0;
1197 if (dev->version.major_version > HBM_MAJOR_VERSION_CAP ||
1198 (dev->version.major_version == HBM_MAJOR_VERSION_CAP &&
1199 dev->version.minor_version >= HBM_MINOR_VERSION_CAP))
1200 dev->hbm_f_cap_supported = 1;
1202 /* Client DMA Support */
1203 dev->hbm_f_cd_supported = 0;
1204 if (dev->version.major_version > HBM_MAJOR_VERSION_CD ||
1205 (dev->version.major_version == HBM_MAJOR_VERSION_CD &&
1206 dev->version.minor_version >= HBM_MINOR_VERSION_CD))
1207 dev->hbm_f_cd_supported = 1;
1211 * mei_hbm_version_is_supported - checks whether the driver can
1212 * support the hbm version of the device
1214 * @dev: the device structure
1215 * Return: true if driver can support hbm version of the device
1217 bool mei_hbm_version_is_supported(struct mei_device *dev)
1219 return (dev->version.major_version < HBM_MAJOR_VERSION) ||
1220 (dev->version.major_version == HBM_MAJOR_VERSION &&
1221 dev->version.minor_version <= HBM_MINOR_VERSION);
1225 * mei_hbm_dispatch - bottom half read routine after ISR to
1226 * handle the read bus message cmd processing.
1228 * @dev: the device structure
1229 * @hdr: header of bus message
1231 * Return: 0 on success and < 0 on failure
1233 int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr)
1235 struct mei_bus_message *mei_msg;
1236 struct hbm_host_version_response *version_res;
1237 struct hbm_props_response *props_res;
1238 struct hbm_host_enum_response *enum_res;
1239 struct hbm_dma_setup_response *dma_setup_res;
1240 struct hbm_add_client_request *add_cl_req;
1241 struct hbm_capability_response *capability_res;
1244 struct mei_hbm_cl_cmd *cl_cmd;
1245 struct hbm_client_connect_request *disconnect_req;
1246 struct hbm_flow_control *fctrl;
1247 struct hbm_client_dma_response *client_dma_res;
1249 /* read the message to our buffer */
1250 BUG_ON(hdr->length >= sizeof(dev->rd_msg_buf));
1251 mei_read_slots(dev, dev->rd_msg_buf, hdr->length);
1252 mei_msg = (struct mei_bus_message *)dev->rd_msg_buf;
1253 cl_cmd = (struct mei_hbm_cl_cmd *)mei_msg;
1255 /* ignore spurious message and prevent reset nesting
1256 * hbm is put to idle during system reset
1258 if (dev->hbm_state == MEI_HBM_IDLE) {
1259 dev_dbg(dev->dev, "hbm: state is idle ignore spurious messages\n");
1263 switch (mei_msg->hbm_cmd) {
1264 case HOST_START_RES_CMD:
1265 dev_dbg(dev->dev, "hbm: start: response message received.\n");
1267 dev->init_clients_timer = 0;
1269 version_res = (struct hbm_host_version_response *)mei_msg;
1271 dev_dbg(dev->dev, "HBM VERSION: DRIVER=%02d:%02d DEVICE=%02d:%02d\n",
1272 HBM_MAJOR_VERSION, HBM_MINOR_VERSION,
1273 version_res->me_max_version.major_version,
1274 version_res->me_max_version.minor_version);
1276 if (version_res->host_version_supported) {
1277 dev->version.major_version = HBM_MAJOR_VERSION;
1278 dev->version.minor_version = HBM_MINOR_VERSION;
1280 dev->version.major_version =
1281 version_res->me_max_version.major_version;
1282 dev->version.minor_version =
1283 version_res->me_max_version.minor_version;
1286 if (!mei_hbm_version_is_supported(dev)) {
1287 dev_warn(dev->dev, "hbm: start: version mismatch - stopping the driver.\n");
1289 dev->hbm_state = MEI_HBM_STOPPED;
1290 if (mei_hbm_stop_req(dev)) {
1291 dev_err(dev->dev, "hbm: start: failed to send stop request\n");
1297 mei_hbm_config_features(dev);
1299 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
1300 dev->hbm_state != MEI_HBM_STARTING) {
1301 if (dev->dev_state == MEI_DEV_POWER_DOWN) {
1302 dev_dbg(dev->dev, "hbm: start: on shutdown, ignoring\n");
1305 dev_err(dev->dev, "hbm: start: state mismatch, [%d, %d]\n",
1306 dev->dev_state, dev->hbm_state);
1310 if (dev->hbm_f_cap_supported) {
1311 if (mei_hbm_capabilities_req(dev))
1313 wake_up(&dev->wait_hbm_start);
1317 if (dev->hbm_f_dr_supported) {
1318 if (mei_dmam_ring_alloc(dev))
1319 dev_info(dev->dev, "running w/o dma ring\n");
1320 if (mei_dma_ring_is_allocated(dev)) {
1321 if (mei_hbm_dma_setup_req(dev))
1324 wake_up(&dev->wait_hbm_start);
1329 dev->hbm_f_dr_supported = 0;
1330 mei_dmam_ring_free(dev);
1332 if (mei_hbm_enum_clients_req(dev))
1335 wake_up(&dev->wait_hbm_start);
1338 case MEI_HBM_CAPABILITIES_RES_CMD:
1339 dev_dbg(dev->dev, "hbm: capabilities response: message received.\n");
1341 dev->init_clients_timer = 0;
1343 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
1344 dev->hbm_state != MEI_HBM_CAP_SETUP) {
1345 if (dev->dev_state == MEI_DEV_POWER_DOWN) {
1346 dev_dbg(dev->dev, "hbm: capabilities response: on shutdown, ignoring\n");
1349 dev_err(dev->dev, "hbm: capabilities response: state mismatch, [%d, %d]\n",
1350 dev->dev_state, dev->hbm_state);
1354 capability_res = (struct hbm_capability_response *)mei_msg;
1355 if (!(capability_res->capability_granted[0] & HBM_CAP_VT))
1356 dev->hbm_f_vt_supported = 0;
1357 if (!(capability_res->capability_granted[0] & HBM_CAP_CD))
1358 dev->hbm_f_cd_supported = 0;
1360 if (dev->hbm_f_dr_supported) {
1361 if (mei_dmam_ring_alloc(dev))
1362 dev_info(dev->dev, "running w/o dma ring\n");
1363 if (mei_dma_ring_is_allocated(dev)) {
1364 if (mei_hbm_dma_setup_req(dev))
1370 dev->hbm_f_dr_supported = 0;
1371 mei_dmam_ring_free(dev);
1373 if (mei_hbm_enum_clients_req(dev))
1377 case MEI_HBM_DMA_SETUP_RES_CMD:
1378 dev_dbg(dev->dev, "hbm: dma setup response: message received.\n");
1380 dev->init_clients_timer = 0;
1382 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
1383 dev->hbm_state != MEI_HBM_DR_SETUP) {
1384 if (dev->dev_state == MEI_DEV_POWER_DOWN) {
1385 dev_dbg(dev->dev, "hbm: dma setup response: on shutdown, ignoring\n");
1388 dev_err(dev->dev, "hbm: dma setup response: state mismatch, [%d, %d]\n",
1389 dev->dev_state, dev->hbm_state);
1393 dma_setup_res = (struct hbm_dma_setup_response *)mei_msg;
1395 if (dma_setup_res->status) {
1396 u8 status = dma_setup_res->status;
1398 if (status == MEI_HBMS_NOT_ALLOWED) {
1399 dev_dbg(dev->dev, "hbm: dma setup not allowed\n");
1401 dev_info(dev->dev, "hbm: dma setup response: failure = %d %s\n",
1403 mei_hbm_status_str(status));
1405 dev->hbm_f_dr_supported = 0;
1406 mei_dmam_ring_free(dev);
1409 if (mei_hbm_enum_clients_req(dev))
1413 case CLIENT_CONNECT_RES_CMD:
1414 dev_dbg(dev->dev, "hbm: client connect response: message received.\n");
1415 mei_hbm_cl_res(dev, cl_cmd, MEI_FOP_CONNECT);
1418 case CLIENT_DISCONNECT_RES_CMD:
1419 dev_dbg(dev->dev, "hbm: client disconnect response: message received.\n");
1420 mei_hbm_cl_res(dev, cl_cmd, MEI_FOP_DISCONNECT);
1423 case MEI_FLOW_CONTROL_CMD:
1424 dev_dbg(dev->dev, "hbm: client flow control response: message received.\n");
1426 fctrl = (struct hbm_flow_control *)mei_msg;
1427 mei_hbm_cl_tx_flow_ctrl_creds_res(dev, fctrl);
1430 case MEI_PG_ISOLATION_ENTRY_RES_CMD:
1431 dev_dbg(dev->dev, "hbm: power gate isolation entry response received\n");
1432 ret = mei_hbm_pg_enter_res(dev);
1437 case MEI_PG_ISOLATION_EXIT_REQ_CMD:
1438 dev_dbg(dev->dev, "hbm: power gate isolation exit request received\n");
1439 ret = mei_hbm_pg_exit_res(dev);
1444 case HOST_CLIENT_PROPERTIES_RES_CMD:
1445 dev_dbg(dev->dev, "hbm: properties response: message received.\n");
1447 dev->init_clients_timer = 0;
1449 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
1450 dev->hbm_state != MEI_HBM_CLIENT_PROPERTIES) {
1451 if (dev->dev_state == MEI_DEV_POWER_DOWN) {
1452 dev_dbg(dev->dev, "hbm: properties response: on shutdown, ignoring\n");
1455 dev_err(dev->dev, "hbm: properties response: state mismatch, [%d, %d]\n",
1456 dev->dev_state, dev->hbm_state);
1460 props_res = (struct hbm_props_response *)mei_msg;
1462 if (props_res->status == MEI_HBMS_CLIENT_NOT_FOUND) {
1463 dev_dbg(dev->dev, "hbm: properties response: %d CLIENT_NOT_FOUND\n",
1464 props_res->me_addr);
1465 } else if (props_res->status) {
1466 dev_err(dev->dev, "hbm: properties response: wrong status = %d %s\n",
1468 mei_hbm_status_str(props_res->status));
1471 mei_hbm_me_cl_add(dev, props_res);
1474 /* request property for the next client */
1475 if (mei_hbm_prop_req(dev, props_res->me_addr + 1))
1480 case HOST_ENUM_RES_CMD:
1481 dev_dbg(dev->dev, "hbm: enumeration response: message received\n");
1483 dev->init_clients_timer = 0;
1485 enum_res = (struct hbm_host_enum_response *) mei_msg;
1486 BUILD_BUG_ON(sizeof(dev->me_clients_map)
1487 < sizeof(enum_res->valid_addresses));
1488 memcpy(dev->me_clients_map, enum_res->valid_addresses,
1489 sizeof(enum_res->valid_addresses));
1491 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
1492 dev->hbm_state != MEI_HBM_ENUM_CLIENTS) {
1493 if (dev->dev_state == MEI_DEV_POWER_DOWN) {
1494 dev_dbg(dev->dev, "hbm: enumeration response: on shutdown, ignoring\n");
1497 dev_err(dev->dev, "hbm: enumeration response: state mismatch, [%d, %d]\n",
1498 dev->dev_state, dev->hbm_state);
1502 dev->hbm_state = MEI_HBM_CLIENT_PROPERTIES;
1504 /* first property request */
1505 if (mei_hbm_prop_req(dev, 0))
1510 case HOST_STOP_RES_CMD:
1511 dev_dbg(dev->dev, "hbm: stop response: message received\n");
1513 dev->init_clients_timer = 0;
1515 if (dev->hbm_state != MEI_HBM_STOPPED) {
1516 dev_err(dev->dev, "hbm: stop response: state mismatch, [%d, %d]\n",
1517 dev->dev_state, dev->hbm_state);
1521 mei_set_devstate(dev, MEI_DEV_POWER_DOWN);
1522 dev_info(dev->dev, "hbm: stop response: resetting.\n");
1523 /* force the reset */
1526 case CLIENT_DISCONNECT_REQ_CMD:
1527 dev_dbg(dev->dev, "hbm: disconnect request: message received\n");
1529 disconnect_req = (struct hbm_client_connect_request *)mei_msg;
1530 mei_hbm_fw_disconnect_req(dev, disconnect_req);
1533 case ME_STOP_REQ_CMD:
1534 dev_dbg(dev->dev, "hbm: stop request: message received\n");
1535 dev->hbm_state = MEI_HBM_STOPPED;
1536 if (mei_hbm_stop_req(dev)) {
1537 dev_err(dev->dev, "hbm: stop request: failed to send stop request\n");
1542 case MEI_HBM_ADD_CLIENT_REQ_CMD:
1543 dev_dbg(dev->dev, "hbm: add client request received\n");
1545 * after the host receives the enum_resp
1546 * message clients may be added or removed
1548 if (dev->hbm_state <= MEI_HBM_ENUM_CLIENTS ||
1549 dev->hbm_state >= MEI_HBM_STOPPED) {
1550 dev_err(dev->dev, "hbm: add client: state mismatch, [%d, %d]\n",
1551 dev->dev_state, dev->hbm_state);
1554 add_cl_req = (struct hbm_add_client_request *)mei_msg;
1555 ret = mei_hbm_fw_add_cl_req(dev, add_cl_req);
1557 dev_err(dev->dev, "hbm: add client: failed to send response %d\n",
1561 dev_dbg(dev->dev, "hbm: add client request processed\n");
1564 case MEI_HBM_NOTIFY_RES_CMD:
1565 dev_dbg(dev->dev, "hbm: notify response received\n");
1566 mei_hbm_cl_res(dev, cl_cmd, notify_res_to_fop(cl_cmd));
1569 case MEI_HBM_NOTIFICATION_CMD:
1570 dev_dbg(dev->dev, "hbm: notification\n");
1571 mei_hbm_cl_notify(dev, cl_cmd);
1574 case MEI_HBM_CLIENT_DMA_MAP_RES_CMD:
1575 dev_dbg(dev->dev, "hbm: client dma map response: message received.\n");
1576 client_dma_res = (struct hbm_client_dma_response *)mei_msg;
1577 mei_hbm_cl_dma_map_res(dev, client_dma_res);
1580 case MEI_HBM_CLIENT_DMA_UNMAP_RES_CMD:
1581 dev_dbg(dev->dev, "hbm: client dma unmap response: message received.\n");
1582 client_dma_res = (struct hbm_client_dma_response *)mei_msg;
1583 mei_hbm_cl_dma_unmap_res(dev, client_dma_res);
1587 WARN(1, "hbm: wrong command %d\n", mei_msg->hbm_cmd);