aboutsummaryrefslogtreecommitdiff
path: root/drivers/platform/x86/intel_scu_fw_update.c
blob: e8b866b5c4f49ec623c4ea94dc87b8d1366e4f35 (plain)
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
/*
 * fw_update.c - Intel SCU Firmware Update Driver
 *
 * Copyright (C) 2012 Intel Corporation
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/io.h>
#include <linux/delay.h>
#include <linux/fs.h>
#include <linux/vmalloc.h>
#include <linux/rpmsg.h>
#include <linux/intel_mid_pm.h>
#include <asm/intel_scu_ipc.h>
#include <asm/intel_scu_pmic.h>
#include <asm/intel_mid_rpmsg.h>
#include <asm/intel-mid.h>
#include <asm/msr.h>

/* Medfield & Cloverview firmware update.
 * The flow and communication between IA and SCU has changed for
 * Medfield firmware update. For more details, please refer to
 * Firmware Arch Spec.
 * Below macros and structs apply for medfield firmware update
 */

#define IPC_CMD_FW_UPDATE_GO	0x02

#define MAX_FW_CHUNK		(128*1024)
#define IFWX_CHUNK_SIZE		(96*1024)

#define SRAM_ADDR		0xFFFC0000
#define MAILBOX_ADDR		0xFFFE0000

#define SCU_FLAG_OFFSET		8
#define IA_FLAG_OFFSET		12

#define MIP_HEADER_OFFSET	0
#define SUCP_OFFSET		0x1D8000
#define VEDFW_OFFSET		0x1A6000

#define DNX_HDR_LEN		24
#define FUPH_HDR_LEN		36

#define DNX_IMAGE	"DXBL"
#define FUPH_HDR_SIZE	"RUPHS"
#define FUPH		"RUPH"
#define MIP		"DMIP"
#define IFWI		"IFW"
#define LOWER_128K	"LOFW"
#define UPPER_128K	"HIFW"
#define PSFW1		"PSFW1"
#define PSFW2		"PSFW2"
#define SSFW		"SSFW"
#define SUCP		"SuCP"
#define VEDFW		"VEDFW"
#define UPDATE_DONE	"HLT$"
#define UPDATE_ABORT	"HLT0"
#define UPDATE_ERROR	"ER"

#define MAX_LEN_IFW	4
#define MAX_LEN_PSFW	7
#define MAX_LEN_SSFW	6
#define MAX_LEN_SUCP	6
#define MAX_LEN_VEDFW	7

#define FUPH_MIP_OFFSET		0x04
#define FUPH_IFWI_OFFSET	0x08
#define FUPH_PSFW1_OFFSET	0x0c
#define FUPH_PSFW2_OFFSET	0x10
#define FUPH_SSFW_OFFSET	0x14
#define FUPH_SUCP_OFFSET	0x18
#define FUPH_VEDFW_OFFSET	0x1c

#define DNX_MAX_SIZE	(128*1024)
#define IFWI_MAX_SIZE	(3*1024*1024)
#define FOTA_MEM_SIZE	(4*1024*1024)

#define DNX_SIZE_OFFSET	0
#define GP_FLAG_OFFSET	4
#define XOR_CHK_OFFSET	20

#define GPF_BIT32	1
#define FUPH_STR	"UPH$"
#define FUPH_MAX_LEN	36
#define SKIP_BYTES	8

static struct kobject *scu_fw_update_kobj;
static struct rpmsg_instance *fw_update_instance;

/* Modified IA-SCU mailbox for medfield firmware update. */
struct ia_scu_mailbox {
	char mail[8];
	u32 scu_flag;
	u32 ia_flag;
};

/* Structure to parse input from firmware-update application. */
struct fw_ud {
	u8 *fw_file_data;
	u32 fsize;
	u8 *dnx_hdr;
	u8 *dnx_file_data;
	u32 dnx_size;
	u32 fuph_hdr_len;
};

struct mfld_fw_update {
	void __iomem *sram;
	void __iomem *mailbox;
	u32 wscu;
	u32 wia;
	char mb_status[8];
};

/* Holds size parameters read from fuph header */
struct fuph_hdr_attrs {
	u32 mip_size;
	u32 ifwi_size;
	u32 psfw1_size;
	u32 psfw2_size;
	u32 ssfw_size;
	u32 sucp_size;
	u32 vedfw_size;
};

enum mailbox_status {
	MB_DONE,
	MB_CONTINUE,
	MB_ERROR
};

/* Misc. firmware components that are part of integrated firmware */
struct misc_fw {
	const char *fw_type;
	u8 str_len;
};

/* lock used to prevent multiple calls to fw update sysfs interface */
static DEFINE_MUTEX(fwud_lock);

static char err_buf[50];
static u8 *pending_data;

struct fw_update_info {
	struct device *dev;
	struct fw_ud *fwud_pending;
};

/* Used to store firmware version. */
#define FW_VERSION_SIZE		16
#define FW_VERSION_MAX_SIZE	36
static u8 fw_version_raw_data[FW_VERSION_MAX_SIZE] = { 0 };

static u8 pmic_nvm_version;

static struct fw_update_info fui;

static struct misc_fw misc_fw_table[] = {
	{ .fw_type = IFWI, .str_len  = MAX_LEN_IFW },
	{ .fw_type = PSFW1, .str_len  = MAX_LEN_PSFW },
	{ .fw_type = SSFW, .str_len  = MAX_LEN_SSFW },
	{ .fw_type = PSFW2, .str_len  = MAX_LEN_PSFW },
	{ .fw_type = SUCP, .str_len  = MAX_LEN_SUCP },
	{ .fw_type = VEDFW, .str_len  = MAX_LEN_VEDFW }
};

static int alloc_fota_mem_early;

int __init alloc_mem_fota_early_flag(char *p)
{
	alloc_fota_mem_early = 1;
	return 0;
}
early_param("alloc_fota_mem_early", alloc_mem_fota_early_flag);

/*
 * IA will wait in busy-state, and poll mailbox, to check
 * if SCU is done processing.
 * If it has to wait for more than a second, it will exit with
 * error code.
 */
static int busy_wait(struct mfld_fw_update *mfld_fw_upd)
{
	u32 count = 0;
	u32 flag;

	flag = mfld_fw_upd->wscu;

	while (ioread32(mfld_fw_upd->mailbox + SCU_FLAG_OFFSET) != flag
		&& count < 500) {
		/* There are synchronization issues between IA and SCU */
		mb();
		/* FIXME: we must use mdelay currently */
		mdelay(10);
		count++;
	}

	if (ioread32(mfld_fw_upd->mailbox + SCU_FLAG_OFFSET) != flag) {
		dev_err(fui.dev, "IA-waited and quitting\n");
		return -ETIMEDOUT;
	}

	return 0;
}

/* This function will
 * 1)copy firmware chunk from user-space to kernel-space.
 * 2) Copy from kernel-space to shared SRAM.
 * 3) Write to mailbox.
 * 4) And wait for SCU to process that firmware chunk.
 * Returns 0 on success, and < 0 for failure.
 */
