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
|
/*
* Copyright (c) 2013 - 2014, Freescale Semiconductor, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice, this list
* of conditions and the following disclaimer.
*
* o 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.
*
* o Neither the name of Freescale Semiconductor, Inc. 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 HOLDER 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.
*/
#ifndef __FSL_PHY_DRIVER_H__
#define __FSL_PHY_DRIVER_H__
#include <stdint.h>
#include <stdbool.h>
#include "fsl_enet_driver.h"
#ifndef MBED_NO_ENET
/*!
* @addtogroup phy_driver
* @{
*/
/*! @file*/
/*******************************************************************************
* Definitions
******************************************************************************/
/*! @brief Defines the PHY return status. */
typedef enum _phy_status
{
kStatus_PHY_Success = 0, /*!< Success*/
kStatus_PHY_InvaildInput = 1, /*!< Invalid PHY input parameter*/
kStatus_PHY_TimeOut = 2, /*!< PHY timeout*/
kStatus_PHY_Fail = 3 /*!< PHY fail*/
} phy_status_t;
/*! @brief Defines the ENET timeout.*/
typedef enum _phy_timeout
{
kPhyTimeout = 0x10000, /*!< ENET resets timeout.*/
} phy_timeout_t;
/*! @brief Defines the PHY register.*/
typedef enum _enet_phy_register
{
kEnetPhyCR = 0, /*!< PHY control register */
kEnetPhySR = 1, /*!< PHY status register*/
kEnetPhyId1 = 2, /*!< PHY identification register 1*/
kEnetPhyId2 = 3, /*!< PHY identification register 2*/
kEnetPhyCt2 = 0x1e /*!< PHY control2 register*/
} enet_phy_register_t;
/*! @brief Defines the control flag.*/
typedef enum _enet_phy_control
{
kEnetPhyAutoNeg = 0x1000,/*!< ENET PHY auto negotiation control*/
kEnetPhySpeed = 0x2000, /*! ENET PHY speed control*/
kEnetPhyLoop = 0x4000, /*!< ENET PHY loop control*/
kEnetPhyReset = 0x8000, /*!< ENET PHY reset control*/
kEnetPhy10HalfDuplex = 0x01, /*!< ENET PHY 10 M half duplex*/
kEnetPhy100HalfDuplex = 0x02,/*!< ENET PHY 100 M half duplex*/
kEnetPhy10FullDuplex = 0x05,/*!< ENET PHY 10 M full duplex*/
kEnetPhy100FullDuplex = 0x06/*!< ENET PHY 100 M full duplex*/
} enet_phy_control_t;
/*! @brief Defines the PHY link speed. */
typedef enum _enet_phy_speed
{
kEnetSpeed10M = 0, /*!< ENET PHY 10 M speed*/
kEnetSpeed100M = 1 /*!< ENET PHY 100 M speed*/
} enet_phy_speed_t;
/*! @brief Defines the PHY link duplex.*/
typedef enum _enet_phy_duplex
{
kEnetHalfDuplex = 0, /*!< ENET PHY half duplex*/
kEnetFullDuplex = 1 /*!< ENET PHY full duplex*/
} enet_phy_duplex_t;
/*! @brief Defines the PHY status.*/
typedef enum _enet_phy_status
{
kEnetPhyLinkStatus = 0x4, /*!< ENET PHY link status bit*/
kEnetPhyAutoNegAble = 0x08, /*!< ENET PHY auto negotiation ability*/
kEnetPhyAutoNegComplete = 0x20, /*!< ENET PHY auto negotiation complete*/
kEnetPhySpeedDulpexMask = 0x07 /*!< ENET PHY speed mask on status register 2*/
} enet_phy_status_t;
/*! @brief Defines the basic PHY application.*/
typedef struct ENETPhyApi
{
uint32_t (* phy_auto_discover)(enet_dev_if_t * enetIfPtr);/*!< PHY auto discover*/
uint32_t (* phy_init)(enet_dev_if_t * enetIfPtr);/*!< PHY initialize*/
uint32_t (* phy_get_link_speed)(enet_dev_if_t * enetIfPtr, enet_phy_speed_t *speed);/*!< Get PHY speed*/
uint32_t (* phy_get_link_status)(enet_dev_if_t * enetIfPtr, bool *status);/*! Get PHY link status*/
uint32_t (* phy_get_link_duplex)(enet_dev_if_t * enetIfPtr, enet_phy_duplex_t *duplex);/*!< Get PHY link duplex*/
} enet_phy_api_t;
/*******************************************************************************
* Global variables
******************************************************************************/
extern const enet_phy_api_t g_enetPhyApi;
/*******************************************************************************
* API
******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif
/*!
* @name PHY Driver
* @{
*/
/*!
* @brief Initializes PHY.
*
* @param enetIfPtr The ENET context structure.
* @return The execution status.
*/
uint32_t phy_init(enet_dev_if_t * enetIfPtr);
/*!
* @brief PHY address auto discover.
*
* @param enetIfPtr The ENET context structure.
* @return The execution status.
*/
uint32_t phy_auto_discover(enet_dev_if_t * enetIfPtr);
/*!
* @brief Gets the PHY link speed.
*
* @param enetIfPtr The ENET context structure.
* @param status The link speed of PHY.
* @return The execution status.
*/
uint32_t phy_get_link_speed(enet_dev_if_t * enetIfPtr, enet_phy_speed_t *status);
/*!
* @brief Gets the PHY link status.
*
* @param enetIfPtr The ENET context structure.
* @param status The link on or down status of the PHY.
* @return The execution status.
*/
uint32_t phy_get_link_status(enet_dev_if_t * enetIfPtr, bool *status);
/*!
* @brief Gets the PHY link duplex.
*
* @param enetIfPtr The ENET context structure.
* @param status The link duplex status of PHY.
* @return The execution status.
*/
uint32_t phy_get_link_duplex(enet_dev_if_t * enetIfPtr, enet_phy_duplex_t *status);
/* @} */
#if defined(__cplusplus)
}
#endif
#endif
/*! @}*/
#endif /* __FSL_PHY_DRIVER_H__ */
/*******************************************************************************
* EOF
******************************************************************************/
|
