AM263Px MCU+ SDK: enet_phymdio_dflt.h Source File

| AM263Px MCU+ SDK 26.00.00 |

enet_phymdio_dflt.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) Texas Instruments Incorporated 2020
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
40 #ifndef ENET_PHYMDIO_DFLT_H_
41 #define ENET_PHYMDIO_DFLT_H_
42
43 /* ========================================================================== */
44 /* Include Files */
45 /* ========================================================================== */
46
47 #include <include/phy/enetphy.h>
48
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52
53 /* ========================================================================== */
54 /* Macros */
55 /* ========================================================================== */
56
57 /* None */
58
59 /* ========================================================================== */
60 /* Structures and Enums */
61 /* ========================================================================== */
62
63 /* None */
64
65 /* ========================================================================== */
66 /* Global Variables Declarations */
67 /* ========================================================================== */
68
69 /* None */
70
71 /* ========================================================================== */
72 /* Function Declarations */
73 /* ========================================================================== */
74
75 int32_t EnetPhyMdioDflt_isAlive(uint32_t phyAddr,
76 bool *isAlive,
77 Mdio_Obj * hMdio);
78
79 int32_t EnetPhyMdioDflt_isLinked(uint32_t phyAddr,
80 bool *isLinked,
81 Mdio_Obj * hMdio);
82
83 int32_t EnetPhyMdioDflt_readC22(uint32_t group,
84 uint32_t phyAddr,
85 uint32_t reg,
86 uint16_t *val,
87 Mdio_Obj * hMdio);
88
89 int32_t EnetPhyMdioDflt_writeC22(uint32_t group,
90 uint32_t phyAddr,
91 uint32_t reg,
92 uint16_t val,
93 Mdio_Obj * hMdio);
94
95 int32_t EnetPhyMdioDflt_readC45(uint32_t group,
96 uint32_t phyAddr,
97 uint8_t mmd,
98 uint16_t reg,
99 uint16_t *val,
100 Mdio_Obj * hMdio);
101
102 int32_t EnetPhyMdioDflt_writeC45(uint32_t group,
103 uint32_t phyAddr,
104 uint8_t mmd,
105 uint16_t reg,
106 uint16_t val,
107 Mdio_Obj * hMdio);
108
117 EnetPhy_MdioHandle EnetPhyMdioDflt_getPhyMdio(void);
118
132 int32_t EnetPhyMdioDflt_ioctl(EnetPhy_Handle hPhy,
133 uint32_t cmd,
134 Enet_IoctlPrms *prms);
135
136 /* ========================================================================== */
137 /* Deprecated Function Declarations */
138 /* ========================================================================== */
139
140 /* None */
141
142 /* ========================================================================== */
143 /* Static Function Definitions */
144 /* ========================================================================== */
145
146 /* None */
147
148 #ifdef __cplusplus
149 }
150 #endif
151
152 #endif /* ENET_PHYMDIO_DFLT_H_ */
EnetPhyMdioDflt_writeC45
int32_t EnetPhyMdioDflt_writeC45(uint32_t group, uint32_t phyAddr, uint8_t mmd, uint16_t reg, uint16_t val, Mdio_Obj *hMdio)
EnetPhyMdioDflt_writeC22
int32_t EnetPhyMdioDflt_writeC22(uint32_t group, uint32_t phyAddr, uint32_t reg, uint16_t val, Mdio_Obj *hMdio)
EnetPhyMdioDflt_isLinked
int32_t EnetPhyMdioDflt_isLinked(uint32_t phyAddr, bool *isLinked, Mdio_Obj *hMdio)
EnetPhyMdioDflt_isAlive
int32_t EnetPhyMdioDflt_isAlive(uint32_t phyAddr, bool *isAlive, Mdio_Obj *hMdio)
Enet_IoctlPrms
Enet IOCTL param.
Definition: enet_ioctl.h:282
enetphy.h
This file contains the type definitions and helper macros for the Ethernet PHY interface.
EnetPhy_Handle
struct EnetPhy_Obj_s * EnetPhy_Handle
PHY driver object handle.
Definition: enetphy.h:672
EnetPhyMdioDflt_ioctl
int32_t EnetPhyMdioDflt_ioctl(EnetPhy_Handle hPhy, uint32_t cmd, Enet_IoctlPrms *prms)
Run an IOCTL operation on a PHY.
EnetPhyMdioDflt_readC45
int32_t EnetPhyMdioDflt_readC45(uint32_t group, uint32_t phyAddr, uint8_t mmd, uint16_t reg, uint16_t *val, Mdio_Obj *hMdio)
EnetPhyMdioDflt_readC22
int32_t EnetPhyMdioDflt_readC22(uint32_t group, uint32_t phyAddr, uint32_t reg, uint16_t *val, Mdio_Obj *hMdio)
EnetPhy_Mdio
MDIO driver.
Definition: enetphy.h:410
EnetPhyMdioDflt_getPhyMdio
EnetPhy_MdioHandle EnetPhyMdioDflt_getPhyMdio(void)
Get handle to the default Enet MDIO implementation.
Mdio_Obj
struct Mdio_Obj_s Mdio_Obj
Definition: enetphy.h:200