forked from FrameworkComputer/EmbeddedController
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathusb_pd_dpm.c
1539 lines (1333 loc) · 40.9 KB
/
usb_pd_dpm.c
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
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Copyright 2020 The ChromiumOS Authors
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/*
* Device Policy Manager implementation
* Refer to USB PD 3.0 spec, version 2.0, sections 8.2 and 8.3
*/
#include "builtin/assert.h"
#include "charge_state.h"
#include "chipset.h"
#include "compile_time_macros.h"
#include "console.h"
#include "ec_commands.h"
#include "hooks.h"
#include "power.h"
#include "power_button.h"
#include "queue.h"
#include "system.h"
#include "task.h"
#include "tcpm/tcpm.h"
#include "temp_sensor.h"
#include "usb_dp_alt_mode.h"
#include "usb_mode.h"
#include "usb_mux.h"
#include "usb_pd.h"
#include "usb_pd_ap_vdm_control.h"
#include "usb_pd_dpm_sm.h"
#include "usb_pd_pdo.h"
#include "usb_pd_tcpm.h"
#include "usb_pd_timer.h"
#include "usb_pe_sm.h"
#include "usb_tbt_alt_mode.h"
#include "usb_tc_sm.h"
/*
* TODO(b/272518464): Work around coreboot GCC preprocessor bug.
* #line marks the *next* line, so it is off by one.
*/
#line 43
#ifdef CONFIG_ZEPHYR
#include "temp_sensor/temp_sensor.h"
#endif
#ifdef CONFIG_USB_PD_DEBUG_LEVEL
static const enum debug_level dpm_debug_level = CONFIG_USB_PD_DEBUG_LEVEL;
#elif defined(CONFIG_USB_PD_INITIAL_DEBUG_LEVEL)
static enum debug_level dpm_debug_level = CONFIG_USB_PD_INITIAL_DEBUG_LEVEL;
#else
static enum debug_level dpm_debug_level = DEBUG_LEVEL_1;
#endif
#ifdef CONFIG_COMMON_RUNTIME
#define CPRINTF(format, args...) cprintf(CC_USBPD, format, ##args)
#define CPRINTS(format, args...) cprints(CC_USBPD, format, ##args)
#else
#define CPRINTF(format, args...)
#define CPRINTS(format, args...)
#endif
static struct {
/* state machine context */
struct sm_ctx ctx;
atomic_t flags;
uint32_t vdm_req[VDO_MAX_SIZE];
int vdm_req_cnt;
enum tcpci_msg_type req_type;
mutex_t vdm_req_mutex;
enum dpm_pd_button_state pd_button_state;
} dpm[CONFIG_USB_PD_PORT_MAX_COUNT];
__overridable const struct svdm_response svdm_rsp = {
.identity = NULL,
.svids = NULL,
.modes = NULL,
};
/* Tracker for which task is waiting on sysjump prep to finish */
static volatile task_id_t sysjump_task_waiting = TASK_ID_INVALID;
#define DPM_SET_FLAG(port, flag) atomic_or(&dpm[(port)].flags, (flag))
#define DPM_CLR_FLAG(port, flag) atomic_clear_bits(&dpm[(port)].flags, (flag))
#define DPM_CHK_FLAG(port, flag) (dpm[(port)].flags & (flag))
/* Flags for internal DPM state */
#define DPM_FLAG_MODE_ENTRY_DONE BIT(0)
#define DPM_FLAG_EXIT_REQUEST BIT(1)
#define DPM_FLAG_ENTER_DP BIT(2)
#define DPM_FLAG_ENTER_TBT BIT(3)
#define DPM_FLAG_ENTER_USB4 BIT(4)
#define DPM_FLAG_ENTER_ANY \
(DPM_FLAG_ENTER_DP | DPM_FLAG_ENTER_TBT | DPM_FLAG_ENTER_USB4)
#define DPM_FLAG_SEND_VDM_REQ BIT(5)
#define DPM_FLAG_DATA_RESET_DONE BIT(6)
#define DPM_FLAG_PD_BUTTON_PRESSED BIT(7)
#define DPM_FLAG_PD_BUTTON_RELEASED BIT(8)
#define DPM_FLAG_PE_READY BIT(9)
/* List of all Device Policy Manager level states */
enum usb_dpm_state {
/* Normal States */
DPM_WAITING,
DPM_DFP_READY,
DPM_UFP_READY,
DPM_DATA_RESET,
};
/* Forward declare the full list of states. This is indexed by usb_pd_state */
static const struct usb_state dpm_states[];
/* List of human readable state names for console debugging */
__maybe_unused static __const_data const char *const dpm_state_names[] = {
/* Normal States */
[DPM_WAITING] = "DPM Waiting",
[DPM_DFP_READY] = "DPM DFP Ready",
[DPM_UFP_READY] = "DPM UFP Ready",
[DPM_DATA_RESET] = "DPM Data Reset",
};
static enum sm_local_state local_state[CONFIG_USB_PD_PORT_MAX_COUNT];
void dpm_set_debug_level(enum debug_level debug_level)
{
#ifndef CONFIG_USB_PD_DEBUG_LEVEL
dpm_debug_level = debug_level;
#endif
}
/* Set the DPM state machine to a new state. */
static void set_state_dpm(const int port, const enum usb_dpm_state new_state)
{
set_state(port, &dpm[port].ctx, &dpm_states[new_state]);
}
/* Get the current TypeC state. */
__maybe_unused test_export_static enum usb_dpm_state
get_state_dpm(const int port)
{
return dpm[port].ctx.current - &dpm_states[0];
}
static void print_current_state(const int port)
{
CPRINTS("C%d: %s", port, dpm_state_names[get_state_dpm(port)]);
}
#ifdef CONFIG_ZEPHYR
static int init_dpm_mutexes(void)
{
int port;
for (port = 0; port < CONFIG_USB_PD_PORT_MAX_COUNT; port++) {
k_mutex_init(&dpm[port].vdm_req_mutex);
}
return 0;
}
SYS_INIT(init_dpm_mutexes, POST_KERNEL, 50);
#endif /* CONFIG_ZEPHYR */
void pd_prepare_sysjump(void)
{
#ifndef CONFIG_ZEPHYR
int i;
/* Exit modes before sysjump so we can cleanly enter again later */
for (i = 0; i < board_get_usb_pd_port_count(); i++) {
/*
* If the port is not capable of alternate mode, then there's no
* need to send the event.
*/
if (!pd_alt_mode_capable(i))
continue;
sysjump_task_waiting = task_get_current();
task_set_event(PD_PORT_TO_TASK_ID(i), PD_EVENT_SYSJUMP);
task_wait_event_mask(TASK_EVENT_SYSJUMP_READY, -1);
sysjump_task_waiting = TASK_ID_INVALID;
}
#endif /* CONFIG_ZEPHYR */
}
void notify_sysjump_ready(void)
{
/*
* If event was set from pd_prepare_sysjump, wake the
* task waiting on us to complete.
*/
if (sysjump_task_waiting != TASK_ID_INVALID)
task_set_event(sysjump_task_waiting, TASK_EVENT_SYSJUMP_READY);
}
/*
* TODO(b/270409939): Refactor this function
*/
int pd_dfp_exit_mode(int port, enum tcpci_msg_type type, uint16_t svid,
int opos)
{
/*
* Empty svid signals we should reset DFP VDM state by exiting all
* entered modes then clearing state. This occurs when we've
* disconnected or for hard reset.
*/
if (!svid) {
if (IS_ENABLED(CONFIG_USB_PD_DP_MODE) && dp_is_active(port))
svdm_exit_dp_mode(port);
pd_dfp_mode_init(port);
}
/*
* Return 0 indicating no message is needed. All modules should be
* handling their SVID-specific cases themselves.
*/
return 0;
}
/*
* Note: this interface is used in board code, but should be obsoleted
* TODO(b/267545470): Fold board DP code into the DP module
*/
int pd_alt_mode(int port, enum tcpci_msg_type type, uint16_t svid)
{
if (svid == USB_SID_DISPLAYPORT && !dp_is_idle(port))
return 1;
else if (IS_ENABLED(CONFIG_USB_PD_TBT_COMPAT_MODE) &&
svid == USB_VID_INTEL && tbt_is_active(port))
return 1;
return -1;
}
void dfp_consume_attention(int port, uint32_t *payload)
{
uint16_t svid = PD_VDO_VID(payload[0]);
if (IS_ENABLED(CONFIG_USB_PD_DP_MODE) && svid == USB_SID_DISPLAYPORT) {
/*
* Attention is only valid after EnterMode, so drop if this is
* out of sequence
*/
if (!dp_is_idle(port))
svdm_dp_attention(port, payload);
}
}
__overridable bool board_is_tbt_usb4_port(int port)
{
return true;
}
enum ec_status pd_request_vdm(int port, const uint32_t *data, int vdo_count,
enum tcpci_msg_type tx_type)
{
mutex_lock(&dpm[port].vdm_req_mutex);
/* Only one VDM REQ message may be pending */
if (DPM_CHK_FLAG(port, DPM_FLAG_SEND_VDM_REQ)) {
mutex_unlock(&dpm[port].vdm_req_mutex);
return EC_RES_BUSY;
}
/* VDM header is required and we cannot exceed standard message size*/
if (!vdo_count || vdo_count > VDO_MAX_SIZE) {
mutex_unlock(&dpm[port].vdm_req_mutex);
return EC_RES_INVALID_PARAM;
}
/* SVDM Attention message must be 1 or 2 VDOs in length */
if (PD_VDO_SVDM(data[0]) && (PD_VDO_CMD(data[0]) == CMD_ATTENTION) &&
vdo_count > PD_ATTENTION_MAX_VDO) {
mutex_unlock(&dpm[port].vdm_req_mutex);
return EC_RES_INVALID_PARAM;
}
/* Save contents of VDM REQ message */
memcpy(dpm[port].vdm_req, data, vdo_count * sizeof(uint32_t));
dpm[port].vdm_req_cnt = vdo_count;
dpm[port].req_type = tx_type;
/*
* Indicate to DPM that a REQ message needs to be sent. This flag
* will be cleared when the REQ message is sent to the policy
* engine (VDM:Attention), or when the reply is received (all others).
*/
DPM_SET_FLAG(port, DPM_FLAG_SEND_VDM_REQ);
mutex_unlock(&dpm[port].vdm_req_mutex);
return EC_RES_SUCCESS;
}
void dpm_clear_vdm_request(int port)
{
DPM_CLR_FLAG(port, DPM_FLAG_SEND_VDM_REQ);
}
bool dpm_check_vdm_request(int port)
{
return DPM_CHK_FLAG(port, DPM_FLAG_SEND_VDM_REQ);
}
enum ec_status pd_request_enter_mode(int port, enum typec_mode mode)
{
if (port >= board_get_usb_pd_port_count())
return EC_RES_INVALID_PARAM;
/* Only one enter request may be active at a time. */
if (DPM_CHK_FLAG(port, DPM_FLAG_ENTER_DP | DPM_FLAG_ENTER_TBT |
DPM_FLAG_ENTER_USB4))
return EC_RES_BUSY;
if (IS_ENABLED(CONFIG_USB_PD_DP_MODE) && mode == TYPEC_MODE_DP) {
if (dp_is_idle(port))
dp_init(port);
DPM_SET_FLAG(port, DPM_FLAG_ENTER_DP);
} else if (IS_ENABLED(CONFIG_USB_PD_TBT_COMPAT_MODE) &&
mode == TYPEC_MODE_TBT) {
/* TODO(b/235984702#comment21): Refactor alt mode modules
* to better support mode reentry. */
if (dp_is_idle(port))
dp_init(port);
DPM_SET_FLAG(port, DPM_FLAG_ENTER_TBT);
} else if (IS_ENABLED(CONFIG_USB_PD_USB4) && mode == TYPEC_MODE_USB4) {
DPM_SET_FLAG(port, DPM_FLAG_ENTER_USB4);
} else {
return EC_RES_INVALID_PARAM;
}
DPM_CLR_FLAG(port, DPM_FLAG_MODE_ENTRY_DONE);
DPM_CLR_FLAG(port, DPM_FLAG_EXIT_REQUEST);
DPM_CLR_FLAG(port, DPM_FLAG_DATA_RESET_DONE);
return EC_RES_SUCCESS;
}
void dpm_init(int port)
{
dpm[port].flags = 0;
dpm[port].pd_button_state = DPM_PD_BUTTON_IDLE;
ap_vdm_init(port);
/* Ensure that DPM state machine gets reset */
set_state_dpm(port, DPM_WAITING);
}
void dpm_mode_exit_complete(int port)
{
DPM_CLR_FLAG(port, DPM_FLAG_MODE_ENTRY_DONE | DPM_FLAG_EXIT_REQUEST |
DPM_FLAG_SEND_VDM_REQ);
}
static void dpm_set_mode_entry_done(int port)
{
DPM_SET_FLAG(port, DPM_FLAG_MODE_ENTRY_DONE);
DPM_CLR_FLAG(port, DPM_FLAG_ENTER_DP | DPM_FLAG_ENTER_TBT |
DPM_FLAG_ENTER_USB4);
}
void dpm_set_mode_exit_request(int port)
{
DPM_SET_FLAG(port, DPM_FLAG_EXIT_REQUEST);
DPM_CLR_FLAG(port, DPM_FLAG_DATA_RESET_DONE);
}
void dpm_data_reset_complete(int port)
{
DPM_SET_FLAG(port, DPM_FLAG_DATA_RESET_DONE);
DPM_CLR_FLAG(port, DPM_FLAG_MODE_ENTRY_DONE);
}
void dpm_set_pe_ready(int port, bool enable)
{
/*
* DPM should remain DPM_WAITING state until the PE is in its ready
* state and is able to accept requests from the DPM layer.
*/
if (enable)
DPM_SET_FLAG(port, DPM_FLAG_PE_READY);
else
DPM_CLR_FLAG(port, DPM_FLAG_PE_READY);
}
static void dpm_clear_mode_exit_request(int port)
{
DPM_CLR_FLAG(port, DPM_FLAG_EXIT_REQUEST);
}
/*
* Returns true if the current policy requests that the EC try to enter this
* mode on this port. If the EC is in charge of policy, the answer is always
* yes.
*/
static bool dpm_mode_entry_requested(int port, enum typec_mode mode)
{
/* If the AP isn't controlling policy, the EC is. */
if (!IS_ENABLED(CONFIG_USB_PD_REQUIRE_AP_MODE_ENTRY))
return true;
switch (mode) {
case TYPEC_MODE_DP:
return !!DPM_CHK_FLAG(port, DPM_FLAG_ENTER_DP);
case TYPEC_MODE_TBT:
return !!DPM_CHK_FLAG(port, DPM_FLAG_ENTER_TBT);
case TYPEC_MODE_USB4:
return !!DPM_CHK_FLAG(port, DPM_FLAG_ENTER_USB4);
default:
return false;
}
}
void dpm_vdm_acked(int port, enum tcpci_msg_type type, int vdo_count,
uint32_t *vdm)
{
__maybe_unused const uint16_t svid = PD_VDO_VID(vdm[0]);
assert(vdo_count >= 1);
assert(vdo_count <= VDO_MAX_SIZE);
if (IS_ENABLED(CONFIG_USB_PD_VDM_AP_CONTROL)) {
ap_vdm_acked(port, type, vdo_count, vdm);
return;
}
switch (svid) {
case USB_SID_DISPLAYPORT:
dp_vdm_acked(port, type, vdo_count, vdm);
break;
case USB_VID_INTEL:
/* TODO (http://b/255967867) Can't use the IS_ENABLED macro here because
* __fallthrough fails in clang as unreachable code.
*/
#ifdef CONFIG_USB_PD_TBT_COMPAT_MODE
intel_vdm_acked(port, type, vdo_count, vdm);
break;
#else
__fallthrough;
#endif /* CONFIG_USB_PD_TBT_COMPAT_MODE */
default:
CPRINTS("C%d: Received unexpected VDM ACK for SVID %d", port,
svid);
}
}
void dpm_vdm_naked(int port, enum tcpci_msg_type type, uint16_t svid,
uint8_t vdm_cmd, uint32_t vdm_header)
{
if (IS_ENABLED(CONFIG_USB_PD_VDM_AP_CONTROL)) {
ap_vdm_naked(port, type, svid, vdm_cmd, vdm_header);
return;
}
switch (svid) {
case USB_SID_DISPLAYPORT:
dp_vdm_naked(port, type, vdm_cmd);
break;
case USB_VID_INTEL:
/* TODO (http://b/255967867) Can't use the IS_ENABLED macro here because
* __fallthrough fails in clang as unreachable code.
*/
#ifdef CONFIG_USB_PD_TBT_COMPAT_MODE
intel_vdm_naked(port, type, vdm_cmd);
break;
#else
__fallthrough;
#endif /* CONFIG_USB_PD_TBT_COMPAT_MODE */
default:
CPRINTS("C%d: Received unexpected VDM NAK for SVID %d", port,
svid);
}
}
static void dpm_send_req_vdm(int port)
{
/* Set up VDM REQ msg that was passed in previously */
if (pd_setup_vdm_request(port, dpm[port].req_type, dpm[port].vdm_req,
dpm[port].vdm_req_cnt) == true)
/* Trigger PE to start a VDM command run */
pd_dpm_request(port, DPM_REQUEST_VDM);
/*
* Clear flag after message is sent to PE layer if it was Attention,
* which generates no reply.
*
* Otherwise, clear flag after message is ACK'd or NAK'd. The flag
* will serve as a guard to indicate that the VDM reply buffer is not
* yet ready to read.
*
*/
if (PD_VDO_SVDM(dpm[port].vdm_req[0]) &&
(PD_VDO_CMD(dpm[port].vdm_req[0]) == CMD_ATTENTION))
DPM_CLR_FLAG(port, DPM_FLAG_SEND_VDM_REQ);
}
void dpm_notify_attention(int port, size_t vdo_objects, uint32_t *buf)
{
/*
* Note: legacy code just assumes 1 VDO, but the spec allows 0
* This should be fine because baked-in EC logic will only be
* handling DP:Attention messages, which are defined to have 1
* VDO
*/
dfp_consume_attention(port, buf);
ap_vdm_attention_enqueue(port, vdo_objects, buf);
}
void dpm_handle_alert(int port, uint32_t ado)
{
if (ado & ADO_EXTENDED_ALERT_EVENT) {
/* Extended Alert */
if (pd_get_data_role(port) == PD_ROLE_DFP &&
(ADO_EXTENDED_ALERT_EVENT_TYPE & ado) ==
ADO_POWER_BUTTON_PRESS) {
DPM_SET_FLAG(port, DPM_FLAG_PD_BUTTON_PRESSED);
} else if (pd_get_data_role(port) == PD_ROLE_DFP &&
(ADO_EXTENDED_ALERT_EVENT_TYPE & ado) ==
ADO_POWER_BUTTON_RELEASE) {
DPM_SET_FLAG(port, DPM_FLAG_PD_BUTTON_RELEASED);
}
}
}
static void dpm_run_pd_button_sm(int port)
{
#ifdef CONFIG_AP_POWER_CONTROL
if (!IS_ENABLED(CONFIG_POWER_BUTTON_X86) &&
!IS_ENABLED(CONFIG_CHIPSET_SC7180) &&
!IS_ENABLED(CONFIG_CHIPSET_SC7280)) {
/* Insufficient chipset API support for USB PD power button. */
DPM_CLR_FLAG(port, DPM_FLAG_PD_BUTTON_PRESSED);
DPM_CLR_FLAG(port, DPM_FLAG_PD_BUTTON_RELEASED);
return;
}
/*
* Check for invalid flag combination. Alerts can only send a press or
* release event at once and only one flag should be set. If press and
* release flags are both set, we cannot know the order they were
* received. Clear the flags, disable the timer and return to an idle
* state.
*/
if (DPM_CHK_FLAG(port, DPM_FLAG_PD_BUTTON_PRESSED) &&
DPM_CHK_FLAG(port, DPM_FLAG_PD_BUTTON_RELEASED)) {
DPM_CLR_FLAG(port, DPM_FLAG_PD_BUTTON_PRESSED |
DPM_FLAG_PD_BUTTON_RELEASED);
pd_timer_disable(port, DPM_TIMER_PD_BUTTON_SHORT_PRESS);
pd_timer_disable(port, DPM_TIMER_PD_BUTTON_LONG_PRESS);
dpm[port].pd_button_state = DPM_PD_BUTTON_IDLE;
return;
}
switch (dpm[port].pd_button_state) {
case DPM_PD_BUTTON_IDLE:
if (DPM_CHK_FLAG(port, DPM_FLAG_PD_BUTTON_PRESSED)) {
pd_timer_enable(port, DPM_TIMER_PD_BUTTON_SHORT_PRESS,
CONFIG_USB_PD_SHORT_PRESS_MAX_MS *
MSEC);
pd_timer_enable(port, DPM_TIMER_PD_BUTTON_LONG_PRESS,
CONFIG_USB_PD_LONG_PRESS_MAX_MS * MSEC);
dpm[port].pd_button_state = DPM_PD_BUTTON_PRESSED;
}
break;
case DPM_PD_BUTTON_PRESSED:
if (DPM_CHK_FLAG(port, DPM_FLAG_PD_BUTTON_PRESSED)) {
pd_timer_enable(port, DPM_TIMER_PD_BUTTON_SHORT_PRESS,
CONFIG_USB_PD_SHORT_PRESS_MAX_MS *
MSEC);
pd_timer_enable(port, DPM_TIMER_PD_BUTTON_LONG_PRESS,
CONFIG_USB_PD_LONG_PRESS_MAX_MS * MSEC);
} else if (pd_timer_is_expired(
port, DPM_TIMER_PD_BUTTON_LONG_PRESS)) {
pd_timer_disable(port, DPM_TIMER_PD_BUTTON_SHORT_PRESS);
pd_timer_disable(port, DPM_TIMER_PD_BUTTON_LONG_PRESS);
dpm[port].pd_button_state = DPM_PD_BUTTON_IDLE;
} else if (DPM_CHK_FLAG(port, DPM_FLAG_PD_BUTTON_RELEASED)) {
if (chipset_in_state(CHIPSET_STATE_ANY_OFF)) {
/*
* Wake chipset on any button press when the
* system is off.
*/
chipset_power_on();
} else if (chipset_in_state(
CHIPSET_STATE_ANY_SUSPEND) ||
chipset_in_state(CHIPSET_STATE_ON)) {
if (pd_timer_is_expired(
port,
DPM_TIMER_PD_BUTTON_SHORT_PRESS)) {
/*
* Shutdown chipset on long USB PD power
* button press.
*/
chipset_force_shutdown(
CHIPSET_SHUTDOWN_BUTTON);
} else {
/*
* Simulate a short power button press
* on short USB PD power button press.
* This will wake the system from
* suspend, or bring up the power UI
* when the system is on.
*/
power_button_simulate_press(
USB_PD_SHORT_BUTTON_PRESS_MS);
}
}
pd_timer_disable(port, DPM_TIMER_PD_BUTTON_SHORT_PRESS);
pd_timer_disable(port, DPM_TIMER_PD_BUTTON_LONG_PRESS);
dpm[port].pd_button_state = DPM_PD_BUTTON_IDLE;
}
break;
}
#endif /* CONFIG_AP_POWER_CONTROL */
/* After checking flags, clear them. */
DPM_CLR_FLAG(port, DPM_FLAG_PD_BUTTON_PRESSED);
DPM_CLR_FLAG(port, DPM_FLAG_PD_BUTTON_RELEASED);
}
/*
* Source-out policy variables and APIs
*
* Priority for the available 3.0 A ports is given in the following order:
* - sink partners which report requiring > 1.5 A in their Sink_Capabilities
*/
/*
* Bitmasks of port numbers in each following category
*
* Note: request bitmasks should be accessed atomically as other ports may alter
* them
*/
static uint32_t max_current_claimed;
K_MUTEX_DEFINE(max_current_claimed_lock);
/* Ports with PD sink needing > 1.5 A */
static atomic_t sink_max_pdo_requested;
/* Ports with FRS source needing > 1.5 A */
static atomic_t source_frs_max_requested;
/* Ports with non-PD sinks, so current requirements are unknown */
static atomic_t non_pd_sink_max_requested;
/* BIST shared test mode */
static bool bist_shared_mode_enabled;
#define LOWEST_PORT(p) __builtin_ctz(p) /* Undefined behavior if p == 0 */
static int count_port_bits(uint32_t bitmask)
{
int i, total = 0;
for (i = 0; i < board_get_usb_pd_port_count(); i++) {
if (bitmask & BIT(i))
total++;
}
return total;
}
/*
* Centralized, mutex-controlled updates to the claimed 3.0 A ports
*/
static void balance_source_ports(void);
DECLARE_DEFERRED(balance_source_ports);
static void balance_source_ports(void)
{
uint32_t removed_ports, new_ports;
static bool deferred_waiting;
if (in_deferred_context())
deferred_waiting = false;
/*
* Ignore balance attempts while we're waiting for a downgraded port to
* finish the downgrade.
*/
if (deferred_waiting)
return;
/*
* Turn off all shared power logic while BIST shared test mode is active
* on the system.
*/
if (bist_shared_mode_enabled)
return;
mutex_lock(&max_current_claimed_lock);
/* Remove any ports which no longer require 3.0 A */
removed_ports = max_current_claimed &
~(sink_max_pdo_requested | source_frs_max_requested |
non_pd_sink_max_requested);
max_current_claimed &= ~removed_ports;
/* Allocate 3.0 A to new PD sink ports that need it */
new_ports = sink_max_pdo_requested & ~max_current_claimed;
while (new_ports) {
int new_max_port = LOWEST_PORT(new_ports);
if (count_port_bits(max_current_claimed) <
CONFIG_USB_PD_3A_PORTS) {
max_current_claimed |= BIT(new_max_port);
typec_select_src_current_limit_rp(new_max_port,
TYPEC_RP_3A0);
} else if (non_pd_sink_max_requested & max_current_claimed) {
/* Always downgrade non-PD ports first */
int rem_non_pd = LOWEST_PORT(non_pd_sink_max_requested &
max_current_claimed);
typec_select_src_current_limit_rp(
rem_non_pd,
typec_get_default_current_limit_rp(rem_non_pd));
max_current_claimed &= ~BIT(rem_non_pd);
/* Wait tSinkAdj before using current */
deferred_waiting = true;
hook_call_deferred(&balance_source_ports_data,
PD_T_SINK_ADJ);
goto unlock;
} else if (source_frs_max_requested & max_current_claimed) {
/* Downgrade lowest FRS port from 3.0 A slot */
int rem_frs = LOWEST_PORT(source_frs_max_requested &
max_current_claimed);
pd_dpm_request(rem_frs, DPM_REQUEST_FRS_DET_DISABLE);
max_current_claimed &= ~BIT(rem_frs);
/* Give 20 ms for the PD task to process DPM flag */
deferred_waiting = true;
hook_call_deferred(&balance_source_ports_data,
20 * MSEC);
goto unlock;
} else {
/* No lower priority ports to downgrade */
goto unlock;
}
new_ports &= ~BIT(new_max_port);
}
/* Allocate 3.0 A to any new FRS ports that need it */
new_ports = source_frs_max_requested & ~max_current_claimed;
while (new_ports) {
int new_frs_port = LOWEST_PORT(new_ports);
if (count_port_bits(max_current_claimed) <
CONFIG_USB_PD_3A_PORTS) {
max_current_claimed |= BIT(new_frs_port);
pd_dpm_request(new_frs_port,
DPM_REQUEST_FRS_DET_ENABLE);
} else if (non_pd_sink_max_requested & max_current_claimed) {
int rem_non_pd = LOWEST_PORT(non_pd_sink_max_requested &
max_current_claimed);
typec_select_src_current_limit_rp(
rem_non_pd,
typec_get_default_current_limit_rp(rem_non_pd));
max_current_claimed &= ~BIT(rem_non_pd);
/* Wait tSinkAdj before using current */
deferred_waiting = true;
hook_call_deferred(&balance_source_ports_data,
PD_T_SINK_ADJ);
goto unlock;
} else {
/* No lower priority ports to downgrade */
goto unlock;
}
new_ports &= ~BIT(new_frs_port);
}
/* Allocate 3.0 A to any non-PD ports which could need it */
new_ports = non_pd_sink_max_requested & ~max_current_claimed;
while (new_ports) {
int new_max_port = LOWEST_PORT(new_ports);
if (count_port_bits(max_current_claimed) <
CONFIG_USB_PD_3A_PORTS) {
max_current_claimed |= BIT(new_max_port);
typec_select_src_current_limit_rp(new_max_port,
TYPEC_RP_3A0);
} else {
/* No lower priority ports to downgrade */
goto unlock;
}
new_ports &= ~BIT(new_max_port);
}
unlock:
mutex_unlock(&max_current_claimed_lock);
}
/* Process port's first Sink_Capabilities PDO for port current consideration */
void dpm_evaluate_sink_fixed_pdo(int port, uint32_t vsafe5v_pdo)
{
/* Verify partner supplied valid vSafe5V fixed object first */
if ((vsafe5v_pdo & PDO_TYPE_MASK) != PDO_TYPE_FIXED)
return;
if (PDO_FIXED_VOLTAGE(vsafe5v_pdo) != 5000)
return;
if (pd_get_power_role(port) == PD_ROLE_SOURCE) {
if (CONFIG_USB_PD_3A_PORTS == 0)
return;
/* Valid PDO to process, so evaluate whether >1.5A is needed */
if (PDO_FIXED_CURRENT(vsafe5v_pdo) <= 1500)
return;
atomic_or(&sink_max_pdo_requested, BIT(port));
} else {
int frs_current = vsafe5v_pdo & PDO_FIXED_FRS_CURR_MASK;
if (!IS_ENABLED(CONFIG_USB_PD_FRS))
return;
/* FRS is only supported in PD 3.0 and higher */
if (pd_get_rev(port, TCPCI_MSG_SOP) == PD_REV20)
return;
if ((vsafe5v_pdo & PDO_FIXED_DUAL_ROLE) && frs_current) {
/* Always enable FRS when 3.0 A is not needed */
if (frs_current == PDO_FIXED_FRS_CURR_DFLT_USB_POWER ||
frs_current == PDO_FIXED_FRS_CURR_1A5_AT_5V) {
pd_dpm_request(port,
DPM_REQUEST_FRS_DET_ENABLE);
return;
}
if (CONFIG_USB_PD_3A_PORTS == 0)
return;
atomic_or(&source_frs_max_requested, BIT(port));
} else {
return;
}
}
balance_source_ports();
}
void dpm_add_non_pd_sink(int port)
{
if (CONFIG_USB_PD_3A_PORTS == 0)
return;
atomic_or(&non_pd_sink_max_requested, BIT(port));
balance_source_ports();
}
void dpm_evaluate_request_rdo(int port, uint32_t rdo)
{
int idx;
int op_ma;
if (CONFIG_USB_PD_3A_PORTS == 0)
return;
idx = RDO_POS(rdo);
/* Check for invalid index */
if (!idx)
return;
op_ma = (rdo >> 10) & 0x3FF;
if ((BIT(port) & sink_max_pdo_requested) && (op_ma <= 150)) {
/*
* sink_max_pdo_requested will be set when we get 5V/3A sink
* capability from port partner. If port partner only request
* 5V/1.5A, we need to provide 5V/1.5A.
*/
atomic_clear_bits(&sink_max_pdo_requested, BIT(port));
balance_source_ports();
}
}
void dpm_remove_sink(int port)
{
if (CONFIG_USB_PD_3A_PORTS == 0)
return;
if (!(BIT(port) & (uint32_t)sink_max_pdo_requested) &&
!(BIT(port) & (uint32_t)non_pd_sink_max_requested))
return;
atomic_clear_bits(&sink_max_pdo_requested, BIT(port));
atomic_clear_bits(&non_pd_sink_max_requested, BIT(port));
/* Restore selected default Rp on the port */
typec_select_src_current_limit_rp(
port, typec_get_default_current_limit_rp(port));
balance_source_ports();
}
void dpm_remove_source(int port)
{
if (CONFIG_USB_PD_3A_PORTS == 0)
return;
if (!IS_ENABLED(CONFIG_USB_PD_FRS))
return;
if (!(BIT(port) & (uint32_t)source_frs_max_requested))
return;
atomic_clear_bits(&source_frs_max_requested, BIT(port));
balance_source_ports();
}
void dpm_bist_shared_mode_enter(int port)
{
/*
* From 6.4.3.3.1 BIST Shared Test Mode Entry:
*
* "When any Master Port in a shared capacity group receives a BIST
* Message with a BIST Shared Test Mode Entry BIST Data Object, while
* in the PE_SRC_Ready State, the UUT Shall enter a compliance test
* mode where the maximum source capability is always offered on every
* port, regardless of the availability of shared power i.e. all shared
* power management is disabled.
* . . .
* On entering this mode, the UUT Shall send a new Source_Capabilities
* Message from each Port in the shared capacity group within
* tBISTSharedTestMode. The Tester will not exceed the shared capacity
* during this mode."
*/
/* Shared mode is unnecessary without at least one 3.0 A port */
if (CONFIG_USB_PD_3A_PORTS == 0)
return;
/* Enter mode only if this port had been in PE_SRC_Ready */
if (pd_get_power_role(port) != PD_ROLE_SOURCE)
return;
bist_shared_mode_enabled = true;
/* Trigger new source caps on all source ports */
for (int i = 0; i < board_get_usb_pd_port_count(); i++) {
if (pd_get_power_role(i) == PD_ROLE_SOURCE)
typec_select_src_current_limit_rp(i, TYPEC_RP_3A0);
}
}
void dpm_bist_shared_mode_exit(int port)
{
/*
* From 6.4.3.3.2 BIST Shared Test Mode Exit:
*
* "Upon receipt of a BIST Message, with a BIST Shared Test Mode Exit
* BIST Data Object, the UUT Shall return a GoodCRC Message and Shall
* exit the BIST Shared Capacity Test Mode.
* . . .
* On exiting the mode, the UUT May send a new Source_Capabilities
* Message to each port in the shared capacity group or the UUT May
* perform ErrorRecovery on each port."
*/
/* Shared mode is unnecessary without at least one 3.0 A port */
if (CONFIG_USB_PD_3A_PORTS == 0)
return;
/* Do nothing if Exit was received with no Entry */
if (!bist_shared_mode_enabled)
return;
bist_shared_mode_enabled = false;
/* Declare error recovery bankruptcy */
for (int i = 0; i < board_get_usb_pd_port_count(); i++) {
pd_set_error_recovery(i);
}
}
/*
* Note: all ports receive the 1.5 A source offering until they are found to
* match a criteria on the 3.0 A priority list (ex. through sink capability
* probing), at which point they will be offered a new 3.0 A source capability.
*
* All ports must be offered our full capability while in BIST shared test mode.
*/
__overridable int dpm_get_source_pdo(const uint32_t **src_pdo, const int port)
{
/* Max PDO may not exist on boards which don't offer 3 A */
#if CONFIG_USB_PD_3A_PORTS > 0
if (max_current_claimed & BIT(port) || bist_shared_mode_enabled) {
*src_pdo = pd_src_pdo_max;
return pd_src_pdo_max_cnt;
}
#endif
*src_pdo = pd_src_pdo;
return pd_src_pdo_cnt;
}
int dpm_get_source_current(const int port)
{
if (pd_get_power_role(port) == PD_ROLE_SINK)
return 0;