static int process_fw_chunk(u8 *fws, u8 *userptr, u32 chunklen,
					struct mfld_fw_update *mfld_fw_upd)
{
	memcpy(fws, userptr, chunklen);

	/* IA copy to sram */
	memcpy_toio(mfld_fw_upd->sram, fws, chunklen);

	/* There are synchronization issues between IA and SCU */
	mb();
	mfld_fw_upd->wia = !(mfld_fw_upd->wia);
	iowrite32(mfld_fw_upd->wia, mfld_fw_upd->mailbox + IA_FLAG_OFFSET);

	mb();
	dev_dbg(fui.dev, "wrote ia_flag=%d\n",
		 ioread32(mfld_fw_upd->mailbox + IA_FLAG_OFFSET));

	mfld_fw_upd->wscu = !mfld_fw_upd->wscu;
	return busy_wait(mfld_fw_upd);
}

/*
 * This function will check mailbox status flag, and return state of mailbox.
 */
static enum mailbox_status check_mb_status(struct mfld_fw_update *mfld_fw_upd)
{

	enum mailbox_status mb_state;

	/* There are synchronization issues between IA and SCU */
	mb();

	memcpy_fromio(mfld_fw_upd->mb_status, mfld_fw_upd->mailbox, 8);

	if (!strncmp(mfld_fw_upd->mb_status, UPDATE_ERROR,
					sizeof(UPDATE_ERROR) - 1) ||
		!strncmp(mfld_fw_upd->mb_status, UPDATE_ABORT,
					sizeof(UPDATE_ABORT) - 1)) {
		dev_dbg(fui.dev,
			"mailbox error=%s\n", mfld_fw_upd->mb_status);
		return MB_ERROR;
	} else {
		mb_state = (!strncmp(mfld_fw_upd->mb_status, UPDATE_DONE,
			sizeof(UPDATE_DONE) - 1)) ? MB_DONE : MB_CONTINUE;
		dev_dbg(fui.dev,
			"mailbox pass=%s, mb_state=%d\n",
			mfld_fw_upd->mb_status, mb_state);
	}

	return mb_state;
}

/* Helper function used to calculate length and offset.  */
int helper_for_calc_offset_length(struct fw_ud *fw_ud_ptr, char *scu_req,
			void **offset, u32 *len, struct fuph_hdr_attrs *fuph,
			const char *fw_type)
{
	unsigned long chunk_no;
	u32 chunk_rem;
	u32 max_chunk_cnt;
	u32 fw_size;
	u32 fw_offset;
	u32 max_fw_chunk_size = MAX_FW_CHUNK;

	if (!strncmp(fw_type, IFWI, strlen(IFWI))) {

		if (kstrtoul(scu_req + strlen(IFWI), 10, &chunk_no) < 0)
			return -EINVAL;

		/* On CTP, IFWx starts from IFW1, not IFW0, thus adjust the
		 * chunk_no to make '*offset' point to the correct address.
		 * Besides, the size of each IFWx chunk is 96k, not 128k
		 */
		chunk_no = chunk_no - 1;
		fw_size = fuph->ifwi_size;
		fw_offset = fuph->mip_size;
		max_fw_chunk_size = IFWX_CHUNK_SIZE;
	} else if (!strncmp(fw_type, PSFW1, strlen(PSFW1))) {

		if (kstrtoul(scu_req + strlen(PSFW1), 10, &chunk_no) < 0)
			return -EINVAL;

		fw_size = fuph->psfw1_size;
		fw_offset = fuph->mip_size + fuph->ifwi_size;
	} else if (!strncmp(fw_type, PSFW2, strlen(PSFW2))) {

		if (kstrtoul(scu_req + strlen(PSFW2), 10, &chunk_no) < 0)
			return -EINVAL;

		fw_size = fuph->psfw2_size;
		fw_offset = fuph->mip_size + fuph->ifwi_size +
				fuph->psfw1_size + fuph->ssfw_size;
	} else if (!strncmp(fw_type, SSFW, strlen(SSFW))) {

		if (kstrtoul(scu_req + strlen(SSFW), 10, &chunk_no) < 0)
			return -EINVAL;

		fw_size = fuph->ssfw_size;
		fw_offset = fuph->mip_size + fuph->ifwi_size +
				fuph->psfw1_size;
	} else if (!strncmp(fw_type, SUCP, strlen(SUCP))) {

		if (kstrtoul(scu_req + strlen(SUCP), 10, &chunk_no) < 0)
			return -EINVAL;

		fw_size = fuph->sucp_size;
		fw_offset = SUCP_OFFSET;
	} else if (!strncmp(fw_type, VEDFW, strlen(VEDFW))) {

		if (kstrtoul(scu_req + strlen(VEDFW), 10, &chunk_no) < 0)
			return -EINVAL;

		fw_size = fuph->vedfw_size;
		fw_offset = VEDFW_OFFSET;
	} else
		return -EINVAL;

	chunk_rem = fw_size % max_fw_chunk_size;
	max_chunk_cnt = (fw_size/max_fw_chunk_size) + (chunk_rem ? 1 : 0);

	dev_dbg(fui.dev,
		"str=%s,chunk_no=%lx, chunk_rem=%d,max_chunk_cnt=%d\n",
		fw_type, chunk_no, chunk_rem, max_chunk_cnt);

	if ((chunk_no + 1) > max_chunk_cnt)
		return -EINVAL;

	/* Note::Logic below will make sure, that we get right length if input
	 is 128K or multiple. */
	*len = (chunk_no == (max_chunk_cnt - 1)) ?
		(chunk_rem ? chunk_rem : max_fw_chunk_size) : max_fw_chunk_size;

	*offset = fw_ud_ptr->fw_file_data + fw_offset +
		chunk_no * max_fw_chunk_size;

	return 0;
}

/*
 * This api calculates offset and length depending on type of firmware chunk
 * requested by SCU. Note: Intent is to follow the architecture such that,
 * SCU controls the flow, and IA simply hands out, what is requested by SCU.
 * IA will simply follow SCU's commands, unless SCU requests for something
 * IA cannot give. TODO:That will be a special error case, need to figure out
 * how to handle that.
 */
