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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
|
/* Copyright 2019 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.
*/
#include "atomic.h"
#include "battery.h"
#include "battery_smart.h"
#include "charge_manager.h"
#include "charge_state.h"
#include "common.h"
#include "console.h"
#include "dps.h"
#include "driver/tcpm/tcpm.h"
#include "ec_commands.h"
#include "hooks.h"
#include "host_command.h"
#include "stdbool.h"
#include "system.h"
#include "task.h"
#include "tcpm/tcpm.h"
#include "util.h"
#include "usb_charge.h"
#include "usb_common.h"
#include "usb_dp_alt_mode.h"
#include "usb_mode.h"
#include "usb_mux.h"
#include "usb_pd_dpm.h"
#include "usb_pd_policy.h"
#include "usb_pd.h"
#include "usb_pd_tcpm.h"
#include "usb_pd_timer.h"
#include "usb_pe_private.h"
#include "usb_pe_sm.h"
#include "usb_tbt_alt_mode.h"
#include "usb_prl_sm.h"
#include "usb_tc_sm.h"
#include "usb_emsg.h"
#include "usb_sm.h"
#include "usbc_ppc.h"
/*
* USB Policy Engine Sink / Source module
*
* Based on Revision 3.0, Version 1.2 of
* the USB Power Delivery Specification.
*/
#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
#define CPRINTF_LX(x, format, args...) \
do { \
if (pe_debug_level >= x) \
CPRINTF(format, ## args); \
} while (0)
#define CPRINTF_L1(format, args...) CPRINTF_LX(1, format, ## args)
#define CPRINTF_L2(format, args...) CPRINTF_LX(2, format, ## args)
#define CPRINTF_L3(format, args...) CPRINTF_LX(3, format, ## args)
#define CPRINTS_LX(x, format, args...) \
do { \
if (pe_debug_level >= x) \
CPRINTS(format, ## args); \
} while (0)
#define CPRINTS_L1(format, args...) CPRINTS_LX(1, format, ## args)
#define CPRINTS_L2(format, args...) CPRINTS_LX(2, format, ## args)
#define CPRINTS_L3(format, args...) CPRINTS_LX(3, format, ## args)
#define PE_SET_FN(port, _fn) atomic_or(&pe[port].flags, \
BIT(_fn))
#define PE_CLR_FN(port, _fn) atomic_clear_bits(&pe[port].flags, \
BIT(_fn))
#define PE_CHK_FN(port, _fn) (pe[port].flags & BIT(_fn))
#define PE_SET_FLAG(port, name) PE_SET_FN(port, (name ## _FN))
#define PE_CLR_FLAG(port, name) PE_CLR_FN(port, (name ## _FN))
#define PE_CHK_FLAG(port, name) PE_CHK_FN(port, (name ## _FN))
#define PE_SET_MASK(port, mask) atomic_or(&pe[port].flags, (mask))
#define PE_CLR_MASK(port, mask) atomic_clear_bits(&pe[port].flags, (mask))
#define PE_CHK_MASK(port, mask) (pe[port].flags & (mask))
/*
* These macros SET, CLEAR, and CHECK, a DPM (Device Policy Manager)
* Request. The Requests are listed in usb_pe_sm.h.
*/
#define PE_SET_DPM_REQUEST(port, req) atomic_or(&pe[port].dpm_request, (req))
#define PE_CLR_DPM_REQUEST(port, req) \
atomic_clear_bits(&pe[port].dpm_request, (req))
#define PE_CHK_DPM_REQUEST(port, req) (pe[port].dpm_request & (req))
/* Message flags which should not persist on returning to ready state */
#define PE_MASK_READY_CLR (BIT(PE_FLAGS_LOCALLY_INITIATED_AMS_FN) | \
BIT(PE_FLAGS_MSG_DISCARDED_FN) | \
BIT(PE_FLAGS_VDM_REQUEST_TIMEOUT_FN) | \
BIT(PE_FLAGS_INTERRUPTIBLE_AMS_FN))
/*
* Combination to check whether a reply to a message was received. Our message
* should have sent (i.e. not been discarded) and a partner message is ready to
* process.
*
* When chunking is disabled (ex. for PD 2.0), these flags will set
* on the same run cycle. With chunking, received message will take an
* additional cycle to be flagged.
*/
#define PE_CHK_REPLY(port) (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED) && \
!PE_CHK_FLAG(port, PE_FLAGS_MSG_DISCARDED))
/* 6.7.3 Hard Reset Counter */
#define N_HARD_RESET_COUNT 2
/* 6.7.4 Capabilities Counter */
#define N_CAPS_COUNT 25
/* 6.7.5 Discover Identity Counter */
/*
* NOTE: The Protocol Layer tries to send a message 3 time before giving up,
* so a Discover Identity SOP' message will be sent 3*6 = 18 times (slightly
* less than spec maximum of 20). This counter applies only to cable plug
* discovery.
*/
#define N_DISCOVER_IDENTITY_COUNT 6
/*
* It is permitted to send SOP' Discover Identity messages before a PD contract
* is in place. However, this is only beneficial if the cable powers up quickly
* solely from VCONN. Limit the number of retries without a contract to
* ensure we attempt some cable discovery after a contract is in place.
*/
#define N_DISCOVER_IDENTITY_PRECONTRACT_LIMIT 2
/*
* Once this limit of SOP' Discover Identity messages has been set, downgrade
* to PD 2.0 in case the cable is non-compliant about GoodCRC-ing higher
* revisions. This limit should be higher than the precontract limit.
*/
#define N_DISCOVER_IDENTITY_PD3_0_LIMIT 4
/*
* tDiscoverIdentity is only defined while an explicit contract is in place, so
* extend the interval between retries pre-contract.
*/
#define PE_T_DISCOVER_IDENTITY_NO_CONTRACT (200*MSEC)
/*
* Only VCONN source can communicate with the cable plug. Hence, try VCONN swap
* 3 times before giving up.
*
* Note: This is not a part of power delivery specification
*/
#define N_VCONN_SWAP_COUNT 3
/*
* Counter to track how many times to attempt SRC to SNK PR swaps before giving
* up.
*
* Note: This is not a part of power delivery specification
*/
#define N_SNK_SRC_PR_SWAP_COUNT 5
/*
* ChromeOS policy:
* For PD2.0, We must be DFP before sending Discover Identity message
* to the port partner. Attempt to DR SWAP from UFP to DFP
* N_DR_SWAP_ATTEMPT_COUNT times before giving up on sending a
* Discover Identity message.
*/
#define N_DR_SWAP_ATTEMPT_COUNT 5
#define TIMER_DISABLED 0xffffffffffffffff /* Unreachable time in future */
/*
* The time that we allow the port partner to send any messages after an
* explicit contract is established. 200ms was chosen somewhat arbitrarily as
* it should be long enough for sources to decide to send a message if they were
* going to, but not so long that a "low power charger connected" notification
* would be shown in the chrome OS UI. Setting t0o large a delay can cause
* problems if the PD discovery time exceeds 1s (tAMETimeout)
*/
#define SRC_SNK_READY_HOLD_OFF_US (200 * MSEC)
/*
* Function pointer to a Structured Vendor Defined Message (SVDM) response
* function defined in the board's usb_pd_policy.c file.
*/
typedef int (*svdm_rsp_func)(int port, uint32_t *payload);
/* List of all Policy Engine level states */
enum usb_pe_state {
/* Super States */
PE_PRS_FRS_SHARED,
PE_VDM_SEND_REQUEST,
/* Normal States */
PE_SRC_STARTUP,
PE_SRC_DISCOVERY,
PE_SRC_SEND_CAPABILITIES,
PE_SRC_NEGOTIATE_CAPABILITY,
PE_SRC_TRANSITION_SUPPLY,
PE_SRC_READY,
PE_SRC_DISABLED,
PE_SRC_CAPABILITY_RESPONSE,
PE_SRC_HARD_RESET,
PE_SRC_HARD_RESET_RECEIVED,
PE_SRC_TRANSITION_TO_DEFAULT,
PE_SNK_STARTUP,
PE_SNK_DISCOVERY,
PE_SNK_WAIT_FOR_CAPABILITIES,
PE_SNK_EVALUATE_CAPABILITY,
PE_SNK_SELECT_CAPABILITY,
PE_SNK_READY,
PE_SNK_HARD_RESET,
PE_SNK_TRANSITION_TO_DEFAULT,
PE_SNK_GIVE_SINK_CAP,
PE_SNK_GET_SOURCE_CAP,
PE_SNK_TRANSITION_SINK,
PE_SEND_SOFT_RESET,
PE_SOFT_RESET,
PE_SEND_NOT_SUPPORTED,
PE_SRC_PING,
PE_DRS_EVALUATE_SWAP,
PE_DRS_CHANGE,
PE_DRS_SEND_SWAP,
PE_PRS_SRC_SNK_EVALUATE_SWAP,
PE_PRS_SRC_SNK_TRANSITION_TO_OFF,
PE_PRS_SRC_SNK_ASSERT_RD,
PE_PRS_SRC_SNK_WAIT_SOURCE_ON,
PE_PRS_SRC_SNK_SEND_SWAP,
PE_PRS_SNK_SRC_EVALUATE_SWAP,
PE_PRS_SNK_SRC_TRANSITION_TO_OFF,
PE_PRS_SNK_SRC_ASSERT_RP,
PE_PRS_SNK_SRC_SOURCE_ON,
PE_PRS_SNK_SRC_SEND_SWAP,
PE_VCS_EVALUATE_SWAP,
PE_VCS_SEND_SWAP,
PE_VCS_WAIT_FOR_VCONN_SWAP,
PE_VCS_TURN_ON_VCONN_SWAP,
PE_VCS_TURN_OFF_VCONN_SWAP,
PE_VCS_SEND_PS_RDY_SWAP,
PE_VCS_CBL_SEND_SOFT_RESET,
PE_VDM_IDENTITY_REQUEST_CBL,
PE_INIT_PORT_VDM_IDENTITY_REQUEST,
PE_INIT_VDM_SVIDS_REQUEST,
PE_INIT_VDM_MODES_REQUEST,
PE_VDM_REQUEST_DPM,
PE_VDM_RESPONSE,
PE_HANDLE_CUSTOM_VDM_REQUEST,
PE_WAIT_FOR_ERROR_RECOVERY,
PE_BIST_TX,
PE_DEU_SEND_ENTER_USB,
PE_DR_GET_SINK_CAP,
PE_DR_SNK_GIVE_SOURCE_CAP,
PE_DR_SRC_GET_SOURCE_CAP,
/* PD3.0 only states below here*/
#ifdef CONFIG_USB_PD_DATA_RESET_MSG
/* DFP Data Reset States */
PE_DDR_SEND_DATA_RESET,
PE_DDR_WAIT_FOR_VCONN_OFF,
PE_DDR_PERFORM_DATA_RESET,
#endif /* CONFIG_USB_PD_DATA_RESET_MSG */
PE_FRS_SNK_SRC_START_AMS,
PE_GIVE_BATTERY_CAP,
PE_GIVE_BATTERY_STATUS,
PE_SEND_ALERT,
PE_SRC_CHUNK_RECEIVED,
PE_SNK_CHUNK_RECEIVED,
PE_VCS_FORCE_VCONN,
};
/*
* The result of a previously sent DPM request; used by PE_VDM_SEND_REQUEST to
* indicate to child states when they need to handle a response.
*/
enum vdm_response_result {
/* The parent state is still waiting for a response. */
VDM_RESULT_WAITING,
/*
* The parent state parsed a message, but there is nothing for the child
* to handle, e.g. BUSY.
*/
VDM_RESULT_NO_ACTION,
/* The parent state processed an ACK response. */
VDM_RESULT_ACK,
/*
* The parent state processed a NAK-like response (NAK, Not Supported,
* or response timeout.
*/
VDM_RESULT_NAK,
};
/* Forward declare the full list of states. This is indexed by usb_pe_state */
static const struct usb_state pe_states[];
/*
* We will use DEBUG LABELS if we will be able to print (COMMON RUNTIME)
* and either CONFIG_USB_PD_DEBUG_LEVEL is not defined (no override) or
* we are overriding and the level is not DISABLED.
*
* If we can't print or the CONFIG_USB_PD_DEBUG_LEVEL is defined to be 0
* then the DEBUG LABELS will be removed from the build.
*/
#if defined(CONFIG_COMMON_RUNTIME) && \
(!defined(CONFIG_USB_PD_DEBUG_LEVEL) || \
(CONFIG_USB_PD_DEBUG_LEVEL > 0))
#define USB_PD_DEBUG_LABELS
#endif
/* List of human readable state names for console debugging */
__maybe_unused static __const_data const char * const pe_state_names[] = {
/* Super States */
#ifdef CONFIG_USB_PD_REV30
[PE_PRS_FRS_SHARED] = "SS:PE_PRS_FRS_SHARED",
#endif
[PE_VDM_SEND_REQUEST] = "SS:PE_VDM_Send_Request",
/* Normal States */
[PE_SRC_STARTUP] = "PE_SRC_Startup",
[PE_SRC_DISCOVERY] = "PE_SRC_Discovery",
[PE_SRC_SEND_CAPABILITIES] = "PE_SRC_Send_Capabilities",
[PE_SRC_NEGOTIATE_CAPABILITY] = "PE_SRC_Negotiate_Capability",
[PE_SRC_TRANSITION_SUPPLY] = "PE_SRC_Transition_Supply",
[PE_SRC_READY] = "PE_SRC_Ready",
[PE_SRC_DISABLED] = "PE_SRC_Disabled",
[PE_SRC_CAPABILITY_RESPONSE] = "PE_SRC_Capability_Response",
[PE_SRC_HARD_RESET] = "PE_SRC_Hard_Reset",
[PE_SRC_HARD_RESET_RECEIVED] = "PE_SRC_Hard_Reset_Received",
[PE_SRC_TRANSITION_TO_DEFAULT] = "PE_SRC_Transition_to_default",
[PE_SNK_STARTUP] = "PE_SNK_Startup",
[PE_SNK_DISCOVERY] = "PE_SNK_Discovery",
[PE_SNK_WAIT_FOR_CAPABILITIES] = "PE_SNK_Wait_for_Capabilities",
[PE_SNK_EVALUATE_CAPABILITY] = "PE_SNK_Evaluate_Capability",
[PE_SNK_SELECT_CAPABILITY] = "PE_SNK_Select_Capability",
[PE_SNK_READY] = "PE_SNK_Ready",
[PE_SNK_HARD_RESET] = "PE_SNK_Hard_Reset",
[PE_SNK_TRANSITION_TO_DEFAULT] = "PE_SNK_Transition_to_default",
[PE_SNK_GIVE_SINK_CAP] = "PE_SNK_Give_Sink_Cap",
[PE_SNK_GET_SOURCE_CAP] = "PE_SNK_Get_Source_Cap",
[PE_SNK_TRANSITION_SINK] = "PE_SNK_Transition_Sink",
[PE_SEND_SOFT_RESET] = "PE_Send_Soft_Reset",
[PE_SOFT_RESET] = "PE_Soft_Reset",
[PE_SEND_NOT_SUPPORTED] = "PE_Send_Not_Supported",
[PE_SRC_PING] = "PE_SRC_Ping",
[PE_DRS_EVALUATE_SWAP] = "PE_DRS_Evaluate_Swap",
[PE_DRS_CHANGE] = "PE_DRS_Change",
[PE_DRS_SEND_SWAP] = "PE_DRS_Send_Swap",
[PE_PRS_SRC_SNK_EVALUATE_SWAP] = "PE_PRS_SRC_SNK_Evaluate_Swap",
[PE_PRS_SRC_SNK_TRANSITION_TO_OFF] = "PE_PRS_SRC_SNK_Transition_To_Off",
[PE_PRS_SRC_SNK_ASSERT_RD] = "PE_PRS_SRC_SNK_Assert_Rd",
[PE_PRS_SRC_SNK_WAIT_SOURCE_ON] = "PE_PRS_SRC_SNK_Wait_Source_On",
[PE_PRS_SRC_SNK_SEND_SWAP] = "PE_PRS_SRC_SNK_Send_Swap",
[PE_PRS_SNK_SRC_EVALUATE_SWAP] = "PE_PRS_SNK_SRC_Evaluate_Swap",
[PE_PRS_SNK_SRC_TRANSITION_TO_OFF] = "PE_PRS_SNK_SRC_Transition_To_Off",
[PE_PRS_SNK_SRC_ASSERT_RP] = "PE_PRS_SNK_SRC_Assert_Rp",
[PE_PRS_SNK_SRC_SOURCE_ON] = "PE_PRS_SNK_SRC_Source_On",
[PE_PRS_SNK_SRC_SEND_SWAP] = "PE_PRS_SNK_SRC_Send_Swap",
#ifdef CONFIG_USBC_VCONN
[PE_VCS_EVALUATE_SWAP] = "PE_VCS_Evaluate_Swap",
[PE_VCS_SEND_SWAP] = "PE_VCS_Send_Swap",
[PE_VCS_WAIT_FOR_VCONN_SWAP] = "PE_VCS_Wait_For_Vconn_Swap",
[PE_VCS_TURN_ON_VCONN_SWAP] = "PE_VCS_Turn_On_Vconn_Swap",
[PE_VCS_TURN_OFF_VCONN_SWAP] = "PE_VCS_Turn_Off_Vconn_Swap",
[PE_VCS_SEND_PS_RDY_SWAP] = "PE_VCS_Send_Ps_Rdy_Swap",
[PE_VCS_CBL_SEND_SOFT_RESET] = "PE_VCS_CBL_Send_Soft_Reset",
#endif
[PE_VDM_IDENTITY_REQUEST_CBL] = "PE_VDM_Identity_Request_Cbl",
[PE_INIT_PORT_VDM_IDENTITY_REQUEST] =
"PE_INIT_PORT_VDM_Identity_Request",
[PE_INIT_VDM_SVIDS_REQUEST] = "PE_INIT_VDM_SVIDs_Request",
[PE_INIT_VDM_MODES_REQUEST] = "PE_INIT_VDM_Modes_Request",
[PE_VDM_REQUEST_DPM] = "PE_VDM_Request_DPM",
[PE_VDM_RESPONSE] = "PE_VDM_Response",
[PE_HANDLE_CUSTOM_VDM_REQUEST] = "PE_Handle_Custom_Vdm_Request",
[PE_WAIT_FOR_ERROR_RECOVERY] = "PE_Wait_For_Error_Recovery",
[PE_BIST_TX] = "PE_Bist_TX",
[PE_DEU_SEND_ENTER_USB] = "PE_DEU_Send_Enter_USB",
[PE_DR_GET_SINK_CAP] = "PE_DR_Get_Sink_Cap",
[PE_DR_SNK_GIVE_SOURCE_CAP] = "PE_DR_SNK_Give_Source_Cap",
[PE_DR_SRC_GET_SOURCE_CAP] = "PE_DR_SRC_Get_Source_Cap",
/* PD3.0 only states below here*/
#ifdef CONFIG_USB_PD_REV30
[PE_FRS_SNK_SRC_START_AMS] = "PE_FRS_SNK_SRC_Start_Ams",
#ifdef CONFIG_USB_PD_EXTENDED_MESSAGES
[PE_GIVE_BATTERY_CAP] = "PE_Give_Battery_Cap",
[PE_GIVE_BATTERY_STATUS] = "PE_Give_Battery_Status",
[PE_SEND_ALERT] = "PE_Send_Alert",
#else
[PE_SRC_CHUNK_RECEIVED] = "PE_SRC_Chunk_Received",
[PE_SNK_CHUNK_RECEIVED] = "PE_SNK_Chunk_Received",
#endif
#ifdef CONFIG_USBC_VCONN
[PE_VCS_FORCE_VCONN] = "PE_VCS_Force_Vconn",
#endif
#ifdef CONFIG_USB_PD_DATA_RESET_MSG
[PE_DDR_SEND_DATA_RESET] = "PE_DDR_Send_Data_Reset",
[PE_DDR_WAIT_FOR_VCONN_OFF] = "PE_DDR_Wait_For_VCONN_Off",
[PE_DDR_PERFORM_DATA_RESET] = "PE_DDR_Perform_Data_Reset",
#endif /* CONFIG_USB_PD_DATA_RESET_MSG */
#endif /* CONFIG_USB_PD_REV30 */
};
#ifndef CONFIG_USBC_VCONN
GEN_NOT_SUPPORTED(PE_VCS_EVALUATE_SWAP);
#define PE_VCS_EVALUATE_SWAP PE_VCS_EVALUATE_SWAP_NOT_SUPPORTED
GEN_NOT_SUPPORTED(PE_VCS_SEND_SWAP);
#define PE_VCS_SEND_SWAP PE_VCS_SEND_SWAP_NOT_SUPPORTED
GEN_NOT_SUPPORTED(PE_VCS_WAIT_FOR_VCONN_SWAP);
#define PE_VCS_WAIT_FOR_VCONN_SWAP PE_VCS_WAIT_FOR_VCONN_SWAP_NOT_SUPPORTED
GEN_NOT_SUPPORTED(PE_VCS_TURN_ON_VCONN_SWAP);
#define PE_VCS_TURN_ON_VCONN_SWAP PE_VCS_TURN_ON_VCONN_SWAP_NOT_SUPPORTED
GEN_NOT_SUPPORTED(PE_VCS_TURN_OFF_VCONN_SWAP);
#define PE_VCS_TURN_OFF_VCONN_SWAP PE_VCS_TURN_OFF_VCONN_SWAP_NOT_SUPPORTED
GEN_NOT_SUPPORTED(PE_VCS_SEND_PS_RDY_SWAP);
#define PE_VCS_SEND_PS_RDY_SWAP PE_VCS_SEND_PS_RDY_SWAP_NOT_SUPPORTED
#endif /* CONFIG_USBC_VCONN */
#ifndef CONFIG_USB_PD_REV30
GEN_NOT_SUPPORTED(PE_FRS_SNK_SRC_START_AMS);
#define PE_FRS_SNK_SRC_START_AMS PE_FRS_SNK_SRC_START_AMS_NOT_SUPPORTED
GEN_NOT_SUPPORTED(PE_PRS_FRS_SHARED);
#define PE_PRS_FRS_SHARED PE_PRS_FRS_SHARED_NOT_SUPPORTED
GEN_NOT_SUPPORTED(PE_SRC_CHUNK_RECEIVED);
#define PE_SRC_CHUNK_RECEIVED PE_SRC_CHUNK_RECEIVED_NOT_SUPPORTED
GEN_NOT_SUPPORTED(PE_SNK_CHUNK_RECEIVED);
#define PE_SNK_CHUNK_RECEIVED PE_SNK_CHUNK_RECEIVED_NOT_SUPPORTED
#endif /* CONFIG_USB_PD_REV30 */
#if !defined(CONFIG_USBC_VCONN) || !defined(CONFIG_USB_PD_REV30)
GEN_NOT_SUPPORTED(PE_VCS_FORCE_VCONN);
#define PE_VCS_FORCE_VCONN PE_VCS_FORCE_VCONN_NOT_SUPPORTED
#endif
#ifndef CONFIG_USB_PD_EXTENDED_MESSAGES
GEN_NOT_SUPPORTED(PE_GIVE_BATTERY_CAP);
#define PE_GIVE_BATTERY_CAP PE_GIVE_BATTERY_CAP_NOT_SUPPORTED
GEN_NOT_SUPPORTED(PE_GIVE_BATTERY_STATUS);
#define PE_GIVE_BATTERY_STATUS PE_GIVE_BATTERY_STATUS_NOT_SUPPORTED
GEN_NOT_SUPPORTED(PE_SEND_ALERT);
#define PE_SEND_ALERT PE_SEND_ALERT_NOT_SUPPORTED
#endif /* CONFIG_USB_PD_EXTENDED_MESSAGES */
#ifdef CONFIG_USB_PD_EXTENDED_MESSAGES
GEN_NOT_SUPPORTED(PE_SRC_CHUNK_RECEIVED);
#define PE_SRC_CHUNK_RECEIVED PE_SRC_CHUNK_RECEIVED_NOT_SUPPORTED
GEN_NOT_SUPPORTED(PE_SNK_CHUNK_RECEIVED);
#define PE_SNK_CHUNK_RECEIVED PE_SNK_CHUNK_RECEIVED_NOT_SUPPORTED
#endif /* CONFIG_USB_PD_EXTENDED_MESSAGES */
static enum sm_local_state local_state[CONFIG_USB_PD_PORT_MAX_COUNT];
/*
* Common message send checking
*
* PE_MSG_SEND_PENDING: A message has been requested to be sent. It has
* not been GoodCRCed or Discarded.
* PE_MSG_SEND_COMPLETED: The message that was requested has been sent.
* This will only be returned one time and any other
* request for message send status will just return
* PE_MSG_SENT. This message actually includes both
* The COMPLETED and the SENT bit for easier checking.
* NOTE: PE_MSG_SEND_COMPLETED will only be returned
* a single time, directly after TX_COMPLETE.
* PE_MSG_SENT: The message that was requested to be sent has
* successfully been transferred to the partner.
* PE_MSG_DISCARDED: The message that was requested to be sent was
* discarded. The partner did not receive it.
* NOTE: PE_MSG_DISCARDED will only be returned
* one time and it is up to the caller to process
* what ever is needed to handle the Discard.
* PE_MSG_DPM_DISCARDED: The message that was requested to be sent was
* discarded and an active DRP_REQUEST was active.
* The DRP_REQUEST that was current will be moved
* back to the drp_requests so it can be performed
* later if needed.
* NOTE: PE_MSG_DPM_DISCARDED will only be returned
* one time and it is up to the caller to process
* what ever is needed to handle the Discard.
*/
enum pe_msg_check {
PE_MSG_SEND_PENDING = BIT(0),
PE_MSG_SENT = BIT(1),
PE_MSG_DISCARDED = BIT(2),
PE_MSG_SEND_COMPLETED = BIT(3) | PE_MSG_SENT,
PE_MSG_DPM_DISCARDED = BIT(4) | PE_MSG_DISCARDED,
};
static void pe_sender_response_msg_entry(const int port);
static enum pe_msg_check pe_sender_response_msg_run(const int port);
static void pe_sender_response_msg_exit(const int port);
/* Debug log level - higher number == more log */
#ifdef CONFIG_USB_PD_DEBUG_LEVEL
static const enum debug_level pe_debug_level = CONFIG_USB_PD_DEBUG_LEVEL;
#else
static enum debug_level pe_debug_level = DEBUG_LEVEL_1;
#endif
/*
* Policy Engine State Machine Object
*/
static struct policy_engine {
/* state machine context */
struct sm_ctx ctx;
/* current port power role (SOURCE or SINK) */
enum pd_power_role power_role;
/* current port data role (DFP or UFP) */
enum pd_data_role data_role;
/* state machine flags */
atomic_t flags;
/* Device Policy Manager Request */
atomic_t dpm_request;
uint32_t dpm_curr_request;
/* last requested voltage PDO index */
int requested_idx;
/*
* Port events - PD_STATUS_EVENT_* values
* Set from PD task but may be cleared by host command
*/
atomic_t events;
/* port address where soft resets are sent */
enum tcpci_msg_type soft_reset_sop;
/* Current limit / voltage based on the last request message */
uint32_t curr_limit;
uint32_t supply_voltage;
/* PD_VDO_INVALID is used when there is an invalid VDO */
int32_t ama_vdo;
int32_t vpd_vdo;
/* Alternate mode discovery results */
struct pd_discovery discovery[DISCOVERY_TYPE_COUNT];
/* Active alternate modes */
struct partner_active_modes partner_amodes[AMODE_TYPE_COUNT];
/* Partner type to send */
enum tcpci_msg_type tx_type;
/* VDM - used to send information to shared VDM Request state */
uint32_t vdm_cnt;
uint32_t vdm_data[VDO_HDR_SIZE + VDO_MAX_SIZE];
uint8_t vdm_ack_min_data_objects;
/* Counters */
/*
* This counter is used to retry the Hard Reset whenever there is no
* response from the remote device.
*/
uint32_t hard_reset_counter;
/*
* This counter is used to count the number of Source_Capabilities
* Messages which have been sent by a Source at power up or after a
* Hard Reset.
*/
uint32_t caps_counter;
/*
* This counter maintains a count of Discover Identity Messages sent
* to a cable. If no GoodCRC messages are received after
* nDiscoverIdentityCount, the port shall not send any further
* SOP'/SOP'' messages.
*/
uint32_t discover_identity_counter;
/*
* For PD2.0, we need to be a DFP before sending a discovery identity
* message to our port partner. This counter keeps track of how
* many attempts to DR SWAP from UFP to DFP.
*/
uint32_t dr_swap_attempt_counter;
/*
* This counter tracks how many PR Swap messages are sent when the
* partner responds with a Wait message. Only used during SRC to SNK
* PR swaps
*/
uint8_t src_snk_pr_swap_counter;
/*
* This counter maintains a count of VCONN swap requests. If VCONN swap
* isn't successful after N_VCONN_SWAP_COUNT, the port calls
* dpm_vdm_naked().
*/
uint8_t vconn_swap_counter;
/* Last received source cap */
uint32_t src_caps[PDO_MAX_OBJECTS];
int src_cap_cnt; /* -1 on error retrieving source caps */
/* Last received sink cap */
uint32_t snk_caps[PDO_MAX_OBJECTS];
int snk_cap_cnt;
/* Attached ChromeOS device id, RW hash, and current RO / RW image */
uint16_t dev_id;
uint32_t dev_rw_hash[PD_RW_HASH_SIZE/4];
enum ec_image current_image;
} pe[CONFIG_USB_PD_PORT_MAX_COUNT];
test_export_static enum usb_pe_state get_state_pe(const int port);
test_export_static void set_state_pe(const int port,
const enum usb_pe_state new_state);
static void pe_set_dpm_curr_request(const int port, const int request);
/*
* The spec. revision is used to index into this array.
* PD 1.0 (VDO 1.0) - return VDM_VER10
* PD 2.0 (VDO 1.0) - return VDM_VER10
* PD 3.0 (VDO 2.0) - return VDM_VER20
*/
static const uint8_t vdo_ver[] = {
[PD_REV10] = VDM_VER10,
[PD_REV20] = VDM_VER10,
[PD_REV30] = VDM_VER20,
};
int pd_get_rev(int port, enum tcpci_msg_type type)
{
return prl_get_rev(port, type);
}
int pd_get_vdo_ver(int port, enum tcpci_msg_type type)
{
enum pd_rev_type rev = prl_get_rev(port, type);
if (rev < PD_REV30)
return vdo_ver[rev];
else
return VDM_VER20;
}
static void pe_set_ready_state(int port)
{
if (pe[port].power_role == PD_ROLE_SOURCE)
set_state_pe(port, PE_SRC_READY);
else
set_state_pe(port, PE_SNK_READY);
}
static void pe_set_hard_reset(int port)
{
if (pe[port].power_role == PD_ROLE_SOURCE)
set_state_pe(port, PE_SRC_HARD_RESET);
else
set_state_pe(port, PE_SNK_HARD_RESET);
}
static inline void send_data_msg(int port, enum tcpci_msg_type type,
enum pd_data_msg_type msg)
{
/* Clear any previous TX status before sending a new message */
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
prl_send_data_msg(port, type, msg);
}
static __maybe_unused inline void send_ext_data_msg(
int port, enum tcpci_msg_type type, enum pd_ext_msg_type msg)
{
/* Clear any previous TX status before sending a new message */
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
prl_send_ext_data_msg(port, type, msg);
}
static inline void send_ctrl_msg(int port, enum tcpci_msg_type type,
enum pd_ctrl_msg_type msg)
{
/* Clear any previous TX status before sending a new message */
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
prl_send_ctrl_msg(port, type, msg);
}
static void set_cable_rev(int port)
{
/*
* If port partner runs PD 2.0, cable communication must
* also be PD 2.0
*/
if (prl_get_rev(port, TCPCI_MSG_SOP) == PD_REV20) {
/*
* If the cable supports PD 3.0, but the port partner supports PD 2.0,
* redo the cable discover with PD 2.0
*/
if (prl_get_rev(port, TCPCI_MSG_SOP_PRIME) == PD_REV30 &&
pd_get_identity_discovery(port, TCPCI_MSG_SOP_PRIME) ==
PD_DISC_COMPLETE) {
pd_set_identity_discovery(port, TCPCI_MSG_SOP_PRIME,
PD_DISC_NEEDED);
}
prl_set_rev(port, TCPCI_MSG_SOP_PRIME, PD_REV20);
}
}
/* Compile-time insurance to ensure this code does not call into prl directly */
#define prl_send_data_msg DO_NOT_USE
#define prl_send_ext_data_msg DO_NOT_USE
#define prl_send_ctrl_msg DO_NOT_USE
static void pe_init(int port)
{
pe[port].flags = 0;
pe[port].dpm_request = 0;
pe[port].dpm_curr_request = 0;
pd_timer_disable_range(port, PE_TIMER_RANGE);
pe[port].data_role = pd_get_data_role(port);
pe[port].tx_type = TCPCI_MSG_INVALID;
pe[port].events = 0;
tc_pd_connection(port, 0);
if (pd_get_power_role(port) == PD_ROLE_SOURCE)
set_state_pe(port, PE_SRC_STARTUP);
else
set_state_pe(port, PE_SNK_STARTUP);
}
int pe_is_running(int port)
{
return local_state[port] == SM_RUN;
}
bool pe_in_frs_mode(int port)
{
return PE_CHK_FLAG(port, PE_FLAGS_FAST_ROLE_SWAP_PATH);
}
bool pe_in_local_ams(int port)
{
return !!PE_CHK_FLAG(port, PE_FLAGS_LOCALLY_INITIATED_AMS);
}
void pe_set_debug_level(enum debug_level debug_level)
{
#ifndef CONFIG_USB_PD_DEBUG_LEVEL
pe_debug_level = debug_level;
#endif
}
void pe_run(int port, int evt, int en)
{
switch (local_state[port]) {
case SM_PAUSED:
if (!en)
break;
/* fall through */
case SM_INIT:
pe_init(port);
local_state[port] = SM_RUN;
/* fall through */
case SM_RUN:
if (!en) {
local_state[port] = SM_PAUSED;
/*
* While we are paused, exit all states and wait until
* initialized again.
*/
set_state(port, &pe[port].ctx, NULL);
break;
}
/*
* 8.3.3.3.8 PE_SNK_Hard_Reset State
* The Policy Engine Shall transition to the PE_SNK_Hard_Reset
* state from any state when:
* - Hard Reset request from Device Policy Manager
*
* USB PD specification clearly states that we should go to
* PE_SNK_Hard_Reset from ANY state (including states in which
* port is source) when DPM requests that. This can lead to
* execute Hard Reset path for sink when actually our power
* role is source. In our implementation we will choose Hard
* Reset path depending on current power role.
*/
if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_HARD_RESET_SEND)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_HARD_RESET_SEND);
if (pd_get_power_role(port) == PD_ROLE_SOURCE)
set_state_pe(port, PE_SRC_HARD_RESET);
else
set_state_pe(port, PE_SNK_HARD_RESET);
}
/*
* Check for Fast Role Swap signal
* This is not a typical pattern for adding state changes.
* I added this here because FRS SIGNALED can happen at any
* state once we are listening for the signal and we want to
* make sure to handle it immediately.
*/
if (IS_ENABLED(CONFIG_USB_PD_REV30) &&
PE_CHK_FLAG(port, PE_FLAGS_FAST_ROLE_SWAP_SIGNALED)) {
PE_CLR_FLAG(port, PE_FLAGS_FAST_ROLE_SWAP_SIGNALED);
set_state_pe(port, PE_FRS_SNK_SRC_START_AMS);
}
/* Run state machine */
run_state(port, &pe[port].ctx);
break;
}
}
int pe_is_explicit_contract(int port)
{
return PE_CHK_FLAG(port, PE_FLAGS_EXPLICIT_CONTRACT);
}
void pe_message_received(int port)
{
/* This should only be called from the PD task */
assert(port == TASK_ID_TO_PD_PORT(task_get_current()));
PE_SET_FLAG(port, PE_FLAGS_MSG_RECEIVED);
task_wake(PD_PORT_TO_TASK_ID(port));
}
void pe_hard_reset_sent(int port)
{
/* This should only be called from the PD task */
assert(port == TASK_ID_TO_PD_PORT(task_get_current()));
PE_CLR_FLAG(port, PE_FLAGS_HARD_RESET_PENDING);
}
void pe_got_hard_reset(int port)
{
/* This should only be called from the PD task */
assert(port == TASK_ID_TO_PD_PORT(task_get_current()));
/*
* Transition from any state to the PE_SRC_Hard_Reset_Received or
* PE_SNK_Transition_to_default state when:
* 1) Hard Reset Signaling is detected.
*/
pe[port].power_role = pd_get_power_role(port);
/* Exit BIST Test mode, in case the TCPC entered it. */
tcpc_set_bist_test_mode(port, false);
if (pe[port].power_role == PD_ROLE_SOURCE)
set_state_pe(port, PE_SRC_HARD_RESET_RECEIVED);
else
set_state_pe(port, PE_SNK_TRANSITION_TO_DEFAULT);
}
#ifdef CONFIG_USB_PD_REV30
/*
* pd_got_frs_signal
*
* Called by the handler that detects the FRS signal in order to
* switch PE states to complete the FRS that the hardware has
* started.
*
* If the PE is not running, generate an error recovery to turn off
* Vbus and get the port back into a known state.
*/
void pd_got_frs_signal(int port)
{
if (pe_is_running(port))
PE_SET_FLAG(port, PE_FLAGS_FAST_ROLE_SWAP_SIGNALED);
else
pd_set_error_recovery(port);
task_wake(PD_PORT_TO_TASK_ID(port));
}
#endif /* CONFIG_USB_PD_REV30 */
/*
* PE_Set_FRS_Enable
*
* This function should be called every time an explicit contract
* is disabled, to disable FRS.
*
* Enabling an explicit contract is not enough to enable FRS, it
* also requires a Sink Capability power requirement from a Source
* that supports FRS so we can determine if this is something we
* can handle.
*/
static void pe_set_frs_enable(int port, int enable)
{
int current = PE_CHK_FLAG(port, PE_FLAGS_FAST_ROLE_SWAP_ENABLED);
/* This should only be called from the PD task */
if (!IS_ENABLED(TEST_BUILD))
assert(port == TASK_ID_TO_PD_PORT(task_get_current()));
if (!IS_ENABLED(CONFIG_USB_PD_FRS) || !IS_ENABLED(CONFIG_USB_PD_REV30))
return;
/* Request an FRS change, only if the state has changed */
if (!!current == !!enable)
return;
pd_set_frs_enable(port, enable);
if (enable) {
int curr_limit = *pd_get_snk_caps(port)
& PDO_FIXED_FRS_CURR_MASK;
typec_select_src_current_limit_rp(port,
curr_limit ==
PDO_FIXED_FRS_CURR_3A0_AT_5V ?
TYPEC_RP_3A0 : TYPEC_RP_1A5);
PE_SET_FLAG(port, PE_FLAGS_FAST_ROLE_SWAP_ENABLED);
} else {
PE_CLR_FLAG(port, PE_FLAGS_FAST_ROLE_SWAP_ENABLED);
}
}
void pe_set_explicit_contract(int port)
{
PE_SET_FLAG(port, PE_FLAGS_EXPLICIT_CONTRACT);
/* Set Rp for collision avoidance */
if (IS_ENABLED(CONFIG_USB_PD_REV30))
typec_update_cc(port);
}
void pe_invalidate_explicit_contract(int port)
{
pe_set_frs_enable(port, 0);
PE_CLR_FLAG(port, PE_FLAGS_EXPLICIT_CONTRACT);
/* Set Rp for current limit if still attached */
if (IS_ENABLED(CONFIG_USB_PD_REV30) && pd_is_connected(port))
typec_update_cc(port);
}
void pd_notify_event(int port, uint32_t event_mask)
{
atomic_or(&pe[port].events, event_mask);
/* Notify the host that new events are available to read */
pd_send_host_event(PD_EVENT_TYPEC);
}
void pd_clear_events(int port, uint32_t clear_mask)
{
atomic_clear_bits(&pe[port].events, clear_mask);
}
uint32_t pd_get_events(int port)
{
return pe[port].events;
}
void pe_set_snk_caps(int port, int cnt, uint32_t *snk_caps)
{
pe[port].snk_cap_cnt = cnt;
memcpy(pe[port].snk_caps, snk_caps, sizeof(uint32_t) * cnt);
}
const uint32_t * const pd_get_snk_caps(int port)
{
return pe[port].snk_caps;
}
uint8_t pd_get_snk_cap_cnt(int port)
{
return pe[port].snk_cap_cnt;
}
uint32_t pd_get_requested_voltage(int port)
{
return pe[port].supply_voltage;
}
uint32_t pd_get_requested_current(int port)
{
return pe[port].curr_limit;
}
/*
* Determine if this port may communicate with the cable plug.
*
* In both PD 2.0 and 3.0 (2.5.4 SOP'/SOP'' Communication with Cable Plugs):
*
* When no Contract or an Implicit Contract is in place (e.g. after a Power Role
* Swap or Fast Role Swap) only the Source port that is supplying Vconn is
* allowed to send packets to a Cable Plug
*
* When in an explicit contract, PD 3.0 requires that a port be Vconn source to
* communicate with the cable. PD 2.0 requires that a port be DFP to
* communicate with the cable plug, with an implication that it must be Vconn
* source as well (6.3.11 VCONN_Swap Message).
*/
static bool pe_can_send_sop_prime(int port)
{
if (IS_ENABLED(CONFIG_USBC_VCONN)) {
if (PE_CHK_FLAG(port, PE_FLAGS_EXPLICIT_CONTRACT)) {
if (prl_get_rev(port, TCPCI_MSG_SOP) == PD_REV20)
return tc_is_vconn_src(port) &&
pe[port].data_role == PD_ROLE_DFP;
else
return tc_is_vconn_src(port);
} else {
return tc_is_vconn_src(port) &&
pe[port].power_role == PD_ROLE_SOURCE;
}
} else {
return false;
}
}
/*
* Determine if this port may send the given VDM type
*
* For PD 2.0, "Only the DFP Shall be an Initrator of Structured VDMs except for
* the Attention Command that Shall only be initiated by the UFP"
*
* For PD 3.0, "Either port May be an Initiator of Structured VDMs except for
* the Enter Mode and Exit Mode Commands which shall only be initiated by the
* DFP" (6.4.4.2 Structured VDM)
*
* In both revisions, VDMs may only be initiated while in an explicit contract,
* with the only exception being for cable plug discovery.
*/
static bool pe_can_send_sop_vdm(int port, int vdm_cmd)
{
if (PE_CHK_FLAG(port, PE_FLAGS_EXPLICIT_CONTRACT)) {
if (prl_get_rev(port, TCPCI_MSG_SOP) == PD_REV20) {
if (pe[port].data_role == PD_ROLE_UFP &&
vdm_cmd != CMD_ATTENTION) {
return false;
}
} else {
if (pe[port].data_role == PD_ROLE_UFP &&
(vdm_cmd == CMD_ENTER_MODE ||
vdm_cmd == CMD_EXIT_MODE)) {
return false;
}
}
return true;
}
return false;
}
static void pe_send_soft_reset(const int port, enum tcpci_msg_type type)
{
pe[port].soft_reset_sop = type;
set_state_pe(port, PE_SEND_SOFT_RESET);
}
void pe_report_discard(int port)
{
/*
* Clear local AMS indicator as our AMS message was discarded, and flag
* the discard for the PE
*/
PE_CLR_FLAG(port, PE_FLAGS_LOCALLY_INITIATED_AMS);
PE_SET_FLAG(port, PE_FLAGS_MSG_DISCARDED);
/* TODO(b/157228506): Ensure all states are checking discard */
}
/*
* Utility function to check for an outgoing message discard during states which
* send a message as a part of an AMS and wait for the transmit to complete.
* Note these states should not be power transitioning.
*
* In these states, discard due to an incoming message is a protocol error.
*/
static bool pe_check_outgoing_discard(int port)
{
/*
* On outgoing discard, soft reset with SOP* of incoming message
*
* See Table 6-65 Response to an incoming Message (except VDM) in PD 3.0
* Version 2.0 Specification.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_DISCARDED) &&
PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
enum tcpci_msg_type sop =
PD_HEADER_GET_SOP(rx_emsg[port].header);
PE_CLR_FLAG(port, PE_FLAGS_MSG_DISCARDED);
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
pe_send_soft_reset(port, sop);
return true;
}
return false;
}
void pe_report_error(int port, enum pe_error e, enum tcpci_msg_type type)
{
/* This should only be called from the PD task */
assert(port == TASK_ID_TO_PD_PORT(task_get_current()));
/*
* If there is a timeout error while waiting for a chunk of a chunked
* message, there is no requirement to trigger a soft reset.
*/
if (e == ERR_RCH_CHUNK_WAIT_TIMEOUT)
return;
/*
* Generate Hard Reset if Protocol Error occurred
* while in PE_Send_Soft_Reset state.
*/
if (get_state_pe(port) == PE_SEND_SOFT_RESET) {
if (pe[port].power_role == PD_ROLE_SINK)
set_state_pe(port, PE_SNK_HARD_RESET);
else
set_state_pe(port, PE_SRC_HARD_RESET);
return;
}
/*
* The following states require custom handling of protocol errors,
* because they either need special handling of the no GoodCRC case
* (cable identity request, send capabilities), occur before explicit
* contract (discovery), or happen during a power transition.
*
* TODO(b/150774779): TCPMv2: Improve pe_error documentation
*/
if ((get_state_pe(port) == PE_SRC_SEND_CAPABILITIES ||
get_state_pe(port) == PE_SRC_TRANSITION_SUPPLY ||
get_state_pe(port) == PE_PRS_SNK_SRC_EVALUATE_SWAP ||
get_state_pe(port) == PE_PRS_SNK_SRC_SOURCE_ON ||
get_state_pe(port) == PE_PRS_SRC_SNK_WAIT_SOURCE_ON ||
get_state_pe(port) == PE_SRC_DISABLED ||
get_state_pe(port) == PE_SRC_DISCOVERY ||
get_state_pe(port) == PE_VCS_CBL_SEND_SOFT_RESET ||
get_state_pe(port) == PE_VDM_IDENTITY_REQUEST_CBL) ||
#ifdef CONFIG_USB_PD_DATA_RESET_MSG
get_state_pe(port) == PE_DDR_SEND_DATA_RESET ||
get_state_pe(port) == PE_DDR_WAIT_FOR_VCONN_OFF ||
get_state_pe(port) == PE_DDR_PERFORM_DATA_RESET ||
#endif
(pe_in_frs_mode(port) &&
get_state_pe(port) == PE_PRS_SNK_SRC_SEND_SWAP)
) {
PE_SET_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
task_wake(PD_PORT_TO_TASK_ID(port));
return;
}
/*
* See section 8.3.3.4.1.1 PE_SRC_Send_Soft_Reset State:
*
* The PE_Send_Soft_Reset state shall be entered from
* any state when
* * A Protocol Error is detected by Protocol Layer during a
* Non-Interruptible AMS or
* * A message has not been sent after retries or
* * When not in an explicit contract and
* * Protocol Errors occurred on SOP during an Interruptible AMS or
* * Protocol Errors occurred on SOP during any AMS where the first
* Message in the sequence has not yet been sent i.e. an unexpected
* Message is received instead of the expected GoodCRC Message
* response.
*/
/* All error types besides transmit errors are Protocol Errors. */
if ((e != ERR_TCH_XMIT &&
!PE_CHK_FLAG(port, PE_FLAGS_INTERRUPTIBLE_AMS))
|| e == ERR_TCH_XMIT
|| (!PE_CHK_FLAG(port, PE_FLAGS_EXPLICIT_CONTRACT) &&
type == TCPCI_MSG_SOP)) {
pe_send_soft_reset(port, type);
}
/*
* Transition to PE_Snk_Ready or PE_Src_Ready by a Protocol
* Error during an Interruptible AMS.
*/
else {
pe_set_ready_state(port);
}
}
void pe_got_soft_reset(int port)
{
/* This should only be called from the PD task */
assert(port == TASK_ID_TO_PD_PORT(task_get_current()));
/*
* The PE_SRC_Soft_Reset state Shall be entered from any state when a
* Soft_Reset Message is received from the Protocol Layer.
*/
set_state_pe(port, PE_SOFT_RESET);
}
__overridable bool pd_can_charge_from_device(int port, const int pdo_cnt,
const uint32_t *pdos)
{
/*
* Don't attempt to charge from a device we have no SrcCaps from. Or, if
* drp_state is FORCE_SOURCE then don't attempt a PRS.
*/
if (pdo_cnt == 0 || pd_get_dual_role(port) == PD_DRP_FORCE_SOURCE)
return false;
/*
* Treat device as a dedicated charger (meaning we should charge
* from it) if:
* - it does not support power swap, or
* - it is unconstrained power, or
* - it presents at least 27 W of available power
*/
/* Unconstrained Power or NOT Dual Role Power we can charge from */
if (pdos[0] & PDO_FIXED_UNCONSTRAINED ||
(pdos[0] & PDO_FIXED_DUAL_ROLE) == 0)
return true;
/* [virtual] allow_list */
if (IS_ENABLED(CONFIG_CHARGE_MANAGER)) {
uint32_t max_ma, max_mv, max_pdo, max_mw, unused;
/*
* Get max power that the partner offers (not necessarily what
* this board will request)
*/
pd_find_pdo_index(pdo_cnt, pdos,
PD_REV3_MAX_VOLTAGE,
&max_pdo);
pd_extract_pdo_power(max_pdo, &max_ma, &max_mv, &unused);
max_mw = max_ma * max_mv / 1000;
if (max_mw >= PD_DRP_CHARGE_POWER_MIN)
return true;
}
return false;
}
void pd_resume_check_pr_swap_needed(int port)
{
/*
* Explicit contract, current power role of SNK, the device
* indicates it should not power us, and device isn't selected
* as the charging port (ex. through the GUI) then trigger a PR_Swap
*/
if (pe_is_explicit_contract(port) &&
pd_get_power_role(port) == PD_ROLE_SINK &&
!pd_can_charge_from_device(port, pd_get_src_cap_cnt(port),
pd_get_src_caps(port)) &&
(!IS_ENABLED(CONFIG_CHARGE_MANAGER) ||
charge_manager_get_active_charge_port() != port))
pd_dpm_request(port, DPM_REQUEST_PR_SWAP);
}
void pd_dpm_request(int port, enum pd_dpm_request req)
{
PE_SET_DPM_REQUEST(port, req);
}
void pe_vconn_swap_complete(int port)
{
/* This should only be called from the PD task */
assert(port == TASK_ID_TO_PD_PORT(task_get_current()));
PE_SET_FLAG(port, PE_FLAGS_VCONN_SWAP_COMPLETE);
}
void pe_ps_reset_complete(int port)
{
/* This should only be called from the PD task */
assert(port == TASK_ID_TO_PD_PORT(task_get_current()));
PE_SET_FLAG(port, PE_FLAGS_PS_RESET_COMPLETE);
}
void pe_message_sent(int port)
{
/* This should only be called from the PD task */
assert(port == TASK_ID_TO_PD_PORT(task_get_current()));
PE_SET_FLAG(port, PE_FLAGS_TX_COMPLETE);
task_wake(PD_PORT_TO_TASK_ID(port));
}
void pd_send_vdm(int port, uint32_t vid, int cmd, const uint32_t *data,
int count)
{
/* Copy VDM Header */
pe[port].vdm_data[0] =
VDO(vid, ((vid & USB_SID_PD) == USB_SID_PD) ? 1 :
(PD_VDO_CMD(cmd) <= CMD_ATTENTION),
VDO_SVDM_VERS(pd_get_vdo_ver(port, TCPCI_MSG_SOP)) |
cmd);
/*
* Copy VDOs after the VDM Header. Note that the count refers to VDO
* count.
*/
memcpy((pe[port].vdm_data + 1), data, count * sizeof(uint32_t));
pe[port].vdm_cnt = count + 1;
/*
* The PE transmit routine assumes that tx_type was set already. Note,
* that this function is likely called from outside the PD task.
* (b/180465870)
*/
pe[port].tx_type = TCPCI_MSG_SOP;
pd_dpm_request(port, DPM_REQUEST_VDM);
task_wake(PD_PORT_TO_TASK_ID(port));
}
#ifdef TEST_BUILD
/*
* Allow unit tests to access this function to clear internal state data between
* runs
*/
void pe_clear_port_data(int port)
#else
static void pe_clear_port_data(int port)
#endif /* TEST_BUILD */
{
/*
* PD 3.0 Section 8.3.3.3.8
* Note: The HardResetCounter is reset on a power cycle or Detach.
*/
pe[port].hard_reset_counter = 0;
/* Reset port events */
pd_clear_events(port, GENMASK(31, 0));
/* But then set disconnected event */
pd_notify_event(port, PD_STATUS_EVENT_DISCONNECTED);
/* Tell Policy Engine to invalidate the explicit contract */
pe_invalidate_explicit_contract(port);
/*
* Saved Source and Sink Capabilities are no longer valid on disconnect
*/
pd_set_src_caps(port, 0, NULL);
pe_set_snk_caps(port, 0, NULL);
/* Clear any stored discovery data, but leave modes for alt mode exit */
pd_dfp_discovery_init(port);
dpm_remove_sink(port);
dpm_remove_source(port);
/* Exit BIST Test mode, in case the TCPC entered it. */
tcpc_set_bist_test_mode(port, false);
}
static void pe_handle_detach(void)
{
const int port = TASK_ID_TO_PD_PORT(task_get_current());
pe_clear_port_data(port);
}
DECLARE_HOOK(HOOK_USB_PD_DISCONNECT, pe_handle_detach, HOOK_PRIO_DEFAULT);
#ifdef CONFIG_USB_PD_RESET_MIN_BATT_SOC
static void pe_update_waiting_batt_flag(void)
{
int i;
int batt_soc = usb_get_battery_soc();
if (batt_soc < CONFIG_USB_PD_RESET_MIN_BATT_SOC ||
battery_get_disconnect_state() != BATTERY_NOT_DISCONNECTED)
return;
for (i = 0; i < board_get_usb_pd_port_count(); i++) {
if (PE_CHK_FLAG(i, PE_FLAGS_SNK_WAITING_BATT)) {
/*
* Battery has gained sufficient charge to kick off PD
* negotiation and withstand a hard reset. Clear the
* flag and perform Hard Reset.
*/
PE_CLR_FLAG(i, PE_FLAGS_SNK_WAITING_BATT);
CPRINTS("C%d: Battery has enough charge (%d%%) " \
"to withstand a hard reset", i, batt_soc);
pd_dpm_request(i, DPM_REQUEST_HARD_RESET_SEND);
}
}
}
DECLARE_HOOK(HOOK_BATTERY_SOC_CHANGE, pe_update_waiting_batt_flag,
HOOK_PRIO_DEFAULT);
#endif
/*
* Private functions
*/
static void pe_set_dpm_curr_request(const int port,
const int request)
{
PE_CLR_DPM_REQUEST(port, request);
pe[port].dpm_curr_request = request;
}
/* Set the TypeC state machine to a new state. */
test_export_static void set_state_pe(const int port,
const enum usb_pe_state new_state)
{
set_state(port, &pe[port].ctx, &pe_states[new_state]);
}
/* Get the current TypeC state. */
test_export_static enum usb_pe_state get_state_pe(const int port)
{
return pe[port].ctx.current - &pe_states[0];
}
/*
* Handle common DPM requests to both source and sink.
*
* Note: it is assumed the calling state set PE_FLAGS_LOCALLY_INITIATED_AMS
*
* Returns true if state was set and calling run state should now return.
*/
static bool common_src_snk_dpm_requests(int port)
{
if (IS_ENABLED(CONFIG_USB_PD_EXTENDED_MESSAGES) &&
PE_CHK_DPM_REQUEST(port, DPM_REQUEST_SEND_ALERT)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_SEND_ALERT);
set_state_pe(port, PE_SEND_ALERT);
return true;
} else if (IS_ENABLED(CONFIG_USBC_VCONN) &&
PE_CHK_DPM_REQUEST(port, DPM_REQUEST_VCONN_SWAP)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_VCONN_SWAP);
set_state_pe(port, PE_VCS_SEND_SWAP);
return true;
} else if (PE_CHK_DPM_REQUEST(port,
DPM_REQUEST_BIST_TX)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_BIST_TX);
set_state_pe(port, PE_BIST_TX);
return true;
} else if (PE_CHK_DPM_REQUEST(port,
DPM_REQUEST_SNK_STARTUP)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_SNK_STARTUP);
set_state_pe(port, PE_SNK_STARTUP);
return true;
} else if (PE_CHK_DPM_REQUEST(port,
DPM_REQUEST_SRC_STARTUP)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_SRC_STARTUP);
set_state_pe(port, PE_SRC_STARTUP);
return true;
} else if (PE_CHK_DPM_REQUEST(port,
DPM_REQUEST_SOFT_RESET_SEND)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_SOFT_RESET_SEND);
/* Currently only support sending soft reset to SOP */
pe_send_soft_reset(port, TCPCI_MSG_SOP);
return true;
} else if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_PORT_DISCOVERY)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_PORT_DISCOVERY);
if (!PE_CHK_FLAG(port, PE_FLAGS_MODAL_OPERATION)) {
/*
* Clear counters and reset timer to trigger a
* port discovery, and also clear any pending VDM send
* requests.
*/
pd_dfp_discovery_init(port);
/*
* TODO(b/189353401): Do not reinitialize modes when no
* longer required.
*/
pd_dfp_mode_init(port);
pe[port].dr_swap_attempt_counter = 0;
pe[port].discover_identity_counter = 0;
pd_timer_enable(port, PE_TIMER_DISCOVER_IDENTITY,
PD_T_DISCOVER_IDENTITY);
PE_CLR_DPM_REQUEST(port, DPM_REQUEST_VDM);
}
return true;
} else if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_VDM)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_VDM);
/* Send previously set up SVDM. */
set_state_pe(port, PE_VDM_REQUEST_DPM);
return true;
} else if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_ENTER_USB)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_ENTER_USB);
set_state_pe(port, PE_DEU_SEND_ENTER_USB);
return true;
} else if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_EXIT_MODES)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_EXIT_MODES);
dpm_set_mode_exit_request(port);
return true;
} else if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_GET_SNK_CAPS)) {
pe_set_dpm_curr_request(port,
DPM_REQUEST_GET_SNK_CAPS);
set_state_pe(port, PE_DR_GET_SINK_CAP);
return true;
} else if (PE_CHK_DPM_REQUEST(port,
DPM_REQUEST_SOP_PRIME_SOFT_RESET_SEND)) {
pe_set_dpm_curr_request(port,
DPM_REQUEST_SOP_PRIME_SOFT_RESET_SEND);
pe[port].tx_type = TCPCI_MSG_SOP_PRIME;
set_state_pe(port, PE_VCS_CBL_SEND_SOFT_RESET);
return true;
} else if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_DR_SWAP)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_DR_SWAP);
/* 6.3.9 DR_Swap Message in Revision 3.1, Version 1.3
* If there are any Active Modes between the Port Partners when
* a DR_Swap Message is a received, then a Hard Reset Shall be
* performed
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MODAL_OPERATION))
pe_set_hard_reset(port);
else
set_state_pe(port, PE_DRS_SEND_SWAP);
return true;
}
#ifdef CONFIG_USB_PD_DATA_RESET_MSG
else if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_DATA_RESET)) {
if (prl_get_rev(port, TCPCI_MSG_SOP) < PD_REV30) {
dpm_data_reset_complete(port);
return false;
}
pe_set_dpm_curr_request(port, DPM_REQUEST_DATA_RESET);
if (pe[port].data_role == PD_ROLE_DFP)
set_state_pe(port, PE_DDR_SEND_DATA_RESET);
else
return false;
return true;
}
#endif /* CONFIG_USB_PD_DATA_RESET_MSG */
return false;
}
/*
* Handle source-specific DPM requests
*
* Returns true if state was set and calling run state should now return.
*/
static bool source_dpm_requests(int port)
{
/*
* Ignore sink-specific request:
* DPM_REQUEST_NEW_POWER_LEVEL
* DPM_REQUEST_SOURCE_CAP
* DPM_REQUEST_FRS_DET_ENABLE
* DPM_REQURST_FRS_DET_DISABLE
*/
PE_CLR_DPM_REQUEST(port, DPM_REQUEST_NEW_POWER_LEVEL |
DPM_REQUEST_SOURCE_CAP |
DPM_REQUEST_FRS_DET_ENABLE |
DPM_REQUEST_FRS_DET_DISABLE);
if (pe[port].dpm_request) {
uint32_t dpm_request = pe[port].dpm_request;
PE_SET_FLAG(port, PE_FLAGS_LOCALLY_INITIATED_AMS);
if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_PR_SWAP)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_PR_SWAP);
set_state_pe(port, PE_PRS_SRC_SNK_SEND_SWAP);
return true;
} else if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_GOTO_MIN)) {
pe_set_dpm_curr_request(port,
DPM_REQUEST_GOTO_MIN);
set_state_pe(port, PE_SRC_TRANSITION_SUPPLY);
return true;
} else if (PE_CHK_DPM_REQUEST(port,
DPM_REQUEST_SRC_CAP_CHANGE)) {
pe_set_dpm_curr_request(port,
DPM_REQUEST_SRC_CAP_CHANGE);
set_state_pe(port, PE_SRC_SEND_CAPABILITIES);
return true;
} else if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_GET_SRC_CAPS)) {
pe_set_dpm_curr_request(port,
DPM_REQUEST_GET_SRC_CAPS);
set_state_pe(port, PE_DR_SRC_GET_SOURCE_CAP);
return true;
} else if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_SEND_PING)) {
pe_set_dpm_curr_request(port,
DPM_REQUEST_SEND_PING);
set_state_pe(port, PE_SRC_PING);
return true;
} else if (common_src_snk_dpm_requests(port)) {
return true;
}
CPRINTF("Unhandled DPM Request %x received\n",
dpm_request);
PE_CLR_DPM_REQUEST(port, dpm_request);
PE_CLR_FLAG(port, PE_FLAGS_LOCALLY_INITIATED_AMS);
}
return false;
}
/*
* Handle sink-specific DPM requests
*
* Returns true if state was set and calling run state should now return.
*/
static bool sink_dpm_requests(int port)
{
/*
* Ignore source specific requests:
* DPM_REQUEST_GOTO_MIN
* DPM_REQUEST_SRC_CAP_CHANGE,
* DPM_REQUEST_SEND_PING
*/
PE_CLR_DPM_REQUEST(port, DPM_REQUEST_GOTO_MIN |
DPM_REQUEST_SRC_CAP_CHANGE |
DPM_REQUEST_SEND_PING);
if (pe[port].dpm_request) {
uint32_t dpm_request = pe[port].dpm_request;
PE_SET_FLAG(port, PE_FLAGS_LOCALLY_INITIATED_AMS);
if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_PR_SWAP)) {
pe_set_dpm_curr_request(port, DPM_REQUEST_PR_SWAP);
set_state_pe(port, PE_PRS_SNK_SRC_SEND_SWAP);
return true;
} else if (PE_CHK_DPM_REQUEST(port, DPM_REQUEST_SOURCE_CAP)) {
pe_set_dpm_curr_request(port,
DPM_REQUEST_SOURCE_CAP);
set_state_pe(port, PE_SNK_GET_SOURCE_CAP);
return true;
} else if (PE_CHK_DPM_REQUEST(port,
DPM_REQUEST_NEW_POWER_LEVEL)) {
pe_set_dpm_curr_request(port,
DPM_REQUEST_NEW_POWER_LEVEL);
set_state_pe(port, PE_SNK_SELECT_CAPABILITY);
return true;
} else if (PE_CHK_DPM_REQUEST(port,
DPM_REQUEST_FRS_DET_ENABLE)) {
pe_set_frs_enable(port, 1);
/* Requires no state change, fall through to false */
PE_CLR_DPM_REQUEST(port, DPM_REQUEST_FRS_DET_ENABLE);
} else if (PE_CHK_DPM_REQUEST(port,
DPM_REQUEST_FRS_DET_DISABLE)) {
pe_set_frs_enable(port, 0);
/* Restore a default port current limit */
typec_select_src_current_limit_rp(port,
CONFIG_USB_PD_PULLUP);
/* Requires no state change, fall through to false */
PE_CLR_DPM_REQUEST(port, DPM_REQUEST_FRS_DET_DISABLE);
} else if (common_src_snk_dpm_requests(port)) {
return true;
} else {
CPRINTF("Unhandled DPM Request %x received\n",
dpm_request);
PE_CLR_DPM_REQUEST(port, dpm_request);
}
PE_CLR_FLAG(port, PE_FLAGS_LOCALLY_INITIATED_AMS);
}
return false;
}
/* Get the previous TypeC state. */
static enum usb_pe_state get_last_state_pe(const int port)
{
return pe[port].ctx.previous - &pe_states[0];
}
static void print_current_state(const int port)
{
const char *mode = "";
if (IS_ENABLED(CONFIG_USB_PD_REV30) &&
pe_in_frs_mode(port))
mode = " FRS-MODE";
if (IS_ENABLED(USB_PD_DEBUG_LABELS))
CPRINTS_L1("C%d: %s%s", port,
pe_state_names[get_state_pe(port)], mode);
else
CPRINTS("C%d: pe-st%d", port, get_state_pe(port));
}
static void send_source_cap(int port)
{
const uint32_t *src_pdo;
const int src_pdo_cnt = dpm_get_source_pdo(&src_pdo, port);
if (src_pdo_cnt == 0) {
/* No source capabilities defined, sink only */
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_REJECT);
}
tx_emsg[port].len = src_pdo_cnt * 4;
memcpy(tx_emsg[port].buf, (uint8_t *)src_pdo, tx_emsg[port].len);
send_data_msg(port, TCPCI_MSG_SOP, PD_DATA_SOURCE_CAP);
}
/*
* Request desired charge voltage from source.
*/
static void pe_send_request_msg(int port)
{
uint32_t vpd_vdo = 0;
uint32_t rdo;
uint32_t curr_limit;
uint32_t supply_voltage;
/*
* If we are charging through a VPD, the requested voltage and current
* might need adjusting.
*/
if ((get_usb_pd_cable_type(port) == IDH_PTYPE_VPD) &&
is_vpd_ct_supported(port)) {
union vpd_vdo vpd = pd_get_am_discovery(port,
TCPCI_MSG_SOP_PRIME)->identity.product_t1.vpd;
/* The raw vpd_vdo is passed to pd_build_request */
vpd_vdo = vpd.raw_value;
}
/* Build and send request RDO */
pd_build_request(vpd_vdo, &rdo, &curr_limit,
&supply_voltage, port);
CPRINTF("C%d: Req [%d] %dmV %dmA", port, RDO_POS(rdo),
supply_voltage, curr_limit);
if (rdo & RDO_CAP_MISMATCH)
CPRINTF(" Mismatch");
CPRINTF("\n");
pe[port].curr_limit = curr_limit;
pe[port].supply_voltage = supply_voltage;
tx_emsg[port].len = 4;
memcpy(tx_emsg[port].buf, (uint8_t *)&rdo, tx_emsg[port].len);
send_data_msg(port, TCPCI_MSG_SOP, PD_DATA_REQUEST);
}
static void pe_update_src_pdo_flags(int port, int pdo_cnt, uint32_t *pdos)
{
/*
* Only parse PDO flags if type is fixed
*
* Note: From 6.4.1 Capabilities Message "The vSafe5V Fixed Supply
* Object Shall always be the first object." so hitting this condition
* would mean the partner is voilating spec.
*/
if ((pdos[0] & PDO_TYPE_MASK) != PDO_TYPE_FIXED)
return;
if (IS_ENABLED(CONFIG_CHARGE_MANAGER)) {
if (pd_can_charge_from_device(port, pdo_cnt, pdos)) {
charge_manager_update_dualrole(port, CAP_DEDICATED);
} else {
charge_manager_update_dualrole(port, CAP_DUALROLE);
}
}
}
/*
* Evaluate whether our PR role is in the middle of changing, meaning we our
* current PR role is not the one we expect to have very shortly.
*/
bool pe_is_pr_swapping(int port)
{
enum usb_pe_state cur_state = get_state_pe(port);
if (cur_state == PE_PRS_SRC_SNK_EVALUATE_SWAP ||
cur_state == PE_PRS_SRC_SNK_TRANSITION_TO_OFF ||
cur_state == PE_PRS_SNK_SRC_EVALUATE_SWAP ||
cur_state == PE_PRS_SNK_SRC_TRANSITION_TO_OFF)
return true;
return false;
}
void pd_request_power_swap(int port)
{
/* Ignore requests when the board does not wish to swap */
if (!pd_check_power_swap(port))
return;
/* Ignore requests when our power role is transitioning */
if (pe_is_pr_swapping(port))
return;
/*
* Always reset the SRC to SNK PR swap counter when a PR swap is
* requested by policy.
*/
pe[port].src_snk_pr_swap_counter = 0;
pd_dpm_request(port, DPM_REQUEST_PR_SWAP);
}
/* The function returns true if there is a PE state change, false otherwise */
static bool port_try_vconn_swap(int port)
{
if (pe[port].vconn_swap_counter < N_VCONN_SWAP_COUNT) {
pd_dpm_request(port, DPM_REQUEST_VCONN_SWAP);
set_state_pe(port, get_last_state_pe(port));
return true;
}
return false;
}
/*
* Run discovery at our leisure from PE_SNK_Ready or PE_SRC_Ready, after
* attempting to get into the desired default policy of DFP/Vconn source
*
* Return indicates whether set_state was called, in which case the calling
* function should return as well.
*/
__maybe_unused static bool pe_attempt_port_discovery(int port)
{
if (!IS_ENABLED(CONFIG_USB_PD_ALT_MODE_DFP))
assert(0);
/*
* DONE set once modal entry is successful, discovery completes, or
* discovery results in a NAK
*/
if (PE_CHK_FLAG(port, PE_FLAGS_VDM_SETUP_DONE))
return false;
/* Apply Port Discovery DR Swap Policy */
if (port_discovery_dr_swap_policy(port, pe[port].data_role,
PE_CHK_FLAG(port, PE_FLAGS_DR_SWAP_TO_DFP))) {
PE_SET_FLAG(port, PE_FLAGS_LOCALLY_INITIATED_AMS);
PE_CLR_FLAG(port, PE_FLAGS_DR_SWAP_TO_DFP);
set_state_pe(port, PE_DRS_SEND_SWAP);
return true;
}
/* Apply Port Discovery VCONN Swap Policy */
if (IS_ENABLED(CONFIG_USBC_VCONN) &&
port_discovery_vconn_swap_policy(port,
PE_CHK_FLAG(port, PE_FLAGS_VCONN_SWAP_TO_ON))) {
PE_SET_FLAG(port, PE_FLAGS_LOCALLY_INITIATED_AMS);
PE_CLR_FLAG(port, PE_FLAGS_VCONN_SWAP_TO_ON);
set_state_pe(port, PE_VCS_SEND_SWAP);
return true;
}
/* If mode entry was successful, disable the timer */
if (PE_CHK_FLAG(port, PE_FLAGS_VDM_SETUP_DONE)) {
pd_timer_disable(port, PE_TIMER_DISCOVER_IDENTITY);
return false;
}
/*
* Run discovery functions when the timer indicating either cable
* discovery spacing or BUSY spacing runs out.
*/
if (pd_timer_is_expired(port, PE_TIMER_DISCOVER_IDENTITY)) {
if (pd_get_identity_discovery(port, TCPCI_MSG_SOP_PRIME) ==
PD_DISC_NEEDED) {
pe[port].tx_type = TCPCI_MSG_SOP_PRIME;
set_state_pe(port, PE_VDM_IDENTITY_REQUEST_CBL);
return true;
} else if (pd_get_identity_discovery(port, TCPCI_MSG_SOP) ==
PD_DISC_NEEDED &&
pe_can_send_sop_vdm(port, CMD_DISCOVER_IDENT)) {
pe[port].tx_type = TCPCI_MSG_SOP;
set_state_pe(port,
PE_INIT_PORT_VDM_IDENTITY_REQUEST);
return true;
} else if (pd_get_svids_discovery(port, TCPCI_MSG_SOP) ==
PD_DISC_NEEDED &&
pe_can_send_sop_vdm(port, CMD_DISCOVER_SVID)) {
pe[port].tx_type = TCPCI_MSG_SOP;
set_state_pe(port, PE_INIT_VDM_SVIDS_REQUEST);
return true;
} else if (pd_get_modes_discovery(port, TCPCI_MSG_SOP) ==
PD_DISC_NEEDED &&
pe_can_send_sop_vdm(port, CMD_DISCOVER_MODES)) {
pe[port].tx_type = TCPCI_MSG_SOP;
set_state_pe(port, PE_INIT_VDM_MODES_REQUEST);
return true;
} else if (pd_get_svids_discovery(port, TCPCI_MSG_SOP_PRIME)
== PD_DISC_NEEDED) {
pe[port].tx_type = TCPCI_MSG_SOP_PRIME;
set_state_pe(port, PE_INIT_VDM_SVIDS_REQUEST);
return true;
} else if (pd_get_modes_discovery(port, TCPCI_MSG_SOP_PRIME) ==
PD_DISC_NEEDED) {
pe[port].tx_type = TCPCI_MSG_SOP_PRIME;
set_state_pe(port, PE_INIT_VDM_MODES_REQUEST);
return true;
}
}
return false;
}
bool pd_setup_vdm_request(int port, enum tcpci_msg_type tx_type,
uint32_t *vdm, uint32_t vdo_cnt)
{
if (vdo_cnt < VDO_HDR_SIZE || vdo_cnt > VDO_MAX_SIZE)
return false;
pe[port].tx_type = tx_type;
memcpy(pe[port].vdm_data, vdm, vdo_cnt * sizeof(*vdm));
pe[port].vdm_cnt = vdo_cnt;
return true;
}
int pd_dev_store_rw_hash(int port, uint16_t dev_id, uint32_t *rw_hash,
uint32_t current_image)
{
pe[port].dev_id = dev_id;
memcpy(pe[port].dev_rw_hash, rw_hash, PD_RW_HASH_SIZE);
#ifdef CONFIG_CMD_PD_DEV_DUMP_INFO
pd_dev_dump_info(dev_id, rw_hash);
#endif
pe[port].current_image = current_image;
if (IS_ENABLED(CONFIG_USB_PD_HOST_CMD)) {
int i;
/* Search table for matching device / hash */
for (i = 0; i < RW_HASH_ENTRIES; i++)
if (dev_id == rw_hash_table[i].dev_id)
return !memcmp(rw_hash,
rw_hash_table[i].dev_rw_hash,
PD_RW_HASH_SIZE);
}
return 0;
}
void pd_dev_get_rw_hash(int port, uint16_t *dev_id, uint8_t *rw_hash,
uint32_t *current_image)
{
*dev_id = pe[port].dev_id;
*current_image = pe[port].current_image;
if (*dev_id)
memcpy(rw_hash, pe[port].dev_rw_hash, PD_RW_HASH_SIZE);
}
/*
* This function must only be called from the PE_SNK_READY entry and
* PE_SRC_READY entry State.
*
* TODO(b:181339670) Rethink jitter timer restart if this is the first
* message but the partner gets a message in first, may not want to
* disable and restart it.
*/
static void pe_update_wait_and_add_jitter_timer(int port)
{
/*
* In PD2.0 Mode
*
* For Source:
* Give the sink some time to send any messages
* before we may send messages of our own. Add
* some jitter of up to ~345ms, to prevent
* multiple collisions. This delay also allows
* the sink device to request power role swap
* and allow the the accept message to be sent
* prior to CMD_DISCOVER_IDENT being sent in the
* SRC_READY state.
*
* For Sink:
* Give the source some time to send any messages before
* we start our interrogation. Add some jitter of up to
* ~345ms to prevent multiple collisions.
*/
if (prl_get_rev(port, TCPCI_MSG_SOP) == PD_REV20 &&
PE_CHK_FLAG(port, PE_FLAGS_FIRST_MSG) &&
pd_timer_is_disabled(port, PE_TIMER_WAIT_AND_ADD_JITTER)) {
pd_timer_enable(port, PE_TIMER_WAIT_AND_ADD_JITTER,
SRC_SNK_READY_HOLD_OFF_US +
(get_time().le.lo & 0xf) * 23 * MSEC);
}
}
/**
* Common sender response message handling
*
* This is setup like a pseudo state machine parent state. It
* centralizes the SenderResponseTimer for the calling states, as
* well as checking message send status.
*/
/*
* pe_sender_response_msg_entry
* Initialization for handling sender response messages.
*
* @param port USB-C Port number
*/
static void pe_sender_response_msg_entry(const int port)
{
/* Stop sender response timer */
pd_timer_disable(port, PE_TIMER_SENDER_RESPONSE);
}
/*
* pe_sender_response_msg_run
* Check status of sender response messages.
*
* The normal progression of pe_sender_response_msg_entry is:
* PENDING -> (COMPLETED/SENT) -> SENT -> SENT ...
* or
* PENDING -> DISCARDED
* PENDING -> DPM_DISCARDED
*
* NOTE: it is not valid to call this function for a message after
* receiving either PE_MSG_DISCARDED or PE_MSG_DPM_DISCARDED until
* another message has been sent and pe_sender_response_msg_entry is called
* again.
*
* @param port USB-C Port number
* @return the current pe_msg_check
*/
static enum pe_msg_check pe_sender_response_msg_run(const int port)
{
timestamp_t tx_success_ts;
uint32_t offset;
if (pd_timer_is_disabled(port, PE_TIMER_SENDER_RESPONSE)) {
/* Check for Discard */
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_DISCARDED)) {
int dpm_request = pe[port].dpm_curr_request;
PE_CLR_FLAG(port, PE_FLAGS_MSG_DISCARDED);
/* Restore the DPM Request */
if (dpm_request) {
PE_SET_DPM_REQUEST(port, dpm_request);
return PE_MSG_DPM_DISCARDED;
}
return PE_MSG_DISCARDED;
}
/* Check for GoodCRC */
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
/* TCPC TX success time stamp */
tx_success_ts = prl_get_tcpc_tx_success_ts(port);
/* Calculate the delay from TX success to PE */
offset = time_since32(tx_success_ts);
/*
* Initialize and run the SenderResponseTimer by
* offsetting it with TX transmit success time.
* This would remove the effect of the latency from
* propagating the TX status.
*/
pd_timer_enable(port, PE_TIMER_SENDER_RESPONSE,
PD_T_SENDER_RESPONSE - offset);
return PE_MSG_SEND_COMPLETED;
}
return PE_MSG_SEND_PENDING;
}
return PE_MSG_SENT;
}
/*
* pe_sender_response_msg_exit
* Exit cleanup for handling sender response messages.
*
* @param port USB-C Port number
*/
static void pe_sender_response_msg_exit(int port)
{
pd_timer_disable(port, PE_TIMER_SENDER_RESPONSE);
}
/**
* PE_SRC_Startup
*/
static void pe_src_startup_entry(int port)
{
print_current_state(port);
/* Reset CapsCounter */
pe[port].caps_counter = 0;
/* Reset the protocol layer */
prl_reset_soft(port);
/* Set initial data role */
pe[port].data_role = pd_get_data_role(port);
/* Set initial power role */
pe[port].power_role = PD_ROLE_SOURCE;
/* Clear explicit contract. */
pe_invalidate_explicit_contract(port);
if (PE_CHK_FLAG(port, PE_FLAGS_PR_SWAP_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_PR_SWAP_COMPLETE);
/*
* Protocol layer reset clears the message IDs for all SOP
* types. Indicate that a SOP' soft reset is required before any
* other messages are sent to the cable.
*
* Note that other paths into this state are for the initial
* connection and for a hard reset. In both cases the cable
* should also automatically clear the message IDs so don't
* generate an SOP' soft reset for those cases. Sending
* unnecessary SOP' soft resets causes bad behavior with
* some devices. See b/179325862.
*/
pd_dpm_request(port, DPM_REQUEST_SOP_PRIME_SOFT_RESET_SEND);
/* Start SwapSourceStartTimer */
pd_timer_enable(port, PE_TIMER_SWAP_SOURCE_START,
PD_T_SWAP_SOURCE_START);
/*
* Evaluate port's sink caps for preferred current, if
* already available
*/
if (pd_get_snk_cap_cnt(port) > 0)
dpm_evaluate_sink_fixed_pdo(port,
*pd_get_snk_caps(port));
/*
* Remove prior FRS claims to 3.0 A now that sink current has
* been claimed, to avoid issues with lower priority ports
* potentially receiving a 3.0 A claim between calls.
*/
dpm_remove_source(port);
} else {
/*
* SwapSourceStartTimer delay is not needed, so trigger now.
* We can't use set_state_pe here, since we need to ensure that
* the protocol layer is running again (done in run function).
*/
pd_timer_enable(port, PE_TIMER_SWAP_SOURCE_START, 0);
/*
* Set DiscoverIdentityTimer to trigger when we enter
* src_discovery for the first time. After initial startup
* set, vdm_identity_request_cbl will handle the timer updates.
*/
pd_timer_enable(port, PE_TIMER_DISCOVER_IDENTITY, 0);
/* Clear port discovery/mode flags */
pd_dfp_discovery_init(port);
pd_dfp_mode_init(port);
dpm_init(port);
pe[port].ama_vdo = PD_VDO_INVALID;
pe[port].vpd_vdo = PD_VDO_INVALID;
pe[port].discover_identity_counter = 0;
/* Reset dr swap attempt counter */
pe[port].dr_swap_attempt_counter = 0;
/* Reset VCONN swap counter */
pe[port].vconn_swap_counter = 0;
/* Request partner sink caps if a feature requires them */
if (IS_ENABLED(CONFIG_USB_PD_HOST_CMD) ||
CONFIG_USB_PD_3A_PORTS > 0 ||
IS_ENABLED(CONFIG_USB_PD_FRS))
pd_dpm_request(port, DPM_REQUEST_GET_SNK_CAPS);
}
}
static void pe_src_startup_run(int port)
{
/* Wait until protocol layer is running */
if (!prl_is_running(port))
return;
if (pd_timer_is_expired(port, PE_TIMER_SWAP_SOURCE_START))
set_state_pe(port, PE_SRC_SEND_CAPABILITIES);
}
static void pe_src_startup_exit(int port)
{
pd_timer_disable(port, PE_TIMER_SWAP_SOURCE_START);
}
/**
* PE_SRC_Discovery
*/
static void pe_src_discovery_entry(int port)
{
print_current_state(port);
/*
* Initialize and run the SourceCapabilityTimer in order
* to trigger sending a Source_Capabilities Message.
*
* The SourceCapabilityTimer Shall continue to run during
* identity discover and Shall Not be initialized on re-entry
* to PE_SRC_Discovery.
*
* Note: Cable identity is the only valid VDM to probe before a contract
* is in place. All other probing must happen from ready states.
*/
if (get_last_state_pe(port) != PE_VDM_IDENTITY_REQUEST_CBL)
pd_timer_enable(port, PE_TIMER_SOURCE_CAP,
PD_T_SEND_SOURCE_CAP);
}
static void pe_src_discovery_run(int port)
{
/*
* Transition to the PE_SRC_Send_Capabilities state when:
* 1) The SourceCapabilityTimer times out and
* CapsCounter ≤ nCapsCount.
*
* Transition to the PE_SRC_Disabled state when:
* 1) The Port Partners are not presently PD Connected
* 2) And the SourceCapabilityTimer times out
* 3) And CapsCounter > nCapsCount.
*
* Transition to the PE_SRC_VDM_Identity_request state when:
* 1) DPM requests the identity of the cable plug and
* 2) DiscoverIdentityCounter < nDiscoverIdentityCount
*/
if (pd_timer_is_expired(port, PE_TIMER_SOURCE_CAP)) {
if (pe[port].caps_counter <= N_CAPS_COUNT) {
set_state_pe(port, PE_SRC_SEND_CAPABILITIES);
return;
} else if (!PE_CHK_FLAG(port, PE_FLAGS_PD_CONNECTION)) {
set_state_pe(port, PE_SRC_DISABLED);
return;
}
}
/*
* Note: While the DiscoverIdentityTimer is only required in an explicit
* contract, we use it here to ensure we space any potential BUSY
* requests properly.
*/
if (pd_get_identity_discovery(port, TCPCI_MSG_SOP_PRIME) ==
PD_DISC_NEEDED
&& pd_timer_is_expired(port, PE_TIMER_DISCOVER_IDENTITY)
&& pe_can_send_sop_prime(port)
&& (pe[port].discover_identity_counter <
N_DISCOVER_IDENTITY_PRECONTRACT_LIMIT)) {
pe[port].tx_type = TCPCI_MSG_SOP_PRIME;
set_state_pe(port, PE_VDM_IDENTITY_REQUEST_CBL);
return;
}
/*
* Transition to the PE_SRC_Disabled state when:
* 1) The Port Partners have not been PD Connected.
* 2) And the NoResponseTimer times out.
* 3) And the HardResetCounter > nHardResetCount.
*/
if (!PE_CHK_FLAG(port, PE_FLAGS_PD_CONNECTION) &&
pd_timer_is_expired(port, PE_TIMER_NO_RESPONSE) &&
pe[port].hard_reset_counter > N_HARD_RESET_COUNT) {
set_state_pe(port, PE_SRC_DISABLED);
return;
}
}
/**
* PE_SRC_Send_Capabilities
*/
static void pe_src_send_capabilities_entry(int port)
{
print_current_state(port);
/* Send PD Capabilities message */
send_source_cap(port);
pe_sender_response_msg_entry(port);
/* Increment CapsCounter */
pe[port].caps_counter++;
}
static void pe_src_send_capabilities_run(int port)
{
enum pe_msg_check msg_check;
/*
* Check the state of the message sent
*/
msg_check = pe_sender_response_msg_run(port);
/*
* Handle Discarded message
* PE_SNK/SRC_READY if DPM_REQUEST
* PE_SEND_SOFT_RESET otherwise
*/
if (msg_check == PE_MSG_DPM_DISCARDED) {
set_state_pe(port, PE_SRC_READY);
return;
} else if (msg_check == PE_MSG_DISCARDED) {
pe_send_soft_reset(port, TCPCI_MSG_SOP);
return;
}
/*
* Handle message that was just sent
*/
if (msg_check == PE_MSG_SEND_COMPLETED) {
/*
* If a GoodCRC Message is received then the Policy Engine
* Shall:
* 1) Stop the NoResponseTimer.
* 2) Reset the HardResetCounter and CapsCounter to zero.
* 3) Initialize and run the SenderResponseTimer.
*/
/* Stop the NoResponseTimer */
pd_timer_disable(port, PE_TIMER_NO_RESPONSE);
/* Reset the HardResetCounter to zero */
pe[port].hard_reset_counter = 0;
/* Reset the CapsCounter to zero */
pe[port].caps_counter = 0;
}
/*
* Transition to the PE_SRC_Negotiate_Capability state when:
* 1) A Request Message is received from the Sink
*/
if ((msg_check & PE_MSG_SENT) &&
PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
/*
* Request Message Received?
*/
if (PD_HEADER_CNT(rx_emsg[port].header) > 0 &&
PD_HEADER_TYPE(rx_emsg[port].header) ==
PD_DATA_REQUEST) {
/*
* Set to highest revision supported by both
* ports.
*/
prl_set_rev(port, TCPCI_MSG_SOP,
MIN(PD_REVISION, PD_HEADER_REV(rx_emsg[port].header)));
set_cable_rev(port);
/* We are PD connected */
PE_SET_FLAG(port, PE_FLAGS_PD_CONNECTION);
tc_pd_connection(port, 1);
/*
* Handle the Sink Request in
* PE_SRC_Negotiate_Capability state
*/
set_state_pe(port, PE_SRC_NEGOTIATE_CAPABILITY);
return;
}
/*
* We have a Protocol Error.
* PE_SEND_SOFT_RESET
*/
pe_send_soft_reset(port,
PD_HEADER_GET_SOP(rx_emsg[port].header));
return;
}
/*
* Transition to the PE_SRC_Discovery state when:
* 1) The Protocol Layer indicates that the Message has not been sent
* and we are presently not Connected
*
* Send soft reset when:
* 1) The Protocol Layer indicates that the Message has not been sent
* and we are already Connected
*
* See section 8.3.3.4.1.1 PE_SRC_Send_Soft_Reset State and section
* 8.3.3.2.3 PE_SRC_Send_Capabilities State.
*
* NOTE: The PE_FLAGS_PROTOCOL_ERROR is set if a GoodCRC Message
* is not received.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
if (!PE_CHK_FLAG(port, PE_FLAGS_PD_CONNECTION))
set_state_pe(port, PE_SRC_DISCOVERY);
else
pe_send_soft_reset(port, TCPCI_MSG_SOP);
return;
}
/*
* Transition to the PE_SRC_Disabled state when:
* 1) The Port Partners have not been PD Connected
* 2) The NoResponseTimer times out
* 3) And the HardResetCounter > nHardResetCount.
*
* Transition to the Error Recovery state when:
* 1) The Port Partners have previously been PD Connected
* 2) The NoResponseTimer times out
* 3) And the HardResetCounter > nHardResetCount.
*/
if (pd_timer_is_expired(port, PE_TIMER_NO_RESPONSE)) {
if (pe[port].hard_reset_counter <= N_HARD_RESET_COUNT)
set_state_pe(port, PE_SRC_HARD_RESET);
else if (PE_CHK_FLAG(port, PE_FLAGS_PD_CONNECTION))
set_state_pe(port, PE_WAIT_FOR_ERROR_RECOVERY);
else
set_state_pe(port, PE_SRC_DISABLED);
return;
}
/*
* Transition to the PE_SRC_Hard_Reset state when:
* 1) The SenderResponseTimer times out.
*/
if (pd_timer_is_expired(port, PE_TIMER_SENDER_RESPONSE)) {
set_state_pe(port, PE_SRC_HARD_RESET);
return;
}
}
static void pe_src_send_capabilities_exit(int port)
{
pe_sender_response_msg_exit(port);
}
/**
* PE_SRC_Negotiate_Capability
*/
static void pe_src_negotiate_capability_entry(int port)
{
uint32_t payload;
print_current_state(port);
/* Get message payload */
payload = *(uint32_t *)(&rx_emsg[port].buf);
/*
* Evaluate the Request from the Attached Sink
*/
/*
* Transition to the PE_SRC_Capability_Response state when:
* 1) The Request cannot be met.
* 2) Or the Request can be met later from the Power Reserve
*
* Transition to the PE_SRC_Transition_Supply state when:
* 1) The Request can be met
*
*/
if (pd_check_requested_voltage(payload, port) != EC_SUCCESS) {
set_state_pe(port, PE_SRC_CAPABILITY_RESPONSE);
} else {
PE_SET_FLAG(port, PE_FLAGS_ACCEPT);
pe[port].requested_idx = RDO_POS(payload);
set_state_pe(port, PE_SRC_TRANSITION_SUPPLY);
}
}
/**
* PE_SRC_Transition_Supply
*/
static void pe_src_transition_supply_entry(int port)
{
print_current_state(port);
/* Send a GotoMin Message or otherwise an Accept Message */
if (PE_CHK_FLAG(port, PE_FLAGS_ACCEPT)) {
PE_CLR_FLAG(port, PE_FLAGS_ACCEPT);
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_ACCEPT);
} else {
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_GOTO_MIN);
}
}
static void pe_src_transition_supply_run(int port)
{
/*
* Transition to the PE_SRC_Ready state when:
* 1) The power supply is ready.
*
* NOTE: This code block is executed twice:
* First Pass)
* When PE_FLAGS_TX_COMPLETE is set due to the
* PD_CTRL_ACCEPT or PD_CTRL_GOTO_MIN messages
* being sent.
*
* Second Pass)
* When PE_FLAGS_TX_COMPLETE is set due to the
* PD_CTRL_PS_RDY message being sent.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
/*
* NOTE: If a message was received,
* pe_src_ready state will handle it.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_PS_READY)) {
PE_CLR_FLAG(port, PE_FLAGS_PS_READY);
/*
* Set first message flag to trigger a wait and add
* jitter delay when operating in PD2.0 mode. Skip
* if we already have a contract.
*/
if (!pe_is_explicit_contract(port)) {
PE_SET_FLAG(port, PE_FLAGS_FIRST_MSG);
pd_timer_disable(port,
PE_TIMER_WAIT_AND_ADD_JITTER);
}
/* NOTE: Second pass through this code block */
/* Explicit Contract is now in place */
pe_set_explicit_contract(port);
/*
* Setup to get Device Policy Manager to request
* Source Capabilities, if needed, for possible
* PR_Swap. Get the number directly to avoid re-probing
* if the partner generated an error and left -1 for the
* count.
*/
if (pe[port].src_cap_cnt == 0)
pd_dpm_request(port, DPM_REQUEST_GET_SRC_CAPS);
set_state_pe(port, PE_SRC_READY);
} else {
/* NOTE: First pass through this code block */
/* Wait for tSrcTransition before changing supply. */
pd_timer_enable(port, PE_TIMER_SRC_TRANSITION,
PD_T_SRC_TRANSITION);
}
return;
}
if (pd_timer_is_expired(port, PE_TIMER_SRC_TRANSITION)) {
pd_timer_disable(port, PE_TIMER_SRC_TRANSITION);
/* Transition power supply and send PS_RDY. */
pd_transition_voltage(pe[port].requested_idx);
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_PS_RDY);
PE_SET_FLAG(port, PE_FLAGS_PS_READY);
}
/*
* Transition to the PE_SRC_Hard_Reset state when:
* 1) A Protocol Error occurs.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
set_state_pe(port, PE_SRC_HARD_RESET);
}
}
static void pe_src_transition_supply_exit(int port)
{
pd_timer_disable(port, PE_TIMER_SRC_TRANSITION);
}
/*
* Transitions state after receiving a Not Supported extended message. Under
* appropriate conditions, transitions to a PE_{SRC,SNK}_Chunk_Received.
*/
static void extended_message_not_supported(int port, uint32_t *payload)
{
uint16_t ext_header = GET_EXT_HEADER(*payload);
if (IS_ENABLED(CONFIG_USB_PD_REV30) &&
!IS_ENABLED(CONFIG_USB_PD_EXTENDED_MESSAGES) &&
PD_EXT_HEADER_CHUNKED(ext_header) &&
PD_EXT_HEADER_DATA_SIZE(ext_header) >
PD_MAX_EXTENDED_MSG_CHUNK_LEN) {
set_state_pe(port,
pe[port].power_role == PD_ROLE_SOURCE ?
PE_SRC_CHUNK_RECEIVED : PE_SNK_CHUNK_RECEIVED);
return;
}
set_state_pe(port, PE_SEND_NOT_SUPPORTED);
}
/**
* PE_SRC_Ready
*/
static void pe_src_ready_entry(int port)
{
print_current_state(port);
/* Ensure any message send flags are cleaned up */
PE_CLR_MASK(port, PE_MASK_READY_CLR);
/* Clear DPM Current Request */
pe[port].dpm_curr_request = 0;
/*
* Wait and add jitter if we are operating in PD2.0 mode and no messages
* have been sent since enter this state.
*/
pe_update_wait_and_add_jitter_timer(port);
}
static void pe_src_ready_run(int port)
{
/*
* Handle incoming messages before discovery and DPMs other than hard
* reset
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
uint8_t type = PD_HEADER_TYPE(rx_emsg[port].header);
uint8_t cnt = PD_HEADER_CNT(rx_emsg[port].header);
uint8_t ext = PD_HEADER_EXT(rx_emsg[port].header);
uint32_t *payload = (uint32_t *)rx_emsg[port].buf;
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
/* Extended Message Requests */
if (ext > 0) {
switch (type) {
#if defined(CONFIG_USB_PD_EXTENDED_MESSAGES) && defined(CONFIG_BATTERY)
case PD_EXT_GET_BATTERY_CAP:
set_state_pe(port, PE_GIVE_BATTERY_CAP);
break;
case PD_EXT_GET_BATTERY_STATUS:
set_state_pe(port, PE_GIVE_BATTERY_STATUS);
break;
#endif /* CONFIG_USB_PD_EXTENDED_MESSAGES && CONFIG_BATTERY */
default:
extended_message_not_supported(port, payload);
}
return;
}
/* Data Message Requests */
else if (cnt > 0) {
switch (type) {
case PD_DATA_REQUEST:
set_state_pe(port, PE_SRC_NEGOTIATE_CAPABILITY);
return;
case PD_DATA_SINK_CAP:
break;
case PD_DATA_VENDOR_DEF:
if (PD_HEADER_TYPE(rx_emsg[port].header) ==
PD_DATA_VENDOR_DEF) {
if (PD_VDO_SVDM(*payload)) {
set_state_pe(port,
PE_VDM_RESPONSE);
} else
set_state_pe(port,
PE_HANDLE_CUSTOM_VDM_REQUEST);
}
return;
case PD_DATA_BIST:
set_state_pe(port, PE_BIST_TX);
return;
default:
set_state_pe(port, PE_SEND_NOT_SUPPORTED);
return;
}
}
/* Control Message Requests */
else {
switch (type) {
case PD_CTRL_GOOD_CRC:
break;
case PD_CTRL_NOT_SUPPORTED:
break;
case PD_CTRL_PING:
break;
case PD_CTRL_GET_SOURCE_CAP:
set_state_pe(port, PE_SRC_SEND_CAPABILITIES);
return;
case PD_CTRL_GET_SINK_CAP:
set_state_pe(port, PE_SNK_GIVE_SINK_CAP);
return;
case PD_CTRL_GOTO_MIN:
break;
case PD_CTRL_PR_SWAP:
set_state_pe(port,
PE_PRS_SRC_SNK_EVALUATE_SWAP);
return;
case PD_CTRL_DR_SWAP:
if (PE_CHK_FLAG(port,
PE_FLAGS_MODAL_OPERATION)) {
set_state_pe(port, PE_SRC_HARD_RESET);
return;
}
set_state_pe(port, PE_DRS_EVALUATE_SWAP);
return;
case PD_CTRL_VCONN_SWAP:
if (IS_ENABLED(CONFIG_USBC_VCONN))
set_state_pe(port,
PE_VCS_EVALUATE_SWAP);
else
set_state_pe(port,
PE_SEND_NOT_SUPPORTED);
return;
/*
* USB PD 3.0 6.8.1:
* Receiving an unexpected message shall be responded
* to with a soft reset message.
*/
case PD_CTRL_ACCEPT:
case PD_CTRL_REJECT:
case PD_CTRL_WAIT:
case PD_CTRL_PS_RDY:
pe_send_soft_reset(port,
PD_HEADER_GET_SOP(rx_emsg[port].header));
return;
/*
* Receiving an unknown or unsupported message
* shall be responded to with a not supported message.
*/
default:
set_state_pe(port, PE_SEND_NOT_SUPPORTED);
return;
}
}
}
/*
* Make sure the PRL layer isn't busy with receiving or transmitting
* chunked messages before attempting to transmit a new message.
*/
if (prl_is_busy(port))
return;
if (PE_CHK_FLAG(port, PE_FLAGS_VDM_REQUEST_CONTINUE)) {
PE_CLR_FLAG(port, PE_FLAGS_VDM_REQUEST_CONTINUE);
set_state_pe(port, PE_VDM_REQUEST_DPM);
return;
}
if (PE_CHK_FLAG(port, PE_FLAGS_WAITING_PR_SWAP) &&
pd_timer_is_expired(port, PE_TIMER_PR_SWAP_WAIT)) {
PE_CLR_FLAG(port, PE_FLAGS_WAITING_PR_SWAP);
PE_SET_DPM_REQUEST(port, DPM_REQUEST_PR_SWAP);
}
if (pd_timer_is_disabled(port, PE_TIMER_WAIT_AND_ADD_JITTER) ||
pd_timer_is_expired(port, PE_TIMER_WAIT_AND_ADD_JITTER)) {
PE_CLR_FLAG(port, PE_FLAGS_FIRST_MSG);
pd_timer_disable(port, PE_TIMER_WAIT_AND_ADD_JITTER);
/*
* Handle Device Policy Manager Requests
*/
if (source_dpm_requests(port))
return;
/*
* Attempt discovery if possible, and return if state was
* changed for that discovery.
*/
if (pe_attempt_port_discovery(port))
return;
/* No DPM requests; attempt mode entry/exit if needed */
dpm_run(port);
}
}
/**
* PE_SRC_Disabled
*/
static void pe_src_disabled_entry(int port)
{
print_current_state(port);
if ((get_usb_pd_cable_type(port) == IDH_PTYPE_VPD) &&
is_vpd_ct_supported(port)) {
/*
* Inform the Device Policy Manager that a Charge-Through VCONN
* Powered Device was detected.
*/
tc_ctvpd_detected(port);
}
if (pd_get_power_role(port) == PD_ROLE_SOURCE)
dpm_add_non_pd_sink(port);
/*
* Unresponsive to USB Power Delivery messaging, but not to Hard Reset
* Signaling. See pe_got_hard_reset
*/
}
/**
* PE_SRC_Capability_Response
*/
static void pe_src_capability_response_entry(int port)
{
print_current_state(port);
/* NOTE: Wait messaging should be implemented. */
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_REJECT);
}
static void pe_src_capability_response_run(int port)
{
/*
* Transition to the PE_SRC_Ready state when:
* 1) There is an Explicit Contract and
* 2) A Reject Message has been sent and the present Contract is still
* Valid or
* 3) A Wait Message has been sent.
*
* Transition to the PE_SRC_Hard_Reset state when:
* 1) There is an Explicit Contract and
* 2) The Reject Message has been sent and the present
* Contract is Invalid
*
* Transition to the PE_SRC_Wait_New_Capabilities state when:
* 1) There is no Explicit Contract and
* 2) A Reject Message has been sent or
* 3) A Wait Message has been sent.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
if (PE_CHK_FLAG(port, PE_FLAGS_EXPLICIT_CONTRACT))
/*
* NOTE: The src capabilities listed in
* board/xxx/usb_pd_policy.c will not
* change so the present contract will
* never be invalid.
*/
set_state_pe(port, PE_SRC_READY);
else
/*
* NOTE: The src capabilities listed in
* board/xxx/usb_pd_policy.c will not
* change, so no need to resending them
* again. Transition to disabled state.
*/
set_state_pe(port, PE_SRC_DISABLED);
}
}
/**
* PE_SRC_Hard_Reset
*/
static void pe_src_hard_reset_entry(int port)
{
print_current_state(port);
/* Generate Hard Reset Signal */
prl_execute_hard_reset(port);
/* Increment the HardResetCounter */
pe[port].hard_reset_counter++;
/* Start NoResponseTimer */
pd_timer_enable(port, PE_TIMER_NO_RESPONSE, PD_T_NO_RESPONSE);
/* Start PSHardResetTimer */
pd_timer_enable(port, PE_TIMER_PS_HARD_RESET, PD_T_PS_HARD_RESET);
/* Clear error flags */
PE_CLR_MASK(port,
BIT(PE_FLAGS_VDM_REQUEST_NAKED_FN) |
BIT(PE_FLAGS_PROTOCOL_ERROR_FN) |
BIT(PE_FLAGS_VDM_REQUEST_BUSY_FN));
}
static void pe_src_hard_reset_run(int port)
{
/*
* Transition to the PE_SRC_Transition_to_default state when:
* 1) The PSHardResetTimer times out.
*/
if (pd_timer_is_expired(port, PE_TIMER_PS_HARD_RESET))
set_state_pe(port, PE_SRC_TRANSITION_TO_DEFAULT);
}
static void pe_src_hard_reset_exit(int port)
{
pd_timer_disable(port, PE_TIMER_PS_HARD_RESET);
}
/**
* PE_SRC_Hard_Reset_Received
*/
static void pe_src_hard_reset_received_entry(int port)
{
print_current_state(port);
/* Start NoResponseTimer */
pd_timer_enable(port, PE_TIMER_NO_RESPONSE, PD_T_NO_RESPONSE);
/* Start PSHardResetTimer */
pd_timer_enable(port, PE_TIMER_PS_HARD_RESET, PD_T_PS_HARD_RESET);
}
static void pe_src_hard_reset_received_run(int port)
{
/*
* Transition to the PE_SRC_Transition_to_default state when:
* 1) The PSHardResetTimer times out.
*/
if (pd_timer_is_expired(port, PE_TIMER_PS_HARD_RESET))
set_state_pe(port, PE_SRC_TRANSITION_TO_DEFAULT);
}
static void pe_src_hard_reset_received_exit(int port)
{
pd_timer_disable(port, PE_TIMER_PS_HARD_RESET);
}
/**
* PE_SRC_Transition_To_Default
*/
static void pe_src_transition_to_default_entry(int port)
{
print_current_state(port);
/* Reset flags */
pe[port].flags = 0;
/* Reset DPM Request */
pe[port].dpm_request = 0;
/*
* Request Device Policy Manager to request power
* supply Hard Resets to vSafe5V via vSafe0V
* Reset local HW
* Request Device Policy Manager to set Port Data
* Role to DFP and turn off VCONN
*/
tc_hard_reset_request(port);
}
static void pe_src_transition_to_default_run(int port)
{
/*
* Transition to the PE_SRC_Startup state when:
* 1) The power supply has reached the default level.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_PS_RESET_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_PS_RESET_COMPLETE);
/* Inform the Protocol Layer that the Hard Reset is complete */
prl_hard_reset_complete(port);
set_state_pe(port, PE_SRC_STARTUP);
}
}
/**
* PE_SNK_Startup State
*/
static void pe_snk_startup_entry(int port)
{
print_current_state(port);
/* Reset the protocol layer */
prl_reset_soft(port);
/* Set initial data role */
pe[port].data_role = pd_get_data_role(port);
/* Set initial power role */
pe[port].power_role = PD_ROLE_SINK;
/* Invalidate explicit contract */
pe_invalidate_explicit_contract(port);
if (PE_CHK_FLAG(port, PE_FLAGS_PR_SWAP_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_PR_SWAP_COMPLETE);
/*
* Protocol layer reset clears the message IDs for all SOP
* types. Indicate that a SOP' soft reset is required before any
* other messages are sent to the cable.
*
* Note that other paths into this state are for the initial
* connection and for a hard reset. In both cases the cable
* should also automatically clear the message IDs so don't
* generate an SOP' soft reset for those cases. Sending
* unnecessary SOP' soft resets causes bad behavior with
* some devices. See b/179325862.
*/
pd_dpm_request(port, DPM_REQUEST_SOP_PRIME_SOFT_RESET_SEND);
/*
* Some port partners may violate spec and attempt to
* communicate with the cable after power role swaps, despite
* not being Vconn source. Disable our SOP' receiving here to
* avoid GoodCRC-ing any erroneous cable probes, and re-enable
* after our contract is in place.
*/
if (tc_is_vconn_src(port))
tcpm_sop_prime_enable(port, false);
dpm_remove_sink(port);
} else {
/*
* Set DiscoverIdentityTimer to trigger when we enter
* snk_ready for the first time.
*/
pd_timer_enable(port, PE_TIMER_DISCOVER_IDENTITY, 0);
/* Clear port discovery/mode flags */
pd_dfp_discovery_init(port);
pd_dfp_mode_init(port);
dpm_init(port);
pe[port].discover_identity_counter = 0;
/* Reset dr swap attempt counter */
pe[port].dr_swap_attempt_counter = 0;
/* Reset VCONN swap counter */
pe[port].vconn_swap_counter = 0;
/*
* TODO: POLICY decision:
* Mark that we'd like to try being Vconn source and DFP
*/
PE_SET_FLAG(port, PE_FLAGS_DR_SWAP_TO_DFP);
PE_SET_FLAG(port, PE_FLAGS_VCONN_SWAP_TO_ON);
}
/*
* Request sink caps for FRS, output power consideration, or reporting
* to the AP through host commands.
*
* On entry to the PE_SNK_Ready state if the Sink supports Fast Role
* Swap, then the Policy Engine Shall do the following:
* - Send a Get_Sink_Cap Message
*/
if (IS_ENABLED(CONFIG_USB_PD_HOST_CMD) ||
CONFIG_USB_PD_3A_PORTS > 0 ||
IS_ENABLED(CONFIG_USB_PD_FRS))
pd_dpm_request(port, DPM_REQUEST_GET_SNK_CAPS);
}
static void pe_snk_startup_run(int port)
{
/* Wait until protocol layer is running */
if (!prl_is_running(port))
return;
/*
* Once the reset process completes, the Policy Engine Shall
* transition to the PE_SNK_Discovery state
*/
set_state_pe(port, PE_SNK_DISCOVERY);
}
/**
* PE_SNK_Discovery State
*/
static void pe_snk_discovery_entry(int port)
{
print_current_state(port);
}
static void pe_snk_discovery_run(int port)
{
/*
* Transition to the PE_SNK_Wait_for_Capabilities state when:
* 1) VBUS has been detected
*/
if (!pd_check_vbus_level(port, VBUS_REMOVED))
set_state_pe(port, PE_SNK_WAIT_FOR_CAPABILITIES);
}
/**
* PE_SNK_Wait_For_Capabilities State
*/
static void pe_snk_wait_for_capabilities_entry(int port)
{
print_current_state(port);
/* Initialize and start the SinkWaitCapTimer */
pd_timer_enable(port, PE_TIMER_TIMEOUT, PD_T_SINK_WAIT_CAP);
}
static void pe_snk_wait_for_capabilities_run(int port)
{
uint8_t type;
uint8_t cnt;
uint8_t ext;
/*
* Transition to the PE_SNK_Evaluate_Capability state when:
* 1) A Source_Capabilities Message is received.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
type = PD_HEADER_TYPE(rx_emsg[port].header);
cnt = PD_HEADER_CNT(rx_emsg[port].header);
ext = PD_HEADER_EXT(rx_emsg[port].header);
if ((ext == 0) && (cnt > 0) && (type == PD_DATA_SOURCE_CAP)) {
set_state_pe(port, PE_SNK_EVALUATE_CAPABILITY);
return;
}
}
/* When the SinkWaitCapTimer times out, perform a Hard Reset. */
if (pd_timer_is_expired(port, PE_TIMER_TIMEOUT)) {
PE_SET_FLAG(port, PE_FLAGS_SNK_WAIT_CAP_TIMEOUT);
set_state_pe(port, PE_SNK_HARD_RESET);
}
}
static void pe_snk_wait_for_capabilities_exit(int port)
{
pd_timer_disable(port, PE_TIMER_TIMEOUT);
}
/**
* PE_SNK_Evaluate_Capability State
*/
static void pe_snk_evaluate_capability_entry(int port)
{
uint32_t *pdo = (uint32_t *)rx_emsg[port].buf;
uint32_t num = rx_emsg[port].len >> 2;
print_current_state(port);
/* Reset Hard Reset counter to zero */
pe[port].hard_reset_counter = 0;
/* Set to highest revision supported by both ports. */
prl_set_rev(port, TCPCI_MSG_SOP,
MIN(PD_REVISION, PD_HEADER_REV(rx_emsg[port].header)));
set_cable_rev(port);
/* Parse source caps if they have changed */
if (pe[port].src_cap_cnt != num ||
memcmp(pdo, pe[port].src_caps, num << 2)) {
/*
* If port policy preference is to be a power role source,
* then request a power role swap. If we'd previously queued a
* PR swap but can now charge from this device, clear it.
*/
if (!pd_can_charge_from_device(port, num, pdo))
pd_request_power_swap(port);
else
PE_CLR_DPM_REQUEST(port, DPM_REQUEST_PR_SWAP);
}
pe_update_src_pdo_flags(port, num, pdo);
pd_set_src_caps(port, num, pdo);
/* Evaluate the options based on supplied capabilities */
pd_process_source_cap(port, pe[port].src_cap_cnt, pe[port].src_caps);
/* Device Policy Response Received */
set_state_pe(port, PE_SNK_SELECT_CAPABILITY);
#ifdef HAS_TASK_DPS
/* Wake DPS task to evaluate the SrcCaps */
task_wake(TASK_ID_DPS);
#endif
}
/**
* PE_SNK_Select_Capability State
*/
static void pe_snk_select_capability_entry(int port)
{
print_current_state(port);
/* Send Request */
pe_send_request_msg(port);
pe_sender_response_msg_entry(port);
/* We are PD Connected */
PE_SET_FLAG(port, PE_FLAGS_PD_CONNECTION);
tc_pd_connection(port, 1);
}
static void pe_snk_select_capability_run(int port)
{
uint8_t type;
uint8_t cnt;
enum tcpci_msg_type sop;
enum pe_msg_check msg_check;
/*
* Check the state of the message sent
*/
msg_check = pe_sender_response_msg_run(port);
/*
* Handle discarded message
*/
if (msg_check & PE_MSG_DISCARDED) {
/*
* The sent REQUEST message was discarded. This can be at
* the start of an AMS or in the middle. Handle what to
* do based on where we came from.
* 1) SE_SNK_EVALUATE_CAPABILITY: sends SoftReset
* 2) SE_SNK_READY: goes back to SNK Ready
*/
if (get_last_state_pe(port) == PE_SNK_EVALUATE_CAPABILITY)
pe_send_soft_reset(port, TCPCI_MSG_SOP);
else
set_state_pe(port, PE_SNK_READY);
return;
}
if ((msg_check & PE_MSG_SENT) &&
PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
type = PD_HEADER_TYPE(rx_emsg[port].header);
cnt = PD_HEADER_CNT(rx_emsg[port].header);
sop = PD_HEADER_GET_SOP(rx_emsg[port].header);
/*
* Transition to the PE_SNK_Transition_Sink state when:
* 1) An Accept Message is received from the Source.
*
* Transition to the PE_SNK_Wait_for_Capabilities state when:
* 1) There is no Explicit Contract in place and
* 2) A Reject Message is received from the Source or
* 3) A Wait Message is received from the Source.
*
* Transition to the PE_SNK_Ready state when:
* 1) There is an Explicit Contract in place and
* 2) A Reject Message is received from the Source or
* 3) A Wait Message is received from the Source.
*
* Transition to the PE_SNK_Hard_Reset state when:
* 1) A SenderResponseTimer timeout occurs.
*/
/* Only look at control messages */
if (cnt == 0) {
/*
* Accept Message Received
*/
if (type == PD_CTRL_ACCEPT) {
/* explicit contract is now in place */
pe_set_explicit_contract(port);
set_state_pe(port, PE_SNK_TRANSITION_SINK);
return;
}
/*
* Reject or Wait Message Received
*/
else if (type == PD_CTRL_REJECT ||
type == PD_CTRL_WAIT) {
if (type == PD_CTRL_WAIT)
PE_SET_FLAG(port, PE_FLAGS_WAIT);
pd_timer_disable(port, PE_TIMER_SINK_REQUEST);
/*
* We had a previous explicit contract, so
* transition to PE_SNK_Ready
*/
if (PE_CHK_FLAG(port,
PE_FLAGS_EXPLICIT_CONTRACT))
set_state_pe(port, PE_SNK_READY);
/*
* No previous explicit contract, so transition
* to PE_SNK_Wait_For_Capabilities
*/
else
set_state_pe(port,
PE_SNK_WAIT_FOR_CAPABILITIES);
return;
}
/*
* Unexpected Control Message Received
*/
else {
/* Send Soft Reset */
pe_send_soft_reset(port, sop);
return;
}
}
/*
* Unexpected Data Message
*/
else {
/* Send Soft Reset */
pe_send_soft_reset(port, sop);
return;
}
}
/* SenderResponsetimer timeout */
if (pd_timer_is_expired(port, PE_TIMER_SENDER_RESPONSE))
set_state_pe(port, PE_SNK_HARD_RESET);
}
void pe_snk_select_capability_exit(int port)
{
pe_sender_response_msg_exit(port);
}
/**
* PE_SNK_Transition_Sink State
*/
static void pe_snk_transition_sink_entry(int port)
{
print_current_state(port);
/* Initialize and run PSTransitionTimer */
pd_timer_enable(port, PE_TIMER_PS_TRANSITION, PD_T_PS_TRANSITION);
}
static void pe_snk_transition_sink_run(int port)
{
/*
* Transition to the PE_SNK_Ready state when:
* 1) A PS_RDY Message is received from the Source.
*
* Transition to the PE_SNK_Hard_Reset state when:
* 1) A Protocol Error occurs.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
/*
* PS_RDY message received
*/
if ((PD_HEADER_CNT(rx_emsg[port].header) == 0) &&
(PD_HEADER_TYPE(rx_emsg[port].header) ==
PD_CTRL_PS_RDY)) {
/*
* Set first message flag to trigger a wait and add
* jitter delay when operating in PD2.0 mode.
*/
PE_SET_FLAG(port, PE_FLAGS_FIRST_MSG);
pd_timer_disable(port, PE_TIMER_WAIT_AND_ADD_JITTER);
/*
* If we've successfully completed our new power
* contract, ensure SOP' communication is enabled before
* entering PE_SNK_READY. It may have been disabled
* during a power role swap to avoid interoperability
* issues with out-of-spec partners.
*/
if (tc_is_vconn_src(port))
tcpm_sop_prime_enable(port, true);
/*
* Evaluate port's sink caps for FRS current, if
* already available
*/
if (pd_get_snk_cap_cnt(port) > 0)
dpm_evaluate_sink_fixed_pdo(port,
*pd_get_snk_caps(port));
set_state_pe(port, PE_SNK_READY);
} else {
/*
* Protocol Error
*/
set_state_pe(port, PE_SNK_HARD_RESET);
}
return;
}
/*
* Timeout will lead to a Hard Reset
*/
if (pd_timer_is_expired(port, PE_TIMER_PS_TRANSITION) &&
pe[port].hard_reset_counter <= N_HARD_RESET_COUNT) {
PE_SET_FLAG(port, PE_FLAGS_PS_TRANSITION_TIMEOUT);
set_state_pe(port, PE_SNK_HARD_RESET);
}
}
static void pe_snk_transition_sink_exit(int port)
{
/* Transition Sink's power supply to the new power level */
pd_set_input_current_limit(port,
pe[port].curr_limit, pe[port].supply_voltage);
if (IS_ENABLED(CONFIG_CHARGE_MANAGER))
/* Set ceiling based on what's negotiated */
charge_manager_set_ceil(port,
CEIL_REQUESTOR_PD, pe[port].curr_limit);
pd_timer_disable(port, PE_TIMER_PS_TRANSITION);
if (IS_ENABLED(CONFIG_USB_PD_DPS))
if (charge_manager_get_active_charge_port() == port)
dps_update_stabilized_time(port);
}
/**
* PE_SNK_Ready State
*/
static void pe_snk_ready_entry(int port)
{
print_current_state(port);
/* Ensure any message send flags are cleaned up */
PE_CLR_MASK(port, PE_MASK_READY_CLR);
/* Clear DPM Current Request */
pe[port].dpm_curr_request = 0;
/*
* On entry to the PE_SNK_Ready state as the result of a wait,
* then do the following:
* 1) Initialize and run the SinkRequestTimer
*/
if (PE_CHK_FLAG(port, PE_FLAGS_WAIT)) {
PE_CLR_FLAG(port, PE_FLAGS_WAIT);
pd_timer_enable(port, PE_TIMER_SINK_REQUEST,
PD_T_SINK_REQUEST);
}
/*
* Wait and add jitter if we are operating in PD2.0 mode and no messages
* have been sent since enter this state.
*/
pe_update_wait_and_add_jitter_timer(port);
}
static void pe_snk_ready_run(int port)
{
/*
* Handle incoming messages before discovery and DPMs other than hard
* reset
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
uint8_t type = PD_HEADER_TYPE(rx_emsg[port].header);
uint8_t cnt = PD_HEADER_CNT(rx_emsg[port].header);
uint8_t ext = PD_HEADER_EXT(rx_emsg[port].header);
uint32_t *payload = (uint32_t *)rx_emsg[port].buf;
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
/* Extended Message Request */
if (ext > 0) {
switch (type) {
#if defined(CONFIG_USB_PD_EXTENDED_MESSAGES) && defined(CONFIG_BATTERY)
case PD_EXT_GET_BATTERY_CAP:
set_state_pe(port, PE_GIVE_BATTERY_CAP);
break;
case PD_EXT_GET_BATTERY_STATUS:
set_state_pe(port, PE_GIVE_BATTERY_STATUS);
break;
#endif /* CONFIG_USB_PD_EXTENDED_MESSAGES && CONFIG_BATTERY */
default:
extended_message_not_supported(port, payload);
}
return;
}
/* Data Messages */
else if (cnt > 0) {
switch (type) {
case PD_DATA_SOURCE_CAP:
set_state_pe(port,
PE_SNK_EVALUATE_CAPABILITY);
break;
case PD_DATA_VENDOR_DEF:
if (PD_HEADER_TYPE(rx_emsg[port].header) ==
PD_DATA_VENDOR_DEF) {
if (PD_VDO_SVDM(*payload))
set_state_pe(port,
PE_VDM_RESPONSE);
else
set_state_pe(port,
PE_HANDLE_CUSTOM_VDM_REQUEST);
}
break;
case PD_DATA_BIST:
set_state_pe(port, PE_BIST_TX);
break;
default:
set_state_pe(port, PE_SEND_NOT_SUPPORTED);
}
return;
}
/* Control Messages */
else {
switch (type) {
case PD_CTRL_GOOD_CRC:
/* Do nothing */
break;
case PD_CTRL_PING:
/* Do nothing */
break;
case PD_CTRL_GET_SOURCE_CAP:
set_state_pe(port, PE_DR_SNK_GIVE_SOURCE_CAP);
return;
case PD_CTRL_GET_SINK_CAP:
set_state_pe(port, PE_SNK_GIVE_SINK_CAP);
return;
case PD_CTRL_GOTO_MIN:
set_state_pe(port, PE_SNK_TRANSITION_SINK);
return;
case PD_CTRL_PR_SWAP:
set_state_pe(port,
PE_PRS_SNK_SRC_EVALUATE_SWAP);
return;
case PD_CTRL_DR_SWAP:
if (PE_CHK_FLAG(port, PE_FLAGS_MODAL_OPERATION))
set_state_pe(port, PE_SNK_HARD_RESET);
else
set_state_pe(port,
PE_DRS_EVALUATE_SWAP);
return;
case PD_CTRL_VCONN_SWAP:
if (IS_ENABLED(CONFIG_USBC_VCONN))
set_state_pe(port,
PE_VCS_EVALUATE_SWAP);
else
set_state_pe(port,
PE_SEND_NOT_SUPPORTED);
return;
case PD_CTRL_NOT_SUPPORTED:
/* Do nothing */
break;
/*
* USB PD 3.0 6.8.1:
* Receiving an unexpected message shall be responded
* to with a soft reset message.
*/
case PD_CTRL_ACCEPT:
case PD_CTRL_REJECT:
case PD_CTRL_WAIT:
case PD_CTRL_PS_RDY:
pe_send_soft_reset(port,
PD_HEADER_GET_SOP(rx_emsg[port].header));
return;
/*
* Receiving an unknown or unsupported message
* shall be responded to with a not supported message.
*/
default:
set_state_pe(port, PE_SEND_NOT_SUPPORTED);
return;
}
}
}
/*
* Make sure the PRL layer isn't busy with receiving or transmitting
* chunked messages before attempting to transmit a new message.
*/
if (prl_is_busy(port))
return;
if (PE_CHK_FLAG(port, PE_FLAGS_VDM_REQUEST_CONTINUE)) {
PE_CLR_FLAG(port, PE_FLAGS_VDM_REQUEST_CONTINUE);
set_state_pe(port, PE_VDM_REQUEST_DPM);
return;
}
if (pd_timer_is_disabled(port, PE_TIMER_WAIT_AND_ADD_JITTER) ||
pd_timer_is_expired(port, PE_TIMER_WAIT_AND_ADD_JITTER)) {
PE_CLR_FLAG(port, PE_FLAGS_FIRST_MSG);
pd_timer_disable(port, PE_TIMER_WAIT_AND_ADD_JITTER);
if (pd_timer_is_expired(port, PE_TIMER_SINK_REQUEST)) {
pd_timer_disable(port, PE_TIMER_SINK_REQUEST);
set_state_pe(port, PE_SNK_SELECT_CAPABILITY);
return;
}
/*
* Handle Device Policy Manager Requests
*/
if (sink_dpm_requests(port))
return;
/*
* Attempt discovery if possible, and return if state was
* changed for that discovery.
*/
if (pe_attempt_port_discovery(port))
return;
/* No DPM requests; attempt mode entry/exit if needed */
dpm_run(port);
}
}
/**
* PE_SNK_Hard_Reset
*/
static void pe_snk_hard_reset_entry(int port)
{
#ifdef CONFIG_USB_PD_RESET_MIN_BATT_SOC
int batt_soc;
#endif
print_current_state(port);
/*
* Note: If the SinkWaitCapTimer times out and the HardResetCounter is
* greater than nHardResetCount the Sink Shall assume that the
* Source is non-responsive.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_SNK_WAIT_CAP_TIMEOUT) &&
pe[port].hard_reset_counter > N_HARD_RESET_COUNT) {
set_state_pe(port, PE_SRC_DISABLED);
return;
}
/*
* If we're about to kill our active charge port and have no battery to
* supply power, disable the PE layer instead. If we have no battery,
* but we haven't determined our active charge port yet, also avoid
* performing the HardReset. It might be that this port was our active
* charge port.
*
* Note: On systems without batteries (ex. chromeboxes), it's preferable
* to brown out rather than leave the port only semi-functional for a
* customer. For systems which should have a battery, this condition is
* not expected to be encountered by a customer.
*/
if (IS_ENABLED(CONFIG_BATTERY) && (battery_is_present() == BP_NO) &&
IS_ENABLED(CONFIG_CHARGE_MANAGER) &&
((port == charge_manager_get_active_charge_port() ||
(charge_manager_get_active_charge_port() == CHARGE_PORT_NONE))) &&
system_get_reset_flags() & EC_RESET_FLAG_SYSJUMP) {
CPRINTS("C%d: Disabling port to avoid brown out, "
"please reboot EC to enable port again", port);
set_state_pe(port, PE_SRC_DISABLED);
return;
}
#ifdef CONFIG_USB_PD_RESET_MIN_BATT_SOC
/*
* If the battery has not met a configured safe level for hard
* resets, set state to PE_SRC_Disabled as a hard
* reset could brown out the board.
* Note this may mean that high-power chargers will stay at
* 15W until a reset is sent, depending on boot timing.
*
* PE_FLAGS_SNK_WAITING_BATT flags will be cleared and
* PE state will be switched to PE_SNK_Startup when
* battery reaches CONFIG_USB_PD_RESET_MIN_BATT_SOC.
* See pe_update_waiting_batt_flag() for more details.
*/
batt_soc = usb_get_battery_soc();
if (batt_soc < CONFIG_USB_PD_RESET_MIN_BATT_SOC ||
battery_get_disconnect_state() != BATTERY_NOT_DISCONNECTED) {
PE_SET_FLAG(port, PE_FLAGS_SNK_WAITING_BATT);
CPRINTS("C%d: Battery low %d%%! Stay in disabled state " \
"until battery level reaches %d%%", port, batt_soc,
CONFIG_USB_PD_RESET_MIN_BATT_SOC);
set_state_pe(port, PE_SRC_DISABLED);
return;
}
#endif
PE_CLR_MASK(port,
BIT(PE_FLAGS_SNK_WAIT_CAP_TIMEOUT_FN) |
BIT(PE_FLAGS_VDM_REQUEST_NAKED_FN) |
BIT(PE_FLAGS_PROTOCOL_ERROR_FN) |
BIT(PE_FLAGS_VDM_REQUEST_BUSY_FN));
/* Request the generation of Hard Reset Signaling by the PHY Layer */
prl_execute_hard_reset(port);
/* Increment the HardResetCounter */
pe[port].hard_reset_counter++;
/*
* Transition the Sink’s power supply to the new power level if
* PSTransistionTimer timeout occurred.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_PS_TRANSITION_TIMEOUT)) {
PE_CLR_FLAG(port, PE_FLAGS_PS_TRANSITION_TIMEOUT);
/* Transition Sink's power supply to the new power level */
pd_set_input_current_limit(port, pe[port].curr_limit,
pe[port].supply_voltage);
if (IS_ENABLED(CONFIG_CHARGE_MANAGER))
/* Set ceiling based on what's negotiated */
charge_manager_set_ceil(port, CEIL_REQUESTOR_PD,
pe[port].curr_limit);
}
}
static void pe_snk_hard_reset_run(int port)
{
/*
* Transition to the PE_SNK_Transition_to_default state when:
* 1) The Hard Reset is complete.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_HARD_RESET_PENDING))
return;
set_state_pe(port, PE_SNK_TRANSITION_TO_DEFAULT);
}
/**
* PE_SNK_Transition_to_default
*/
static void pe_snk_transition_to_default_entry(int port)
{
print_current_state(port);
/* Reset flags */
pe[port].flags = 0;
/* Reset DPM Request */
pe[port].dpm_request = 0;
/* Inform the TC Layer of Hard Reset */
tc_hard_reset_request(port);
}
static void pe_snk_transition_to_default_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_PS_RESET_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_PS_RESET_COMPLETE);
/* Inform the Protocol Layer that the Hard Reset is complete */
prl_hard_reset_complete(port);
set_state_pe(port, PE_SNK_STARTUP);
}
}
/**
* PE_SNK_Get_Source_Cap
*/
static void pe_snk_get_source_cap_entry(int port)
{
print_current_state(port);
/* Send a Get_Source_Cap Message */
tx_emsg[port].len = 0;
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_GET_SOURCE_CAP);
}
static void pe_snk_get_source_cap_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
set_state_pe(port, PE_SNK_READY);
}
}
/**
* PE_SNK_Send_Soft_Reset and PE_SRC_Send_Soft_Reset
*/
static void pe_send_soft_reset_entry(int port)
{
print_current_state(port);
/* Reset Protocol Layer (softly) */
prl_reset_soft(port);
pe_sender_response_msg_entry(port);
/*
* Mark the temporary timer PE_TIMER_TIMEOUT as expired to limit
* to sending a single SoftReset message.
*/
pd_timer_enable(port, PE_TIMER_TIMEOUT, 0);
}
static void pe_send_soft_reset_run(int port)
{
int type;
int cnt;
int ext;
enum pe_msg_check msg_check;
/* Wait until protocol layer is running */
if (!prl_is_running(port))
return;
/*
* Protocol layer is running, so need to send a single SoftReset.
* Use temporary timer to act as a flag to keep this as a single
* message send.
*/
if (!pd_timer_is_disabled(port, PE_TIMER_TIMEOUT)) {
pd_timer_disable(port, PE_TIMER_TIMEOUT);
/*
* TODO(b/150614211): Soft reset type should match
* unexpected incoming message type
*/
/* Send Soft Reset message */
send_ctrl_msg(port,
pe[port].soft_reset_sop, PD_CTRL_SOFT_RESET);
return;
}
/*
* Check the state of the message sent
*/
msg_check = pe_sender_response_msg_run(port);
/*
* Handle discarded message
*/
if (msg_check == PE_MSG_DISCARDED) {
pe_set_ready_state(port);
return;
}
/*
* Transition to the PE_SNK_Send_Capabilities or
* PE_SRC_Send_Capabilities state when:
* 1) An Accept Message has been received.
*/
if (msg_check == PE_MSG_SENT &&
PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
type = PD_HEADER_TYPE(rx_emsg[port].header);
cnt = PD_HEADER_CNT(rx_emsg[port].header);
ext = PD_HEADER_EXT(rx_emsg[port].header);
if ((ext == 0) && (cnt == 0) && (type == PD_CTRL_ACCEPT)) {
if (pe[port].power_role == PD_ROLE_SINK)
set_state_pe(port,
PE_SNK_WAIT_FOR_CAPABILITIES);
else
set_state_pe(port,
PE_SRC_SEND_CAPABILITIES);
return;
}
}
/*
* Transition to PE_SNK_Hard_Reset or PE_SRC_Hard_Reset on Sender
* Response Timer Timeout or Protocol Layer or Protocol Error
*/
if (pd_timer_is_expired(port, PE_TIMER_SENDER_RESPONSE) ||
PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
if (pe[port].power_role == PD_ROLE_SINK)
set_state_pe(port, PE_SNK_HARD_RESET);
else
set_state_pe(port, PE_SRC_HARD_RESET);
return;
}
}
static void pe_send_soft_reset_exit(int port)
{
pe_sender_response_msg_exit(port);
pd_timer_disable(port, PE_TIMER_TIMEOUT);
}
/**
* PE_SNK_Soft_Reset and PE_SNK_Soft_Reset
*/
static void pe_soft_reset_entry(int port)
{
print_current_state(port);
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_ACCEPT);
}
static void pe_soft_reset_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
if (pe[port].power_role == PD_ROLE_SINK)
set_state_pe(port, PE_SNK_WAIT_FOR_CAPABILITIES);
else
set_state_pe(port, PE_SRC_SEND_CAPABILITIES);
} else if (PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
if (pe[port].power_role == PD_ROLE_SINK)
set_state_pe(port, PE_SNK_HARD_RESET);
else
set_state_pe(port, PE_SRC_HARD_RESET);
}
}
/**
* PE_SRC_Not_Supported and PE_SNK_Not_Supported
*
* 6.7.1 Soft Reset and Protocol Error (Revision 2.0, Version 1.3)
* An unrecognized or unsupported Message (except for a Structured VDM),
* received in the PE_SNK_Ready or PE_SRC_Ready states, Shall Not cause
* a Soft_Reset Message to be generated but instead a Reject Message
* Shall be generated.
*/
static void pe_send_not_supported_entry(int port)
{
print_current_state(port);
/* Request the Protocol Layer to send a Not_Supported Message. */
if (prl_get_rev(port, TCPCI_MSG_SOP) > PD_REV20)
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_NOT_SUPPORTED);
else
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_REJECT);
}
static void pe_send_not_supported_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
pe_set_ready_state(port);
}
}
/**
* PE_SRC_Chunk_Received and PE_SNK_Chunk_Received
*
* 6.11.2.1.1 Architecture of Device Including Chunking Layer (Revision 3.0,
* Version 2.0): If a PD Device or Cable Marker has no requirement to handle any
* message requiring more than one Chunk of any Extended Message, it May omit
* the Chunking Layer. In this case it Shall implement the
* ChunkingNotSupportedTimer to ensure compatible operation with partners which
* support Chunking.
*
* See also:
* 6.6.18.1 ChunkingNotSupportedTimer
* 8.3.3.6 Not Supported Message State Diagrams
*/
__maybe_unused static void pe_chunk_received_entry(int port)
{
if (!IS_ENABLED(CONFIG_USB_PD_REV30) ||
IS_ENABLED(CONFIG_USB_PD_EXTENDED_MESSAGES))
assert(0);
print_current_state(port);
pd_timer_enable(port, PE_TIMER_CHUNKING_NOT_SUPPORTED,
PD_T_CHUNKING_NOT_SUPPORTED);
}
__maybe_unused static void pe_chunk_received_run(int port)
{
if (!IS_ENABLED(CONFIG_USB_PD_REV30) ||
IS_ENABLED(CONFIG_USB_PD_EXTENDED_MESSAGES))
assert(0);
if (pd_timer_is_expired(port, PE_TIMER_CHUNKING_NOT_SUPPORTED))
set_state_pe(port, PE_SEND_NOT_SUPPORTED);
}
__maybe_unused static void pe_chunk_received_exit(int port)
{
pd_timer_disable(port, PE_TIMER_CHUNKING_NOT_SUPPORTED);
}
/**
* PE_SRC_Ping
*/
static void pe_src_ping_entry(int port)
{
print_current_state(port);
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_PING);
}
static void pe_src_ping_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
set_state_pe(port, PE_SRC_READY);
}
}
#ifdef CONFIG_USB_PD_EXTENDED_MESSAGES
/**
* PE_Give_Battery_Cap
*/
static void pe_give_battery_cap_entry(int port)
{
uint8_t *payload = rx_emsg[port].buf;
uint16_t *msg = (uint16_t *)tx_emsg[port].buf;
if (!IS_ENABLED(CONFIG_BATTERY))
return;
print_current_state(port);
/* Set VID */
msg[BCDB_VID] = USB_VID_GOOGLE;
/* Set PID */
msg[BCDB_PID] = CONFIG_USB_PID;
if (battery_is_present()) {
/*
* We only have one fixed battery,
* so make sure batt cap ref is 0.
* This value is the first byte after the headers.
*/
if (payload[0] != 0) {
/* Invalid battery reference */
msg[BCDB_DESIGN_CAP] = 0;
msg[BCDB_FULL_CAP] = 0;
/* Set invalid battery bit in response bit 0, byte 8 */
msg[BCDB_BATT_TYPE] = 1;
} else {
/*
* The Battery Design Capacity field shall return the
* Battery’s design capacity in tenths of Wh. If the
* Battery is Hot Swappable and is not present, the
* Battery Design Capacity field shall be set to 0. If
* the Battery is unable to report its Design Capacity,
* it shall return 0xFFFF
*/
msg[BCDB_DESIGN_CAP] = 0xffff;
/*
* The Battery Last Full Charge Capacity field shall
* return the Battery’s last full charge capacity in
* tenths of Wh. If the Battery is Hot Swappable and
* is not present, the Battery Last Full Charge Capacity
* field shall be set to 0. If the Battery is unable to
* report its Design Capacity, the Battery Last Full
* Charge Capacity field shall be set to 0xFFFF.
*/
msg[BCDB_FULL_CAP] = 0xffff;
if (IS_ENABLED(HAS_TASK_HOSTCMD) &&
*host_get_memmap(EC_MEMMAP_BATTERY_VERSION) != 0) {
int design_volt, design_cap, full_cap;
design_volt = *(int *)host_get_memmap(
EC_MEMMAP_BATT_DVLT);
design_cap = *(int *)host_get_memmap(
EC_MEMMAP_BATT_DCAP);
full_cap = *(int *)host_get_memmap(
EC_MEMMAP_BATT_LFCC);
/*
* Wh = (c * v) / 1000000
* 10th of a Wh = Wh * 10
*/
msg[BCDB_DESIGN_CAP] = DIV_ROUND_NEAREST(
(design_cap * design_volt),
100000);
/*
* Wh = (c * v) / 1000000
* 10th of a Wh = Wh * 10
*/
msg[BCDB_FULL_CAP] = DIV_ROUND_NEAREST(
(design_cap * full_cap),
100000);
} else {
uint32_t v;
uint32_t c;
if (battery_design_voltage(&v) == 0) {
if (battery_design_capacity(&c) == 0) {
/*
* Wh = (c * v) / 1000000
* 10th of a Wh = Wh * 10
*/
msg[BCDB_DESIGN_CAP] =
DIV_ROUND_NEAREST(
(c * v),
100000);
}
if (battery_full_charge_capacity(&c)
== 0) {
/*
* Wh = (c * v) / 1000000
* 10th of a Wh = Wh * 10
*/
msg[BCDB_FULL_CAP] =
DIV_ROUND_NEAREST(
(c * v),
100000);
}
}
}
/* Valid battery selected */
msg[BCDB_BATT_TYPE] = 0;
}
} else {
/* Battery not present indicated by 0's in the capacity */
msg[BCDB_DESIGN_CAP] = 0;
msg[BCDB_FULL_CAP] = 0;
if (payload[0] != 0)
msg[BCDB_BATT_TYPE] = 1;
else
msg[BCDB_BATT_TYPE] = 0;
}
/* Extended Battery Cap data is 9 bytes */
tx_emsg[port].len = 9;
send_ext_data_msg(port, TCPCI_MSG_SOP, PD_EXT_BATTERY_CAP);
}
static void pe_give_battery_cap_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
pe_set_ready_state(port);
}
}
/**
* PE_Give_Battery_Status
*/
static void pe_give_battery_status_entry(int port)
{
uint8_t *payload = rx_emsg[port].buf;
uint32_t *msg = (uint32_t *)tx_emsg[port].buf;
if (!IS_ENABLED(CONFIG_BATTERY))
return;
print_current_state(port);
if (battery_is_present()) {
/*
* We only have one fixed battery,
* so make sure batt cap ref is 0.
* This value is the first byte after the headers.
*/
if (payload[0] != 0) {
/* Invalid battery reference */
*msg = BSDO_CAP(BSDO_CAP_UNKNOWN);
*msg |= BSDO_INVALID;
} else {
uint32_t v;
uint32_t c;
*msg = BSDO_CAP(BSDO_CAP_UNKNOWN);
if (IS_ENABLED(HAS_TASK_HOSTCMD) &&
*host_get_memmap(EC_MEMMAP_BATTERY_VERSION) != 0) {
v = *(int *)host_get_memmap(
EC_MEMMAP_BATT_DVLT);
c = *(int *)host_get_memmap(
EC_MEMMAP_BATT_CAP);
/*
* Wh = (c * v) / 1000000
* 10th of a Wh = Wh * 10
*/
*msg = BSDO_CAP(DIV_ROUND_NEAREST((c * v),
100000));
} else if (battery_design_voltage(&v) == 0 &&
battery_remaining_capacity(&c) == 0) {
/*
* Wh = (c * v) / 1000000
* 10th of a Wh = Wh * 10
*/
*msg = BSDO_CAP(DIV_ROUND_NEAREST((c * v),
100000));
}
/* Battery is present */
*msg |= BSDO_PRESENT;
/*
* For drivers that are not smart battery compliant,
* battery_status() returns EC_ERROR_UNIMPLEMENTED and
* the battery is assumed to be idle.
*/
if (battery_status(&c) != 0) {
*msg |= BSDO_IDLE; /* assume idle */
} else {
if (c & STATUS_FULLY_CHARGED)
/* Fully charged */
*msg |= BSDO_IDLE;
else if (c & STATUS_DISCHARGING)
/* Discharging */
*msg |= BSDO_DISCHARGING;
/* else battery is charging.*/
}
}
} else {
*msg = BSDO_CAP(BSDO_CAP_UNKNOWN);
if (payload[0] != 0)
*msg |= BSDO_INVALID;
}
/* Battery Status data is 4 bytes */
tx_emsg[port].len = 4;
send_data_msg(port, TCPCI_MSG_SOP, PD_DATA_BATTERY_STATUS);
}
static void pe_give_battery_status_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
set_state_pe(port, PE_SRC_READY);
}
}
/**
* PE_SRC_Send_Source_Alert and
* PE_SNK_Send_Sink_Alert
*/
static void pe_send_alert_entry(int port)
{
uint32_t *msg = (uint32_t *)tx_emsg[port].buf;
uint32_t *len = &tx_emsg[port].len;
print_current_state(port);
if (pd_build_alert_msg(msg, len, pe[port].power_role) != EC_SUCCESS)
pe_set_ready_state(port);
/* Request the Protocol Layer to send Alert Message. */
send_data_msg(port, TCPCI_MSG_SOP, PD_DATA_ALERT);
}
static void pe_send_alert_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
pe_set_ready_state(port);
}
}
#endif /* CONFIG_USB_PD_EXTENDED_MESSAGES */
/**
* PE_DRS_Evaluate_Swap
*/
static void pe_drs_evaluate_swap_entry(int port)
{
print_current_state(port);
/* Get evaluation of Data Role Swap request from DPM */
if (pd_check_data_swap(port, pe[port].data_role)) {
PE_SET_FLAG(port, PE_FLAGS_ACCEPT);
/*
* PE_DRS_UFP_DFP_Evaluate_Swap and
* PE_DRS_DFP_UFP_Evaluate_Swap states embedded here.
*/
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_ACCEPT);
} else {
/*
* PE_DRS_UFP_DFP_Reject_Swap and PE_DRS_DFP_UFP_Reject_Swap
* states embedded here.
*/
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_REJECT);
}
}
static void pe_drs_evaluate_swap_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
/* Accept Message sent. Transtion to PE_DRS_Change */
if (PE_CHK_FLAG(port, PE_FLAGS_ACCEPT)) {
PE_CLR_FLAG(port, PE_FLAGS_ACCEPT);
set_state_pe(port, PE_DRS_CHANGE);
} else {
/*
* Message sent. Transition back to PE_SRC_Ready or
* PE_SNK_Ready.
*/
pe_set_ready_state(port);
}
}
}
/**
* PE_DRS_Change
*/
static void pe_drs_change_entry(int port)
{
print_current_state(port);
/*
* PE_DRS_UFP_DFP_Change_to_DFP and PE_DRS_DFP_UFP_Change_to_UFP
* states embedded here.
*/
/* Request DPM to change port data role */
pd_request_data_swap(port);
}
static void pe_drs_change_run(int port)
{
/* Wait until the data role is changed */
if (pe[port].data_role == pd_get_data_role(port))
return;
/* Update the data role */
pe[port].data_role = pd_get_data_role(port);
if (pe[port].data_role == PD_ROLE_DFP)
PE_CLR_FLAG(port, PE_FLAGS_DR_SWAP_TO_DFP);
/*
* Port changed. Transition back to PE_SRC_Ready or
* PE_SNK_Ready.
*/
pe_set_ready_state(port);
}
/**
* PE_DRS_Send_Swap
*/
static void pe_drs_send_swap_entry(int port)
{
print_current_state(port);
/*
* PE_DRS_UFP_DFP_Send_Swap and PE_DRS_DFP_UFP_Send_Swap
* states embedded here.
*/
/* Request the Protocol Layer to send a DR_Swap Message */
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_DR_SWAP);
pe_sender_response_msg_entry(port);
}
static void pe_drs_send_swap_run(int port)
{
int type;
int cnt;
int ext;
enum pe_msg_check msg_check;
/*
* Check the state of the message sent
*/
msg_check = pe_sender_response_msg_run(port);
/*
* Transition to PE_DRS_Change when:
* 1) An Accept Message is received.
*
* Transition to PE_SRC_Ready or PE_SNK_Ready state when:
* 1) A Reject Message is received.
* 2) Or a Wait Message is received.
*/
if ((msg_check & PE_MSG_SENT) &&
PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
type = PD_HEADER_TYPE(rx_emsg[port].header);
cnt = PD_HEADER_CNT(rx_emsg[port].header);
ext = PD_HEADER_EXT(rx_emsg[port].header);
if ((ext == 0) && (cnt == 0)) {
if (type == PD_CTRL_ACCEPT) {
set_state_pe(port, PE_DRS_CHANGE);
return;
} else if ((type == PD_CTRL_REJECT) ||
(type == PD_CTRL_WAIT) ||
(type == PD_CTRL_NOT_SUPPORTED)) {
pe_set_ready_state(port);
return;
}
}
}
/*
* Transition to PE_SRC_Ready or PE_SNK_Ready state when:
* 1) the SenderResponseTimer times out.
* 2) Message was discarded.
*/
if ((msg_check & PE_MSG_DISCARDED) ||
pd_timer_is_expired(port, PE_TIMER_SENDER_RESPONSE))
pe_set_ready_state(port);
}
static void pe_drs_send_swap_exit(int port)
{
pe_sender_response_msg_exit(port);
}
/**
* PE_PRS_SRC_SNK_Evaluate_Swap
*/
static void pe_prs_src_snk_evaluate_swap_entry(int port)
{
print_current_state(port);
if (!pd_check_power_swap(port)) {
/* PE_PRS_SRC_SNK_Reject_PR_Swap state embedded here */
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_REJECT);
} else {
tc_request_power_swap(port);
/* PE_PRS_SRC_SNK_Accept_Swap state embedded here */
PE_SET_FLAG(port, PE_FLAGS_ACCEPT);
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_ACCEPT);
}
}
static void pe_prs_src_snk_evaluate_swap_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
if (PE_CHK_FLAG(port, PE_FLAGS_ACCEPT)) {
PE_CLR_FLAG(port, PE_FLAGS_ACCEPT);
/*
* Clear any pending DPM power role swap request so we
* don't trigger a power role swap request back to src
* power role.
*/
PE_CLR_DPM_REQUEST(port, DPM_REQUEST_PR_SWAP);
/*
* Power Role Swap OK, transition to
* PE_PRS_SRC_SNK_Transition_to_off
*/
set_state_pe(port, PE_PRS_SRC_SNK_TRANSITION_TO_OFF);
} else {
/* Message sent, return to PE_SRC_Ready */
set_state_pe(port, PE_SRC_READY);
}
}
}
/**
* PE_PRS_SRC_SNK_Transition_To_Off
*/
static void pe_prs_src_snk_transition_to_off_entry(int port)
{
print_current_state(port);
/* Contract is invalid */
pe_invalidate_explicit_contract(port);
/* Tell TypeC to power off the source */
tc_src_power_off(port);
pd_timer_enable(port, PE_TIMER_PS_SOURCE,
PD_POWER_SUPPLY_TURN_OFF_DELAY);
}
static void pe_prs_src_snk_transition_to_off_run(int port)
{
/*
* This is a non-interruptible AMS and power is transitioning - hard
* reset on interruption.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
tc_pr_swap_complete(port, 0);
set_state_pe(port, PE_SRC_HARD_RESET);
}
/* Give time for supply to power off */
if (pd_timer_is_expired(port, PE_TIMER_PS_SOURCE) &&
pd_check_vbus_level(port, VBUS_SAFE0V))
set_state_pe(port, PE_PRS_SRC_SNK_ASSERT_RD);
}
static void pe_prs_src_snk_transition_to_off_exit(int port)
{
pd_timer_disable(port, PE_TIMER_PS_SOURCE);
}
/**
* PE_PRS_SRC_SNK_Assert_Rd
*/
static void pe_prs_src_snk_assert_rd_entry(int port)
{
print_current_state(port);
/* Tell TypeC to swap from Attached.SRC to Attached.SNK */
tc_prs_src_snk_assert_rd(port);
}
static void pe_prs_src_snk_assert_rd_run(int port)
{
/* Wait until Rd is asserted */
if (tc_is_attached_snk(port))
set_state_pe(port, PE_PRS_SRC_SNK_WAIT_SOURCE_ON);
}
/**
* PE_PRS_SRC_SNK_Wait_Source_On
*/
static void pe_prs_src_snk_wait_source_on_entry(int port)
{
print_current_state(port);
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_PS_RDY);
}
static void pe_prs_src_snk_wait_source_on_run(int port)
{
if (pd_timer_is_disabled(port, PE_TIMER_PS_SOURCE) &&
PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
/* Update pe power role */
pe[port].power_role = pd_get_power_role(port);
pd_timer_enable(port, PE_TIMER_PS_SOURCE, PD_T_PS_SOURCE_ON);
}
/*
* Transition to PE_SNK_Startup when:
* 1) A PS_RDY Message is received.
*/
if (!pd_timer_is_disabled(port, PE_TIMER_PS_SOURCE) &&
PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
int type = PD_HEADER_TYPE(rx_emsg[port].header);
int cnt = PD_HEADER_CNT(rx_emsg[port].header);
int ext = PD_HEADER_EXT(rx_emsg[port].header);
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
if ((ext == 0) && (cnt == 0) && (type == PD_CTRL_PS_RDY)) {
PE_SET_FLAG(port, PE_FLAGS_PR_SWAP_COMPLETE);
set_state_pe(port, PE_SNK_STARTUP);
} else {
int sop = PD_HEADER_GET_SOP(rx_emsg[port].header);
/*
* USB PD 3.0 6.8.1:
* Receiving an unexpected message shall be responded
* to with a soft reset message.
*/
pe_send_soft_reset(port, sop);
}
return;
}
/*
* Transition to ErrorRecovery state when:
* 1) The PSSourceOnTimer times out.
* 2) PS_RDY not sent after retries.
*/
if (pd_timer_is_expired(port, PE_TIMER_PS_SOURCE) ||
PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
set_state_pe(port, PE_WAIT_FOR_ERROR_RECOVERY);
return;
}
}
static void pe_prs_src_snk_wait_source_on_exit(int port)
{
pd_timer_disable(port, PE_TIMER_PS_SOURCE);
tc_pr_swap_complete(port,
PE_CHK_FLAG(port, PE_FLAGS_PR_SWAP_COMPLETE));
}
/**
* PE_PRS_SRC_SNK_Send_Swap
*/
static void pe_prs_src_snk_send_swap_entry(int port)
{
print_current_state(port);
/* Making an attempt to PR_Swap, clear we were possibly waiting */
pd_timer_disable(port, PE_TIMER_PR_SWAP_WAIT);
/* Request the Protocol Layer to send a PR_Swap Message. */
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_PR_SWAP);
pe_sender_response_msg_entry(port);
}
static void pe_prs_src_snk_send_swap_run(int port)
{
int type;
int cnt;
int ext;
enum pe_msg_check msg_check;
/*
* Check the state of the message sent
*/
msg_check = pe_sender_response_msg_run(port);
/*
* Transition to PE_PRS_SRC_SNK_Transition_To_Off when:
* 1) An Accept Message is received.
*
* Transition to PE_SRC_Ready state when:
* 1) A Reject Message is received.
* 2) Or a Wait Message is received.
*/
if ((msg_check & PE_MSG_SENT) &&
PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
type = PD_HEADER_TYPE(rx_emsg[port].header);
cnt = PD_HEADER_CNT(rx_emsg[port].header);
ext = PD_HEADER_EXT(rx_emsg[port].header);
if ((ext == 0) && (cnt == 0)) {
if (type == PD_CTRL_ACCEPT) {
pe[port].src_snk_pr_swap_counter = 0;
tc_request_power_swap(port);
set_state_pe(port,
PE_PRS_SRC_SNK_TRANSITION_TO_OFF);
} else if (type == PD_CTRL_REJECT) {
pe[port].src_snk_pr_swap_counter = 0;
set_state_pe(port, PE_SRC_READY);
} else if (type == PD_CTRL_WAIT) {
if (pe[port].src_snk_pr_swap_counter <
N_SNK_SRC_PR_SWAP_COUNT) {
PE_SET_FLAG(port,
PE_FLAGS_WAITING_PR_SWAP);
pd_timer_enable(port,
PE_TIMER_PR_SWAP_WAIT,
PD_T_PR_SWAP_WAIT);
}
pe[port].src_snk_pr_swap_counter++;
set_state_pe(port, PE_SRC_READY);
}
return;
}
}
/*
* Transition to PE_SRC_Ready state when:
* 1) Or the SenderResponseTimer times out.
* 2) Message was discarded.
*/
if ((msg_check & PE_MSG_DISCARDED) ||
pd_timer_is_expired(port, PE_TIMER_SENDER_RESPONSE))
set_state_pe(port, PE_SRC_READY);
}
static void pe_prs_src_snk_send_swap_exit(int port)
{
pe_sender_response_msg_exit(port);
}
/**
* PE_PRS_SNK_SRC_Evaluate_Swap
*/
static void pe_prs_snk_src_evaluate_swap_entry(int port)
{
print_current_state(port);
/*
* Cancel any pending PR swap request due to a received Wait since the
* partner just sent us a PR swap message.
*/
PE_CLR_FLAG(port, PE_FLAGS_WAITING_PR_SWAP);
pe[port].src_snk_pr_swap_counter = 0;
if (!pd_check_power_swap(port)) {
/* PE_PRS_SNK_SRC_Reject_Swap state embedded here */
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_REJECT);
} else {
tc_request_power_swap(port);
/* PE_PRS_SNK_SRC_Accept_Swap state embedded here */
PE_SET_FLAG(port, PE_FLAGS_ACCEPT);
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_ACCEPT);
}
}
static void pe_prs_snk_src_evaluate_swap_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
if (PE_CHK_FLAG(port, PE_FLAGS_ACCEPT)) {
PE_CLR_FLAG(port, PE_FLAGS_ACCEPT);
/*
* Clear any pending DPM power role swap request so we
* don't trigger a power role swap request back to sink
* power role.
*/
PE_CLR_DPM_REQUEST(port, DPM_REQUEST_PR_SWAP);
/*
* Accept message sent, transition to
* PE_PRS_SNK_SRC_Transition_to_off
*/
set_state_pe(port, PE_PRS_SNK_SRC_TRANSITION_TO_OFF);
} else {
/* Message sent, return to PE_SNK_Ready */
set_state_pe(port, PE_SNK_READY);
}
}
if (PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
/*
* Protocol Error occurs while PR swap, this may
* brown out if the port-parnter can't hold VBUS
* for tSrcTransition. Notify TC that we end the PR
* swap and start to watch VBUS.
*
* TODO(b:155181980): issue soft reset on protocol error.
*/
tc_pr_swap_complete(port, 0);
}
}
/**
* PE_PRS_SNK_SRC_Transition_To_Off
* PE_FRS_SNK_SRC_Transition_To_Off
*
* NOTE: Shared action code used for Power Role Swap and Fast Role Swap
*/
static void pe_prs_snk_src_transition_to_off_entry(int port)
{
print_current_state(port);
if (!IS_ENABLED(CONFIG_USB_PD_REV30) ||
!pe_in_frs_mode(port))
tc_snk_power_off(port);
pd_timer_enable(port, PE_TIMER_PS_SOURCE, PD_T_PS_SOURCE_OFF);
}
static void pe_prs_snk_src_transition_to_off_run(int port)
{
int type;
int cnt;
int ext;
/*
* Transition to ErrorRecovery state when:
* 1) The PSSourceOffTimer times out.
*/
if (pd_timer_is_expired(port, PE_TIMER_PS_SOURCE))
set_state_pe(port, PE_WAIT_FOR_ERROR_RECOVERY);
/*
* Transition to PE_PRS_SNK_SRC_Assert_Rp when:
* 1) An PS_RDY Message is received.
*/
else if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
type = PD_HEADER_TYPE(rx_emsg[port].header);
cnt = PD_HEADER_CNT(rx_emsg[port].header);
ext = PD_HEADER_EXT(rx_emsg[port].header);
if ((ext == 0) && (cnt == 0) && (type == PD_CTRL_PS_RDY)) {
/*
* FRS: We are always ready to drive vSafe5v, so just
* skip PE_FRS_SNK_SRC_Vbus_Applied and go direct to
* PE_FRS_SNK_SRC_Assert_Rp
*/
set_state_pe(port, PE_PRS_SNK_SRC_ASSERT_RP);
}
}
}
static void pe_prs_snk_src_transition_to_off_exit(int port)
{
pd_timer_disable(port, PE_TIMER_PS_SOURCE);
}
/**
* PE_PRS_SNK_SRC_Assert_Rp
* PE_FRS_SNK_SRC_Assert_Rp
*
* NOTE: Shared action code used for Power Role Swap and Fast Role Swap
*/
static void pe_prs_snk_src_assert_rp_entry(int port)
{
print_current_state(port);
/*
* Tell TypeC to Power/Fast Role Swap (PRS/FRS) from
* Attached.SNK to Attached.SRC
*/
tc_prs_snk_src_assert_rp(port);
}
static void pe_prs_snk_src_assert_rp_run(int port)
{
/* Wait until TypeC is in the Attached.SRC state */
if (tc_is_attached_src(port)) {
if (!IS_ENABLED(CONFIG_USB_PD_REV30) ||
!pe_in_frs_mode(port)) {
/* Contract is invalid now */
pe_invalidate_explicit_contract(port);
}
set_state_pe(port, PE_PRS_SNK_SRC_SOURCE_ON);
}
}
/**
* PE_PRS_SNK_SRC_Source_On
* PE_FRS_SNK_SRC_Source_On
*
* NOTE: Shared action code used for Power Role Swap and Fast Role Swap
*/
static void pe_prs_snk_src_source_on_entry(int port)
{
print_current_state(port);
/*
* VBUS was enabled when the TypeC state machine entered
* Attached.SRC state
*/
pd_timer_enable(port, PE_TIMER_PS_SOURCE,
PD_POWER_SUPPLY_TURN_ON_DELAY);
}
static void pe_prs_snk_src_source_on_run(int port)
{
/* Wait until power supply turns on */
if (!pd_timer_is_disabled(port, PE_TIMER_PS_SOURCE)) {
if (!pd_timer_is_expired(port, PE_TIMER_PS_SOURCE))
return;
/* update pe power role */
pe[port].power_role = pd_get_power_role(port);
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_PS_RDY);
/* reset timer so PD_CTRL_PS_RDY isn't sent again */
pd_timer_disable(port, PE_TIMER_PS_SOURCE);
}
/*
* Transition to ErrorRecovery state when:
* 1) On protocol error
*/
else if (PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
set_state_pe(port, PE_WAIT_FOR_ERROR_RECOVERY);
}
else if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
/* Run swap source timer on entry to pe_src_startup */
PE_SET_FLAG(port, PE_FLAGS_PR_SWAP_COMPLETE);
set_state_pe(port, PE_SRC_STARTUP);
}
}
static void pe_prs_snk_src_source_on_exit(int port)
{
pd_timer_disable(port, PE_TIMER_PS_SOURCE);
tc_pr_swap_complete(port,
PE_CHK_FLAG(port, PE_FLAGS_PR_SWAP_COMPLETE));
}
/**
* PE_PRS_SNK_SRC_Send_Swap
* PE_FRS_SNK_SRC_Send_Swap
*
* NOTE: Shared action code used for Power Role Swap and Fast Role Swap
*/
static void pe_prs_snk_src_send_swap_entry(int port)
{
print_current_state(port);
/*
* PRS_SNK_SRC_SEND_SWAP
* Request the Protocol Layer to send a PR_Swap Message.
*
* FRS_SNK_SRC_SEND_SWAP
* Hardware should have turned off sink power and started
* bringing Vbus to vSafe5.
* Request the Protocol Layer to send a FR_Swap Message.
*/
if (IS_ENABLED(CONFIG_USB_PD_REV30)) {
send_ctrl_msg(port,
TCPCI_MSG_SOP,
pe_in_frs_mode(port)
? PD_CTRL_FR_SWAP
: PD_CTRL_PR_SWAP);
} else {
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_PR_SWAP);
}
pe_sender_response_msg_entry(port);
}
static void pe_prs_snk_src_send_swap_run(int port)
{
int type;
int cnt;
int ext;
enum pe_msg_check msg_check;
/*
* Check the state of the message sent
*/
msg_check = pe_sender_response_msg_run(port);
/*
* Handle discarded message
*/
if (msg_check & PE_MSG_DISCARDED) {
if (pe_in_frs_mode(port))
set_state_pe(port, PE_SNK_HARD_RESET);
else
set_state_pe(port, PE_SNK_READY);
return;
}
/*
* Transition to PE_PRS_SNK_SRC_Transition_to_off when:
* 1) An Accept Message is received.
*
* PRS: Transition to PE_SNK_Ready state when:
* FRS: Transition to ErrorRecovery state when:
* 1) A Reject Message is received.
* 2) Or a Wait Message is received.
*/
if ((msg_check & PE_MSG_SENT) &&
PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
type = PD_HEADER_TYPE(rx_emsg[port].header);
cnt = PD_HEADER_CNT(rx_emsg[port].header);
ext = PD_HEADER_EXT(rx_emsg[port].header);
if ((ext == 0) && (cnt == 0)) {
if (type == PD_CTRL_ACCEPT) {
tc_request_power_swap(port);
set_state_pe(port,
PE_PRS_SNK_SRC_TRANSITION_TO_OFF);
} else if ((type == PD_CTRL_REJECT) ||
(type == PD_CTRL_WAIT)) {
if (IS_ENABLED(CONFIG_USB_PD_REV30))
set_state_pe(port,
pe_in_frs_mode(port)
? PE_WAIT_FOR_ERROR_RECOVERY
: PE_SNK_READY);
else
set_state_pe(port, PE_SNK_READY);
}
return;
}
}
/*
* PRS: Transition to PE_SNK_Ready state when:
* FRS: Transition to ErrorRecovery state when:
* 1) The SenderResponseTimer times out.
*/
if (pd_timer_is_expired(port, PE_TIMER_SENDER_RESPONSE)) {
if (IS_ENABLED(CONFIG_USB_PD_REV30))
set_state_pe(port,
pe_in_frs_mode(port)
? PE_WAIT_FOR_ERROR_RECOVERY
: PE_SNK_READY);
else
set_state_pe(port, PE_SNK_READY);
return;
}
/*
* FRS Only: Transition to ErrorRecovery state when:
* 2) The FR_Swap Message is not sent after retries (a GoodCRC Message
* has not been received). A soft reset Shall Not be initiated in
* this case.
*/
if (IS_ENABLED(CONFIG_USB_PD_REV30) &&
pe_in_frs_mode(port) &&
PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
set_state_pe(port, PE_WAIT_FOR_ERROR_RECOVERY);
}
}
static void pe_prs_snk_src_send_swap_exit(int port)
{
pe_sender_response_msg_exit(port);
}
/**
* PE_FRS_SNK_SRC_Start_AMS
*/
__maybe_unused static void pe_frs_snk_src_start_ams_entry(int port)
{
if (!IS_ENABLED(CONFIG_USB_PD_REV30))
assert(0);
print_current_state(port);
/* Inform Protocol Layer this is start of AMS */
PE_SET_FLAG(port, PE_FLAGS_LOCALLY_INITIATED_AMS);
/* Shared PRS/FRS code, indicate FRS path */
PE_SET_FLAG(port, PE_FLAGS_FAST_ROLE_SWAP_PATH);
/*
* Invalidate the contract after the FRS flags set so the
* flags can be propagated to this function.
*/
pe_invalidate_explicit_contract(port);
set_state_pe(port, PE_PRS_SNK_SRC_SEND_SWAP);
}
/**
* PE_PRS_FRS_SHARED
*/
__maybe_unused static void pe_prs_frs_shared_entry(int port)
{
if (!IS_ENABLED(CONFIG_USB_PD_REV30))
assert(0);
/*
* Shared PRS/FRS code, assume PRS path
*
* This is the super state entry. It will be called before
* the first entry state to get into the PRS/FRS path.
* For FRS, PE_FRS_SNK_SRC_START_AMS entry will be called
* after this and that will set for the FRS path.
*/
PE_CLR_FLAG(port, PE_FLAGS_FAST_ROLE_SWAP_PATH);
}
__maybe_unused static void pe_prs_frs_shared_exit(int port)
{
if (!IS_ENABLED(CONFIG_USB_PD_REV30))
assert(0);
/*
* Shared PRS/FRS code, when not in shared path
* indicate PRS path
*/
PE_CLR_FLAG(port, PE_FLAGS_FAST_ROLE_SWAP_PATH);
}
/**
* PE_BIST_TX
*/
static void pe_bist_tx_entry(int port)
{
uint32_t *payload = (uint32_t *)rx_emsg[port].buf;
uint8_t mode = BIST_MODE(payload[0]);
int vbus_mv;
int ibus_ma;
print_current_state(port);
/* Get the current nominal VBUS value */
if (pe[port].power_role == PD_ROLE_SOURCE) {
const uint32_t *src_pdo;
uint32_t unused;
dpm_get_source_pdo(&src_pdo, port);
pd_extract_pdo_power(src_pdo[pe[port].requested_idx - 1],
&ibus_ma, &vbus_mv, &unused);
} else {
vbus_mv = pe[port].supply_voltage;
}
/* If VBUS is not at vSafe5V, then don't enter BIST test mode */
if (vbus_mv != PD_V_SAFE5V_NOM) {
pe_set_ready_state(port);
return;
}
if (mode == BIST_CARRIER_MODE_2) {
/*
* PE_BIST_Carrier_Mode embedded here.
* See PD 3.0 section 6.4.3.1 BIST Carrier Mode 2: With a BIST
* Carrier Mode 2 BIST Data Object, the UUT Shall send out a
* continuous string of BMC-encoded alternating "1"s and “0”s.
* The UUT Shall exit the Continuous BIST Mode within
* tBISTContMode of this Continuous BIST Mode being enabled.
*/
send_ctrl_msg(port, TCPCI_MSG_TX_BIST_MODE_2, 0);
pd_timer_enable(port, PE_TIMER_BIST_CONT_MODE,
PD_T_BIST_CONT_MODE);
} else if (mode == BIST_TEST_DATA) {
/*
* See PD 3.0 section 6.4.3.2 BIST Test Data:
* With a BIST Test Data BIST Data Object, the UUT Shall return
* a GoodCRC Message and Shall enter a test mode in which it
* sends no further Messages except for GoodCRC Messages in
* response to received Messages.... The test Shall be ended by
* sending Hard Reset Signaling to reset the UUT.
*/
if (tcpc_set_bist_test_mode(port, true) != EC_SUCCESS)
CPRINTS("C%d: Failed to enter BIST Test Mode", port);
} else {
/* Ignore unsupported BIST messages. */
pe_set_ready_state(port);
return;
}
}
static void pe_bist_tx_run(int port)
{
if (pd_timer_is_expired(port, PE_TIMER_BIST_CONT_MODE)) {
/*
* Entry point to disable BIST in TCPC if that's not already
* handled automatically by the TCPC. Unless this method is
* implemented in a TCPM driver, this function does nothing.
*/
tcpm_reset_bist_type_2(port);
if (pe[port].power_role == PD_ROLE_SOURCE)
set_state_pe(port, PE_SRC_TRANSITION_TO_DEFAULT);
else
set_state_pe(port, PE_SNK_TRANSITION_TO_DEFAULT);
} else {
/*
* We are in test data mode and no further Messages except for
* GoodCRC Messages in response to received Messages will
* be sent.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED))
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
}
}
static void pe_bist_tx_exit(int port)
{
pd_timer_disable(port, PE_TIMER_BIST_CONT_MODE);
}
/**
* Give_Sink_Cap Message
*/
static void pe_snk_give_sink_cap_entry(int port)
{
print_current_state(port);
/* Send a Sink_Capabilities Message */
tx_emsg[port].len = pd_snk_pdo_cnt * 4;
memcpy(tx_emsg[port].buf, (uint8_t *)pd_snk_pdo, tx_emsg[port].len);
send_data_msg(port, TCPCI_MSG_SOP, PD_DATA_SINK_CAP);
}
static void pe_snk_give_sink_cap_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
pe_set_ready_state(port);
return;
}
if (pe_check_outgoing_discard(port))
return;
}
/**
* Wait For Error Recovery
*/
static void pe_wait_for_error_recovery_entry(int port)
{
print_current_state(port);
tc_start_error_recovery(port);
}
static void pe_wait_for_error_recovery_run(int port)
{
/* Stay here until error recovery is complete */
}
/**
* PE_Handle_Custom_Vdm_Request
*/
static void pe_handle_custom_vdm_request_entry(int port)
{
/* Get the message */
uint32_t *payload = (uint32_t *)rx_emsg[port].buf;
int cnt = PD_HEADER_CNT(rx_emsg[port].header);
int sop = PD_HEADER_GET_SOP(rx_emsg[port].header);
int rlen = 0;
uint32_t *rdata;
print_current_state(port);
/* This is an Interruptible AMS */
PE_SET_FLAG(port, PE_FLAGS_INTERRUPTIBLE_AMS);
rlen = pd_custom_vdm(port, cnt, payload, &rdata);
if (rlen > 0) {
tx_emsg[port].len = rlen * 4;
memcpy(tx_emsg[port].buf, (uint8_t *)rdata, tx_emsg[port].len);
send_data_msg(port, sop, PD_DATA_VENDOR_DEF);
} else {
if (prl_get_rev(port, TCPCI_MSG_SOP) > PD_REV20) {
set_state_pe(port, PE_SEND_NOT_SUPPORTED);
} else {
PE_CLR_FLAG(port, PE_FLAGS_INTERRUPTIBLE_AMS);
pe_set_ready_state(port);
}
}
}
static void pe_handle_custom_vdm_request_run(int port)
{
/* Wait for ACCEPT, WAIT or Reject message to send. */
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
/*
* Message sent. Transition back to
* PE_SRC_Ready or PE_SINK_Ready
*/
pe_set_ready_state(port);
}
}
static void pe_handle_custom_vdm_request_exit(int port)
{
PE_CLR_FLAG(port, PE_FLAGS_INTERRUPTIBLE_AMS);
}
static enum vdm_response_result parse_vdm_response_common(int port)
{
/* Retrieve the message information */
uint32_t *payload;
int sop;
uint8_t type;
uint8_t cnt;
uint8_t ext;
if (!PE_CHK_REPLY(port))
return VDM_RESULT_WAITING;
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
payload = (uint32_t *)rx_emsg[port].buf;
sop = PD_HEADER_GET_SOP(rx_emsg[port].header);
type = PD_HEADER_TYPE(rx_emsg[port].header);
cnt = PD_HEADER_CNT(rx_emsg[port].header);
ext = PD_HEADER_EXT(rx_emsg[port].header);
if (sop == pe[port].tx_type && type == PD_DATA_VENDOR_DEF && cnt >= 1
&& ext == 0) {
if (PD_VDO_CMDT(payload[0]) == CMDT_RSP_ACK &&
cnt >= pe[port].vdm_ack_min_data_objects) {
/* Handle ACKs in state-specific code. */
return VDM_RESULT_ACK;
} else if (PD_VDO_CMDT(payload[0]) == CMDT_RSP_NAK) {
/* Handle NAKs in state-specific code. */
return VDM_RESULT_NAK;
} else if (PD_VDO_CMDT(payload[0]) == CMDT_RSP_BUSY) {
/*
* Don't fill in the discovery field so we re-probe in
* tVDMBusy
*/
CPRINTS("C%d: Partner BUSY, request will be retried",
port);
pd_timer_enable(port, PE_TIMER_DISCOVER_IDENTITY,
PD_T_VDM_BUSY);
return VDM_RESULT_NO_ACTION;
} else if (PD_VDO_CMDT(payload[0]) == CMDT_INIT) {
/*
* Unexpected VDM REQ received. Let Src.Ready or
* Snk.Ready handle it.
*/
PE_SET_FLAG(port, PE_FLAGS_MSG_RECEIVED);
return VDM_RESULT_NO_ACTION;
}
/*
* Partner gave us an incorrect size or command; mark discovery
* as failed.
*/
CPRINTS("C%d: Unexpected VDM response: 0x%04x 0x%04x",
port, rx_emsg[port].header, payload[0]);
return VDM_RESULT_NAK;
} else if (sop == pe[port].tx_type && ext == 0 && cnt == 0 &&
type == PD_CTRL_NOT_SUPPORTED) {
/*
* A NAK would be more expected here, but Not Supported is still
* allowed with the same meaning.
*/
return VDM_RESULT_NAK;
}
/* Unexpected Message Received. Src.Ready or Snk.Ready can handle it. */
PE_SET_FLAG(port, PE_FLAGS_MSG_RECEIVED);
return VDM_RESULT_NO_ACTION;
}
/**
* PE_VDM_SEND_REQUEST
* Shared parent to manage VDM timer and other shared parts of the VDM request
* process
*/
static void pe_vdm_send_request_entry(int port)
{
if (pe[port].tx_type == TCPCI_MSG_INVALID) {
if (IS_ENABLED(USB_PD_DEBUG_LABELS))
CPRINTS("C%d: %s: Tx type expected to be set, "
"returning",
port, pe_state_names[get_state_pe(port)]);
set_state_pe(port, get_last_state_pe(port));
return;
}
if ((pe[port].tx_type == TCPCI_MSG_SOP_PRIME ||
pe[port].tx_type == TCPCI_MSG_SOP_PRIME_PRIME) &&
!tc_is_vconn_src(port) && port_discovery_vconn_swap_policy(port,
BIT(PE_FLAGS_VCONN_SWAP_TO_ON_FN))) {
if (port_try_vconn_swap(port))
return;
}
/* All VDM sequences are Interruptible */
PE_SET_MASK(port,
BIT(PE_FLAGS_LOCALLY_INITIATED_AMS_FN) |
BIT(PE_FLAGS_INTERRUPTIBLE_AMS_FN));
}
static void pe_vdm_send_request_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE) &&
pd_timer_is_disabled(port, PE_TIMER_VDM_RESPONSE)) {
/* Message was sent */
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
/* Start no response timer */
/* TODO(b/155890173): Support DPM-supplied timeout */
pd_timer_enable(port, PE_TIMER_VDM_RESPONSE,
PD_T_VDM_SNDR_RSP);
}
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_DISCARDED)) {
/*
* Go back to ready on first AMS message discard
* (ready states will clear the discard flag)
*/
pe_set_ready_state(port);
return;
}
/*
* Check the VDM timer, child will be responsible for processing
* messages and reacting appropriately to unexpected messages.
*/
if (pd_timer_is_expired(port, PE_TIMER_VDM_RESPONSE)) {
CPRINTF("VDM %s Response Timeout\n",
pe[port].tx_type == TCPCI_MSG_SOP ?
"Port" : "Cable");
/*
* Flag timeout so child state can mark appropriate discovery
* item as failed.
*/
PE_SET_FLAG(port, PE_FLAGS_VDM_REQUEST_TIMEOUT);
set_state_pe(port, get_last_state_pe(port));
}
}
static void pe_vdm_send_request_exit(int port)
{
/*
* Clear TX complete in case child called set_state_pe() before parent
* could process transmission
*/
PE_CLR_FLAG(port, PE_FLAGS_INTERRUPTIBLE_AMS);
/* Invalidate TX type so it must be set before next call */
pe[port].tx_type = TCPCI_MSG_INVALID;
pd_timer_disable(port, PE_TIMER_VDM_RESPONSE);
}
/**
* PE_VDM_IDENTITY_REQUEST_CBL
* Combination of PE_INIT_PORT_VDM_Identity_Request State specific to the
* cable and PE_SRC_VDM_Identity_Request State.
* pe[port].tx_type must be set (to SOP') prior to entry.
*/
static void pe_vdm_identity_request_cbl_entry(int port)
{
uint32_t *msg = (uint32_t *)tx_emsg[port].buf;
print_current_state(port);
if (!pe_can_send_sop_prime(port)) {
/*
* The parent state already tried to enable SOP' traffic. If it
* is still disabled, there's nothing left to try.
*/
pd_set_identity_discovery(port, pe[port].tx_type, PD_DISC_FAIL);
set_state_pe(port, get_last_state_pe(port));
return;
}
msg[0] = VDO(USB_SID_PD, 1,
VDO_SVDM_VERS(pd_get_vdo_ver(port, pe[port].tx_type)) |
CMD_DISCOVER_IDENT);
tx_emsg[port].len = sizeof(uint32_t);
send_data_msg(port, pe[port].tx_type, PD_DATA_VENDOR_DEF);
pe[port].discover_identity_counter++;
/*
* Valid DiscoverIdentity responses should have at least 4 objects
* (header, ID header, Cert Stat, Product VDO).
*/
pe[port].vdm_ack_min_data_objects = 4;
}
static void pe_vdm_identity_request_cbl_run(int port)
{
/* Retrieve the message information */
uint32_t *payload = (uint32_t *) rx_emsg[port].buf;
int sop = PD_HEADER_GET_SOP(rx_emsg[port].header);
uint8_t type = PD_HEADER_TYPE(rx_emsg[port].header);
uint8_t cnt = PD_HEADER_CNT(rx_emsg[port].header);
uint8_t ext = PD_HEADER_EXT(rx_emsg[port].header);
switch (parse_vdm_response_common(port)) {
case VDM_RESULT_WAITING:
/*
* The common code didn't parse a message. Handle protocol
* errors; otherwise, continue waiting.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
/*
* No Good CRC: See section 6.4.4.3.1 - Discover
* Identity.
*
* Discover Identity Command request sent to SOP' Shall
* Not cause a Soft Reset if a GoodCRC Message response
* is not returned since this can indicate a non-PD
* Capable cable.
*/
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
set_state_pe(port, get_last_state_pe(port));
}
return;
case VDM_RESULT_NO_ACTION:
/*
* If the received message doesn't change the discovery state,
* there is nothing to do but return to the previous ready
* state.
*/
if (get_last_state_pe(port) == PE_SRC_DISCOVERY &&
(sop != pe[port].tx_type ||
type != PD_DATA_VENDOR_DEF ||
cnt == 0 || ext != 0)) {
/*
* Unexpected non-VDM received: Before an explicit
* contract, an unexpected message shall generate a soft
* reset using the SOP* of the incoming message.
*/
pe_send_soft_reset(port, sop);
return;
}
break;
case VDM_RESULT_ACK:
/* PE_INIT_PORT_VDM_Identity_ACKed embedded here */
dfp_consume_identity(port, sop, cnt, payload);
/*
* Note: If port partner runs PD 2.0, we must use PD 2.0 to
* communicate with the cable plug when in an explicit contract.
*
* PD Spec Table 6-2: Revision Interoperability during an
* Explicit Contract
*/
if (prl_get_rev(port, TCPCI_MSG_SOP) != PD_REV20)
prl_set_rev(port, sop,
PD_HEADER_REV(rx_emsg[port].header));
break;
case VDM_RESULT_NAK:
/* PE_INIT_PORT_VDM_IDENTITY_NAKed embedded here */
pd_set_identity_discovery(port, pe[port].tx_type, PD_DISC_FAIL);
break;
}
/* Return to calling state (PE_{SRC,SNK}_Ready or PE_SRC_Discovery) */
set_state_pe(port, get_last_state_pe(port));
}
static void pe_vdm_identity_request_cbl_exit(int port)
{
/*
* When cable GoodCRCs but does not reply, down-rev to PD 2.0 and try
* again.
*
* PD 3.0 Rev 2.0 6.2.1.1.5 Specification Revision
*
* "When a Cable Plug does not respond to a Revision 3.0 Discover
* Identity REQ with a Discover Identity ACK or BUSY the Vconn Source
* May repeat steps 1-4 using a Revision 2.0 Discover Identity REQ in
* step 1 before establishing that there is no Cable Plug to
* communicate with"
*/
if (PE_CHK_FLAG(port, PE_FLAGS_VDM_REQUEST_TIMEOUT)) {
PE_CLR_FLAG(port, PE_FLAGS_VDM_REQUEST_TIMEOUT);
prl_set_rev(port, TCPCI_MSG_SOP_PRIME, PD_REV20);
}
/*
* 6.6.15 DiscoverIdentityTimer
*
* No more than nDiscoverIdentityCount Discover Identity Messages
* without a GoodCRC Message response Shall be sent. If no GoodCRC
* Message response is received after nDiscoverIdentityCount Discover
* Identity Command requests have been sent by a Port, the Port Shall
* Not send any further SOP’/SOP’’ Messages.
*/
if (pe[port].discover_identity_counter >= N_DISCOVER_IDENTITY_COUNT)
pd_set_identity_discovery(port, pe[port].tx_type,
PD_DISC_FAIL);
else if (pe[port].discover_identity_counter ==
N_DISCOVER_IDENTITY_PD3_0_LIMIT)
/*
* Downgrade to PD 2.0 if the partner hasn't replied before
* all retries are exhausted in case the cable is
* non-compliant about GoodCRC-ing higher revisions
*/
prl_set_rev(port, TCPCI_MSG_SOP_PRIME, PD_REV20);
/*
* Set discover identity timer unless BUSY case already did so.
*/
if (pd_get_identity_discovery(port, pe[port].tx_type) == PD_DISC_NEEDED
&& pd_timer_is_expired(port, PE_TIMER_DISCOVER_IDENTITY)) {
/*
* The tDiscoverIdentity timer is used during an explicit
* contract when discovering whether a cable is PD capable.
*
* Pre-contract, slow the rate Discover Identity commands are
* sent. This permits operation with captive cable devices that
* power the SOP' responder from VBUS instead of VCONN.
*/
pd_timer_enable(port, PE_TIMER_DISCOVER_IDENTITY,
pe_is_explicit_contract(port)
? PD_T_DISCOVER_IDENTITY
: PE_T_DISCOVER_IDENTITY_NO_CONTRACT);
}
/* Do not attempt further discovery if identity discovery failed. */
if (pd_get_identity_discovery(port, pe[port].tx_type) == PD_DISC_FAIL) {
pd_set_svids_discovery(port, pe[port].tx_type, PD_DISC_FAIL);
pd_notify_event(port, pe[port].tx_type == TCPCI_MSG_SOP ?
PD_STATUS_EVENT_SOP_DISC_DONE :
PD_STATUS_EVENT_SOP_PRIME_DISC_DONE);
}
}
/**
* PE_INIT_PORT_VDM_Identity_Request
*
* Specific to SOP requests, as cables require additions for the discover
* identity counter, must tolerate not receiving a GoodCRC, and need to set the
* cable revision based on response.
* pe[port].tx_type must be set (to SOP) prior to entry.
*/
static void pe_init_port_vdm_identity_request_entry(int port)
{
uint32_t *msg = (uint32_t *)tx_emsg[port].buf;
print_current_state(port);
msg[0] = VDO(USB_SID_PD, 1,
VDO_SVDM_VERS(pd_get_vdo_ver(port, pe[port].tx_type)) |
CMD_DISCOVER_IDENT);
tx_emsg[port].len = sizeof(uint32_t);
send_data_msg(port, pe[port].tx_type, PD_DATA_VENDOR_DEF);
/*
* Valid DiscoverIdentity responses should have at least 4 objects
* (header, ID header, Cert Stat, Product VDO).
*/
pe[port].vdm_ack_min_data_objects = 4;
}
static void pe_init_port_vdm_identity_request_run(int port)
{
switch (parse_vdm_response_common(port)) {
case VDM_RESULT_WAITING:
/* If common code didn't parse a message, continue waiting. */
return;
case VDM_RESULT_NO_ACTION:
/*
* If the received message doesn't change the discovery state,
* there is nothing to do but return to the previous ready
* state.
*/
break;
case VDM_RESULT_ACK: {
/* Retrieve the message information. */
uint32_t *payload = (uint32_t *) rx_emsg[port].buf;
int sop = PD_HEADER_GET_SOP(rx_emsg[port].header);
uint8_t cnt = PD_HEADER_CNT(rx_emsg[port].header);
/* PE_INIT_PORT_VDM_Identity_ACKed embedded here */
dfp_consume_identity(port, sop, cnt, payload);
break;
}
case VDM_RESULT_NAK:
/* PE_INIT_PORT_VDM_IDENTITY_NAKed embedded here */
pd_set_identity_discovery(port, pe[port].tx_type, PD_DISC_FAIL);
break;
}
/* Return to calling state (PE_{SRC,SNK}_Ready) */
set_state_pe(port, get_last_state_pe(port));
}
static void pe_init_port_vdm_identity_request_exit(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_VDM_REQUEST_TIMEOUT)) {
PE_CLR_FLAG(port, PE_FLAGS_VDM_REQUEST_TIMEOUT);
/*
* Mark failure to respond as discovery failure.
*
* For PD 2.0 partners (6.10.3 Applicability of Structured VDM
* Commands Note 3):
*
* If Structured VDMs are not supported, a Structured VDM
* Command received by a DFP or UFP Shall be Ignored.
*/
pd_set_identity_discovery(port, pe[port].tx_type, PD_DISC_FAIL);
}
/* Do not attempt further discovery if identity discovery failed. */
if (pd_get_identity_discovery(port, pe[port].tx_type) == PD_DISC_FAIL) {
pd_set_svids_discovery(port, pe[port].tx_type, PD_DISC_FAIL);
pd_notify_event(port, pe[port].tx_type == TCPCI_MSG_SOP ?
PD_STATUS_EVENT_SOP_DISC_DONE :
PD_STATUS_EVENT_SOP_PRIME_DISC_DONE);
}
}
/**
* PE_INIT_VDM_SVIDs_Request
*
* Used for SOP and SOP' requests, selected by pe[port].tx_type prior to entry.
*/
static void pe_init_vdm_svids_request_entry(int port)
{
uint32_t *msg = (uint32_t *)tx_emsg[port].buf;
print_current_state(port);
if (pe[port].tx_type == TCPCI_MSG_SOP_PRIME &&
!pe_can_send_sop_prime(port)) {
/*
* The parent state already tried to enable SOP' traffic. If it
* is still disabled, there's nothing left to try.
*/
pd_set_svids_discovery(port, pe[port].tx_type, PD_DISC_FAIL);
set_state_pe(port, get_last_state_pe(port));
return;
}
msg[0] = VDO(USB_SID_PD, 1,
VDO_SVDM_VERS(pd_get_vdo_ver(port, pe[port].tx_type)) |
CMD_DISCOVER_SVID);
tx_emsg[port].len = sizeof(uint32_t);
send_data_msg(port, pe[port].tx_type, PD_DATA_VENDOR_DEF);
/*
* Valid Discover SVIDs ACKs should have at least 2 objects (VDM header
* and at least 1 SVID VDO).
*/
pe[port].vdm_ack_min_data_objects = 2;
}
static void pe_init_vdm_svids_request_run(int port)
{
switch (parse_vdm_response_common(port)) {
case VDM_RESULT_WAITING:
/* If common code didn't parse a message, continue waiting. */
return;
case VDM_RESULT_NO_ACTION:
/*
* If the received message doesn't change the discovery state,
* there is nothing to do but return to the previous ready
* state.
*/
break;
case VDM_RESULT_ACK: {
/* Retrieve the message information. */
uint32_t *payload = (uint32_t *) rx_emsg[port].buf;
int sop = PD_HEADER_GET_SOP(rx_emsg[port].header);
uint8_t cnt = PD_HEADER_CNT(rx_emsg[port].header);
/* PE_INIT_VDM_SVIDs_ACKed embedded here */
dfp_consume_svids(port, sop, cnt, payload);
break;
}
case VDM_RESULT_NAK:
/* PE_INIT_VDM_SVIDs_NAKed embedded here */
pd_set_svids_discovery(port, pe[port].tx_type, PD_DISC_FAIL);
break;
}
/* Return to calling state (PE_{SRC,SNK}_Ready) */
set_state_pe(port, get_last_state_pe(port));
}
static void pe_init_vdm_svids_request_exit(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_VDM_REQUEST_TIMEOUT)) {
PE_CLR_FLAG(port, PE_FLAGS_VDM_REQUEST_TIMEOUT);
/*
* Mark failure to respond as discovery failure.
*
* For PD 2.0 partners (6.10.3 Applicability of Structured VDM
* Commands Note 3):
*
* If Structured VDMs are not supported, a Structured VDM
* Command received by a DFP or UFP Shall be Ignored.
*/
pd_set_svids_discovery(port, pe[port].tx_type, PD_DISC_FAIL);
}
/* If SVID discovery failed, discovery is done at this point */
if (pd_get_svids_discovery(port, pe[port].tx_type) == PD_DISC_FAIL)
pd_notify_event(port, pe[port].tx_type == TCPCI_MSG_SOP ?
PD_STATUS_EVENT_SOP_DISC_DONE :
PD_STATUS_EVENT_SOP_PRIME_DISC_DONE);
}
/**
* PE_INIT_VDM_Modes_Request
*
* Used for SOP and SOP' requests, selected by pe[port].tx_type prior to entry.
*/
static void pe_init_vdm_modes_request_entry(int port)
{
uint32_t *msg = (uint32_t *)tx_emsg[port].buf;
const struct svid_mode_data *mode_data =
pd_get_next_mode(port, pe[port].tx_type);
uint16_t svid;
/*
* The caller should have checked that there was something to discover
* before entering this state.
*/
assert(mode_data);
assert(mode_data->discovery == PD_DISC_NEEDED);
svid = mode_data->svid;
print_current_state(port);
if (pe[port].tx_type == TCPCI_MSG_SOP_PRIME &&
!pe_can_send_sop_prime(port)) {
/*
* The parent state already tried to enable SOP' traffic. If it
* is still disabled, there's nothing left to try.
*/
pd_set_modes_discovery(port, pe[port].tx_type, svid,
PD_DISC_FAIL);
set_state_pe(port, get_last_state_pe(port));
return;
}
msg[0] = VDO((uint16_t) svid, 1,
VDO_SVDM_VERS(pd_get_vdo_ver(port, pe[port].tx_type)) |
CMD_DISCOVER_MODES);
tx_emsg[port].len = sizeof(uint32_t);
send_data_msg(port, pe[port].tx_type, PD_DATA_VENDOR_DEF);
/*
* Valid Discover Modes responses should have at least 2 objects (VDM
* header and at least 1 mode VDO).
*/
pe[port].vdm_ack_min_data_objects = 2;
}
static void pe_init_vdm_modes_request_run(int port)
{
const struct svid_mode_data *mode_data;
uint16_t requested_svid;
mode_data = pd_get_next_mode(port, pe[port].tx_type);
assert(mode_data);
assert(mode_data->discovery == PD_DISC_NEEDED);
requested_svid = mode_data->svid;
switch (parse_vdm_response_common(port)) {
case VDM_RESULT_WAITING:
/* If common code didn't parse a message, continue waiting. */
return;
case VDM_RESULT_NO_ACTION:
/*
* If the received message doesn't change the discovery state,
* there is nothing to do but return to the previous ready
* state.
*/
break;
case VDM_RESULT_ACK: {
/* Retrieve the message information. */
uint32_t *payload = (uint32_t *) rx_emsg[port].buf;
int sop = PD_HEADER_GET_SOP(rx_emsg[port].header);
uint8_t cnt = PD_HEADER_CNT(rx_emsg[port].header);
uint16_t response_svid = (uint16_t) PD_VDO_VID(payload[0]);
/*
* Accept ACK if the request and response SVIDs are equal;
* otherwise, treat this as a NAK of the request SVID.
*
* TODO(b:169242812): support valid mode checking in
* dfp_consume_modes.
*/
if (requested_svid == response_svid) {
/* PE_INIT_VDM_Modes_ACKed embedded here */
dfp_consume_modes(port, sop, cnt, payload);
break;
}
}
/* Fall Through */
case VDM_RESULT_NAK:
/* PE_INIT_VDM_Modes_NAKed embedded here */
pd_set_modes_discovery(port, pe[port].tx_type, requested_svid,
PD_DISC_FAIL);
break;
}
/* Return to calling state (PE_{SRC,SNK}_Ready) */
set_state_pe(port, get_last_state_pe(port));
}
static void pe_init_vdm_modes_request_exit(int port)
{
if (pd_get_modes_discovery(port, pe[port].tx_type) != PD_DISC_NEEDED)
/* Mode discovery done, notify the AP */
pd_notify_event(port, pe[port].tx_type == TCPCI_MSG_SOP ?
PD_STATUS_EVENT_SOP_DISC_DONE :
PD_STATUS_EVENT_SOP_PRIME_DISC_DONE);
}
/**
* PE_VDM_REQUEST_DPM
*
* Makes a VDM request with contents and SOP* type previously set up by the DPM.
*/
static void pe_vdm_request_dpm_entry(int port)
{
print_current_state(port);
if ((pe[port].tx_type == TCPCI_MSG_SOP_PRIME ||
pe[port].tx_type == TCPCI_MSG_SOP_PRIME_PRIME) &&
!pe_can_send_sop_prime(port)) {
/*
* The parent state already tried to enable SOP' traffic. If it
* is still disabled, there's nothing left to try.
*/
dpm_vdm_naked(port, pe[port].tx_type,
PD_VDO_VID(pe[port].vdm_data[0]),
PD_VDO_CMD(pe[port].vdm_data[0]));
set_state_pe(port, get_last_state_pe(port));
return;
}
/* Copy Vendor Data Objects (VDOs) into message buffer */
if (pe[port].vdm_cnt > 0) {
/* Copy data after header */
memcpy(&tx_emsg[port].buf,
(uint8_t *)pe[port].vdm_data,
pe[port].vdm_cnt * 4);
/* Update len with the number of VDO bytes */
tx_emsg[port].len = pe[port].vdm_cnt * 4;
}
/*
* Clear the VDM nak'ed flag so that each request is
* treated separately (NAKs are handled by the
* DPM layer). Otherwise previous NAKs received will
* cause the state to exit early.
*/
PE_CLR_FLAG(port, PE_FLAGS_VDM_REQUEST_NAKED);
send_data_msg(port, pe[port].tx_type, PD_DATA_VENDOR_DEF);
/*
* In general, valid VDM ACKs must have a VDM header. Other than that,
* ACKs must be validated based on the command and SVID.
*/
pe[port].vdm_ack_min_data_objects = 1;
}
static void pe_vdm_request_dpm_run(int port)
{
uint32_t vdm_hdr;
switch (parse_vdm_response_common(port)) {
case VDM_RESULT_WAITING:
/*
* USB-PD 3.0 Rev 1.1 - 6.4.4.2.5
* Structured VDM command consists of a command request and a
* command response (ACK, NAK, or BUSY). An exception is made
* for the Attention command which shall have no response.
*
* Since Attention commands do not have an expected reply,
* the SVDM command is complete once the Attention command
* transmit is complete.
*/
vdm_hdr = pe[port].vdm_data[0];
if(PD_VDO_SVDM(vdm_hdr) &&
(PD_VDO_CMD(vdm_hdr) == CMD_ATTENTION)) {
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
break;
}
}
/*
* If common code didn't parse a message, and the VDM
* just sent was not an Attention message, then continue
* waiting.
*/
return;
case VDM_RESULT_NO_ACTION:
/*
* If the received message doesn't change the discovery state,
* there is nothing to do but return to the previous ready
* state. This includes Attention commands which have no
* expected SVDM response.
*/
break;
case VDM_RESULT_ACK: {
/* Retrieve the message information. */
uint32_t *payload = (uint32_t *) rx_emsg[port].buf;
int sop = PD_HEADER_GET_SOP(rx_emsg[port].header);
uint8_t cnt = PD_HEADER_CNT(rx_emsg[port].header);
uint16_t svid = PD_VDO_VID(payload[0]);
uint8_t vdm_cmd = PD_VDO_CMD(payload[0]);
/*
* PE initiator VDM-ACKed state for requested VDM, like
* PE_INIT_VDM_FOO_ACKed, embedded here.
*/
dpm_vdm_acked(port, sop, cnt, payload);
if (sop == TCPCI_MSG_SOP && svid == USB_SID_DISPLAYPORT &&
vdm_cmd == CMD_DP_CONFIG) {
PE_SET_FLAG(port, PE_FLAGS_VDM_SETUP_DONE);
}
break;
}
case VDM_RESULT_NAK:
/*
* PE initiator VDM-NAKed state for requested VDM, like
* PE_INIT_VDM_FOO_NAKed, embedded here.
*/
PE_SET_FLAG(port, PE_FLAGS_VDM_SETUP_DONE);
/*
* Because Not Supported messages or response timeouts are
* treated as NAKs, there may not be a NAK message to parse.
* Extract the needed information from the sent VDM.
*/
dpm_vdm_naked(port, pe[port].tx_type,
PD_VDO_VID(pe[port].vdm_data[0]),
PD_VDO_CMD(pe[port].vdm_data[0]));
break;
}
/* Return to calling state (PE_{SRC,SNK}_Ready) */
set_state_pe(port, get_last_state_pe(port));
}
static void pe_vdm_request_dpm_exit(int port)
{
/*
* Force Tx type to be reset before reentering a VDM state, unless the
* current VDM request will be resumed.
*/
if (!PE_CHK_FLAG(port, PE_FLAGS_VDM_REQUEST_CONTINUE))
pe[port].tx_type = TCPCI_MSG_INVALID;
}
/**
* PE_VDM_Response
*/
static void pe_vdm_response_entry(int port)
{
int vdo_len = 0;
uint32_t *rx_payload;
uint32_t *tx_payload;
uint8_t vdo_cmd;
svdm_rsp_func func = NULL;
print_current_state(port);
/* This is an Interruptible AMS */
PE_SET_FLAG(port, PE_FLAGS_INTERRUPTIBLE_AMS);
/* Get the message */
rx_payload = (uint32_t *)rx_emsg[port].buf;
/* Extract VDM command from the VDM header */
vdo_cmd = PD_VDO_CMD(rx_payload[0]);
/* This must be a command request to proceed further */
if (PD_VDO_CMDT(rx_payload[0]) != CMDT_INIT) {
CPRINTF("ERR:CMDT:%d:%d\n", PD_VDO_CMDT(rx_payload[0]),
vdo_cmd);
pe_set_ready_state(port);
return;
}
tx_payload = (uint32_t *)tx_emsg[port].buf;
/*
* Designed in TCPMv1, svdm_response functions use same
* buffer to take received data and overwrite with response
* data. To work with this interface, here copy rx data to
* tx buffer and pass tx_payload to func.
* TODO(b/166455363): change the interface to pass both rx
* and tx buffer.
*
* The SVDM header is dependent on both VDM command request being
* replied to and the result of response function. The SVDM command
* message is copied into tx_payload. tx_payload[0] is the VDM header
* for the response message. The SVDM response function takes the role
* of the DPM layer and will indicate the response type (ACK/NAK/BUSY)
* by its return value (vdo_len)
* vdo_len > 0 --> ACK
* vdo_len == 0 --> NAK
* vdo_len < 0 --> BUSY
*/
memcpy(tx_payload, rx_payload, PD_HEADER_CNT(rx_emsg[port].header) * 4);
/*
* Clear fields in SVDM response message that will be set based on the
* result of the svdm response function.
*/
tx_payload[0] &= ~VDO_CMDT_MASK;
tx_payload[0] &= ~VDO_SVDM_VERS(0x3);
/* Add SVDM structured version being used */
tx_payload[0] |= VDO_SVDM_VERS(pd_get_vdo_ver(port, TCPCI_MSG_SOP));
/* Use VDM command to select the response handler function */
switch (vdo_cmd) {
case CMD_DISCOVER_IDENT:
func = svdm_rsp.identity;
break;
case CMD_DISCOVER_SVID:
func = svdm_rsp.svids;
break;
case CMD_DISCOVER_MODES:
func = svdm_rsp.modes;
break;
case CMD_ENTER_MODE:
func = svdm_rsp.enter_mode;
break;
case CMD_DP_STATUS:
if (svdm_rsp.amode)
func = svdm_rsp.amode->status;
break;
case CMD_DP_CONFIG:
if (svdm_rsp.amode)
func = svdm_rsp.amode->config;
break;
case CMD_EXIT_MODE:
func = svdm_rsp.exit_mode;
break;
#ifdef CONFIG_USB_PD_ALT_MODE_DFP
case CMD_ATTENTION:
/*
* attention is only SVDM with no response
* (just goodCRC) return zero here.
*/
dfp_consume_attention(port, rx_payload);
pe_set_ready_state(port);
return;
#endif
default:
CPRINTF("VDO ERR:CMD:%d\n", vdo_cmd);
}
/*
* If the port partner is PD_REV20 and our data role is DFP, we must
* reply to any SVDM command with a NAK. If the SVDM was an Attention
* command, it does not have a response, and exits the function above.
*/
if (func && (prl_get_rev(port, TCPCI_MSG_SOP) != PD_REV20 ||
pe[port].data_role == PD_ROLE_UFP)) {
/*
* Execute SVDM response function selected above and set the
* correct response type in the VDM header.
*/
vdo_len = func(port, tx_payload);
if (vdo_len > 0) {
tx_payload[0] |= VDO_CMDT(CMDT_RSP_ACK);
/*
* If command response is an ACK and if the command was
* either enter/exit mode, then update the PE modal flag
* accordingly and cancel any DFP swap attempts.
*/
if (vdo_cmd == CMD_ENTER_MODE) {
PE_CLR_FLAG(port, PE_FLAGS_DR_SWAP_TO_DFP);
PE_SET_FLAG(port, PE_FLAGS_MODAL_OPERATION);
}
if (vdo_cmd == CMD_EXIT_MODE)
PE_CLR_FLAG(port, PE_FLAGS_MODAL_OPERATION);
} else if (!vdo_len) {
tx_payload[0] |= VDO_CMDT(CMDT_RSP_NAK);
vdo_len = 1;
} else {
tx_payload[0] |= VDO_CMDT(CMDT_RSP_BUSY);
vdo_len = 1;
}
} else {
/*
* Received at VDM command which is not supported. PD 2.0 may
* NAK or ignore the message (see TD.PD.VNDI.E1. VDM Identity
* steps), but PD 3.0 must send Not_Supported (PD 3.0 Ver 2.0 +
* ECNs 2020-12-10 Table 6-64 Response to an incoming
* VDM or TD.PD.VNDI3.E3 VDM Identity steps)
*/
if (prl_get_rev(port, TCPCI_MSG_SOP) == PD_REV30) {
set_state_pe(port, PE_SEND_NOT_SUPPORTED);
return;
}
tx_payload[0] |= VDO_CMDT(CMDT_RSP_NAK);
vdo_len = 1;
}
/* Send response message. Note len is in bytes, not VDO objects */
tx_emsg[port].len = (vdo_len * sizeof(uint32_t));
send_data_msg(port, TCPCI_MSG_SOP, PD_DATA_VENDOR_DEF);
}
static void pe_vdm_response_run(int port)
{
/*
* This state waits for a VDM response message to be sent. Return to the
* ready state once the message has been sent, a protocol error was
* detected, or if the VDM response msg was discarded based on being
* interrupted by another rx message. Since VDM sequences are AMS
* interruptible, there is no need to soft reset regardless of exit
* reason.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE) ||
PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR) ||
PE_CHK_FLAG(port, PE_FLAGS_MSG_DISCARDED)) {
PE_CLR_MASK(port,
BIT(PE_FLAGS_TX_COMPLETE_FN) |
BIT(PE_FLAGS_PROTOCOL_ERROR_FN) |
BIT(PE_FLAGS_MSG_DISCARDED_FN));
pe_set_ready_state(port);
}
}
static void pe_vdm_response_exit(int port)
{
PE_CLR_FLAG(port, PE_FLAGS_INTERRUPTIBLE_AMS);
}
/**
* PE_DEU_SEND_ENTER_USB
*/
static void pe_enter_usb_entry(int port)
{
uint32_t usb4_payload;
print_current_state(port);
if (!IS_ENABLED(CONFIG_USB_PD_USB4)) {
pe_set_ready_state(port);
return;
}
/* Port is already in USB4 mode, do not send enter USB message again */
if (enter_usb_entry_is_done(port)) {
pe_set_ready_state(port);
return;
}
if ((pe[port].tx_type == TCPCI_MSG_SOP_PRIME ||
pe[port].tx_type == TCPCI_MSG_SOP_PRIME_PRIME) &&
!tc_is_vconn_src(port)) {
if (port_try_vconn_swap(port))
return;
}
pe[port].tx_type = TCPCI_MSG_SOP;
usb4_payload = enter_usb_setup_next_msg(port, &pe[port].tx_type);
if (!usb4_payload) {
enter_usb_failed(port);
pe_set_ready_state(port);
return;
}
tx_emsg[port].len = sizeof(usb4_payload);
memcpy(tx_emsg[port].buf, &usb4_payload, tx_emsg[port].len);
send_data_msg(port, pe[port].tx_type, PD_DATA_ENTER_USB);
pe_sender_response_msg_entry(port);
}
static void pe_enter_usb_run(int port)
{
enum pe_msg_check msg_check;
if (!IS_ENABLED(CONFIG_USB_PD_USB4)) {
pe_set_ready_state(port);
return;
}
/*
* Check the state of the message sent
*/
msg_check = pe_sender_response_msg_run(port);
/*
* Handle Discarded message, return to PE_SNK/SRC_READY
*/
if (msg_check & PE_MSG_DISCARDED) {
pe_set_ready_state(port);
return;
} else if (msg_check == PE_MSG_SEND_PENDING) {
/* Wait until message is sent */
return;
}
if (pd_timer_is_expired(port, PE_TIMER_SENDER_RESPONSE)) {
pe_set_ready_state(port);
enter_usb_failed(port);
return;
}
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
int cnt = PD_HEADER_CNT(rx_emsg[port].header);
int type = PD_HEADER_TYPE(rx_emsg[port].header);
int sop = PD_HEADER_GET_SOP(rx_emsg[port].header);
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
/* Only look at control messages */
if (cnt == 0) {
/* Accept message received */
if (type == PD_CTRL_ACCEPT) {
enter_usb_accepted(port, sop);
} else if (type == PD_CTRL_REJECT) {
enter_usb_rejected(port, sop);
} else {
/*
* Unexpected control message received.
* Send Soft Reset.
*/
pe_send_soft_reset(port, sop);
return;
}
} else {
/* Unexpected data message received. Send Soft reset */
pe_send_soft_reset(port, sop);
return;
}
pe_set_ready_state(port);
}
}
static void pe_enter_usb_exit(int port)
{
pe_sender_response_msg_exit(port);
}
#ifdef CONFIG_USBC_VCONN
/*
* PE_VCS_Evaluate_Swap
*/
static void pe_vcs_evaluate_swap_entry(int port)
{
print_current_state(port);
/*
* Request the DPM for an evaluation of the VCONN Swap request.
* Note: Ports that are presently the VCONN Source must always
* accept a VCONN
*/
/*
* Transition to the PE_VCS_Accept_Swap state when:
* 1) The Device Policy Manager indicates that a VCONN Swap is ok.
*
* Transition to the PE_VCS_Reject_Swap state when:
* 1) Port is not presently the VCONN Source and
* 2) The DPM indicates that a VCONN Swap is not ok or
* 3) The DPM indicates that a VCONN Swap cannot be done at this time.
*/
/* DPM rejects a VCONN Swap and port is not a VCONN source*/
if (!tc_check_vconn_swap(port) && tc_is_vconn_src(port) < 1) {
/* NOTE: PE_VCS_Reject_Swap State embedded here */
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_REJECT);
}
/* Port is not ready to perform a VCONN swap */
else if (tc_is_vconn_src(port) < 0) {
/* NOTE: PE_VCS_Reject_Swap State embedded here */
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_WAIT);
}
/* Port is ready to perform a VCONN swap */
else {
/* NOTE: PE_VCS_Accept_Swap State embedded here */
PE_SET_FLAG(port, PE_FLAGS_ACCEPT);
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_ACCEPT);
}
}
static void pe_vcs_evaluate_swap_run(int port)
{
/* Wait for ACCEPT, WAIT or Reject message to send. */
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
if (PE_CHK_FLAG(port, PE_FLAGS_ACCEPT)) {
PE_CLR_FLAG(port, PE_FLAGS_ACCEPT);
/* Accept Message sent and Presently VCONN Source */
if (tc_is_vconn_src(port))
set_state_pe(port, PE_VCS_WAIT_FOR_VCONN_SWAP);
/* Accept Message sent and Not presently VCONN Source */
else
set_state_pe(port, PE_VCS_TURN_ON_VCONN_SWAP);
} else {
/*
* Message sent. Transition back to PE_SRC_Ready or
* PE_SINK_Ready
*/
pe_set_ready_state(port);
}
return;
}
if (pe_check_outgoing_discard(port))
return;
}
/*
* PE_VCS_Send_Swap
*/
static void pe_vcs_send_swap_entry(int port)
{
print_current_state(port);
/* Send a VCONN_Swap Message */
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_VCONN_SWAP);
pe_sender_response_msg_entry(port);
}
static void pe_vcs_send_swap_run(int port)
{
uint8_t type;
uint8_t cnt;
enum tcpci_msg_type sop;
enum pe_msg_check msg_check;
/*
* Check the state of the message sent
*/
msg_check = pe_sender_response_msg_run(port);
if ((msg_check & PE_MSG_SENT) &&
PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
/* Increment once message has successfully sent */
pe[port].vconn_swap_counter++;
type = PD_HEADER_TYPE(rx_emsg[port].header);
cnt = PD_HEADER_CNT(rx_emsg[port].header);
sop = PD_HEADER_GET_SOP(rx_emsg[port].header);
/* Only look at control messages */
if (cnt == 0) {
/*
* Transition to the PE_VCS_Wait_For_VCONN state when:
* 1) Accept Message Received and
* 2) The Port is presently the VCONN Source.
*
* Transition to the PE_VCS_Turn_On_VCONN state when:
* 1) Accept Message Received and
* 2) The Port is not presently the VCONN Source.
*/
if (type == PD_CTRL_ACCEPT) {
if (tc_is_vconn_src(port)) {
set_state_pe(port,
PE_VCS_WAIT_FOR_VCONN_SWAP);
} else {
set_state_pe(port,
PE_VCS_TURN_ON_VCONN_SWAP);
}
return;
}
/*
* Transition back to either the PE_SRC_Ready or
* PE_SNK_Ready state when:
* 2) Reject message is received or
* 3) Wait message Received.
*/
if (type == PD_CTRL_REJECT || type == PD_CTRL_WAIT) {
pe_set_ready_state(port);
return;
}
/*
* The Policy Engine May transition to the
* PE_VCS_Force_Vconn state when:
* - A Not_Supported Message is received and
* - The Port is not presently the VCONN Source
*/
if (type == PD_CTRL_NOT_SUPPORTED) {
if (IS_ENABLED(CONFIG_USB_PD_REV30) &&
!tc_is_vconn_src(port))
set_state_pe(port, PE_VCS_FORCE_VCONN);
else
pe_set_ready_state(port);
return;
}
}
/*
* Unexpected Message Received, send soft reset with SOP* of
* incoming message.
*/
pe_send_soft_reset(port, sop);
return;
}
/*
* Transition back to either the PE_SRC_Ready or
* PE_SNK_Ready state when:
* 1) SenderResponseTimer Timeout
* 2) Message was discarded.
*/
if ((msg_check & PE_MSG_DISCARDED) ||
pd_timer_is_expired(port, PE_TIMER_SENDER_RESPONSE))
pe_set_ready_state(port);
}
static void pe_vcs_send_swap_exit(int port)
{
pe_sender_response_msg_exit(port);
}
/*
* PE_VCS_Wait_for_VCONN_Swap
*/
static void pe_vcs_wait_for_vconn_swap_entry(int port)
{
print_current_state(port);
/* Start the VCONNOnTimer */
pd_timer_enable(port, PE_TIMER_VCONN_ON, PD_T_VCONN_SOURCE_ON);
/*
* The USB PD 3.0 spec indicates that the initial VCONN source
* shall cease sourcing VCONN within tVCONNSourceOff (25ms)
* after receiving the PS_RDY message. However, some partners
* begin sending SOP' messages only 1 ms after sending PS_RDY
* during VCONN swap.
*
* Preemptively disable receipt of SOP' and SOP'' messages while
* we wait for PS_RDY so we don't attempt to process messages
* directed at the cable.
*
* We continue to source VCONN while we wait as required by the
* spec.
*/
tcpm_sop_prime_enable(port, false);
}
static void pe_vcs_wait_for_vconn_swap_run(int port)
{
/*
* Transition to the PE_VCS_Turn_Off_VCONN state when:
* 1) A PS_RDY Message is received.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
/*
* PS_RDY message received
*
* Note: intentionally leave the receive flag set to indicate
* our route on exit when PS_RDY is received.
*/
if ((PD_HEADER_CNT(rx_emsg[port].header) == 0) &&
(PD_HEADER_EXT(rx_emsg[port].header) == 0) &&
(PD_HEADER_TYPE(rx_emsg[port].header) == PD_CTRL_PS_RDY)) {
set_state_pe(port, PE_VCS_TURN_OFF_VCONN_SWAP);
return;
} else {
/*
* Unexpected message received - reset with the SOP* of
* the incoming message.
*/
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
pe_send_soft_reset(port,
PD_HEADER_GET_SOP(rx_emsg[port].header));
return;
}
}
/*
* Transition to either the PE_SRC_Hard_Reset or
* PE_SNK_Hard_Reset state when:
* 1) The VCONNOnTimer times out.
*/
if (pd_timer_is_expired(port, PE_TIMER_VCONN_ON)) {
if (pe[port].power_role == PD_ROLE_SOURCE)
set_state_pe(port, PE_SRC_HARD_RESET);
else
set_state_pe(port, PE_SNK_HARD_RESET);
}
}
static void pe_vcs_wait_for_vconn_swap_exit(int port)
{
/*
* If we exited without getting PS_RDY, re-enable SOP' messaging since
* we are still the Vconn source.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED))
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
else
tcpm_sop_prime_enable(port, true);
pd_timer_disable(port, PE_TIMER_VCONN_ON);
}
/*
* PE_VCS_Turn_On_VCONN_Swap
*/
static void pe_vcs_turn_on_vconn_swap_entry(int port)
{
print_current_state(port);
/* Request DPM to turn on VCONN */
pd_request_vconn_swap_on(port);
}
static void pe_vcs_turn_on_vconn_swap_run(int port)
{
/*
* Transition to the PE_VCS_Send_Ps_Rdy state when:
* 1) The Port’s VCONN is on.
*/
if (pd_timer_is_disabled(port, PE_TIMER_TIMEOUT) &&
PE_CHK_FLAG(port, PE_FLAGS_VCONN_SWAP_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_VCONN_SWAP_COMPLETE);
pd_timer_enable(port, PE_TIMER_TIMEOUT,
CONFIG_USBC_VCONN_SWAP_DELAY_US);
}
if (pd_timer_is_expired(port, PE_TIMER_TIMEOUT))
set_state_pe(port, PE_VCS_SEND_PS_RDY_SWAP);
}
static void pe_vcs_turn_on_vconn_swap_exit(int port)
{
pd_timer_disable(port, PE_TIMER_TIMEOUT);
}
/*
* PE_VCS_Turn_Off_VCONN_Swap
*/
static void pe_vcs_turn_off_vconn_swap_entry(int port)
{
print_current_state(port);
/* Request DPM to turn off VCONN */
pd_request_vconn_swap_off(port);
}
static void pe_vcs_turn_off_vconn_swap_run(int port)
{
/* Wait for VCONN to turn off */
if (PE_CHK_FLAG(port, PE_FLAGS_VCONN_SWAP_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_VCONN_SWAP_COMPLETE);
/*
* A VCONN Swap Shall reset the DiscoverIdentityCounter
* to zero
*/
pe[port].discover_identity_counter = 0;
pe[port].dr_swap_attempt_counter = 0;
pe_set_ready_state(port);
return;
}
}
/*
* PE_VCS_Send_PS_Rdy_Swap
*/
static void pe_vcs_send_ps_rdy_swap_entry(int port)
{
print_current_state(port);
/* Check for any interruptions to this non-interruptible AMS */
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
enum tcpci_msg_type sop =
PD_HEADER_GET_SOP(rx_emsg[port].header);
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
/* Soft reset with the SOP* of the incoming message */
pe_send_soft_reset(port, sop);
return;
}
/* Send a PS_RDY Message */
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_PS_RDY);
}
static void pe_vcs_send_ps_rdy_swap_run(int port)
{
/*
* After a VCONN Swap the VCONN Source needs to reset
* the Cable Plug’s Protocol Layer in order to ensure
* MessageID synchronization.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
/*
* A VCONN Swap Shall reset the
* DiscoverIdentityCounter to zero
*/
pe[port].discover_identity_counter = 0;
pe[port].dr_swap_attempt_counter = 0;
/* A SOP' soft reset is required after VCONN swap */
pd_dpm_request(port, DPM_REQUEST_SOP_PRIME_SOFT_RESET_SEND);
pe_set_ready_state(port);
}
if (pe_check_outgoing_discard(port))
return;
if (PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
/* PS_RDY didn't send, soft reset */
pe_send_soft_reset(port, TCPCI_MSG_SOP);
}
}
/*
* PE_VCS_Force_Vconn
*/
__maybe_unused static void pe_vcs_force_vconn_entry(int port)
{
print_current_state(port);
/* Request DPM to turn on VCONN */
pd_request_vconn_swap_on(port);
}
__maybe_unused static void pe_vcs_force_vconn_run(int port)
{
/*
* The Policy Engine Shall transition back to either the PE_SRC_Ready
* or PE_SNK_Ready state when:
* 1) The Port’s VCONN is on.
*
* Note we'll wait CONFIG_USBC_VCONN_SWAP_DELAY_US, as defined by the
* board, to ensure Vconn is on.
*/
if (pd_timer_is_disabled(port, PE_TIMER_TIMEOUT) &&
PE_CHK_FLAG(port, PE_FLAGS_VCONN_SWAP_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_VCONN_SWAP_COMPLETE);
pd_timer_enable(port, PE_TIMER_TIMEOUT,
CONFIG_USBC_VCONN_SWAP_DELAY_US);
}
if (pd_timer_is_expired(port, PE_TIMER_TIMEOUT)) {
/*
* Note: A cable soft reset shouldn't be necessary as a
* Not_Supported reply means the partner doesn't support
* sourcing Vconn and did not communicate with the cable.
*/
pe_set_ready_state(port);
return;
}
}
__maybe_unused static void pe_vcs_force_vconn_exit(int port)
{
pd_timer_disable(port, PE_TIMER_TIMEOUT);
}
/*
* PE_VCS_CBL_SEND_SOFT_RESET
* Note - Entry is only when directed by the DPM. Protocol errors are handled
* by the PE_SEND_SOFT_RESET state.
*/
static void pe_vcs_cbl_send_soft_reset_entry(int port)
{
print_current_state(port);
if (!pe_can_send_sop_prime(port)) {
/*
* If we're not VCONN source, return the appropriate state.
* A VCONN swap re-triggers sending SOP' soft reset
*/
if (pe_is_explicit_contract(port)) {
/* Return to PE_{SRC,SNK}_Ready state */
pe_set_ready_state(port);
} else {
/*
* Not in Explicit Contract, so we must be a SRC,
* return to PE_Src_Send_Capabilities.
*/
set_state_pe(port, PE_SRC_SEND_CAPABILITIES);
}
return;
}
send_ctrl_msg(port, TCPCI_MSG_SOP_PRIME, PD_CTRL_SOFT_RESET);
pe_sender_response_msg_entry(port);
}
static void pe_vcs_cbl_send_soft_reset_run(int port)
{
bool cable_soft_reset_complete = false;
enum pe_msg_check msg_check;
msg_check = pe_sender_response_msg_run(port);
/* Got ACCEPT or REJECT from Cable Plug */
if ((msg_check & PE_MSG_SENT) &&
PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
cable_soft_reset_complete = true;
/*
* Note: If port partner runs PD 2.0, we must use PD 2.0 to
* communicate with the cable plug when in an explicit contract.
*
* PD Spec Table 6-2: Revision Interoperability during an
* Explicit Contract
*/
if (prl_get_rev(port, TCPCI_MSG_SOP) != PD_REV20)
prl_set_rev(port, TCPCI_MSG_SOP_PRIME,
PD_HEADER_REV(rx_emsg[port].header));
}
/* No GoodCRC received, cable is not present */
if (PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
/*
* TODO(b/171823328): TCPMv2: Implement cable reset
* Cable reset will only be done here if we know for certain
* a cable is present (we've received the SOP' DiscId response).
*/
cable_soft_reset_complete = true;
}
if (cable_soft_reset_complete ||
pd_timer_is_expired(port, PE_TIMER_SENDER_RESPONSE) ||
(msg_check & PE_MSG_DISCARDED)) {
if (pe_is_explicit_contract(port)) {
/* Return to PE_{SRC,SNK}_Ready state */
pe_set_ready_state(port);
} else {
/*
* Not in Explicit Contract, so we must be a SRC,
* return to PE_Src_Send_Capabilities.
*/
set_state_pe(port, PE_SRC_SEND_CAPABILITIES);
}
}
}
static void pe_vcs_cbl_send_soft_reset_exit(int port)
{
pe_sender_response_msg_exit(port);
}
#endif /* CONFIG_USBC_VCONN */
/*
* PE_DR_SNK_Get_Sink_Cap and PE_SRC_Get_Sink_Cap State (shared)
*/
static void pe_dr_get_sink_cap_entry(int port)
{
print_current_state(port);
/* Send a Get Sink Cap Message */
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_GET_SINK_CAP);
pe_sender_response_msg_entry(port);
}
static void pe_dr_get_sink_cap_run(int port)
{
int type;
int cnt;
int ext;
enum pe_msg_check msg_check;
enum tcpci_msg_type sop;
/*
* Check the state of the message sent
*/
msg_check = pe_sender_response_msg_run(port);
/*
* Transition to PE_[SRC,SNK]_Ready when:
* 1) A Sink_Capabilities Message is received
* 2) Or SenderResponseTimer times out
* 3) Or a Reject Message is received.
*
* Transition to PE_SEND_SOFT_RESET state when:
* 1) An unexpected message is received
*/
if ((msg_check & PE_MSG_SENT) &&
PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
type = PD_HEADER_TYPE(rx_emsg[port].header);
cnt = PD_HEADER_CNT(rx_emsg[port].header);
ext = PD_HEADER_EXT(rx_emsg[port].header);
sop = PD_HEADER_GET_SOP(rx_emsg[port].header);
if (ext == 0 && sop == TCPCI_MSG_SOP) {
if ((cnt > 0) && (type == PD_DATA_SINK_CAP)) {
uint32_t *payload =
(uint32_t *)rx_emsg[port].buf;
uint8_t cap_cnt = rx_emsg[port].len /
sizeof(uint32_t);
pe_set_snk_caps(port, cap_cnt, payload);
dpm_evaluate_sink_fixed_pdo(port, payload[0]);
pe_set_ready_state(port);
return;
} else if (cnt == 0 && (type == PD_CTRL_REJECT ||
type == PD_CTRL_NOT_SUPPORTED)) {
pe_set_ready_state(port);
return;
}
/* Unexpected messages fall through to soft reset */
}
pe_send_soft_reset(port, sop);
return;
}
/*
* Transition to PE_[SRC,SNK]_Ready state when:
* 1) SenderResponseTimer times out.
* 2) Message was discarded.
*/
if ((msg_check & PE_MSG_DISCARDED) ||
pd_timer_is_expired(port, PE_TIMER_SENDER_RESPONSE))
pe_set_ready_state(port);
}
static void pe_dr_get_sink_cap_exit(int port)
{
pe_sender_response_msg_exit(port);
}
/*
* PE_DR_SNK_Give_Source_Cap
*/
static void pe_dr_snk_give_source_cap_entry(int port)
{
print_current_state(port);
/* Send source capabilities. */
send_source_cap(port);
}
static void pe_dr_snk_give_source_cap_run(int port)
{
/*
* Transition back to PE_SNK_Ready when the Source_Capabilities message
* has been successfully sent.
*
* Get Source Capabilities AMS is uninterruptible, but in case the
* partner violates the spec then send a soft reset rather than get
* stuck here.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_TX_COMPLETE);
set_state_pe(port, PE_SNK_READY);
} else if (PE_CHK_FLAG(port, PE_FLAGS_MSG_DISCARDED)) {
pe_send_soft_reset(port, TCPCI_MSG_SOP);
}
}
/*
* PE_DR_SRC_Get_Source_Cap
*/
static void pe_dr_src_get_source_cap_entry(int port)
{
print_current_state(port);
/* Send a Get_Source_Cap Message */
tx_emsg[port].len = 0;
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_GET_SOURCE_CAP);
pe_sender_response_msg_entry(port);
}
static void pe_dr_src_get_source_cap_run(int port)
{
int type;
int cnt;
int ext;
enum pe_msg_check msg_check;
/*
* Check the state of the message sent
*/
msg_check = pe_sender_response_msg_run(port);
/*
* Transition to PE_SRC_Ready when:
* 1) A Source Capabilities Message is received.
* 2) A Reject Message is received.
*/
if ((msg_check & PE_MSG_SENT) &&
PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
type = PD_HEADER_TYPE(rx_emsg[port].header);
cnt = PD_HEADER_CNT(rx_emsg[port].header);
ext = PD_HEADER_EXT(rx_emsg[port].header);
if (ext == 0) {
if ((cnt > 0) && (type == PD_DATA_SOURCE_CAP)) {
uint32_t *payload =
(uint32_t *)rx_emsg[port].buf;
pd_set_src_caps(port, cnt, payload);
/*
* If we'd prefer to charge from this partner,
* then propose a PR swap.
*/
if (pd_can_charge_from_device(port, cnt,
payload))
pd_request_power_swap(port);
/*
* Report dual role power capability to the
* charge manager if present
*/
if (IS_ENABLED(CONFIG_CHARGE_MANAGER) &&
pd_get_partner_dual_role_power(port))
charge_manager_update_dualrole(port,
CAP_DUALROLE);
set_state_pe(port, PE_SRC_READY);
} else if ((cnt == 0) && (type == PD_CTRL_REJECT ||
type == PD_CTRL_NOT_SUPPORTED)) {
pd_set_src_caps(port, -1, NULL);
set_state_pe(port, PE_SRC_READY);
} else {
/*
* On protocol error, consider source cap
* retrieval a failure
*/
pd_set_src_caps(port, -1, NULL);
set_state_pe(port, PE_SEND_SOFT_RESET);
}
return;
} else {
pd_set_src_caps(port, -1, NULL);
set_state_pe(port, PE_SEND_SOFT_RESET);
return;
}
}
/*
* Transition to PE_SRC_Ready state when:
* 1) the SenderResponseTimer times out.
* 2) Message was discarded.
*/
if ((msg_check & PE_MSG_DISCARDED) ||
pd_timer_is_expired(port, PE_TIMER_SENDER_RESPONSE))
set_state_pe(port, PE_SRC_READY);
}
static void pe_dr_src_get_source_cap_exit(int port)
{
pe_sender_response_msg_exit(port);
}
#ifdef CONFIG_USB_PD_DATA_RESET_MSG
/*
* PE_DDR_Send_Data_Reset
* See PD rev 3.1, v. 1.2, Figure 8-88.
*/
static void pe_ddr_send_data_reset_entry(int port)
{
print_current_state(port);
/* Send Data Reset message */
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_DATA_RESET);
pe_sender_response_msg_entry(port);
}
static void pe_ddr_send_data_reset_run(int port)
{
enum pe_msg_check msg_check = pe_sender_response_msg_run(port);
/* Handle Discarded message, return to PE_SNK/SRC_READY */
if (msg_check & PE_MSG_DISCARDED) {
pe_set_ready_state(port);
return;
} else if (msg_check == PE_MSG_SEND_PENDING) {
/* Wait until message is sent */
return;
}
/*
* Transition to the next Data Reset state after receiving Accept.
* Return to the ready state after receiving Not Supported. After
* receiving Reject or any other message type (Protocol Error),
* transition to Error Recovery.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
const uint32_t hdr = rx_emsg[port].header;
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
if (PD_HEADER_GET_SOP(hdr) == TCPCI_MSG_SOP &&
PD_HEADER_CNT(hdr) == 0 &&
!PD_HEADER_EXT(hdr) &&
PD_HEADER_TYPE(hdr) == PD_CTRL_ACCEPT) {
/*
* Start DataResetFailTimer NOTE: This timer continues
* to run in every state until it is stopped or it times
* out.
*/
pd_timer_enable(port, PE_TIMER_DATA_RESET_FAIL,
PD_T_DATA_RESET_FAIL);
set_state_pe(port, tc_is_vconn_src(port) ?
PE_DDR_PERFORM_DATA_RESET :
PE_DDR_WAIT_FOR_VCONN_OFF);
return;
} else if (PD_HEADER_GET_SOP(hdr) == TCPCI_MSG_SOP &&
PD_HEADER_CNT(hdr) == 0 &&
!PD_HEADER_EXT(hdr) &&
PD_HEADER_TYPE(hdr) == PD_CTRL_NOT_SUPPORTED) {
/* Just pretend it worked. */
dpm_data_reset_complete(port);
pe_set_ready_state(port);
return;
}
/* Otherwise, it's a protocol error. */
PE_SET_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
}
if (pd_timer_is_expired(port, PE_TIMER_SENDER_RESPONSE) ||
PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
set_state_pe(port, PE_WAIT_FOR_ERROR_RECOVERY);
return;
}
}
static void pe_ddr_send_data_reset_exit(int port)
{
pe_sender_response_msg_exit(port);
}
/*
* PE_DDR_Wait_For_VCONN_Off
*/
static void pe_ddr_wait_for_vconn_off_entry(int port)
{
print_current_state(port);
/* Initialize and start VCONNDischargeTimer */
pd_timer_enable(port, PE_TIMER_VCONN_DISCHARGE, PD_T_VCONN_DISCHARGE);
}
static void pe_ddr_wait_for_vconn_off_run(int port)
{
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
const uint32_t hdr = rx_emsg[port].header;
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
if (PD_HEADER_GET_SOP(hdr) == TCPCI_MSG_SOP &&
PD_HEADER_CNT(hdr) == 0 &&
!PD_HEADER_EXT(hdr) &&
PD_HEADER_TYPE(hdr) == PD_CTRL_PS_RDY) {
/* PS_RDY message received */
pd_timer_enable(port, PE_TIMER_VCONN_REAPPLIED,
PD_T_VCONN_REAPPLIED);
set_state_pe(port, PE_DDR_PERFORM_DATA_RESET);
return;
}
/* Otherwise, it's a protocol error. */
PE_SET_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
}
if (pd_timer_is_expired(port, PE_TIMER_VCONN_DISCHARGE) ||
PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
set_state_pe(port, PE_WAIT_FOR_ERROR_RECOVERY);
return;
}
}
static void pe_ddr_wait_for_vconn_off_exit(int port)
{
pd_timer_disable(port, PE_TIMER_VCONN_DISCHARGE);
}
/*
* PE_DDR_Perform_Data_Reset
* See PD rev 3.1, v. 1.2, section 6.3.14.
*/
static void pe_ddr_perform_data_reset_entry(int port)
{
print_current_state(port);
/*
* 1) The DFP shall:
* a) Disconnect the Port’s USB 2.0 D+/D- signals.
* b) If operating in USB 3.2 remove the port’s Rx Terminations.
* c) If operating in [USB4] drive the port’s SBTX to a logic low.
*/
usb_mux_set(port, USB_PD_MUX_NONE, USB_SWITCH_DISCONNECT,
polarity_rm_dts(pd_get_polarity(port)));
/* 2) Both the DFP and UFP Shall exit all Alternate Modes if any. */
if (IS_ENABLED(CONFIG_USB_PD_ALT_MODE_DFP)) {
pd_dfp_exit_mode(port, TCPCI_MSG_SOP, 0, 0);
pd_dfp_exit_mode(port, TCPCI_MSG_SOP_PRIME, 0, 0);
pd_dfp_exit_mode(port, TCPCI_MSG_SOP_PRIME_PRIME, 0, 0);
}
/* 3) Reset the cable */
/*
* TODO(b/141363146): The PD spec is ambiguous about which state the PE
* should be in during the cable reset (step 3 in section 6.3.14). If
* the DFP is not the initial VCONN Source, the cable reset presumably
* starts in PE_DDR_Wait_for_VCONN_Off and finishes in
* PE_DDR_Perform_Data_Reset. To be consistent with the steps in 6.3.14,
* that would imply that steps 1 and 2 take place in
* PE_DDR_Send_Data_Reset. However, this would be inconsistent with the,
* "Tell the Policy Manager to Perform Data Reset," action in
* PE_DDR_Perform_Data_Reset in figure 8-88, DFP Data_Reset Message
* State Diagram, since the Data Reset process would have had to start
* before then. Resolve this ambiguity and update this implementation.
*/
if (IS_ENABLED(CONFIG_USBC_VCONN) && tc_is_vconn_src(port))
pd_request_vconn_swap_off(port);
}
static void pe_ddr_perform_data_reset_run(int port)
{
/*
* PE_FLAGS_VCONN_SWAP_COMPLETE may be set in 2 cases:
* a) If the PE requested to turn VCONN off while entering this state,
* i.e. if the TCPM was VCONN Source at that time. If the TCPM did not
* start out as VCONN Source, then PE_DDR_Wait_For_VCONN_Off will have
* already started the VCONN reapplied timer.
* b) When this state requests to turn VCONN on after tVCONNReapplied
* expires. At this point, the Data Reset process is complete.
*/
if (IS_ENABLED(CONFIG_USBC_VCONN) && !tc_is_vconn_src(port) &&
PE_CHK_FLAG(port, PE_FLAGS_VCONN_SWAP_COMPLETE)) {
PE_CLR_FLAG(port, PE_FLAGS_VCONN_SWAP_COMPLETE);
pd_timer_enable(port, PE_TIMER_VCONN_REAPPLIED,
PD_T_VCONN_REAPPLIED);
} else if (IS_ENABLED(CONFIG_USBC_VCONN) &&
pd_timer_is_expired(port, PE_TIMER_VCONN_REAPPLIED)) {
pd_request_vconn_swap_on(port);
pd_timer_disable(port, PE_TIMER_VCONN_REAPPLIED);
/*
* 4) After tDataReset the DFP shall:
* a) Reconnect the [USB 2.0] D+/D- signals
* b) If the Port was operating in [USB 3.2] or [USB4]
* reapply the port’s Rx Terminations
* TODO: Section 6.3.14 implies that tDataReset is a minimum
* time for the DFP to leave the lines disconnected during Data
* Reset, possibly starting after the cable reset. Section
* 6.6.10.2 implies that tDataReset is the maximum time for the
* DFP to send Data_Reset_Complete after receiving Accept. These
* interpretations are mutually exclusive. Resolve that
* ambiguity and update this implementation.
*/
usb_mux_set(port, USB_PD_MUX_NONE, USB_SWITCH_DISCONNECT,
polarity_rm_dts(pd_get_polarity(port)));
} else if (IS_ENABLED(CONFIG_USBC_VCONN) &&
PE_CHK_FLAG(port, PE_FLAGS_VCONN_SWAP_COMPLETE) &&
tc_is_vconn_src(port)) {
PE_CLR_FLAG(port, PE_FLAGS_VCONN_SWAP_COMPLETE);
PE_SET_FLAG(port, PE_FLAGS_DATA_RESET_COMPLETE);
} else if (PE_CHK_FLAG(port, PE_FLAGS_DATA_RESET_COMPLETE) &&
!pd_timer_is_disabled(port, PE_TIMER_DATA_RESET_FAIL)) {
pd_timer_disable(port, PE_TIMER_DATA_RESET_FAIL);
send_ctrl_msg(port, TCPCI_MSG_SOP, PD_CTRL_DATA_RESET_COMPLETE);
} else if (PE_CHK_FLAG(port, PE_FLAGS_DATA_RESET_COMPLETE)) {
/*
* There is no specified response to Data_Reset_Complete, but
* make sure the port partner receives it before returning to a
* ready state.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_DISCARDED))
set_state_pe(port, PE_WAIT_FOR_ERROR_RECOVERY);
else if (PE_CHK_FLAG(port, PE_FLAGS_TX_COMPLETE))
pe_set_ready_state(port);
return;
} else if (pd_timer_is_expired(port, PE_TIMER_DATA_RESET_FAIL) ||
PE_CHK_FLAG(port, PE_FLAGS_PROTOCOL_ERROR)) {
PE_CLR_FLAG(port, PE_FLAGS_PROTOCOL_ERROR);
set_state_pe(port, PE_WAIT_FOR_ERROR_RECOVERY);
return;
}
/*
* No messages are expected, so any received would be a protocol error.
*/
if (PE_CHK_FLAG(port, PE_FLAGS_MSG_RECEIVED)) {
PE_CLR_FLAG(port, PE_FLAGS_MSG_RECEIVED);
set_state_pe(port, PE_WAIT_FOR_ERROR_RECOVERY);
}
}
static void pe_ddr_perform_data_reset_exit(int port)
{
pd_timer_disable(port, PE_TIMER_VCONN_REAPPLIED);
pd_timer_disable(port, PE_TIMER_DATA_RESET_FAIL);
PE_CLR_FLAG(port, PE_FLAGS_DATA_RESET_COMPLETE);
dpm_data_reset_complete(port);
}
#endif /* CONFIG_USB_PD_DATA_RESET_MSG */
const uint32_t * const pd_get_src_caps(int port)
{
return pe[port].src_caps;
}
void pd_set_src_caps(int port, int cnt, uint32_t *src_caps)
{
int i;
pe[port].src_cap_cnt = cnt;
for (i = 0; i < cnt; i++)
pe[port].src_caps[i] = *src_caps++;
}
uint8_t pd_get_src_cap_cnt(int port)
{
if (pe[port].src_cap_cnt > 0)
return pe[port].src_cap_cnt;
return 0;
}
/* Track access to the PD discovery structures during HC execution */
atomic_t task_access[CONFIG_USB_PD_PORT_MAX_COUNT][DISCOVERY_TYPE_COUNT];
void pd_dfp_discovery_init(int port)
{
atomic_or(&task_access[port][TCPCI_MSG_SOP], BIT(task_get_current()));
atomic_or(&task_access[port][TCPCI_MSG_SOP_PRIME],
BIT(task_get_current()));
memset(pe[port].discovery, 0, sizeof(pe[port].discovery));
}
void pd_dfp_mode_init(int port)
{
/*
* Clear the VDM Setup Done and Modal Operation flags so we will
* have a fresh discovery
*/
PE_CLR_MASK(port,
BIT(PE_FLAGS_VDM_SETUP_DONE_FN) |
BIT(PE_FLAGS_MODAL_OPERATION_FN));
memset(pe[port].partner_amodes, 0, sizeof(pe[port].partner_amodes));
/* Reset the DPM and DP modules to enable alternate mode entry. */
dpm_mode_exit_complete(port);
dp_init(port);
if (IS_ENABLED(CONFIG_USB_PD_TBT_COMPAT_MODE))
tbt_init(port);
if (IS_ENABLED(CONFIG_USB_PD_USB4))
enter_usb_init(port);
if (IS_ENABLED(CONFIG_USB_PD_ALT_MODE_UFP_DP))
pd_ufp_set_dp_opos(port, 0);
}
__maybe_unused void pd_discovery_access_clear(int port,
enum tcpci_msg_type type)
{
if (!IS_ENABLED(CONFIG_USB_PD_ALT_MODE_DFP))
assert(0);
atomic_clear_bits(&task_access[port][type], 0xFFFFFFFF);
}
__maybe_unused bool pd_discovery_access_validate(int port,
enum tcpci_msg_type type)
{
if (!IS_ENABLED(CONFIG_USB_PD_ALT_MODE_DFP))
assert(0);
return !(task_access[port][type] & ~BIT(task_get_current()));
}
__maybe_unused struct pd_discovery *pd_get_am_discovery_and_notify_access(
int port, enum tcpci_msg_type type)
{
atomic_or(&task_access[port][type], BIT(task_get_current()));
return (struct pd_discovery *)pd_get_am_discovery(port, type);
}
__maybe_unused const struct pd_discovery *pd_get_am_discovery(int port,
enum tcpci_msg_type type)
{
if (!IS_ENABLED(CONFIG_USB_PD_ALT_MODE_DFP))
assert(0);
ASSERT(type < DISCOVERY_TYPE_COUNT);
return &pe[port].discovery[type];
}
__maybe_unused struct partner_active_modes *pd_get_partner_active_modes(
int port, enum tcpci_msg_type type)
{
if (!IS_ENABLED(CONFIG_USB_PD_ALT_MODE_DFP))
assert(0);
ASSERT(type < AMODE_TYPE_COUNT);
return &pe[port].partner_amodes[type];
}
__maybe_unused void pd_set_dfp_enter_mode_flag(int port, bool set)
{
if (!IS_ENABLED(CONFIG_USB_PD_ALT_MODE_DFP))
assert(0);
if (set)
PE_SET_FLAG(port, PE_FLAGS_MODAL_OPERATION);
else
PE_CLR_FLAG(port, PE_FLAGS_MODAL_OPERATION);
}
const char *pe_get_current_state(int port)
{
if (pe_is_running(port) && IS_ENABLED(USB_PD_DEBUG_LABELS))
return pe_state_names[get_state_pe(port)];
else
return "";
}
uint32_t pe_get_flags(int port)
{
return pe[port].flags;
}
static __const_data const struct usb_state pe_states[] = {
/* Super States */
#ifdef CONFIG_USB_PD_REV30
[PE_PRS_FRS_SHARED] = {
.entry = pe_prs_frs_shared_entry,
.exit = pe_prs_frs_shared_exit,
},
#endif
[PE_VDM_SEND_REQUEST] = {
.entry = pe_vdm_send_request_entry,
.run = pe_vdm_send_request_run,
.exit = pe_vdm_send_request_exit,
},
/* Normal States */
[PE_SRC_STARTUP] = {
.entry = pe_src_startup_entry,
.run = pe_src_startup_run,
.exit = pe_src_startup_exit,
},
[PE_SRC_DISCOVERY] = {
.entry = pe_src_discovery_entry,
.run = pe_src_discovery_run,
},
[PE_SRC_SEND_CAPABILITIES] = {
.entry = pe_src_send_capabilities_entry,
.run = pe_src_send_capabilities_run,
.exit = pe_src_send_capabilities_exit,
},
[PE_SRC_NEGOTIATE_CAPABILITY] = {
.entry = pe_src_negotiate_capability_entry,
},
[PE_SRC_TRANSITION_SUPPLY] = {
.entry = pe_src_transition_supply_entry,
.run = pe_src_transition_supply_run,
.exit = pe_src_transition_supply_exit,
},
[PE_SRC_READY] = {
.entry = pe_src_ready_entry,
.run = pe_src_ready_run,
},
[PE_SRC_DISABLED] = {
.entry = pe_src_disabled_entry,
},
[PE_SRC_CAPABILITY_RESPONSE] = {
.entry = pe_src_capability_response_entry,
.run = pe_src_capability_response_run,
},
[PE_SRC_HARD_RESET] = {
.entry = pe_src_hard_reset_entry,
.run = pe_src_hard_reset_run,
.exit = pe_src_hard_reset_exit,
},
[PE_SRC_HARD_RESET_RECEIVED] = {
.entry = pe_src_hard_reset_received_entry,
.run = pe_src_hard_reset_received_run,
.exit = pe_src_hard_reset_received_exit,
},
[PE_SRC_TRANSITION_TO_DEFAULT] = {
.entry = pe_src_transition_to_default_entry,
.run = pe_src_transition_to_default_run,
},
[PE_SNK_STARTUP] = {
.entry = pe_snk_startup_entry,
.run = pe_snk_startup_run,
},
[PE_SNK_DISCOVERY] = {
.entry = pe_snk_discovery_entry,
.run = pe_snk_discovery_run,
},
[PE_SNK_WAIT_FOR_CAPABILITIES] = {
.entry = pe_snk_wait_for_capabilities_entry,
.run = pe_snk_wait_for_capabilities_run,
.exit = pe_snk_wait_for_capabilities_exit,
},
[PE_SNK_EVALUATE_CAPABILITY] = {
.entry = pe_snk_evaluate_capability_entry,
},
[PE_SNK_SELECT_CAPABILITY] = {
.entry = pe_snk_select_capability_entry,
.run = pe_snk_select_capability_run,
.exit = pe_snk_select_capability_exit,
},
[PE_SNK_READY] = {
.entry = pe_snk_ready_entry,
.run = pe_snk_ready_run,
},
[PE_SNK_HARD_RESET] = {
.entry = pe_snk_hard_reset_entry,
.run = pe_snk_hard_reset_run,
},
[PE_SNK_TRANSITION_TO_DEFAULT] = {
.entry = pe_snk_transition_to_default_entry,
.run = pe_snk_transition_to_default_run,
},
[PE_SNK_GIVE_SINK_CAP] = {
.entry = pe_snk_give_sink_cap_entry,
.run = pe_snk_give_sink_cap_run,
},
[PE_SNK_GET_SOURCE_CAP] = {
.entry = pe_snk_get_source_cap_entry,
.run = pe_snk_get_source_cap_run,
},
[PE_SNK_TRANSITION_SINK] = {
.entry = pe_snk_transition_sink_entry,
.run = pe_snk_transition_sink_run,
.exit = pe_snk_transition_sink_exit,
},
[PE_SEND_SOFT_RESET] = {
.entry = pe_send_soft_reset_entry,
.run = pe_send_soft_reset_run,
.exit = pe_send_soft_reset_exit,
},
[PE_SOFT_RESET] = {
.entry = pe_soft_reset_entry,
.run = pe_soft_reset_run,
},
[PE_SEND_NOT_SUPPORTED] = {
.entry = pe_send_not_supported_entry,
.run = pe_send_not_supported_run,
},
[PE_SRC_PING] = {
.entry = pe_src_ping_entry,
.run = pe_src_ping_run,
},
[PE_DRS_EVALUATE_SWAP] = {
.entry = pe_drs_evaluate_swap_entry,
.run = pe_drs_evaluate_swap_run,
},
[PE_DRS_CHANGE] = {
.entry = pe_drs_change_entry,
.run = pe_drs_change_run,
},
[PE_DRS_SEND_SWAP] = {
.entry = pe_drs_send_swap_entry,
.run = pe_drs_send_swap_run,
.exit = pe_drs_send_swap_exit,
},
[PE_PRS_SRC_SNK_EVALUATE_SWAP] = {
.entry = pe_prs_src_snk_evaluate_swap_entry,
.run = pe_prs_src_snk_evaluate_swap_run,
},
[PE_PRS_SRC_SNK_TRANSITION_TO_OFF] = {
.entry = pe_prs_src_snk_transition_to_off_entry,
.run = pe_prs_src_snk_transition_to_off_run,
.exit = pe_prs_src_snk_transition_to_off_exit,
},
[PE_PRS_SRC_SNK_ASSERT_RD] = {
.entry = pe_prs_src_snk_assert_rd_entry,
.run = pe_prs_src_snk_assert_rd_run,
},
[PE_PRS_SRC_SNK_WAIT_SOURCE_ON] = {
.entry = pe_prs_src_snk_wait_source_on_entry,
.run = pe_prs_src_snk_wait_source_on_run,
.exit = pe_prs_src_snk_wait_source_on_exit,
},
[PE_PRS_SRC_SNK_SEND_SWAP] = {
.entry = pe_prs_src_snk_send_swap_entry,
.run = pe_prs_src_snk_send_swap_run,
.exit = pe_prs_src_snk_send_swap_exit,
},
[PE_PRS_SNK_SRC_EVALUATE_SWAP] = {
.entry = pe_prs_snk_src_evaluate_swap_entry,
.run = pe_prs_snk_src_evaluate_swap_run,
},
/*
* Some of the Power Role Swap actions are shared with the very
* similar actions of Fast Role Swap.
*/
/* State actions are shared with PE_FRS_SNK_SRC_TRANSITION_TO_OFF */
[PE_PRS_SNK_SRC_TRANSITION_TO_OFF] = {
.entry = pe_prs_snk_src_transition_to_off_entry,
.run = pe_prs_snk_src_transition_to_off_run,
.exit = pe_prs_snk_src_transition_to_off_exit,
#ifdef CONFIG_USB_PD_REV30
.parent = &pe_states[PE_PRS_FRS_SHARED],
#endif /* CONFIG_USB_PD_REV30 */
},
/* State actions are shared with PE_FRS_SNK_SRC_ASSERT_RP */
[PE_PRS_SNK_SRC_ASSERT_RP] = {
.entry = pe_prs_snk_src_assert_rp_entry,
.run = pe_prs_snk_src_assert_rp_run,
#ifdef CONFIG_USB_PD_REV30
.parent = &pe_states[PE_PRS_FRS_SHARED],
#endif /* CONFIG_USB_PD_REV30 */
},
/* State actions are shared with PE_FRS_SNK_SRC_SOURCE_ON */
[PE_PRS_SNK_SRC_SOURCE_ON] = {
.entry = pe_prs_snk_src_source_on_entry,
.run = pe_prs_snk_src_source_on_run,
.exit = pe_prs_snk_src_source_on_exit,
#ifdef CONFIG_USB_PD_REV30
.parent = &pe_states[PE_PRS_FRS_SHARED],
#endif /* CONFIG_USB_PD_REV30 */
},
/* State actions are shared with PE_FRS_SNK_SRC_SEND_SWAP */
[PE_PRS_SNK_SRC_SEND_SWAP] = {
.entry = pe_prs_snk_src_send_swap_entry,
.run = pe_prs_snk_src_send_swap_run,
.exit = pe_prs_snk_src_send_swap_exit,
#ifdef CONFIG_USB_PD_REV30
.parent = &pe_states[PE_PRS_FRS_SHARED],
#endif /* CONFIG_USB_PD_REV30 */
},
#ifdef CONFIG_USBC_VCONN
[PE_VCS_EVALUATE_SWAP] = {
.entry = pe_vcs_evaluate_swap_entry,
.run = pe_vcs_evaluate_swap_run,
},
[PE_VCS_SEND_SWAP] = {
.entry = pe_vcs_send_swap_entry,
.run = pe_vcs_send_swap_run,
.exit = pe_vcs_send_swap_exit,
},
[PE_VCS_WAIT_FOR_VCONN_SWAP] = {
.entry = pe_vcs_wait_for_vconn_swap_entry,
.run = pe_vcs_wait_for_vconn_swap_run,
.exit = pe_vcs_wait_for_vconn_swap_exit,
},
[PE_VCS_TURN_ON_VCONN_SWAP] = {
.entry = pe_vcs_turn_on_vconn_swap_entry,
.run = pe_vcs_turn_on_vconn_swap_run,
.exit = pe_vcs_turn_on_vconn_swap_exit,
},
[PE_VCS_TURN_OFF_VCONN_SWAP] = {
.entry = pe_vcs_turn_off_vconn_swap_entry,
.run = pe_vcs_turn_off_vconn_swap_run,
},
[PE_VCS_SEND_PS_RDY_SWAP] = {
.entry = pe_vcs_send_ps_rdy_swap_entry,
.run = pe_vcs_send_ps_rdy_swap_run,
},
[PE_VCS_CBL_SEND_SOFT_RESET] = {
.entry = pe_vcs_cbl_send_soft_reset_entry,
.run = pe_vcs_cbl_send_soft_reset_run,
.exit = pe_vcs_cbl_send_soft_reset_exit,
},
#endif /* CONFIG_USBC_VCONN */
[PE_VDM_IDENTITY_REQUEST_CBL] = {
.entry = pe_vdm_identity_request_cbl_entry,
.run = pe_vdm_identity_request_cbl_run,
.exit = pe_vdm_identity_request_cbl_exit,
.parent = &pe_states[PE_VDM_SEND_REQUEST],
},
[PE_INIT_PORT_VDM_IDENTITY_REQUEST] = {
.entry = pe_init_port_vdm_identity_request_entry,
.run = pe_init_port_vdm_identity_request_run,
.exit = pe_init_port_vdm_identity_request_exit,
.parent = &pe_states[PE_VDM_SEND_REQUEST],
},
[PE_INIT_VDM_SVIDS_REQUEST] = {
.entry = pe_init_vdm_svids_request_entry,
.run = pe_init_vdm_svids_request_run,
.exit = pe_init_vdm_svids_request_exit,
.parent = &pe_states[PE_VDM_SEND_REQUEST],
},
[PE_INIT_VDM_MODES_REQUEST] = {
.entry = pe_init_vdm_modes_request_entry,
.run = pe_init_vdm_modes_request_run,
.exit = pe_init_vdm_modes_request_exit,
.parent = &pe_states[PE_VDM_SEND_REQUEST],
},
[PE_VDM_REQUEST_DPM] = {
.entry = pe_vdm_request_dpm_entry,
.run = pe_vdm_request_dpm_run,
.exit = pe_vdm_request_dpm_exit,
.parent = &pe_states[PE_VDM_SEND_REQUEST],
},
[PE_VDM_RESPONSE] = {
.entry = pe_vdm_response_entry,
.run = pe_vdm_response_run,
.exit = pe_vdm_response_exit,
},
[PE_HANDLE_CUSTOM_VDM_REQUEST] = {
.entry = pe_handle_custom_vdm_request_entry,
.run = pe_handle_custom_vdm_request_run,
.exit = pe_handle_custom_vdm_request_exit,
},
[PE_DEU_SEND_ENTER_USB] = {
.entry = pe_enter_usb_entry,
.run = pe_enter_usb_run,
.exit = pe_enter_usb_exit,
},
[PE_WAIT_FOR_ERROR_RECOVERY] = {
.entry = pe_wait_for_error_recovery_entry,
.run = pe_wait_for_error_recovery_run,
},
[PE_BIST_TX] = {
.entry = pe_bist_tx_entry,
.run = pe_bist_tx_run,
.exit = pe_bist_tx_exit,
},
[PE_DR_GET_SINK_CAP] = {
.entry = pe_dr_get_sink_cap_entry,
.run = pe_dr_get_sink_cap_run,
.exit = pe_dr_get_sink_cap_exit,
},
[PE_DR_SNK_GIVE_SOURCE_CAP] = {
.entry = pe_dr_snk_give_source_cap_entry,
.run = pe_dr_snk_give_source_cap_run,
},
[PE_DR_SRC_GET_SOURCE_CAP] = {
.entry = pe_dr_src_get_source_cap_entry,
.run = pe_dr_src_get_source_cap_run,
.exit = pe_dr_src_get_source_cap_exit,
},
#ifdef CONFIG_USB_PD_REV30
[PE_FRS_SNK_SRC_START_AMS] = {
.entry = pe_frs_snk_src_start_ams_entry,
.parent = &pe_states[PE_PRS_FRS_SHARED],
},
#ifdef CONFIG_USB_PD_EXTENDED_MESSAGES
[PE_GIVE_BATTERY_CAP] = {
.entry = pe_give_battery_cap_entry,
.run = pe_give_battery_cap_run,
},
[PE_GIVE_BATTERY_STATUS] = {
.entry = pe_give_battery_status_entry,
.run = pe_give_battery_status_run,
},
[PE_SEND_ALERT] = {
.entry = pe_send_alert_entry,
.run = pe_send_alert_run,
},
#else
[PE_SRC_CHUNK_RECEIVED] = {
.entry = pe_chunk_received_entry,
.run = pe_chunk_received_run,
.exit = pe_chunk_received_exit,
},
[PE_SNK_CHUNK_RECEIVED] = {
.entry = pe_chunk_received_entry,
.run = pe_chunk_received_run,
.exit = pe_chunk_received_exit,
},
#endif /* CONFIG_USB_PD_EXTENDED_MESSAGES */
#ifdef CONFIG_USBC_VCONN
[PE_VCS_FORCE_VCONN] = {
.entry = pe_vcs_force_vconn_entry,
.run = pe_vcs_force_vconn_run,
.exit = pe_vcs_force_vconn_exit,
},
#endif /* CONFIG_USBC_VCONN */
#ifdef CONFIG_USB_PD_DATA_RESET_MSG
[PE_DDR_SEND_DATA_RESET] = {
.entry = pe_ddr_send_data_reset_entry,
.run = pe_ddr_send_data_reset_run,
.exit = pe_ddr_send_data_reset_exit,
},
[PE_DDR_WAIT_FOR_VCONN_OFF] = {
.entry = pe_ddr_wait_for_vconn_off_entry,
.run = pe_ddr_wait_for_vconn_off_run,
.exit = pe_ddr_wait_for_vconn_off_exit,
},
[PE_DDR_PERFORM_DATA_RESET] = {
.entry = pe_ddr_perform_data_reset_entry,
.run = pe_ddr_perform_data_reset_run,
.exit = pe_ddr_perform_data_reset_exit,
},
#endif /* CONFIG_USB_PD_DATA_RESET_MSG */
#endif /* CONFIG_USB_PD_REV30 */
};
#ifdef TEST_BUILD
/* TODO(b/173791979): Unit tests shouldn't need to access internal states */
const struct test_sm_data test_pe_sm_data[] = {
{
.base = pe_states,
.size = ARRAY_SIZE(pe_states),
.names = pe_state_names,
.names_size = ARRAY_SIZE(pe_state_names),
},
};
BUILD_ASSERT(ARRAY_SIZE(pe_states) == ARRAY_SIZE(pe_state_names));
const int test_pe_sm_data_size = ARRAY_SIZE(test_pe_sm_data);
void pe_set_flag(int port, int mask)
{
PE_SET_MASK(port, mask);
}
void pe_clr_flag(int port, int mask)
{
PE_CLR_MASK(port, mask);
}
int pe_chk_flag(int port, int mask)
{
return PE_CHK_MASK(port, mask);
}
void pe_clr_dpm_requests(int port)
{
pe[port].dpm_request = 0;
}
#endif
|