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
// SPDX-License-Identifier: GPL-2.0+
/*
 * AD7124 SPI ADC driver
 *
 * Copyright 2018 Analog Devices Inc.
 * Copyright 2025 BayLibre, SAS
 */
#include <linux/bitfield.h>
#include <linux/bitops.h>
#include <linux/cleanup.h>
#include <linux/clk.h>
#include <linux/clk-provider.h>
#include <linux/debugfs.h>
#include <linux/delay.h>
#include <linux/device.h>
#include <linux/err.h>
#include <linux/interrupt.h>
#include <linux/kernel.h>
#include <linux/kfifo.h>
#include <linux/minmax.h>
#include <linux/module.h>
#include <linux/property.h>
#include <linux/regulator/consumer.h>
#include <linux/spi/spi.h>
#include <linux/sprintf.h>
#include <linux/units.h>

#include <linux/iio/iio.h>
#include <linux/iio/adc/ad_sigma_delta.h>
#include <linux/iio/sysfs.h>

/* AD7124 registers */
#define AD7124_COMMS			0x00
#define AD7124_STATUS			0x00
#define AD7124_ADC_CONTROL		0x01
#define AD7124_DATA			0x02
#define AD7124_IO_CONTROL_1		0x03
#define AD7124_IO_CONTROL_2		0x04
#define AD7124_ID			0x05
#define AD7124_ERROR			0x06
#define AD7124_ERROR_EN			0x07
#define AD7124_MCLK_COUNT		0x08
#define AD7124_CHANNEL(x)		(0x09 + (x))
#define AD7124_CONFIG(x)		(0x19 + (x))
#define AD7124_FILTER(x)		(0x21 + (x))
#define AD7124_OFFSET(x)		(0x29 + (x))
#define AD7124_GAIN(x)			(0x31 + (x))

/* AD7124_STATUS */
#define AD7124_STATUS_POR_FLAG			BIT(4)

/* AD7124_ADC_CONTROL */
#define AD7124_ADC_CONTROL_CLK_SEL		GENMASK(1, 0)
#define AD7124_ADC_CONTROL_CLK_SEL_INT			0
#define AD7124_ADC_CONTROL_CLK_SEL_INT_OUT		1
#define AD7124_ADC_CONTROL_CLK_SEL_EXT			2
#define AD7124_ADC_CONTROL_CLK_SEL_EXT_DIV4		3
#define AD7124_ADC_CONTROL_MODE			GENMASK(5, 2)
#define AD7124_ADC_CONTROL_MODE_CONTINUOUS		0
#define AD7124_ADC_CONTROL_MODE_SINGLE			1
#define AD7124_ADC_CONTROL_MODE_STANDBY			2
#define AD7124_ADC_CONTROL_MODE_POWERDOWN		3
#define AD7124_ADC_CONTROL_MODE_IDLE			4
#define AD7124_ADC_CONTROL_MODE_INT_OFFSET_CALIB	5 /* Internal Zero-Scale Calibration */
#define AD7124_ADC_CONTROL_MODE_INT_GAIN_CALIB		6 /* Internal Full-Scale Calibration */
#define AD7124_ADC_CONTROL_MODE_SYS_OFFSET_CALIB	7 /* System Zero-Scale Calibration */
#define AD7124_ADC_CONTROL_MODE_SYS_GAIN_CALIB		8 /* System Full-Scale Calibration */
#define AD7124_ADC_CONTROL_POWER_MODE		GENMASK(7, 6)
#define AD7124_ADC_CONTROL_POWER_MODE_LOW		0
#define AD7124_ADC_CONTROL_POWER_MODE_MID		1
#define AD7124_ADC_CONTROL_POWER_MODE_FULL		2
#define AD7124_ADC_CONTROL_REF_EN		BIT(8)
#define AD7124_ADC_CONTROL_DATA_STATUS		BIT(10)

/* AD7124_ID */
#define AD7124_ID_SILICON_REVISION		GENMASK(3, 0)
#define AD7124_ID_DEVICE_ID			GENMASK(7, 4)
#define AD7124_ID_DEVICE_ID_AD7124_4			0x0
#define AD7124_ID_DEVICE_ID_AD7124_8			0x1

/* AD7124_CHANNEL_X */
#define AD7124_CHANNEL_ENABLE		BIT(15)
#define AD7124_CHANNEL_SETUP		GENMASK(14, 12)
#define AD7124_CHANNEL_AINP		GENMASK(9, 5)
#define AD7124_CHANNEL_AINM		GENMASK(4, 0)
#define AD7124_CHANNEL_AINx_TEMPSENSOR		16
#define AD7124_CHANNEL_AINx_AVSS		17

/* AD7124_CONFIG_X */
#define AD7124_CONFIG_BIPOLAR		BIT(11)
#define AD7124_CONFIG_IN_BUFF		GENMASK(6, 5)
#define AD7124_CONFIG_AIN_BUFP		BIT(6)
#define AD7124_CONFIG_AIN_BUFM		BIT(5)
#define AD7124_CONFIG_REF_SEL		GENMASK(4, 3)
#define AD7124_CONFIG_PGA		GENMASK(2, 0)

/* AD7124_FILTER_X */
#define AD7124_FILTER_FILTER		GENMASK(23, 21)
#define AD7124_FILTER_FILTER_SINC4		0
#define AD7124_FILTER_FILTER_SINC3		2
#define AD7124_FILTER_FILTER_SINC4_SINC1	4
#define AD7124_FILTER_FILTER_SINC3_SINC1	5
#define AD7124_FILTER_FILTER_SINC3_PF		7
#define AD7124_FILTER_REJ60		BIT(20)
#define AD7124_FILTER_POST_FILTER	GENMASK(19, 17)
#define AD7124_FILTER_POST_FILTER_47dB		2
#define AD7124_FILTER_POST_FILTER_62dB		3
#define AD7124_FILTER_POST_FILTER_86dB		5
#define AD7124_FILTER_POST_FILTER_92dB		6
#define AD7124_FILTER_SINGLE_CYCLE	BIT(16)
#define AD7124_FILTER_FS		GENMASK(10, 0)

#define AD7124_CFG_SLOT_UNASSIGNED	~0U

#define AD7124_MAX_CONFIGS	8
#define AD7124_MAX_CHANNELS	16

#define AD7124_INT_CLK_HZ	614400

/* AD7124 input sources */

enum ad7124_ref_sel {
	AD7124_REFIN1,
	AD7124_REFIN2,
	AD7124_INT_REF,
	AD7124_AVDD_REF,
};

enum ad7124_power_mode {
	AD7124_LOW_POWER,
	AD7124_MID_POWER,
	AD7124_FULL_POWER,
};

static const unsigned int ad7124_gain[8] = {
	1, 2, 4, 8, 16, 32, 64, 128
};

static const unsigned int ad7124_reg_size[] = {
	1, 2, 3, 3, 2, 1, 3, 3, 1, 2, 2, 2, 2,
	2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
	2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3,
	3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3,
	3, 3, 3, 3, 3
};

static const int ad7124_master_clk_freq_hz[3] = {
	[AD7124_LOW_POWER] = AD7124_INT_CLK_HZ / 8,
	[AD7124_MID_POWER] = AD7124_INT_CLK_HZ / 4,
	[AD7124_FULL_POWER] = AD7124_INT_CLK_HZ,
};

static const char * const ad7124_ref_names[] = {
	[AD7124_REFIN1] = "refin1",
	[AD7124_REFIN2] = "refin2",
	[AD7124_INT_REF] = "int",
	[AD7124_AVDD_REF] = "avdd",
};

struct ad7124_chip_info {
	const char *name;
	unsigned int chip_id;
	unsigned int num_inputs;
};