int calc_offset_and_length(struct fw_ud *fw_ud_ptr, char *scu_req,
			void **offset, u32 *len, struct fuph_hdr_attrs *fuph)
{
	u8 cnt;

	if (!strncmp(DNX_IMAGE, scu_req, strlen(scu_req))) {
		*offset = fw_ud_ptr->dnx_file_data;
		*len = fw_ud_ptr->dnx_size;
		return 0;
	} else if (!strncmp(FUPH, scu_req, strlen(scu_req))) {
		*offset = fw_ud_ptr->fw_file_data + fw_ud_ptr->fsize
				- fw_ud_ptr->fuph_hdr_len;
		*len = fw_ud_ptr->fuph_hdr_len;
		return 0;
	} else if (!strncmp(MIP, scu_req, strlen(scu_req))) {
		*offset = fw_ud_ptr->fw_file_data + MIP_HEADER_OFFSET;
		*len = fuph->mip_size;
		return 0;
	} else if (!strncmp(LOWER_128K, scu_req, strlen(scu_req))) {
		*offset = fw_ud_ptr->fw_file_data + fuph->mip_size;
		*len = MAX_FW_CHUNK;
		return 0;
	} else if (!strncmp(UPPER_128K, scu_req, strlen(scu_req))) {
		*offset = fw_ud_ptr->fw_file_data
				+ fuph->mip_size + MAX_FW_CHUNK;
		*len = MAX_FW_CHUNK;
		return 0;
	} else {
		for (cnt = 0; cnt < ARRAY_SIZE(misc_fw_table); cnt++) {

			if (!strncmp(misc_fw_table[cnt].fw_type, scu_req,
					strlen(misc_fw_table[cnt].fw_type))) {

				if (strlen(scu_req) ==
						misc_fw_table[cnt].str_len) {

					if (helper_for_calc_offset_length
						(fw_ud_ptr, scu_req,
						offset, len, fuph,
						misc_fw_table[cnt].fw_type) < 0)
						goto error_case;

					dev_dbg(fui.dev,
					"\nmisc fw type=%s, len=%u,offset=%p",
					misc_fw_table[cnt].fw_type, *len,
					*offset);

					return 0;

				} else
					goto error_case;
			}
		}

	}

	dev_dbg(fui.dev, "Unexpected mailbox request from scu\n");

error_case:
	/* TODO::Need to test this error case..and see how SCU reacts
	* and how IA handles
	* subsequent error response and whether exit is graceful...
	*/

	dev_dbg(fui.dev, "error case,respond back to SCU..\n");
	dev_dbg(fui.dev, "scu_req=%s\n", scu_req);
	*len = 0;
	*offset = 0;

	return -EINVAL;
}

/**
 * intel_scu_ipc_medfw_upgrade - Medfield Firmware update utility
 *
 * The flow and communication between IA and SCU has changed for
 * Medfield firmware update. So we have a different api below
 * to support Medfield firmware update.
 *
 * On success returns 0, for failure , returns < 0.
 */
static int intel_scu_ipc_medfw_upgrade(void)
{
	struct fw_ud *fw_ud_param = fui.fwud_pending;
	struct mfld_fw_update	mfld_fw_upd;
	u8 *fw_file_data = NULL;
	u8 *fws = NULL;
	u8 *fuph_start = NULL;
	int ret_val = 0;

	struct fuph_hdr_attrs fuph;
	u32 length = 0;
	void *offset;
	enum mailbox_status mb_state;

	/* set all devices in d0i0 before IFWI upgrade */
	if (unlikely(pmu_set_devices_in_d0i0())) {
		pr_debug("pmu: failed to set all devices in d0i0...\n");
		BUG();
	}

	rpmsg_global_lock();

	mfld_fw_upd.wscu = 0;
	mfld_fw_upd.wia = 0;
	memset(mfld_fw_upd.mb_status, 0, sizeof(char) * 8);

	fw_file_data = fw_ud_param->fw_file_data;
	mfld_fw_upd.sram = ioremap_nocache(SRAM_ADDR, MAX_FW_CHUNK);
	if (mfld_fw_upd.sram == NULL) {
		dev_err(fui.dev, "unable to map sram\n");
		ret_val = -ENOMEM;
		goto out_unlock;
	}

	mfld_fw_upd.mailbox = ioremap_nocache(MAILBOX_ADDR,
					sizeof(struct ia_scu_mailbox));

	if (mfld_fw_upd.mailbox == NULL) {
		dev_err(fui.dev, "unable to map the mailbox\n");
		ret_val = -ENOMEM;
		goto unmap_sram;
	}

	/*IA initializes both IAFlag and SCUFlag to zero */
	iowrite32(0, mfld_fw_upd.mailbox + SCU_FLAG_OFFSET);
	iowrite32(0, mfld_fw_upd.mailbox + IA_FLAG_OFFSET);
	memset_io(mfld_fw_upd.mailbox, 0, 8);

	fws = kmalloc(MAX_FW_CHUNK, GFP_KERNEL);
	if (fws == NULL) {
		ret_val = -ENOMEM;
		goto unmap_mb;
	}

	/* fuph header start */
	fuph_start = fw_ud_param->fw_file_data + (fw_ud_param->fsize - 1)
					- (fw_ud_param->fuph_hdr_len - 1);

	/* Convert sizes in DWORDS to number of bytes. */
	fuph.mip_size = (*((u32 *)(fuph_start + FUPH_MIP_OFFSET)))*4;
	fuph.ifwi_size = (*((u32 *)(fuph_start + FUPH_IFWI_OFFSET)))*4;
	fuph.psfw1_size = (*((u32 *)(fuph_start + FUPH_PSFW1_OFFSET)))*4;
	fuph.psfw2_size = (*((u32 *)(fuph_start + FUPH_PSFW2_OFFSET)))*4;
	fuph.ssfw_size = (*((u32 *)(fuph_start + FUPH_SSFW_OFFSET)))*4;
	fuph.sucp_size = (*((u32 *)(fuph_start + FUPH_SUCP_OFFSET)))*4;

	if (fw_ud_param->fuph_hdr_len == FUPH_HDR_LEN) {
		fuph.vedfw_size =
				(*((u32 *)(fuph_start + FUPH_VEDFW_OFFSET)))*4;
	} else
		fuph.vedfw_size = 0;

	dev_dbg(fui.dev,
		"ln=%d, mi=%d, if=%d, ps1=%d, ps2=%d, sfw=%d, sucp=%d, vd=%d\n",
		fw_ud_param->fuph_hdr_len, fuph.mip_size, fuph.ifwi_size,
		fuph.psfw1_size, fuph.psfw2_size, fuph.ssfw_size,
		fuph.sucp_size,	fuph.vedfw_size);

	/* TODO_SK::There is just
	 *  1 write required from IA side for DFU.
	 *  So commenting this-out, until it gets confirmed */
	/*ipc_command(IPC_CMD_FW_UPDATE_READY); */

	/*1. DNX SIZE HEADER   */
	memcpy(fws, fw_ud_param->dnx_hdr, DNX_HDR_LEN);

	memcpy_toio(mfld_fw_upd.sram, fws, DNX_HDR_LEN);

	/* There are synchronization issues between IA and SCU */
	mb();

	/* Write cmd to trigger an interrupt to SCU for firmware update*/
	ret_val = rpmsg_send_simple_command(fw_update_instance,
					    IPCMSG_FW_UPDATE,
					    IPC_CMD_FW_UPDATE_GO);

	if (ret_val) {
		dev_err(fui.dev, "IPC_CMD_FW_UPDATE_GO failed\n");
		goto term;
	}

	mfld_fw_upd.wscu = !mfld_fw_upd.wscu;

	if (busy_wait(&mfld_fw_upd) < 0) {
		ret_val = -1;
		goto term;
	}

	/* TODO:Add a count for iteration, based on sizes of security firmware,
	 * so that we determine finite number of iterations to loop thro.
	 * That way at the very least, we can atleast control the number
	 * of iterations, and prevent infinite looping if there are any bugs.
	 * The only catch being for B0, SCU will request twice for each firmware
	 * chunk, since its writing to 2 partitions.
	 * TODO::Investigate if we need to increase timeout for busy_wait,
	 * since SCU is now writing to 2 partitions.
	 */

	while ((mb_state = check_mb_status(&mfld_fw_upd)) != MB_DONE) {

		if (mb_state == MB_ERROR) {
			dev_dbg(fui.dev, "check_mb_status,error\n");
			ret_val = -1;
			goto term;
		}

		if (!strncmp(mfld_fw_upd.mb_status, FUPH_HDR_SIZE,
				strlen(FUPH_HDR_SIZE))) {
			iowrite32(fw_ud_param->fuph_hdr_len, mfld_fw_upd.sram);
			/* There are synchronization issues between IA-SCU */
			mb();
			dev_dbg(fui.dev,
				"copied fuph hdr size=%d\n",
				ioread32(mfld_fw_upd.sram));
			mfld_fw_upd.wia = !mfld_fw_upd.wia;
			iowrite32(mfld_fw_upd.wia, mfld_fw_upd.mailbox +
				IA_FLAG_OFFSET);
			dev_dbg(fui.dev, "ia_flag=%d\n",
				ioread32(mfld_fw_upd.mailbox + IA_FLAG_OFFSET));
			mb();
			mfld_fw_upd.wscu = !mfld_fw_upd.wscu;

			if (busy_wait(&mfld_fw_upd) < 0) {
				ret_val = -1;
				goto term;
			}

			continue;
		}

		if (calc_offset_and_length(fw_ud_param, mfld_fw_upd.mb_status,
					&offset, &length, &fuph) < 0) {
			dev_err(fui.dev,
			"calc_offset_and_length_error,error\n");
			ret_val = -1;
			goto term;
		}

		if ((process_fw_chunk(fws, offset, length,
				      &mfld_fw_upd)) != 0) {
			dev_err(fui.dev,
			"Error processing fw chunk=%s\n",
			mfld_fw_upd.mb_status);
			ret_val = -1;
			goto term;
		} else
			dev_dbg(fui.dev,
				"PASS processing fw chunk=%s\n",
				mfld_fw_upd.mb_status);
	}
	ret_val = intel_scu_ipc_check_status();

term:
	kfree(fws);
unmap_mb:
	iounmap(mfld_fw_upd.mailbox);
unmap_sram:
	iounmap(mfld_fw_upd.sram);
out_unlock:
	rpmsg_global_unlock();

	return ret_val;
}

