projects / deliverable / linux.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
mei: bus: add and call callback on notify event
[deliverable/linux.git] / drivers / misc / mei / hbm.c
... / ...
CommitLineData
1/*
2 *
3 * Intel Management Engine Interface (Intel MEI) Linux driver
4 * Copyright (c) 2003-2012, Intel Corporation.
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#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>
22
23#include <linux/mei.h>
24
25#include "mei_dev.h"
26#include "hbm.h"
27#include "client.h"
28
29static const char *mei_hbm_status_str(enum mei_hbm_status status)
30{
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";
42 }
43#undef MEI_HBM_STATUS
44};
45
46static const char *mei_cl_conn_status_str(enum mei_cl_connect_status status)
47{
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 default: return "unknown";
56 }
57#undef MEI_CL_CCS
58}
59
60const char *mei_hbm_state_str(enum mei_hbm_state state)
61{
62#define MEI_HBM_STATE(state) case MEI_HBM_##state: return #state
63 switch (state) {
64 MEI_HBM_STATE(IDLE);
65 MEI_HBM_STATE(STARTING);
66 MEI_HBM_STATE(STARTED);
67 MEI_HBM_STATE(ENUM_CLIENTS);
68 MEI_HBM_STATE(CLIENT_PROPERTIES);
69 MEI_HBM_STATE(STOPPED);
70 default:
71 return "unknown";
72 }
73#undef MEI_HBM_STATE
74}
75
76/**
77 * mei_cl_conn_status_to_errno - convert client connect response
78 * status to error code
79 *
80 * @status: client connect response status
81 *
82 * Return: corresponding error code
83 */
84static int mei_cl_conn_status_to_errno(enum mei_cl_connect_status status)
85{
86 switch (status) {
87 case MEI_CL_CONN_SUCCESS: return 0;
88 case MEI_CL_CONN_NOT_FOUND: return -ENOTTY;
89 case MEI_CL_CONN_ALREADY_STARTED: return -EBUSY;
90 case MEI_CL_CONN_OUT_OF_RESOURCES: return -EBUSY;
91 case MEI_CL_CONN_MESSAGE_SMALL: return -EINVAL;
92 default: return -EINVAL;
93 }
94}
95
96/**
97 * mei_hbm_idle - set hbm to idle state
98 *
99 * @dev: the device structure
100 */
101void mei_hbm_idle(struct mei_device *dev)
102{
103 dev->init_clients_timer = 0;
104 dev->hbm_state = MEI_HBM_IDLE;
105}
106
107/**
108 * mei_hbm_reset - reset hbm counters and book keeping data structurs
109 *
110 * @dev: the device structure
111 */
112void mei_hbm_reset(struct mei_device *dev)
113{
114 dev->me_client_index = 0;
115
116 mei_me_cl_rm_all(dev);
117
118 mei_hbm_idle(dev);
119}
120
121/**
122 * mei_hbm_hdr - construct hbm header
123 *
124 * @hdr: hbm header
125 * @length: payload length
126 */
127
128static inline void mei_hbm_hdr(struct mei_msg_hdr *hdr, size_t length)
129{
130 hdr->host_addr = 0;
131 hdr->me_addr = 0;
132 hdr->length = length;
133 hdr->msg_complete = 1;
134 hdr->reserved = 0;
135}
136
137/**
138 * mei_hbm_cl_hdr - construct client hbm header
139 *
140 * @cl: client
141 * @hbm_cmd: host bus message command
142 * @buf: buffer for cl header
143 * @len: buffer length
144 */
145static inline
146void mei_hbm_cl_hdr(struct mei_cl *cl, u8 hbm_cmd, void *buf, size_t len)
147{
148 struct mei_hbm_cl_cmd *cmd = buf;
149
150 memset(cmd, 0, len);
151
152 cmd->hbm_cmd = hbm_cmd;
153 cmd->host_addr = mei_cl_host_addr(cl);
154 cmd->me_addr = mei_cl_me_id(cl);
155}
156
157/**
158 * mei_hbm_cl_write - write simple hbm client message
159 *
160 * @dev: the device structure
161 * @cl: client
162 * @hbm_cmd: host bus message command
163 * @len: buffer length
164 *
165 * Return: 0 on success, <0 on failure.
166 */
167static inline
168int mei_hbm_cl_write(struct mei_device *dev,
169 struct mei_cl *cl, u8 hbm_cmd, size_t len)
170{
171 struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
172
173 mei_hbm_hdr(mei_hdr, len);
174 mei_hbm_cl_hdr(cl, hbm_cmd, dev->wr_msg.data, len);
175
176 return mei_write_message(dev, mei_hdr, dev->wr_msg.data);
177}
178
179/**
180 * mei_hbm_cl_addr_equal - check if the client's and
181 * the message address match
182 *
183 * @cl: client
184 * @cmd: hbm client message
185 *
186 * Return: true if addresses are the same
187 */
188static inline
189bool mei_hbm_cl_addr_equal(struct mei_cl *cl, struct mei_hbm_cl_cmd *cmd)
190{
191 return mei_cl_host_addr(cl) == cmd->host_addr &&
192 mei_cl_me_id(cl) == cmd->me_addr;
193}
194
195/**
196 * mei_hbm_cl_find_by_cmd - find recipient client
197 *
198 * @dev: the device structure
199 * @buf: a buffer with hbm cl command
200 *
201 * Return: the recipient client or NULL if not found
202 */
203static inline
204struct mei_cl *mei_hbm_cl_find_by_cmd(struct mei_device *dev, void *buf)
205{
206 struct mei_hbm_cl_cmd *cmd = (struct mei_hbm_cl_cmd *)buf;
207 struct mei_cl *cl;
208
209 list_for_each_entry(cl, &dev->file_list, link)
210 if (mei_hbm_cl_addr_equal(cl, cmd))
211 return cl;
212 return NULL;
213}
214
215
216/**
217 * mei_hbm_start_wait - wait for start response message.
218 *
219 * @dev: the device structure
220 *
221 * Return: 0 on success and < 0 on failure
222 */
223int mei_hbm_start_wait(struct mei_device *dev)
224{
225 int ret;
226
227 if (dev->hbm_state > MEI_HBM_STARTING)
228 return 0;
229
230 mutex_unlock(&dev->device_lock);
231 ret = wait_event_timeout(dev->wait_hbm_start,
232 dev->hbm_state != MEI_HBM_STARTING,
233 mei_secs_to_jiffies(MEI_HBM_TIMEOUT));
234 mutex_lock(&dev->device_lock);
235
236 if (ret == 0 && (dev->hbm_state <= MEI_HBM_STARTING)) {
237 dev->hbm_state = MEI_HBM_IDLE;
238 dev_err(dev->dev, "waiting for mei start failed\n");
239 return -ETIME;
240 }
241 return 0;
242}
243
244/**
245 * mei_hbm_start_req - sends start request message.
246 *
247 * @dev: the device structure
248 *
249 * Return: 0 on success and < 0 on failure
250 */
251int mei_hbm_start_req(struct mei_device *dev)
252{
253 struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
254 struct hbm_host_version_request *start_req;
255 const size_t len = sizeof(struct hbm_host_version_request);
256 int ret;
257
258 mei_hbm_reset(dev);
259
260 mei_hbm_hdr(mei_hdr, len);
261
262 /* host start message */
263 start_req = (struct hbm_host_version_request *)dev->wr_msg.data;
264 memset(start_req, 0, len);
265 start_req->hbm_cmd = HOST_START_REQ_CMD;
266 start_req->host_version.major_version = HBM_MAJOR_VERSION;
267 start_req->host_version.minor_version = HBM_MINOR_VERSION;
268
269 dev->hbm_state = MEI_HBM_IDLE;
270 ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
271 if (ret) {
272 dev_err(dev->dev, "version message write failed: ret = %d\n",
273 ret);
274 return ret;
275 }
276
277 dev->hbm_state = MEI_HBM_STARTING;
278 dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
279 return 0;
280}
281
282/*
283 * mei_hbm_enum_clients_req - sends enumeration client request message.
284 *
285 * @dev: the device structure
286 *
287 * Return: 0 on success and < 0 on failure
288 */
289static int mei_hbm_enum_clients_req(struct mei_device *dev)
290{
291 struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
292 struct hbm_host_enum_request *enum_req;
293 const size_t len = sizeof(struct hbm_host_enum_request);
294 int ret;
295
296 /* enumerate clients */
297 mei_hbm_hdr(mei_hdr, len);
298
299 enum_req = (struct hbm_host_enum_request *)dev->wr_msg.data;
300 memset(enum_req, 0, len);
301 enum_req->hbm_cmd = HOST_ENUM_REQ_CMD;
302 enum_req->allow_add = dev->hbm_f_dc_supported;
303
304 ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
305 if (ret) {
306 dev_err(dev->dev, "enumeration request write failed: ret = %d.\n",
307 ret);
308 return ret;
309 }
310 dev->hbm_state = MEI_HBM_ENUM_CLIENTS;
311 dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
312 return 0;
313}
314
315/*
316 * mei_hbm_me_cl_add - add new me client to the list
317 *
318 * @dev: the device structure
319 * @res: hbm property response
320 *
321 * Return: 0 on success and -ENOMEM on allocation failure
322 */
323
324static int mei_hbm_me_cl_add(struct mei_device *dev,
325 struct hbm_props_response *res)
326{
327 struct mei_me_client *me_cl;
328 const uuid_le *uuid = &res->client_properties.protocol_name;
329
330 mei_me_cl_rm_by_uuid(dev, uuid);
331
332 me_cl = kzalloc(sizeof(struct mei_me_client), GFP_KERNEL);
333 if (!me_cl)
334 return -ENOMEM;
335
336 mei_me_cl_init(me_cl);
337
338 me_cl->props = res->client_properties;
339 me_cl->client_id = res->me_addr;
340 me_cl->mei_flow_ctrl_creds = 0;
341
342 mei_me_cl_add(dev, me_cl);
343
344 return 0;
345}
346
347/**
348 * mei_hbm_add_cl_resp - send response to fw on client add request
349 *
350 * @dev: the device structure
351 * @addr: me address
352 * @status: response status
353 *
354 * Return: 0 on success and < 0 on failure
355 */
356static int mei_hbm_add_cl_resp(struct mei_device *dev, u8 addr, u8 status)
357{
358 struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
359 struct hbm_add_client_response *resp;
360 const size_t len = sizeof(struct hbm_add_client_response);
361 int ret;
362
363 dev_dbg(dev->dev, "adding client response\n");
364
365 resp = (struct hbm_add_client_response *)dev->wr_msg.data;
366
367 mei_hbm_hdr(mei_hdr, len);
368 memset(resp, 0, sizeof(struct hbm_add_client_response));
369
370 resp->hbm_cmd = MEI_HBM_ADD_CLIENT_RES_CMD;
371 resp->me_addr = addr;
372 resp->status = status;
373
374 ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
375 if (ret)
376 dev_err(dev->dev, "add client response write failed: ret = %d\n",
377 ret);
378 return ret;
379}
380
381/**
382 * mei_hbm_fw_add_cl_req - request from the fw to add a client
383 *
384 * @dev: the device structure
385 * @req: add client request
386 *
387 * Return: 0 on success and < 0 on failure
388 */
389static int mei_hbm_fw_add_cl_req(struct mei_device *dev,
390 struct hbm_add_client_request *req)
391{
392 int ret;
393 u8 status = MEI_HBMS_SUCCESS;
394
395 BUILD_BUG_ON(sizeof(struct hbm_add_client_request) !=
396 sizeof(struct hbm_props_response));
397
398 ret = mei_hbm_me_cl_add(dev, (struct hbm_props_response *)req);
399 if (ret)
400 status = !MEI_HBMS_SUCCESS;
401
402 return mei_hbm_add_cl_resp(dev, req->me_addr, status);
403}
404
405/**
406 * mei_hbm_cl_notify_req - send notification request
407 *
408 * @dev: the device structure
409 * @cl: a client to disconnect from
410 * @start: true for start false for stop
411 *
412 * Return: 0 on success and -EIO on write failure
413 */
414int mei_hbm_cl_notify_req(struct mei_device *dev,
415 struct mei_cl *cl, u8 start)
416{
417
418 struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
419 struct hbm_notification_request *req;
420 const size_t len = sizeof(struct hbm_notification_request);
421 int ret;
422
423 mei_hbm_hdr(mei_hdr, len);
424 mei_hbm_cl_hdr(cl, MEI_HBM_NOTIFY_REQ_CMD, dev->wr_msg.data, len);
425
426 req = (struct hbm_notification_request *)dev->wr_msg.data;
427 req->start = start;
428
429 ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
430 if (ret)
431 dev_err(dev->dev, "notify request failed: ret = %d\n", ret);
432
433 return ret;
434}
435
436/**
437 * notify_res_to_fop - convert notification response to the proper
438 * notification FOP
439 *
440 * @cmd: client notification start response command
441 *
442 * Return: MEI_FOP_NOTIFY_START or MEI_FOP_NOTIFY_STOP;
443 */
444static inline enum mei_cb_file_ops notify_res_to_fop(struct mei_hbm_cl_cmd *cmd)
445{
446 struct hbm_notification_response *rs =
447 (struct hbm_notification_response *)cmd;
448
449 return mei_cl_notify_req2fop(rs->start);
450}
451
452/**
453 * mei_hbm_cl_notify_start_res - update the client state according
454 * notify start response
455 *
456 * @dev: the device structure
457 * @cl: mei host client
458 * @cmd: client notification start response command
459 */
460static void mei_hbm_cl_notify_start_res(struct mei_device *dev,
461 struct mei_cl *cl,
462 struct mei_hbm_cl_cmd *cmd)
463{
464 struct hbm_notification_response *rs =
465 (struct hbm_notification_response *)cmd;
466
467 cl_dbg(dev, cl, "hbm: notify start response status=%d\n", rs->status);
468
469 if (rs->status == MEI_HBMS_SUCCESS ||
470 rs->status == MEI_HBMS_ALREADY_STARTED) {
471 cl->notify_en = true;
472 cl->status = 0;
473 } else {
474 cl->status = -EINVAL;
475 }
476}
477
478/**
479 * mei_hbm_cl_notify_stop_res - update the client state according
480 * notify stop response
481 *
482 * @dev: the device structure
483 * @cl: mei host client
484 * @cmd: client notification stop response command
485 */
486static void mei_hbm_cl_notify_stop_res(struct mei_device *dev,
487 struct mei_cl *cl,
488 struct mei_hbm_cl_cmd *cmd)
489{
490 struct hbm_notification_response *rs =
491 (struct hbm_notification_response *)cmd;
492
493 cl_dbg(dev, cl, "hbm: notify stop response status=%d\n", rs->status);
494
495 if (rs->status == MEI_HBMS_SUCCESS ||
496 rs->status == MEI_HBMS_NOT_STARTED) {
497 cl->notify_en = false;
498 cl->status = 0;
499 } else {
500 /* TODO: spec is not clear yet about other possible issues */
501 cl->status = -EINVAL;
502 }
503}
504
505/**
506 * mei_hbm_cl_notify - signal notification event
507 *
508 * @dev: the device structure
509 * @cmd: notification client message
510 */
511static void mei_hbm_cl_notify(struct mei_device *dev,
512 struct mei_hbm_cl_cmd *cmd)
513{
514 struct mei_cl *cl;
515
516 cl = mei_hbm_cl_find_by_cmd(dev, cmd);
517 if (cl)
518 mei_cl_notify(cl);
519}
520
521/**
522 * mei_hbm_prop_req - request property for a single client
523 *
524 * @dev: the device structure
525 *
526 * Return: 0 on success and < 0 on failure
527 */
528
529static int mei_hbm_prop_req(struct mei_device *dev)
530{
531
532 struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
533 struct hbm_props_request *prop_req;
534 const size_t len = sizeof(struct hbm_props_request);
535 unsigned long next_client_index;
536 int ret;
537
538 next_client_index = find_next_bit(dev->me_clients_map, MEI_CLIENTS_MAX,
539 dev->me_client_index);
540
541 /* We got all client properties */
542 if (next_client_index == MEI_CLIENTS_MAX) {
543 dev->hbm_state = MEI_HBM_STARTED;
544 schedule_work(&dev->init_work);
545
546 return 0;
547 }
548
549 mei_hbm_hdr(mei_hdr, len);
550 prop_req = (struct hbm_props_request *)dev->wr_msg.data;
551
552 memset(prop_req, 0, sizeof(struct hbm_props_request));
553
554 prop_req->hbm_cmd = HOST_CLIENT_PROPERTIES_REQ_CMD;
555 prop_req->me_addr = next_client_index;
556
557 ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
558 if (ret) {
559 dev_err(dev->dev, "properties request write failed: ret = %d\n",
560 ret);
561 return ret;
562 }
563
564 dev->init_clients_timer = MEI_CLIENTS_INIT_TIMEOUT;
565 dev->me_client_index = next_client_index;
566
567 return 0;
568}
569
570/*
571 * mei_hbm_pg - sends pg command
572 *
573 * @dev: the device structure
574 * @pg_cmd: the pg command code
575 *
576 * Return: -EIO on write failure
577 * -EOPNOTSUPP if the operation is not supported by the protocol
578 */
579int mei_hbm_pg(struct mei_device *dev, u8 pg_cmd)
580{
581 struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
582 struct hbm_power_gate *req;
583 const size_t len = sizeof(struct hbm_power_gate);
584 int ret;
585
586 if (!dev->hbm_f_pg_supported)
587 return -EOPNOTSUPP;
588
589 mei_hbm_hdr(mei_hdr, len);
590
591 req = (struct hbm_power_gate *)dev->wr_msg.data;
592 memset(req, 0, len);
593 req->hbm_cmd = pg_cmd;
594
595 ret = mei_write_message(dev, mei_hdr, dev->wr_msg.data);
596 if (ret)
597 dev_err(dev->dev, "power gate command write failed.\n");
598 return ret;
599}
600EXPORT_SYMBOL_GPL(mei_hbm_pg);
601
602/**
603 * mei_hbm_stop_req - send stop request message
604 *
605 * @dev: mei device
606 *
607 * Return: -EIO on write failure
608 */
609static int mei_hbm_stop_req(struct mei_device *dev)
610{
611 struct mei_msg_hdr *mei_hdr = &dev->wr_msg.hdr;
612 struct hbm_host_stop_request *req =
613 (struct hbm_host_stop_request *)dev->wr_msg.data;
614 const size_t len = sizeof(struct hbm_host_stop_request);
615
616 mei_hbm_hdr(mei_hdr, len);
617
618 memset(req, 0, len);
619 req->hbm_cmd = HOST_STOP_REQ_CMD;
620 req->reason = DRIVER_STOP_REQUEST;
621
622 return mei_write_message(dev, mei_hdr, dev->wr_msg.data);
623}
624
625/**
626 * mei_hbm_cl_flow_control_req - sends flow control request.
627 *
628 * @dev: the device structure
629 * @cl: client info
630 *
631 * Return: -EIO on write failure
632 */
633int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl)
634{
635 const size_t len = sizeof(struct hbm_flow_control);
636
637 cl_dbg(dev, cl, "sending flow control\n");
638 return mei_hbm_cl_write(dev, cl, MEI_FLOW_CONTROL_CMD, len);
639}
640
641/**
642 * mei_hbm_add_single_flow_creds - adds single buffer credentials.
643 *
644 * @dev: the device structure
645 * @flow: flow control.
646 *
647 * Return: 0 on success, < 0 otherwise
648 */
649static int mei_hbm_add_single_flow_creds(struct mei_device *dev,
650 struct hbm_flow_control *flow)
651{
652 struct mei_me_client *me_cl;
653 int rets;
654
655 me_cl = mei_me_cl_by_id(dev, flow->me_addr);
656 if (!me_cl) {
657 dev_err(dev->dev, "no such me client %d\n",
658 flow->me_addr);
659 return -ENOENT;
660 }
661
662 if (WARN_ON(me_cl->props.single_recv_buf == 0)) {
663 rets = -EINVAL;
664 goto out;
665 }
666
667 me_cl->mei_flow_ctrl_creds++;
668 dev_dbg(dev->dev, "recv flow ctrl msg ME %d (single) creds = %d.\n",
669 flow->me_addr, me_cl->mei_flow_ctrl_creds);
670
671 rets = 0;
672out:
673 mei_me_cl_put(me_cl);
674 return rets;
675}
676
677/**
678 * mei_hbm_cl_flow_control_res - flow control response from me
679 *
680 * @dev: the device structure
681 * @flow_control: flow control response bus message
682 */
683static void mei_hbm_cl_flow_control_res(struct mei_device *dev,
684 struct hbm_flow_control *flow_control)
685{
686 struct mei_cl *cl;
687
688 if (!flow_control->host_addr) {
689 /* single receive buffer */
690 mei_hbm_add_single_flow_creds(dev, flow_control);
691 return;
692 }
693
694 cl = mei_hbm_cl_find_by_cmd(dev, flow_control);
695 if (cl) {
696 cl->mei_flow_ctrl_creds++;
697 cl_dbg(dev, cl, "flow control creds = %d.\n",
698 cl->mei_flow_ctrl_creds);
699 }
700}
701
702
703/**
704 * mei_hbm_cl_disconnect_req - sends disconnect message to fw.
705 *
706 * @dev: the device structure
707 * @cl: a client to disconnect from
708 *
709 * Return: -EIO on write failure
710 */
711int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl)
712{
713 const size_t len = sizeof(struct hbm_client_connect_request);
714
715 return mei_hbm_cl_write(dev, cl, CLIENT_DISCONNECT_REQ_CMD, len);
716}
717
718/**
719 * mei_hbm_cl_disconnect_rsp - sends disconnect respose to the FW
720 *
721 * @dev: the device structure
722 * @cl: a client to disconnect from
723 *
724 * Return: -EIO on write failure
725 */
726int mei_hbm_cl_disconnect_rsp(struct mei_device *dev, struct mei_cl *cl)
727{
728 const size_t len = sizeof(struct hbm_client_connect_response);
729
730 return mei_hbm_cl_write(dev, cl, CLIENT_DISCONNECT_RES_CMD, len);
731}
732
733/**
734 * mei_hbm_cl_disconnect_res - update the client state according
735 * disconnect response
736 *
737 * @dev: the device structure
738 * @cl: mei host client
739 * @cmd: disconnect client response host bus message
740 */
741static void mei_hbm_cl_disconnect_res(struct mei_device *dev, struct mei_cl *cl,
742 struct mei_hbm_cl_cmd *cmd)
743{
744 struct hbm_client_connect_response *rs =
745 (struct hbm_client_connect_response *)cmd;
746
747 cl_dbg(dev, cl, "hbm: disconnect response status=%d\n", rs->status);
748
749 if (rs->status == MEI_CL_DISCONN_SUCCESS)
750 cl->state = MEI_FILE_DISCONNECT_REPLY;
751 cl->status = 0;
752}
753
754/**
755 * mei_hbm_cl_connect_req - send connection request to specific me client
756 *
757 * @dev: the device structure
758 * @cl: a client to connect to
759 *
760 * Return: -EIO on write failure
761 */
762int mei_hbm_cl_connect_req(struct mei_device *dev, struct mei_cl *cl)
763{
764 const size_t len = sizeof(struct hbm_client_connect_request);
765
766 return mei_hbm_cl_write(dev, cl, CLIENT_CONNECT_REQ_CMD, len);
767}
768
769/**
770 * mei_hbm_cl_connect_res - update the client state according
771 * connection response
772 *
773 * @dev: the device structure
774 * @cl: mei host client
775 * @cmd: connect client response host bus message
776 */
777static void mei_hbm_cl_connect_res(struct mei_device *dev, struct mei_cl *cl,
778 struct mei_hbm_cl_cmd *cmd)
779{
780 struct hbm_client_connect_response *rs =
781 (struct hbm_client_connect_response *)cmd;
782
783 cl_dbg(dev, cl, "hbm: connect response status=%s\n",
784 mei_cl_conn_status_str(rs->status));
785
786 if (rs->status == MEI_CL_CONN_SUCCESS)
787 cl->state = MEI_FILE_CONNECTED;
788 else {
789 cl->state = MEI_FILE_DISCONNECT_REPLY;
790 if (rs->status == MEI_CL_CONN_NOT_FOUND)
791 mei_me_cl_del(dev, cl->me_cl);
792 }
793 cl->status = mei_cl_conn_status_to_errno(rs->status);
794}
795
796/**
797 * mei_hbm_cl_res - process hbm response received on behalf
798 * an client
799 *
800 * @dev: the device structure
801 * @rs: hbm client message
802 * @fop_type: file operation type
803 */
804static void mei_hbm_cl_res(struct mei_device *dev,
805 struct mei_hbm_cl_cmd *rs,
806 enum mei_cb_file_ops fop_type)
807{
808 struct mei_cl *cl;
809 struct mei_cl_cb *cb, *next;
810
811 cl = NULL;
812 list_for_each_entry_safe(cb, next, &dev->ctrl_rd_list.list, list) {
813
814 cl = cb->cl;
815
816 if (cb->fop_type != fop_type)
817 continue;
818
819 if (mei_hbm_cl_addr_equal(cl, rs)) {
820 list_del_init(&cb->list);
821 break;
822 }
823 }
824
825 if (!cl)
826 return;
827
828 switch (fop_type) {
829 case MEI_FOP_CONNECT:
830 mei_hbm_cl_connect_res(dev, cl, rs);
831 break;
832 case MEI_FOP_DISCONNECT:
833 mei_hbm_cl_disconnect_res(dev, cl, rs);
834 break;
835 case MEI_FOP_NOTIFY_START:
836 mei_hbm_cl_notify_start_res(dev, cl, rs);
837 break;
838 case MEI_FOP_NOTIFY_STOP:
839 mei_hbm_cl_notify_stop_res(dev, cl, rs);
840 break;
841 default:
842 return;
843 }
844
845 cl->timer_count = 0;
846 wake_up(&cl->wait);
847}
848
849
850/**
851 * mei_hbm_fw_disconnect_req - disconnect request initiated by ME firmware
852 * host sends disconnect response
853 *
854 * @dev: the device structure.
855 * @disconnect_req: disconnect request bus message from the me
856 *
857 * Return: -ENOMEM on allocation failure
858 */
859static int mei_hbm_fw_disconnect_req(struct mei_device *dev,
860 struct hbm_client_connect_request *disconnect_req)
861{
862 struct mei_cl *cl;
863 struct mei_cl_cb *cb;
864
865 cl = mei_hbm_cl_find_by_cmd(dev, disconnect_req);
866 if (cl) {
867 cl_dbg(dev, cl, "fw disconnect request received\n");
868 cl->state = MEI_FILE_DISCONNECTING;
869 cl->timer_count = 0;
870
871 cb = mei_io_cb_init(cl, MEI_FOP_DISCONNECT_RSP, NULL);
872 if (!cb)
873 return -ENOMEM;
874 cl_dbg(dev, cl, "add disconnect response as first\n");
875 list_add(&cb->list, &dev->ctrl_wr_list.list);
876 }
877 return 0;
878}
879
880/**
881 * mei_hbm_config_features - check what hbm features and commands
882 * are supported by the fw
883 *
884 * @dev: the device structure
885 */
886static void mei_hbm_config_features(struct mei_device *dev)
887{
888 /* Power Gating Isolation Support */
889 dev->hbm_f_pg_supported = 0;
890 if (dev->version.major_version > HBM_MAJOR_VERSION_PGI)
891 dev->hbm_f_pg_supported = 1;
892
893 if (dev->version.major_version == HBM_MAJOR_VERSION_PGI &&
894 dev->version.minor_version >= HBM_MINOR_VERSION_PGI)
895 dev->hbm_f_pg_supported = 1;
896
897 if (dev->version.major_version >= HBM_MAJOR_VERSION_DC)
898 dev->hbm_f_dc_supported = 1;
899
900 /* disconnect on connect timeout instead of link reset */
901 if (dev->version.major_version >= HBM_MAJOR_VERSION_DOT)
902 dev->hbm_f_dot_supported = 1;
903
904 /* Notification Event Support */
905 if (dev->version.major_version >= HBM_MAJOR_VERSION_EV)
906 dev->hbm_f_ev_supported = 1;
907}
908
909/**
910 * mei_hbm_version_is_supported - checks whether the driver can
911 * support the hbm version of the device
912 *
913 * @dev: the device structure
914 * Return: true if driver can support hbm version of the device
915 */
916bool mei_hbm_version_is_supported(struct mei_device *dev)
917{
918 return (dev->version.major_version < HBM_MAJOR_VERSION) ||
919 (dev->version.major_version == HBM_MAJOR_VERSION &&
920 dev->version.minor_version <= HBM_MINOR_VERSION);
921}
922
923/**
924 * mei_hbm_dispatch - bottom half read routine after ISR to
925 * handle the read bus message cmd processing.
926 *
927 * @dev: the device structure
928 * @hdr: header of bus message
929 *
930 * Return: 0 on success and < 0 on failure
931 */
932int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr)
933{
934 struct mei_bus_message *mei_msg;
935 struct hbm_host_version_response *version_res;
936 struct hbm_props_response *props_res;
937 struct hbm_host_enum_response *enum_res;
938 struct hbm_add_client_request *add_cl_req;
939 int ret;
940
941 struct mei_hbm_cl_cmd *cl_cmd;
942 struct hbm_client_connect_request *disconnect_req;
943 struct hbm_flow_control *flow_control;
944
945 /* read the message to our buffer */
946 BUG_ON(hdr->length >= sizeof(dev->rd_msg_buf));
947 mei_read_slots(dev, dev->rd_msg_buf, hdr->length);
948 mei_msg = (struct mei_bus_message *)dev->rd_msg_buf;
949 cl_cmd = (struct mei_hbm_cl_cmd *)mei_msg;
950
951 /* ignore spurious message and prevent reset nesting
952 * hbm is put to idle during system reset
953 */
954 if (dev->hbm_state == MEI_HBM_IDLE) {
955 dev_dbg(dev->dev, "hbm: state is idle ignore spurious messages\n");
956 return 0;
957 }
958
959 switch (mei_msg->hbm_cmd) {
960 case HOST_START_RES_CMD:
961 dev_dbg(dev->dev, "hbm: start: response message received.\n");
962
963 dev->init_clients_timer = 0;
964
965 version_res = (struct hbm_host_version_response *)mei_msg;
966
967 dev_dbg(dev->dev, "HBM VERSION: DRIVER=%02d:%02d DEVICE=%02d:%02d\n",
968 HBM_MAJOR_VERSION, HBM_MINOR_VERSION,
969 version_res->me_max_version.major_version,
970 version_res->me_max_version.minor_version);
971
972 if (version_res->host_version_supported) {
973 dev->version.major_version = HBM_MAJOR_VERSION;
974 dev->version.minor_version = HBM_MINOR_VERSION;
975 } else {
976 dev->version.major_version =
977 version_res->me_max_version.major_version;
978 dev->version.minor_version =
979 version_res->me_max_version.minor_version;
980 }
981
982 if (!mei_hbm_version_is_supported(dev)) {
983 dev_warn(dev->dev, "hbm: start: version mismatch - stopping the driver.\n");
984
985 dev->hbm_state = MEI_HBM_STOPPED;
986 if (mei_hbm_stop_req(dev)) {
987 dev_err(dev->dev, "hbm: start: failed to send stop request\n");
988 return -EIO;
989 }
990 break;
991 }
992
993 mei_hbm_config_features(dev);
994
995 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
996 dev->hbm_state != MEI_HBM_STARTING) {
997 dev_err(dev->dev, "hbm: start: state mismatch, [%d, %d]\n",
998 dev->dev_state, dev->hbm_state);
999 return -EPROTO;
1000 }
1001
1002 if (mei_hbm_enum_clients_req(dev)) {
1003 dev_err(dev->dev, "hbm: start: failed to send enumeration request\n");
1004 return -EIO;
1005 }
1006
1007 wake_up(&dev->wait_hbm_start);
1008 break;
1009
1010 case CLIENT_CONNECT_RES_CMD:
1011 dev_dbg(dev->dev, "hbm: client connect response: message received.\n");
1012 mei_hbm_cl_res(dev, cl_cmd, MEI_FOP_CONNECT);
1013 break;
1014
1015 case CLIENT_DISCONNECT_RES_CMD:
1016 dev_dbg(dev->dev, "hbm: client disconnect response: message received.\n");
1017 mei_hbm_cl_res(dev, cl_cmd, MEI_FOP_DISCONNECT);
1018 break;
1019
1020 case MEI_FLOW_CONTROL_CMD:
1021 dev_dbg(dev->dev, "hbm: client flow control response: message received.\n");
1022
1023 flow_control = (struct hbm_flow_control *) mei_msg;
1024 mei_hbm_cl_flow_control_res(dev, flow_control);
1025 break;
1026
1027 case MEI_PG_ISOLATION_ENTRY_RES_CMD:
1028 dev_dbg(dev->dev, "power gate isolation entry response received\n");
1029 dev->pg_event = MEI_PG_EVENT_RECEIVED;
1030 if (waitqueue_active(&dev->wait_pg))
1031 wake_up(&dev->wait_pg);
1032 break;
1033
1034 case MEI_PG_ISOLATION_EXIT_REQ_CMD:
1035 dev_dbg(dev->dev, "power gate isolation exit request received\n");
1036 dev->pg_event = MEI_PG_EVENT_RECEIVED;
1037 if (waitqueue_active(&dev->wait_pg))
1038 wake_up(&dev->wait_pg);
1039 else
1040 /*
1041 * If the driver is not waiting on this then
1042 * this is HW initiated exit from PG.
1043 * Start runtime pm resume sequence to exit from PG.
1044 */
1045 pm_request_resume(dev->dev);
1046 break;
1047
1048 case HOST_CLIENT_PROPERTIES_RES_CMD:
1049 dev_dbg(dev->dev, "hbm: properties response: message received.\n");
1050
1051 dev->init_clients_timer = 0;
1052
1053 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
1054 dev->hbm_state != MEI_HBM_CLIENT_PROPERTIES) {
1055 dev_err(dev->dev, "hbm: properties response: state mismatch, [%d, %d]\n",
1056 dev->dev_state, dev->hbm_state);
1057 return -EPROTO;
1058 }
1059
1060 props_res = (struct hbm_props_response *)mei_msg;
1061
1062 if (props_res->status) {
1063 dev_err(dev->dev, "hbm: properties response: wrong status = %d %s\n",
1064 props_res->status,
1065 mei_hbm_status_str(props_res->status));
1066 return -EPROTO;
1067 }
1068
1069 mei_hbm_me_cl_add(dev, props_res);
1070
1071 dev->me_client_index++;
1072
1073 /* request property for the next client */
1074 if (mei_hbm_prop_req(dev))
1075 return -EIO;
1076
1077 break;
1078
1079 case HOST_ENUM_RES_CMD:
1080 dev_dbg(dev->dev, "hbm: enumeration response: message received\n");
1081
1082 dev->init_clients_timer = 0;
1083
1084 enum_res = (struct hbm_host_enum_response *) mei_msg;
1085 BUILD_BUG_ON(sizeof(dev->me_clients_map)
1086 < sizeof(enum_res->valid_addresses));
1087 memcpy(dev->me_clients_map, enum_res->valid_addresses,
1088 sizeof(enum_res->valid_addresses));
1089
1090 if (dev->dev_state != MEI_DEV_INIT_CLIENTS ||
1091 dev->hbm_state != MEI_HBM_ENUM_CLIENTS) {
1092 dev_err(dev->dev, "hbm: enumeration response: state mismatch, [%d, %d]\n",
1093 dev->dev_state, dev->hbm_state);
1094 return -EPROTO;
1095 }
1096
1097 dev->hbm_state = MEI_HBM_CLIENT_PROPERTIES;
1098
1099 /* first property request */
1100 if (mei_hbm_prop_req(dev))
1101 return -EIO;
1102
1103 break;
1104
1105 case HOST_STOP_RES_CMD:
1106 dev_dbg(dev->dev, "hbm: stop response: message received\n");
1107
1108 dev->init_clients_timer = 0;
1109
1110 if (dev->hbm_state != MEI_HBM_STOPPED) {
1111 dev_err(dev->dev, "hbm: stop response: state mismatch, [%d, %d]\n",
1112 dev->dev_state, dev->hbm_state);
1113 return -EPROTO;
1114 }
1115
1116 dev->dev_state = MEI_DEV_POWER_DOWN;
1117 dev_info(dev->dev, "hbm: stop response: resetting.\n");
1118 /* force the reset */
1119 return -EPROTO;
1120 break;
1121
1122 case CLIENT_DISCONNECT_REQ_CMD:
1123 dev_dbg(dev->dev, "hbm: disconnect request: message received\n");
1124
1125 disconnect_req = (struct hbm_client_connect_request *)mei_msg;
1126 mei_hbm_fw_disconnect_req(dev, disconnect_req);
1127 break;
1128
1129 case ME_STOP_REQ_CMD:
1130 dev_dbg(dev->dev, "hbm: stop request: message received\n");
1131 dev->hbm_state = MEI_HBM_STOPPED;
1132 if (mei_hbm_stop_req(dev)) {
1133 dev_err(dev->dev, "hbm: stop request: failed to send stop request\n");
1134 return -EIO;
1135 }
1136 break;
1137
1138 case MEI_HBM_ADD_CLIENT_REQ_CMD:
1139 dev_dbg(dev->dev, "hbm: add client request received\n");
1140 /*
1141 * after the host receives the enum_resp
1142 * message clients may be added or removed
1143 */
1144 if (dev->hbm_state <= MEI_HBM_ENUM_CLIENTS &&
1145 dev->hbm_state >= MEI_HBM_STOPPED) {
1146 dev_err(dev->dev, "hbm: add client: state mismatch, [%d, %d]\n",
1147 dev->dev_state, dev->hbm_state);
1148 return -EPROTO;
1149 }
1150 add_cl_req = (struct hbm_add_client_request *)mei_msg;
1151 ret = mei_hbm_fw_add_cl_req(dev, add_cl_req);
1152 if (ret) {
1153 dev_err(dev->dev, "hbm: add client: failed to send response %d\n",
1154 ret);
1155 return -EIO;
1156 }
1157 dev_dbg(dev->dev, "hbm: add client request processed\n");
1158 break;
1159
1160 case MEI_HBM_NOTIFY_RES_CMD:
1161 dev_dbg(dev->dev, "hbm: notify response received\n");
1162 mei_hbm_cl_res(dev, cl_cmd, notify_res_to_fop(cl_cmd));
1163 break;
1164
1165 case MEI_HBM_NOTIFICATION_CMD:
1166 dev_dbg(dev->dev, "hbm: notification\n");
1167 mei_hbm_cl_notify(dev, cl_cmd);
1168 break;
1169
1170 default:
1171 BUG();
1172 break;
1173
1174 }
1175 return 0;
1176}
1177
Linux kernel - Deliverables
This page took 0.027231 seconds and 5 git commands to generate.