-
Notifications
You must be signed in to change notification settings - Fork 9.5k
Expand file tree
/
Copy pathi2c_dw.c
More file actions
1443 lines (1201 loc) · 38.8 KB
/
Copy pathi2c_dw.c
File metadata and controls
1443 lines (1201 loc) · 38.8 KB
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
/* dw_i2c.c - I2C file for Design Ware */
/*
* Copyright (c) 2015 Intel Corporation
* Copyright (c) 2022 Andrei-Edward Popa
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <zephyr/arch/cpu.h>
#ifdef CONFIG_CPU_CORTEX_M
#include <cmsis_core.h>
#endif
#include <stddef.h>
#include <zephyr/types.h>
#include <stdlib.h>
#include <stdbool.h>
#include <zephyr/drivers/i2c.h>
#include <zephyr/kernel.h>
#include <zephyr/init.h>
#include <zephyr/pm/device.h>
#include <zephyr/arch/cpu.h>
#include <zephyr/irq.h>
#include <string.h>
#if defined(CONFIG_PINCTRL)
#include <zephyr/drivers/pinctrl.h>
#endif
#if defined(CONFIG_RESET)
#include <zephyr/drivers/reset.h>
#endif
#include <errno.h>
#include <zephyr/sys/sys_io.h>
#include <zephyr/sys/util.h>
#if defined(CONFIG_I2C_DW_LPSS_DMA)
#include <zephyr/drivers/dma.h>
#include <zephyr/drivers/dma/dma_intel_lpss.h>
#endif
#ifdef CONFIG_IOAPIC
#include <zephyr/drivers/interrupt_controller/ioapic.h>
#endif
#include "i2c_dw.h"
#include "i2c_dw_registers.h"
#define LOG_LEVEL CONFIG_I2C_LOG_LEVEL
#include <zephyr/logging/log.h>
#include <zephyr/irq.h>
LOG_MODULE_REGISTER(i2c_dw);
#include "i2c-priv.h"
static inline uint32_t get_regs(const struct device *dev)
{
return (uint32_t)DEVICE_MMIO_GET(dev);
}
/*
* @param dev: DW I2C device instance
* @param wrapper_dev: Callers device instance
*/
void i2c_dw_register_recover_bus_cb(const struct device *dev, i2c_api_recover_bus_t recover_bus_cb,
const struct device *wrapper_dev)
{
struct i2c_dw_dev_config *const dw = dev->data;
dw->recover_bus_cb = recover_bus_cb;
dw->recover_bus_dev = (struct device *)wrapper_dev;
}
/* it might call from i2c_transfer api and have already
* lock the bus, no need to lock bus again here
*/
static int i2c_recovery_bus(const struct device *dev)
{
int ret = 0;
struct i2c_dw_dev_config *const dw = dev->data;
if (dw->recover_bus_cb) {
/* callback customize recovery function */
ret = dw->recover_bus_cb(dw->recover_bus_dev);
if (ret == 0) {
/* recovery success */
dw->state = I2C_DW_STATE_READY;
}
}
return ret;
}
int i2c_dw_recovery_bus(const struct device *dev)
{
int ret = 0;
struct i2c_dw_dev_config *const dw = dev->data;
/* lock bus */
ret = k_sem_take(&dw->bus_sem, K_FOREVER);
if (ret != 0) {
return ret;
}
/* do bus recovery */
ret = i2c_recovery_bus(dev);
/* unlock bus */
k_sem_give(&dw->bus_sem);
return ret;
}
static int i2c_dw_error_chk(const struct device *dev)
{
struct i2c_dw_dev_config *const dw = dev->data;
uint32_t reg_base = get_regs(dev);
union ic_interrupt_register intr_stat;
union ic_txabrt_register ic_txabrt_src;
uint32_t value;
/* Cache ic_intr_stat and txabrt_src for processing,
* so there is no need to read the register multiple times.
*/
intr_stat.raw = read_intr_stat(reg_base);
ic_txabrt_src.raw = read_txabrt_src(reg_base);
/* NACK and SDA_STUCK are below TX_Abort */
if (intr_stat.bits.tx_abrt) {
/* check 7bit NACK Tx Abort */
if (ic_txabrt_src.bits.ADDR7BNACK) {
dw->state |= I2C_DW_NACK;
LOG_ERR_RATELIMIT("NACK on %s", dev->name);
}
/* check SDA stuck low Tx abort, need to do bus recover */
if (ic_txabrt_src.bits.SDASTUCKLOW) {
dw->state |= I2C_DW_SDA_STUCK;
LOG_ERR("SDA Stuck Low on %s", dev->name);
}
/* clear RTS5912_INTR_STAT_TX_ABRT */
value = read_clr_tx_abrt(reg_base);
}
/* check SCL stuck low */
if (intr_stat.bits.scl_stuck_low) {
dw->state |= I2C_DW_SCL_STUCK;
LOG_ERR("SCL Stuck Low on %s", dev->name);
}
if (dw->state & I2C_DW_ERR_MASK) {
#if CONFIG_I2C_ALLOW_NO_STOP_TRANSACTIONS
dw->need_setup = true;
#endif
LOG_ERR_RATELIMIT("IO Fail on %s", dev->name);
return -EIO;
}
return 0;
}
#ifdef CONFIG_I2C_DW_LPSS_DMA
void i2c_dw_enable_idma(const struct device *dev, bool enable)
{
uint32_t reg;
uint32_t reg_base = get_regs(dev);
if (enable) {
write_dma_cr(DW_IC_DMA_ENABLE, reg_base);
reg = sys_read32(reg_base + DW_IC_REG_DMA_CR);
} else {
reg = read_dma_cr(reg_base);
reg &= ~DW_IC_DMA_ENABLE;
write_dma_cr(reg, reg_base);
reg = sys_read32(reg_base + DW_IC_REG_DMA_CR);
}
}
void cb_i2c_idma_transfer(const struct device *dma, void *user_data, uint32_t channel, int status)
{
const struct device *dev = (const struct device *)user_data;
const struct i2c_dw_rom_config *const rom = dev->config;
struct i2c_dw_dev_config *const dw = dev->data;
dma_stop(rom->dma_dev, channel);
i2c_dw_enable_idma(dev, false);
if (status) {
dw->xfr_status = true;
} else {
dw->xfr_status = false;
}
}
void i2c_dw_set_fifo_th(const struct device *dev, uint8_t fifo_depth)
{
uint32_t reg_base = get_regs(dev);
write_tdlr(fifo_depth, reg_base);
write_rdlr(fifo_depth - 1, reg_base);
}
inline void *i2c_dw_dr_phy_addr(const struct device *dev)
{
struct i2c_dw_dev_config *const dw = dev->data;
return (void *)(dw->phy_addr + DW_IC_REG_DATA_CMD);
}
int32_t i2c_dw_idma_rx_transfer(const struct device *dev)
{
struct i2c_dw_dev_config *const dw = dev->data;
const struct i2c_dw_rom_config *const rom = dev->config;
struct dma_config dma_cfg = {0};
struct dma_block_config dma_block_cfg = {0};
if (!device_is_ready(rom->dma_dev)) {
LOG_DBG("DMA device is not ready");
return -ENODEV;
}
dma_cfg.dma_slot = 1U;
dma_cfg.channel_direction = PERIPHERAL_TO_MEMORY;
dma_cfg.source_data_size = 1U;
dma_cfg.dest_data_size = 1U;
dma_cfg.source_burst_length = 1U;
dma_cfg.dest_burst_length = 1U;
dma_cfg.dma_callback = cb_i2c_idma_transfer;
dma_cfg.user_data = (void *)dev;
dma_cfg.complete_callback_en = 0U;
dma_cfg.error_callback_dis = 0U;
dma_cfg.block_count = 1U;
dma_cfg.head_block = &dma_block_cfg;
dma_block_cfg.block_size = dw->xfr_len;
dma_block_cfg.dest_address = (uint64_t)&dw->xfr_buf[0];
dma_block_cfg.source_address = (uint64_t)i2c_dw_dr_phy_addr(dev);
dw->xfr_status = false;
if (dma_config(rom->dma_dev, DMA_INTEL_LPSS_RX_CHAN, &dma_cfg)) {
LOG_DBG("Error transfer");
return -EIO;
}
if (dma_start(rom->dma_dev, DMA_INTEL_LPSS_RX_CHAN)) {
LOG_DBG("Error transfer");
return -EIO;
}
i2c_dw_enable_idma(dev, true);
i2c_dw_set_fifo_th(dev, 1);
return 0;
}
int32_t i2c_dw_idma_tx_transfer(const struct device *dev, uint64_t data)
{
const struct i2c_dw_rom_config *const rom = dev->config;
struct i2c_dw_dev_config *const dw = dev->data;
struct dma_config dma_cfg = {0};
struct dma_block_config dma_block_cfg = {0};
if (!device_is_ready(rom->dma_dev)) {
LOG_DBG("DMA device is not ready");
return -ENODEV;
}
dma_cfg.dma_slot = 0U;
dma_cfg.channel_direction = MEMORY_TO_PERIPHERAL;
dma_cfg.source_data_size = 1U;
dma_cfg.dest_data_size = 1U;
dma_cfg.source_burst_length = 1U;
dma_cfg.dest_burst_length = 1U;
dma_cfg.dma_callback = cb_i2c_idma_transfer;
dma_cfg.user_data = (void *)dev;
dma_cfg.complete_callback_en = 0U;
dma_cfg.error_callback_dis = 0U;
dma_cfg.block_count = 1U;
dma_cfg.head_block = &dma_block_cfg;
dma_block_cfg.block_size = 1;
dma_block_cfg.source_address = (uint64_t)&data;
dma_block_cfg.dest_address = (uint64_t)i2c_dw_dr_phy_addr(dev);
dw->xfr_status = false;
if (dma_config(rom->dma_dev, DMA_INTEL_LPSS_TX_CHAN, &dma_cfg)) {
LOG_DBG("Error transfer");
return -EIO;
}
if (dma_start(rom->dma_dev, DMA_INTEL_LPSS_TX_CHAN)) {
LOG_DBG("Error transfer");
return -EIO;
}
i2c_dw_enable_idma(dev, true);
i2c_dw_set_fifo_th(dev, 1);
return 0;
}
#endif
static inline void i2c_dw_data_ask(const struct device *dev)
{
struct i2c_dw_dev_config *const dw = dev->data;
uint32_t data;
int tx_empty;
int rx_empty;
int cnt;
int rx_buffer_depth, tx_buffer_depth;
union ic_comp_param_1_register ic_comp_param_1;
uint32_t reg_base = get_regs(dev);
/* No more bytes to request, so command queue is no longer needed */
if (dw->request_bytes == 0U) {
clear_bit_intr_mask_tx_empty(reg_base);
return;
}
/* Get the FIFO depth that could be from 2 to 256 from HW spec */
ic_comp_param_1.raw = read_comp_param_1(reg_base);
rx_buffer_depth = ic_comp_param_1.bits.rx_buffer_depth + 1;
tx_buffer_depth = ic_comp_param_1.bits.tx_buffer_depth + 1;
/* How many bytes we can actually ask */
rx_empty = (rx_buffer_depth - read_rxflr(reg_base)) - dw->rx_pending;
if (rx_empty < 0) {
/* RX FIFO expected to be full.
* So don't request any bytes, yet.
*/
return;
}
/* How many empty slots in TX FIFO (as command queue) */
tx_empty = tx_buffer_depth - read_txflr(reg_base);
/* Figure out how many bytes we can request */
cnt = MIN(rx_buffer_depth, dw->request_bytes);
cnt = MIN(MIN(tx_empty, rx_empty), cnt);
while (cnt > 0) {
/* Tell controller to get another byte */
data = IC_DATA_CMD_CMD;
/* Send RESTART if needed */
if (dw->xfr_flags & I2C_MSG_RESTART) {
data |= IC_DATA_CMD_RESTART;
dw->xfr_flags &= ~(I2C_MSG_RESTART);
}
/* After receiving the last byte, send STOP if needed */
if ((dw->xfr_flags & I2C_MSG_STOP) && (dw->request_bytes == 1U)) {
data |= IC_DATA_CMD_STOP;
}
#ifdef CONFIG_I2C_TARGET
clear_bit_intr_mask_tx_empty(reg_base);
#endif /* CONFIG_I2C_TARGET */
write_cmd_data(data, reg_base);
if (i2c_dw_error_chk(dev)) {
return;
}
dw->rx_pending++;
dw->request_bytes--;
cnt--;
}
}
static void i2c_dw_data_read(const struct device *dev)
{
struct i2c_dw_dev_config *const dw = dev->data;
uint32_t reg_base = get_regs(dev);
#ifdef CONFIG_I2C_DW_LPSS_DMA
if (test_bit_status_rfne(reg_base) && (dw->xfr_len > 0)) {
i2c_dw_idma_rx_transfer(dev);
dw->xfr_len = 0;
dw->rx_pending = 0;
}
#else
while (test_bit_status_rfne(reg_base) && (dw->xfr_len > 0)) {
dw->xfr_buf[0] = (uint8_t)read_cmd_data(reg_base);
dw->xfr_buf++;
dw->xfr_len--;
dw->rx_pending--;
if (dw->xfr_len == 0U) {
break;
}
if (i2c_dw_error_chk(dev)) {
return;
}
}
#endif
/* Nothing to receive anymore */
if (dw->xfr_len == 0U) {
dw->state &= ~I2C_DW_CMD_RECV;
return;
}
}
static int i2c_dw_data_send(const struct device *dev)
{
struct i2c_dw_dev_config *const dw = dev->data;
uint32_t data = 0U;
uint32_t reg_base = get_regs(dev);
/* Nothing to send anymore, mask the interrupt */
if (dw->xfr_len == 0U) {
clear_bit_intr_mask_tx_empty(reg_base);
dw->state &= ~I2C_DW_CMD_SEND;
return 0;
}
while (test_bit_status_tfnt(reg_base) && (dw->xfr_len > 0)) {
/* We have something to transmit to a specific host */
data = dw->xfr_buf[0];
/* Send RESTART if needed */
if (dw->xfr_flags & I2C_MSG_RESTART) {
data |= IC_DATA_CMD_RESTART;
dw->xfr_flags &= ~(I2C_MSG_RESTART);
}
/* Send STOP if needed */
if ((dw->xfr_len == 1U) && (dw->xfr_flags & I2C_MSG_STOP)) {
data |= IC_DATA_CMD_STOP;
}
#ifdef CONFIG_I2C_DW_LPSS_DMA
i2c_dw_idma_tx_transfer(dev, data);
#else
write_cmd_data(data, reg_base);
#endif
dw->xfr_len--;
dw->xfr_buf++;
if (test_bit_intr_stat_tx_abrt(reg_base)) {
return -EIO;
}
if (i2c_dw_error_chk(dev)) {
return -EIO;
}
}
return 0;
}
static inline void i2c_dw_transfer_complete(const struct device *dev)
{
struct i2c_dw_dev_config *const dw = dev->data;
uint32_t value;
uint32_t reg_base = get_regs(dev);
write_intr_mask(DW_DISABLE_ALL_I2C_INT, reg_base);
value = read_clr_intr(reg_base);
#ifdef CONFIG_CPU_CORTEX_M
const struct i2c_dw_rom_config *const rom = dev->config;
/* clear pending interrupt */
NVIC_ClearPendingIRQ(rom->irqnumber);
#endif
k_sem_give(&dw->device_sync_sem);
}
#ifdef CONFIG_I2C_TARGET
static inline uint8_t i2c_dw_read_byte_non_blocking(const struct device *dev);
static inline void i2c_dw_write_byte_non_blocking(const struct device *dev, uint8_t data);
static void i2c_dw_slave_read_clear_intr_bits(const struct device *dev);
#endif
static void i2c_dw_isr(const struct device *port)
{
struct i2c_dw_dev_config *const dw = port->data;
union ic_interrupt_register intr_stat;
uint32_t value;
int ret = 0;
uint32_t reg_base = get_regs(port);
/* Cache ic_intr_stat for processing, so there is no need to read
* the register multiple times.
*/
intr_stat.raw = read_intr_stat(reg_base);
/*
* Causes of an interrupt:
* - STOP condition is detected
* - Transfer is aborted
* - Transmit FIFO is empty
* - Transmit FIFO has overflowed
* - Receive FIFO is full
* - Receive FIFO has overflowed
* - Received FIFO has underrun
* - Transmit data is required (tx_req)
* - Receive data is available (rx_avail)
*/
LOG_DBG("I2C: interrupt received");
/* Check if we are configured as a master device */
if (test_bit_con_master_mode(reg_base)) {
#ifdef CONFIG_I2C_DW_LPSS_DMA
uint32_t stat = sys_read32(reg_base + IDMA_REG_INTR_STS);
if (stat & IDMA_TX_RX_CHAN_MASK) {
const struct i2c_dw_rom_config *const rom = port->config;
/* Handle the DMA interrupt */
dma_intel_lpss_isr(rom->dma_dev);
}
#endif
/* Bail early if there is any error. */
if ((DW_INTR_STAT_TX_ABRT | DW_INTR_STAT_TX_OVER | DW_INTR_STAT_RX_OVER |
DW_INTR_STAT_RX_UNDER | DW_INTR_STAT_SCL_STUCK_LOW) &
intr_stat.raw) {
dw->state = I2C_DW_CMD_ERROR;
i2c_dw_error_chk(port);
#if CONFIG_I2C_ALLOW_NO_STOP_TRANSACTIONS
dw->need_setup = true;
#endif
goto done;
}
/* Check if the RX FIFO reached threshold */
if (intr_stat.bits.rx_full) {
i2c_dw_data_read(port);
}
#ifdef CONFIG_I2C_TARGET
/* Check if the TX FIFO is ready for commands.
* TX FIFO also serves as command queue where read requests
* are written to TX FIFO.
*/
if ((dw->xfr_flags & I2C_MSG_RW_MASK) == I2C_MSG_READ) {
set_bit_intr_mask_tx_empty(reg_base);
}
#endif /* CONFIG_I2C_TARGET */
if (intr_stat.bits.tx_empty) {
if ((dw->xfr_flags & I2C_MSG_RW_MASK) == I2C_MSG_WRITE) {
ret = i2c_dw_data_send(port);
} else {
i2c_dw_data_ask(port);
}
/* If STOP is not expected, finish processing this
* message if there is nothing left to do anymore.
*/
if (((dw->xfr_len == 0U) && !(dw->xfr_flags & I2C_MSG_STOP)) ||
(ret != 0)) {
goto done;
}
}
/* STOP detected: finish processing this message */
if (intr_stat.bits.stop_det) {
value = read_clr_stop_det(reg_base);
#if CONFIG_I2C_ALLOW_NO_STOP_TRANSACTIONS
dw->need_setup = true;
#endif
goto done;
}
} else {
#ifdef CONFIG_I2C_TARGET
const struct i2c_target_callbacks *slave_cb = dw->slave_cfg->callbacks;
uint32_t slave_activity = test_bit_status_activity(reg_base);
uint8_t data;
i2c_dw_slave_read_clear_intr_bits(port);
if (intr_stat.bits.rx_full) {
if (dw->state != I2C_DW_CMD_SEND) {
dw->state = I2C_DW_CMD_SEND;
if (slave_cb->write_requested) {
slave_cb->write_requested(dw->slave_cfg);
}
}
/* FIFO needs to be drained here so we don't miss the next interrupt */
do {
data = i2c_dw_read_byte_non_blocking(port);
if (slave_cb->write_received) {
slave_cb->write_received(dw->slave_cfg, data);
}
} while (test_bit_status_rfne(reg_base));
}
if (intr_stat.bits.rd_req) {
if (slave_activity) {
read_clr_rd_req(reg_base);
dw->state = I2C_DW_CMD_RECV;
if (!dw->read_in_progress) {
if (slave_cb->read_requested) {
slave_cb->read_requested(dw->slave_cfg, &data);
i2c_dw_write_byte_non_blocking(port, data);
}
dw->read_in_progress = true;
} else {
if (slave_cb->read_processed) {
slave_cb->read_processed(dw->slave_cfg, &data);
i2c_dw_write_byte_non_blocking(port, data);
}
}
}
}
if (intr_stat.bits.stop_det) {
read_clr_stop_det(reg_base);
dw->state = I2C_DW_STATE_READY;
dw->read_in_progress = false;
if (slave_cb->stop) {
slave_cb->stop(dw->slave_cfg);
}
}
#endif
}
return;
done:
i2c_dw_transfer_complete(port);
}
static int i2c_dw_setup(const struct device *dev, uint16_t slave_address)
{
struct i2c_dw_dev_config *const dw = dev->data;
uint32_t value;
union ic_con_register ic_con;
union ic_tar_register ic_tar;
uint32_t reg_base = get_regs(dev);
#if CONFIG_I2C_ALLOW_NO_STOP_TRANSACTIONS
if (!dw->need_setup) {
return 0;
}
#endif
ic_con.raw = 0U;
/* Disable the device controller to be able set TAR */
clear_bit_enable_en(reg_base);
/* enable bus clear feature */
ic_con.bits.bus_clear = 1U;
/* enable tx empty control to fix timing issue */
ic_con.bits.tx_empty_ctl = 1U;
/* Disable interrupts */
write_intr_mask(0, reg_base);
/* Clear interrupts */
value = read_clr_intr(reg_base);
/* Set master or slave mode - (initialization = slave) */
if (I2C_MODE_CONTROLLER & dw->app_config) {
/*
* Make sure to set both the master_mode and slave_disable_bit
* to both 0 or both 1
*/
LOG_DBG("I2C: host configured as Master Device");
ic_con.bits.master_mode = 1U;
ic_con.bits.slave_disable = 1U;
} else {
return -EINVAL;
}
ic_con.bits.restart_en = 1U;
/* Set addressing mode - (initialization = 7 bit) */
if (I2C_ADDR_10_BITS & dw->app_config) {
LOG_DBG("I2C: using 10-bit address");
ic_con.bits.addr_master_10bit = 1U;
ic_con.bits.addr_slave_10bit = 1U;
}
/* Setup the clock frequency and speed mode */
switch (I2C_SPEED_GET(dw->app_config)) {
case I2C_SPEED_STANDARD:
LOG_DBG("I2C: speed set to STANDARD");
write_ss_scl_lcnt(dw->lcnt, reg_base);
write_ss_scl_hcnt(dw->hcnt, reg_base);
ic_con.bits.speed = I2C_DW_SPEED_STANDARD;
break;
case I2C_SPEED_FAST:
__fallthrough;
case I2C_SPEED_FAST_PLUS:
LOG_DBG("I2C: speed set to FAST or FAST_PLUS");
write_fs_scl_lcnt(dw->lcnt, reg_base);
write_fs_scl_hcnt(dw->hcnt, reg_base);
ic_con.bits.speed = I2C_DW_SPEED_FAST;
break;
case I2C_SPEED_HIGH:
if (!dw->support_hs_mode) {
return -EINVAL;
}
LOG_DBG("I2C: speed set to HIGH");
write_hs_scl_lcnt(dw->lcnt, reg_base);
write_hs_scl_hcnt(dw->hcnt, reg_base);
ic_con.bits.speed = I2C_DW_SPEED_HIGH;
break;
default:
LOG_DBG("I2C: invalid speed requested");
return -EINVAL;
}
LOG_DBG("I2C: lcnt = %d", dw->lcnt);
LOG_DBG("I2C: hcnt = %d", dw->hcnt);
/* Set the IC_CON register */
write_con(ic_con.raw, reg_base);
/* Set RX fifo threshold level.
* Setting it to zero automatically triggers interrupt
* RX_FULL whenever there is data received.
*
* TODO: extend the threshold for multi-byte RX.
*/
write_rx_tl(0, reg_base);
/* Set TX fifo threshold level.
* TX_EMPTY interrupt is triggered only when the
* TX FIFO is truly empty. So that we can let
* the controller do the transfers for longer period
* before we need to fill the FIFO again. This may
* cause some pauses during transfers, but this keeps
* the device from interrupting often.
*/
write_tx_tl(0, reg_base);
ic_tar.raw = read_tar(reg_base);
if (test_bit_con_master_mode(reg_base)) {
/* Set address of target slave */
ic_tar.bits.ic_tar = slave_address;
} else {
/* Set slave address for device */
write_sar(slave_address, reg_base);
}
/* If I2C is being operated in master mode and I2C_DYNAMIC_TAR_UPDATE
* configuration parameter is set to Yes (1), the ic_10bitaddr_master
* bit in ic_tar register would control whether the DW_apb_i2c starts
* its transfers in 7-bit or 10-bit addressing mode.
*/
if (I2C_MODE_CONTROLLER & dw->app_config) {
if (I2C_ADDR_10_BITS & dw->app_config) {
ic_tar.bits.ic_10bitaddr_master = 1U;
} else {
ic_tar.bits.ic_10bitaddr_master = 0U;
}
}
write_tar(ic_tar.raw, reg_base);
#if CONFIG_I2C_ALLOW_NO_STOP_TRANSACTIONS
dw->need_setup = false;
#endif
return 0;
}
bool i2c_dw_is_busy(const struct device *dev)
{
struct i2c_dw_dev_config *const dw = dev->data;
uint32_t reg_base = get_regs(dev);
#if CONFIG_I2C_ALLOW_NO_STOP_TRANSACTIONS
/* The application explicitly started a transaction without
* a STOP. Allow the application to continue sending transactions.
*/
if (!dw->need_setup) {
return false;
}
#endif
if (test_bit_status_activity(reg_base) || (dw->state & I2C_DW_BUSY)) {
return true;
}
return false;
}
static int i2c_dw_transfer(const struct device *dev, struct i2c_msg *msgs, uint8_t num_msgs,
uint16_t slave_address)
{
struct i2c_dw_dev_config *const dw = dev->data;
struct i2c_msg *cur_msg = msgs;
uint8_t msg_left = num_msgs;
uint8_t pflags;
int ret;
uint32_t reg_base = get_regs(dev);
uint32_t value = 0;
__ASSERT_NO_MSG(msgs);
if (!num_msgs) {
return 0;
}
/* semaphore to support I2C_CALLBACK */
ret = k_sem_take(&dw->bus_sem, K_FOREVER);
if (ret != 0) {
return ret;
}
/* check if the state is sda/scl stuck at low state */
if (dw->state & I2C_DW_STUCK_ERR_MASK) {
/* try to recovery */
if (i2c_recovery_bus(dev)) {
ret = -ETIME;
goto error;
}
/* reset state */
dw->state = I2C_DW_STATE_READY;
}
/* First step, check if there is current activity
* Skip if last read did not stop
*/
if (i2c_dw_is_busy(dev)) {
ret = -EBUSY;
goto error;
}
dw->state |= I2C_DW_BUSY;
ret = i2c_dw_setup(dev, slave_address);
if (ret) {
goto error;
}
/* Enable controller */
set_bit_enable_en(reg_base);
/*
* While waiting at device_sync_sem, kernel can switch to idle
* task which in turn can call pm_system_suspend() hook of Power
* Management App (PMA).
* pm_device_busy_set() call here, would indicate to PMA that it should
* not execute PM policies that would turn off this ip block, causing an
* ongoing hw transaction to be left in an inconsistent state.
* Note : This is just a sample to show a possible use of the API, it is
* up to the driver expert to see, if he actually needs it here, or
* somewhere else, or not needed as the driver's suspend()/resume()
* can handle everything
*/
pm_device_busy_set(dev);
/* Process all the messages */
while (msg_left > 0) {
/* Workaround for I2C scanner as DW HW does not support 0 byte transfers.*/
if ((cur_msg->len == 0) && (cur_msg->buf != NULL)) {
cur_msg->len = 1;
}
pflags = dw->xfr_flags;
dw->xfr_buf = cur_msg->buf;
dw->xfr_len = cur_msg->len;
dw->xfr_flags = cur_msg->flags;
dw->rx_pending = 0U;
/* Need to RESTART if changing transfer direction */
if ((pflags & I2C_MSG_RW_MASK) != (dw->xfr_flags & I2C_MSG_RW_MASK)) {
dw->xfr_flags |= I2C_MSG_RESTART;
}
dw->state &= ~(I2C_DW_CMD_SEND | I2C_DW_CMD_RECV);
if ((dw->xfr_flags & I2C_MSG_RW_MASK) == I2C_MSG_WRITE) {
dw->state |= I2C_DW_CMD_SEND;
dw->request_bytes = 0U;
} else {
dw->state |= I2C_DW_CMD_RECV;
dw->request_bytes = dw->xfr_len;
}
/* Enable interrupts to trigger ISR */
if (test_bit_con_master_mode(reg_base)) {
/* Enable necessary interrupts */
write_intr_mask((DW_ENABLE_TX_INT_I2C_MASTER | DW_ENABLE_RX_INT_I2C_MASTER),
reg_base);
} else {
/* Enable necessary interrupts */
write_intr_mask(DW_ENABLE_TX_INT_I2C_SLAVE, reg_base);
}
/* Wait for transfer to be done */
ret = k_sem_take(&dw->device_sync_sem, K_MSEC(CONFIG_I2C_DW_RW_TIMEOUT_MS));
if (ret != 0) {
if (test_bit_con_master_mode(reg_base)) {
/* Trigger abort and wait for it to complete. */
set_bit_enable_abort(reg_base);
(void)k_sem_take(&dw->device_sync_sem, K_MSEC(1));
}
write_intr_mask(DW_DISABLE_ALL_I2C_INT, reg_base);
value = read_clr_intr(reg_base);
ret = -ETIMEDOUT;
k_sem_reset(&dw->device_sync_sem);
break;
}
if (dw->state & I2C_DW_CMD_ERROR) {
ret = -EIO;
break;
}
/* Something wrong if there is something left to do */
if (dw->xfr_len > 0) {
ret = -EIO;
break;
}
if (dw->state & I2C_DW_ERR_MASK) {
if (dw->state & (I2C_DW_SDA_STUCK | I2C_DW_SCL_STUCK)) {
ret = -ETIME;
} else if (dw->state & (I2C_DW_NACK | I2C_DW_CMD_ERROR)) {
ret = -EIO;
}
break;
}
cur_msg++;
msg_left--;
}
pm_device_busy_clear(dev);
error:
/* keep error mask for bus recovery */
dw->state &= I2C_DW_STUCK_ERR_MASK;
k_sem_give(&dw->bus_sem);
return ret;
}
static int i2c_dw_runtime_configure(const struct device *dev, uint32_t config)
{
struct i2c_dw_dev_config *const dw = dev->data;
const struct i2c_dw_rom_config *const rom = dev->config;
uint32_t value = 0U;
uint32_t rc = 0U;
uint32_t reg_base = get_regs(dev);
dw->app_config = config;
/* Make sure we have a supported speed for the DesignWare model */
/* and have setup the clock frequency and speed mode */
switch (I2C_SPEED_GET(dw->app_config)) {
case I2C_SPEED_STANDARD:
/* Following the directions on DW spec page 59, IC_SS_SCL_LCNT
* must have register values larger than IC_FS_SPKLEN + 7
*/
value = I2C_STD_LCNT + rom->lcnt_offset;
if (value <= (read_fs_spklen(reg_base) + 7)) {
value = read_fs_spklen(reg_base) + 8;
}
dw->lcnt = value;
/* Following the directions on DW spec page 59, IC_SS_SCL_HCNT
* must have register values larger than IC_FS_SPKLEN + 5
*/
value = I2C_STD_HCNT + rom->hcnt_offset;
if (value <= (read_fs_spklen(reg_base) + 5)) {
value = read_fs_spklen(reg_base) + 6;
}
dw->hcnt = value;
break;
case I2C_SPEED_FAST:
/*
* Following the directions on DW spec page 59, IC_FS_SCL_LCNT
* must have register values larger than IC_FS_SPKLEN + 7
*/
value = I2C_FS_LCNT + rom->lcnt_offset;
if (value <= (read_fs_spklen(reg_base) + 7)) {
value = read_fs_spklen(reg_base) + 8;
}
dw->lcnt = value;
/*
* Following the directions on DW spec page 59, IC_FS_SCL_HCNT
* must have register values larger than IC_FS_SPKLEN + 5
*/
value = I2C_FS_HCNT + rom->hcnt_offset;
if (value <= (read_fs_spklen(reg_base) + 5)) {
value = read_fs_spklen(reg_base) + 6;
}
dw->hcnt = value;
break;
case I2C_SPEED_FAST_PLUS:
/*