static void cur_err(const char *err_info)
{
	strncpy(err_buf, err_info, sizeof(err_buf) - 1);
}

static ssize_t write_dnx(struct file *file, struct kobject *kobj,
	struct bin_attribute *attr, char *buf, loff_t off, size_t count)
{
	int ret;

	mutex_lock(&fwud_lock);

	if (!pending_data) {
		pending_data = vmalloc(FOTA_MEM_SIZE);
		if (NULL == pending_data) {
			cur_err("alloc fota memory by sysfs failed\n");
			ret = -ENOMEM;
			goto end;
		}
	}

	fui.fwud_pending->dnx_file_data = pending_data + IFWI_MAX_SIZE;

	if (unlikely(off >= DNX_MAX_SIZE)) {
		fui.fwud_pending->dnx_file_data = NULL;
		cur_err("too large dnx binary stream!");
		ret = -EFBIG;
		goto end;
	}

	if (unlikely((off + IFWI_MAX_SIZE) < 0)) {
		fui.fwud_pending->dnx_file_data = NULL;
		cur_err("invalid argument below lower bound!");
		ret = -EINVAL;
		goto end;
	}

	if (unlikely((off + IFWI_MAX_SIZE + count) > FOTA_MEM_SIZE)) {
		fui.fwud_pending->dnx_file_data = NULL;
		cur_err("invalid argument exceeding upper bound!");
		ret = -EINVAL;
		goto end;
	}

	memcpy(fui.fwud_pending->dnx_file_data + off, buf, count);

	if (!off)
		fui.fwud_pending->dnx_size = count;
	else
		fui.fwud_pending->dnx_size += count;

	mutex_unlock(&fwud_lock);
	return count;

end:
	mutex_unlock(&fwud_lock);
	return ret;
}

/* Parses from the end of IFWI, and looks for UPH$,
 * to determine length of FUPH header
 */
static int find_fuph_header_len(unsigned int *len,
		unsigned char *file_data, unsigned int file_size)
{
	int ret = -EINVAL;
	unsigned char *temp;
	unsigned int cnt = 0;

	if (!len || !file_data || !file_size) {
		dev_err(fui.dev, "find_fuph_header_len: Invalid inputs\n");
		return ret;
	}

	/* Skipping the checksum at the end, and moving to the
	 * start of the last add-on firmware size in fuph.
	 */
	temp = file_data + file_size - SKIP_BYTES;

	while (cnt <= FUPH_MAX_LEN) {
		if (!strncmp(temp, FUPH_STR, sizeof(FUPH_STR) - 1)) {
			pr_info("Fuph_hdr_len=%d\n", cnt + SKIP_BYTES);
			*len = cnt + SKIP_BYTES;
			ret = 0;
			break;
		}
		temp -= 4;
		cnt += 4;
	}

	return ret;
}

static ssize_t write_ifwi(struct file *file, struct kobject *kobj,
	struct bin_attribute *attr, char *buf, loff_t off, size_t count)
{
	int ret;

	mutex_lock(&fwud_lock);

	if (!pending_data) {
		pending_data = vmalloc(FOTA_MEM_SIZE);
		if (NULL == pending_data) {
			cur_err("alloc fota memory by sysfs failed\n");
			ret = -ENOMEM;
			goto end;
		}
	}

	fui.fwud_pending->fw_file_data = pending_data;

	if (unlikely(off >= IFWI_MAX_SIZE)) {
		fui.fwud_pending->fw_file_data = NULL;
		cur_err("too large ifwi binary stream!\n");
		ret = -EFBIG;
		goto end;
	}

	if (unlikely(off < 0)) {
		fui.fwud_pending->fw_file_data = NULL;
		cur_err("invalid argument below lower bound!\n");
		ret = -EINVAL;
		goto end;
	}

	if (unlikely((off + count) > FOTA_MEM_SIZE)) {
		fui.fwud_pending->fw_file_data = NULL;
		cur_err("invalid argument exceeding upper bound!\n");
		ret = -EINVAL;
		goto end;
	}

	memcpy(fui.fwud_pending->fw_file_data + off, buf, count);

	if (!off)
		fui.fwud_pending->fsize = count;
	else
		fui.fwud_pending->fsize += count;

	mutex_unlock(&fwud_lock);
	return count;

end:
	mutex_unlock(&fwud_lock);
	return ret;
}

/*
 * intel_scu_fw_prepare - prepare dnx_hdr and fuph
 *
 * This function will be invoked at reboot, when DNX and IFWI data are ready.
 */
