AM261x MCU+ SDK: mdio.h Source File

| AM261x MCU+ SDK 26.00.00 |

drivers/mdio/v0/mdio.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2021 Texas Instruments Incorporated
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
42 #ifndef MDIO_H_
43 #define MDIO_H_
44
45 /* ========================================================================== */
46 /* Include Files */
47 /* ========================================================================== */
48
49 #include <stdint.h>
50 #include <drivers/hw_include/cslr_mdio.h>
51 #include <kernel/dpl/SystemP.h>
52
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56
57 /* ========================================================================== */
58 /* Macros & Typedefs */
59 /* ========================================================================== */
60
68 #define MDIO_LINKSEL_MDIO_MODE (0)
69
70 #define MDIO_LINKSEL_MLINK_MODE (1)
71
73 /* ========================================================================== */
74 /* Function Declarations */
75 /* ========================================================================== */
76
84 int32_t MDIO_initClock(uint32_t baseAddr);
85
99 int32_t MDIO_phyRegRead(uint32_t baseAddr,
100 void *pUserGroup,
101 uint32_t phyAddr,
102 uint32_t regNum,
103 uint16_t *pData);
104
118 int32_t MDIO_phyRegWrite(uint32_t baseAddr,
119 void *pUserGroup,
120 uint32_t phyAddr,
121 uint32_t regNum,
122 uint16_t wrVal);
136 int32_t MDIO_phyExtRegRead(uint32_t baseAddr,
137 void *pUserGroup,
138 uint32_t phyAddr,
139 uint32_t regNum,
140 uint16_t *pData);
141
155 int32_t MDIO_phyExtRegWrite(uint32_t baseAddr,
156 void *pUserGroup,
157 uint32_t phyAddr,
158 uint32_t regNum,
159 uint16_t wrVal);
160
171 int32_t MDIO_phyLinkStatus(uint32_t baseAddr, uint32_t phyAddr);
172
185 int32_t MDIO_enableLinkInterrupt(uint32_t mdioBaseAddress,
186 uint32_t regInst,
187 uint32_t phyAddr,
188 uint8_t linkSel);
189
190 /* ========================================================================== */
191 /* Global Variables */
192 /* ========================================================================== */
193
194 #ifdef __cplusplus
195 }
196 #endif
197
200 #endif /* #ifndef MDIO_H_ */
MDIO_phyLinkStatus
int32_t MDIO_phyLinkStatus(uint32_t baseAddr, uint32_t phyAddr)
This API reads the link status of all PHY connected to this MDIO. The bit corresponding to the PHY ad...
SystemP.h
MDIO_phyRegRead
int32_t MDIO_phyRegRead(uint32_t baseAddr, void *pUserGroup, uint32_t phyAddr, uint32_t regNum, uint16_t *pData)
This API reads an IEEE defined PHY register using MDIO. It should be called only after successful exe...
MDIO_enableLinkInterrupt
int32_t MDIO_enableLinkInterrupt(uint32_t mdioBaseAddress, uint32_t regInst, uint32_t phyAddr, uint8_t linkSel)
Function to enable the MDIO Link change interrupt.
MDIO_initClock
int32_t MDIO_initClock(uint32_t baseAddr)
This function initializes the MDIO clock.
MDIO_phyExtRegRead
int32_t MDIO_phyExtRegRead(uint32_t baseAddr, void *pUserGroup, uint32_t phyAddr, uint32_t regNum, uint16_t *pData)
This API reads an extended PHY register using MDIO. It should be called only after successful executi...
MDIO_phyRegWrite
int32_t MDIO_phyRegWrite(uint32_t baseAddr, void *pUserGroup, uint32_t phyAddr, uint32_t regNum, uint16_t wrVal)
This API writes an IEEE defined PHY register using MDIO. It should be called only after successful ex...
MDIO_phyExtRegWrite
int32_t MDIO_phyExtRegWrite(uint32_t baseAddr, void *pUserGroup, uint32_t phyAddr, uint32_t regNum, uint16_t wrVal)
This API writes an extended PHY register using MDIO. It should be called only after successful execut...