MCUSW
EthTrcv.h
Go to the documentation of this file.
1 /*
2 *
3 * Copyright (c) 2024 Texas Instruments Incorporated
4 *
5 * All rights reserved not granted herein.
6 *
7 * Limited License.
8 *
9 * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
10 * license under copyrights and patents it now or hereafter owns or controls to make,
11 * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
12 * terms herein. With respect to the foregoing patent license, such license is granted
13 * solely to the extent that any such patent is necessary to Utilize the software alone.
14 * The patent license shall not apply to any combinations which include this software,
15 * other than combinations with devices manufactured by or for TI ("TI Devices").
16 * No hardware patent is licensed hereunder.
17 *
18 * Redistributions must preserve existing copyright notices and reproduce this license
19 * (including the above copyright notice and the disclaimer and (if applicable) source
20 * code license limitations below) in the documentation and/or other materials provided
21 * with the distribution
22 *
23 * Redistribution and use in binary form, without modification, are permitted provided
24 * that the following conditions are met:
25 *
26 * * No reverse engineering, decompilation, or disassembly of this software is
27 * permitted with respect to any software provided in binary form.
28 *
29 * * any redistribution and use are licensed by TI for use only with TI Devices.
30 *
31 * * Nothing shall obligate TI to provide you with source code for the software
32 * licensed and provided to you in object code.
33 *
34 * If software source code is provided to you, modification and redistribution of the
35 * source code are permitted provided that the following conditions are met:
36 *
37 * * any redistribution and use of the source code, including any resulting derivative
38 * works, are licensed by TI for use only with TI Devices.
39 *
40 * * any redistribution and use of any object code compiled from the source code
41 * and any resulting derivative works, are licensed by TI for use only with TI Devices.
42 *
43 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
44 *
45 * may be used to endorse or promote products derived from this software without
46 * specific prior written permission.
47 *
48 * DISCLAIMER.
49 *
50 * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
51 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53 * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
54 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
55 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
57 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
58 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
59 * OF THE POSSIBILITY OF SUCH DAMAGE.
60 *
61 */
62 
85 /*
86  * Below are the global requirements which are met by this EthTrcv
87  * driver which can't be mapped to a particular source ID
88  */
89 /*
90  * Requirements: MCAL-1751, MCAL-1754, MCAL-1755,
91  * MCAL-1756, MCAL-1757, MCAL-1818, MCAL-981
92  */
93 
94 #ifndef ETHTRCV_H_
95 #define ETHTRCV_H_
96 
97 /* ========================================================================== */
98 /* Include Files */
99 /* ========================================================================== */
100 
101 /* Requirements: MCAL-1825 */
102 #include "EthTrcv_Types.h"
103 
104 #ifdef __cplusplus
105 extern "C" {
106 #endif
107 
108 /* ========================================================================== */
109 /* Macros & Typedefs */
110 /* ========================================================================== */
111 
118 /*
119  * Requirements: MCAL-1752
120  */
122 #define ETHTRCV_SW_MAJOR_VERSION (11U)
123 
124 #define ETHTRCV_SW_MINOR_VERSION (0U)
125 
126 #define ETHTRCV_SW_PATCH_VERSION (0U)
127 
135 /*
136  * Requirements: MCAL-1752
137  */
139 #define ETHTRCV_AR_RELEASE_MAJOR_VERSION (4U)
140 
141 #define ETHTRCV_AR_RELEASE_MINOR_VERSION (3U)
142 
143 #define ETHTRCV_AR_RELEASE_REVISION_VERSION (1U)
144 
151 #define ETHTRCV_VENDOR_ID (44U)
152 
153 #define ETHTRCV_MODULE_ID (73U)
154 
155 #define ETHTRCV_INSTANCE_ID (0U)
156 
171 #define ETHTRCV_INIT_ID ((uint8) 0x01U)
172 
174 #define ETHTRCV_CONTROLLER_INIT_ID ((uint8) 0x02U)
175 
177 #define ETHTRCV_SETTRCVMODE_ID ((uint8) 0x03U)
178 
180 #define ETHTRCV_GETTRCVMODE_ID ((uint8) 0x04U)
181 
183 #define ETHTRCV_SRTAUTONEGOTIA_ID ((uint8) 0x05U)
184 
186 #define ETHTRCV_GETLNKSTATE_ID ((uint8) 0x06U)
187 
189 #define ETHTRCV_GETBAUD_ID ((uint8) 0x07U)
190 
192 #define ETHTRCV_GETDPLXMODE_ID ((uint8) 0x08U)
193 
195 #define ETHTRCV_READMIIIND_ID ((uint8) 0x09U)
196 
198 #define ETHTRCV_WRITEMIIIND_ID ((uint8) 0x0AU)
199 
201 #define ETHTRCV_VERSION_ID ((uint8) 0x0BU)
202 
204 #define ETHTRCV_MAINFCT_WRITE_ID ((uint8) 0x0CU)
205 
207 #define ETHTRCV_GETTRCVWKUPMODE_ID ((uint8) 0x0DU)
208 
210 #define ETHTRCV_SETTRCVWKUPMODE_ID ((uint8) 0x0EU)
211 
213 #define ETHTRCV_CHKWKUP_ID ((uint8) 0x0FU)
214 
216 #define ETHTRCV_SETPHYTESTMODE_ID ((uint8) 0x10U)
217 
219 #define ETHTRCV_SETPHYLOOPBACKMODE_ID ((uint8) 0x11U)
220 
222 #define ETHTRCV_GETPHYSIGNALQUALITY_ID ((uint8) 0x12U)
223 
225 #define ETHTRCV_SETPHYTXMODE_ID ((uint8) 0x13U)
226 
228 #define ETHTRCV_GETCABLEDIAGNOSTICSRESULT_ID ((uint8) 0x014U)
229 
231 #define ETHTRCV_GETPHYIDENTIFIER_ID ((uint8) 0x015U)
232 
242 /*
243  * Requirements: MCAL-1763
244  */
245 
246 #ifndef ETHTRCV_E_INV_TRCV_IDX
247 
248 #define ETHTRCV_E_INV_TRCV_IDX ((uint8) 0x01U)
249 #endif
250 
251 #ifndef ETHTRCV_E_UNINIT
252 
253 #define ETHTRCV_E_UNINIT ((uint8) 0x02U)
254 #endif
255 
256 #ifndef ETHTRCV_E_PARAM_POINTER
257 
258 #define ETHTRCV_E_PARAM_POINTER ((uint8) 0x03U)
259 #endif
260 
261 #ifndef ETHTRCV_E_INIT_FAILED
262 
263 #define ETHTRCV_E_INIT_FAILED ((uint8) 0x04U)
264 #endif
265 
266 #ifndef ETHTRCV_E_NOT_SUPPORTED
267 
268 #define ETHTRCV_E_NOT_SUPPORTED ((uint8) 0x05U)
269 #endif
270 
272 /* ========================================================================== */
273 /* Structures and Enums */
274 /* ========================================================================== */
275 
276 /* None */
277 
278 /* ========================================================================== */
279 /* Function Declarations */
280 /* ========================================================================== */
281 
303 FUNC(void, ETHTRCV_CODE)
304 EthTrcv_Init(P2CONST(EthTrcv_ConfigType, AUTOMATIC, ETHTRCV_PBCFG) CfgPtr);
305 
329 FUNC(Std_ReturnType, ETHTRCV_CODE)
330 EthTrcv_TransceiverInit(uint8 TrcvIdx);
331 
332 
333 #if (STD_ON == ETHTRCV_SETTRANSCEIVERMODE_API)
334 
360 FUNC(Std_ReturnType, ETHTRCV_CODE)
361 EthTrcv_SetTransceiverMode(uint8 TrcvIdx,
362  EthTrcv_ModeType CtrlMode);
363 #endif
364 
365 #if (STD_ON == ETHTRCV_GETTRANSCEIVERMODE_API)
366 
389 FUNC(Std_ReturnType, ETHTRCV_CODE)
390 EthTrcv_GetTransceiverMode(uint8 TrcvIdx,
391  EthTrcv_ModeType *TrcvModePtr);
392 #endif
393 
394 #if (ETHTRCV_WAKEUPSUPPORT_API != ETHTRCV_WAKEUP_NOT_SUPPORTED)
395 
426 FUNC(Std_ReturnType, ETHTRCV_CODE)
427 EthTrcv_SetTransceiverWakeupMode(uint8 TrcvIdx,
428  EthTrcv_WakeupModeType TrcvWakeupMode);
429 #endif
430 
431 #if (ETHTRCV_WAKEUPSUPPORT_API != ETHTRCV_WAKEUP_NOT_SUPPORTED)
432 
458 FUNC(Std_ReturnType, ETHTRCV_CODE)
459 EthTrcv_GetTransceiverWakeupMode(uint8 TrcvIdx,
460  EthTrcv_WakeupModeType *TrcvWakeupModePtr);
461 #endif
462 
463 #if (ETHTRCV_WAKEUPSUPPORT_API != ETHTRCV_WAKEUP_NOT_SUPPORTED)
464 
489 FUNC(Std_ReturnType, ETHTRCV_CODE)
490 EthTrcv_CheckWakeup(uint8 TrcvIdx);
491 #endif
492 
493 /* Requirements: MCAL-1820 */
494 /* The function is not required or called by an upper layer BSW software
495  * component. So making internal */
496 #if (STD_ON == ETHTRCV_STARTAUTONEGOTIATION_API)
497 
521 FUNC(Std_ReturnType, ETHTRCV_CODE)
522 EthTrcv_StartAutoNegotiation(uint8 TrcvIdx);
523 #endif
524 
525 #if (STD_ON == ETHTRCV_GETLINKSTATE_API)
526 
551 FUNC(Std_ReturnType, ETHTRCV_CODE)
552 EthTrcv_GetLinkState(uint8 TrcvIdx,
553  EthTrcv_LinkStateType *LinkStatePtr);
554 #endif
555 
556 /*
557  * Requirements: MCAL-1821
558  */
559 /* The function is not required or called by an upper layer BSW software
560  * component. So making internal */
561 #if (STD_ON == ETHTRCV_GETBAUDRATE_API)
562 
588 FUNC(Std_ReturnType, ETHTRCV_CODE)
589 EthTrcv_GetBaudRate(uint8 TrcvIdx,
590  EthTrcv_BaudRateType *BaudRatePtr);
591 #endif
592 
593 #if (STD_ON == ETHTRCV_GETDUPLEXMODE_API)
594 
619 FUNC(Std_ReturnType, ETHTRCV_CODE)
620 EthTrcv_GetDuplexMode(uint8 TrcvIdx,
621  EthTrcv_DuplexModeType *DuplexModePtr);
622 #endif
623 
624 #if (STD_ON == ETHTRCV_SETPHYTESTMODE_API)
625 
647 FUNC(Std_ReturnType, ETHTRCV_CODE)
648 EthTrcv_SetPhyTestMode(uint8 TrcvIdx,
649  EthTrcv_PhyTestModeType Mode);
650 #endif
651 
652 #if (STD_ON == ETHTRCV_SETPHYLOOPBACKMODE_API)
653 
676 FUNC(Std_ReturnType, ETHTRCV_CODE)
677 EthTrcv_SetPhyLoopbackMode(uint8 TrcvIdx,
678  EthTrcv_PhyLoopbackModeType Mode);
679 #endif
680 
681 #if (STD_ON == ETHTRCV_GETPHYSIGNALQUALITY_API)
682 
706 FUNC(Std_ReturnType, ETHTRCV_CODE)
707 EthTrcv_GetPhySignalQuality(uint8 TrcvIdx,
708  uint32* SignalQualityPtr);
709 #endif
710 
711 #if (STD_ON == ETHTRCV_SETPHYTXMODE_API)
712 
735 FUNC(Std_ReturnType, ETHTRCV_CODE)
736  EthTrcv_SetPhyTxMode(uint8 TrcvIdx,
737  EthTrcv_PhyTxModeType Mode);
738 #endif
739 
740 #if (STD_ON == ETHTRCV_GETCABLEDIAGNOSTICSRESULT_API)
741 
765 FUNC(Std_ReturnType, ETHTRCV_CODE)
766  EthTrcv_GetCableDiagnosticsResult(uint8 TrcvIdx,
767  EthTrcv_CableDiagResultType * ResultPtr);
768 #endif
769 
770 #if (STD_ON == ETHTRCV_GETPHYIDENTIFIER_API)
771 
803 FUNC(Std_ReturnType, ETHTRCV_CODE)
804 EthTrcv_GetPhyIdentifier(uint8 TrcvIdx,
805  uint32* OrgUniqueIdPtr,
806  uint8* ModelNrPtr,
807  uint8* RevisionNrPtr);
808 #endif
809 
810 #if (STD_ON == ETHTRCV_VERSION_INFO_API)
811 
832 FUNC(void, ETHTRCV_CODE)
833 EthTrcv_GetVersionInfo(P2VAR(Std_VersionInfoType, AUTOMATIC, ETHTRCV_APPL_DATA) VersionInfoPtr);
834 #endif
835 
867 /* Important Note:
868  * There is discrepancy in the Eth and EthTrcv specs. Data type for RegVal in
869  * EthTrcv_ReadMiiIndication is uint8 as per Eth Trcv spec where as Eth_ReadMii
870  * takes uint16 pointer RegValPtr. To avoid data loss we change RegVal data type
871  * to uint16 */
872 FUNC(void, ETHTRCV_CODE)
873 EthTrcv_ReadMiiIndication(uint8 CtrlIdx,
874  uint8 TrcvIdx,
875  uint8 RegIdx,
876  uint16 RegVal);
877 
907 FUNC(void, ETHTRCV_CODE)
908 EthTrcv_WriteMiiIndication(uint8 CtrlIdx,
909  uint8 TrcvIdx,
910  uint8 RegId);
911 
931 FUNC(void, ETHTRCV_CODE)
932 EthTrcv_MainFunction(void);
933 
934 #ifdef __cplusplus
935 }
936 #endif
937 
938 #endif /* ETHTRCV_H_ */
939 
Mode
EthTrcv_PhyTestModeType Mode
Definition: EthTrcv.h:649
CtrlMode
EthTrcv_ModeType CtrlMode
Definition: EthTrcv.h:362
TrcvModePtr
EthTrcv_ModeType * TrcvModePtr
Definition: EthTrcv.h:391
RegId
uint8 uint8 RegId
Definition: EthTrcv.h:910
LinkStatePtr
EthTrcv_LinkStateType * LinkStatePtr
Definition: EthTrcv.h:553
ResultPtr
EthTrcv_CableDiagResultType * ResultPtr
Definition: EthTrcv.h:767
OrgUniqueIdPtr
uint32 * OrgUniqueIdPtr
Definition: EthTrcv.h:805
RegVal
uint8 uint8 uint16 RegVal
Definition: EthTrcv.h:876
DuplexModePtr
EthTrcv_DuplexModeType * DuplexModePtr
Definition: EthTrcv.h:621
AUTOMATIC
AUTOMATIC
Definition: EthTrcv.h:304
FUNC
FUNC(void, ETHTRCV_CODE) EthTrcv_Init(P2CONST(EthTrcv_ConfigType
This function initializes the Ethernet Transceiver controller. All the required initialization for th...
P2CONST
P2CONST(void, AUTOMATIC, DIO_CONST) DioConfig_WKUP_GPIO0_B01_ChannelGroupRef[1]
Reference to channel group structure for WKUP_GPIO0_B01 created at config time.
VersionInfoPtr
ETHTRCV_APPL_DATA VersionInfoPtr
Definition: EthTrcv.h:833
BaudRatePtr
EthTrcv_BaudRateType * BaudRatePtr
Definition: EthTrcv.h:590
TrcvIdx
uint8 TrcvIdx
Definition: EthTrcv.h:874
CfgPtr
ETHTRCV_PBCFG CfgPtr
Definition: EthTrcv.h:304
RevisionNrPtr
uint32 uint8 uint8 * RevisionNrPtr
Definition: EthTrcv.h:807
ModelNrPtr
uint32 uint8 * ModelNrPtr
Definition: EthTrcv.h:806
RegIdx
uint8 uint8 RegIdx
Definition: EthTrcv.h:875
SignalQualityPtr
uint32 * SignalQualityPtr
Definition: EthTrcv.h:708
P2VAR
P2VAR(Eth_ModeType, AUTOMATIC, ETH_APPL_DATA) CtrlModePtr)