1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
|
/*****************************************************************************
(c) Cambridge Silicon Radio Limited 2012
All rights reserved and confidential information of CSR
Refer to LICENSE.txt included with this source for details
on the license terms.
*****************************************************************************/
/*
* ---------------------------------------------------------------------------
* FILE: csr_wifi_hip_card_sdio_mem.c
*
* PURPOSE: Implementation of the Card API for SDIO.
*
* ---------------------------------------------------------------------------
*/
#include "csr_wifi_hip_unifi.h"
#include "csr_wifi_hip_card.h"
#define SDIO_RETRIES 3
#define CSR_WIFI_HIP_SDIO_TRACE_DATA_LENGTH 16
#define retryable_sdio_error(_csrResult) (((_csrResult) == CSR_SDIO_RESULT_CRC_ERROR) || ((_csrResult) == CSR_SDIO_RESULT_TIMEOUT))
/*
* ---------------------------------------------------------------------------
* retrying_read8
* retrying_write8
*
* These functions provide the first level of retry for SDIO operations.
* If an SDIO command fails for reason of a response timeout or CRC
* error, it is retried immediately. If three attempts fail we report a
* failure.
* If the command failed for any other reason, the failure is reported
* immediately.
*
* Arguments:
* card Pointer to card structure.
* funcnum The SDIO function to access.
* Function 0 is the Card Configuration Register space,
* function 1/2 is the UniFi register space.
* addr Address to access
* pdata Pointer in which to return the value read.
* data Value to write.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* ---------------------------------------------------------------------------
*/
static CsrResult retrying_read8(card_t *card, s16 funcnum, u32 addr, u8 *pdata)
{
CsrSdioFunction *sdio = card->sdio_if;
CsrResult r = CSR_RESULT_SUCCESS;
s16 retries;
CsrResult csrResult = CSR_RESULT_SUCCESS;
retries = 0;
while (retries++ < SDIO_RETRIES)
{
if (funcnum == 0)
{
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
unifi_debug_log_to_buf("r0@%02X", addr);
#endif
csrResult = CsrSdioF0Read8(sdio, addr, pdata);
}
else
{
#ifdef CSR_WIFI_TRANSPORT_CSPI
unifi_error(card->ospriv,
"retrying_read_f0_8: F1 8-bit reads are not allowed.\n");
return CSR_RESULT_FAILURE;
#else
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
unifi_debug_log_to_buf("r@%02X", addr);
#endif
csrResult = CsrSdioRead8(sdio, addr, pdata);
#endif
}
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
if (csrResult != CSR_RESULT_SUCCESS)
{
unifi_debug_log_to_buf("error=%X\n", csrResult);
}
else
{
unifi_debug_log_to_buf("=%X\n", *pdata);
}
#endif
if (csrResult == CSR_SDIO_RESULT_NO_DEVICE)
{
return CSR_WIFI_HIP_RESULT_NO_DEVICE;
}
/*
* Try again for retryable (CRC or TIMEOUT) errors,
* break on success or fatal error
*/
if (!retryable_sdio_error(csrResult))
{
#ifdef CSR_WIFI_HIP_DATA_PLANE_PROFILE
card->cmd_prof.cmd52_count++;
#endif
break;
}
unifi_trace(card->ospriv, UDBG2, "retryable SDIO error reading F%d 0x%lX\n", funcnum, addr);
}
if ((csrResult == CSR_RESULT_SUCCESS) && (retries > 1))
{
unifi_warning(card->ospriv, "Read succeeded after %d attempts\n", retries);
}
if (csrResult != CSR_RESULT_SUCCESS)
{
unifi_error(card->ospriv, "Failed to read from UniFi (addr 0x%lX) after %d tries\n",
addr, retries - 1);
/* Report any SDIO error as a general i/o error */
r = CSR_RESULT_FAILURE;
}
return r;
} /* retrying_read8() */
static CsrResult retrying_write8(card_t *card, s16 funcnum, u32 addr, u8 data)
{
CsrSdioFunction *sdio = card->sdio_if;
CsrResult r = CSR_RESULT_SUCCESS;
s16 retries;
CsrResult csrResult = CSR_RESULT_SUCCESS;
retries = 0;
while (retries++ < SDIO_RETRIES)
{
if (funcnum == 0)
{
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
unifi_debug_log_to_buf("w0@%02X=%X", addr, data);
#endif
csrResult = CsrSdioF0Write8(sdio, addr, data);
}
else
{
#ifdef CSR_WIFI_TRANSPORT_CSPI
unifi_error(card->ospriv,
"retrying_write_f0_8: F1 8-bit writes are not allowed.\n");
return CSR_RESULT_FAILURE;
#else
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
unifi_debug_log_to_buf("w@%02X=%X", addr, data);
#endif
csrResult = CsrSdioWrite8(sdio, addr, data);
#endif
}
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
if (csrResult != CSR_RESULT_SUCCESS)
{
unifi_debug_log_to_buf(",error=%X", csrResult);
}
unifi_debug_string_to_buf("\n");
#endif
if (csrResult == CSR_SDIO_RESULT_NO_DEVICE)
{
return CSR_WIFI_HIP_RESULT_NO_DEVICE;
}
/*
* Try again for retryable (CRC or TIMEOUT) errors,
* break on success or fatal error
*/
if (!retryable_sdio_error(csrResult))
{
#ifdef CSR_WIFI_HIP_DATA_PLANE_PROFILE
card->cmd_prof.cmd52_count++;
#endif
break;
}
unifi_trace(card->ospriv, UDBG2, "retryable SDIO error writing %02X to F%d 0x%lX\n",
data, funcnum, addr);
}
if ((csrResult == CSR_RESULT_SUCCESS) && (retries > 1))
{
unifi_warning(card->ospriv, "Write succeeded after %d attempts\n", retries);
}
if (csrResult != CSR_RESULT_SUCCESS)
{
unifi_error(card->ospriv, "Failed to write to UniFi (addr 0x%lX) after %d tries\n",
addr, retries - 1);
/* Report any SDIO error as a general i/o error */
r = CSR_RESULT_FAILURE;
}
return r;
} /* retrying_write8() */
static CsrResult retrying_read16(card_t *card, s16 funcnum,
u32 addr, u16 *pdata)
{
CsrSdioFunction *sdio = card->sdio_if;
CsrResult r = CSR_RESULT_SUCCESS;
s16 retries;
CsrResult csrResult = CSR_RESULT_SUCCESS;
retries = 0;
while (retries++ < SDIO_RETRIES)
{
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
unifi_debug_log_to_buf("r@%02X", addr);
#endif
csrResult = CsrSdioRead16(sdio, addr, pdata);
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
if (csrResult != CSR_RESULT_SUCCESS)
{
unifi_debug_log_to_buf("error=%X\n", csrResult);
}
else
{
unifi_debug_log_to_buf("=%X\n", *pdata);
}
#endif
if (csrResult == CSR_SDIO_RESULT_NO_DEVICE)
{
return CSR_WIFI_HIP_RESULT_NO_DEVICE;
}
/*
* Try again for retryable (CRC or TIMEOUT) errors,
* break on success or fatal error
*/
if (!retryable_sdio_error(csrResult))
{
#ifdef CSR_WIFI_HIP_DATA_PLANE_PROFILE
card->cmd_prof.cmd52_count++;
#endif
break;
}
unifi_trace(card->ospriv, UDBG2, "retryable SDIO error reading F%d 0x%lX\n", funcnum, addr);
}
if ((csrResult == CSR_RESULT_SUCCESS) && (retries > 1))
{
unifi_warning(card->ospriv, "Read succeeded after %d attempts\n", retries);
}
if (csrResult != CSR_RESULT_SUCCESS)
{
unifi_error(card->ospriv, "Failed to read from UniFi (addr 0x%lX) after %d tries\n",
addr, retries - 1);
/* Report any SDIO error as a general i/o error */
r = CSR_RESULT_FAILURE;
}
return r;
} /* retrying_read16() */
static CsrResult retrying_write16(card_t *card, s16 funcnum,
u32 addr, u16 data)
{
CsrSdioFunction *sdio = card->sdio_if;
CsrResult r = CSR_RESULT_SUCCESS;
s16 retries;
CsrResult csrResult = CSR_RESULT_SUCCESS;
retries = 0;
while (retries++ < SDIO_RETRIES)
{
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
unifi_debug_log_to_buf("w@%02X=%X", addr, data);
#endif
csrResult = CsrSdioWrite16(sdio, addr, data);
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
if (csrResult != CSR_RESULT_SUCCESS)
{
unifi_debug_log_to_buf(",error=%X", csrResult);
}
unifi_debug_string_to_buf("\n");
#endif
if (csrResult == CSR_SDIO_RESULT_NO_DEVICE)
{
return CSR_WIFI_HIP_RESULT_NO_DEVICE;
}
/*
* Try again for retryable (CRC or TIMEOUT) errors,
* break on success or fatal error
*/
if (!retryable_sdio_error(csrResult))
{
#ifdef CSR_WIFI_HIP_DATA_PLANE_PROFILE
card->cmd_prof.cmd52_count++;
#endif
break;
}
unifi_trace(card->ospriv, UDBG2, "retryable SDIO error writing %02X to F%d 0x%lX\n",
data, funcnum, addr);
}
if ((csrResult == CSR_RESULT_SUCCESS) && (retries > 1))
{
unifi_warning(card->ospriv, "Write succeeded after %d attempts\n", retries);
}
if (csrResult != CSR_RESULT_SUCCESS)
{
unifi_error(card->ospriv, "Failed to write to UniFi (addr 0x%lX) after %d tries\n",
addr, retries - 1);
/* Report any SDIO error as a general i/o error */
r = CSR_RESULT_FAILURE;
}
return r;
} /* retrying_write16() */
/*
* ---------------------------------------------------------------------------
* sdio_read_f0
*
* Reads a byte value from the CCCR (func 0) area of UniFi.
*
* Arguments:
* card Pointer to card structure.
* addr Address to read from
* pdata Pointer in which to store the read value.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* ---------------------------------------------------------------------------
*/
CsrResult sdio_read_f0(card_t *card, u32 addr, u8 *pdata)
{
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_DATA_PLANE_PROFILE)
card->cmd_prof.cmd52_f0_r_count++;
#endif
return retrying_read8(card, 0, addr, pdata);
} /* sdio_read_f0() */
/*
* ---------------------------------------------------------------------------
* sdio_write_f0
*
* Writes a byte value to the CCCR (func 0) area of UniFi.
*
* Arguments:
* card Pointer to card structure.
* addr Address to read from
* data Data value to write.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* ---------------------------------------------------------------------------
*/
CsrResult sdio_write_f0(card_t *card, u32 addr, u8 data)
{
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_DATA_PLANE_PROFILE)
card->cmd_prof.cmd52_f0_w_count++;
#endif
return retrying_write8(card, 0, addr, data);
} /* sdio_write_f0() */
/*
* ---------------------------------------------------------------------------
* unifi_read_direct_8_or_16
*
* Read a 8-bit value from the UniFi SDIO interface.
*
* Arguments:
* card Pointer to card structure.
* addr Address to read from
* pdata Pointer in which to return data.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* ---------------------------------------------------------------------------
*/
CsrResult unifi_read_direct_8_or_16(card_t *card, u32 addr, u8 *pdata)
{
#ifdef CSR_WIFI_TRANSPORT_CSPI
u16 w;
CsrResult r;
r = retrying_read16(card, card->function, addr, &w);
*pdata = (u8)(w & 0xFF);
return r;
#else
return retrying_read8(card, card->function, addr, pdata);
#endif
} /* unifi_read_direct_8_or_16() */
/*
* ---------------------------------------------------------------------------
* unifi_write_direct_8_or_16
*
* Write a byte value to the UniFi SDIO interface.
*
* Arguments:
* card Pointer to card structure.
* addr Address to write to
* data Value to write.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error
*
* Notes:
* If 8-bit write is used, the even address *must* be written second.
* This is because writes to odd bytes are cached and not committed
* to memory until the preceding even address is written.
* ---------------------------------------------------------------------------
*/
CsrResult unifi_write_direct_8_or_16(card_t *card, u32 addr, u8 data)
{
if (addr & 1)
{
unifi_warning(card->ospriv,
"Warning: Byte write to an odd address (0x%lX) is dangerous\n",
addr);
}
#ifdef CSR_WIFI_TRANSPORT_CSPI
return retrying_write16(card, card->function, addr, (u16)data);
#else
return retrying_write8(card, card->function, addr, data);
#endif
} /* unifi_write_direct_8_or_16() */
/*
* ---------------------------------------------------------------------------
* unifi_read_direct16
*
* Read a 16-bit value from the UniFi SDIO interface.
*
* Arguments:
* card Pointer to card structure.
* addr Address to read from
* pdata Pointer in which to return data.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
*
* Notes:
* The even address *must* be read first. This is because reads from
* odd bytes are cached and read from memory when the preceding
* even address is read.
* ---------------------------------------------------------------------------
*/
CsrResult unifi_read_direct16(card_t *card, u32 addr, u16 *pdata)
{
return retrying_read16(card, card->function, addr, pdata);
} /* unifi_read_direct16() */
/*
* ---------------------------------------------------------------------------
* unifi_write_direct16
*
* Write a 16-bit value to the UniFi SDIO interface.
*
* Arguments:
* card Pointer to card structure.
* addr Address to write to
* data Value to write.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
*
* Notes:
* The even address *must* be written second. This is because writes to
* odd bytes are cached and not committed to memory until the preceding
* even address is written.
* ---------------------------------------------------------------------------
*/
CsrResult unifi_write_direct16(card_t *card, u32 addr, u16 data)
{
return retrying_write16(card, card->function, addr, data);
} /* unifi_write_direct16() */
/*
* ---------------------------------------------------------------------------
* unifi_read_direct32
*
* Read a 32-bit value from the UniFi SDIO interface.
*
* Arguments:
* card Pointer to card structure.
* addr Address to read from
* pdata Pointer in which to return data.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* ---------------------------------------------------------------------------
*/
CsrResult unifi_read_direct32(card_t *card, u32 addr, u32 *pdata)
{
CsrResult r;
u16 w0, w1;
r = retrying_read16(card, card->function, addr, &w0);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
r = retrying_read16(card, card->function, addr + 2, &w1);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
*pdata = ((u32)w1 << 16) | (u32)w0;
return CSR_RESULT_SUCCESS;
} /* unifi_read_direct32() */
/*
* ---------------------------------------------------------------------------
* unifi_read_directn_match
*
* Read multiple 8-bit values from the UniFi SDIO interface,
* stopping when either we have read 'len' bytes or we have read
* a octet equal to 'match'. If 'match' is not a valid octet
* then this function is the same as 'unifi_read_directn'.
*
* Arguments:
* card Pointer to card structure.
* addr Start address to read from.
* pdata Pointer to which to write data.
* len Maximum umber of bytes to read
* match The value to stop reading at.
* num Pointer to buffer to write number of bytes read
*
* Returns:
* number of octets read on success, negative error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
*
* Notes:
* The even address *must* be read first. This is because reads from
* odd bytes are cached and read from memory when the preceding
* even address is read.
* ---------------------------------------------------------------------------
*/
static CsrResult unifi_read_directn_match(card_t *card, u32 addr, void *pdata, u16 len, s8 m, u32 *num)
{
CsrResult r;
u32 i;
u8 *cptr;
u16 w;
*num = 0;
cptr = (u8 *)pdata;
for (i = 0; i < len; i += 2)
{
r = retrying_read16(card, card->function, addr, &w);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
*cptr++ = ((u8)w & 0xFF);
if ((m >= 0) && (((s8)w & 0xFF) == m))
{
break;
}
if (i + 1 == len)
{
/* The len is odd. Ignore the last high byte */
break;
}
*cptr++ = ((u8)(w >> 8) & 0xFF);
if ((m >= 0) && (((s8)(w >> 8) & 0xFF) == m))
{
break;
}
addr += 2;
}
*num = (CsrInt32)(cptr - (u8 *)pdata);
return CSR_RESULT_SUCCESS;
}
/*
* ---------------------------------------------------------------------------
* unifi_read_directn
*
* Read multiple 8-bit values from the UniFi SDIO interface.
*
* Arguments:
* card Pointer to card structure.
* addr Start address to read from.
* pdata Pointer to which to write data.
* len Number of bytes to read
*
* Returns:
* 0 on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
*
* Notes:
* The even address *must* be read first. This is because reads from
* odd bytes are cached and read from memory when the preceding
* even address is read.
* ---------------------------------------------------------------------------
*/
CsrResult unifi_read_directn(card_t *card, u32 addr, void *pdata, u16 len)
{
u32 num;
return unifi_read_directn_match(card, addr, pdata, len, -1, &num);
} /* unifi_read_directn() */
/*
* ---------------------------------------------------------------------------
* unifi_write_directn
*
* Write multiple 8-bit values to the UniFi SDIO interface.
*
* Arguments:
* card Pointer to card structure.
* addr Start address to write to.
* pdata Source data pointer.
* len Number of bytes to write, must be even.
*
* Returns:
* 0 on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
*
* Notes:
* The UniFi has a peculiar 16-bit bus architecture. Writes are only
* committed to memory when an even address is accessed. Writes to
* odd addresses are cached and only committed if the next write is
* to the preceding address.
* This means we must write data as pairs of bytes in reverse order.
* ---------------------------------------------------------------------------
*/
CsrResult unifi_write_directn(card_t *card, u32 addr, void *pdata, u16 len)
{
CsrResult r;
u8 *cptr;
s16 signed_len;
cptr = (u8 *)pdata;
signed_len = (s16)len;
while (signed_len > 0)
{
/* This is UniFi-1 specific code. CSPI not supported so 8-bit write allowed */
r = retrying_write16(card, card->function, addr, *cptr);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
cptr += 2;
addr += 2;
signed_len -= 2;
}
return CSR_RESULT_SUCCESS;
} /* unifi_write_directn() */
/*
* ---------------------------------------------------------------------------
* set_dmem_page
* set_pmem_page
*
* Set up the page register for the shared data memory window or program
* memory window.
*
* Arguments:
* card Pointer to card structure.
* dmem_addr UniFi shared-data-memory address to access.
* pmem_addr UniFi program memory address to access. This includes
* External FLASH memory at 0x000000
* Processor program memory at 0x200000
* External SRAM at memory 0x400000
* paddr Location to write an SDIO address (24-bit) for
* use in a unifi_read_direct or unifi_write_direct call.
*
* Returns:
* CSR_RESULT_SUCCESS on success
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* ---------------------------------------------------------------------------
*/
static CsrResult set_dmem_page(card_t *card, u32 dmem_addr, u32 *paddr)
{
u16 page, addr;
u32 len;
CsrResult r;
*paddr = 0;
if (!ChipHelper_DecodeWindow(card->helper,
CHIP_HELPER_WINDOW_3,
CHIP_HELPER_WT_SHARED,
dmem_addr / 2,
&page, &addr, &len))
{
unifi_error(card->ospriv, "Failed to decode SHARED_DMEM_PAGE %08lx\n", dmem_addr);
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
if (page != card->dmem_page)
{
unifi_trace(card->ospriv, UDBG6, "setting dmem page=0x%X, addr=0x%lX\n", page, addr);
/* change page register */
r = unifi_write_direct16(card, ChipHelper_HOST_WINDOW3_PAGE(card->helper) * 2, page);
if (r != CSR_RESULT_SUCCESS)
{
unifi_error(card->ospriv, "Failed to write SHARED_DMEM_PAGE\n");
return r;
}
card->dmem_page = page;
}
*paddr = ((CsrInt32)addr * 2) + (dmem_addr & 1);
return CSR_RESULT_SUCCESS;
} /* set_dmem_page() */
static CsrResult set_pmem_page(card_t *card, u32 pmem_addr,
enum chip_helper_window_type mem_type, u32 *paddr)
{
u16 page, addr;
u32 len;
CsrResult r;
*paddr = 0;
if (!ChipHelper_DecodeWindow(card->helper,
CHIP_HELPER_WINDOW_2,
mem_type,
pmem_addr / 2,
&page, &addr, &len))
{
unifi_error(card->ospriv, "Failed to decode PROG MEM PAGE %08lx %d\n", pmem_addr, mem_type);
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
if (page != card->pmem_page)
{
unifi_trace(card->ospriv, UDBG6, "setting pmem page=0x%X, addr=0x%lX\n", page, addr);
/* change page register */
r = unifi_write_direct16(card, ChipHelper_HOST_WINDOW2_PAGE(card->helper) * 2, page);
if (r != CSR_RESULT_SUCCESS)
{
unifi_error(card->ospriv, "Failed to write PROG MEM PAGE\n");
return r;
}
card->pmem_page = page;
}
*paddr = ((CsrInt32)addr * 2) + (pmem_addr & 1);
return CSR_RESULT_SUCCESS;
} /* set_pmem_page() */
/*
* ---------------------------------------------------------------------------
* set_page
*
* Sets up the appropriate page register to access the given address.
* Returns the sdio address at which the unifi address can be accessed.
*
* Arguments:
* card Pointer to card structure.
* generic_addr UniFi internal address to access, in Generic Pointer
* format, i.e. top byte is space indicator.
* paddr Location to write page address
* SDIO address (24-bit) for use in a unifi_read_direct or
* unifi_write_direct call
*
* Returns:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* CSR_WIFI_HIP_RESULT_INVALID_VALUE the address is invalid
* ---------------------------------------------------------------------------
*/
static CsrResult set_page(card_t *card, u32 generic_addr, u32 *paddr)
{
CsrInt32 space;
u32 addr;
CsrResult r = CSR_RESULT_SUCCESS;
if (!paddr)
{
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
*paddr = 0;
space = UNIFI_GP_SPACE(generic_addr);
addr = UNIFI_GP_OFFSET(generic_addr);
switch (space)
{
case UNIFI_SH_DMEM:
/* Shared Data Memory is accessed via the Shared Data Memory window */
r = set_dmem_page(card, addr, paddr);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
break;
case UNIFI_EXT_FLASH:
if (!ChipHelper_HasFlash(card->helper))
{
unifi_error(card->ospriv, "Bad address space for chip in generic pointer 0x%08lX (helper=0x%x)\n",
generic_addr, card->helper);
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
/* External FLASH is accessed via the Program Memory window */
r = set_pmem_page(card, addr, CHIP_HELPER_WT_FLASH, paddr);
break;
case UNIFI_EXT_SRAM:
if (!ChipHelper_HasExtSram(card->helper))
{
unifi_error(card->ospriv, "Bad address space for chip in generic pointer 0x%08l (helper=0x%x)\n",
generic_addr, card->helper);
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
/* External SRAM is accessed via the Program Memory window */
r = set_pmem_page(card, addr, CHIP_HELPER_WT_EXT_SRAM, paddr);
break;
case UNIFI_REGISTERS:
/* Registers are accessed directly */
*paddr = addr;
break;
case UNIFI_PHY_DMEM:
r = unifi_set_proc_select(card, UNIFI_PROC_PHY);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
*paddr = ChipHelper_DATA_MEMORY_RAM_OFFSET(card->helper) * 2 + addr;
break;
case UNIFI_MAC_DMEM:
r = unifi_set_proc_select(card, UNIFI_PROC_MAC);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
*paddr = ChipHelper_DATA_MEMORY_RAM_OFFSET(card->helper) * 2 + addr;
break;
case UNIFI_BT_DMEM:
if (!ChipHelper_HasBt(card->helper))
{
unifi_error(card->ospriv, "Bad address space for chip in generic pointer 0x%08lX (helper=0x%x)\n",
generic_addr, card->helper);
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
r = unifi_set_proc_select(card, UNIFI_PROC_BT);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
*paddr = ChipHelper_DATA_MEMORY_RAM_OFFSET(card->helper) * 2 + addr;
break;
case UNIFI_PHY_PMEM:
r = unifi_set_proc_select(card, UNIFI_PROC_PHY);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
r = set_pmem_page(card, addr, CHIP_HELPER_WT_CODE_RAM, paddr);
break;
case UNIFI_MAC_PMEM:
r = unifi_set_proc_select(card, UNIFI_PROC_MAC);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
r = set_pmem_page(card, addr, CHIP_HELPER_WT_CODE_RAM, paddr);
break;
case UNIFI_BT_PMEM:
if (!ChipHelper_HasBt(card->helper))
{
unifi_error(card->ospriv, "Bad address space for chip in generic pointer 0x%08lX (helper=0x%x)\n",
generic_addr, card->helper);
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
r = unifi_set_proc_select(card, UNIFI_PROC_BT);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
r = set_pmem_page(card, addr, CHIP_HELPER_WT_CODE_RAM, paddr);
break;
case UNIFI_PHY_ROM:
if (!ChipHelper_HasRom(card->helper))
{
unifi_error(card->ospriv, "Bad address space for chip in generic pointer 0x%08lX (helper=0x%x)\n",
generic_addr, card->helper);
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
r = unifi_set_proc_select(card, UNIFI_PROC_PHY);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
r = set_pmem_page(card, addr, CHIP_HELPER_WT_ROM, paddr);
break;
case UNIFI_MAC_ROM:
if (!ChipHelper_HasRom(card->helper))
{
unifi_error(card->ospriv, "Bad address space for chip in generic pointer 0x%08lX (helper=0x%x)\n",
generic_addr, card->helper);
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
r = unifi_set_proc_select(card, UNIFI_PROC_MAC);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
r = set_pmem_page(card, addr, CHIP_HELPER_WT_ROM, paddr);
break;
case UNIFI_BT_ROM:
if (!ChipHelper_HasRom(card->helper) || !ChipHelper_HasBt(card->helper))
{
unifi_error(card->ospriv, "Bad address space for chip in generic pointer 0x%08lX (helper=0x%x)\n",
generic_addr, card->helper);
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
r = unifi_set_proc_select(card, UNIFI_PROC_BT);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
r = set_pmem_page(card, addr, CHIP_HELPER_WT_ROM, paddr);
break;
default:
unifi_error(card->ospriv, "Bad address space %d in generic pointer 0x%08lX (helper=0x%x)\n",
space, generic_addr, card->helper);
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
return r;
} /* set_page() */
/*
* ---------------------------------------------------------------------------
* unifi_set_proc_select
*
*
* Arguments:
* card Pointer to card structure.
* select Which XAP core to select
*
* Returns:
* 0 on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* ---------------------------------------------------------------------------
*/
CsrResult unifi_set_proc_select(card_t *card, enum unifi_dbg_processors_select select)
{
CsrResult r;
/* Verify the the select value is allowed. */
switch (select)
{
case UNIFI_PROC_MAC:
case UNIFI_PROC_PHY:
case UNIFI_PROC_BOTH:
break;
default:
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
if (card->proc_select != (u32)select)
{
r = unifi_write_direct16(card,
ChipHelper_DBG_HOST_PROC_SELECT(card->helper) * 2,
(u8)select);
if (r == CSR_WIFI_HIP_RESULT_NO_DEVICE)
{
return r;
}
if (r != CSR_RESULT_SUCCESS)
{
unifi_error(card->ospriv, "Failed to write to Proc Select register\n");
return r;
}
card->proc_select = (u32)select;
}
return CSR_RESULT_SUCCESS;
}
/*
* ---------------------------------------------------------------------------
* unifi_read_8_or_16
*
* Performs a byte read of the given address in shared data memory.
* Set up the shared data memory page register as required.
*
* Arguments:
* card Pointer to card structure.
* unifi_addr UniFi shared-data-memory address to access.
* pdata Pointer to a byte variable for the value read.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* CSR_WIFI_HIP_RESULT_INVALID_VALUE a bad generic pointer was specified
* ---------------------------------------------------------------------------
*/
CsrResult unifi_read_8_or_16(card_t *card, u32 unifi_addr, u8 *pdata)
{
u32 sdio_addr;
CsrResult r;
#ifdef CSR_WIFI_TRANSPORT_CSPI
u16 w;
#endif
r = set_page(card, unifi_addr, &sdio_addr);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_DATA_PLANE_PROFILE)
card->cmd_prof.cmd52_r8or16_count++;
#endif
#ifdef CSR_WIFI_TRANSPORT_CSPI
r = retrying_read16(card, card->function, sdio_addr, &w);
*pdata = (u8)(w & 0xFF);
return r;
#else
return retrying_read8(card, card->function, sdio_addr, pdata);
#endif
} /* unifi_read_8_or_16() */
/*
* ---------------------------------------------------------------------------
* unifi_write_8_or_16
*
* Performs a byte write of the given address in shared data memory.
* Set up the shared data memory page register as required.
*
* Arguments:
* card Pointer to card context struct.
* unifi_addr UniFi shared-data-memory address to access.
* data Value to write.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* CSR_WIFI_HIP_RESULT_INVALID_VALUE a bad generic pointer was specified
*
* Notes:
* Beware using unifi_write8() because byte writes are not safe on UniFi.
* Writes to odd bytes are cached, writes to even bytes perform a 16-bit
* write with the previously cached odd byte.
* ---------------------------------------------------------------------------
*/
CsrResult unifi_write_8_or_16(card_t *card, u32 unifi_addr, u8 data)
{
u32 sdio_addr;
CsrResult r;
#ifdef CSR_WIFI_TRANSPORT_CSPI
u16 w;
#endif
r = set_page(card, unifi_addr, &sdio_addr);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
if (sdio_addr & 1)
{
unifi_warning(card->ospriv,
"Warning: Byte write to an odd address (0x%lX) is dangerous\n",
sdio_addr);
}
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_DATA_PLANE_PROFILE)
card->cmd_prof.cmd52_w8or16_count++;
#endif
#ifdef CSR_WIFI_TRANSPORT_CSPI
w = data;
return retrying_write16(card, card->function, sdio_addr, w);
#else
return retrying_write8(card, card->function, sdio_addr, data);
#endif
} /* unifi_write_8_or_16() */
/*
* ---------------------------------------------------------------------------
* unifi_card_read16
*
* Performs a 16-bit read of the given address in shared data memory.
* Set up the shared data memory page register as required.
*
* Arguments:
* card Pointer to card structure.
* unifi_addr UniFi shared-data-memory address to access.
* pdata Pointer to a 16-bit int variable for the value read.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* CSR_WIFI_HIP_RESULT_INVALID_VALUE a bad generic pointer was specified
* ---------------------------------------------------------------------------
*/
CsrResult unifi_card_read16(card_t *card, u32 unifi_addr, u16 *pdata)
{
u32 sdio_addr;
CsrResult r;
r = set_page(card, unifi_addr, &sdio_addr);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_DATA_PLANE_PROFILE)
card->cmd_prof.cmd52_r16_count++;
#endif
return unifi_read_direct16(card, sdio_addr, pdata);
} /* unifi_card_read16() */
/*
* ---------------------------------------------------------------------------
* unifi_card_write16
*
* Performs a 16-bit write of the given address in shared data memory.
* Set up the shared data memory page register as required.
*
* Arguments:
* card Pointer to card structure.
* unifi_addr UniFi shared-data-memory address to access.
* pdata Pointer to a byte variable for the value write.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* CSR_WIFI_HIP_RESULT_INVALID_VALUE a bad generic pointer was specified
* ---------------------------------------------------------------------------
*/
CsrResult unifi_card_write16(card_t *card, u32 unifi_addr, u16 data)
{
u32 sdio_addr;
CsrResult r;
r = set_page(card, unifi_addr, &sdio_addr);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_DATA_PLANE_PROFILE)
card->cmd_prof.cmd52_w16_count++;
#endif
return unifi_write_direct16(card, sdio_addr, data);
} /* unifi_card_write16() */
/*
* ---------------------------------------------------------------------------
* unifi_read32
*
* Performs a 32-bit read of the given address in shared data memory.
* Set up the shared data memory page register as required.
*
* Arguments:
* card Pointer to card structure.
* unifi_addr UniFi shared-data-memory address to access.
* pdata Pointer to a int variable for the value read.
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* CSR_WIFI_HIP_RESULT_INVALID_VALUE a bad generic pointer was specified
* ---------------------------------------------------------------------------
*/
CsrResult unifi_read32(card_t *card, u32 unifi_addr, u32 *pdata)
{
u32 sdio_addr;
CsrResult r;
r = set_page(card, unifi_addr, &sdio_addr);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_DATA_PLANE_PROFILE)
card->cmd_prof.cmd52_r32_count++;
#endif
return unifi_read_direct32(card, sdio_addr, pdata);
} /* unifi_read32() */
/*
* ---------------------------------------------------------------------------
* unifi_card_readn
* unifi_readnz
*
* Read multiple 8-bit values from the UniFi SDIO interface.
* This function interprets the address as a GenericPointer as
* defined in the UniFi Host Interface Protocol Specification.
* The readnz version of this function will stop when it reads a
* zero octet.
*
* Arguments:
* card Pointer to card structure.
* unifi_addr UniFi shared-data-memory address to access.
* pdata Pointer to which to write data.
* len Number of bytes to read
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* CSR_WIFI_HIP_RESULT_INVALID_VALUE a bad generic pointer was specified
* ---------------------------------------------------------------------------
*/
CsrResult unifi_readn_match(card_t *card, u32 unifi_addr, void *pdata, u16 len, s8 match)
{
u32 sdio_addr;
CsrResult r;
u32 num;
r = set_page(card, unifi_addr, &sdio_addr);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
r = unifi_read_directn_match(card, sdio_addr, pdata, len, match, &num);
return r;
} /* unifi_readn_match() */
CsrResult unifi_card_readn(card_t *card, u32 unifi_addr, void *pdata, u16 len)
{
return unifi_readn_match(card, unifi_addr, pdata, len, -1);
} /* unifi_card_readn() */
CsrResult unifi_readnz(card_t *card, u32 unifi_addr, void *pdata, u16 len)
{
return unifi_readn_match(card, unifi_addr, pdata, len, 0);
} /* unifi_readnz() */
/*
* ---------------------------------------------------------------------------
* unifi_read_shared_count
*
* Read signal count locations, checking for an SDIO error. The
* signal count locations only contain a valid number if the
* highest bit isn't set.
*
* Arguments:
* card Pointer to card context structure.
* addr Shared-memory address to read.
*
* Returns:
* Value read from memory (0-127) or -1 on error
* ---------------------------------------------------------------------------
*/
CsrInt32 unifi_read_shared_count(card_t *card, u32 addr)
{
u8 b;
/* I've increased this count, because I have seen cases where
* there were three reads in a row with the top bit set. I'm not
* sure why this might have happened, but I can't see a problem
* with increasing this limit. It's better to take a while to
* recover than to fail. */
#define SHARED_READ_RETRY_LIMIT 10
CsrInt32 i;
/*
* Get the to-host-signals-written count.
* The top-bit will be set if the firmware was in the process of
* changing the value, in which case we read again.
*/
/* Limit the number of repeats so we don't freeze */
for (i = 0; i < SHARED_READ_RETRY_LIMIT; i++)
{
CsrResult r;
r = unifi_read_8_or_16(card, addr, &b);
if (r != CSR_RESULT_SUCCESS)
{
return -1;
}
if (!(b & 0x80))
{
/* There is a chance that the MSB may have contained invalid data
* (overflow) at the time it was read. Therefore mask off the MSB.
* This avoids a race between driver read and firmware write of the
* word, the value we need is in the lower 8 bits anway.
*/
return (CsrInt32)(b & 0xff);
}
}
return -1; /* this function has changed in WMM mods */
} /* unifi_read_shared_count() */
/*
* ---------------------------------------------------------------------------
* unifi_writen
*
* Write multiple 8-bit values to the UniFi SDIO interface using CMD52
* This function interprets the address as a GenericPointer as
* defined in the UniFi Host Interface Protocol Specification.
*
* Arguments:
* card Pointer to card structure.
* unifi_addr UniFi shared-data-memory address to access.
* pdata Pointer to which to write data.
* len Number of bytes to write
*
* Returns:
* 0 on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
* CSR_WIFI_HIP_RESULT_INVALID_VALUE an odd length or length too big.
* ---------------------------------------------------------------------------
*/
CsrResult unifi_writen(card_t *card, u32 unifi_addr, void *pdata, u16 len)
{
u32 sdio_addr;
CsrResult r;
r = set_page(card, unifi_addr, &sdio_addr);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
return unifi_write_directn(card, sdio_addr, pdata, len);
} /* unifi_writen() */
static CsrResult csr_sdio_block_rw(card_t *card, s16 funcnum,
u32 addr, u8 *pdata,
u16 count, s16 dir_is_write)
{
CsrResult csrResult;
if (dir_is_write == UNIFI_SDIO_READ)
{
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
unifi_debug_log_to_buf("r@%02X#%X=", addr, count);
#endif
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_DATA_PLANE_PROFILE)
unifi_debug_log_to_buf("R");
#endif
csrResult = CsrSdioRead(card->sdio_if, addr, pdata, count);
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_DATA_PLANE_PROFILE)
unifi_debug_log_to_buf("<");
#endif
}
else
{
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
unifi_debug_log_to_buf("w@%02X#%X=", addr, count);
unifi_debug_hex_to_buf(pdata, count > CSR_WIFI_HIP_SDIO_TRACE_DATA_LENGTH?CSR_WIFI_HIP_SDIO_TRACE_DATA_LENGTH : count);
#endif
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_DATA_PLANE_PROFILE)
unifi_debug_log_to_buf("W");
#endif
csrResult = CsrSdioWrite(card->sdio_if, addr, pdata, count);
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_DATA_PLANE_PROFILE)
unifi_debug_log_to_buf(">");
#endif
}
#ifdef CSR_WIFI_HIP_DATA_PLANE_PROFILE
card->cmd_prof.cmd53_count++;
#endif
#if defined (CSR_WIFI_HIP_DEBUG_OFFLINE) && defined (CSR_WIFI_HIP_SDIO_TRACE)
if (csrResult != CSR_RESULT_SUCCESS)
{
unifi_debug_log_to_buf("error=%X", csrResult);
}
else if (dir_is_write == UNIFI_SDIO_READ)
{
unifi_debug_hex_to_buf(pdata, count > CSR_WIFI_HIP_SDIO_TRACE_DATA_LENGTH?CSR_WIFI_HIP_SDIO_TRACE_DATA_LENGTH : count);
}
unifi_debug_string_to_buf("\n");
#endif
return csrResult; /* CSR SDIO (not HIP) error code */
}
/*
* ---------------------------------------------------------------------------
* unifi_bulk_rw
*
* Transfer bulk data to or from the UniFi SDIO interface.
* This function is used to read or write signals and bulk data.
*
* Arguments:
* card Pointer to card structure.
* handle Value to put in the Register Address field of the CMD53 req.
* data Pointer to data to write.
* direction One of UNIFI_SDIO_READ or UNIFI_SDIO_WRITE
*
* Returns:
* CSR_RESULT_SUCCESS on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
*
* Notes:
* This function uses SDIO CMD53, which is the block transfer mode.
* ---------------------------------------------------------------------------
*/
CsrResult unifi_bulk_rw(card_t *card, u32 handle, void *pdata,
u32 len, s16 direction)
{
#define CMD53_RETRIES 3
/*
* Ideally instead of sleeping, we want to busy wait.
* Currently there is no framework API to do this. When it becomes available,
* we can use it to busy wait using usecs
*/
#define REWIND_RETRIES 15 /* when REWIND_DELAY==1msec, or 250 when REWIND_DELAY==50usecs */
#define REWIND_POLLING_RETRIES 5
#define REWIND_DELAY 1 /* msec or 50usecs */
CsrResult csrResult; /* SDIO error code */
CsrResult r = CSR_RESULT_SUCCESS; /* HIP error code */
s16 retries = CMD53_RETRIES;
s16 stat_retries;
u8 stat;
s16 dump_read;
#ifdef UNIFI_DEBUG
u8 *pdata_lsb = ((u8 *)&pdata) + card->lsb;
#endif
#ifdef CSR_WIFI_MAKE_FAKE_CMD53_ERRORS
static s16 fake_error;
#endif
dump_read = 0;
#ifdef UNIFI_DEBUG
if (*pdata_lsb & 1)
{
unifi_notice(card->ospriv, "CD53 request on a unaligned buffer (addr: 0x%X) dir %s-Host\n",
pdata, (direction == UNIFI_SDIO_READ)?"To" : "From");
if (direction == UNIFI_SDIO_WRITE)
{
dump(pdata, (u16)len);
}
else
{
dump_read = 1;
}
}
#endif
/* Defensive checks */
if (!pdata)
{
unifi_error(card->ospriv, "Null pdata for unifi_bulk_rw() len: %d\n", len);
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
if ((len & 1) || (len > 0xffff))
{
unifi_error(card->ospriv, "Impossible CMD53 length requested: %d\n", len);
return CSR_WIFI_HIP_RESULT_INVALID_VALUE;
}
while (1)
{
csrResult = csr_sdio_block_rw(card, card->function, handle,
(u8 *)pdata, (u16)len,
direction);
if (csrResult == CSR_SDIO_RESULT_NO_DEVICE)
{
return CSR_WIFI_HIP_RESULT_NO_DEVICE;
}
#ifdef CSR_WIFI_MAKE_FAKE_CMD53_ERRORS
if (++fake_error > 100)
{
fake_error = 90;
unifi_warning(card->ospriv, "Faking a CMD53 error,\n");
if (csrResult == CSR_RESULT_SUCCESS)
{
csrResult = CSR_RESULT_FAILURE;
}
}
#endif
if (csrResult == CSR_RESULT_SUCCESS)
{
if (dump_read)
{
dump(pdata, (u16)len);
}
break;
}
/*
* At this point the SDIO driver should have written the I/O Abort
* register to notify UniFi that the command has failed.
* UniFi-1 and UniFi-2 (not UF6xxx) use the same register to store the
* Deep Sleep State. This means we have to restore the Deep Sleep
* State (AWAKE in any case since we can not perform a CD53 in any other
* state) by rewriting the I/O Abort register to its previous value.
*/
if (card->chip_id <= SDIO_CARD_ID_UNIFI_2)
{
(void)unifi_set_host_state(card, UNIFI_HOST_STATE_AWAKE);
}
/* If csr_sdio_block_rw() failed in a non-retryable way, or retries exhausted
* then stop retrying
*/
if (!retryable_sdio_error(csrResult))
{
unifi_error(card->ospriv, "Fatal error in a CMD53 transfer\n");
break;
}
/*
* These happen from time to time, try again
*/
if (--retries == 0)
{
break;
}
unifi_trace(card->ospriv, UDBG4,
"Error in a CMD53 transfer, retrying (h:%d,l:%u)...\n",
(s16)handle & 0xff, len);
/* The transfer failed, rewind and try again */
r = unifi_write_8_or_16(card, card->sdio_ctrl_addr + 8,
(u8)(handle & 0xff));
if (r == CSR_WIFI_HIP_RESULT_NO_DEVICE)
{
return r;
}
if (r != CSR_RESULT_SUCCESS)
{
/*
* If we can't even do CMD52 (register read/write) then
* stop here.
*/
unifi_error(card->ospriv, "Failed to write REWIND cmd\n");
return r;
}
/* Signal the UniFi to look for the rewind request. */
r = CardGenInt(card);
if (r != CSR_RESULT_SUCCESS)
{
return r;
}
/* Wait for UniFi to acknowledge the rewind */
stat_retries = REWIND_RETRIES;
while (1)
{
r = unifi_read_8_or_16(card, card->sdio_ctrl_addr + 8, &stat);
if (r == CSR_WIFI_HIP_RESULT_NO_DEVICE)
{
return r;
}
if (r != CSR_RESULT_SUCCESS)
{
unifi_error(card->ospriv, "Failed to read REWIND status\n");
return CSR_RESULT_FAILURE;
}
if (stat == 0)
{
break;
}
if (--stat_retries == 0)
{
unifi_error(card->ospriv, "Timeout waiting for REWIND ready\n");
return CSR_RESULT_FAILURE;
}
/* Poll for the ack a few times */
if (stat_retries < REWIND_RETRIES - REWIND_POLLING_RETRIES)
{
CsrThreadSleep(REWIND_DELAY);
}
}
}
/* The call to csr_sdio_block_rw() still failed after retrying */
if (csrResult != CSR_RESULT_SUCCESS)
{
unifi_error(card->ospriv, "Block %s failed after %d retries\n",
(direction == UNIFI_SDIO_READ)?"read" : "write",
CMD53_RETRIES - retries);
/* Report any SDIO error as a general i/o error */
return CSR_RESULT_FAILURE;
}
/* Collect some stats */
if (direction == UNIFI_SDIO_READ)
{
card->sdio_bytes_read += len;
}
else
{
card->sdio_bytes_written += len;
}
return CSR_RESULT_SUCCESS;
} /* unifi_bulk_rw() */
/*
* ---------------------------------------------------------------------------
* unifi_bulk_rw_noretry
*
* Transfer bulk data to or from the UniFi SDIO interface.
* This function is used to read or write signals and bulk data.
*
* Arguments:
* card Pointer to card structure.
* handle Value to put in the Register Address field of
* the CMD53 req.
* data Pointer to data to write.
* direction One of UNIFI_SDIO_READ or UNIFI_SDIO_WRITE
*
* Returns:
* 0 on success, non-zero error code on error:
* CSR_WIFI_HIP_RESULT_NO_DEVICE card was ejected
* CSR_RESULT_FAILURE an SDIO error occurred
*
* Notes:
* This function uses SDIO CMD53, which is the block transfer mode.
* ---------------------------------------------------------------------------
*/
CsrResult unifi_bulk_rw_noretry(card_t *card, u32 handle, void *pdata,
u32 len, s16 direction)
{
CsrResult csrResult;
csrResult = csr_sdio_block_rw(card, card->function, handle,
(u8 *)pdata, (u16)len, direction);
if (csrResult != CSR_RESULT_SUCCESS)
{
unifi_error(card->ospriv, "Block %s failed\n",
(direction == UNIFI_SDIO_READ)?"read" : "write");
return csrResult;
}
return CSR_RESULT_SUCCESS;
} /* unifi_bulk_rw_noretry() */
|