1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
|
/* Copyright 2018 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/* IPC module for ISH */
/**
* IPC - Inter Processor Communication
* -----------------------------------
*
* IPC is a bi-directional doorbell based message passing interface sans
* session and transport layers, between hardware blocks. ISH uses IPC to
* communicate with the Host, PMC (Power Management Controller), CSME
* (Converged Security and Manageability Engine), Audio, Graphics and ISP.
*
* Both the initiator and target ends each have a 32-bit doorbell register and
* 128-byte message regions. In addition, the following register pairs help in
* synchronizing IPC.
*
* - Peripheral Interrupt Status Register (PISR)
* - Peripheral Interrupt Mask Register (PIMR)
* - Doorbell Clear Status Register (DB CSR)
*/
#include "registers.h"
#include "console.h"
#include "task.h"
#include "util.h"
#include "ipc_heci.h"
#include "ish_fwst.h"
#include "queue.h"
#include "hooks.h"
#ifdef IPC_HECI_DEBUG
#define CPUTS(outstr) cputs(CC_LPC, outstr)
#define CPRINTS(format, args...) cprints(CC_LPC, format, ## args)
#define CPRINTF(format, args...) cprintf(CC_LPC, format, ## args)
#else
#define CPUTS(outstr)
#define CPRINTS(format, args...)
#define CPRINTF(format, args...)
#endif
/*
* comminucation protocol is defined in Linux Documentation
* <kernel_root>/Documentation/hid/intel-ish-hid.txt
*/
/* MNG commands */
/* The ipc_mng_task manages IPC link. It should be the highest priority */
#define MNG_RX_CMPL_ENABLE 0
#define MNG_RX_CMPL_DISABLE 1
#define MNG_RX_CMPL_INDICATION 2
#define MNG_RESET_NOTIFY 3
#define MNG_RESET_NOTIFY_ACK 4
#define MNG_SYNC_FW_CLOCK 5
#define MNG_ILLEGAL_CMD 0xFF
/* Peripheral Interrupt Satus Register */
#define IPC_PISR_HOST2ISH_BIT BIT(0)
#define IPC_PISR_PMC2ISH_BIT BIT(1)
#define IPC_PISR_CSME2ISH_BIT BIT(2)
/* Peripheral Interrupt Mask Register */
#define IPC_PIMR_HOST2ISH_BIT BIT(0)
#define IPC_PIMR_PMC2ISH_BIT BIT(1)
#define IPC_PIMR_CSME2ISH_BIT BIT(2)
#define IPC_PIMR_ISH2HOST_CLR_BIT BIT(11)
#define IPC_PIMR_ISH2PMC_CLR_BIT BIT(12)
#define IPC_PIMR_ISH2CSME_CLR_BIT BIT(13)
/* Peripheral Interrupt DB(DoorBell) Clear Status Register */
#define IPC_DB_CLR_STS_ISH2HOST_BIT BIT(0)
#define IPC_DB_CLR_STS_ISH2ISP_BIT BIT(2)
#define IPC_DB_CLR_STS_ISH2AUDIO_BIT BIT(3)
#define IPC_DB_CLR_STS_ISH2PMC_BIT BIT(8)
#define IPC_DB_CLR_STS_ISH2CSME_BIT BIT(16)
/* Doorbell */
#define IPC_DB_MSG_LENGTH_FIELD 0x3FF
#define IPC_DB_MSG_LENGTH_SHIFT 0
#define IPC_DB_MSG_LENGTH_MASK \
(IPC_DB_MSG_LENGTH_FIELD << IPC_DB_MSG_LENGTH_SHIFT)
#define IPC_DB_PROTOCOL_FIELD 0x0F
#define IPC_DB_PROTOCOL_SHIFT 10
#define IPC_DB_PROTOCOL_MASK (IPC_DB_PROTOCOL_FIELD << IPC_DB_PROTOCOL_SHIFT)
#define IPC_DB_CMD_FIELD 0x0F
#define IPC_DB_CMD_SHIFT 16
#define IPC_DB_CMD_MASK (IPC_DB_CMD_FIELD << IPC_DB_CMD_SHIFT)
#define IPC_DB_BUSY_SHIFT 31
#define IPC_DB_BUSY_MASK BIT(IPC_DB_BUSY_SHIFT)
#define IPC_DB_MSG_LENGTH(drbl) \
(((drbl) & IPC_DB_MSG_LENGTH_MASK) >> IPC_DB_MSG_LENGTH_SHIFT)
#define IPC_DB_PROTOCOL(drbl) \
(((drbl) & IPC_DB_PROTOCOL_MASK) >> IPC_DB_PROTOCOL_SHIFT)
#define IPC_DB_CMD(drbl) \
(((drbl) & IPC_DB_CMD_MASK) >> IPC_DB_CMD_SHIFT)
#define IPC_DB_BUSY(drbl) (!!((drbl) & IPC_DB_BUSY_MASK))
#define IPC_BUILD_DB(length, proto, cmd, busy) \
(((busy) << IPC_DB_BUSY_SHIFT) | ((cmd) << IPC_DB_CMD_SHIFT) | \
((proto) << IPC_DB_PROTOCOL_SHIFT) | \
((length) << IPC_DB_MSG_LENGTH_SHIFT))
#define IPC_BUILD_MNG_DB(cmd, length) \
IPC_BUILD_DB(length, IPC_PROTOCOL_MNG, cmd, 1)
#define IPC_BUILD_HECI_DB(length) \
IPC_BUILD_DB(length, IPC_PROTOCOL_HECI, 0, 1)
#define IPC_MSG_MAX_SIZE 0x80
#define IPC_HOST_MSG_QUEUE_SIZE 8
#define IPC_PMC_MSG_QUEUE_SIZE 2
#define IPC_HANDLE_PEER_ID_SHIFT 4
#define IPC_HANDLE_PROTOCOL_SHIFT 0
#define IPC_HANDLE_PROTOCOL_MASK 0x0F
#define IPC_BUILD_HANDLE(peer_id, protocol) \
((ipc_handle_t)(((peer_id) << IPC_HANDLE_PEER_ID_SHIFT) | (protocol)))
#define IPC_BUILD_MNG_HANDLE(peer_id) \
IPC_BUILD_HANDLE((peer_id), IPC_PROTOCOL_MNG)
#define IPC_BUILD_HOST_MNG_HANDLE() IPC_BUILD_MNG_HANDLE(IPC_PEER_ID_HOST)
#define IPC_HANDLE_PEER_ID(handle) \
((uint32_t)(handle) >> IPC_HANDLE_PEER_ID_SHIFT)
#define IPC_HANDLE_PROTOCOL(handle) \
((uint32_t)(handle) & IPC_HANDLE_PROTOCOL_MASK)
#define IPC_IS_VALID_HANDLE(handle) \
(IPC_HANDLE_PEER_ID(handle) < IPC_PEERS_COUNT && \
IPC_HANDLE_PROTOCOL(handle) < IPC_PROTOCOL_COUNT)
struct ipc_msg {
uint32_t drbl;
uint8_t payload[IPC_MSG_MAX_SIZE];
} __packed;
struct ipc_rst_payload {
uint16_t reset_id;
uint16_t reserved;
};
struct ipc_oob_msg {
uint32_t address;
uint32_t length;
};
struct ipc_msg_event {
task_id_t task_id;
uint32_t event;
uint8_t enabled;
};
/*
* IPC interface context
* This is per-IPC context.
*/
struct ipc_if_ctx {
uint32_t in_msg_reg;
uint32_t out_msg_reg;
uint32_t in_drbl_reg;
uint32_t out_drbl_reg;
uint32_t clr_busy_bit;
uint32_t pimr_2ish_bit;
uint32_t pimr_2host_clearing_bit;
uint8_t irq_in;
uint8_t irq_clr;
uint16_t reset_id;
struct ipc_msg_event msg_events[IPC_PROTOCOL_COUNT];
struct mutex lock;
struct mutex write_lock;
struct queue tx_queue;
uint8_t is_tx_ipc_busy;
uint8_t initialized;
};
/* list of peer contexts */
static struct ipc_if_ctx ipc_peer_ctxs[IPC_PEERS_COUNT] = {
[IPC_PEER_ID_HOST] = {
.in_msg_reg = IPC_HOST2ISH_MSG_REGS,
.out_msg_reg = IPC_ISH2HOST_MSG_REGS,
.in_drbl_reg = IPC_HOST2ISH_DOORBELL,
.out_drbl_reg = IPC_ISH2HOST_DOORBELL,
.clr_busy_bit = IPC_DB_CLR_STS_ISH2HOST_BIT,
.pimr_2ish_bit = IPC_PIMR_HOST2ISH_BIT,
.pimr_2host_clearing_bit = IPC_PIMR_ISH2HOST_CLR_BIT,
.irq_in = ISH_IPC_HOST2ISH_IRQ,
.irq_clr = ISH_IPC_ISH2HOST_CLR_IRQ,
.tx_queue = QUEUE_NULL(IPC_HOST_MSG_QUEUE_SIZE, struct ipc_msg),
},
/* Other peers (PMC, CSME, etc) to be added when required */
};
static inline struct ipc_if_ctx *ipc_get_if_ctx(const uint32_t peer_id)
{
return &ipc_peer_ctxs[peer_id];
}
static inline struct ipc_if_ctx *ipc_handle_to_if_ctx(const ipc_handle_t handle)
{
return ipc_get_if_ctx(IPC_HANDLE_PEER_ID(handle));
}
static inline void ipc_enable_pimr_db_interrupt(const struct ipc_if_ctx *ctx)
{
REG32(IPC_PIMR) |= ctx->pimr_2ish_bit;
}
static inline void ipc_disable_pimr_db_interrupt(const struct ipc_if_ctx *ctx)
{
REG32(IPC_PIMR) &= ~ctx->pimr_2ish_bit;
}
static inline void ipc_enable_pimr_clearing_interrupt(
const struct ipc_if_ctx *ctx)
{
REG32(IPC_PIMR) |= ctx->pimr_2host_clearing_bit;
}
static inline void ipc_disable_pimr_clearing_interrupt(
const struct ipc_if_ctx *ctx)
{
REG32(IPC_PIMR) &= ~ctx->pimr_2host_clearing_bit;
}
static void write_payload_and_ring_drbl(const struct ipc_if_ctx *ctx,
uint32_t drbl,
const uint8_t *payload,
size_t payload_size)
{
uint32_t msg_idx = 0;
/* write in 32-bits unit */
while (payload_size >= sizeof(uint32_t)) {
REG32(ctx->out_msg_reg + msg_idx) =
*(uint32_t *)(payload + msg_idx);
msg_idx += sizeof(uint32_t);
payload_size -= sizeof(uint32_t);
}
/* write leftovers in 8-bits unit */
while (payload_size) {
REG8(ctx->out_msg_reg + msg_idx) =
*(uint8_t *)(payload + msg_idx);
msg_idx++;
payload_size--;
}
REG32(ctx->out_drbl_reg) = drbl;
}
static int ipc_write_raw(struct ipc_if_ctx *ctx, uint32_t drbl,
const uint8_t *payload, size_t payload_size)
{
struct queue *q = &ctx->tx_queue;
struct ipc_msg *msg;
size_t tail, space;
int res = 0;
mutex_lock(&ctx->write_lock);
ipc_disable_pimr_clearing_interrupt(ctx);
if (ctx->is_tx_ipc_busy) {
space = queue_space(q);
if (space) {
tail = q->state->tail & (q->buffer_units - 1);
msg = (struct ipc_msg *)q->buffer + tail;
msg->drbl = drbl;
memcpy(msg->payload, payload, payload_size);
queue_advance_tail(q, 1);
} else {
CPRINTS("tx queue is full\n");
res = -IPC_ERR_TX_QUEUE_FULL;
}
ipc_enable_pimr_clearing_interrupt(ctx);
goto write_unlock;
}
ipc_enable_pimr_clearing_interrupt(ctx);
ctx->is_tx_ipc_busy = 1;
write_payload_and_ring_drbl(ctx, drbl, payload, payload_size);
write_unlock:
mutex_unlock(&ctx->write_lock);
return res;
}
static int ipc_send_reset_notify(const ipc_handle_t handle)
{
struct ipc_rst_payload *ipc_rst;
struct ipc_if_ctx *ctx;
struct ipc_msg msg;
ctx = ipc_handle_to_if_ctx(handle);
ctx->reset_id = (uint16_t)ish_fwst_get_reset_id();
ipc_rst = (struct ipc_rst_payload *)msg.payload;
ipc_rst->reset_id = ctx->reset_id;
msg.drbl = IPC_BUILD_MNG_DB(MNG_RESET_NOTIFY, sizeof(*ipc_rst));
ipc_write_raw(ctx, msg.drbl, msg.payload, IPC_DB_MSG_LENGTH(msg.drbl));
return 0;
}
static int ipc_send_cmpl_indication(struct ipc_if_ctx *ctx)
{
struct ipc_msg msg;
msg.drbl = IPC_BUILD_MNG_DB(MNG_RX_CMPL_INDICATION, 0);
ipc_write_raw(ctx, msg.drbl, msg.payload, IPC_DB_MSG_LENGTH(msg.drbl));
return 0;
}
static int ipc_get_protocol_data(const struct ipc_if_ctx *ctx,
const uint32_t protocol,
uint8_t *buf, const size_t buf_size)
{
int len = 0, payload_size;
uint8_t *src = NULL, *dest = NULL;
struct ipc_msg *msg;
uint32_t drbl_val;
drbl_val = REG32(ctx->in_drbl_reg);
payload_size = IPC_DB_MSG_LENGTH(drbl_val);
if (payload_size > IPC_MAX_PAYLOAD_SIZE) {
CPRINTS("invalid msg : payload is too big\n");
return -IPC_ERR_INVALID_MSG;
}
switch (protocol) {
case IPC_PROTOCOL_HECI:
/* copy only payload which is a heci packet */
len = payload_size;
break;
case IPC_PROTOCOL_MNG:
/* copy including doorbell which forms a ipc packet */
len = payload_size + sizeof(drbl_val);
break;
default:
CPRINTS("protocol %d not supported yet\n", protocol);
break;
}
if (len > buf_size) {
CPRINTS("buffer is smaller than payload\n");
return -IPC_ERR_TOO_SMALL_BUFFER;
}
CPRINTF("ipc p=%d, db=0x%0x, payload_size=%d\n", protocol, drbl_val,
IPC_DB_MSG_LENGTH(drbl_val));
switch (protocol) {
case IPC_PROTOCOL_HECI:
src = (uint8_t *)ctx->in_msg_reg;
dest = buf;
break;
case IPC_PROTOCOL_MNG:
src = (uint8_t *)ctx->in_msg_reg;
msg = (struct ipc_msg *)buf;
msg->drbl = drbl_val;
dest = msg->payload;
break;
default :
break;
}
if (src && dest)
memcpy(dest, src, payload_size);
return len;
}
static void set_pimr_and_send_rx_complete(struct ipc_if_ctx *ctx)
{
ipc_enable_pimr_db_interrupt(ctx);
ipc_send_cmpl_indication(ctx);
}
static void handle_msg_recv_interrupt(const uint32_t peer_id)
{
struct ipc_if_ctx *ctx;
uint32_t drbl_val, payload_size, protocol, invalid_msg = 0;
ctx = ipc_get_if_ctx(peer_id);
ipc_disable_pimr_db_interrupt(ctx);
drbl_val = REG32(ctx->in_drbl_reg);
protocol = IPC_DB_PROTOCOL(drbl_val);
payload_size = IPC_DB_MSG_LENGTH(drbl_val);
if (payload_size > IPC_MSG_MAX_SIZE)
invalid_msg = 1;
if (!ctx->msg_events[protocol].enabled)
invalid_msg = 2;
if (!invalid_msg) {
/* send event to task */
task_set_event(ctx->msg_events[protocol].task_id,
ctx->msg_events[protocol].event, 0);
} else {
CPRINTS("discard msg : %d\n", invalid_msg);
REG32(ctx->in_drbl_reg) = 0;
set_pimr_and_send_rx_complete(ctx);
}
}
static void handle_busy_clear_interrupt(const uint32_t peer_id)
{
struct ipc_if_ctx *ctx;
struct ipc_msg *msg;
struct queue *q;
size_t head;
ctx = ipc_get_if_ctx(peer_id);
/*
* No need to use sync mechanism here since the accesing the queue
* happens only when either this IRQ is disabled or
* in ISR context(here) of this IRQ.
*/
if (!queue_is_empty(&ctx->tx_queue)) {
q = &ctx->tx_queue;
head = q->state->head & (q->buffer_units - 1);
msg = (struct ipc_msg *)(q->buffer + head * q->unit_bytes);
write_payload_and_ring_drbl(ctx, msg->drbl, msg->payload,
IPC_DB_MSG_LENGTH(msg->drbl));
queue_advance_head(q, 1);
} else {
ctx->is_tx_ipc_busy = 0;
}
REG32(IPC_BUSY_CLEAR) = ctx->clr_busy_bit;
}
/**
* IPC interrupts are received by the FW when a) Host SW rings doorbell and
* b) when Host SW clears doorbell busy bit [31].
*
* Doorbell Register (DB) bits
* ----+-------+--------+-----------+--------+------------+--------------------
* 31 | 30 29 | 28-20 |19 18 17 16| 15 14 | 13 12 11 10| 9 8 7 6 5 4 3 2 1 0
* ----+-------+--------+-----------+--------+------------+--------------------
* Busy|Options|Reserved| Command |Reserved| Protocol | Message Length
* ----+-------+--------+-----------+--------+------------+--------------------
*
* ISH Peripheral Interrupt Status Register:
* Bit 0 - If set, indicates interrupt was caused by setting Host2ISH DB
*
* ISH Peripheral Interrupt Mask Register
* Bit 0 - If set, mask interrupt caused by Host2ISH DB
*
* ISH Peripheral DB Clear Status Register
* Bit 0 - If set, indicates interrupt was caused by clearing Host2ISH DB
*/
static void ipc_host2ish_isr(void)
{
uint32_t pisr = REG32(IPC_PISR);
uint32_t pimr = REG32(IPC_PIMR);
#ifdef CHIP_FAMILY_ISH5
/*
* TODO(b/122364080): Remove this code once proper power management is
* in place for ISH.
*
* Ensure that the host IPC power is requested after getting an
* interrupt otherwise the resume message will never get delivered (via
* host ipc communication). Resume is where we would like to restore all
* power settings, but that is too late for this power request.
*/
PMU_VNN_REQ = VNN_REQ_IPC_HOST_WRITE & ~PMU_VNN_REQ;
#endif
if ((pisr & IPC_PISR_HOST2ISH_BIT) && (pimr & IPC_PIMR_HOST2ISH_BIT))
handle_msg_recv_interrupt(IPC_PEER_ID_HOST);
}
DECLARE_IRQ(ISH_IPC_HOST2ISH_IRQ, ipc_host2ish_isr);
static void ipc_host2ish_busy_clear_isr(void)
{
uint32_t busy_clear = REG32(IPC_BUSY_CLEAR);
uint32_t pimr = REG32(IPC_PIMR);
if ((busy_clear & IPC_DB_CLR_STS_ISH2HOST_BIT) &&
(pimr & IPC_PIMR_ISH2HOST_CLR_BIT))
handle_busy_clear_interrupt(IPC_PEER_ID_HOST);
}
DECLARE_IRQ(ISH_IPC_ISH2HOST_CLR_IRQ, ipc_host2ish_busy_clear_isr);
int ipc_write(const ipc_handle_t handle, const void *buf, const size_t buf_size)
{
int ret;
struct ipc_if_ctx *ctx;
uint32_t drbl = 0;
const uint8_t *payload = NULL;
int payload_size;
uint32_t protocol;
if (!IPC_IS_VALID_HANDLE(handle))
return -EC_ERROR_INVAL;
protocol = IPC_HANDLE_PROTOCOL(handle);
ctx = ipc_handle_to_if_ctx(handle);
if (ctx->initialized == 0) {
CPRINTS("open_ipc() for the peer is never called\n");
return -EC_ERROR_INVAL;
}
if (!ctx->msg_events[protocol].enabled) {
CPRINTS("call open_ipc() for the protocol first\n");
return -EC_ERROR_INVAL;
}
switch (protocol) {
case IPC_PROTOCOL_BOOT:
break;
case IPC_PROTOCOL_HECI:
drbl = IPC_BUILD_HECI_DB(buf_size);
payload = buf;
break;
case IPC_PROTOCOL_MCTP:
break;
case IPC_PROTOCOL_MNG:
drbl = ((struct ipc_msg *)buf)->drbl;
payload = ((struct ipc_msg *)buf)->payload;
break;
case IPC_PROTOCOL_ECP:
/* TODO : EC protocol */
break;
}
payload_size = IPC_DB_MSG_LENGTH(drbl);
if (payload_size > IPC_MSG_MAX_SIZE) {
/* too much input */
return -EC_ERROR_OVERFLOW;
}
ret = ipc_write_raw(ctx, drbl, payload, payload_size);
if (ret)
return ret;
return buf_size;
}
ipc_handle_t ipc_open(const enum ipc_peer_id peer_id,
const enum ipc_protocol protocol,
const uint32_t event)
{
struct ipc_if_ctx *ctx;
if (protocol >= IPC_PROTOCOL_COUNT ||
peer_id >= IPC_PEERS_COUNT)
return IPC_INVALID_HANDLE;
ctx = ipc_get_if_ctx(peer_id);
mutex_lock(&ctx->lock);
if (ctx->msg_events[protocol].enabled) {
mutex_unlock(&ctx->lock);
return IPC_INVALID_HANDLE;
}
ctx->msg_events[protocol].task_id = task_get_current();
ctx->msg_events[protocol].enabled = 1;
ctx->msg_events[protocol].event = event;
/* For HECI protocol, set HECI UP status when IPC link is ready */
if (peer_id == IPC_PEER_ID_HOST &&
protocol == IPC_PROTOCOL_HECI && ish_fwst_is_ilup_set())
ish_fwst_set_hup();
if (ctx->initialized == 0) {
task_enable_irq(ctx->irq_in);
task_enable_irq(ctx->irq_clr);
ipc_enable_pimr_db_interrupt(ctx);
ipc_enable_pimr_clearing_interrupt(ctx);
ctx->initialized = 1;
}
mutex_unlock(&ctx->lock);
return IPC_BUILD_HANDLE(peer_id, protocol);
}
static void handle_mng_commands(const ipc_handle_t handle,
const struct ipc_msg *msg)
{
struct ipc_rst_payload *ipc_rst;
struct ipc_if_ctx *ctx;
uint32_t peer_id = IPC_HANDLE_PEER_ID(handle);
ctx = ipc_handle_to_if_ctx(handle);
switch (IPC_DB_CMD(msg->drbl)) {
case MNG_RX_CMPL_ENABLE:
case MNG_RX_CMPL_DISABLE:
case MNG_RX_CMPL_INDICATION:
case MNG_RESET_NOTIFY:
CPRINTS("msg not handled %d\n", IPC_DB_CMD(msg->drbl));
break;
case MNG_RESET_NOTIFY_ACK:
ipc_rst = (struct ipc_rst_payload *)msg->payload;
if (peer_id == IPC_PEER_ID_HOST &&
ipc_rst->reset_id == ctx->reset_id) {
ish_fwst_set_ilup();
if (ctx->msg_events[IPC_PROTOCOL_HECI].enabled)
ish_fwst_set_hup();
}
break;
case MNG_SYNC_FW_CLOCK:
/* TODO: if there's data to host requires timestamp
* we need to implement this
*/
CPRINTS("sync fw clock");
break;
}
}
static int do_ipc_read(struct ipc_if_ctx *ctx, const uint32_t protocol,
uint8_t *buf, const size_t buf_size)
{
int len;
len = ipc_get_protocol_data(ctx, protocol, buf, buf_size);
REG32(ctx->in_drbl_reg) = 0;
set_pimr_and_send_rx_complete(ctx);
return len;
}
static int ipc_check_read_validity(const struct ipc_if_ctx *ctx,
const uint32_t protocol)
{
if (ctx->initialized == 0)
return -EC_ERROR_INVAL;
if (!ctx->msg_events[protocol].enabled)
return -EC_ERROR_INVAL;
/* ipc_read() should be called by the same task called ipc_open() */
if (ctx->msg_events[protocol].task_id != task_get_current())
return -IPC_ERR_INVALID_TASK;
return 0;
}
/*
* ipc_read should be called by the same task context which called ipc_open()
*/
int ipc_read(const ipc_handle_t handle, void *buf, const size_t buf_size,
int timeout_us)
{
struct ipc_if_ctx *ctx;
uint32_t events, protocol, drbl_protocol, drbl_val;
int ret;
if (!IPC_IS_VALID_HANDLE(handle))
return -EC_ERROR_INVAL;
protocol = IPC_HANDLE_PROTOCOL(handle);
ctx = ipc_handle_to_if_ctx(handle);
ret = ipc_check_read_validity(ctx, protocol);
if (ret)
return ret;
if (timeout_us) {
events = task_wait_event_mask(ctx->msg_events[protocol].event,
timeout_us);
if (events & TASK_EVENT_TIMER)
return -EC_ERROR_TIMEOUT;
if (!(events & ctx->msg_events[protocol].event))
return -EC_ERROR_UNKNOWN;
} else {
/* check if msg for the protocol is available */
drbl_val = REG32(ctx->in_drbl_reg);
drbl_protocol = IPC_DB_PROTOCOL(drbl_val);
if (!(protocol == drbl_protocol) || !IPC_DB_BUSY(drbl_val))
return -IPC_ERR_MSG_NOT_AVAILABLE;
}
return do_ipc_read(ctx, protocol, buf, buf_size);
}
/* event flag for MNG msg */
#define EVENT_FLAG_BIT_MNG_MSG TASK_EVENT_CUSTOM(1)
/*
* This task handles MNG messages
*/
void ipc_mng_task(void)
{
int payload_size;
struct ipc_msg msg;
ipc_handle_t handle;
#ifdef CHIP_FAMILY_ISH5
/*
* TODO(b/122364080): Remove this code once proper power management is
* in place for ISH.
*
* Ensure that power for host IPCs is requested and ack'ed
*/
PMU_VNN_REQ = VNN_REQ_IPC_HOST_WRITE & ~PMU_VNN_REQ;
while (!(PMU_VNN_REQ_ACK & PMU_VNN_REQ_ACK_STATUS))
continue;
#endif
handle = ipc_open(IPC_PEER_ID_HOST, IPC_PROTOCOL_MNG,
EVENT_FLAG_BIT_MNG_MSG);
ASSERT(handle != IPC_INVALID_HANDLE);
ipc_send_reset_notify(handle);
while (1) {
payload_size = ipc_read(handle, &msg, sizeof(msg), -1);
/* allow doorbell with any payload */
if (payload_size < 0) {
CPRINTS("ipc_read error. discard msg\n");
continue; /* TODO: retry several and exit */
}
/* handle MNG commands */
handle_mng_commands(handle, &msg);
}
}
void ipc_init(void)
{
int i;
struct ipc_if_ctx *ctx;
for (i = 0; i < IPC_PEERS_COUNT; i++) {
ctx = ipc_get_if_ctx(i);
queue_init(&ctx->tx_queue);
}
}
DECLARE_HOOK(HOOK_INIT, ipc_init, HOOK_PRIO_DEFAULT);
|