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
|
/**
* \file mdio.c
*
* \brief MDIO APIs.
*
* This file contains the device abstraction layer APIs for MDIO.
*/
/*
* Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com/
*/
/*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the
* distribution.
*
* Neither the name of Texas Instruments Incorporated nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
/* HW Macros and Peripheral Defines */
#include "hw_types.h"
#include "hw_mdio.h"
/* Driver APIs */
#include "mdio.h"
/*******************************************************************************
* INTERNAL MACRO DEFINITIONS
*******************************************************************************/
#define PHY_REG_MASK (0x1Fu)
#define PHY_ADDR_MASK (0x1Fu)
#define PHY_DATA_MASK (0xFFFFu)
#define PHY_REG_SHIFT (21u)
#define PHY_ADDR_SHIFT (16u)
/*******************************************************************************
* API FUNCTION DEFINITIONS
*******************************************************************************/
/**
* \brief Reads a PHY register using MDIO.
*
* \param baseAddr Base Address of the MDIO Module Registers.
* \param phyAddr PHY Adress.
* \param regNum Register Number to be read.
* \param dataPtr Pointer where the read value shall be written.
*
* \return status of the read \n
* TRUE - read is successful.\n
* FALSE - read is not acknowledged properly.
*
**/
unsigned int MDIOPhyRegRead(unsigned int baseAddr, unsigned int phyAddr,
unsigned int regNum, volatile unsigned short *dataPtr)
{
/* Wait till transaction completion if any */
while(HWREG(baseAddr + MDIO_USERACCESS0) & MDIO_USERACCESS0_GO);
HWREG(baseAddr + MDIO_USERACCESS0)
= (MDIO_USERACCESS0_READ | MDIO_USERACCESS0_GO
|((regNum & PHY_REG_MASK) << PHY_REG_SHIFT)
|((phyAddr & PHY_ADDR_MASK) << PHY_ADDR_SHIFT));
/* wait for command completion */
while(HWREG(baseAddr + MDIO_USERACCESS0) & MDIO_USERACCESS0_GO);
/* Store the data if the read is acknowledged */
if((HWREG(baseAddr + MDIO_USERACCESS0)) & MDIO_USERACCESS0_ACK)
{
*dataPtr = (unsigned short)((HWREG(baseAddr + MDIO_USERACCESS0))
& PHY_DATA_MASK);
return TRUE;
}
return FALSE;
}
/**
* \brief Writes a PHY register using MDIO.
*
* \param baseAddr Base Address of the MDIO Module Registers.
* \param phyAddr PHY Adress.
* \param regNum Register Number to be read.
* \param RegVal Value to be written.
*
* \return None
*
**/
void MDIOPhyRegWrite(unsigned int baseAddr, unsigned int phyAddr,
unsigned int regNum, unsigned short RegVal)
{
/* Wait till transaction completion if any */
while(HWREG(baseAddr + MDIO_USERACCESS0) & MDIO_USERACCESS0_GO);
HWREG(baseAddr + MDIO_USERACCESS0)
= (MDIO_USERACCESS0_WRITE | MDIO_USERACCESS0_GO
|((regNum & PHY_REG_MASK) << PHY_REG_SHIFT)
|((phyAddr & PHY_ADDR_MASK) << PHY_ADDR_SHIFT)
| RegVal);
/* wait for command completion*/
while(HWREG(baseAddr + MDIO_USERACCESS0) & MDIO_USERACCESS0_GO);
}
/**
* \brief Reads the alive status of all PHY connected to this MDIO.
* The bit correponding to the PHY address will be set if the PHY
* is alive.
*
* \param baseAddr Base Address of the MDIO Module Registers.
*
* \return MDIO alive register state
*
**/
unsigned int MDIOPhyAliveStatusGet(unsigned int baseAddr)
{
return (HWREG(baseAddr + MDIO_ALIVE));
}
/**
* \brief Reads the link status of all PHY connected to this MDIO.
* The bit correponding to the PHY address will be set if the PHY
* link is active.
*
* \param baseAddr Base Address of the MDIO Module Registers.
*
* \return MDIO link register state
*
**/
unsigned int MDIOPhyLinkStatusGet(unsigned int baseAddr)
{
return (HWREG(baseAddr + MDIO_LINK));
}
/**
* \brief Initializes the MDIO peripheral. This enables the MDIO state
* machine, uses standard pre-amble and set the clock divider value.
*
* \param baseAddr Base Address of the MDIO Module Registers.
* \param mdioInputFreq The clock input to the MDIO module
* \param mdioOutputFreq The clock output required on the MDIO bus
* \return None
*
**/
void MDIOInit(unsigned int baseAddr, unsigned int mdioInputFreq,
unsigned int mdioOutputFreq)
{
unsigned int clkDiv = (mdioInputFreq/mdioOutputFreq) - 1;
HWREG(baseAddr + MDIO_CONTROL) = ((clkDiv & MDIO_CONTROL_CLKDIV)
| MDIO_CONTROL_ENABLE
| MDIO_CONTROL_PREAMBLE
| MDIO_CONTROL_FAULTENB);
}
/**
* \brief Saves the MDIO register context. Note that only MDIO control
* register context is saved here.
*
* \param baseAddr Base Address of the MDIO Module Registers.
* \param contextPtr Pointer to the structure where MDIO context
* needs to be saved.
* \return None
*
**/
void MDIOContextSave(unsigned int baseAddr, MDIOCONTEXT *contextPtr)
{
contextPtr->mdioCtrl = HWREG(baseAddr + MDIO_CONTROL);
}
/**
* \brief Restores the MDIO register context. Note that only MDIO control
* register context is restored here. Hence enough delay shall be
* given after this API
*
* \param baseAddr Base Address of the MDIO Module Registers.
* \param contextPtr Pointer to the structure where MDIO context
* needs to be restored from
* \return None
*
**/
void MDIOContextRestore(unsigned int baseAddr, MDIOCONTEXT *contextPtr)
{
HWREG(baseAddr + MDIO_CONTROL) = contextPtr->mdioCtrl;
}
/***************************** End Of File ***********************************/
|
