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
|
/**
*******************************************
* @file w25q_mem.c
* @author Dmitriy Semenov / Crazy_Geeks
* @version 0.1b
* @date 12-August-2021
* @brief Source file for W25Qxxx lib
* @note https://github.com/Crazy-Geeks/STM32-W25Q-QSPI
*******************************************
*
* @note https://ru.mouser.com/datasheet/2/949/w25q256jv_spi_revg_08032017-1489574.pdf
* @note https://www.st.com/resource/en/application_note/DM00227538-.pdf
*/
/**
* @addtogroup W25Q_Driver
* @{
*/
#include "w25q_mem.h"
/**
* @addtogroup W25Q_Exp Exported types
* @brief External fields and data
* @{
*/
extern QSPI_HandleTypeDef hqspi; ///< Quad SPI HAL Instance
/// @}
/**
* @addtogroup W25Q_PrivFi Private fields
* @brief Private variables and defines
* @{
*/
#define w25q_delay(x) HAL_Delay(x) ///< Delay define to provide future support of RTOS
W25Q_STATUS_REG w25q_status; ///< Internal status structure instance
/// @}
/**
* @addtogroup W25Q_PrivFu Private Methods
* @brief Internal lib's functions
* @{
*/
W25Q_STATE W25Q_WriteEnable(bool enable); ///< Toggle WOL bit
W25Q_STATE W25Q_EnableQSPI(bool enable); ///< Toggle QE bit
W25Q_STATE W25Q_Enter4ByteMode(bool enable); ///< Toggle ADS bit
W25Q_STATE W25Q_SetExtendedAddr(u8_t Addr); ///< Set addr in 3-byte mode
W25Q_STATE W25Q_GetExtendedAddr(u8_t *outAddr); ///< Get addr in 3-byte mode
static inline u32_t page_to_addr(u32_t pageNum, u8_t pageShift); ///< Translate page addr to byte addr
/// @}
/**
* @addtogroup W25Q_Pub Public methods
* @brief Public Methods
* @{
*/
/**
* @addtogroup W25Q_Init Init methods
* @brief Initalization
* @{
*/
/**
* @brief W25Q Init function
*
* @param none
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_Init(void) {
W25Q_STATE state; // temp status variable
// read id
u8_t id = 0;
state = W25Q_ReadID(&id);
if (state != W25Q_OK)
return state;
// u can check id here
// read chip's state to private lib's struct
state = W25Q_ReadStatusStruct(NULL);
if (state != W25Q_OK)
return state;
#if MEM_FLASH_SIZE > 128 // if 4-byte mode
/* If power-default 4-byte
mode disabled */
if (!w25q_status.ADP) {
u8_t buf_reg = 0;
state = W25Q_ReadStatusReg(&buf_reg, 3);
if (state != W25Q_OK)
return state;
buf_reg |= 0b10; // set ADP bit
state = W25Q_WriteStatusReg(buf_reg, 3);
if (state != W25Q_OK)
return state;
}
/* If current 4-byte
mode disabled */
if (!w25q_status.ADS) {
state = W25Q_Enter4ByteMode(1);
if (state != W25Q_OK)
return state;
}
#endif
/* If Quad-SPI mode disabled */
if (!w25q_status.QE) {
u8_t buf_reg = 0;
state = W25Q_ReadStatusReg(&buf_reg, 2);
if (state != W25Q_OK)
return state;
buf_reg |= 0b10;
state = W25Q_WriteStatusReg(buf_reg, 2);
if (state != W25Q_OK)
return state;
}
// make another read
state = W25Q_ReadStatusStruct(NULL);
// return communication status
return state;
}
/**
* @}
* @addtogroup W25Q_Reg Register Functions
* @brief Operations with Status Registers
* @{
*/
/**
* @brief W25Q Enable Volatile SR
* Makes status register volatile (temporary)
*
* @attention Func in development
* @param none
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_EnableVolatileSR(void) {
return W25Q_PARAM_ERR;
}
/**
* @brief W25Q Read Status Register
* Read one status register
*
* @param[out] reg_data 1 byte
* @param[in] reg_num Desired register 1..3
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadStatusReg(u8_t *reg_data, u8_t reg_num) {
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
if (reg_num == 1)
com.Instruction = W25Q_READ_SR1;
else if (reg_num == 2)
com.Instruction = W25Q_READ_SR2;
else if (reg_num == 3)
com.Instruction = W25Q_READ_SR3;
else
return W25Q_PARAM_ERR;
com.AddressMode = QSPI_ADDRESS_NONE;
com.AddressSize = QSPI_ADDRESS_NONE;
com.Address = 0x0U;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_1_LINE;
com.NbData = 1;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK) {
return W25Q_SPI_ERR;
}
if (HAL_QSPI_Receive(&hqspi, reg_data, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK) {
return W25Q_SPI_ERR;
}
return W25Q_OK;
}
/**
* @brief W25Q Write Status Register
* Write one status register
*
* @param[in] reg_data 1 byte
* @param[in] reg_num Desired register 1..3
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_WriteStatusReg(u8_t reg_data, u8_t reg_num) {
while (W25Q_IsBusy() == W25Q_BUSY)
w25q_delay(1);
W25Q_STATE state = W25Q_WriteEnable(1);
if (state != W25Q_OK)
return state;
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
if (reg_num == 1)
com.Instruction = W25Q_WRITE_SR1;
else if (reg_num == 2)
com.Instruction = W25Q_WRITE_SR2;
else if (reg_num == 3)
com.Instruction = W25Q_WRITE_SR3;
else
return W25Q_PARAM_ERR;
com.AddressMode = QSPI_ADDRESS_NONE;
com.AddressSize = QSPI_ADDRESS_NONE;
com.Address = 0x0U;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_1_LINE;
com.NbData = 1;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK) {
return W25Q_SPI_ERR;
}
if (HAL_QSPI_Transmit(&hqspi, ®_data, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK) {
return W25Q_SPI_ERR;
}
return W25Q_OK;
}
/**
* @brief W25Q Read Status Registers
* Read all status registers to struct
*
* @param[out] status W25Q_STATUS_REG Pointer
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadStatusStruct(W25Q_STATUS_REG *status) {
// buffer enum-variable
W25Q_STATE state;
// buffer register variables
u8_t SRs[3] = { 0, };
// first portion
state = W25Q_ReadStatusReg(&SRs[0], 1);
if (state != W25Q_OK)
return state;
// second portion
state = W25Q_ReadStatusReg(&SRs[1], 2);
if (state != W25Q_OK)
return state;
// third portion
state = W25Q_ReadStatusReg(&SRs[2], 3);
if (state != W25Q_OK)
return state;
if(status){
status->BUSY = w25q_status.BUSY = SRs[0] & 0b1;
status->WEL = w25q_status.WEL = (SRs[0] >> 1) & 0b1;
status->QE = w25q_status.QE = (SRs[1] >> 1) & 0b1;
status->SUS = w25q_status.SUS = (SRs[1] >> 7) & 0b1;
status->ADS = w25q_status.ADS = SRs[2] & 0b1;
status->ADP = w25q_status.ADP = (SRs[2] >> 1) & 0b1;
status->SLEEP = w25q_status.SLEEP; // возможно нужно вынести в начало (тестить)
}
return state;
}
/**
* @brief W25Q Check Busy flag
* Fast checking Busy flag
*
* @param none
* @return W25Q_STATE enum (W25Q_OK / W25Q_BUSY)
*/
W25Q_STATE W25Q_IsBusy(void) {
W25Q_STATE state;
u8_t sr = 0;
state = W25Q_ReadStatusReg(&sr, 1);
if (state != W25Q_OK)
return state;
w25q_status.BUSY = sr & 0b1;
return w25q_status.BUSY ? W25Q_BUSY : W25Q_OK;
}
/**
* @}
* @addtogroup W25Q_Read Read Functions
* @brief Read operations - single data type variables or raw 8-bit blocks
* @{
*/
/**
* @brief W25Q Read single Signed Byte
* Read signed 8-bit byte variable
*
* @param[out] buf Data to be read (single)
* @param[in] pageShift Byte shift inside page (0..255)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadSByte(i8_t *buf, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
u8_t data;
W25Q_STATE state = W25Q_ReadRaw(&data, 1, rawAddr);
if (state != W25Q_OK)
return state;
memcpy(buf, &data, 1);
return W25Q_OK;
}
/**
* @brief W25Q Read single Unsigned Byte
* Read unsigned 8-bit byte variable
*
* @param[out] buf Data to be read (single)
* @param[in] pageShift Byte shift inside page (0..255)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadByte(u8_t *buf, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
u8_t data;
W25Q_STATE state = W25Q_ReadRaw(&data, 1, rawAddr);
if (state != W25Q_OK)
return state;
buf[0] = data;
return W25Q_OK;
}
/**
* @brief W25Q Read single Signed Word
* Read signed 16-bit word variable
*
* @param[out] buf Data to be read (single)
* @param[in] pageShift Byte shift inside page (0..254)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadSWord(i16_t *buf, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT || pageShift > 256 - 2)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
u8_t data[2];
W25Q_STATE state = W25Q_ReadRaw(data, 2, rawAddr);
if (state != W25Q_OK)
return state;
memcpy(buf, data, 2);
return W25Q_OK;
}
/**
* @brief W25Q Read single Unsigned Word
* Read unsigned 16-bit word variable
*
* @param[out] buf Data to be read (single)
* @param[in] pageShift Byte shift inside page (0..254)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadWord(u16_t *buf, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT || pageShift > 256 - 2)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
u8_t data[2];
W25Q_STATE state = W25Q_ReadRaw(data, 2, rawAddr);
if (state != W25Q_OK)
return state;
memcpy(buf, data, 2);
return W25Q_OK;
}
/**
* @brief W25Q Read single Signed Long
* Read signed 32-bit long variable
*
* @param[out] buf Data to be read (single)
* @param[in] pageShift Byte shift inside page (0..252)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadSLong(i32_t *buf, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT || pageShift > 256 - 4)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
u8_t data[4];
W25Q_STATE state = W25Q_ReadRaw(data, 4, rawAddr);
if (state != W25Q_OK)
return state;
memcpy(buf, data, 4);
return W25Q_OK;
}
/**
* @brief W25Q Read single Signed Long
* Read signed 32-bit long variable
*
* @param[out] buf Data to be read (single)
* @param[in] pageShift Byte shift inside page (0..252)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadLong(u32_t *buf, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT || pageShift > 256 - 4)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
u8_t data[4];
W25Q_STATE state = W25Q_ReadRaw(data, 4, rawAddr);
if (state != W25Q_OK)
return state;
memcpy(buf, data, 4);
return W25Q_OK;
}
/**
* @brief W25Q Read any 8-bit data
* Read any 8-bit data from preffered page place
*
* @note Use memcpy to decode data
* @param[out] buf Pointer to data to be read (single or array)
* @param[in] len Length of data (1..256)
* @param[in] pageShift Byte shift inside page (0..256 - len)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadData(u8_t *buf, u16_t len, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT || len == 0 || len > 256 || pageShift > 256 - len)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
return W25Q_ReadRaw(buf, len, rawAddr);
}
/**
* @brief W25Q Read any 8-bit data from raw addr
* Read any 8-bit data from preffered chip address
*
* @note Address is in [byte] size
* @note Be carefull with page overrun
* @param[out] buf Pointer to data to be written (single or array)
* @param[in] data_len Length of data (1..256)
* @param[in] rawAddr Start address of chip's cell
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadRaw(u8_t *buf, u16_t data_len, u32_t rawAddr) {
if (data_len > 256 || data_len == 0)
return W25Q_PARAM_ERR;
while (W25Q_IsBusy() == W25Q_BUSY)
w25q_delay(1);
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
#if MEM_FLASH_SIZE > 128U
com.Instruction = W25Q_FAST_READ_QUAD_IO_4B; // Command
com.AddressSize = QSPI_ADDRESS_32_BITS;
#else
com.Instruction = W25Q_FAST_READ; // Command
com.AddressSize = QSPI_ADDRESS_24_BITS;
#endif
com.AddressMode = QSPI_ADDRESS_1_LINE;
com.Address = rawAddr;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 8;
com.DataMode = QSPI_DATA_1_LINE;
com.NbData = data_len;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK)
return W25Q_SPI_ERR;
if (HAL_QSPI_Receive(&hqspi, buf, HAL_QSPI_TIMEOUT_DEFAULT_VALUE) != HAL_OK)
return W25Q_SPI_ERR;
return W25Q_OK;
}
/**
* @brief W25Q Read any 8-bit data from raw addr
* Read any 8-bit data from preffered chip address by SINGLE SPI
*
* @note Works only with SINGLE SPI Line
* @param[out] buf Pointer to data array
* @param[in] len Length of array
* @param[in] Addr Address to data
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_SingleRead(u8_t *buf, u32_t len, u32_t Addr) {
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
#if MEM_FLASH_SIZE > 128U
com.Instruction = W25Q_READ_DATA_4B; // Command
com.AddressSize = QSPI_ADDRESS_32_BITS;
#else
com.Instruction = W25Q_READ_DATA; // Command
com.AddressSize = QSPI_ADDRESS_24_BITS;
#endif
com.AddressMode = QSPI_ADDRESS_1_LINE;
com.Address = Addr;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_1_LINE;
com.NbData = len;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK)
return W25Q_SPI_ERR;
if (HAL_QSPI_Receive(&hqspi, buf, HAL_QSPI_TIMEOUT_DEFAULT_VALUE) != HAL_OK)
return W25Q_SPI_ERR;
return W25Q_OK;
}
/**
* @}
* @addtogroup W25Q_Write Write functions
* @brief Program/write operations - single data type variables or raw 8-bit blocks
* @{
*/
/**
* @brief W25Q Burst Wrap settings
*
* @attention Func in development
*
* @param[in] WrapSize Wrap size: 8/16/32/64 / 0 - disable
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_SetBurstWrap(u8_t WrapSize) {
return W25Q_PARAM_ERR;
}
/**
* @brief W25Q Program single Signed Byte
* Program signed 8-bit byte variable
*
* @param[in] buf Data to be written (single)
* @param[in] pageShift Byte shift inside page (0..255)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ProgramSByte(i8_t buf, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
u8_t data;
memcpy(&data, &buf, 1);
return W25Q_ProgramRaw(&data, 1, rawAddr);
}
/**
* @brief W25Q Program single Unsigned Byte
* Program unsigned 8-bit byte vairable
*
* @param[in] buf Data to be written (single)
* @param[in] pageShift Byte shift inside page (0..255)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ProgramByte(u8_t buf, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
u8_t data;
memcpy(&data, &buf, 1);
return W25Q_ProgramRaw(&data, 1, rawAddr);
}
/**
* @brief W25Q Program single Signed Word
* Program signed 16-bit word vairable
*
* @param[in] buf Data to be written (single)
* @param[in] pageShift Byte shift inside page (0..254)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ProgramSWord(i16_t buf, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT || pageShift > 256 - 2)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
u8_t data[2];
memcpy(data, &buf, 2);
return W25Q_ProgramRaw(data, 2, rawAddr);
}
/**
* @brief W25Q Program single Unsigned Word
* Program unsigned 16-bit word vairable
*
* @param[in] buf Data to be written (single)
* @param[in] pageShift Byte shift inside page (0..254)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ProgramWord(u16_t buf, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT || pageShift > 256 - 2)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
u8_t data[2];
memcpy(data, &buf, 2);
return W25Q_ProgramRaw(data, 2, rawAddr);
}
/**
* @brief W25Q Program single Signed Long
* Program signed 32-bit long vairable
*
* @param[in] buf Data to be written (single)
* @param[in] pageShift Byte shift inside page (0..252)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ProgramSLong(i32_t buf, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT || pageShift > 256 - 4)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
u8_t data[4];
memcpy(data, &buf, 4);
return W25Q_ProgramRaw(data, 4, rawAddr);
}
/**
* @brief W25Q Program single Unigned Long
* Program unsigned 32-bit long vairable
*
* @param[in] buf Data to be written (single)
* @param[in] pageShift Byte shift inside page (0..252)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ProgramLong(u32_t buf, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT || pageShift > 256 - 4)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
u8_t data[4];
memcpy(data, &buf, 4);
return W25Q_ProgramRaw(data, 4, rawAddr);
}
/**
* @brief W25Q Program any 8-bit data
* Program any 8-bit data to preffered page place
*
* @note Use memcpy to prepare data
* @param[in] buf Pointer to data to be written (single or array)
* @param[in] len Length of data (1..256)
* @param[in] pageShift Byte shift inside page (0..256 - len)
* @param[in] pageNum Page number (0..PAGE_COUNT-1)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ProgramData(u8_t *buf, u16_t len, u8_t pageShift, u32_t pageNum) {
if (pageNum >= PAGE_COUNT || len == 0 || len > 256 || pageShift > 256 - len)
return W25Q_PARAM_ERR;
u32_t rawAddr = page_to_addr(pageNum, pageShift);
return W25Q_ProgramRaw(buf, len, rawAddr);
}
/**
* @brief W25Q Program any 8-bit data to raw addr
* Program any 8-bit data to preffered chip address
*
* @note Address is in [byte] size
* @note Be carefull with page overrun
* @param[in] buf Pointer to data to be written (single or array)
* @param[in] data_len Length of data (1..256)
* @param[in] rawAddr Start address of chip's cell
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ProgramRaw(u8_t *buf, u16_t data_len, u32_t rawAddr) {
if (data_len > 256 || data_len == 0)
return W25Q_PARAM_ERR;
while (W25Q_IsBusy() == W25Q_BUSY)
w25q_delay(1);
W25Q_STATE state = W25Q_WriteEnable(1);
if (state != W25Q_OK)
return state;
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
#if MEM_FLASH_SIZE > 128U
com.Instruction = W25Q_PAGE_PROGRAM_QUAD_INP_4B; // Command
com.AddressSize = QSPI_ADDRESS_32_BITS;
#else
com.Instruction = W25Q_PAGE_PROGRAM; // Command
com.AddressSize = QSPI_ADDRESS_24_BITS;
#endif
com.AddressMode = QSPI_ADDRESS_1_LINE;
com.Address = rawAddr;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_1_LINE;
com.NbData = data_len;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK)
return W25Q_SPI_ERR;
if (HAL_QSPI_Transmit(&hqspi, buf, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK)
return W25Q_SPI_ERR;
while (W25Q_IsBusy() == W25Q_BUSY)
w25q_delay(1);
return W25Q_OK;
}
/**
* @}
* @addtogroup W25Q_Erase Erase functions
* @brief Erase sector, blocks or whole chip
* @{
*/
/**
* @brief W25Q Sector erase (4KB)
* Minimal size operation to erase data
*
* @note Should be executed before writing
* @param[in] SectAddr Sector start address
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_EraseSector(u32_t SectAddr) {
if (SectAddr >= SECTOR_COUNT)
return W25Q_PARAM_ERR;
while (W25Q_IsBusy() == W25Q_BUSY)
w25q_delay(1);
u32_t rawAddr = SectAddr * MEM_SECTOR_SIZE * 1024U;
W25Q_STATE state = W25Q_WriteEnable(1);
if (state != W25Q_OK)
return state;
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
#if MEM_FLASH_SIZE > 128U
com.Instruction = W25Q_SECTOR_ERASE_4B; // Command
com.AddressSize = QSPI_ADDRESS_32_BITS;
#else
com.Instruction = W25Q_SECTOR_ERASE; // Command
com.AddressSize = QSPI_ADDRESS_24_BITS;
#endif
com.AddressMode = QSPI_ADDRESS_1_LINE;
com.Address = rawAddr;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_NONE;
com.NbData = 0;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK)
return W25Q_SPI_ERR;
while (W25Q_IsBusy() == W25Q_BUSY)
w25q_delay(1);
return W25Q_OK;
}
/**
* @brief W25Q Block erase (32/64 KB)
* Func to erase big block
*
* @note Should be executed before writing
* @param[in] BlockAddr Block start address
* @param[in] size Size of block: 32KB or 64KB
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_EraseBlock(u32_t BlockAddr, u8_t size) {
if (size != 32 && size != 64)
return W25Q_PARAM_ERR;
if ((size == 64 && BlockAddr >= BLOCK_COUNT)
|| (size == 32 && BlockAddr >= BLOCK_COUNT * 2))
return W25Q_PARAM_ERR;
while (W25Q_IsBusy() == W25Q_BUSY)
w25q_delay(1);
u32_t rawAddr = BlockAddr * MEM_SECTOR_SIZE * 1024U * 16;
if (size == 32)
rawAddr /= 2;
W25Q_STATE state = W25Q_WriteEnable(1);
if (state != W25Q_OK)
return state;
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
if (size == 32) {
com.Instruction = W25Q_32KB_BLOCK_ERASE; // Command
#if MEM_FLASH_SIZE > 128U
com.AddressSize = QSPI_ADDRESS_32_BITS;
#else
com.AddressSize = QSPI_ADDRESS_24_BITS;
#endif
} else if (size == 64) {
#if MEM_FLASH_SIZE > 128U
com.Instruction = W25Q_64KB_BLOCK_ERASE_4B; // Command
com.AddressSize = QSPI_ADDRESS_32_BITS;
#else
com.Instruction = W25Q_64KB_BLOCK_ERASE; // Command
com.AddressSize = QSPI_ADDRESS_24_BITS;
#endif
}
com.AddressMode = QSPI_ADDRESS_1_LINE;
com.Address = rawAddr;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_NONE;
com.NbData = 0;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK)
return W25Q_SPI_ERR;
while (W25Q_IsBusy() == W25Q_BUSY)
w25q_delay(1);
return W25Q_OK;
}
/**
* @brief W25Q Chip erase
* Func to erase all the data on chip
*
* @note Should be executed before writing
* @param none
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_EraseChip(void) {
while (W25Q_IsBusy() == W25Q_BUSY)
w25q_delay(1);
W25Q_STATE state = W25Q_WriteEnable(1);
if (state != W25Q_OK)
return state;
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
com.Instruction = W25Q_CHIP_ERASE; // Command
com.AddressSize = QSPI_ADDRESS_NONE;
com.AddressMode = QSPI_ADDRESS_NONE;
com.Address = 0;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_NONE;
com.NbData = 0;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK)
return W25Q_SPI_ERR;
while (W25Q_IsBusy() == W25Q_BUSY)
w25q_delay(1);
return W25Q_OK;
}
/**
* @}
* @addtogroup W25Q_SUS Suspend functions
* @brief Pause/resume operations
* @{
*/
/**
* @brief W25Q Programm/Erase Suspend
* Pause programm or suspend operatiom
*
* @note SUS == 0 && BUSY == 1, otherwise ignored
* @note Power loose during suspend state may corrupt data
* @param none
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ProgSuspend(void) {
if (W25Q_BUSY != W25Q_IsBusy())
return W25Q_CHIP_IGNORE;
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
com.Instruction = W25Q_ERASEPROG_SUSPEND; // Command
com.AddressSize = QSPI_ADDRESS_NONE;
com.AddressMode = QSPI_ADDRESS_NONE;
com.Address = 0;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_NONE;
com.NbData = 0;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK)
return W25Q_SPI_ERR;
return W25Q_OK;
}
/**
* @brief W25Q Programm/Erase Resume
* Resume suspended state
*
* @note SUS == 1, otherwise ignored
* @param none
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ProgResume(void) {
W25Q_STATE state = W25Q_ReadStatusStruct(NULL);
if (state != W25Q_OK)
return state;
if (w25q_status.SUS != 1)
return W25Q_CHIP_IGNORE;
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
com.Instruction = W25Q_ERASEPROG_RESUME; // Command
com.AddressSize = QSPI_ADDRESS_NONE;
com.AddressMode = QSPI_ADDRESS_NONE;
com.Address = 0;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_NONE;
com.NbData = 0;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK)
return W25Q_SPI_ERR;
return W25Q_OK;
}
/**
* @}
* @addtogroup W25Q_Sleep Sleep functions
* @brief Баю-бай, ток засыпай
* @{
*/
/**
* @brief W25Q Sleep / Power Down
* Set chip to low-power state
*
* @note Use WakeUP or ReadID
* @param none
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_Sleep(void) {
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
com.Instruction = W25Q_POWERDOWN; // Command
com.AddressMode = QSPI_ADDRESS_NONE;
com.AddressSize = QSPI_ADDRESS_NONE;
com.Address = 0x0U;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_NONE;
com.NbData = 0;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK) {
return W25Q_SPI_ERR;
}
w25q_delay(1); // Give a little time to sleep
w25q_status.SLEEP = 1;
return W25Q_OK;
}
/**
* @brief W25Q WakeUP
* Wake UP function
*
* @param none
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_WakeUP(void) {
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
com.Instruction = W25Q_POWERUP; // Command
com.AddressMode = QSPI_ADDRESS_NONE;
com.AddressSize = QSPI_ADDRESS_NONE;
com.Address = 0x0U;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_NONE;
com.NbData = 0;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK) {
return W25Q_SPI_ERR;
}
w25q_delay(1); // Give a little time to wake
return W25Q_OK;
}
/**
* @}
* @addtogroup W25Q_ID ID functions
* @brief Who am I? Хто я?
* @{
*/
/**
* @brief W25Q Read ID
* Function for reading chip ID
*
* @param[out] buf Pointer to output data (1 byte)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadID(u8_t *buf) {
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
com.Instruction = W25Q_DEVID; // Command
com.AddressMode = QSPI_ADDRESS_1_LINE;
com.AddressSize = QSPI_ADDRESS_24_BITS;
com.Address = 0x0U;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_1_LINE;
com.NbData = 1;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK) {
return W25Q_SPI_ERR;
}
if (HAL_QSPI_Receive(&hqspi, buf, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK) {
return W25Q_SPI_ERR;
}
return W25Q_OK;
}
/**
* @brief W25Q Read chip Full ID
* Read Manufacturer ID + Device ID
*
* @attention Func in development
* @param[out] buf Pointer to data from ID register
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadFullID(u8_t *buf) {
return W25Q_PARAM_ERR;
}
/**
* @brief W25Q Read chip UID
* Read Unique ID
*
* @attention Func in development
* @param[out] buf Pointer to data from ID register
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadUID(u8_t *buf) {
return W25Q_PARAM_ERR;
}
/**
* @brief W25Q Read JEDEC ID
* Read ID by JEDEC standards
*
* @attention Func in development
* @param[out] buf Pointer to data from ID register
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadJEDECID(u8_t *buf) {
return W25Q_PARAM_ERR;
}
/**
* @brief W25Q Read SFDP Register
* Read device descriptor by SFDP standard
*
* @attention Func in development
* @param[out] buf Pointer to data from ID register
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadSFDPRegister(u8_t *buf) {
return W25Q_PARAM_ERR;
}
/**
* @}
* @addtogroup W25Q_Secure Security register functions
* @brief Shhh, security
* @{
*/
/**
* @brief W25Q Erase Security Registers
* Clean security registers (one or all)
*
* @attention Func in development
* @param[in] numReg Number of security register (1..3 / 0-all)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_EraseSecurityRegisters(u8_t numReg) {
return W25Q_PARAM_ERR;
}
/**
* @brief W25Q Program Security Register
* Write data to security reg
*
* @attention Func in development
* @param[in] buf Pointer to 8-bit data bufer
* @param[in] numReg Number of security register (1..3)
* @param[in] byteAddr Byte addr in register (0..255)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ProgSecurityRegisters(u8_t *buf, u8_t numReg, u8_t byteAddr) {
return W25Q_PARAM_ERR;
}
/**
* @brief W25Q Read Security Register
* Read data from security reg
*
* @attention Func in development
* @param[out] buf Pointer to 8-bit data bufer
* @param[in] numReg Number of security register (1..3)
* @param[in] byteAddr Byte addr in register (0..255)
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_ReadSecurityRegisters(u8_t *buf, u8_t numReg, u8_t byteAddr) {
return W25Q_PARAM_ERR;
}
/**
* @}
* @addtogroup W25Q_Protect Read-only protection functions
* @brief No writing! Protect block or whole chip
* @{
*/
/**
* @brief W25Q 4K Block lock
* Set read-only status to 4K block
*
* @attention Func in development
* @param[in] Addr Block address
* @param[in] enable 1-Enable/0-Disable
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_BlockReadOnly(u32_t Addr, bool enable) {
return W25Q_PARAM_ERR;
}
/**
* @brief W25Q 4K Block lock CHECK
* Check read-only status from 4K block
*
* @attention Func in development
* @param[out] state Block read-only status (1-locked/0-unlocked)
* @param[in] Addr Block address
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_BlockReadOnlyCheck(bool *state, u32_t Addr) {
return W25Q_PARAM_ERR;
}
/**
* @brief W25Q Global read-only lock
* Set read-only status to the whole chip
*
* @attention Func in development
* @param[in] enable 1-enable/0-disable
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_GlobalReadOnly(bool enable){
return W25Q_PARAM_ERR;
}
/**
* @}
* @addtogroup W25Q_RST Reset functions
* @brief Reboot the chip
* @{
*/
/**
* @brief W25Q Software Reset
* Reset by register (not by external GPIO pin)
*
* @param[in] force Enable/disable (0/1) force reset - wait for BUSY and SUSpend
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_SwReset(bool force) {
W25Q_STATE state; // temp status reg
state = W25Q_ReadStatusStruct(NULL); // read settings
if (state != W25Q_OK)
return state;
if (!force || w25q_status.BUSY || w25q_status.SUS) // if busy or suspend
return W25Q_CHIP_ERR;
if (force) {
while (W25Q_IsBusy() == W25Q_BUSY)
w25q_delay(1);
if (w25q_status.SUS)
W25Q_ProgResume();
}
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
com.Instruction = W25Q_ENABLE_RST; // Command
com.AddressMode = QSPI_ADDRESS_NONE;
com.AddressSize = QSPI_ADDRESS_NONE;
com.Address = 0x0U;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_NONE;
com.NbData = 0;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK) {
return W25Q_SPI_ERR;
}
w25q_delay(1); // Give a little time to prepare
com.Instruction = W25Q_RESET;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK) {
return W25Q_SPI_ERR;
}
w25q_delay(5); // Give a little time to reset
state = W25Q_Init();
return state;
}
/// @}
// addgroup{
/// @}
// Public {
/**
* @brief W25Q Toggle WEL bit
* Toggle write enable latch
*
* @param[in] enable 1-enable write/0-disable write
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_WriteEnable(bool enable) {
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
com.Instruction = enable ? W25Q_WRITE_ENABLE : W25Q_WRITE_DISABLE;
com.AddressMode = QSPI_ADDRESS_NONE;
com.AddressSize = QSPI_ADDRESS_NONE;
com.Address = 0x0U;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_NONE;
com.NbData = 0;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK) {
return W25Q_SPI_ERR;
}
w25q_delay(1); // Give a little time to sleep
w25q_status.WEL = 1;
return W25Q_OK;
}
/**
* @brief W25Q Toggle 4-byte mode
*
* @note Affects only ADS bit
* @param[in] enable 1-enable/0-disable
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_Enter4ByteMode(bool enable) {
while (W25Q_IsBusy() == W25Q_BUSY)
w25q_delay(1);
QSPI_CommandTypeDef com;
com.InstructionMode = QSPI_INSTRUCTION_1_LINE; // QSPI_INSTRUCTION_...
com.Instruction = enable ? W25Q_ENABLE_4B_MODE : W25Q_DISABLE_4B_MODE;
com.AddressMode = QSPI_ADDRESS_NONE;
com.AddressSize = QSPI_ADDRESS_NONE;
com.Address = 0x0U;
com.AlternateByteMode = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytes = QSPI_ALTERNATE_BYTES_NONE;
com.AlternateBytesSize = QSPI_ALTERNATE_BYTES_NONE;
com.DummyCycles = 0;
com.DataMode = QSPI_DATA_NONE;
com.NbData = 0;
com.DdrMode = QSPI_DDR_MODE_DISABLE;
//com.DdrHoldHalfCycle = QSPI_DDR_HHC_ANALOG_DELAY;
com.SIOOMode = QSPI_SIOO_INST_EVERY_CMD;
if (HAL_QSPI_Command(&hqspi, &com, HAL_QSPI_TIMEOUT_DEFAULT_VALUE)
!= HAL_OK) {
return W25Q_SPI_ERR;
}
w25q_delay(1); // Give a little time to set command
return W25Q_ReadStatusStruct(NULL);
}
/**
* @brief W25Q Set extended byte
* Extended byte in 3-byte mode
*
* @attention Func in development
* @param[in] Addr 4th byte of addr
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_SetExtendedAddr(u8_t Addr) {
return W25Q_PARAM_ERR;
}
/**
* @brief W25Q Get extended byte
* Read extended byte in 3-byte mode
*
* @attention Func in development
* @param[out] Addr 4th byte of addr
* @return W25Q_STATE enum
*/
W25Q_STATE W25Q_GetExtendedAddr(u8_t *outAddr) {
return W25Q_PARAM_ERR;
}
/**
* @brief Page to address
* Translate page to byte-address
*
* @param[in] pageNum Number of page
* @param[in] pageShift Byte to shift inside page
* @return byte-address
*/
u32_t page_to_addr(u32_t pageNum, u8_t pageShift) {
return pageNum * MEM_PAGE_SIZE + pageShift;
}
///@}
|