enum ad7124_filter_type {
	AD7124_FILTER_TYPE_SINC3,
	AD7124_FILTER_TYPE_SINC3_PF1,
	AD7124_FILTER_TYPE_SINC3_PF2,
	AD7124_FILTER_TYPE_SINC3_PF3,
	AD7124_FILTER_TYPE_SINC3_PF4,
	AD7124_FILTER_TYPE_SINC3_REJ60,
	AD7124_FILTER_TYPE_SINC3_SINC1,
	AD7124_FILTER_TYPE_SINC4,
	AD7124_FILTER_TYPE_SINC4_REJ60,
	AD7124_FILTER_TYPE_SINC4_SINC1,
};

struct ad7124_channel_config {
	unsigned int cfg_slot;
	unsigned int requested_odr;
	unsigned int requested_odr_micro;
	/*
	 * Following fields are used to compare for equality. If you
	 * make adaptations in it, you most likely also have to adapt
	 * ad7124_config_equal(), too.
	 */
	struct_group(config_props,
		enum ad7124_ref_sel refsel;
		bool bipolar;
		bool buf_positive;
		bool buf_negative;
		unsigned int vref_mv;
		unsigned int pga_bits;
		unsigned int odr_sel_bits;
		enum ad7124_filter_type filter_type;
		unsigned int calibration_offset;
		unsigned int calibration_gain;
	);
};

struct ad7124_channel {
	struct ad7124_channel_config cfg;
	unsigned int ain;
	unsigned int slot;
	u8 syscalib_mode;
};

struct ad7124_state {
	const struct ad7124_chip_info *chip_info;
	struct ad_sigma_delta sd;
	struct ad7124_channel *channels;
	struct regulator *vref[4];
	u32 clk_hz;
	unsigned int adc_control;
	unsigned int num_channels;
	struct mutex cfgs_lock; /* lock for configs access */
	u8 cfg_slot_use_count[AD7124_MAX_CONFIGS];

	/*
	 * Stores the power-on reset value for the GAIN(x) registers which are
	 * needed for measurements at gain 1 (i.e. CONFIG(x).PGA == 0)
	 */
	unsigned int gain_default;
	bool enable_single_cycle;
};

static const struct ad7124_chip_info ad7124_4_chip_info = {
	.name = "ad7124-4",
	.chip_id = AD7124_ID_DEVICE_ID_AD7124_4,
	.num_inputs = 8,
};

static const struct ad7124_chip_info ad7124_8_chip_info = {
	.name = "ad7124-8",
	.chip_id = AD7124_ID_DEVICE_ID_AD7124_8,
	.num_inputs = 16,
};

static int ad7124_find_closest_match(const int *array,
				     unsigned int size, int val)
{
	int i, idx;
	unsigned int diff_new, diff_old;

	diff_old = U32_MAX;
	idx = 0;

	for (i = 0; i < size; i++) {
		diff_new = abs(val - array[i]);
		if (diff_new < diff_old) {
			diff_old = diff_new;
			idx = i;
		}
	}

	return idx;
}

static int ad7124_spi_write_mask(struct ad7124_state *st,
				 unsigned int addr,
				 unsigned long mask,
				 unsigned int val,
				 unsigned int bytes)
{
	unsigned int readval;
	int ret;

	ret = ad_sd_read_reg(&st->sd, addr, bytes, &readval);
	if (ret < 0)
		return ret;

	readval &= ~mask;
	readval |= val;

	return ad_sd_write_reg(&st->sd, addr, bytes, readval);
}

static int ad7124_set_mode(struct ad_sigma_delta *sd,
			   enum ad_sigma_delta_mode mode)
{
	struct ad7124_state *st = container_of(sd, struct ad7124_state, sd);

	st->adc_control &= ~AD7124_ADC_CONTROL_MODE;
	st->adc_control |= FIELD_PREP(AD7124_ADC_CONTROL_MODE, mode);

	return ad_sd_write_reg(&st->sd, AD7124_ADC_CONTROL, 2, st->adc_control);
}

static u32 ad7124_get_fclk_hz(struct ad7124_state *st)
{
	enum ad7124_power_mode power_mode;
	u32 fclk_hz;

	power_mode = FIELD_GET(AD7124_ADC_CONTROL_POWER_MODE, st->adc_control);
	fclk_hz = st->clk_hz;

	switch (power_mode) {
	case AD7124_LOW_POWER:
		fclk_hz /= 8;
		break;
	case AD7124_MID_POWER:
		fclk_hz /= 4;
		break;
	default:
		break;
	}

	return fclk_hz;
}

static u32 ad7124_get_fs_factor(struct ad7124_state *st, unsigned int channel)
{
	enum ad7124_power_mode power_mode =
		FIELD_GET(AD7124_ADC_CONTROL_POWER_MODE, st->adc_control);
	u32 avg = power_mode == AD7124_LOW_POWER ? 8 : 16;

	/*
	 * These are the "zero-latency" factors from the data sheet. For the
	 * sinc1 filters, these aren't documented, but derived by taking the
	 * single-channel formula from the sinc1 section of the data sheet and
	 * multiplying that by the sinc3/4 factor from the corresponding zero-
	 * latency sections.
	 */
	switch (st->channels[channel].cfg.filter_type) {
	case AD7124_FILTER_TYPE_SINC4:
	case AD7124_FILTER_TYPE_SINC4_REJ60:
		return 4 * 32;
	case AD7124_FILTER_TYPE_SINC4_SINC1:
		return 4 * avg * 32;
	case AD7124_FILTER_TYPE_SINC3_SINC1:
		return 3 * avg * 32;
	default:
		return 3 * 32;
	}
}

static u32 ad7124_get_fadc_divisor(struct ad7124_state *st, unsigned int channel)
{
	u32 factor = ad7124_get_fs_factor(st, channel);

	/*
	 * The output data rate (f_ADC) is f_CLK / divisor. We are returning
	 * the divisor.
	 */
	return st->channels[channel].cfg.odr_sel_bits * factor;
}

static void ad7124_set_channel_odr(struct ad7124_state *st, unsigned int channel)
{
	struct ad7124_channel_config *cfg = &st->channels[channel].cfg;
	unsigned int fclk, factor, divisor, odr_sel_bits;

	fclk = ad7124_get_fclk_hz(st);
	factor = ad7124_get_fs_factor(st, channel);

	/*
	 * FS[10:0] = fCLK / (fADC x 32 * N) where:
	 * fADC is the output data rate
	 * fCLK is the master clock frequency
	 * N is number of conversions per sample (depends on filter type)
	 * FS[10:0] are the bits in the filter register
	 * FS[10:0] can have a value from 1 to 2047
	 */
	divisor = cfg->requested_odr * factor +
		  cfg->requested_odr_micro * factor / MICRO;
	odr_sel_bits = clamp(DIV_ROUND_CLOSEST(fclk, divisor), 1, 2047);

	st->channels[channel].cfg.odr_sel_bits = odr_sel_bits;
}

static int ad7124_get_3db_filter_factor(struct ad7124_state *st,
					unsigned int channel)
{
	struct ad7124_channel_config *cfg = &st->channels[channel].cfg;

	/*
	 * 3dB point is the f_CLK rate times some factor. This functions returns
	 * the factor times 1000.
	 */
	switch (cfg->filter_type) {
	case AD7124_FILTER_TYPE_SINC3:
	case AD7124_FILTER_TYPE_SINC3_REJ60:
	case AD7124_FILTER_TYPE_SINC3_SINC1:
		return 272;
	case AD7124_FILTER_TYPE_SINC4:
	case AD7124_FILTER_TYPE_SINC4_REJ60:
	case AD7124_FILTER_TYPE_SINC4_SINC1:
		return 230;
	case AD7124_FILTER_TYPE_SINC3_PF1:
		return 633;
	case AD7124_FILTER_TYPE_SINC3_PF2:
		return 605;
	case AD7124_FILTER_TYPE_SINC3_PF3:
		return 669;
	case AD7124_FILTER_TYPE_SINC3_PF4:
		return 759;
	default:
		return -EINVAL;
	}
}

