-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSC16IS7XX.c
1704 lines (1445 loc) · 97.2 KB
/
SC16IS7XX.c
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
/*!*****************************************************************************
* @file SC16IS7XX.c
* @author Fabien 'Emandhal' MAILLY
* @version 1.0.2
* @date 18/06/2023
* @brief SC16IS740, SC16IS741, SC16IS741A, SC16IS750, SC16IS752, SC16IS760,
* SC16IS762 driver
* @details The SC16IS7XX component is a Single/Double UART with I2C-bus/SPI
* interface, 64 bytes of transmit and receive FIFOs, IrDA SIR built-in support
* Follow datasheet SC16IS740_750_760 Rev.7 ( 9 June 2011)
* SC16IS741_1 Rev.01 (29 April 2010)
* SC16IS741A Rev.1 (18 March 2013)
* SC16IS752_SC16IS762 Rev.9 (22 March 2012)
* Follow AN10571 - Sleep programming for NXP bridge ICs Rev.01 (7 Jan 2007)
* AN10417 - SC16IS760/762 Fast IrDA mode Rev.01 (8 June 2006)
* AN10386 - Baud rate calculation for Philips UARTs Rev.01 (3 August 2005)
******************************************************************************/
//-----------------------------------------------------------------------------
#include "SC16IS7XX.h"
#include "string.h"
//-----------------------------------------------------------------------------
#ifdef __cplusplus
# include <cstdint>
extern "C" {
#endif
//-----------------------------------------------------------------------------
#ifdef USE_DYNAMIC_INTERFACE
# define GET_I2C_INTERFACE pComp->I2C
# define GET_SPI_INTERFACE pComp->SPI
#else
# define GET_I2C_INTERFACE &pComp->I2C
# define GET_SPI_INTERFACE &pComp->SPI
#endif
//-----------------------------------------------------------------------------
//=============================================================================
// Prototypes for private functions
//=============================================================================
/*! @brief Read data from the SC16IS7XX
*
* @param[in] *pComp Is the pointed structure of the device to be used
* @param[in] channel Is the UART channel where to read data
* @param[in] address Is the address to be read
* @param[out] *data Is where the data will be stored
* @param[in] size Is the size of the data array to read
* @return Returns an #eERRORRESULT value enum
*/
static eERRORRESULT __SC16IS7XX_ReadData(SC16IS7XX *pComp, const eSC16IS7XX_Channel channel, const uint8_t address, uint8_t *data, uint8_t size);
/*! @brief Write data to the SC16IS7XX
*
* @param[in] *pComp Is the pointed structure of the device to be used
* @param[in] channel Is the UART channel where to write data
* @param[in] address Is the address where data will be written
* @param[in] *data Is the data array to write
* @param[in] size Is the size of the data array to write
* @return Returns an #eERRORRESULT value enum
*/
static eERRORRESULT __SC16IS7XX_WriteData(SC16IS7XX *pComp, const eSC16IS7XX_Channel channel, const uint8_t address, uint8_t *data, uint8_t size);
//-----------------------------------------------------------------------------
// DO NOT USE DIRECTLY, use SC16IS7XX_InitUART() instead! Control Flow needs to be configured with a safe UART configuration to avoid spurious effects, which is done in the SC16IS7XX_InitUART() function
static eERRORRESULT __SC16IS7XX_SetControlFlowConfiguration(SC16IS7XX_UART *pUART, SC16IS7XX_HardControlFlow *pHardFlow, SC16IS7XX_SoftControlFlow *pSoftFlow, const uint8_t* pSpecialChar, bool useAdressChar);
// DO NOT USE DIRECTLY, use SC16IS7XX_InitUART() instead! UART configuration needs to be configured with a safe UART configuration to avoid spurious effects, which is done in the SC16IS7XX_InitUART() function
static eERRORRESULT __SC16IS7XX_SetUARTConfiguration(SC16IS7XX_UART *pUART, const SC16IS7XX_UARTconfig *pUARTConf);
// DO NOT USE DIRECTLY, use SC16IS7XX_InitUART() instead! UART configuration needs to be configured with a safe UART configuration to avoid spurious effects, which is done in the SC16IS7XX_InitUART() function
static eERRORRESULT __SC16IS7XX_ConfigureFIFOs(SC16IS7XX_UART *pUART, bool useFIFOs, eSC16IS7XX_IntTxTriggerLevel txTrigLvl, eSC16IS7XX_IntRxTriggerLevel rxTrigLvl);
//-----------------------------------------------------------------------------
#ifdef SC16IS7XX_USE_BUFFERS
//! Transfer available data from Rx buffer of the UART
static void __SC16IS7XX_RxBufferToDataBuff(SC16IS7XX_Buffer* const pBuf, uint8_t *data, size_t *size, size_t *actuallyReceived);
#endif
//-----------------------------------------------------------------------------
#define SC16IS7XX_ABSOLUTE(value) ( (value) < 0.0f ? -(value) : value )
//-----------------------------------------------------------------------------
//=== SC16IS7XX devices limits ================================================
const SC16IS7XX_Limits SC16IS7XX_LIMITS[SC16IS7XX_PN_COUNT] =
{
{ .I2C_CLOCK_MAX = SC16IS7XX_I2C_CLOCK_MAX, .SPI_CLOCK_MAX = SC16IS7XX_SPI_CLOCK_MAX, .IrDA_1_4_RATIO = false, .HAVE_GPIO = false, .HAVE_2_UARTS = false, }, // SC16IS740
{ .I2C_CLOCK_MAX = SC16IS7XX_I2C_CLOCK_MAX, .SPI_CLOCK_MAX = SC16IS7XX_SPI_CLOCK_MAX, .IrDA_1_4_RATIO = false, .HAVE_GPIO = false, .HAVE_2_UARTS = false, }, // SC16IS741/SC16IS741A
{ .I2C_CLOCK_MAX = SC16IS7XX_I2C_CLOCK_MAX, .SPI_CLOCK_MAX = SC16IS7XX_SPI_CLOCK_MAX, .IrDA_1_4_RATIO = false, .HAVE_GPIO = true , .HAVE_2_UARTS = false, }, // SC16IS750
{ .I2C_CLOCK_MAX = SC16IS7XX_I2C_CLOCK_MAX, .SPI_CLOCK_MAX = SC16IS7XX_SPI_CLOCK_MAX, .IrDA_1_4_RATIO = false, .HAVE_GPIO = true , .HAVE_2_UARTS = true , }, // SC16IS752
{ .I2C_CLOCK_MAX = SC16IS7XX_I2C_CLOCK_MAX, .SPI_CLOCK_MAX = SC16IS76X_SPI_CLOCK_MAX, .IrDA_1_4_RATIO = true , .HAVE_GPIO = true , .HAVE_2_UARTS = false, }, // SC16IS760
{ .I2C_CLOCK_MAX = SC16IS7XX_I2C_CLOCK_MAX, .SPI_CLOCK_MAX = SC16IS76X_SPI_CLOCK_MAX, .IrDA_1_4_RATIO = true , .HAVE_GPIO = true , .HAVE_2_UARTS = true , }, // SC16IS762
};
//**********************************************************************************************************************************************************
//=============================================================================
// SC16IS7XX initialization
//=============================================================================
eERRORRESULT Init_SC16IS7XX(SC16IS7XX *pComp, const SC16IS7XX_Config *pConf)
{
#ifdef CHECK_NULL_PARAM
if (pComp == NULL) return ERR__PARAMETER_ERROR;
#endif
eERRORRESULT Error;
//--- Check device configuration --------------------------
if (pComp->DevicePN >= SC16IS7XX_PN_COUNT) return ERR__UNKNOWN_DEVICE;
if ((pComp->XtalFreq != 0) && (pComp->XtalFreq > SC16IS7XX_XTAL_FREQ_MAX)) return ERR__FREQUENCY_ERROR; // The device crystal should not be > 24MHz
if ((pComp->OscFreq != 0) && (pComp->OscFreq > SC16IS7XX_OSC_FREQ_MAX )) return ERR__FREQUENCY_ERROR; // The device oscillator should not be > 80MHz
if ((pComp->XtalFreq == 0) && (pComp->OscFreq == 0)) return ERR__CONFIGURATION; // Both XtalFreq and OscFreq are configured to 0
//--- Configure the Interface -----------------------------
#ifdef SC16IS7XX_I2C_DEFINED
if (pComp->Interface == SC16IS7XX_INTERFACE_I2C)
{
I2C_Interface* pI2C = GET_I2C_INTERFACE;
# if defined(CHECK_NULL_PARAM)
# if defined(USE_DYNAMIC_INTERFACE)
if (pI2C == NULL) return ERR__PARAMETER_ERROR;
# endif
if (pI2C->fnI2C_Init == NULL) return ERR__PARAMETER_ERROR;
# endif
if (pComp->InterfaceClockSpeed > SC16IS7XX_LIMITS[pComp->DevicePN].I2C_CLOCK_MAX) return ERR__I2C_CONFIG_ERROR;
Error = pI2C->fnI2C_Init(pI2C, pComp->InterfaceClockSpeed); // Initialize the I2C interface
if (Error != ERR_OK) return Error; // If there is an error while calling fnI2C_Init() then return the error
if (SC16IS7XX_IsReady(pComp) == false) return ERR__NO_DEVICE_DETECTED; // No device detected
}
#endif
#ifdef SC16IS7XX_SPI_DEFINED
if (pComp->Interface == SC16IS7XX_INTERFACE_SPI)
{
SPI_Interface* pSPI = GET_SPI_INTERFACE;
# if defined(CHECK_NULL_PARAM)
# if defined(USE_DYNAMIC_INTERFACE)
if (pSPI == NULL) return ERR__PARAMETER_ERROR;
# endif
if (pSPI->fnSPI_Init == NULL) return ERR__PARAMETER_ERROR;
# endif
if (pComp->InterfaceClockSpeed > SC16IS7XX_LIMITS[pComp->DevicePN].SPI_CLOCK_MAX) return ERR__SPI_CONFIG_ERROR;
Error = pSPI->fnSPI_Init(pSPI, pComp->SPIchipSelect, SPI_MODE0, pComp->InterfaceClockSpeed); // Initialize the SPI interface
if (Error != ERR_OK) return Error; // If there is an error while calling fnSPI_Init() then return the error
}
#endif
//--- Reset device ----------------------------------------
Error = SC16IS7XX_SoftResetDevice(pComp);
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_SoftResetDevice() then return the Error
//--- Test interface connection ---------------------------
Error = SC16IS7XX_HardwareCommTest(pComp);
if (Error == ERR__BAD_DATA) return ERR__NO_DEVICE_DETECTED; // If there is a bad data error then the device is not detected
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_HardwareCommTest() then return the Error
//--- Configure GPIOs -------------------------------------
if (SC16IS7XX_LIMITS[pComp->DevicePN].HAVE_GPIO && (pConf != NULL)) // Only if device PN have GPIOs and a configuration is available
{
Error = SC16IS7XX_ConfigureGPIOs(pComp, pConf->StartupPinsDirection, pConf->StartupPinsLevel, pConf->PinsInterruptEnable);
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ConfigureGPIOs() then return the error
}
return ERR_OK;
}
//=============================================================================
// Perform a Software Reset the SC16IS7XX
//=============================================================================
eERRORRESULT SC16IS7XX_SoftResetDevice(SC16IS7XX *pComp)
{
eERRORRESULT Error;
Error = SC16IS7XX_WriteRegister(pComp, SC16IS7XX_NO_CHANNEL, RegSC16IS7XX_IOControl, SC16IS7XX_IOCTRL_SOFTWARE_RESET); // Write the IOControl register
if (Error == ERR__I2C_NACK_DATA) return ERR_OK; // Device returns NACK on I2C-bus when set bit "UART software reset" is written
return Error;
}
//=============================================================================
// Hardware communication tests of the SC16IS7XX
//=============================================================================
eERRORRESULT SC16IS7XX_HardwareCommTest(SC16IS7XX *pComp)
{
eERRORRESULT Error;
uint8_t Value;
//--- Test communication ---
Error = SC16IS7XX_WriteRegister(pComp, SC16IS7XX_NO_CHANNEL, RegSC16IS7XX_SPR, 0x55); // Write 0x55 to Scratchpad Register
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_WriteRegister() then return the Error
Error = SC16IS7XX_ReadRegister(pComp, SC16IS7XX_NO_CHANNEL, RegSC16IS7XX_SPR, &Value); // Read the Scratchpad Register
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ReadRegister() then return the Error
if (Value != 0x55) return ERR__BAD_DATA; // If the read back value is not the same as the one written, return an error
Error = SC16IS7XX_WriteRegister(pComp, SC16IS7XX_NO_CHANNEL, RegSC16IS7XX_SPR, 0xAA); // Write 0xAA to Scratchpad Register
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_WriteRegister() then return the Error
Error = SC16IS7XX_ReadRegister(pComp, SC16IS7XX_NO_CHANNEL, RegSC16IS7XX_SPR, &Value); // Read the Scratchpad Register
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ReadRegister() then return the Error
if (Value != 0xAA) return ERR__BAD_DATA; // If the read back value is not the same as the one written, return an error
return ERR_OK;
}
//**********************************************************************************************************************************************************
#ifdef SC16IS7XX_I2C_DEFINED
//=============================================================================
// Is the SC16IS7XX device ready
//=============================================================================
bool SC16IS7XX_IsReady(SC16IS7XX *pComp)
{
#ifdef CHECK_NULL_PARAM
if (pComp == NULL) return false;
#endif
I2C_Interface* pI2C = GET_I2C_INTERFACE;
#if defined(CHECK_NULL_PARAM)
# if defined(USE_DYNAMIC_INTERFACE)
if (pI2C == NULL) return false;
# endif
if (pI2C->fnI2C_Transfer == NULL) return false;
#endif
I2CInterface_Packet PacketDesc = I2C_INTERFACE8_NO_DATA_DESC(pComp->I2Caddress & I2C_WRITE_ANDMASK);
return (pI2C->fnI2C_Transfer(pI2C, &PacketDesc) == ERR_OK); // Send only the chip address and get the Ack flag
}
#endif
//=============================================================================
// [STATIC] Read data from the SC16IS7XX
//=============================================================================
eERRORRESULT __SC16IS7XX_ReadData(SC16IS7XX *pComp, const eSC16IS7XX_Channel channel, const uint8_t address, uint8_t *data, uint8_t size)
{
#ifdef CHECK_NULL_PARAM
if (pComp == NULL) return ERR__PARAMETER_ERROR;
#endif
if (size == 0) return ERR_OK;
eERRORRESULT Error = ERR_OK;
uint8_t Address = SC16IS7XX_CHANNEL_SET(channel) | SC16IS7XX_ADDRESS_SET(address);
#ifdef SC16IS7XX_I2C_DEFINED
if (pComp->Interface == SC16IS7XX_INTERFACE_I2C)
{
I2C_Interface* pI2C = GET_I2C_INTERFACE;
# if defined(CHECK_NULL_PARAM)
# if defined(USE_DYNAMIC_INTERFACE)
if (pI2C == NULL) return ERR__PARAMETER_ERROR;
# endif
if (pI2C->fnI2C_Transfer == NULL) return ERR__PARAMETER_ERROR;
# endif
uint8_t ChipAddrW = (pComp->I2Caddress & I2C_WRITE_ANDMASK);
uint8_t ChipAddrR = (ChipAddrW | I2C_READ_ORMASK);
//--- Send the address ---
I2CInterface_Packet AddrPacketDesc = I2C_INTERFACE8_TX_DATA_DESC(ChipAddrW, true, &Address, sizeof(uint8_t), false, I2C_WRITE_THEN_READ_FIRST_PART);
Error = pI2C->fnI2C_Transfer(pI2C, &AddrPacketDesc); // Transfer the address
if (Error == ERR__I2C_NACK) return ERR__NOT_READY; // If the device receive a NAK, then the device is not ready
if (Error != ERR_OK) return Error; // If there is an error while calling fnI2C_Transfer() then return the Error
//--- Get the data ---
I2CInterface_Packet DataPacketDesc = I2C_INTERFACE8_RX_DATA_DESC(ChipAddrR, true, data, size, true, I2C_WRITE_THEN_READ_SECOND_PART);
Error = pI2C->fnI2C_Transfer(pI2C, &DataPacketDesc); // Restart at first data read transfer, get the data and stop transfer at last byte
}
#endif
#ifdef SC16IS7XX_SPI_DEFINED
if (pComp->Interface == SC16IS7XX_INTERFACE_SPI)
{
SPI_Interface* pSPI = GET_SPI_INTERFACE;
# if defined(CHECK_NULL_PARAM)
# if defined(USE_DYNAMIC_INTERFACE)
if (pSPI == NULL) return ERR__PARAMETER_ERROR;
# endif
if (pSPI->fnSPI_Transfer == NULL) return ERR__PARAMETER_ERROR;
# endif
Address |= SC16IS7XX_SPI_READ;
//--- Send the address ---
SPIInterface_Packet AddrPacketDesc = SPI_INTERFACE_TX_DATA_DESC(&Address, sizeof(uint8_t), false); // Prepare SPI packet description to use
Error = pSPI->fnSPI_Transfer(pSPI, &AddrPacketDesc); // Transfer the address
if (Error != ERR_OK) return Error; // If there is an error while calling fnSPI_Transfer() then return the Error
//--- Get the data ---
SPIInterface_Packet DataPacketDesc = SPI_INTERFACE_RX_DATA_WITH_DUMMYBYTE_DESC(0x00, data, size, true); // Prepare SPI packet description to use
Error = pSPI->fnSPI_Transfer(pSPI, &DataPacketDesc); // Get the data and stop transfer at last byte
}
#endif
return Error;
}
//=============================================================================
// Read a register of the SC16IS7XX
//=============================================================================
inline eERRORRESULT SC16IS7XX_ReadRegister(SC16IS7XX *pComp, const eSC16IS7XX_Channel channel, const uint8_t registerAddr, uint8_t *registerValue)
{
return __SC16IS7XX_ReadData(pComp, channel, registerAddr, registerValue, 1);
}
//=============================================================================
// [STATIC] Write data to the SC16IS7XX
//=============================================================================
eERRORRESULT __SC16IS7XX_WriteData(SC16IS7XX *pComp, const eSC16IS7XX_Channel channel, const uint8_t address, uint8_t *data, uint8_t size)
{
#ifdef CHECK_NULL_PARAM
if (pComp == NULL) return ERR__PARAMETER_ERROR;
#endif
if (size == 0) return ERR_OK;
eERRORRESULT Error = ERR_OK;
uint8_t Address = SC16IS7XX_CHANNEL_SET(channel) | SC16IS7XX_ADDRESS_SET(address) | SC16IS7XX_SPI_WRITE;
#ifdef SC16IS7XX_I2C_DEFINED
if (pComp->Interface == SC16IS7XX_INTERFACE_I2C)
{
I2C_Interface* pI2C = GET_I2C_INTERFACE;
# if defined(CHECK_NULL_PARAM)
# if defined(USE_DYNAMIC_INTERFACE)
if (pI2C == NULL) return ERR__PARAMETER_ERROR;
# endif
if (pI2C->fnI2C_Transfer == NULL) return ERR__PARAMETER_ERROR;
# endif
uint8_t ChipAddrW = (pComp->I2Caddress & I2C_WRITE_ANDMASK);
//--- Send the address ---
I2CInterface_Packet AddrPacketDesc = I2C_INTERFACE8_TX_DATA_DESC(ChipAddrW, true, &Address, sizeof(uint8_t), false, I2C_WRITE_THEN_WRITE_FIRST_PART);
Error = pI2C->fnI2C_Transfer(pI2C, &AddrPacketDesc); // Transfer the address
if (Error == ERR__I2C_NACK) return ERR__NOT_READY; // If the device receive a NAK, then the device is not ready
if (Error == ERR__I2C_NACK_DATA) return ERR__I2C_INVALID_ADDRESS; // If the device receive a NAK while transferring data, then this is an invalid address
if (Error != ERR_OK) return Error; // If there is an error while calling fnI2C_Transfer() then return the Error
//--- Send the data ---
I2CInterface_Packet DataPacketDesc = I2C_INTERFACE8_TX_DATA_DESC(ChipAddrW, false, data, size, true, I2C_WRITE_THEN_WRITE_SECOND_PART);
Error = pI2C->fnI2C_Transfer(pI2C, &DataPacketDesc); // Continue by transferring the data, and stop transfer at last byte
}
#endif
#ifdef SC16IS7XX_SPI_DEFINED
if (pComp->Interface == SC16IS7XX_INTERFACE_SPI)
{
SPI_Interface* pSPI = GET_SPI_INTERFACE;
# if defined(CHECK_NULL_PARAM)
# if defined(USE_DYNAMIC_INTERFACE)
if (pSPI == NULL) return ERR__PARAMETER_ERROR;
# endif
if (pSPI->fnSPI_Transfer == NULL) return ERR__PARAMETER_ERROR;
# endif
//--- Send the address ---
SPIInterface_Packet AddrPacketDesc = SPI_INTERFACE_TX_DATA_DESC(&Address, sizeof(uint8_t), false); // Prepare SPI packet description to use
Error = pSPI->fnSPI_Transfer(pSPI, &AddrPacketDesc); // Transfer the address
if (Error != ERR_OK) return Error; // If there is an error while calling fnSPI_Transfer() then return the Error
//--- Send the data ---
SPIInterface_Packet DataPacketDesc = SPI_INTERFACE_TX_DATA_DESC(data, size, true); // Prepare SPI packet description to use
Error = pSPI->fnSPI_Transfer(pSPI, &DataPacketDesc); // Send the data and stop transfer at last byte
}
#endif
return Error;
}
//=============================================================================
// Write a register of the SC16IS7XX
//=============================================================================
inline eERRORRESULT SC16IS7XX_WriteRegister(SC16IS7XX *pComp, const eSC16IS7XX_Channel channel, const uint8_t registerAddr, uint8_t registerValue)
{
return __SC16IS7XX_WriteData(pComp, channel, registerAddr, ®isterValue, 1);
}
//=============================================================================
// Modify a register of the SC16IS7XX
//=============================================================================
eERRORRESULT SC16IS7XX_ModifyRegister(SC16IS7XX *pComp, const eSC16IS7XX_Channel channel, const uint8_t registerAddr, uint8_t registerValue, uint8_t registerMask)
{
eERRORRESULT Error;
uint8_t RegValue;
Error = SC16IS7XX_ReadRegister(pComp, channel, registerAddr, &RegValue); // Read the register value
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ReadRegister() then return the error
RegValue &= ~registerMask; // Clear bits to modify
RegValue |= (registerValue & registerMask); // Set the new value
return SC16IS7XX_WriteRegister(pComp, channel, registerAddr, RegValue); // Write the value to register
}
//=============================================================================
// Set register access of the SC16IS7XX
//=============================================================================
eERRORRESULT SC16IS7XX_SetRegisterAccess(SC16IS7XX *pComp, const eSC16IS7XX_Channel channel, eSC16IS7XX_AccessTo setAccessTo, uint8_t *originalLCRregValue)
{
eERRORRESULT Error;
Error = SC16IS7XX_ReadRegister(pComp, channel, RegSC16IS7XX_LCR, originalLCRregValue); // Read the LCR register
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ReadRegister() then return the error
return SC16IS7XX_WriteRegister(pComp, channel, RegSC16IS7XX_LCR, setAccessTo); // Write the LCR register
}
//=============================================================================
// Return access to general registers of the SC16IS7XX
//=============================================================================
eERRORRESULT SC16IS7XX_ReturnAccessToGeneralRegister(SC16IS7XX *pComp, const eSC16IS7XX_Channel channel, uint8_t originalLCRregValue)
{
originalLCRregValue &= SC16IS7XX_LCR_VALUE_SET_GENERAL_REGISTER; // Force access to general registers
return SC16IS7XX_WriteRegister(pComp, channel, RegSC16IS7XX_LCR, originalLCRregValue); // Write the LCR register
}
//**********************************************************************************************************************************************************
//=============================================================================
// Enable Enhanced Functions of the SC16IS7XX device
//=============================================================================
eERRORRESULT SC16IS7XX_EnableEnhancedFunctions(SC16IS7XX *pComp, eSC16IS7XX_Channel channel)
{
eERRORRESULT Error;
//--- Enable access to enhanced registers ---
SC16IS7XX_LCR_Register OriginalLCR;
Error = SC16IS7XX_SetRegisterAccess(pComp, channel, SC16IS7XX_LCR_VALUE_SET_ENHANCED_FEATURE_REGISTER, &OriginalLCR.LCR);
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_SetRegisterAccess() then return the error
//--- Enable Enhanced Functions ---
Error = SC16IS7XX_ModifyRegister(pComp, channel, RegSC16IS7XX_EFR, SC16IS7XX_EFR_ENHANCED_FUNCTION_ENABLE, SC16IS7XX_EFR_ENHANCED_FUNCTION_Mask);
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ReadRegister() then return the error
//--- Return access to general registers ---
return SC16IS7XX_ReturnAccessToGeneralRegister(pComp, channel, OriginalLCR.LCR); // Return access to general registers
}
//**********************************************************************************************************************************************************
//=============================================================================
// Verify if the SC16IS7XX device has sleep mode enabled
//=============================================================================
eERRORRESULT SC16IS7XX_IsDeviceInSleepMode(SC16IS7XX *pComp, bool* isSleepModeEnable)
{
#ifdef CHECK_NULL_PARAM
if (isSleepModeEnable == NULL) return ERR__PARAMETER_ERROR;
#endif
eERRORRESULT Error;
SC16IS7XX_IER_Register RegIER;
Error = SC16IS7XX_ReadRegister(pComp, SC16IS7XX_NO_CHANNEL, RegSC16IS7XX_IER, &RegIER.IER); // Read the IER register
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ReadRegister() then return the error
*isSleepModeEnable = ((RegIER.IER & SC16IS7XX_IER_SLEEP_MODE_ENABLE) > 0);
return ERR_OK;
}
//**********************************************************************************************************************************************************
//=============================================================================
// Configure GPIOs of the SC16IS7XX device
//=============================================================================
eERRORRESULT SC16IS7XX_ConfigureGPIOs(SC16IS7XX *pComp, uint8_t pinsDirection, uint8_t pinsLevel, uint8_t pinsInterruptEnable)
{
#ifdef CHECK_NULL_PARAM
if (pComp == NULL) return ERR__PARAMETER_ERROR;
#endif
eERRORRESULT Error;
if (SC16IS7XX_LIMITS[pComp->DevicePN].HAVE_GPIO == false) return ERR__NOT_SUPPORTED; // Only if the device have I/O pins
Error = SC16IS7XX_SetGPIOPinsDirection(pComp, pinsDirection, 0xFF); // Write the GPIOs pin direction
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_SetGPIOPinsDirection() then return the error
Error = SC16IS7XX_SetGPIOPinsOutputLevel(pComp, pinsLevel, 0xFF); // Write the GPIOs output level
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_SetGPIOPinsOutputLevel() then return the error
return SC16IS7XX_SetGPIOPinsInterruptEnable(pComp, pinsInterruptEnable, 0xFF); // Write the pin interrupt enable
}
//=============================================================================
// Set I/O pins direction of the SC16IS7XX
//=============================================================================
eERRORRESULT SC16IS7XX_SetGPIOPinsDirection(SC16IS7XX *pComp, const uint8_t pinsDirection, const uint8_t pinsChangeMask)
{
#ifdef CHECK_NULL_PARAM
if (pComp == NULL) return ERR__PARAMETER_ERROR;
#endif
if (SC16IS7XX_LIMITS[pComp->DevicePN].HAVE_GPIO == false) return ERR__NOT_SUPPORTED; // Only if the device have I/O pins
pComp->GPIOsOutDir &= ~pinsChangeMask; // Force change bits to 0
pComp->GPIOsOutDir |= (~pinsDirection & pinsChangeMask); // Apply new direction only on changed pins. Invert pin direction to fit GPIO_Interface logic
return SC16IS7XX_WriteRegister(pComp, SC16IS7XX_NO_CHANNEL, RegSC16IS7XX_IODir, pComp->GPIOsOutDir);
}
//=============================================================================
// Get I/O pins input level of the SC16IS7XX
//=============================================================================
eERRORRESULT SC16IS7XX_GetGPIOPinsInputLevel(SC16IS7XX *pComp, uint8_t *pinsState)
{
#ifdef CHECK_NULL_PARAM
if ((pComp == NULL) || (pinsState == NULL)) return ERR__PARAMETER_ERROR;
#endif
if (SC16IS7XX_LIMITS[pComp->DevicePN].HAVE_GPIO == false) return ERR__NOT_SUPPORTED; // Only if the device have I/O pins
return SC16IS7XX_ReadRegister(pComp, SC16IS7XX_NO_CHANNEL, RegSC16IS7XX_IOState, pinsState); // Read the IOState register
}
//=============================================================================
// Set I/O pins output level of the SC16IS7XX
//=============================================================================
eERRORRESULT SC16IS7XX_SetGPIOPinsOutputLevel(SC16IS7XX *pComp, const uint8_t pinsLevel, const uint8_t pinsChangeMask)
{
#ifdef CHECK_NULL_PARAM
if (pComp == NULL) return ERR__PARAMETER_ERROR;
#endif
if (SC16IS7XX_LIMITS[pComp->DevicePN].HAVE_GPIO == false) return ERR__NOT_SUPPORTED; // Only if the device have I/O pins
pComp->GPIOsOutLevel &= ~pinsChangeMask; // Force change bits to 0
pComp->GPIOsOutLevel |= (pinsLevel & pinsChangeMask); // Apply new output level only on changed pins
return SC16IS7XX_WriteRegister(pComp, SC16IS7XX_NO_CHANNEL, RegSC16IS7XX_IOState, pComp->GPIOsOutLevel); // Write the IOState register
}
//-----------------------------------------------------------------------------
#ifdef USE_GENERICS_DEFINED
//=============================================================================
// Set PORT direction of the SC16IS7XX device
//=============================================================================
eERRORRESULT SC16IS7XX_SetPORTdirection_Gen(PORT_Interface *pIntDev, const uint32_t pinsDirection)
{
#ifdef CHECK_NULL_PARAM
if (pIntDev == NULL) return ERR__NULL_POINTER;
#endif
if (pIntDev->UniqueID != SC16IS7XX_UNIQUE_ID) return ERR__UNKNOWN_ELEMENT;
SC16IS7XX* pDevice = (SC16IS7XX*)(pIntDev->InterfaceDevice); // Get the MCP251XFD device of this GPIO port
#ifdef CHECK_NULL_PARAM
if (pDevice == NULL) return ERR__UNKNOWN_DEVICE;
#endif
return SC16IS7XX_SetGPIOPinsDirection(pDevice, (uint8_t)pinsDirection, 0xFF);
}
//=============================================================================
// Get PORT pins input level of the SC16IS7XX device
//=============================================================================
eERRORRESULT SC16IS7XX_GetPORTinputLevel_Gen(PORT_Interface *pIntDev, uint32_t *pinsLevel)
{
#ifdef CHECK_NULL_PARAM
if (pIntDev == NULL) return ERR__NULL_POINTER;
#endif
if (pIntDev->UniqueID != SC16IS7XX_UNIQUE_ID) return ERR__UNKNOWN_ELEMENT;
SC16IS7XX* pDevice = (SC16IS7XX*)(pIntDev->InterfaceDevice); // Get the MCP251XFD device of this GPIO port
#ifdef CHECK_NULL_PARAM
if (pDevice == NULL) return ERR__UNKNOWN_DEVICE;
#endif
uint8_t Value = 0;
eERRORRESULT Error = SC16IS7XX_GetGPIOPinsInputLevel(pDevice, &Value);
*pinsLevel = Value;
return Error;
}
//=============================================================================
// Set PORT pins output level of the SC16IS7XX device
//=============================================================================
eERRORRESULT SC16IS7XX_SetPORToutputLevel_Gen(PORT_Interface *pIntDev, const uint32_t pinsLevel)
{
#ifdef CHECK_NULL_PARAM
if (pIntDev == NULL) return ERR__NULL_POINTER;
#endif
if (pIntDev->UniqueID != SC16IS7XX_UNIQUE_ID) return ERR__UNKNOWN_ELEMENT;
SC16IS7XX* pDevice = (SC16IS7XX*)(pIntDev->InterfaceDevice); // Get the MCP251XFD device of this GPIO port
#ifdef CHECK_NULL_PARAM
if (pDevice == NULL) return ERR__UNKNOWN_DEVICE;
#endif
return SC16IS7XX_SetGPIOPinsOutputLevel(pDevice, (uint8_t)pinsLevel, 0xFF);
}
//-----------------------------------------------------------------------------
//=============================================================================
// Set a pin on PORT direction of the SC16IS7XX device
//=============================================================================
eERRORRESULT SC16IS7XX_SetPinState_Gen(GPIO_Interface *pIntDev, const eGPIO_State pinState)
{
#ifdef CHECK_NULL_PARAM
if (pIntDev == NULL) return ERR__NULL_POINTER;
#endif
if (pIntDev->UniqueID != SC16IS7XX_UNIQUE_ID) return ERR__UNKNOWN_ELEMENT;
SC16IS7XX* pDevice = (SC16IS7XX*)(pIntDev->InterfaceDevice); // Get the MCP251XFD device of this GPIO port
#ifdef CHECK_NULL_PARAM
if (pDevice == NULL) return ERR__UNKNOWN_DEVICE;
#endif
switch (pinState)
{
default: break;
case GPIO_STATE_OUTPUT: return SC16IS7XX_SetGPIOPinsDirection(pDevice, 0x00, pIntDev->PinBitMask);
case GPIO_STATE_INPUT : return SC16IS7XX_SetGPIOPinsDirection(pDevice, pIntDev->PinBitMask, pIntDev->PinBitMask);
case GPIO_STATE_RESET : return SC16IS7XX_SetGPIOPinsOutputLevel(pDevice, 0x00, pIntDev->PinBitMask);
case GPIO_STATE_SET : return SC16IS7XX_SetGPIOPinsOutputLevel(pDevice, pIntDev->PinBitMask, pIntDev->PinBitMask);
case GPIO_STATE_TOGGLE: return SC16IS7XX_SetGPIOPinsOutputLevel(pDevice, pDevice->GPIOsOutLevel ^ (uint8_t)pIntDev->PinBitMask, pIntDev->PinBitMask);
}
return ERR__PARAMETER_ERROR;
}
//=============================================================================
// Get a pin on PORT input level of the SC16IS7XX device
//=============================================================================
eERRORRESULT SC16IS7XX_GetPinInputLevel_Gen(GPIO_Interface *pIntDev, eGPIO_State *pinLevel)
{
#ifdef CHECK_NULL_PARAM
if (pIntDev == NULL) return ERR__NULL_POINTER;
#endif
if (pIntDev->UniqueID != SC16IS7XX_UNIQUE_ID) return ERR__UNKNOWN_ELEMENT;
SC16IS7XX* pDevice = (SC16IS7XX*)(pIntDev->InterfaceDevice); // Get the MCP251XFD device of this GPIO port
#ifdef CHECK_NULL_PARAM
if (pDevice == NULL) return ERR__UNKNOWN_DEVICE;
#endif
uint8_t PinState = 0;
eERRORRESULT Error = SC16IS7XX_GetGPIOPinsInputLevel(pDevice, &PinState);
*pinLevel = (PinState > 0 ? GPIO_STATE_SET : GPIO_STATE_RESET);
return Error;
}
#endif
//-----------------------------------------------------------------------------
//=============================================================================
// Set I/O pins interrupt enable of the SC16IS7XX
//=============================================================================
eERRORRESULT SC16IS7XX_SetGPIOPinsInterruptEnable(SC16IS7XX *pComp, uint8_t pinsIntEna, uint8_t pinsChangeMask)
{
#ifdef CHECK_NULL_PARAM
if (pComp == NULL) return ERR__PARAMETER_ERROR;
#endif
if (SC16IS7XX_LIMITS[pComp->DevicePN].HAVE_GPIO == false) return ERR__NOT_SUPPORTED; // Only if the device have I/O pins
return SC16IS7XX_ModifyRegister(pComp, SC16IS7XX_NO_CHANNEL, RegSC16IS7XX_IOIntEna, pinsIntEna, pinsChangeMask);
}
//-----------------------------------------------------------------------------
//**********************************************************************************************************************************************************
//=============================================================================
// SC16IS7XX UART initialization
//=============================================================================
eERRORRESULT SC16IS7XX_InitUART(SC16IS7XX_UART *pUART, const SC16IS7XX_UARTconfig *pUARTConf)
{
#ifdef CHECK_NULL_PARAM
if ((pUART == NULL) || (pUARTConf == NULL)) return ERR__PARAMETER_ERROR;
#endif
SC16IS7XX* pComp = pUART->Device; // Get the SC16IS7XX device of this UART
#ifdef CHECK_NULL_PARAM
if (pComp == NULL) return ERR__UNKNOWN_DEVICE;
#endif
SC16IS7XX_UARTconfig *pConf = (SC16IS7XX_UARTconfig*)pUARTConf;
eERRORRESULT Error;
//--- Check the UART channel ------------------------------
if (pUART->Channel >= SC16IS7XX_CHANNEL_COUNT) return ERR__UNKNOWN_ELEMENT;
if ((pUART->Channel == SC16IS7XX_CHANNEL_B) && (SC16IS7XX_LIMITS[pComp->DevicePN].HAVE_2_UARTS == false)) return ERR__UNKNOWN_ELEMENT;
#ifdef SC16IS7XX_USE_BUFFERS
//--- Configure buffers ---
if (pUART->TxBuffer.pData != NULL)
{
pUART->TxBuffer.PosIn = pUART->TxBuffer.PosOut = 0;
pUART->TxBuffer.IsFull = false;
}
if (pUART->RxBuffer.pData != NULL)
{
pUART->RxBuffer.PosIn = pUART->RxBuffer.PosOut = 0;
pUART->RxBuffer.IsFull = false;
}
#endif
//--- Enable Enhanced Functions ---------------------------
Error = SC16IS7XX_EnableEnhancedFunctions(pComp, pUART->Channel); // Enable the enhanced function of the UART channel
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_EnableEnhancedFunctions() then return the error
//--- Enable TCR and TLR ---
Error = SC16IS7XX_ModifyRegister(pComp, pUART->Channel, RegSC16IS7XX_MCR, SC16IS7XX_MCR_TCR_AND_TLR_REGISTER_ENABLE, SC16IS7XX_MCR_TCR_AND_TLR_REGISTER_Mask);
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ModifyRegister() then return the error
//--- Disable Interrupts, Tx, Rx and clear FIFOs ----------
SC16IS7XX_IER_Register OriginalIER;
Error = SC16IS7XX_ReadRegister(pComp, pUART->Channel, RegSC16IS7XX_IER, &OriginalIER.IER); // Read and save configuration of the IER register
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ReadRegister() then return the error
Error = SC16IS7XX_WriteRegister(pComp, pUART->Channel, RegSC16IS7XX_IER, 0x00); // Disable all interrupts. And with this, the device sleep will be disabled
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_WriteRegister() then return the error
Error = SC16IS7XX_TxRxDisable(pUART, true, true); // Disable Transmitter and receiver
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_TxRxDisable() then return the error
Error = SC16IS7XX_ResetFIFO(pUART, true, true); // Reset and clear Transmit and receive FIFOs
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ResetFIFO() then return the error
//--- Disable control flow --------------------------------
Error = __SC16IS7XX_SetControlFlowConfiguration(pUART, NULL, NULL, NULL, false); // Disable the control flow
if (Error != ERR_OK) return Error; // If there is an error while calling __SC16IS7XX_SetControlFlowConfiguration() then return the error
//--- Set UART configuration ------------------------------
Error = __SC16IS7XX_SetUARTConfiguration(pUART, pUARTConf); // Configure UART
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_SetUARTConfiguration() then return the error
//--- Set Baudrate ----------------------------------------
Error = SC16IS7XX_SetUARTBaudRate(pUART, pUARTConf); // Configure UART baudrate
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_SetUARTBaudRate() then return the error
//--- Set FIFO configuration ------------------------------
Error = __SC16IS7XX_ConfigureFIFOs(pUART, pUARTConf->UseFIFOs, pUARTConf->TxTrigLvl, pUARTConf->RxTrigLvl); // Configure FIFOs
if (Error != ERR_OK) return Error; // If there is an error while calling __SC16IS7XX_ConfigureFIFOs() then return the error
//--- Return to original interrupt configuration ----------
Error = SC16IS7XX_WriteRegister(pComp, pUART->Channel, RegSC16IS7XX_IER, OriginalIER.IER); // Re-enable previous interrupts with the sleep state if previously set
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_WriteRegister() then return the error
//--- Transmitter and receiver configuration --------------
Error = SC16IS7XX_TxRxDisable(pUART, pUARTConf->DisableTransmitter, pUARTConf->DisableReceiver); // Disable Transmitter and receiver
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_TxRxDisable() then return the error
//--- Test UART connection --------------------------------
if (((pUART->DriverConfig & SC16IS7XX_TEST_LOOPBACK_AT_INIT) > 0) && (pUARTConf->DisableTransmitter == false) && (pUARTConf->DisableReceiver == false)) // If a UART loopback test is asked...
{
Error = SC16IS7XX_UARTCommTest(pUART); // Test the UART before Control Flow because the Control Flow may interfere with the test
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_UARTCommTest() then return the error
}
//--- Set Control Flow ------------------------------------
SC16IS7XX_HardControlFlow* pHardFlow = NULL;
SC16IS7XX_SoftControlFlow* pSoftFlow = NULL;
const uint8_t* pSpecialChar = (pUARTConf->UseSpecialChar ? &pUARTConf->SpecialChar : NULL);
bool UseAddressChar = false;
switch (pUARTConf->UARTtype)
{
case SC16IS7XX_UART_RS232:
switch (pUARTConf->RS232.ControlFlowType)
{
case SC16IS7XX_NO_CONTROL_FLOW:
default: break;
case SC16IS7XX_HARDWARE_CONTROL_FLOW: pHardFlow = &pConf->RS232.HardFlowControl; break;
case SC16IS7XX_SOFTWARE_CONTROL_FLOW: pSoftFlow = &pConf->RS232.SoftFlowControl; break;
}
break;
case SC16IS7XX_UART_RS485:
if (pUARTConf->RS485.UseHardwareControlFlow) pHardFlow = &pConf->RS485.HardFlowControl;
if (pUARTConf->RS485.AutoRS485mode == SC16IS7XX_AUTO_ADDRESS_DETECT) UseAddressChar = true;
break;
case SC16IS7XX_UART_IrDA:
if (pUARTConf->IrDA.UseSoftwareControlFlow) pSoftFlow = &pConf->IrDA.SoftFlowControl;
break;
case SC16IS7XX_UART_Modem:
if (pUARTConf->Modem.UseHardwareControlFlow) pHardFlow = &pConf->Modem.HardFlowControl;
break;
default: break;
}
if ((pHardFlow != NULL) || (pSoftFlow != NULL) || (pSpecialChar != NULL))
Error = __SC16IS7XX_SetControlFlowConfiguration(pUART, pHardFlow, pSoftFlow, pSpecialChar, UseAddressChar); // Configure the control flow
if (Error != ERR_OK) return Error; // If there is an error while calling __SC16IS7XX_SetControlFlowConfiguration() then return the error
//--- Disable TCR and TLR access --------------------------
Error = SC16IS7XX_ModifyRegister(pComp, pUART->Channel, RegSC16IS7XX_MCR, SC16IS7XX_MCR_TCR_AND_TLR_REGISTER_DISABLE, SC16IS7XX_MCR_TCR_AND_TLR_REGISTER_Mask);
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ModifyRegister() then return the error
//--- Configure interrupts --------------------------------
return SC16IS7XX_ConfigureInterrupt(pUART, pConf->Interrupts);
}
//=============================================================================
// UART communication tests of the SC16IS7XX UART
//=============================================================================
eERRORRESULT SC16IS7XX_UARTCommTest(SC16IS7XX_UART *pUART)
{
#ifdef CHECK_NULL_PARAM
if (pUART == NULL) return ERR__PARAMETER_ERROR;
#endif
SC16IS7XX* pComp = pUART->Device; // Get the SC16IS7XX device of this UART
#ifdef CHECK_NULL_PARAM
if (pComp == NULL) return ERR__UNKNOWN_DEVICE;
#endif
eERRORRESULT Error;
setSC16IS7XX_ReceiveError CharError;
char Value;
//--- Set UART in loopback mode ---
SC16IS7XX_MCR_Register RegMCR;
Error = SC16IS7XX_ReadRegister(pComp, pUART->Channel, RegSC16IS7XX_MCR, &RegMCR.MCR); // Read the MCR register
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ReadRegister() then return the error
RegMCR.MCR |= SC16IS7XX_MCR_LOOPBACK_ENABLE; // Set enable local Loopback mode (internal)
Error = SC16IS7XX_WriteRegister(pComp, pUART->Channel, RegSC16IS7XX_MCR, RegMCR.MCR); // Write the MCR register
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_WriteRegister() then return the error
//--- Reset UART FIFOs ---
Error = SC16IS7XX_ResetFIFO(pUART, true, true); // Reset both Transmit and Receive FIFOs
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ResetFIFO() then return the error
//--- Test UART communication ---
Error = SC16IS7XX_TransmitChar(pUART, (char)(0x55 & 0x1F)); // Transmit char 0x55 (reduced to 5 bits for 5-bits compatibility) by UART
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_TransmitCharByUART() then return the error
Error = SC16IS7XX_ReceiveChar(pUART, &Value, &CharError); // Receive a char UART by UART
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ReceiveCharByUART() then return the error
if (CharError != SC16IS7XX_NO_RX_ERROR) return ERR__PERIPHERAL_NOT_VALID; // If the received data create an error then the peripheral is not valid
if (Value != (char)(0x55 & 0x1F)) return ERR__PERIPHERAL_NOT_VALID; // If the read back value is not the same as the one written, return an error
Error = SC16IS7XX_TransmitChar(pUART, (char)(0xAA & 0x1F)); // Transmit char 0xAA (reduced to 5 bits for 5-bits compatibility) by UART
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_TransmitCharByUART() then return the error
Error = SC16IS7XX_ReceiveChar(pUART, &Value, &CharError); // Receive a char UART by UART
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ReceiveCharByUART() then return the error
if (CharError != SC16IS7XX_NO_RX_ERROR) return ERR__PERIPHERAL_NOT_VALID; // If the received data create an error then the peripheral is not valid
if (Value != (char)(0xAA & 0x1F)) return ERR__PERIPHERAL_NOT_VALID; // If the read back value is not the same as the one written, return an error
RegMCR.MCR &= SC16IS7XX_MCR_NORMAL_OPERATING_MODE; // Set normal operating mode
return SC16IS7XX_WriteRegister(pComp, pUART->Channel, RegSC16IS7XX_MCR, RegMCR.MCR); // Write the MCR register
}
//=============================================================================
// [STATIC] Set UART configuration of the SC16IS7XX UART
//=============================================================================
// DO NOT USE DIRECTLY, use SC16IS7XX_InitUART() instead! UART configuration needs to be configured with a safe UART configuration to avoid spurious effects, which is done in the SC16IS7XX_InitUART() function
eERRORRESULT __SC16IS7XX_SetUARTConfiguration(SC16IS7XX_UART *pUART, const SC16IS7XX_UARTconfig *pUARTConf)
{
#ifdef CHECK_NULL_PARAM
if ((pUART == NULL) || (pUARTConf == NULL)) return ERR__PARAMETER_ERROR;
#endif
SC16IS7XX* pComp = pUART->Device; // Get the SC16IS7XX device of this UART
#ifdef CHECK_NULL_PARAM
if (pComp == NULL) return ERR__UNKNOWN_DEVICE;
#endif
eERRORRESULT Error, ErrorReturn = 0;
SC16IS7XX_MCR_Register RegMCR;
SC16IS7XX_EFCR_Register RegEFCR;
SC16IS7XX_IOControl_Register RegIOC;
SC16IS7XX_EFR_Register RegEFR;
uint8_t RegIOCmask = 0x00;
RegEFCR.EFCR = SC16IS7XX_EFCR_IrDA_3_16_PULSE_RATIO | SC16IS7XX_EFCR_9BIT_MODE_DISABLE // Default configuration
| SC16IS7XX_EFCR_TX_NOT_CONTROL_RTS | SC16IS7XX_EFCR_NORMAL_RTS_PIN;
//--- Select the IO control mask ---
RegIOC.IOControl = SC16IS7XX_IOCTRL_GPIO7_4_AS_IO | SC16IS7XX_IOCTRL_GPIO3_0_AS_IO;
switch (pUART->Channel)
{
case SC16IS7XX_CHANNEL_A: RegIOCmask = SC16IS7XX_IOCTRL_UARTA_MODEM_MODE_Mask; break;
case SC16IS7XX_CHANNEL_B: RegIOCmask = SC16IS7XX_IOCTRL_UARTB_MODEM_MODE_Mask; break;
default: return ERR__UNKNOWN_ELEMENT;
}
//--- Configure the UART type ---
switch (pUARTConf->UARTtype)
{
case SC16IS7XX_UART_RS232:
RegMCR.MCR = SC16IS7XX_MCR_NORMAL_UART_MODE;
break;
case SC16IS7XX_UART_RS485:
RegMCR.MCR = SC16IS7XX_MCR_NORMAL_UART_MODE;
switch (pUARTConf->RS485.RTScontrol)
{
//--- Configure RTS mode ---
case SC16IS7XX_RS485_AUTO_RTS:
if (pUARTConf->RS485.UseHardwareControlFlow) return ERR__CONFIGURATION; // If auto RTS mode then the hardware control flow shall not be used
RegEFCR.EFCR |= SC16IS7XX_EFCR_TX_CONTROL_RTS; // Set automatic RTS mode
break;
case SC16IS7XX_RS485_HARD_FLOW_CONTROL_RTS:
if (pUARTConf->RS485.UseHardwareControlFlow == false) return ERR__CONFIGURATION; // If hardware control flow RTS mode then the hardware control flow shall be used
break;
case SC16IS7XX_RS485_MANUAL_EXTERNAL_RTS:
if (pUARTConf->RS485.UseHardwareControlFlow) return ERR__CONFIGURATION; // If manual/external RTS mode then the hardware control flow shall not be used
break;
default: break;
}
if (pUARTConf->RS485.RTSoutInversion) RegEFCR.EFCR |= SC16IS7XX_EFCR_INVERT_RTS_PIN; // Invert RTS output if configured
//--- Configure RS-485 mode ---
switch (pUARTConf->RS485.AutoRS485mode)
{
case SC16IS7XX_NO_AUTO_RS485_MODE: break;
case SC16IS7XX_MULTIDROP_MODE: RegEFCR.EFCR |= SC16IS7XX_EFCR_9BIT_MODE_ENABLE; break;
case SC16IS7XX_AUTO_ADDRESS_DETECT:
RegEFCR.EFCR |= SC16IS7XX_EFCR_9BIT_MODE_ENABLE;
//--- Enable access to enhanced registers ---
SC16IS7XX_LCR_Register OriginalLCR;
Error = SC16IS7XX_SetRegisterAccess(pComp, pUART->Channel, SC16IS7XX_LCR_VALUE_SET_ENHANCED_FEATURE_REGISTER, &OriginalLCR.LCR);
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_SetRegisterAccess() then return the error
//--- Configure the auto address detect ---
RegEFR.EFR = SC16IS7XX_EFR_SPECIAL_CHAR_DETECT_ENABLE;
SC16IS7XX_ModifyRegister(pComp, pUART->Channel, RegSC16IS7XX_EFR, RegEFR.EFR, SC16IS7XX_EFR_SPECIAL_CHAR_DETECT_Mask); // Modify the EFR register
if (Error != ERR_OK) ErrorReturn = Error; // If there is an error while calling SC16IS7XX_ModifyRegister() then return the error
Error = SC16IS7XX_WriteRegister(pComp, pUART->Channel, RegSC16IS7XX_XOFF2, pUARTConf->RS485.AddressChar); // Write the Address char in Xoff2 register
if (Error != ERR_OK) ErrorReturn = Error; // If there is an error while calling SC16IS7XX_WriteRegister() then return the error
//--- Return access to general registers ---
Error = SC16IS7XX_ReturnAccessToGeneralRegister(pComp, pUART->Channel, OriginalLCR.LCR); // Return access to general registers
if (ErrorReturn != ERR_OK) return ErrorReturn; // If there is an error while Enhanced Features are enabled then return the error
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ReturnAccessToGeneralRegister() then return the error
break;
default: return ERR__CONFIGURATION;
}
break;
case SC16IS7XX_UART_IrDA:
RegMCR.MCR = SC16IS7XX_MCR_IrDA_MODE; // Set IrDA mode
RegEFCR.EFCR = SC16IS7XX_EFCR_IrDA_3_16_PULSE_RATIO; // By default, set IrDA 3/16 pulse ratio
if (pUARTConf->IrDA.IrDAmode == SC16IS7XX_IrDA_SIR_1_4_RATIO) // If IrDA mode is 1/4 ratio
{
if (SC16IS7XX_LIMITS[pComp->DevicePN].IrDA_1_4_RATIO) // If 1/4 ratio mode supported
RegEFCR.EFCR = SC16IS7XX_EFCR_IrDA_1_4_PULSE_RATIO; // Then set the 1/4 ratio configuration
else return ERR__NOT_SUPPORTED; // Else return an error
}
break;
case SC16IS7XX_UART_Modem:
RegMCR.MCR = SC16IS7XX_MCR_NORMAL_UART_MODE;
switch (pUART->Channel)
{
case SC16IS7XX_CHANNEL_A: RegIOC.IOControl = SC16IS7XX_IOCTRL_GPIO7_4_AS_MODEM; break;
case SC16IS7XX_CHANNEL_B: RegIOC.IOControl = SC16IS7XX_IOCTRL_GPIO3_0_AS_MODEM; break;
default: return ERR__UNKNOWN_ELEMENT;
}
break;
default: return ERR__UNKNOWN_ELEMENT;
}
//--- Now apply parameters to registers ---
SC16IS7XX_ModifyRegister(pComp, pUART->Channel, RegSC16IS7XX_MCR, RegMCR.MCR, SC16IS7XX_MCR_IrDA_MODE_Mask); // Modify the LCR register
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ModifyRegister() then return the error
SC16IS7XX_ModifyRegister(pComp, pUART->Channel, RegSC16IS7XX_EFCR, RegEFCR.EFCR, SC16IS7XX_EFCR_LINE_CONTROL_MODE_Mask); // Modify the EFCR register
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ModifyRegister() then return the error
SC16IS7XX_ModifyRegister(pComp, pUART->Channel, RegSC16IS7XX_IOControl, RegIOC.IOControl, RegIOCmask); // Modify the IOControl register
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_ModifyRegister() then return the error
//--- Configuration of the data communication format ---
SC16IS7XX_LCR_Register RegLCR;
RegLCR.LCR = SC16IS7XX_LCR_NO_BREAK_CONDITION | SC16IS7XX_LCR_DIVISOR_LATCH_DISABLE
| SC16IS7XX_LCR_DATA_LENGTH_SET(pUARTConf->UARTwordLen) // UART word length
| (pUARTConf->UARTstopBit != SC16IS7XX_STOP_BIT_1bit ? SC16IS7XX_LCR_EXTENDED_STOP_BIT : SC16IS7XX_LCR_ONLY_1_STOP_BIT) // UART stop bit
| SC16IS7XX_LCR_PARITY_SET(pUARTConf->UARTparity); // UART parity
return SC16IS7XX_WriteRegister(pComp, pUART->Channel, RegSC16IS7XX_LCR, RegLCR.LCR); // Write the LCR register
}
//=============================================================================
// Set UART baudrate of the SC16IS7XX UART
//=============================================================================
eERRORRESULT SC16IS7XX_SetUARTBaudRate(SC16IS7XX_UART *pUART, const SC16IS7XX_UARTconfig *pUARTConf)
{
#ifdef CHECK_NULL_PARAM
if ((pUART == NULL) || (pUARTConf == NULL)) return ERR__PARAMETER_ERROR;
#endif
SC16IS7XX* pComp = pUART->Device; // Get the SC16IS7XX device of this UART
#ifdef CHECK_NULL_PARAM
if (pUART == NULL) return ERR__UNKNOWN_DEVICE;
#endif
eERRORRESULT Error;
//--- Check that the device is not in sleep mode ---
bool DeviceInSleepMode;
Error = SC16IS7XX_IsDeviceInSleepMode(pComp, &DeviceInSleepMode); // Ask if device is in sleep mode
if (Error != ERR_OK) return Error; // If there is an error while calling SC16IS7XX_IsDeviceInSleepMode() then return the error
if (DeviceInSleepMode) return ERR__NOT_IN_SLEEP_MODE; // To perform the set baudrate operation, the device should not be in sleep mode
//--- Limits tests ---
if ((pComp->XtalFreq != 0) && (pComp->XtalFreq < SC16IS7XX_FREQ_MIN )) return ERR__FREQUENCY_ERROR; // The device crystal should not be < 1.6kHz (100 bauds min)
if ((pComp->XtalFreq != 0) && (pComp->XtalFreq > SC16IS7XX_XTAL_FREQ_MAX)) return ERR__FREQUENCY_ERROR; // The device crystal should not be > 24MHz
if ((pComp->OscFreq != 0) && (pComp->OscFreq < SC16IS7XX_FREQ_MIN )) return ERR__FREQUENCY_ERROR; // The device oscillator should not be < 1.6kMHz (100 bauds min)
if ((pComp->OscFreq != 0) && (pComp->OscFreq > SC16IS7XX_OSC_FREQ_MAX )) return ERR__FREQUENCY_ERROR; // The device oscillator should not be > 80MHz
uint32_t CompFreq = 0;
if (pComp->XtalFreq != 0) CompFreq = pComp->XtalFreq; else CompFreq = pComp->OscFreq; // Select the device frequency
if (CompFreq == 0) return ERR__FREQUENCY_ERROR; // Both XtalFreq and OscFreq are configured to 0
if (pUARTConf->UARTbaudrate < SC16IS7XX_BAUDRATE_MIN) return ERR__BAUDRATE_ERROR; // The UART baudrate should not be < 100 bauds
if (pUARTConf->UARTbaudrate > SC16IS7XX_BAUDRATE_MAX) return ERR__BAUDRATE_ERROR; // In All modes the baudrate max is 5Mbauds
if (pUARTConf->UARTtype == SC16IS7XX_UART_IrDA) // If the device is in IrDA mode
{
if (pUARTConf->IrDA.IrDAmode == SC16IS7XX_IrDA_SIR_1_4_RATIO)
{
if (SC16IS7XX_LIMITS[pComp->DevicePN].IrDA_1_4_RATIO)
{
if (pUARTConf->UARTbaudrate > SC16IS76X_IrDA_SPEED_MAX) return ERR__BAUDRATE_ERROR; // The UART baudrate should not be > max IrDA baudrate (SC16IS76X only)
}
else return ERR__NOT_SUPPORTED; // IrDA SIR 1/4 ratio not supported on SC16IS7XX who are not SC16IS76X
}
else if (pUARTConf->UARTbaudrate > SC16IS7XX_IrDA_SPEED_MAX) return ERR__BAUDRATE_ERROR; // The UART baudrate should not be > max IrDA baudrate
}
//--- Calculate Divisor with Prescaler = 1 and its error ---