static int intel_scu_fw_prepare(struct fw_ud *fwud_pending)
{
	unsigned int size;
	unsigned int gpFlags = 0;
	unsigned int xorcs;
	unsigned char dnxSH[DNX_HDR_LEN] = { 0 };

	mutex_lock(&fwud_lock);

	size = fui.fwud_pending->dnx_size;

	/* Set GPFlags parameter */
	gpFlags = gpFlags | (GPF_BIT32 << 31);
	xorcs = (size ^ gpFlags);

	memcpy((dnxSH + DNX_SIZE_OFFSET), (unsigned char *)(&size), 4);
	memcpy((dnxSH + GP_FLAG_OFFSET), (unsigned char *)(&gpFlags), 4);
	memcpy((dnxSH + XOR_CHK_OFFSET), (unsigned char *)(&xorcs), 4);

	/* assign the last DNX_HDR_LEN bytes memory to dnx header */
	fui.fwud_pending->dnx_hdr = pending_data + FOTA_MEM_SIZE - DNX_HDR_LEN;

	/* directly memcpy to dnx_hdr */
	memcpy(fui.fwud_pending->dnx_hdr, dnxSH, DNX_HDR_LEN);

	if (find_fuph_header_len(&(fui.fwud_pending->fuph_hdr_len),
			fui.fwud_pending->fw_file_data,
			fui.fwud_pending->fsize) < 0) {
		dev_err(fui.dev, "Error with FUPH header\n");
		mutex_unlock(&fwud_lock);
		return -EINVAL;
	}

	dev_dbg(fui.dev, "fupd_hdr_len=%d, fsize=%d, dnx_size=%d",
		fui.fwud_pending->fuph_hdr_len,	fui.fwud_pending->fsize,
		fui.fwud_pending->dnx_size);

	mutex_unlock(&fwud_lock);
	return 0;
}

int intel_scu_ipc_fw_update(void)
{
	int ret = 0;

	/* jump fw upgrade process when fota memory not allocated
	 * or when user cancels update
	 * or when one of dnx and ifwi is not written
	 * or when failure happens in writing one of dnx and ifwi
	 */
	if (!pending_data || !fui.fwud_pending ||
		!fui.fwud_pending->dnx_file_data ||
		!fui.fwud_pending->fw_file_data) {
		pr_info("Jump FW upgrade process\n");
		goto end;
	}

	ret = intel_scu_fw_prepare(fui.fwud_pending);
	if (ret) {
		dev_err(fui.dev, "intel_scu_fw_prepare failed\n");
		goto end;
	}

	ret = intel_scu_ipc_medfw_upgrade();
	if (ret)
		dev_err(fui.dev, "intel_scu_ipc_medfw_upgrade failed\n");

end:
	return ret;
}
EXPORT_SYMBOL(intel_scu_ipc_fw_update);

static ssize_t fw_version_show(struct kobject *kobj,
		struct kobj_attribute *attr, char *buf)
{
	int data_to_copy, i;
	int used = 0;

	if (intel_mid_identify_cpu() > INTEL_MID_CPU_CHIP_CLOVERVIEW)
		data_to_copy = FW_VERSION_MAX_SIZE;
	else
		data_to_copy = FW_VERSION_SIZE;

	for (i = 0; i < data_to_copy; i++)
		used += snprintf(buf + used, PAGE_SIZE - used, "%x ",
				fw_version_raw_data[i]);

	return used;
}

/*
 * Read IFWI version
 */

#define INTE_SCU_FW_BUF_LENGTH              256
#define INTE_SCU_IPC_FW_VERSION_LENGTH      16

#define INTE_SCU_IPC_FW_REVISION_MAJ_REG    15
#define INTE_SCU_IPC_FW_REVISION_MIN_REG    14
#define INTE_SCU_IPC_SCU_RT_FW_REVISION_MAJ_REG    1
#define INTE_SCU_IPC_SCU_RT_FW_REVISION_MIN_REG    0
#define INTE_SCU_IPC_PUNIT_FW_REVISION_MAJ_REG     5
#define INTE_SCU_IPC_PUNIT_FW_REVISION_MIN_REG     4
#define INTE_SCU_IPC_IA32_FW_REVISION_MAJ_REG      7
#define INTE_SCU_IPC_IA32_FW_REVISION_MIN_REG      6
#define INTE_SCU_IPC_SUPP_IA32_FW_REVISION_MAJ_REG 9
#define INTE_SCU_IPC_SUPP_IA32_FW_REVISION_MIN_REG 8
#define INTE_SCU_IPC_VALHOOKS_FW_REVISION_MAJ_REG  11
#define INTE_SCU_IPC_VALHOOKS_FW_REVISION_MIN_REG  10

#define INTE_SCU_IPC_SCU_BS_FW_REVISION_EXT_MIN_REG    0
#define INTE_SCU_IPC_SCU_BS_FW_REVISION_EXT_MAJ_REG    2
#define INTE_SCU_IPC_SCU_RT_FW_REVISION_EXT_MIN_REG    4
#define INTE_SCU_IPC_SCU_RT_FW_REVISION_EXT_MAJ_REG    6
#define INTE_SCU_IPC_IA32_FW_REVISION_EXT_MIN_REG      8
#define INTE_SCU_IPC_IA32_FW_REVISION_EXT_MAJ_REG      10
#define INTE_SCU_IPC_VALHOOKS_FW_REVISION_EXT_MIN_REG  12
#define INTE_SCU_IPC_VALHOOKS_FW_REVISION_EXT_MAJ_REG  14

#define INTE_SCU_IPC_FW_REVISION_EXT_MIN_REG           0
#define INTE_SCU_IPC_FW_REVISION_EXT_MAJ_REG           2
#define INTE_SCU_IPC_CHAABI_FW_REVISION_EXT_MIN_REG    4
#define INTE_SCU_IPC_CHAABI_FW_REVISION_EXT_MAJ_REG    6
#define INTE_SCU_IPC_MIA_FW_REVISION_EXT_MIN_REG       8
#define INTE_SCU_IPC_MIA_FW_REVISION_EXT_MAJ_REG       10
#define INTE_PUNIT_FW_REVISION_EXT_MIN_REG             12
#define INTE_PUNIT_FW_REVISION_EXT_MAJ_REG             14
#define INTE_UCODE_FW_REVISION_EXT_MIN_REG             16
#define INTE_UCODE_FW_REVISION_EXT_MAJ_REG             18

#define INTE_SCU_FW_OFFS	0
#define INTE_SCU_FW_EXT_OFFS	1

struct scu_ipc_version {
	unsigned int    count;    /* length of version info */
	unsigned char   data[FW_VERSION_MAX_SIZE]; /* version data */
	char            scu_bs[FW_VERSION_SIZE];
	char            scu_rt[FW_VERSION_SIZE];
	char            ia32fw[FW_VERSION_SIZE];
	char            supp_ia32fw[FW_VERSION_SIZE];
	char            valhooks[FW_VERSION_SIZE];
	char            ifwi[FW_VERSION_SIZE];
	char            chaabi[FW_VERSION_SIZE];
	char            mia[FW_VERSION_SIZE];
	char            punit[FW_VERSION_SIZE];
	char            ucode[FW_VERSION_SIZE];
};