/* Only called during probe, so dev_err_probe() can be used */
static int ad7124_init_config_vref(struct ad7124_state *st, struct ad7124_channel_config *cfg)
{
	struct device *dev = &st->sd.spi->dev;
	unsigned int refsel = cfg->refsel;

	switch (refsel) {
	case AD7124_REFIN1:
	case AD7124_REFIN2:
	case AD7124_AVDD_REF:
		if (IS_ERR(st->vref[refsel]))
			return dev_err_probe(dev, PTR_ERR(st->vref[refsel]),
					     "Error, trying to use external voltage reference without a %s regulator.\n",
					     ad7124_ref_names[refsel]);

		cfg->vref_mv = regulator_get_voltage(st->vref[refsel]);
		/* Conversion from uV to mV */
		cfg->vref_mv /= 1000;
		return 0;
	case AD7124_INT_REF:
		cfg->vref_mv = 2500;
		st->adc_control |= AD7124_ADC_CONTROL_REF_EN;
		return 0;
	default:
		return dev_err_probe(dev, -EINVAL, "Invalid reference %d\n", refsel);
	}
}

static bool ad7124_config_equal(struct ad7124_channel_config *a,
				struct ad7124_channel_config *b)
{
	return a->refsel == b->refsel &&
	       a->bipolar == b->bipolar &&
	       a->buf_positive == b->buf_positive &&
	       a->buf_negative == b->buf_negative &&
	       a->vref_mv == b->vref_mv &&
	       a->pga_bits == b->pga_bits &&
	       a->odr_sel_bits == b->odr_sel_bits &&
	       a->filter_type == b->filter_type &&
	       a->calibration_offset == b->calibration_offset &&
	       a->calibration_gain == b->calibration_gain;
}

static int ad7124_write_config(struct ad7124_state *st, struct ad7124_channel_config *cfg,
			       unsigned int cfg_slot)
{
	unsigned int val, filter;
	unsigned int rej60 = 0;
	unsigned int post = 0;
	int ret;

	ret = ad_sd_write_reg(&st->sd, AD7124_OFFSET(cfg_slot), 3,
			      cfg->calibration_offset);
	if (ret)
		return ret;

	ret = ad_sd_write_reg(&st->sd, AD7124_GAIN(cfg_slot), 3,
			      cfg->calibration_gain);
	if (ret)
		return ret;

	val = FIELD_PREP(AD7124_CONFIG_BIPOLAR, cfg->bipolar) |
		FIELD_PREP(AD7124_CONFIG_REF_SEL, cfg->refsel) |
		(cfg->buf_positive ? AD7124_CONFIG_AIN_BUFP : 0) |
		(cfg->buf_negative ? AD7124_CONFIG_AIN_BUFM : 0) |
		FIELD_PREP(AD7124_CONFIG_PGA, cfg->pga_bits);

	ret = ad_sd_write_reg(&st->sd, AD7124_CONFIG(cfg_slot), 2, val);
	if (ret < 0)
		return ret;

	switch (cfg->filter_type) {
	case AD7124_FILTER_TYPE_SINC3:
		filter = AD7124_FILTER_FILTER_SINC3;
		break;
	case AD7124_FILTER_TYPE_SINC3_PF1:
		filter = AD7124_FILTER_FILTER_SINC3_PF;
		post = AD7124_FILTER_POST_FILTER_47dB;
		break;
	case AD7124_FILTER_TYPE_SINC3_PF2:
		filter = AD7124_FILTER_FILTER_SINC3_PF;
		post = AD7124_FILTER_POST_FILTER_62dB;
		break;
	case AD7124_FILTER_TYPE_SINC3_PF3:
		filter = AD7124_FILTER_FILTER_SINC3_PF;
		post = AD7124_FILTER_POST_FILTER_86dB;
		break;
	case AD7124_FILTER_TYPE_SINC3_PF4:
		filter = AD7124_FILTER_FILTER_SINC3_PF;
		post = AD7124_FILTER_POST_FILTER_92dB;
		break;
	case AD7124_FILTER_TYPE_SINC3_REJ60:
		filter = AD7124_FILTER_FILTER_SINC3;
		rej60 = 1;
		break;
	case AD7124_FILTER_TYPE_SINC3_SINC1:
		filter = AD7124_FILTER_FILTER_SINC3_SINC1;
		break;
	case AD7124_FILTER_TYPE_SINC4:
		filter = AD7124_FILTER_FILTER_SINC4;
		break;
	case AD7124_FILTER_TYPE_SINC4_REJ60:
		filter = AD7124_FILTER_FILTER_SINC4;
		rej60 = 1;
		break;
	case AD7124_FILTER_TYPE_SINC4_SINC1:
		filter = AD7124_FILTER_FILTER_SINC4_SINC1;
		break;
	default:
		return -EINVAL;
	}

	/*
	 * NB: AD7124_FILTER_SINGLE_CYCLE is always set so that we get the same
	 * sampling frequency even when only one channel is enabled in a
	 * buffered read. If it was not set, the N in ad7124_set_channel_odr()
	 * would be 1 and we would get a faster sampling frequency than what
	 * was requested. It may only be disabled through debugfs for testing
	 * purposes.
	 */
	return ad_sd_write_reg(&st->sd, AD7124_FILTER(cfg_slot), 3,
			       FIELD_PREP(AD7124_FILTER_FILTER, filter) |
			       FIELD_PREP(AD7124_FILTER_REJ60, rej60) |
			       FIELD_PREP(AD7124_FILTER_POST_FILTER, post) |
			       FIELD_PREP(AD7124_FILTER_SINGLE_CYCLE,
					  st->enable_single_cycle) |
			       FIELD_PREP(AD7124_FILTER_FS, cfg->odr_sel_bits));
}

/**
 * ad7124_request_config_slot() - Request a config slot for a given config
 * @st:		Driver instance
 * @channel:	Channel to request a slot for
 *
 * Tries to find a matching config already in use, otherwise finds a free
 * slot. If this function returns successfully, the use count for the slot is
 * increased and the slot number is stored in cfg->cfg_slot.
 *
 * The slot must be released again with ad7124_release_config_slot() when no
 * longer needed.
 *
 * Returns: 0 if a slot was successfully assigned, -EUSERS if no slot is
 * available or other error if SPI communication fails.
 */
static int ad7124_request_config_slot(struct ad7124_state *st, u8 channel)
{
	unsigned int other, slot;
	int last_used_slot = -1;

	/* Find another channel with a matching config, if any. */
	for (other = 0; other < st->num_channels; other++) {
		if (other == channel)
			continue;

		if (st->channels[other].cfg.cfg_slot == AD7124_CFG_SLOT_UNASSIGNED)
			continue;

		last_used_slot = max_t(int, last_used_slot,
				       st->channels[other].cfg.cfg_slot);

		if (!ad7124_config_equal(&st->channels[other].cfg,
					 &st->channels[channel].cfg))
			continue;

		/* Found a match, re-use that slot. */
		slot = st->channels[other].cfg.cfg_slot;
		st->cfg_slot_use_count[slot]++;
		st->channels[channel].cfg.cfg_slot = slot;

		return 0;
	}

	/* No match, use next free slot. */
	slot = last_used_slot + 1;
	if (slot >= AD7124_MAX_CONFIGS)
		return -EUSERS;

	st->cfg_slot_use_count[slot]++;
	st->channels[channel].cfg.cfg_slot = slot;

	return ad7124_write_config(st, &st->channels[channel].cfg, slot);
}

static void ad7124_release_config_slot(struct ad7124_state *st, u8 channel)
{
	unsigned int slot;

	/*
	 * All of these early return conditions can happen at probe when all
	 * channels are disabled. Otherwise, they should not happen normally.
	 */
	if (channel >= st->num_channels)
		return;

	slot = st->channels[channel].cfg.cfg_slot;

	if (slot == AD7124_CFG_SLOT_UNASSIGNED ||
	    st->cfg_slot_use_count[slot] == 0)
		return;

	st->cfg_slot_use_count[slot]--;
	st->channels[channel].cfg.cfg_slot = AD7124_CFG_SLOT_UNASSIGNED;
}

