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
|
// SPDX-License-Identifier: GPL-2.0
/*
* UCSI driver for Cypress CCGx Type-C controller
*
* Copyright (C) 2017-2018 NVIDIA Corporation. All rights reserved.
* Author: Ajay Gupta <ajayg@nvidia.com>
*
* Some code borrowed from drivers/usb/typec/ucsi/ucsi_acpi.c
*/
#include <linux/acpi.h>
#include <linux/delay.h>
#include <linux/firmware.h>
#include <linux/i2c.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/platform_device.h>
#include <linux/pm.h>
#include <linux/pm_runtime.h>
#include <asm/unaligned.h>
#include "ucsi.h"
enum enum_fw_mode {
BOOT, /* bootloader */
FW1, /* FW partition-1 (contains secondary fw) */
FW2, /* FW partition-2 (contains primary fw) */
FW_INVALID,
};
#define CCGX_RAB_DEVICE_MODE 0x0000
#define CCGX_RAB_INTR_REG 0x0006
#define DEV_INT BIT(0)
#define PORT0_INT BIT(1)
#define PORT1_INT BIT(2)
#define UCSI_READ_INT BIT(7)
#define CCGX_RAB_JUMP_TO_BOOT 0x0007
#define TO_BOOT 'J'
#define TO_ALT_FW 'A'
#define CCGX_RAB_RESET_REQ 0x0008
#define RESET_SIG 'R'
#define CMD_RESET_I2C 0x0
#define CMD_RESET_DEV 0x1
#define CCGX_RAB_ENTER_FLASHING 0x000A
#define FLASH_ENTER_SIG 'P'
#define CCGX_RAB_VALIDATE_FW 0x000B
#define CCGX_RAB_FLASH_ROW_RW 0x000C
#define FLASH_SIG 'F'
#define FLASH_RD_CMD 0x0
#define FLASH_WR_CMD 0x1
#define FLASH_FWCT1_WR_CMD 0x2
#define FLASH_FWCT2_WR_CMD 0x3
#define FLASH_FWCT_SIG_WR_CMD 0x4
#define CCGX_RAB_READ_ALL_VER 0x0010
#define CCGX_RAB_READ_FW2_VER 0x0020
#define CCGX_RAB_UCSI_CONTROL 0x0039
#define CCGX_RAB_UCSI_CONTROL_START BIT(0)
#define CCGX_RAB_UCSI_CONTROL_STOP BIT(1)
#define CCGX_RAB_UCSI_DATA_BLOCK(offset) (0xf000 | ((offset) & 0xff))
#define REG_FLASH_RW_MEM 0x0200
#define DEV_REG_IDX CCGX_RAB_DEVICE_MODE
#define CCGX_RAB_PDPORT_ENABLE 0x002C
#define PDPORT_1 BIT(0)
#define PDPORT_2 BIT(1)
#define CCGX_RAB_RESPONSE 0x007E
#define ASYNC_EVENT BIT(7)
/* CCGx events & async msg codes */
#define RESET_COMPLETE 0x80
#define EVENT_INDEX RESET_COMPLETE
#define PORT_CONNECT_DET 0x84
#define PORT_DISCONNECT_DET 0x85
#define ROLE_SWAP_COMPELETE 0x87
/* ccg firmware */
#define CYACD_LINE_SIZE 527
#define CCG4_ROW_SIZE 256
#define FW1_METADATA_ROW 0x1FF
#define FW2_METADATA_ROW 0x1FE
#define FW_CFG_TABLE_SIG_SIZE 256
static int secondary_fw_min_ver = 41;
enum enum_flash_mode {
SECONDARY_BL, /* update secondary using bootloader */
PRIMARY, /* update primary using secondary */
SECONDARY, /* update secondary using primary */
FLASH_NOT_NEEDED, /* update not required */
FLASH_INVALID,
};
static const char * const ccg_fw_names[] = {
"ccg_boot.cyacd",
"ccg_primary.cyacd",
"ccg_secondary.cyacd"
};
struct ccg_dev_info {
#define CCG_DEVINFO_FWMODE_SHIFT (0)
#define CCG_DEVINFO_FWMODE_MASK (0x3 << CCG_DEVINFO_FWMODE_SHIFT)
#define CCG_DEVINFO_PDPORTS_SHIFT (2)
#define CCG_DEVINFO_PDPORTS_MASK (0x3 << CCG_DEVINFO_PDPORTS_SHIFT)
u8 mode;
u8 bl_mode;
__le16 silicon_id;
__le16 bl_last_row;
} __packed;
struct version_format {
__le16 build;
u8 patch;
u8 ver;
#define CCG_VERSION_MIN_SHIFT (0)
#define CCG_VERSION_MIN_MASK (0xf << CCG_VERSION_MIN_SHIFT)
#define CCG_VERSION_MAJ_SHIFT (4)
#define CCG_VERSION_MAJ_MASK (0xf << CCG_VERSION_MAJ_SHIFT)
} __packed;
struct version_info {
struct version_format base;
struct version_format app;
};
struct fw_config_table {
u32 identity;
u16 table_size;
u8 fwct_version;
u8 is_key_change;
u8 guid[16];
struct version_format base;
struct version_format app;
u8 primary_fw_digest[32];
u32 key_exp_length;
u8 key_modulus[256];
u8 key_exp[4];
};
/* CCGx response codes */
enum ccg_resp_code {
CMD_NO_RESP = 0x00,
CMD_SUCCESS = 0x02,
FLASH_DATA_AVAILABLE = 0x03,
CMD_INVALID = 0x05,
FLASH_UPDATE_FAIL = 0x07,
INVALID_FW = 0x08,
INVALID_ARG = 0x09,
CMD_NOT_SUPPORT = 0x0A,
TRANSACTION_FAIL = 0x0C,
PD_CMD_FAIL = 0x0D,
UNDEF_ERROR = 0x0F,
INVALID_RESP = 0x10,
};
#define CCG_EVENT_MAX (EVENT_INDEX + 43)
struct ccg_cmd {
u16 reg;
u32 data;
int len;
u32 delay; /* ms delay for cmd timeout */
};
struct ccg_resp {
u8 code;
u8 length;
};
struct ucsi_ccg {
struct device *dev;
struct ucsi *ucsi;
struct ucsi_ppm ppm;
struct i2c_client *client;
struct ccg_dev_info info;
/* version info for boot, primary and secondary */
struct version_info version[FW2 + 1];
/* CCG HPI communication flags */
unsigned long flags;
#define RESET_PENDING 0
#define DEV_CMD_PENDING 1
struct ccg_resp dev_resp;
u8 cmd_resp;
int port_num;
int irq;
struct work_struct work;
struct mutex lock; /* to sync between user and driver thread */
/* fw build with vendor information */
u16 fw_build;
};
static int ccg_read(struct ucsi_ccg *uc, u16 rab, u8 *data, u32 len)
{
struct i2c_client *client = uc->client;
const struct i2c_adapter_quirks *quirks = client->adapter->quirks;
unsigned char buf[2];
struct i2c_msg msgs[] = {
{
.addr = client->addr,
.flags = 0x0,
.len = sizeof(buf),
.buf = buf,
},
{
.addr = client->addr,
.flags = I2C_M_RD,
.buf = data,
},
};
u32 rlen, rem_len = len, max_read_len = len;
int status;
/* check any max_read_len limitation on i2c adapter */
if (quirks && quirks->max_read_len)
max_read_len = quirks->max_read_len;
pm_runtime_get_sync(uc->dev);
while (rem_len > 0) {
msgs[1].buf = &data[len - rem_len];
rlen = min_t(u16, rem_len, max_read_len);
msgs[1].len = rlen;
put_unaligned_le16(rab, buf);
status = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
if (status < 0) {
dev_err(uc->dev, "i2c_transfer failed %d\n", status);
pm_runtime_put_sync(uc->dev);
return status;
}
rab += rlen;
rem_len -= rlen;
}
pm_runtime_put_sync(uc->dev);
return 0;
}
static int ccg_write(struct ucsi_ccg *uc, u16 rab, u8 *data, u32 len)
{
struct i2c_client *client = uc->client;
unsigned char *buf;
struct i2c_msg msgs[] = {
{
.addr = client->addr,
.flags = 0x0,
}
};
int status;
buf = kzalloc(len + sizeof(rab), GFP_KERNEL);
if (!buf)
return -ENOMEM;
put_unaligned_le16(rab, buf);
memcpy(buf + sizeof(rab), data, len);
msgs[0].len = len + sizeof(rab);
msgs[0].buf = buf;
pm_runtime_get_sync(uc->dev);
status = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
if (status < 0) {
dev_err(uc->dev, "i2c_transfer failed %d\n", status);
pm_runtime_put_sync(uc->dev);
kfree(buf);
return status;
}
pm_runtime_put_sync(uc->dev);
kfree(buf);
return 0;
}
static int ucsi_ccg_init(struct ucsi_ccg *uc)
{
unsigned int count = 10;
u8 data;
int status;
data = CCGX_RAB_UCSI_CONTROL_STOP;
status = ccg_write(uc, CCGX_RAB_UCSI_CONTROL, &data, sizeof(data));
if (status < 0)
return status;
data = CCGX_RAB_UCSI_CONTROL_START;
status = ccg_write(uc, CCGX_RAB_UCSI_CONTROL, &data, sizeof(data));
if (status < 0)
return status;
/*
* Flush CCGx RESPONSE queue by acking interrupts. Above ucsi control
* register write will push response which must be cleared.
*/
do {
status = ccg_read(uc, CCGX_RAB_INTR_REG, &data, sizeof(data));
if (status < 0)
return status;
if (!data)
return 0;
status = ccg_write(uc, CCGX_RAB_INTR_REG, &data, sizeof(data));
if (status < 0)
return status;
usleep_range(10000, 11000);
} while (--count);
return -ETIMEDOUT;
}
static int ucsi_ccg_send_data(struct ucsi_ccg *uc)
{
u8 *ppm = (u8 *)uc->ppm.data;
int status;
u16 rab;
rab = CCGX_RAB_UCSI_DATA_BLOCK(offsetof(struct ucsi_data, message_out));
status = ccg_write(uc, rab, ppm +
offsetof(struct ucsi_data, message_out),
sizeof(uc->ppm.data->message_out));
if (status < 0)
return status;
rab = CCGX_RAB_UCSI_DATA_BLOCK(offsetof(struct ucsi_data, ctrl));
return ccg_write(uc, rab, ppm + offsetof(struct ucsi_data, ctrl),
sizeof(uc->ppm.data->ctrl));
}
static int ucsi_ccg_recv_data(struct ucsi_ccg *uc)
{
u8 *ppm = (u8 *)uc->ppm.data;
int status;
u16 rab;
rab = CCGX_RAB_UCSI_DATA_BLOCK(offsetof(struct ucsi_data, cci));
status = ccg_read(uc, rab, ppm + offsetof(struct ucsi_data, cci),
sizeof(uc->ppm.data->cci));
if (status < 0)
return status;
rab = CCGX_RAB_UCSI_DATA_BLOCK(offsetof(struct ucsi_data, message_in));
return ccg_read(uc, rab, ppm + offsetof(struct ucsi_data, message_in),
sizeof(uc->ppm.data->message_in));
}
static int ucsi_ccg_ack_interrupt(struct ucsi_ccg *uc)
{
int status;
unsigned char data;
status = ccg_read(uc, CCGX_RAB_INTR_REG, &data, sizeof(data));
if (status < 0)
return status;
return ccg_write(uc, CCGX_RAB_INTR_REG, &data, sizeof(data));
}
static int ucsi_ccg_sync(struct ucsi_ppm *ppm)
{
struct ucsi_ccg *uc = container_of(ppm, struct ucsi_ccg, ppm);
int status;
status = ucsi_ccg_recv_data(uc);
if (status < 0)
return status;
/* ack interrupt to allow next command to run */
return ucsi_ccg_ack_interrupt(uc);
}
static int ucsi_ccg_cmd(struct ucsi_ppm *ppm, struct ucsi_control *ctrl)
{
struct ucsi_ccg *uc = container_of(ppm, struct ucsi_ccg, ppm);
ppm->data->ctrl.raw_cmd = ctrl->raw_cmd;
return ucsi_ccg_send_data(uc);
}
static irqreturn_t ccg_irq_handler(int irq, void *data)
{
struct ucsi_ccg *uc = data;
ucsi_notify(uc->ucsi);
return IRQ_HANDLED;
}
static int get_fw_info(struct ucsi_ccg *uc)
{
int err;
err = ccg_read(uc, CCGX_RAB_READ_ALL_VER, (u8 *)(&uc->version),
sizeof(uc->version));
if (err < 0)
return err;
err = ccg_read(uc, CCGX_RAB_DEVICE_MODE, (u8 *)(&uc->info),
sizeof(uc->info));
if (err < 0)
return err;
return 0;
}
static inline bool invalid_async_evt(int code)
{
return (code >= CCG_EVENT_MAX) || (code < EVENT_INDEX);
}
static void ccg_process_response(struct ucsi_ccg *uc)
{
struct device *dev = uc->dev;
if (uc->dev_resp.code & ASYNC_EVENT) {
if (uc->dev_resp.code == RESET_COMPLETE) {
if (test_bit(RESET_PENDING, &uc->flags))
uc->cmd_resp = uc->dev_resp.code;
get_fw_info(uc);
}
if (invalid_async_evt(uc->dev_resp.code))
dev_err(dev, "invalid async evt %d\n",
uc->dev_resp.code);
} else {
if (test_bit(DEV_CMD_PENDING, &uc->flags)) {
uc->cmd_resp = uc->dev_resp.code;
clear_bit(DEV_CMD_PENDING, &uc->flags);
} else {
dev_err(dev, "dev resp 0x%04x but no cmd pending\n",
uc->dev_resp.code);
}
}
}
static int ccg_read_response(struct ucsi_ccg *uc)
{
unsigned long target = jiffies + msecs_to_jiffies(1000);
struct device *dev = uc->dev;
u8 intval;
int status;
/* wait for interrupt status to get updated */
do {
status = ccg_read(uc, CCGX_RAB_INTR_REG, &intval,
sizeof(intval));
if (status < 0)
return status;
if (intval & DEV_INT)
break;
usleep_range(500, 600);
} while (time_is_after_jiffies(target));
if (time_is_before_jiffies(target)) {
dev_err(dev, "response timeout error\n");
return -ETIME;
}
status = ccg_read(uc, CCGX_RAB_RESPONSE, (u8 *)&uc->dev_resp,
sizeof(uc->dev_resp));
if (status < 0)
return status;
status = ccg_write(uc, CCGX_RAB_INTR_REG, &intval, sizeof(intval));
if (status < 0)
return status;
return 0;
}
/* Caller must hold uc->lock */
static int ccg_send_command(struct ucsi_ccg *uc, struct ccg_cmd *cmd)
{
struct device *dev = uc->dev;
int ret;
switch (cmd->reg & 0xF000) {
case DEV_REG_IDX:
set_bit(DEV_CMD_PENDING, &uc->flags);
break;
default:
dev_err(dev, "invalid cmd register\n");
break;
}
ret = ccg_write(uc, cmd->reg, (u8 *)&cmd->data, cmd->len);
if (ret < 0)
return ret;
msleep(cmd->delay);
ret = ccg_read_response(uc);
if (ret < 0) {
dev_err(dev, "response read error\n");
switch (cmd->reg & 0xF000) {
case DEV_REG_IDX:
clear_bit(DEV_CMD_PENDING, &uc->flags);
break;
default:
dev_err(dev, "invalid cmd register\n");
break;
}
return -EIO;
}
ccg_process_response(uc);
return uc->cmd_resp;
}
static int ccg_cmd_enter_flashing(struct ucsi_ccg *uc)
{
struct ccg_cmd cmd;
int ret;
cmd.reg = CCGX_RAB_ENTER_FLASHING;
cmd.data = FLASH_ENTER_SIG;
cmd.len = 1;
cmd.delay = 50;
mutex_lock(&uc->lock);
ret = ccg_send_command(uc, &cmd);
mutex_unlock(&uc->lock);
if (ret != CMD_SUCCESS) {
dev_err(uc->dev, "enter flashing failed ret=%d\n", ret);
return ret;
}
return 0;
}
static int ccg_cmd_reset(struct ucsi_ccg *uc)
{
struct ccg_cmd cmd;
u8 *p;
int ret;
p = (u8 *)&cmd.data;
cmd.reg = CCGX_RAB_RESET_REQ;
p[0] = RESET_SIG;
p[1] = CMD_RESET_DEV;
cmd.len = 2;
cmd.delay = 5000;
mutex_lock(&uc->lock);
set_bit(RESET_PENDING, &uc->flags);
ret = ccg_send_command(uc, &cmd);
if (ret != RESET_COMPLETE)
goto err_clear_flag;
ret = 0;
err_clear_flag:
clear_bit(RESET_PENDING, &uc->flags);
mutex_unlock(&uc->lock);
return ret;
}
static int ccg_cmd_port_control(struct ucsi_ccg *uc, bool enable)
{
struct ccg_cmd cmd;
int ret;
cmd.reg = CCGX_RAB_PDPORT_ENABLE;
if (enable)
cmd.data = (uc->port_num == 1) ?
PDPORT_1 : (PDPORT_1 | PDPORT_2);
else
cmd.data = 0x0;
cmd.len = 1;
cmd.delay = 10;
mutex_lock(&uc->lock);
ret = ccg_send_command(uc, &cmd);
mutex_unlock(&uc->lock);
if (ret != CMD_SUCCESS) {
dev_err(uc->dev, "port control failed ret=%d\n", ret);
return ret;
}
return 0;
}
static int ccg_cmd_jump_boot_mode(struct ucsi_ccg *uc, int bl_mode)
{
struct ccg_cmd cmd;
int ret;
cmd.reg = CCGX_RAB_JUMP_TO_BOOT;
if (bl_mode)
cmd.data = TO_BOOT;
else
cmd.data = TO_ALT_FW;
cmd.len = 1;
cmd.delay = 100;
mutex_lock(&uc->lock);
set_bit(RESET_PENDING, &uc->flags);
ret = ccg_send_command(uc, &cmd);
if (ret != RESET_COMPLETE)
goto err_clear_flag;
ret = 0;
err_clear_flag:
clear_bit(RESET_PENDING, &uc->flags);
mutex_unlock(&uc->lock);
return ret;
}
static int
ccg_cmd_write_flash_row(struct ucsi_ccg *uc, u16 row,
const void *data, u8 fcmd)
{
struct i2c_client *client = uc->client;
struct ccg_cmd cmd;
u8 buf[CCG4_ROW_SIZE + 2];
u8 *p;
int ret;
/* Copy the data into the flash read/write memory. */
put_unaligned_le16(REG_FLASH_RW_MEM, buf);
memcpy(buf + 2, data, CCG4_ROW_SIZE);
mutex_lock(&uc->lock);
ret = i2c_master_send(client, buf, CCG4_ROW_SIZE + 2);
if (ret != CCG4_ROW_SIZE + 2) {
dev_err(uc->dev, "REG_FLASH_RW_MEM write fail %d\n", ret);
mutex_unlock(&uc->lock);
return ret < 0 ? ret : -EIO;
}
/* Use the FLASH_ROW_READ_WRITE register to trigger */
/* writing of data to the desired flash row */
p = (u8 *)&cmd.data;
cmd.reg = CCGX_RAB_FLASH_ROW_RW;
p[0] = FLASH_SIG;
p[1] = fcmd;
put_unaligned_le16(row, &p[2]);
cmd.len = 4;
cmd.delay = 50;
if (fcmd == FLASH_FWCT_SIG_WR_CMD)
cmd.delay += 400;
if (row == 510)
cmd.delay += 220;
ret = ccg_send_command(uc, &cmd);
mutex_unlock(&uc->lock);
if (ret != CMD_SUCCESS) {
dev_err(uc->dev, "write flash row failed ret=%d\n", ret);
return ret;
}
return 0;
}
static int ccg_cmd_validate_fw(struct ucsi_ccg *uc, unsigned int fwid)
{
struct ccg_cmd cmd;
int ret;
cmd.reg = CCGX_RAB_VALIDATE_FW;
cmd.data = fwid;
cmd.len = 1;
cmd.delay = 500;
mutex_lock(&uc->lock);
ret = ccg_send_command(uc, &cmd);
mutex_unlock(&uc->lock);
if (ret != CMD_SUCCESS)
return ret;
return 0;
}
static bool ccg_check_vendor_version(struct ucsi_ccg *uc,
struct version_format *app,
struct fw_config_table *fw_cfg)
{
struct device *dev = uc->dev;
/* Check if the fw build is for supported vendors */
if (le16_to_cpu(app->build) != uc->fw_build) {
dev_info(dev, "current fw is not from supported vendor\n");
return false;
}
/* Check if the new fw build is for supported vendors */
if (le16_to_cpu(fw_cfg->app.build) != uc->fw_build) {
dev_info(dev, "new fw is not from supported vendor\n");
return false;
}
return true;
}
static bool ccg_check_fw_version(struct ucsi_ccg *uc, const char *fw_name,
struct version_format *app)
{
const struct firmware *fw = NULL;
struct device *dev = uc->dev;
struct fw_config_table fw_cfg;
u32 cur_version, new_version;
bool is_later = false;
if (request_firmware(&fw, fw_name, dev) != 0) {
dev_err(dev, "error: Failed to open cyacd file %s\n", fw_name);
return false;
}
/*
* check if signed fw
* last part of fw image is fw cfg table and signature
*/
if (fw->size < sizeof(fw_cfg) + FW_CFG_TABLE_SIG_SIZE)
goto out_release_firmware;
memcpy((uint8_t *)&fw_cfg, fw->data + fw->size -
sizeof(fw_cfg) - FW_CFG_TABLE_SIG_SIZE, sizeof(fw_cfg));
if (fw_cfg.identity != ('F' | 'W' << 8 | 'C' << 16 | 'T' << 24)) {
dev_info(dev, "not a signed image\n");
goto out_release_firmware;
}
/* compare input version with FWCT version */
cur_version = le16_to_cpu(app->build) | app->patch << 16 |
app->ver << 24;
new_version = le16_to_cpu(fw_cfg.app.build) | fw_cfg.app.patch << 16 |
fw_cfg.app.ver << 24;
if (!ccg_check_vendor_version(uc, app, &fw_cfg))
goto out_release_firmware;
if (new_version > cur_version)
is_later = true;
out_release_firmware:
release_firmware(fw);
return is_later;
}
static int ccg_fw_update_needed(struct ucsi_ccg *uc,
enum enum_flash_mode *mode)
{
struct device *dev = uc->dev;
int err;
struct version_info version[3];
err = ccg_read(uc, CCGX_RAB_DEVICE_MODE, (u8 *)(&uc->info),
sizeof(uc->info));
if (err) {
dev_err(dev, "read device mode failed\n");
return err;
}
err = ccg_read(uc, CCGX_RAB_READ_ALL_VER, (u8 *)version,
sizeof(version));
if (err) {
dev_err(dev, "read device mode failed\n");
return err;
}
if (memcmp(&version[FW1], "\0\0\0\0\0\0\0\0",
sizeof(struct version_info)) == 0) {
dev_info(dev, "secondary fw is not flashed\n");
*mode = SECONDARY_BL;
} else if (le16_to_cpu(version[FW1].base.build) <
secondary_fw_min_ver) {
dev_info(dev, "secondary fw version is too low (< %d)\n",
secondary_fw_min_ver);
*mode = SECONDARY;
} else if (memcmp(&version[FW2], "\0\0\0\0\0\0\0\0",
sizeof(struct version_info)) == 0) {
dev_info(dev, "primary fw is not flashed\n");
*mode = PRIMARY;
} else if (ccg_check_fw_version(uc, ccg_fw_names[PRIMARY],
&version[FW2].app)) {
dev_info(dev, "found primary fw with later version\n");
*mode = PRIMARY;
} else {
dev_info(dev, "secondary and primary fw are the latest\n");
*mode = FLASH_NOT_NEEDED;
}
return 0;
}
static int do_flash(struct ucsi_ccg *uc, enum enum_flash_mode mode)
{
struct device *dev = uc->dev;
const struct firmware *fw = NULL;
const char *p, *s;
const char *eof;
int err, row, len, line_sz, line_cnt = 0;
unsigned long start_time = jiffies;
struct fw_config_table fw_cfg;
u8 fw_cfg_sig[FW_CFG_TABLE_SIG_SIZE];
u8 *wr_buf;
err = request_firmware(&fw, ccg_fw_names[mode], dev);
if (err) {
dev_err(dev, "request %s failed err=%d\n",
ccg_fw_names[mode], err);
return err;
}
if (((uc->info.mode & CCG_DEVINFO_FWMODE_MASK) >>
CCG_DEVINFO_FWMODE_SHIFT) == FW2) {
err = ccg_cmd_port_control(uc, false);
if (err < 0)
goto release_fw;
err = ccg_cmd_jump_boot_mode(uc, 0);
if (err < 0)
goto release_fw;
}
eof = fw->data + fw->size;
/*
* check if signed fw
* last part of fw image is fw cfg table and signature
*/
if (fw->size < sizeof(fw_cfg) + sizeof(fw_cfg_sig))
goto not_signed_fw;
memcpy((uint8_t *)&fw_cfg, fw->data + fw->size -
sizeof(fw_cfg) - sizeof(fw_cfg_sig), sizeof(fw_cfg));
if (fw_cfg.identity != ('F' | ('W' << 8) | ('C' << 16) | ('T' << 24))) {
dev_info(dev, "not a signed image\n");
goto not_signed_fw;
}
eof = fw->data + fw->size - sizeof(fw_cfg) - sizeof(fw_cfg_sig);
memcpy((uint8_t *)&fw_cfg_sig,
fw->data + fw->size - sizeof(fw_cfg_sig), sizeof(fw_cfg_sig));
/* flash fw config table and signature first */
err = ccg_cmd_write_flash_row(uc, 0, (u8 *)&fw_cfg,
FLASH_FWCT1_WR_CMD);
if (err)
goto release_fw;
err = ccg_cmd_write_flash_row(uc, 0, (u8 *)&fw_cfg + CCG4_ROW_SIZE,
FLASH_FWCT2_WR_CMD);
if (err)
goto release_fw;
err = ccg_cmd_write_flash_row(uc, 0, &fw_cfg_sig,
FLASH_FWCT_SIG_WR_CMD);
if (err)
goto release_fw;
not_signed_fw:
wr_buf = kzalloc(CCG4_ROW_SIZE + 4, GFP_KERNEL);
if (!wr_buf)
return -ENOMEM;
err = ccg_cmd_enter_flashing(uc);
if (err)
goto release_mem;
/*****************************************************************
* CCG firmware image (.cyacd) file line format
*
* :00rrrrllll[dd....]cc/r/n
*
* :00 header
* rrrr is row number to flash (4 char)
* llll is data len to flash (4 char)
* dd is a data field represents one byte of data (512 char)
* cc is checksum (2 char)
* \r\n newline
*
* Total length: 3 + 4 + 4 + 512 + 2 + 2 = 527
*
*****************************************************************/
p = strnchr(fw->data, fw->size, ':');
while (p < eof) {
s = strnchr(p + 1, eof - p - 1, ':');
if (!s)
s = eof;
line_sz = s - p;
if (line_sz != CYACD_LINE_SIZE) {
dev_err(dev, "Bad FW format line_sz=%d\n", line_sz);
err = -EINVAL;
goto release_mem;
}
if (hex2bin(wr_buf, p + 3, CCG4_ROW_SIZE + 4)) {
err = -EINVAL;
goto release_mem;
}
row = get_unaligned_be16(wr_buf);
len = get_unaligned_be16(&wr_buf[2]);
if (len != CCG4_ROW_SIZE) {
err = -EINVAL;
goto release_mem;
}
err = ccg_cmd_write_flash_row(uc, row, wr_buf + 4,
FLASH_WR_CMD);
if (err)
goto release_mem;
line_cnt++;
p = s;
}
dev_info(dev, "total %d row flashed. time: %dms\n",
line_cnt, jiffies_to_msecs(jiffies - start_time));
err = ccg_cmd_validate_fw(uc, (mode == PRIMARY) ? FW2 : FW1);
if (err)
dev_err(dev, "%s validation failed err=%d\n",
(mode == PRIMARY) ? "FW2" : "FW1", err);
else
dev_info(dev, "%s validated\n",
(mode == PRIMARY) ? "FW2" : "FW1");
err = ccg_cmd_port_control(uc, false);
if (err < 0)
goto release_mem;
err = ccg_cmd_reset(uc);
if (err < 0)
goto release_mem;
err = ccg_cmd_port_control(uc, true);
if (err < 0)
goto release_mem;
release_mem:
kfree(wr_buf);
release_fw:
release_firmware(fw);
return err;
}
/*******************************************************************************
* CCG4 has two copies of the firmware in addition to the bootloader.
* If the device is running FW1, FW2 can be updated with the new version.
* Dual firmware mode allows the CCG device to stay in a PD contract and support
* USB PD and Type-C functionality while a firmware update is in progress.
******************************************************************************/
static int ccg_fw_update(struct ucsi_ccg *uc, enum enum_flash_mode flash_mode)
{
int err;
while (flash_mode != FLASH_NOT_NEEDED) {
err = do_flash(uc, flash_mode);
if (err < 0)
return err;
err = ccg_fw_update_needed(uc, &flash_mode);
if (err < 0)
return err;
}
dev_info(uc->dev, "CCG FW update successful\n");
return err;
}
static int ccg_restart(struct ucsi_ccg *uc)
{
struct device *dev = uc->dev;
int status;
status = ucsi_ccg_init(uc);
if (status < 0) {
dev_err(dev, "ucsi_ccg_start fail, err=%d\n", status);
return status;
}
status = request_threaded_irq(uc->irq, NULL, ccg_irq_handler,
IRQF_ONESHOT | IRQF_TRIGGER_HIGH,
dev_name(dev), uc);
if (status < 0) {
dev_err(dev, "request_threaded_irq failed - %d\n", status);
return status;
}
uc->ucsi = ucsi_register_ppm(dev, &uc->ppm);
if (IS_ERR(uc->ucsi)) {
dev_err(uc->dev, "ucsi_register_ppm failed\n");
return PTR_ERR(uc->ucsi);
}
return 0;
}
static void ccg_update_firmware(struct work_struct *work)
{
struct ucsi_ccg *uc = container_of(work, struct ucsi_ccg, work);
enum enum_flash_mode flash_mode;
int status;
status = ccg_fw_update_needed(uc, &flash_mode);
if (status < 0)
return;
if (flash_mode != FLASH_NOT_NEEDED) {
ucsi_unregister_ppm(uc->ucsi);
free_irq(uc->irq, uc);
ccg_fw_update(uc, flash_mode);
ccg_restart(uc);
}
}
static ssize_t do_flash_store(struct device *dev,
struct device_attribute *attr,
const char *buf, size_t n)
{
struct ucsi_ccg *uc = i2c_get_clientdata(to_i2c_client(dev));
bool flash;
if (kstrtobool(buf, &flash))
return -EINVAL;
if (!flash)
return n;
if (uc->fw_build == 0x0) {
dev_err(dev, "fail to flash FW due to missing FW build info\n");
return -EINVAL;
}
schedule_work(&uc->work);
return n;
}
static DEVICE_ATTR_WO(do_flash);
static struct attribute *ucsi_ccg_sysfs_attrs[] = {
&dev_attr_do_flash.attr,
NULL,
};
static struct attribute_group ucsi_ccg_attr_group = {
.attrs = ucsi_ccg_sysfs_attrs,
};
static int ucsi_ccg_probe(struct i2c_client *client,
const struct i2c_device_id *id)
{
struct device *dev = &client->dev;
struct ucsi_ccg *uc;
int status;
u16 rab;
uc = devm_kzalloc(dev, sizeof(*uc), GFP_KERNEL);
if (!uc)
return -ENOMEM;
uc->ppm.data = devm_kzalloc(dev, sizeof(struct ucsi_data), GFP_KERNEL);
if (!uc->ppm.data)
return -ENOMEM;
uc->ppm.cmd = ucsi_ccg_cmd;
uc->ppm.sync = ucsi_ccg_sync;
uc->dev = dev;
uc->client = client;
mutex_init(&uc->lock);
INIT_WORK(&uc->work, ccg_update_firmware);
/* Only fail FW flashing when FW build information is not provided */
status = device_property_read_u16(dev, "ccgx,firmware-build",
&uc->fw_build);
if (status)
dev_err(uc->dev, "failed to get FW build information\n");
/* reset ccg device and initialize ucsi */
status = ucsi_ccg_init(uc);
if (status < 0) {
dev_err(uc->dev, "ucsi_ccg_init failed - %d\n", status);
return status;
}
status = get_fw_info(uc);
if (status < 0) {
dev_err(uc->dev, "get_fw_info failed - %d\n", status);
return status;
}
uc->port_num = 1;
if (uc->info.mode & CCG_DEVINFO_PDPORTS_MASK)
uc->port_num++;
status = request_threaded_irq(client->irq, NULL, ccg_irq_handler,
IRQF_ONESHOT | IRQF_TRIGGER_HIGH,
dev_name(dev), uc);
if (status < 0) {
dev_err(uc->dev, "request_threaded_irq failed - %d\n", status);
return status;
}
uc->irq = client->irq;
uc->ucsi = ucsi_register_ppm(dev, &uc->ppm);
if (IS_ERR(uc->ucsi)) {
dev_err(uc->dev, "ucsi_register_ppm failed\n");
return PTR_ERR(uc->ucsi);
}
rab = CCGX_RAB_UCSI_DATA_BLOCK(offsetof(struct ucsi_data, version));
status = ccg_read(uc, rab, (u8 *)(uc->ppm.data) +
offsetof(struct ucsi_data, version),
sizeof(uc->ppm.data->version));
if (status < 0) {
ucsi_unregister_ppm(uc->ucsi);
return status;
}
i2c_set_clientdata(client, uc);
status = sysfs_create_group(&uc->dev->kobj, &ucsi_ccg_attr_group);
if (status)
dev_err(uc->dev, "cannot create sysfs group: %d\n", status);
pm_runtime_set_active(uc->dev);
pm_runtime_enable(uc->dev);
pm_runtime_idle(uc->dev);
return 0;
}
static int ucsi_ccg_remove(struct i2c_client *client)
{
struct ucsi_ccg *uc = i2c_get_clientdata(client);
cancel_work_sync(&uc->work);
ucsi_unregister_ppm(uc->ucsi);
pm_runtime_disable(uc->dev);
free_irq(uc->irq, uc);
sysfs_remove_group(&uc->dev->kobj, &ucsi_ccg_attr_group);
return 0;
}
static const struct i2c_device_id ucsi_ccg_device_id[] = {
{"ccgx-ucsi", 0},
{}
};
MODULE_DEVICE_TABLE(i2c, ucsi_ccg_device_id);
static int ucsi_ccg_resume(struct device *dev)
{
struct i2c_client *client = to_i2c_client(dev);
struct ucsi_ccg *uc = i2c_get_clientdata(client);
return ucsi_resume(uc->ucsi);
}
static int ucsi_ccg_runtime_suspend(struct device *dev)
{
return 0;
}
static int ucsi_ccg_runtime_resume(struct device *dev)
{
return 0;
}
static const struct dev_pm_ops ucsi_ccg_pm = {
.resume = ucsi_ccg_resume,
.runtime_suspend = ucsi_ccg_runtime_suspend,
.runtime_resume = ucsi_ccg_runtime_resume,
};
static struct i2c_driver ucsi_ccg_driver = {
.driver = {
.name = "ucsi_ccg",
.pm = &ucsi_ccg_pm,
},
.probe = ucsi_ccg_probe,
.remove = ucsi_ccg_remove,
.id_table = ucsi_ccg_device_id,
};
module_i2c_driver(ucsi_ccg_driver);
MODULE_AUTHOR("Ajay Gupta <ajayg@nvidia.com>");
MODULE_DESCRIPTION("UCSI driver for Cypress CCGx Type-C controller");
MODULE_LICENSE("GPL v2");
|