struct scu_ipc_version version;

static void format_rev_4_digit(struct scu_ipc_version ver, int vers_ext, char *buf,
		int pos_maj, int pos_min)
{
	int offs;

	if (vers_ext)
		offs = FW_VERSION_SIZE;
	else
		offs = 0;
	snprintf(buf, FW_VERSION_SIZE, "%.4X.%.4X",
		ver.data[offs + pos_maj + 1] << 8 | ver.data[offs + pos_maj],
		ver.data[offs + pos_min + 1] << 8 | ver.data[offs + pos_min]);
}

static void format_rev_2_digit(struct scu_ipc_version ver, char *buf,
		int pos_maj, int pos_min)
{
	snprintf(buf, FW_VERSION_SIZE, "%.2X.%.2X",
		ver.data[pos_maj], ver.data[pos_min]);
}

static void read_ifwi_version(void)
{
	bool ifwi_rev_ext = false;

	/* Check how to read components versions. For example, with older */
	/* CPU, major/minor version is coded on 2 digits only.            */
	if (intel_mid_identify_cpu() > INTEL_MID_CPU_CHIP_CLOVERVIEW)
		ifwi_rev_ext = true;

	version.count = FW_VERSION_SIZE;
	memcpy(version.data, fw_version_raw_data, FW_VERSION_SIZE);

	if (ifwi_rev_ext) {
		memcpy(version.data + FW_VERSION_SIZE,
			fw_version_raw_data + FW_VERSION_SIZE,
			FW_VERSION_MAX_SIZE - FW_VERSION_SIZE);

		format_rev_4_digit(version, INTE_SCU_FW_OFFS, version.scu_bs,
				INTE_SCU_IPC_SCU_BS_FW_REVISION_EXT_MAJ_REG,
				INTE_SCU_IPC_SCU_BS_FW_REVISION_EXT_MIN_REG);
		pr_info("SCU BS Version: %s\n", version.scu_bs);

		format_rev_4_digit(version, INTE_SCU_FW_OFFS, version.scu_rt,
				INTE_SCU_IPC_SCU_RT_FW_REVISION_EXT_MAJ_REG,
				INTE_SCU_IPC_SCU_RT_FW_REVISION_EXT_MIN_REG);
		pr_info("SCU RT Version: %s\n", version.scu_rt);

		format_rev_4_digit(version, INTE_SCU_FW_OFFS, version.ia32fw,
				INTE_SCU_IPC_IA32_FW_REVISION_EXT_MAJ_REG,
				INTE_SCU_IPC_IA32_FW_REVISION_EXT_MIN_REG);
		pr_info("IA32FW Version: %s\n", version.ia32fw);

		format_rev_4_digit(version, INTE_SCU_FW_OFFS, version.valhooks,
				INTE_SCU_IPC_VALHOOKS_FW_REVISION_EXT_MAJ_REG,
				INTE_SCU_IPC_VALHOOKS_FW_REVISION_EXT_MIN_REG);
		pr_info("ValHooks Version: %s\n", version.valhooks);

		format_rev_4_digit(version, INTE_SCU_FW_EXT_OFFS, version.ifwi,
				INTE_SCU_IPC_FW_REVISION_EXT_MAJ_REG,
				INTE_SCU_IPC_FW_REVISION_EXT_MIN_REG);
		pr_info("IFWI Version: %s\n", version.ifwi);

		format_rev_4_digit(version, INTE_SCU_FW_EXT_OFFS, version.chaabi,
				INTE_SCU_IPC_CHAABI_FW_REVISION_EXT_MAJ_REG,
				INTE_SCU_IPC_CHAABI_FW_REVISION_EXT_MIN_REG);
		pr_info("CHAABI Version: %s\n", version.chaabi);

		format_rev_4_digit(version, INTE_SCU_FW_EXT_OFFS, version.mia,
				INTE_SCU_IPC_MIA_FW_REVISION_EXT_MAJ_REG,
				INTE_SCU_IPC_MIA_FW_REVISION_EXT_MIN_REG);
		pr_info("mIA Version: %s\n", version.mia);

		format_rev_4_digit(version, INTE_SCU_FW_EXT_OFFS, version.punit,
				INTE_PUNIT_FW_REVISION_EXT_MAJ_REG,
				INTE_PUNIT_FW_REVISION_EXT_MIN_REG);
		pr_info("PUnit Version: %s\n", version.punit);

		format_rev_4_digit(version, INTE_SCU_FW_EXT_OFFS, version.ucode,
				INTE_UCODE_FW_REVISION_EXT_MAJ_REG,
				INTE_UCODE_FW_REVISION_EXT_MIN_REG);
		pr_info("uCode Version: %s\n", version.ucode);
	} else {
		format_rev_2_digit(version, version.ifwi,
				INTE_SCU_IPC_FW_REVISION_MAJ_REG,
				INTE_SCU_IPC_FW_REVISION_MIN_REG);
		pr_info("IFWI Version: %s\n", version.ifwi);

		format_rev_2_digit(version, version.scu_rt,
				INTE_SCU_IPC_SCU_RT_FW_REVISION_MAJ_REG,
				INTE_SCU_IPC_SCU_RT_FW_REVISION_MIN_REG);
		pr_info("SCU Version: %s\n", version.scu_rt);

		format_rev_2_digit(version, version.punit,
				INTE_SCU_IPC_PUNIT_FW_REVISION_MAJ_REG,
				INTE_SCU_IPC_PUNIT_FW_REVISION_MIN_REG);
		pr_info("PUnit Version: %s\n", version.punit);

		format_rev_2_digit(version, version.ia32fw,
				INTE_SCU_IPC_IA32_FW_REVISION_MAJ_REG,
				INTE_SCU_IPC_IA32_FW_REVISION_MIN_REG);
		pr_info("IA32FW Version: %s\n", version.ia32fw);

		format_rev_2_digit(version, version.supp_ia32fw,
				INTE_SCU_IPC_SUPP_IA32_FW_REVISION_MAJ_REG,
				INTE_SCU_IPC_SUPP_IA32_FW_REVISION_MIN_REG);
		pr_info("SUPP IA32FW Version: %s\n", version.supp_ia32fw);

		format_rev_2_digit(version, version.valhooks,
				INTE_SCU_IPC_VALHOOKS_FW_REVISION_MAJ_REG,
				INTE_SCU_IPC_VALHOOKS_FW_REVISION_MIN_REG);
		pr_info("ValHooks Version: %s\n", version.valhooks);
	}
	return;
}

#define MSR_PUNIT_VERSION_ADDR 0x667
#define MSR_UCODE_VERSION_ADDR 0x8b
#define MSR_PMIC_NVM_VERSION_ADDR 0x6E08