static int ad7124_prepare_read(struct ad7124_state *st, int address)
{
	struct ad7124_channel_config *cfg = &st->channels[address].cfg;
	int ret;

	ret = ad7124_request_config_slot(st, address);
	if (ret)
		return ret;

	/* point channel to the config slot and enable */
	return ad_sd_write_reg(&st->sd, AD7124_CHANNEL(address), 2,
			       st->channels[address].ain |
			       FIELD_PREP(AD7124_CHANNEL_SETUP, cfg->cfg_slot) |
			       AD7124_CHANNEL_ENABLE);
}

static int ad7124_set_channel(struct ad_sigma_delta *sd, unsigned int channel)
{
	struct ad7124_state *st = container_of(sd, struct ad7124_state, sd);
	int ret;

	mutex_lock(&st->cfgs_lock);
	ret = ad7124_prepare_read(st, channel);
	mutex_unlock(&st->cfgs_lock);

	return ret;
}

static int ad7124_append_status(struct ad_sigma_delta *sd, bool append)
{
	struct ad7124_state *st = container_of(sd, struct ad7124_state, sd);
	unsigned int adc_control = st->adc_control;
	int ret;

	if (append)
		adc_control |= AD7124_ADC_CONTROL_DATA_STATUS;
	else
		adc_control &= ~AD7124_ADC_CONTROL_DATA_STATUS;

	ret = ad_sd_write_reg(&st->sd, AD7124_ADC_CONTROL, 2, adc_control);
	if (ret < 0)
		return ret;

	st->adc_control = adc_control;

	return 0;
}

static int ad7124_disable_one(struct ad_sigma_delta *sd, unsigned int chan)
{
	struct ad7124_state *st = container_of(sd, struct ad7124_state, sd);

	ad7124_release_config_slot(st, chan);

	/* The relevant thing here is that AD7124_CHANNEL_ENABLE is cleared. */
	return ad_sd_write_reg(&st->sd, AD7124_CHANNEL(chan), 2, 0);
}

static int ad7124_disable_all(struct ad_sigma_delta *sd)
{
	int ret;
	int i;

	for (i = 0; i < AD7124_MAX_CHANNELS; i++) {
		ret = ad7124_disable_one(sd, i);
		if (ret < 0)
			return ret;
	}

	return 0;
}

static const struct ad_sigma_delta_info ad7124_sigma_delta_info = {
	.set_channel = ad7124_set_channel,
	.append_status = ad7124_append_status,
	.disable_all = ad7124_disable_all,
	.disable_one = ad7124_disable_one,
	.set_mode = ad7124_set_mode,
	.has_registers = true,
	.addr_shift = 0,
	.read_mask = BIT(6),
	.status_ch_mask = GENMASK(3, 0),
	.data_reg = AD7124_DATA,
	.num_slots = 8,
	.irq_flags = IRQF_TRIGGER_FALLING,
	.num_resetclks = 64,
};

static const int ad7124_voltage_scales[][2] = {
	{ 0, 1164 },
	{ 0, 2328 },
	{ 0, 4656 },
	{ 0, 9313 },
	{ 0, 18626 },
	{ 0, 37252 },
	{ 0, 74505 },
	{ 0, 149011 },
	{ 0, 298023 },
};

static int ad7124_read_avail(struct iio_dev *indio_dev,
			     struct iio_chan_spec const *chan,
			     const int **vals, int *type, int *length, long info)
{
	switch (info) {
	case IIO_CHAN_INFO_SCALE:
		*vals = (const int *)ad7124_voltage_scales;
		*type = IIO_VAL_INT_PLUS_NANO;
		*length = ARRAY_SIZE(ad7124_voltage_scales) * 2;
		return IIO_AVAIL_LIST;
	default:
		return -EINVAL;
	}
}

static int ad7124_read_raw(struct iio_dev *indio_dev,
			   struct iio_chan_spec const *chan,
			   int *val, int *val2, long info)
{
	struct ad7124_state *st = iio_priv(indio_dev);
	int idx, ret;

	switch (info) {
	case IIO_CHAN_INFO_RAW:
		ret = ad_sigma_delta_single_conversion(indio_dev, chan, val);
		if (ret < 0)
			return ret;

		return IIO_VAL_INT;
	case IIO_CHAN_INFO_SCALE:
		switch (chan->type) {
		case IIO_VOLTAGE:
			mutex_lock(&st->cfgs_lock);

			idx = st->channels[chan->address].cfg.pga_bits;
			*val = st->channels[chan->address].cfg.vref_mv;
			if (st->channels[chan->address].cfg.bipolar)
				*val2 = chan->scan_type.realbits - 1 + idx;
			else
				*val2 = chan->scan_type.realbits + idx;

			mutex_unlock(&st->cfgs_lock);
			return IIO_VAL_FRACTIONAL_LOG2;

		case IIO_TEMP:
			/*
			 * According to the data sheet
			 *   Temperature (°C)
			 * = ((Conversion − 0x800000)/13584) − 272.5
			 * = (Conversion − 0x800000 - 13584 * 272.5) / 13584
			 * = (Conversion − 12090248) / 13584
			 * So scale with 1000/13584 to yield °mC. Reduce by 8 to
			 * 125/1698.
			 */
			*val = 125;
			*val2 = 1698;
			return IIO_VAL_FRACTIONAL;

		default:
			return -EINVAL;
		}

	case IIO_CHAN_INFO_OFFSET:
		switch (chan->type) {
		case IIO_VOLTAGE:
			mutex_lock(&st->cfgs_lock);
			if (st->channels[chan->address].cfg.bipolar)
				*val = -(1 << (chan->scan_type.realbits - 1));
			else
				*val = 0;

			mutex_unlock(&st->cfgs_lock);
			return IIO_VAL_INT;

		case IIO_TEMP:
			/* see calculation above */
			*val = -12090248;
			return IIO_VAL_INT;

		default:
			return -EINVAL;
		}

	case IIO_CHAN_INFO_SAMP_FREQ: {
		struct ad7124_channel_config *cfg = &st->channels[chan->address].cfg;

		guard(mutex)(&st->cfgs_lock);

		switch (cfg->filter_type) {
		case AD7124_FILTER_TYPE_SINC3:
		case AD7124_FILTER_TYPE_SINC3_REJ60:
		case AD7124_FILTER_TYPE_SINC3_SINC1:
		case AD7124_FILTER_TYPE_SINC4:
		case AD7124_FILTER_TYPE_SINC4_REJ60:
		case AD7124_FILTER_TYPE_SINC4_SINC1:
			*val = ad7124_get_fclk_hz(st);
			*val2 = ad7124_get_fadc_divisor(st, chan->address);
			return IIO_VAL_FRACTIONAL;
		/*
		 * Post filters force the chip to a fixed rate. These are the
		 * single-channel rates from the data sheet divided by 3 for
		 * the multi-channel case (data sheet doesn't explicitly state
		 * this but confirmed through testing).
		 */
		case AD7124_FILTER_TYPE_SINC3_PF1:
			*val = 300;
			*val2 = 33;
			return IIO_VAL_FRACTIONAL;
		case AD7124_FILTER_TYPE_SINC3_PF2:
			*val = 25;
			*val2 = 3;
			return IIO_VAL_FRACTIONAL;
		case AD7124_FILTER_TYPE_SINC3_PF3:
			*val = 20;
			*val2 = 3;
			return IIO_VAL_FRACTIONAL;
		case AD7124_FILTER_TYPE_SINC3_PF4:
			*val = 50;
			*val2 = 9;
			return IIO_VAL_FRACTIONAL;
		default:
			return -EINVAL;
		}
	}
	case IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY: {
		guard(mutex)(&st->cfgs_lock);

		ret = ad7124_get_3db_filter_factor(st, chan->address);
		if (ret < 0)
			return ret;

		/* 3dB point is the f_CLK rate times a fractional value */
		*val = ret * ad7124_get_fclk_hz(st);
		*val2 = MILLI * ad7124_get_fadc_divisor(st, chan->address);
		return IIO_VAL_FRACTIONAL;
	}
	default:
		return -EINVAL;
	}
}

