-
Notifications
You must be signed in to change notification settings - Fork 0
/
tcpp0203.c
888 lines (758 loc) · 26.1 KB
/
tcpp0203.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
/**
******************************************************************************
* @file tcpp0203.c
* @author MCD Application Team
* @brief This file provides the TCPP02/03 Type-C port protection driver.
******************************************************************************
* @attention
*
* Copyright (c) 2021 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
*/
/* Includes ------------------------------------------------------------------*/
#include "tcpp0203.h"
#if defined(_TRACE)
#include "usbpd_core.h"
#include "usbpd_trace.h"
#include "string.h"
#include "stdio.h"
#endif /* _TRACE */
/** @addtogroup BSP
* @{
*/
/** @addtogroup Components
* @{
*/
/** @addtogroup TCPP0203
* @brief This file provides a set of functions needed to drive the
* TCPP02/03 Type-C port protection.
* @{
*/
/** @defgroup TCPP0203_Private_Constants Private Constants
* @{
*/
/* Compilation option in order to enable/disable a concistency check performed
after each I2C access into TCPP0203 registers : goal is to check that written value in Reg0
is properly reflected into reg1 register content.
To enable register consistency check, please uncomment below definition.
To disable it, comment below line */
/* #define TCPP0203_REGISTER_CONSISTENCY_CHECK */
/** @defgroup TCPP0203_Private_Types Private Types
* @{
*/
/* TCPP02/03 Type-C port protection driver structure initialization */
TCPP0203_Drv_t TCPP0203_Driver =
{
TCPP0203_Init,
TCPP0203_DeInit,
TCPP0203_Reset,
TCPP0203_SetVConnSwitch,
TCPP0203_SetGateDriverProvider,
TCPP0203_SetGateDriverConsumer,
TCPP0203_SetPowerMode,
TCPP0203_SetVBusDischarge,
TCPP0203_SetVConnDischarge,
TCPP0203_GetVConnSwitchAck,
TCPP0203_GetGateDriverProviderAck,
TCPP0203_GetGateDriverConsumerAck,
TCPP0203_GetPowerModeAck,
TCPP0203_GetVBusDischargeAck,
TCPP0203_GetVConnDischargeAck,
TCPP0203_GetOCPVConnFlag,
TCPP0203_GetOCPVBusFlag,
TCPP0203_GetOVPVBusFlag,
TCPP0203_GetOVPCCFlag,
TCPP0203_GetOTPFlag,
TCPP0203_GetVBusOkFlag,
TCPP0203_ReadTCPPType,
TCPP0203_ReadVCONNPower,
TCPP0203_WriteCtrlRegister,
TCPP0203_ReadAckRegister,
TCPP0203_ReadFlagRegister,
};
/**
* @}
*/
/** @defgroup TCPP0203_Private_Variables Private Variables
* @{
*/
static uint8_t TCPP0203_DeviceType = TCPP0203_DEVICE_TYPE_03;
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
static uint8_t Reg0_Expected_Value = 0x00;
static uint8_t Reg1_LastRead_Value = 0x00;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
/**
* @}
*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup TCPP0203_Private_Function_Prototypes TCPP0203 Private Function Prototypes
* @{
*/
static int32_t TCPP0203_ReadRegWrap(const void *handle, uint8_t Reg, uint8_t *Data, uint8_t Length);
static int32_t TCPP0203_WriteRegWrap(const void *handle, uint8_t Reg, uint8_t *Data, uint8_t Length);
static int32_t TCPP0203_ModifyReg0(TCPP0203_Object_t *pObj, uint8_t Value, uint8_t Mask);
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
static int32_t TCPP0203_CheckReg0Reg1(TCPP0203_Object_t *pObj, uint8_t Reg0ExpectedValue);
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
/**
* @}
*/
/** @defgroup TCPP0203_Exported_Functions TCPP0203 Exported Functions
* @{
*/
/**
* @brief Register Bus Io to component
* @param Component object pointer
* @retval Status of execution
*/
int32_t TCPP0203_RegisterBusIO(TCPP0203_Object_t *pObj, TCPP0203_IO_t *pIO)
{
int32_t ret;
if (pObj == NULL)
{
ret = TCPP0203_ERROR;
}
else
{
pObj->IO.Init = pIO->Init;
pObj->IO.DeInit = pIO->DeInit;
pObj->IO.Address = pIO->Address;
pObj->IO.WriteReg = pIO->WriteReg;
pObj->IO.ReadReg = pIO->ReadReg;
pObj->IO.GetTick = pIO->GetTick;
pObj->Ctx.ReadReg = TCPP0203_ReadRegWrap;
pObj->Ctx.WriteReg = TCPP0203_WriteRegWrap;
pObj->Ctx.handle = pObj;
if (pObj->IO.Init != NULL)
{
ret = pObj->IO.Init();
}
else
{
ret = TCPP0203_ERROR;
}
}
return ret;
}
/**
* @brief Initializes the TCPP0203 interface
* @param pObj Pointer to component object
* @retval Component status (TCPP0203_OK / TCPP0203_ERROR)
*/
int32_t TCPP0203_Init(TCPP0203_Object_t *pObj)
{
int32_t ret = 0;
uint8_t tmp;
if (pObj->IsInitialized == 0U)
{
/* Read TCPP Device type */
ret += tcpp0203_read_reg(&pObj->Ctx, TCPP0203_READ_REG2, &tmp, 1);
if (ret == TCPP0203_OK)
{
TCPP0203_DeviceType = (tmp & TCPP0203_DEVICE_TYPE_MSK);
}
else
{
TCPP0203_DeviceType = TCPP0203_DEVICE_TYPE_02;
}
pObj->IsInitialized = 1U;
}
if (ret != TCPP0203_OK)
{
ret = TCPP0203_ERROR;
}
return ret;
}
/**
* @brief Deinitializes the TCPP0203 interface
* @param pObj Pointer to component object
* @retval Component status (TCPP0203_OK / TCPP0203_ERROR)
*/
int32_t TCPP0203_DeInit(TCPP0203_Object_t *pObj)
{
if (pObj->IsInitialized == 1U)
{
/* De-Initialize IO BUS layer */
pObj->IO.DeInit();
pObj->IsInitialized = 0U;
}
return TCPP0203_OK;
}
/**
* @brief Resets TCPP0203 register (Reg0)
* @param pObj Pointer to component object
* @retval Component status (TCPP0203_OK / TCPP0203_ERROR)
*/
int32_t TCPP0203_Reset(TCPP0203_Object_t *pObj)
{
int32_t ret = TCPP0203_OK;
uint8_t tmp = TCPP0203_REG0_RST_VALUE;
/* Write reset values in Reg0 register */
if (tcpp0203_write_reg(&pObj->Ctx, TCPP0203_PROG_CTRL, &tmp, 1) != TCPP0203_OK)
{
ret = TCPP0203_ERROR;
}
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
Reg0_Expected_Value = TCPP0203_REG0_RST_VALUE;
Reg1_LastRead_Value = TCPP0203_REG0_RST_VALUE;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
return ret;
}
/**
* @brief Configure TCPP0203 VConn Switch
* @param pObj Pointer to component object
* @param VConnSwitch VConn Switch requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_VCONN_SWITCH_OPEN VConn switch open
* @arg TCPP0203_VCONN_SWITCH_CC1 VConn closed on CC1
* @arg TCPP0203_VCONN_SWITCH_CC2 VConn closed on CC2
* @retval Component status
*/
int32_t TCPP0203_SetVConnSwitch(TCPP0203_Object_t *pObj, uint8_t VConnSwitch)
{
int32_t ret = TCPP0203_OK;
if ((VConnSwitch != TCPP0203_VCONN_SWITCH_OPEN)
&& (VConnSwitch != TCPP0203_VCONN_SWITCH_CC1)
&& (VConnSwitch != TCPP0203_VCONN_SWITCH_CC2))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update VConn switch setting in Writing register Reg0 */
ret += TCPP0203_ModifyReg0(pObj, VConnSwitch, TCPP0203_VCONN_SWITCH_MSK);
}
return ret;
}
/**
* @brief Configure TCPP0203 Gate Driver for Provider path
* @param pObj Pointer to component object
* @param GateDriverProvider GDP switch load requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_GD_PROVIDER_SWITCH_OPEN GDP Switch Load Open
* @arg TCPP0203_GD_PROVIDER_SWITCH_CLOSED GDP Switch Load closed
* @retval Component status
*/
int32_t TCPP0203_SetGateDriverProvider(TCPP0203_Object_t *pObj, uint8_t GateDriverProvider)
{
int32_t ret = TCPP0203_OK;
if ((GateDriverProvider != TCPP0203_GD_PROVIDER_SWITCH_OPEN)
&& (GateDriverProvider != TCPP0203_GD_PROVIDER_SWITCH_CLOSED))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update GDP Switch Load setting in Writing register Reg0 */
if (GateDriverProvider == TCPP0203_GD_PROVIDER_SWITCH_CLOSED)
{
/* If Gate Driver Provider is to be closed, Gate Driver Consumer should be open */
ret += TCPP0203_ModifyReg0(pObj, (GateDriverProvider | TCPP0203_GD_CONSUMER_SWITCH_OPEN),
(TCPP0203_GD_PROVIDER_SWITCH_MSK | TCPP0203_GD_CONSUMER_SWITCH_MSK));
}
else
{
ret += TCPP0203_ModifyReg0(pObj, GateDriverProvider, TCPP0203_GD_PROVIDER_SWITCH_MSK);
}
}
return ret;
}
/**
* @brief Configure TCPP0203 Gate Driver for Consumer path
* @param pObj Pointer to component object
* @param GateDriverConsumer GDC switch load requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_GD_CONSUMER_SWITCH_OPEN GDC Switch Load Open
* @arg TCPP0203_GD_CONSUMER_SWITCH_CLOSED GDC Switch Load closed
* @retval Component status
*/
int32_t TCPP0203_SetGateDriverConsumer(TCPP0203_Object_t *pObj, uint8_t GateDriverConsumer)
{
int32_t ret = TCPP0203_OK;
/* Check if TCPP type is TCPP03. Otherwise, return error */
if (TCPP0203_DeviceType != TCPP0203_DEVICE_TYPE_03)
{
return (TCPP0203_ERROR);
}
if ((GateDriverConsumer != TCPP0203_GD_CONSUMER_SWITCH_OPEN)
&& (GateDriverConsumer != TCPP0203_GD_CONSUMER_SWITCH_CLOSED))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update GDC Switch Load setting in Writing register Reg0 */
if (GateDriverConsumer == TCPP0203_GD_CONSUMER_SWITCH_CLOSED)
{
/* If Gate Driver Consumer is to be closed, Gate Driver Provider should be open */
ret += TCPP0203_ModifyReg0(pObj, (GateDriverConsumer | TCPP0203_GD_PROVIDER_SWITCH_OPEN),
(TCPP0203_GD_PROVIDER_SWITCH_MSK | TCPP0203_GD_CONSUMER_SWITCH_MSK));
}
else
{
ret += TCPP0203_ModifyReg0(pObj, GateDriverConsumer, TCPP0203_GD_CONSUMER_SWITCH_MSK);
}
}
return ret;
}
/**
* @brief Configure TCPP0203 Power Mode
* @param pObj Pointer to component object
* @param PowerMode Power mode requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_POWER_MODE_HIBERNATE Hibernate
* @arg TCPP0203_POWER_MODE_LOWPOWER Low Power
* @arg TCPP0203_POWER_MODE_NORMAL Normal
* @retval Component status
*/
int32_t TCPP0203_SetPowerMode(TCPP0203_Object_t *pObj, uint8_t PowerMode)
{
int32_t ret = TCPP0203_OK;
if ((PowerMode != TCPP0203_POWER_MODE_HIBERNATE)
&& (PowerMode != TCPP0203_POWER_MODE_LOWPOWER)
&& (PowerMode != TCPP0203_POWER_MODE_NORMAL))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update Power Mode setting in Writing register Reg0 */
ret += TCPP0203_ModifyReg0(pObj, PowerMode, TCPP0203_POWER_MODE_MSK);
}
return ret;
}
/**
* @brief Configure TCPP0203 Gate Driver for Provider path
* @param pObj Pointer to component object
* @param VBusDischarge VBUS Discharge requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_VBUS_DISCHARGE_OFF VBUS Discharge Off
* @arg TCPP0203_VBUS_DISCHARGE_ON VBUS Discharge On
* @retval Component status
*/
int32_t TCPP0203_SetVBusDischarge(TCPP0203_Object_t *pObj, uint8_t VBusDischarge)
{
int32_t ret = TCPP0203_OK;
if ((VBusDischarge != TCPP0203_VBUS_DISCHARGE_OFF)
&& (VBusDischarge != TCPP0203_VBUS_DISCHARGE_ON))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update VBUS Discharge setting in Writing register Reg0 */
ret += TCPP0203_ModifyReg0(pObj, VBusDischarge, TCPP0203_VBUS_DISCHARGE_MSK);
}
return ret;
}
/**
* @brief Configure TCPP0203 Gate Driver for Provider path
* @param pObj Pointer to component object
* @param VConnDischarge GDP switch load requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_VCONN_DISCHARGE_OFF VConn Discharge Off
* @arg TCPP0203_VCONN_DISCHARGE_ON VConn Discharge On
* @retval Component status
*/
int32_t TCPP0203_SetVConnDischarge(TCPP0203_Object_t *pObj, uint8_t VConnDischarge)
{
int32_t ret = TCPP0203_OK;
if ((VConnDischarge != TCPP0203_VCONN_DISCHARGE_OFF)
&& (VConnDischarge != TCPP0203_VCONN_DISCHARGE_ON))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update VConn Discharge setting in Writing register Reg0 */
ret += TCPP0203_ModifyReg0(pObj, VConnDischarge, TCPP0203_VCONN_DISCHARGE_MSK);
}
return ret;
}
/**
* @brief Get VConn switch Ack value
* @param pObj Pointer to component object
* @param pVConnSwitchAck Pointer on VConn switch Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_VCONN_SWITCH_OPEN VConn switch open Ack
* @arg TCPP0203_VCONN_SWITCH_CC1 VConn closed on CC1 Ack
* @arg TCPP0203_VCONN_SWITCH_CC2 VConn closed on CC2 Ack
* @retval Component status
*/
int32_t TCPP0203_GetVConnSwitchAck(TCPP0203_Object_t *pObj, uint8_t *pVConnSwitchAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pVConnSwitchAck = (tmp & TCPP0203_VCONN_SWITCH_ACK_MSK);
return ret;
}
/**
* @brief Get Gate Driver Provider Ack value
* @param pObj Pointer to component object
* @param pGateDriverProviderAck Pointer on Gate Driver Provider Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_GD_PROVIDER_SWITCH_ACK_OPEN Gate Driver Provider Open Ack
* @arg TCPP0203_GD_PROVIDER_SWITCH_ACK_CLOSED Gate Driver Provider Closed Ack
* @retval Component status
*/
int32_t TCPP0203_GetGateDriverProviderAck(TCPP0203_Object_t *pObj, uint8_t *pGateDriverProviderAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pGateDriverProviderAck = (tmp & TCPP0203_GD_PROVIDER_SWITCH_ACK_MSK);
return ret;
}
/**
* @brief Get Gate Driver Consumer Ack value
* @param pObj Pointer to component object
* @param pGateDriverConsumerAck Pointer on Gate Driver Consumer Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_GD_CONSUMER_SWITCH_ACK_OPEN Gate Driver Consumer Open Ack
* @arg TCPP0203_GD_CONSUMER_SWITCH_ACK_CLOSED Gate Driver Consumer Closed Ack
* @retval Component status
*/
int32_t TCPP0203_GetGateDriverConsumerAck(TCPP0203_Object_t *pObj, uint8_t *pGateDriverConsumerAck)
{
int32_t ret;
uint8_t tmp;
/* Check if TCPP type is TCPP03. Otherwise, return error */
if (TCPP0203_DeviceType != TCPP0203_DEVICE_TYPE_03)
{
return (TCPP0203_ERROR);
}
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pGateDriverConsumerAck = (tmp & TCPP0203_GD_CONSUMER_SWITCH_ACK_MSK);
return ret;
}
/**
* @brief Get Power Mode Ack value
* @param pObj Pointer to component object
* @param pPowerModeAck Pointer on Power Mode Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_POWER_MODE_ACK_HIBERNATE Power Mode Hibernate Ack
* @arg TCPP0203_POWER_MODE_ACK_LOWPOWER Power Mode Low Power Ack
* @arg TCPP0203_POWER_MODE_ACK_NORMAL Power Mode Normal Ack
* @retval Component status
*/
int32_t TCPP0203_GetPowerModeAck(TCPP0203_Object_t *pObj, uint8_t *pPowerModeAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pPowerModeAck = (tmp & TCPP0203_POWER_MODE_ACK_MSK);
return ret;
}
/**
* @brief Get VBUS Discharge Ack value
* @param pObj Pointer to component object
* @param pVBusDischargeAck Pointer on VBUS Discharge Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_VBUS_DISCHARGE_ACK_OFF VBUS Discharge Off Ack
* @arg TCPP0203_VBUS_DISCHARGE_ACK_ON VBUS Discharge On Ack
* @retval Component status
*/
int32_t TCPP0203_GetVBusDischargeAck(TCPP0203_Object_t *pObj, uint8_t *pVBusDischargeAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pVBusDischargeAck = (tmp & TCPP0203_VBUS_DISCHARGE_ACK_MSK);
return ret;
}
/**
* @brief Get VConn Discharge Ack value
* @param pObj Pointer to component object
* @param pVConnDischargeAck Pointer on VConn Discharge Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_VCONN_DISCHARGE_ACK_OFF VConn Discharge Off Ack
* @arg TCPP0203_VCONN_DISCHARGE_ACK_ON VConn Discharge On Ack
* @retval Component status
*/
int32_t TCPP0203_GetVConnDischargeAck(TCPP0203_Object_t *pObj, uint8_t *pVConnDischargeAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pVConnDischargeAck = (tmp & TCPP0203_VCONN_DISCHARGE_ACK_MSK);
return ret;
}
/**
* @brief Get OCP VConn Flag value
* @param pObj Pointer to component object
* @param pOCPVConnFlag Pointer on OCP VConn Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OCP_VCONN_RESET OCP VConn flag not set
* @arg TCPP0203_FLAG_OCP_VCONN_SET OCP VConn flag set
* @retval Component status
*/
int32_t TCPP0203_GetOCPVConnFlag(TCPP0203_Object_t *pObj, uint8_t *pOCPVConnFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pOCPVConnFlag = (tmp & TCPP0203_FLAG_OCP_VCONN_MSK);
return ret;
}
/**
* @brief Get OCP VBUS Flag value
* @param pObj Pointer to component object
* @param pGetOCPVBusFlag Pointer on OCP VBUS Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OCP_VBUS_RESET OCP VBUS flag not set
* @arg TCPP0203_FLAG_OCP_VBUS_SET OCP VBUS flag set
* @retval Component status
*/
int32_t TCPP0203_GetOCPVBusFlag(TCPP0203_Object_t *pObj, uint8_t *pGetOCPVBusFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pGetOCPVBusFlag = (tmp & TCPP0203_FLAG_OCP_VBUS_MSK);
return ret;
}
/**
* @brief Get OVP VBUS Flag value
* @param pObj Pointer to component object
* @param pOVPVBusFlag Pointer on OVP VBUS Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OVP_VBUS_RESET OVP VBUS flag not set
* @arg TCPP0203_FLAG_OVP_VBUS_SET OVP VBUS flag set
* @retval Component status
*/
int32_t TCPP0203_GetOVPVBusFlag(TCPP0203_Object_t *pObj, uint8_t *pOVPVBusFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pOVPVBusFlag = (tmp & TCPP0203_FLAG_OVP_VBUS_MSK);
return ret;
}
/**
* @brief Get OVP CC Flag value
* @param pObj Pointer to component object
* @param pOVPCCFlag Pointer on OVP CC Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OVP_CC_RESET OVP CC flag not set
* @arg TCPP0203_FLAG_OVP_CC_SET OVP CC flag set
* @retval Component status
*/
int32_t TCPP0203_GetOVPCCFlag(TCPP0203_Object_t *pObj, uint8_t *pOVPCCFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pOVPCCFlag = (tmp & TCPP0203_FLAG_OVP_CC_MSK);
return ret;
}
/**
* @brief Get Over Temperature Flag value
* @param pObj Pointer to component object
* @param pOTPFlag Pointer on Over Temperature Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OTP_RESET Over Temperature flag not set
* @arg TCPP0203_FLAG_OTP_SET Over Temperature flag set
* @retval Component status
*/
int32_t TCPP0203_GetOTPFlag(TCPP0203_Object_t *pObj, uint8_t *pOTPFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pOTPFlag = (tmp & TCPP0203_FLAG_OTP_MSK);
return ret;
}
/**
* @brief Get VBUS OK Flag value
* @param pObj Pointer to component object
* @param pVBusOkFlag Pointer on VBUS OK Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_VBUS_OK_RESET VBUS OK flag not set
* @arg TCPP0203_FLAG_VBUS_OK_SET VBUS OK flag set
* @retval Component status
*/
int32_t TCPP0203_GetVBusOkFlag(TCPP0203_Object_t *pObj, uint8_t *pVBusOkFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pVBusOkFlag = (tmp & TCPP0203_FLAG_VBUS_OK_MSK);
return ret;
}
/**
* @brief Get TCPP0203 Device Type value
* @param pObj Pointer to component object
* @param pTCPPType Pointer on TCPP0203 Device Type value
* This output parameter can be one of the following values:
* @arg TCPP0203_DEVICE_TYPE_02 TCPP02 Type
* @arg TCPP0203_DEVICE_TYPE_03 TCPP03 Type
* @retval Component status
*/
int32_t TCPP0203_ReadTCPPType(TCPP0203_Object_t *pObj, uint8_t *pTCPPType)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pTCPPType = (tmp & TCPP0203_DEVICE_TYPE_MSK);
return ret;
}
/**
* @brief Get VConn Power value
* @param pObj Pointer to component object
* @param pVCONNPower Pointer on VConn Power value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_VCONN_PWR_1W OCP VConn flag not set
* @arg TCPP0203_FLAG_VCONN_PWR_0_1W OCP VConn flag set
* @retval Component status
*/
int32_t TCPP0203_ReadVCONNPower(TCPP0203_Object_t *pObj, uint8_t *pVCONNPower)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pVCONNPower = (tmp & TCPP0203_FLAG_VCONN_PWR_MSK);
return ret;
}
/**
* @brief Set complete Ctrl register value (Reg 0)
* @param pObj Pointer to component object
* @param pCtrlRegister Pointer on Ctrl register value
* @retval Component status
*/
int32_t TCPP0203_WriteCtrlRegister(TCPP0203_Object_t *pObj, uint8_t *pCtrlRegister)
{
int32_t ret;
/* Update value in writing register (reg0) */
ret = tcpp0203_write_reg(&pObj->Ctx, TCPP0203_PROG_CTRL, pCtrlRegister, 1);
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
Reg0_Expected_Value = *pCtrlRegister;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
return ret;
}
/**
* @brief Get complete Ack register value
* @param pObj Pointer to component object
* @param pAckRegister Pointer on Ack register value
* @retval Component status
*/
int32_t TCPP0203_ReadAckRegister(TCPP0203_Object_t *pObj, uint8_t *pAckRegister)
{
int32_t ret;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, pAckRegister, 1);
return ret;
}
/**
* @brief Get complete Flag register value
* @param pObj Pointer to component object
* @param pFlagRegister Pointer on Flag register value
* @retval Component status
*/
int32_t TCPP0203_ReadFlagRegister(TCPP0203_Object_t *pObj, uint8_t *pFlagRegister)
{
int32_t ret;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, pFlagRegister, 1);
return ret;
}
/******************** Static functions ****************************************/
/**
* @brief Wrap TCPP0203 read function to Bus IO function
* @param handle Component object handle
* @param Reg Target register address to read
* @param pData Buffer where Target register value should be stored
* @param Length buffer size to be read
* @retval error status
*/
static int32_t TCPP0203_ReadRegWrap(const void *handle, uint8_t Reg, uint8_t *pData, uint8_t Length)
{
const TCPP0203_Object_t *pObj = (const TCPP0203_Object_t *)handle;
return pObj->IO.ReadReg(pObj->IO.Address, Reg, pData, Length);
}
/**
* @brief Wrap TCPP0203 write function to Bus IO function
* @param handle Component object handle
* @param Reg Target register address to write
* @param pData Target register value to be written
* @param Length Buffer size to be written
* @retval error status
*/
static int32_t TCPP0203_WriteRegWrap(const void *handle, uint8_t Reg, uint8_t *pData, uint8_t Length)
{
const TCPP0203_Object_t *pObj = (const TCPP0203_Object_t *)handle;
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
Reg0_Expected_Value = *pData;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
return pObj->IO.WriteReg(pObj->IO.Address, Reg, pData, Length);
}
/**
* @brief TCPP0203 register update function to Bus IO function
* @param handle Component object handle
* @param Reg Target register address to write
* @param pData Target register value to be written
* @param Length Buffer size to be written
* @retval error status
*/
static int32_t TCPP0203_ModifyReg0(TCPP0203_Object_t *pObj, uint8_t Value, uint8_t Mask)
{
int32_t ret;
uint8_t tmp;
/* Read current content of ACK register (reflects content of bits set to 1 in Writing register Reg0) */
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
/* Update only the area dedicated to Mask */
tmp &= ~(Mask);
tmp |= (Value & Mask);
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
Reg0_Expected_Value = tmp;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
/* Update value in writing register (reg0) */
ret += tcpp0203_write_reg(&pObj->Ctx, TCPP0203_PROG_CTRL, &tmp, 1);
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
ret += TCPP0203_CheckReg0Reg1(pObj, Reg0_Expected_Value);
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
return ret;
}
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
/**
* @brief TCPP0203 register control function between Reg0 and Reg1 value
* @param handle Component object handle
* @param Reg0ExpectedValue Value expected in Reg0 (built after all calls to write functions)
* @retval error status
*/
static int32_t TCPP0203_CheckReg0Reg1(TCPP0203_Object_t *pObj, uint8_t Reg0ExpectedValue)
{
int32_t ret;
/* Read current content of ACK register (expected to reflect content of bits set to 1 in Writing register Reg0) */
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &Reg1_LastRead_Value, 1);
#ifdef _TRACE
char str[12];
sprintf(str, "Exp0_0x%02x", Reg0ExpectedValue);
USBPD_TRACE_Add(USBPD_TRACE_DEBUG, 0U, 0U, (uint8_t *)str, sizeof(str) - 1U);
sprintf(str, "Reg1_0x%02x", Reg1_LastRead_Value);
USBPD_TRACE_Add(USBPD_TRACE_DEBUG, 0U, 0U, (uint8_t *)str, sizeof(str) - 1U);
#endif /* _TRACE */
/* Control if Reg1 value is same as Reg0 expected one */
if (Reg1_LastRead_Value != Reg0ExpectedValue)
{
while (1);
}
return ret;
}
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/