static int fw_version_info(void)
{
	int ret;
	u32 low, high;

	memset(fw_version_raw_data, 0, FW_VERSION_MAX_SIZE);

	ret = rpmsg_send_command(fw_update_instance, IPCMSG_FW_REVISION, 0,
				NULL, (u32 *)fw_version_raw_data, 0, 4);
	if (ret < 0) {
		cur_err("Error getting fw version");
		return -EINVAL;
	}

	if (intel_mid_identify_cpu() > INTEL_MID_CPU_CHIP_CLOVERVIEW) {
		ret = rpmsg_send_command(fw_update_instance,
			IPCMSG_FW_REVISION, 1, NULL,
			(u32 *)(fw_version_raw_data + FW_VERSION_SIZE), 0, 4);
		if (ret < 0) {
			cur_err("Error getting fw version");
			return -EINVAL;
		}
		/* PUnit version is not availabe in SMIP, we get it with a
		   machine-specific register read, same for uCode */
		rdmsr(MSR_PUNIT_VERSION_ADDR, low, high);
		*(u32 *)(fw_version_raw_data + FW_VERSION_SIZE +
				INTE_PUNIT_FW_REVISION_EXT_MIN_REG) = low;
		rdmsr(MSR_UCODE_VERSION_ADDR, low, high);
		*(u32 *)(fw_version_raw_data + FW_VERSION_SIZE +
				INTE_UCODE_FW_REVISION_EXT_MIN_REG) = high;
	}

	read_ifwi_version();

	if (intel_mid_identify_cpu() == INTEL_MID_CPU_CHIP_ANNIEDALE) {
		ret = intel_scu_ipc_ioread8(MSR_PMIC_NVM_VERSION_ADDR, &pmic_nvm_version);
		if (ret < 0) {
			cur_err("Error getting PMIC NVM version");
			return -EINVAL;
		}
		pr_info("PMIC NVM Version: %.2X\n", pmic_nvm_version);
	}
	return 0;
}

static ssize_t sys_version_show(struct kobject *kobj,
		struct kobj_attribute *attr, char *buf)
{
	if (intel_mid_identify_cpu() > INTEL_MID_CPU_CHIP_CLOVERVIEW) {
		if (strcmp(attr->attr.name, "chaabi_version") == 0)
			return snprintf(buf, PAGE_SIZE, "%s\n",
					version.chaabi);
		if (strcmp(attr->attr.name, "mia_version") == 0)
			return snprintf(buf, PAGE_SIZE, "%s\n",
					version.mia);
		if (strcmp(attr->attr.name, "scu_bs_version") == 0)
			return snprintf(buf, PAGE_SIZE, "%s\n",
					version.scu_bs);
		if (strcmp(attr->attr.name, "ucode_version") == 0)
			return snprintf(buf, PAGE_SIZE, "%s\n",
					version.ucode);
	} else {
		if (strcmp(attr->attr.name, "supp_ia32fw_version") == 0)
			return snprintf(buf, PAGE_SIZE, "%s\n", version.supp_ia32fw);
	}

	if (strcmp(attr->attr.name, "punit_version") == 0)
		return snprintf(buf, PAGE_SIZE, "%s\n", version.punit);
	if (strcmp(attr->attr.name, "ifwi_version") == 0)
		return snprintf(buf, PAGE_SIZE, "%s\n", version.ifwi);
	if (strcmp(attr->attr.name, "scu_version") == 0)
		return snprintf(buf, PAGE_SIZE, "%s\n", version.scu_rt);
	if (strcmp(attr->attr.name, "ia32fw_version") == 0)
		return snprintf(buf, PAGE_SIZE, "%s\n", version.ia32fw);
	if (strcmp(attr->attr.name, "valhooks_version") == 0)
		return snprintf(buf, PAGE_SIZE, "%s\n", version.valhooks);

	pr_err("component version not found\n");
	return 0;
}

static ssize_t pmic_nvm_version_show(struct kobject *kobj,
		struct kobj_attribute *attr, char *buf)
{
	return snprintf(buf, PAGE_SIZE, "%.2X\n", pmic_nvm_version);
}

static ssize_t last_error_show(struct kobject *kobj,
		struct kobj_attribute *attr, char *buf)
{
	return snprintf(buf, PAGE_SIZE, "%s\n", err_buf);
}

static ssize_t cancel_update_store(struct kobject *kobj,
		struct kobj_attribute *attr, const char *buf, size_t size)
{
	int value;

	if (sscanf(buf, "%d", &value) != 1) {
		cur_err("One argument is needed\n");
		return -EINVAL;
	}

	if (value == 1) {
		mutex_lock(&fwud_lock);
		fui.fwud_pending->fw_file_data = NULL;
		fui.fwud_pending->dnx_file_data = NULL;
		mutex_unlock(&fwud_lock);
	} else {
		cur_err("input '1' to cancel fw upgrade\n");
		return -EINVAL;
	}

	return size;
}

#define __BIN_ATTR(_name, _mode, _size, _read, _write) { \
	.attr = {.name = __stringify(_name), .mode = _mode },	\
	.size	= _size,					\
	.read	= _read,					\
	.write	= _write,					\
}

#define BIN_ATTR(_name, _mode, _size, _read, _write) \
struct bin_attribute bin_attr_##_name =	\
	__BIN_ATTR(_name, _mode, _size, _read, _write)

#define KOBJ_FW_UPDATE_ATTR(_name, _mode, _show, _store) \
	struct kobj_attribute _name##_attr = __ATTR(_name, _mode, _show, _store)

static KOBJ_FW_UPDATE_ATTR(cancel_update, S_IWUSR, NULL, cancel_update_store);
static KOBJ_FW_UPDATE_ATTR(fw_version, S_IRUSR, fw_version_show, NULL);
static KOBJ_FW_UPDATE_ATTR(ifwi_version, S_IRUSR, sys_version_show, NULL);
static KOBJ_FW_UPDATE_ATTR(chaabi_version, S_IRUSR, sys_version_show, NULL);
static KOBJ_FW_UPDATE_ATTR(mia_version, S_IRUSR, sys_version_show, NULL);
static KOBJ_FW_UPDATE_ATTR(scu_bs_version, S_IRUSR, sys_version_show, NULL);
static KOBJ_FW_UPDATE_ATTR(scu_version, S_IRUSR, sys_version_show, NULL);
static KOBJ_FW_UPDATE_ATTR(punit_version, S_IRUSR, sys_version_show, NULL);
static KOBJ_FW_UPDATE_ATTR(ia32fw_version, S_IRUSR, sys_version_show, NULL);
static KOBJ_FW_UPDATE_ATTR(supp_ia32fw_version, S_IRUSR, sys_version_show, NULL);
static KOBJ_FW_UPDATE_ATTR(valhooks_version, S_IRUSR, sys_version_show, NULL);
static KOBJ_FW_UPDATE_ATTR(ucode_version, S_IRUSR, sys_version_show, NULL);