static int ad7124_write_raw(struct iio_dev *indio_dev,
			    struct iio_chan_spec const *chan,
			    int val, int val2, long info)
{
	struct ad7124_state *st = iio_priv(indio_dev);
	struct ad7124_channel_config *cfg = &st->channels[chan->address].cfg;
	unsigned int res, gain, full_scale, vref;

	guard(mutex)(&st->cfgs_lock);

	switch (info) {
	case IIO_CHAN_INFO_SAMP_FREQ:
		if (val2 < 0 || val < 0 || (val2 == 0 && val == 0))
			return -EINVAL;

		cfg->requested_odr = val;
		cfg->requested_odr_micro = val2;
		ad7124_set_channel_odr(st, chan->address);

		return 0;
	case IIO_CHAN_INFO_SCALE:
		if (val != 0)
			return -EINVAL;

		if (st->channels[chan->address].cfg.bipolar)
			full_scale = 1 << (chan->scan_type.realbits - 1);
		else
			full_scale = 1 << chan->scan_type.realbits;

		vref = st->channels[chan->address].cfg.vref_mv * 1000000LL;
		res = DIV_ROUND_CLOSEST(vref, full_scale);
		gain = DIV_ROUND_CLOSEST(res, val2);
		res = ad7124_find_closest_match(ad7124_gain, ARRAY_SIZE(ad7124_gain), gain);

		st->channels[chan->address].cfg.pga_bits = res;
		return 0;
	default:
		return -EINVAL;
	}
}

static int ad7124_reg_access(struct iio_dev *indio_dev,
			     unsigned int reg,
			     unsigned int writeval,
			     unsigned int *readval)
{
	struct ad7124_state *st = iio_priv(indio_dev);
	int ret;

	if (reg >= ARRAY_SIZE(ad7124_reg_size))
		return -EINVAL;

	if (readval)
		ret = ad_sd_read_reg(&st->sd, reg, ad7124_reg_size[reg],
				     readval);
	else
		ret = ad_sd_write_reg(&st->sd, reg, ad7124_reg_size[reg],
				      writeval);

	return ret;
}

static int ad7124_update_scan_mode(struct iio_dev *indio_dev,
				   const unsigned long *scan_mask)
{
	struct ad7124_state *st = iio_priv(indio_dev);
	bool bit_set;
	int ret;
	int i;

	guard(mutex)(&st->cfgs_lock);

	for (i = 0; i < st->num_channels; i++) {
		bit_set = test_bit(i, scan_mask);
		if (bit_set)
			ret = ad7124_prepare_read(st, i);
		else
			ret = ad7124_spi_write_mask(st, AD7124_CHANNEL(i), AD7124_CHANNEL_ENABLE,
						    0, 2);
		if (ret < 0)
			return ret;
	}

	return 0;
}

static const struct iio_info ad7124_info = {
	.read_avail = ad7124_read_avail,
	.read_raw = ad7124_read_raw,
	.write_raw = ad7124_write_raw,
	.debugfs_reg_access = &ad7124_reg_access,
	.validate_trigger = ad_sd_validate_trigger,
	.update_scan_mode = ad7124_update_scan_mode,
};

/* Only called during probe, so dev_err_probe() can be used */
static int ad7124_soft_reset(struct ad7124_state *st)
{
	struct device *dev = &st->sd.spi->dev;
	unsigned int readval, timeout;
	int ret;

	ret = ad_sd_reset(&st->sd);
	if (ret < 0)
		return ret;

	fsleep(200);
	timeout = 100;
	do {
		ret = ad_sd_read_reg(&st->sd, AD7124_STATUS, 1, &readval);
		if (ret < 0)
			return dev_err_probe(dev, ret, "Error reading status register\n");

		if (!(readval & AD7124_STATUS_POR_FLAG))
			break;

		/* The AD7124 requires typically 2ms to power up and settle */
		usleep_range(100, 2000);
	} while (--timeout);

	if (readval & AD7124_STATUS_POR_FLAG)
		return dev_err_probe(dev, -EIO, "Soft reset failed\n");

	ret = ad_sd_read_reg(&st->sd, AD7124_GAIN(0), 3, &st->gain_default);
	if (ret < 0)
		return dev_err_probe(dev, ret, "Error reading gain register\n");

	dev_dbg(dev, "Reset value of GAIN register is 0x%x\n", st->gain_default);

	return 0;
}

static int ad7124_check_chip_id(struct ad7124_state *st)
{
	struct device *dev = &st->sd.spi->dev;
	unsigned int readval, chip_id, silicon_rev;
	int ret;

	ret = ad_sd_read_reg(&st->sd, AD7124_ID, 1, &readval);
	if (ret < 0)
		return dev_err_probe(dev, ret, "Failure to read ID register\n");

	chip_id = FIELD_GET(AD7124_ID_DEVICE_ID, readval);
	silicon_rev = FIELD_GET(AD7124_ID_SILICON_REVISION, readval);

	if (chip_id != st->chip_info->chip_id)
		return dev_err_probe(dev, -ENODEV,
				     "Chip ID mismatch: expected %u, got %u\n",
				     st->chip_info->chip_id, chip_id);

	if (silicon_rev == 0)
		return dev_err_probe(dev, -ENODEV,
				     "Silicon revision empty. Chip may not be present\n");

	return 0;
}

enum {
	AD7124_SYSCALIB_ZERO_SCALE,
	AD7124_SYSCALIB_FULL_SCALE,
};

static int ad7124_syscalib_locked(struct ad7124_state *st, const struct iio_chan_spec *chan)
{
	struct device *dev = &st->sd.spi->dev;
	struct ad7124_channel *ch = &st->channels[chan->address];
	int ret;

	if (ch->syscalib_mode == AD7124_SYSCALIB_ZERO_SCALE) {
		ch->cfg.calibration_offset = 0x800000;

		ret = ad_sd_calibrate(&st->sd, AD7124_ADC_CONTROL_MODE_SYS_OFFSET_CALIB,
				      chan->address);
		if (ret < 0)
			return ret;

		/*
		 * Making the assumption that a single conversion will always
		 * use configuration slot 0 for the OFFSET/GAIN registers.
		 */
		ret = ad_sd_read_reg(&st->sd, AD7124_OFFSET(0), 3,
				     &ch->cfg.calibration_offset);
		if (ret < 0)
			return ret;

		dev_dbg(dev, "offset for channel %lu after zero-scale calibration: 0x%x\n",
			chan->address, ch->cfg.calibration_offset);
	} else {
		ch->cfg.calibration_gain = st->gain_default;

		ret = ad_sd_calibrate(&st->sd, AD7124_ADC_CONTROL_MODE_SYS_GAIN_CALIB,
				      chan->address);
		if (ret < 0)
			return ret;

		ret = ad_sd_read_reg(&st->sd, AD7124_GAIN(0), 3,
				     &ch->cfg.calibration_gain);
		if (ret < 0)
			return ret;

		dev_dbg(dev, "gain for channel %lu after full-scale calibration: 0x%x\n",
			chan->address, ch->cfg.calibration_gain);
	}

	return 0;
}

static ssize_t ad7124_write_syscalib(struct iio_dev *indio_dev,
				     uintptr_t private,
				     const struct iio_chan_spec *chan,
				     const char *buf, size_t len)
{
	struct ad7124_state *st = iio_priv(indio_dev);
	bool sys_calib;
	int ret;

	ret = kstrtobool(buf, &sys_calib);
	if (ret)
		return ret;

	if (!sys_calib)
		return len;

	if (!iio_device_claim_direct(indio_dev))
		return -EBUSY;

	ret = ad7124_syscalib_locked(st, chan);

	iio_device_release_direct(indio_dev);

	return ret ?: len;
}

static const char * const ad7124_syscalib_modes[] = {
	[AD7124_SYSCALIB_ZERO_SCALE] = "zero_scale",
	[AD7124_SYSCALIB_FULL_SCALE] = "full_scale",
};

static int ad7124_set_syscalib_mode(struct iio_dev *indio_dev,
				    const struct iio_chan_spec *chan,
				    unsigned int mode)
{
	struct ad7124_state *st = iio_priv(indio_dev);

	st->channels[chan->address].syscalib_mode = mode;

	return 0;
}

static int ad7124_get_syscalib_mode(struct iio_dev *indio_dev,
				    const struct iio_chan_spec *chan)
{
	struct ad7124_state *st = iio_priv(indio_dev);

	return st->channels[chan->address].syscalib_mode;
}

static const struct iio_enum ad7124_syscalib_mode_enum = {
	.items = ad7124_syscalib_modes,
	.num_items = ARRAY_SIZE(ad7124_syscalib_modes),
	.set = ad7124_set_syscalib_mode,
	.get = ad7124_get_syscalib_mode
};

static const char * const ad7124_filter_types[] = {
	[AD7124_FILTER_TYPE_SINC3] = "sinc3",
	[AD7124_FILTER_TYPE_SINC3_PF1] = "sinc3+pf1",
	[AD7124_FILTER_TYPE_SINC3_PF2] = "sinc3+pf2",
	[AD7124_FILTER_TYPE_SINC3_PF3] = "sinc3+pf3",
	[AD7124_FILTER_TYPE_SINC3_PF4] = "sinc3+pf4",
	[AD7124_FILTER_TYPE_SINC3_REJ60] = "sinc3+rej60",
	[AD7124_FILTER_TYPE_SINC3_SINC1] = "sinc3+sinc1",
	[AD7124_FILTER_TYPE_SINC4] = "sinc4",
	[AD7124_FILTER_TYPE_SINC4_REJ60] = "sinc4+rej60",
	[AD7124_FILTER_TYPE_SINC4_SINC1] = "sinc4+sinc1",
};

static int ad7124_set_filter_type_attr(struct iio_dev *dev,
				       const struct iio_chan_spec *chan,
				       unsigned int value)
{
	struct ad7124_state *st = iio_priv(dev);
	struct ad7124_channel_config *cfg = &st->channels[chan->address].cfg;

	guard(mutex)(&st->cfgs_lock);

	cfg->filter_type = value;
	ad7124_set_channel_odr(st, chan->address);

	return 0;
}

static int ad7124_get_filter_type_attr(struct iio_dev *dev,
				       const struct iio_chan_spec *chan)
{
	struct ad7124_state *st = iio_priv(dev);

	guard(mutex)(&st->cfgs_lock);

	return st->channels[chan->address].cfg.filter_type;
}

static const struct iio_enum ad7124_filter_type_enum = {
	.items = ad7124_filter_types,
	.num_items = ARRAY_SIZE(ad7124_filter_types),
	.set = ad7124_set_filter_type_attr,
	.get = ad7124_get_filter_type_attr,
};

static const struct iio_chan_spec_ext_info ad7124_calibsys_ext_info[] = {
	{
		.name = "sys_calibration",
		.write = ad7124_write_syscalib,
		.shared = IIO_SEPARATE,
	},
	IIO_ENUM("sys_calibration_mode", IIO_SEPARATE,
		 &ad7124_syscalib_mode_enum),
	IIO_ENUM_AVAILABLE("sys_calibration_mode", IIO_SHARED_BY_TYPE,
			   &ad7124_syscalib_mode_enum),
	IIO_ENUM("filter_type", IIO_SEPARATE, &ad7124_filter_type_enum),
	IIO_ENUM_AVAILABLE("filter_type", IIO_SHARED_BY_TYPE,
			   &ad7124_filter_type_enum),
	{ }
};

static const struct iio_chan_spec ad7124_channel_template = {
	.type = IIO_VOLTAGE,
	.indexed = 1,
	.differential = 1,
	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
		BIT(IIO_CHAN_INFO_SCALE) |
		BIT(IIO_CHAN_INFO_OFFSET) |
		BIT(IIO_CHAN_INFO_SAMP_FREQ) |
		BIT(IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY),
	.info_mask_shared_by_type_available = BIT(IIO_CHAN_INFO_SCALE),
	.scan_type = {
		.sign = 'u',
		.realbits = 24,
		.storagebits = 32,
		.endianness = IIO_BE,
	},
	.ext_info = ad7124_calibsys_ext_info,
};

/*
 * Input specifiers 8 - 15 are explicitly reserved for ad7124-4
 * while they are fine for ad7124-8. Values above 31 don't fit
 * into the register field and so are invalid for sure.
 */
static bool ad7124_valid_input_select(unsigned int ain, const struct ad7124_chip_info *info)
{
	if (ain >= info->num_inputs && ain < 16)
		return false;

	return ain <= FIELD_MAX(AD7124_CHANNEL_AINM);
}

static int ad7124_parse_channel_config(struct iio_dev *indio_dev,
				       struct device *dev)
{
	struct ad7124_state *st = iio_priv(indio_dev);
	struct ad7124_channel_config *cfg;
	struct ad7124_channel *channels;
	struct iio_chan_spec *chan;
	unsigned int ain[2], channel = 0, tmp;
	unsigned int num_channels;
	int ret;

	num_channels = device_get_child_node_count(dev);

	/*
	 * The driver assigns each logical channel defined in the device tree
	 * statically one channel register. So only accept 16 such logical
	 * channels to not treat CONFIG_0 (i.e. the register following
	 * CHANNEL_15) as an additional channel register. The driver could be
	 * improved to lift this limitation.
	 */
	if (num_channels > AD7124_MAX_CHANNELS)
		return dev_err_probe(dev, -EINVAL, "Too many channels defined\n");

	/* Add one for temperature */
	st->num_channels = min(num_channels + 1, AD7124_MAX_CHANNELS);

	chan = devm_kcalloc(dev, st->num_channels,
			    sizeof(*chan), GFP_KERNEL);
	if (!chan)
		return -ENOMEM;

	channels = devm_kcalloc(dev, st->num_channels, sizeof(*channels),
				GFP_KERNEL);
	if (!channels)
		return -ENOMEM;

	indio_dev->channels = chan;
	indio_dev->num_channels = st->num_channels;
	st->channels = channels;

	device_for_each_child_node_scoped(dev, child) {
		ret = fwnode_property_read_u32(child, "reg", &channel);
		if (ret)
			return dev_err_probe(dev, ret,
					     "Failed to parse reg property of %pfwP\n", child);

		if (channel >= num_channels)
			return dev_err_probe(dev, -EINVAL,
					     "Channel index >= number of channels in %pfwP\n", child);

		ret = fwnode_property_read_u32_array(child, "diff-channels",
						     ain, 2);
		if (ret)
			return dev_err_probe(dev, ret,
					     "Failed to parse diff-channels property of %pfwP\n", child);

		if (!ad7124_valid_input_select(ain[0], st->chip_info) ||
		    !ad7124_valid_input_select(ain[1], st->chip_info))
			return dev_err_probe(dev, -EINVAL,
					     "diff-channels property of %pfwP contains invalid data\n", child);

		st->channels[channel].ain = FIELD_PREP(AD7124_CHANNEL_AINP, ain[0]) |
			FIELD_PREP(AD7124_CHANNEL_AINM, ain[1]);

		cfg = &st->channels[channel].cfg;
		cfg->bipolar = fwnode_property_read_bool(child, "bipolar");

		ret = fwnode_property_read_u32(child, "adi,reference-select", &tmp);
		if (ret)
			cfg->refsel = AD7124_INT_REF;
		else
			cfg->refsel = tmp;

		cfg->buf_positive =
			fwnode_property_read_bool(child, "adi,buffered-positive");
		cfg->buf_negative =
			fwnode_property_read_bool(child, "adi,buffered-negative");

		chan[channel] = ad7124_channel_template;
		chan[channel].address = channel;
		chan[channel].scan_index = channel;
		chan[channel].channel = ain[0];
		chan[channel].channel2 = ain[1];
	}