static KOBJ_FW_UPDATE_ATTR(last_error, S_IRUSR, last_error_show, NULL);
static KOBJ_FW_UPDATE_ATTR(pmic_nvm_version, S_IRUSR, pmic_nvm_version_show, NULL);
static BIN_ATTR(dnx, S_IWUSR, DNX_MAX_SIZE, NULL, write_dnx);
static BIN_ATTR(ifwi, S_IWUSR, IFWI_MAX_SIZE, NULL, write_ifwi);

static struct attribute *fw_update_attrs[] = {
	&cancel_update_attr.attr,
	&fw_version_attr.attr,
	&ifwi_version_attr.attr,
	&chaabi_version_attr.attr,
	&mia_version_attr.attr,
	&scu_bs_version_attr.attr,
	&scu_version_attr.attr,
	&punit_version_attr.attr,
	&ia32fw_version_attr.attr,
	&supp_ia32fw_version_attr.attr,
	&valhooks_version_attr.attr,
	&ucode_version_attr.attr,
	&pmic_nvm_version_attr.attr,
	&last_error_attr.attr,
	NULL,
};

static struct attribute_group fw_update_attr_group = {
	.name = "fw_info",
	.attrs = fw_update_attrs,
};

static int intel_fw_update_sysfs_create(struct kobject *kobj)
{
	int ret;

	ret = sysfs_create_group(kobj, &fw_update_attr_group);
	if (ret) {
		dev_err(fui.dev, "Unable to export sysfs interface\n");
		goto out;
	}

	ret = sysfs_create_bin_file(kobj, &bin_attr_dnx);
	if (ret) {
		dev_err(fui.dev, "Unable to create dnx bin file\n");
		goto err_dnx_bin;
	}

	ret = sysfs_create_bin_file(kobj, &bin_attr_ifwi);
	if (ret) {
		dev_err(fui.dev, "Unable to create ifwi bin file\n");
		goto err_ifwi_bin;
	}

	return 0;

err_ifwi_bin:
	sysfs_remove_bin_file(kobj, &bin_attr_dnx);
err_dnx_bin:
	sysfs_remove_group(kobj, &fw_update_attr_group);
out:
	return ret;
}

static void intel_fw_update_sysfs_remove(struct kobject *kobj)
{
	sysfs_remove_bin_file(kobj, &bin_attr_ifwi);
	sysfs_remove_bin_file(kobj, &bin_attr_dnx);
	sysfs_remove_group(kobj, &fw_update_attr_group);
}

static int fw_update_rpmsg_probe(struct rpmsg_channel *rpdev)
{
	int ret;
	struct fw_update_info *fu_info = &fui;

	if (rpdev == NULL) {
		pr_err("fw_update rpmsg channel not created\n");
		ret = -ENODEV;
		goto out;
	}

	dev_info(&rpdev->dev, "Probed fw_update rpmsg device\n");

	/* Allocate rpmsg instance for fw_update*/
	ret = alloc_rpmsg_instance(rpdev, &fw_update_instance);
	if (!fw_update_instance) {
		dev_err(&rpdev->dev, "kzalloc fw_update instance failed\n");
		goto out;
	}
	/* Initialize rpmsg instance */
	init_rpmsg_instance(fw_update_instance);

	fu_info->dev = &rpdev->dev;

	fui.fwud_pending = kzalloc(sizeof(struct fw_ud), GFP_KERNEL);
	if (NULL == fui.fwud_pending) {
		ret = -ENOMEM;
		dev_err(fui.dev, "alloc fwud_pending memory failed\n");
		goto err_fwud_pending;
	}

	scu_fw_update_kobj = kobject_create_and_add("fw_update", kernel_kobj);
	if (!scu_fw_update_kobj) {
		ret = -ENOMEM;
		dev_err(fui.dev, "create kobject failed\n");
		goto err_kobj;
	}

	ret = intel_fw_update_sysfs_create(scu_fw_update_kobj);
	if (ret) {
		dev_err(fui.dev, "creating fw update sysfs failed\n");
		goto err_free_fwud;
	}

	dev_info(&rpdev->dev, "Getting current fw version\n");
	ret = fw_version_info();
	if (ret) {
		dev_err(fui.dev, "cannot get current fw version\n");
		goto err_sysfs;
	}

	/* If alloc_fota_mem_early flag is set, allocate FOTA_MEM_SIZE
	 * bytes memory.
	 * reserve the first contiguous IFWI_MAX_SIZE bytes for IFWI,
	 * the next contiguous DNX_MAX_SIZE bytes are reserved for DNX,
	 * the last DNX_HDR_LEN bytes for DNX Header
	 */
	if (alloc_fota_mem_early) {
		pending_data = vmalloc(FOTA_MEM_SIZE);
		if (NULL == pending_data) {
			ret = -ENOMEM;
			dev_err(fui.dev, "early alloc fota memory failed\n");
			goto err_sysfs;
		}
	}

	return 0;

err_sysfs:
	intel_fw_update_sysfs_remove(scu_fw_update_kobj);
err_free_fwud:
	kobject_put(scu_fw_update_kobj);
err_kobj:
	kfree(fui.fwud_pending);
	fui.fwud_pending = NULL;
err_fwud_pending:
	free_rpmsg_instance(rpdev, &fw_update_instance);
out:
	return ret;
}

static void fw_update_rpmsg_remove(struct rpmsg_channel *rpdev)
{
	free_rpmsg_instance(rpdev, &fw_update_instance);
	intel_fw_update_sysfs_remove(scu_fw_update_kobj);
	kobject_put(scu_fw_update_kobj);

	vfree(pending_data);
	pending_data = NULL;
	kfree(fui.fwud_pending);
	fui.fwud_pending = NULL;
}

static void fw_update_rpmsg_cb(struct rpmsg_channel *rpdev, void *data,
					int len, void *priv, u32 src)
{
	dev_warn(&rpdev->dev, "unexpected, message\n");

	print_hex_dump(KERN_DEBUG, __func__, DUMP_PREFIX_NONE, 16, 1,
		       data, len,  true);
}

static struct rpmsg_device_id fw_update_rpmsg_id_table[] = {
	{ .name	= "rpmsg_fw_update" },
	{ },
};
MODULE_DEVICE_TABLE(rpmsg, fw_update_rpmsg_id_table);

static struct rpmsg_driver fw_update_rpmsg = {
	.drv.name	= KBUILD_MODNAME,
	.drv.owner	= THIS_MODULE,
	.id_table	= fw_update_rpmsg_id_table,
	.probe		= fw_update_rpmsg_probe,
	.callback	= fw_update_rpmsg_cb,
	.remove		= fw_update_rpmsg_remove,
};

static int __init fw_update_module_init(void)
{
	return register_rpmsg_driver(&fw_update_rpmsg);
}

static void __exit fw_update_module_exit(void)
{
	unregister_rpmsg_driver(&fw_update_rpmsg);
}

module_init(fw_update_module_init);
module_exit(fw_update_module_exit);

MODULE_AUTHOR("Sreedhara DS <sreedhara.ds@intel.com>");
MODULE_AUTHOR("Ning Li <ning.li@intel.com>");
MODULE_DESCRIPTION("Intel SCU Firmware Update Driver");
MODULE_LICENSE("GPL v2");