	if (num_channels < AD7124_MAX_CHANNELS) {
		st->channels[num_channels] = (struct ad7124_channel) {
			.ain = FIELD_PREP(AD7124_CHANNEL_AINP, AD7124_CHANNEL_AINx_TEMPSENSOR) |
				FIELD_PREP(AD7124_CHANNEL_AINM, AD7124_CHANNEL_AINx_AVSS),
			.cfg = {
				.bipolar = true,
			},
		};

		chan[num_channels] = (struct iio_chan_spec) {
			.type = IIO_TEMP,
			.info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
				BIT(IIO_CHAN_INFO_SCALE) | BIT(IIO_CHAN_INFO_OFFSET) |
				BIT(IIO_CHAN_INFO_SAMP_FREQ),
			.scan_type = {
				/*
				 * You might find it strange that a bipolar
				 * measurement yields an unsigned value, but
				 * this matches the device's manual.
				 */
				.sign = 'u',
				.realbits = 24,
				.storagebits = 32,
				.endianness = IIO_BE,
			},
			.address = num_channels,
			.scan_index = num_channels,
			.ext_info = ad7124_calibsys_ext_info,
		};
	}

	return 0;
}

static int ad7124_setup(struct ad7124_state *st)
{
	struct device *dev = &st->sd.spi->dev;
	unsigned int power_mode, clk_sel;
	struct clk *mclk;
	int i, ret;

	/*
	 * Always use full power mode for max performance. If needed, the driver
	 * could be adapted to use a dynamic power mode based on the requested
	 * output data rate.
	 */
	power_mode = AD7124_ADC_CONTROL_POWER_MODE_FULL;

	/*
	 * This "mclk" business is needed for backwards compatibility with old
	 * devicetrees that specified a fake clock named "mclk" to select the
	 * power mode.
	 */
	mclk = devm_clk_get_optional_enabled(dev, "mclk");
	if (IS_ERR(mclk))
		return dev_err_probe(dev, PTR_ERR(mclk), "Failed to get mclk\n");

	if (mclk) {
		unsigned long mclk_hz;

		mclk_hz = clk_get_rate(mclk);
		if (!mclk_hz)
			return dev_err_probe(dev, -EINVAL,
					     "Failed to get mclk rate\n");

		/*
		 * This logic is a bit backwards, which is why it is only here
		 * for backwards compatibility. The driver should be able to set
		 * the power mode as it sees fit and the f_clk/mclk rate should
		 * be dynamic accordingly. But here, we are selecting a fixed
		 * power mode based on the given "mclk" rate.
		 */
		power_mode = ad7124_find_closest_match(ad7124_master_clk_freq_hz,
			ARRAY_SIZE(ad7124_master_clk_freq_hz), mclk_hz);

		if (mclk_hz != ad7124_master_clk_freq_hz[power_mode]) {
			ret = clk_set_rate(mclk, mclk_hz);
			if (ret)
				return dev_err_probe(dev, ret,
						     "Failed to set mclk rate\n");
		}

		clk_sel = AD7124_ADC_CONTROL_CLK_SEL_INT;
		st->clk_hz = AD7124_INT_CLK_HZ;
	} else if (!device_property_present(dev, "clocks") &&
		   device_property_present(dev, "#clock-cells")) {
#ifdef CONFIG_COMMON_CLK
		struct clk_hw *clk_hw;

		const char *name __free(kfree) = kasprintf(GFP_KERNEL, "%pfwP-clk",
							   dev_fwnode(dev));
		if (!name)
			return -ENOMEM;

		clk_hw = devm_clk_hw_register_fixed_rate(dev, name, NULL, 0,
							 AD7124_INT_CLK_HZ);
		if (IS_ERR(clk_hw))
			return dev_err_probe(dev, PTR_ERR(clk_hw),
					     "Failed to register clock provider\n");

		ret = devm_of_clk_add_hw_provider(dev, of_clk_hw_simple_get,
						  clk_hw);
		if (ret)
			return dev_err_probe(dev, ret,
					     "Failed to add clock provider\n");
#endif

		/*
		 * Treat the clock as always on. This way we don't have to deal
		 * with someone trying to enable/disable the clock while we are
		 * reading samples.
		 */
		clk_sel = AD7124_ADC_CONTROL_CLK_SEL_INT_OUT;
		st->clk_hz = AD7124_INT_CLK_HZ;
	} else {
		struct clk *clk;

		clk = devm_clk_get_optional_enabled(dev, NULL);
		if (IS_ERR(clk))
			return dev_err_probe(dev, PTR_ERR(clk),
					     "Failed to get external clock\n");

		if (clk) {
			unsigned long clk_hz;

			clk_hz = clk_get_rate(clk);
			if (!clk_hz)
				return dev_err_probe(dev, -EINVAL,
					"Failed to get external clock rate\n");

			/*
			 * The external clock may be 4x the nominal clock rate,
			 * in which case the ADC needs to be configured to
			 * divide it by 4. Using MEGA is a bit arbitrary, but
			 * the expected clock rates are either 614.4 kHz or
			 * 2.4576 MHz, so this should work.
			 */
			if (clk_hz > (1 * HZ_PER_MHZ)) {
				clk_sel = AD7124_ADC_CONTROL_CLK_SEL_EXT_DIV4;
				st->clk_hz = clk_hz / 4;
			} else {
				clk_sel = AD7124_ADC_CONTROL_CLK_SEL_EXT;
				st->clk_hz = clk_hz;
			}
		} else {
			clk_sel = AD7124_ADC_CONTROL_CLK_SEL_INT;
			st->clk_hz = AD7124_INT_CLK_HZ;
		}
	}

	st->adc_control &= ~AD7124_ADC_CONTROL_CLK_SEL;
	st->adc_control |= FIELD_PREP(AD7124_ADC_CONTROL_CLK_SEL, clk_sel);

	st->adc_control &= ~AD7124_ADC_CONTROL_POWER_MODE;
	st->adc_control |= FIELD_PREP(AD7124_ADC_CONTROL_POWER_MODE, power_mode);

	st->adc_control &= ~AD7124_ADC_CONTROL_MODE;
	st->adc_control |= FIELD_PREP(AD7124_ADC_CONTROL_MODE, AD_SD_MODE_IDLE);

	ret = devm_mutex_init(dev, &st->cfgs_lock);
	if (ret)
		return ret;

	for (i = 0; i < st->num_channels; i++) {
		struct ad7124_channel_config *cfg = &st->channels[i].cfg;

		ret = ad7124_init_config_vref(st, cfg);
		if (ret < 0)
			return ret;

		cfg->cfg_slot = AD7124_CFG_SLOT_UNASSIGNED;

		/* Default filter type on the ADC after reset. */
		cfg->filter_type = AD7124_FILTER_TYPE_SINC4;

		/*
		 * 9.38 SPS is the minimum output data rate supported
		 * regardless of the selected power mode. Round it up to 10 and
		 * set all channels to this default value.
		 */
		cfg->requested_odr = 10;
		ad7124_set_channel_odr(st, i);
	}

	ad7124_disable_all(&st->sd);

	ret = ad_sd_write_reg(&st->sd, AD7124_ADC_CONTROL, 2, st->adc_control);
	if (ret < 0)
		return dev_err_probe(dev, ret, "Failed to setup CONTROL register\n");

	return ret;
}

static int __ad7124_calibrate_all(struct ad7124_state *st, struct iio_dev *indio_dev)
{
	struct device *dev = &st->sd.spi->dev;
	int ret, i;

	for (i = 0; i < st->num_channels; i++) {
		/*
		 * For calibration the OFFSET register should hold its reset default
		 * value. For the GAIN register there is no such requirement but
		 * for gain 1 it should hold the reset default value, too. So to
		 * simplify matters use the reset default value for both.
		 */
		st->channels[i].cfg.calibration_offset = 0x800000;
		st->channels[i].cfg.calibration_gain = st->gain_default;

		/*
		 * Only the main voltage input channels are important enough
		 * to be automatically calibrated here. For everything else,
		 * just use the default values set above.
		 */
		if (indio_dev->channels[i].type != IIO_VOLTAGE)
			continue;

		/*
		 * Full-scale calibration isn't supported at gain 1, so skip in
		 * that case. Note that untypically full-scale calibration has
		 * to happen before zero-scale calibration. This only applies to
		 * the internal calibration. For system calibration it's as
		 * usual: first zero-scale then full-scale calibration.
		 */
		if (st->channels[i].cfg.pga_bits > 0) {
			ret = ad_sd_calibrate(&st->sd, AD7124_ADC_CONTROL_MODE_INT_GAIN_CALIB, i);
			if (ret < 0)
				return ret;

			/*
			 * read out the resulting value of GAIN
			 * after full-scale calibration because the next
			 * ad_sd_calibrate() call overwrites this via
			 * ad_sigma_delta_set_channel() -> ad7124_set_channel()
			 * -> ad7124_prepare_read().
			 */
			ret = ad_sd_read_reg(&st->sd, AD7124_GAIN(0), 3,
					     &st->channels[i].cfg.calibration_gain);
			if (ret < 0)
				return ret;
		}

		ret = ad_sd_calibrate(&st->sd, AD7124_ADC_CONTROL_MODE_INT_OFFSET_CALIB, i);
		if (ret < 0)
			return ret;

		/*
		 * Making the assumption that a single conversion will always
		 * use configuration slot 0 for the OFFSET/GAIN registers.
		 */
		ret = ad_sd_read_reg(&st->sd, AD7124_OFFSET(0), 3,
				     &st->channels[i].cfg.calibration_offset);
		if (ret < 0)
			return ret;

		dev_dbg(dev, "offset and gain for channel %d = 0x%x + 0x%x\n", i,
			st->channels[i].cfg.calibration_offset,
			st->channels[i].cfg.calibration_gain);
	}

	return 0;
}

static int ad7124_calibrate_all(struct ad7124_state *st, struct iio_dev *indio_dev)
{
	int ret;
	unsigned int adc_control = st->adc_control;

	/*
	 * Calibration isn't supported at full power, so speed down a bit.
	 * Setting .adc_control is enough here because the control register is
	 * written as part of ad_sd_calibrate() -> ad_sigma_delta_set_mode().
	 * The resulting calibration is then also valid for high-speed, so just
	 * restore adc_control afterwards.
	 */
	if (FIELD_GET(AD7124_ADC_CONTROL_POWER_MODE, adc_control) >= AD7124_FULL_POWER) {
		st->adc_control &= ~AD7124_ADC_CONTROL_POWER_MODE;
		st->adc_control |= FIELD_PREP(AD7124_ADC_CONTROL_POWER_MODE, AD7124_MID_POWER);
	}

	ret = __ad7124_calibrate_all(st, indio_dev);

	st->adc_control = adc_control;

	return ret;
}

static void ad7124_reg_disable(void *r)
{
	regulator_disable(r);
}

static void ad7124_debugfs_init(struct iio_dev *indio_dev)
{
	struct dentry *dentry = iio_get_debugfs_dentry(indio_dev);
	struct ad7124_state *st = iio_priv(indio_dev);

	if (!IS_ENABLED(CONFIG_DEBUG_FS))
		return;

	debugfs_create_bool("enable_single_cycle", 0644, dentry,
			    &st->enable_single_cycle);
}

static int ad7124_probe(struct spi_device *spi)
{
	const struct ad7124_chip_info *info;
	struct device *dev = &spi->dev;
	struct ad7124_state *st;
	struct iio_dev *indio_dev;
	int i, ret;

	info = spi_get_device_match_data(spi);
	if (!info)
		return dev_err_probe(dev, -ENODEV, "Failed to get match data\n");

	indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
	if (!indio_dev)
		return -ENOMEM;

	st = iio_priv(indio_dev);

	st->chip_info = info;

	/* Only disabled for debug/testing purposes. */
	st->enable_single_cycle = true;

	indio_dev->name = st->chip_info->name;
	indio_dev->modes = INDIO_DIRECT_MODE;
	indio_dev->info = &ad7124_info;

	ret = ad_sd_init(&st->sd, indio_dev, spi, &ad7124_sigma_delta_info);
	if (ret < 0)
		return ret;

	ret = ad7124_parse_channel_config(indio_dev, &spi->dev);
	if (ret < 0)
		return ret;

	for (i = 0; i < ARRAY_SIZE(st->vref); i++) {
		if (i == AD7124_INT_REF)
			continue;

		st->vref[i] = devm_regulator_get_optional(&spi->dev,
						ad7124_ref_names[i]);
		if (PTR_ERR(st->vref[i]) == -ENODEV)
			continue;
		else if (IS_ERR(st->vref[i]))
			return PTR_ERR(st->vref[i]);

		ret = regulator_enable(st->vref[i]);
		if (ret)
			return dev_err_probe(dev, ret, "Failed to enable regulator #%d\n", i);

		ret = devm_add_action_or_reset(&spi->dev, ad7124_reg_disable,
					       st->vref[i]);
		if (ret)
			return ret;
	}

	ret = ad7124_soft_reset(st);
	if (ret < 0)
		return ret;

	ret = ad7124_check_chip_id(st);
	if (ret)
		return ret;

	ret = ad7124_setup(st);
	if (ret < 0)
		return ret;

	ret = devm_ad_sd_setup_buffer_and_trigger(&spi->dev, indio_dev);
	if (ret < 0)
		return dev_err_probe(dev, ret, "Failed to setup triggers\n");

	ret = ad7124_calibrate_all(st, indio_dev);
	if (ret)
		return ret;

	ret = devm_iio_device_register(&spi->dev, indio_dev);
	if (ret < 0)
		return dev_err_probe(dev, ret, "Failed to register iio device\n");

	ad7124_debugfs_init(indio_dev);

	return 0;
}

static const struct of_device_id ad7124_of_match[] = {
	{ .compatible = "adi,ad7124-4", .data = &ad7124_4_chip_info },
	{ .compatible = "adi,ad7124-8", .data = &ad7124_8_chip_info },
	{ }
};
MODULE_DEVICE_TABLE(of, ad7124_of_match);

static const struct spi_device_id ad71124_ids[] = {
	{ .name = "ad7124-4", .driver_data = (kernel_ulong_t)&ad7124_4_chip_info },
	{ .name = "ad7124-8", .driver_data = (kernel_ulong_t)&ad7124_8_chip_info },
	{ }
};
MODULE_DEVICE_TABLE(spi, ad71124_ids);

static struct spi_driver ad71124_driver = {
	.driver = {
		.name = "ad7124",
		.of_match_table = ad7124_of_match,
	},
	.probe = ad7124_probe,
	.id_table = ad71124_ids,
};
module_spi_driver(ad71124_driver);

MODULE_AUTHOR("Stefan Popa <stefan.popa@analog.com>");
MODULE_DESCRIPTION("Analog Devices AD7124 SPI driver");
MODULE_LICENSE("GPL");
MODULE_IMPORT_NS("IIO_AD_SIGMA_DELTA");