-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlan8720.h
449 lines (407 loc) · 15.3 KB
/
lan8720.h
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
/**
******************************************************************************
* @file lan8720.h
* @author worranhin
* @brief This file contains all the functions prototypes for the
* lan8720.c PHY driver.
******************************************************************************
* @attention
*
* Copyright (c) 2024 worranhin.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
*/
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef LAN8720_H
#define LAN8720_H
#ifdef __cplusplus
extern "C" {
#endif
/* Includes ------------------------------------------------------------------*/
#include <stdint.h>
/** @addtogroup BSP
* @{
*/
/** @addtogroup Component
* @{
*/
/** @defgroup LAN8720
* @{
*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup LAN8720_Exported_Constants LAN8720 Exported Constants
* @{
*/
/** @defgroup LAN8720_Registers_Mapping LAN8720 Registers Mapping
* @{
*/
#define LAN8720_BCR ((uint16_t)0x0000U)
#define LAN8720_BSR ((uint16_t)0x0001U)
#define LAN8720_PHYI1R ((uint16_t)0x0002U)
#define LAN8720_PHYI2R ((uint16_t)0x0003U)
#define LAN8720_ANAR ((uint16_t)0x0004U)
#define LAN8720_ANLPAR ((uint16_t)0x0005U)
#define LAN8720_ANER ((uint16_t)0x0006U)
//#define LAN8720_ANNPTR ((uint16_t)0x0007U)
//#define LAN8720_ANNPRR ((uint16_t)0x0008U)
//#define LAN8720_MMDACR ((uint16_t)0x000DU)
//#define LAN8720_MMDAADR ((uint16_t)0x000EU)
//#define LAN8720_ENCTR ((uint16_t)0x0010U)
#define LAN8720_MCSR ((uint16_t)0x0011U)
#define LAN8720_SMR ((uint16_t)0x0012U)
//#define LAN8720_TPDCR ((uint16_t)0x0018U)
//#define LAN8720_TCSR ((uint16_t)0x0019U)
#define LAN8720_SECR ((uint16_t)0x001AU)
#define LAN8720_SCSIR ((uint16_t)0x001BU)
//#define LAN8720_CLR ((uint16_t)0x001CU)
#define LAN8720_ISFR ((uint16_t)0x001DU)
#define LAN8720_IMR ((uint16_t)0x001EU)
#define LAN8720_PHYSCSR ((uint16_t)0x001FU) // PHY SPECIAL CONTROL/STATUS REGISTER
/**
* @}
*/
/** @defgroup LAN8720_BCR_Bit_Definition LAN8720 BCR Bit Definition
* @{
*/
#define LAN8720_BCR_SOFT_RESET ((uint16_t)0x8000U)
#define LAN8720_BCR_LOOPBACK ((uint16_t)0x4000U)
#define LAN8720_BCR_SPEED_SELECT ((uint16_t)0x2000U)
#define LAN8720_BCR_AUTONEGO_EN ((uint16_t)0x1000U)
#define LAN8720_BCR_POWER_DOWN ((uint16_t)0x0800U)
#define LAN8720_BCR_ISOLATE ((uint16_t)0x0400U)
#define LAN8720_BCR_RESTART_AUTONEGO ((uint16_t)0x0200U)
#define LAN8720_BCR_DUPLEX_MODE ((uint16_t)0x0100U)
/**
* @}
*/
/** @defgroup LAN8720_BSR_Bit_Definition LAN8720 BSR Bit Definition
* @{
*/
#define LAN8720_BSR_100BASE_T4 ((uint16_t)0x8000U)
#define LAN8720_BSR_100BASE_TX_FD ((uint16_t)0x4000U)
#define LAN8720_BSR_100BASE_TX_HD ((uint16_t)0x2000U)
#define LAN8720_BSR_10BASE_T_FD ((uint16_t)0x1000U)
#define LAN8720_BSR_10BASE_T_HD ((uint16_t)0x0800U)
#define LAN8720_BSR_100BASE_T2_FD ((uint16_t)0x0400U)
#define LAN8720_BSR_100BASE_T2_HD ((uint16_t)0x0200U)
#define LAN8720_BSR_EXTENDED_STATUS ((uint16_t)0x0100U)
#define LAN8720_BSR_AUTONEGO_CPLT ((uint16_t)0x0020U)
#define LAN8720_BSR_REMOTE_FAULT ((uint16_t)0x0010U)
#define LAN8720_BSR_AUTONEGO_ABILITY ((uint16_t)0x0008U)
#define LAN8720_BSR_LINK_STATUS ((uint16_t)0x0004U)
#define LAN8720_BSR_JABBER_DETECT ((uint16_t)0x0002U)
#define LAN8720_BSR_EXTENDED_CAP ((uint16_t)0x0001U)
/**
* @}
*/
/** @defgroup LAN8720_PHYI1R_Bit_Definition LAN8720 PHYI1R Bit Definition
* @{
*/
#define LAN8720_PHYI1R_OUI_3_18 ((uint16_t)0xFFFFU)
/**
* @}
*/
/** @defgroup LAN8720_PHYI2R_Bit_Definition LAN8720 PHYI2R Bit Definition
* @{
*/
#define LAN8720_PHYI2R_OUI_19_24 ((uint16_t)0xFC00U)
#define LAN8720_PHYI2R_MODEL_NBR ((uint16_t)0x03F0U)
#define LAN8720_PHYI2R_REVISION_NBR ((uint16_t)0x000FU)
/**
* @}
*/
/** @defgroup LAN8720_ANAR_Bit_Definition LAN8720 ANAR Bit Definition
* @{
*/
//#define LAN8720_ANAR_NEXT_PAGE ((uint16_t)0x8000U)
#define LAN8720_ANAR_REMOTE_FAULT ((uint16_t)0x2000U)
#define LAN8720_ANAR_PAUSE_OPERATION ((uint16_t)0x0C00U)
#define LAN8720_ANAR_PO_NOPAUSE ((uint16_t)0x0000U)
#define LAN8720_ANAR_PO_SYMMETRIC_PAUSE ((uint16_t)0x0400U)
#define LAN8720_ANAR_PO_ASYMMETRIC_PAUSE ((uint16_t)0x0800U)
#define LAN8720_ANAR_PO_ADVERTISE_SUPPORT ((uint16_t)0x0C00U)
#define LAN8720_ANAR_100BASE_TX_FD ((uint16_t)0x0100U)
#define LAN8720_ANAR_100BASE_TX ((uint16_t)0x0080U)
#define LAN8720_ANAR_10BASE_T_FD ((uint16_t)0x0040U)
#define LAN8720_ANAR_10BASE_T ((uint16_t)0x0020U)
#define LAN8720_ANAR_SELECTOR_FIELD ((uint16_t)0x000FU)
/**
* @}
*/
/** @defgroup LAN8720_ANLPAR_Bit_Definition LAN8720 ANLPAR Bit Definition
* @{
*/
#define LAN8720_ANLPAR_NEXT_PAGE ((uint16_t)0x8000U)
#define LAN8720_ANLPAR_ACKNOWLEDGE ((uint16_t)0x4000U) // special
#define LAN8720_ANLPAR_REMOTE_FAULT ((uint16_t)0x2000U)
#define LAN8720_ANLPAR_PAUSE_OPERATION ((uint16_t)0x0400U)
//#define LAN8720_ANLPAR_PO_NOPAUSE ((uint16_t)0x0000U)
//#define LAN8720_ANLPAR_PO_SYMMETRIC_PAUSE ((uint16_t)0x0400U)
//#define LAN8720_ANLPAR_PO_ASYMMETRIC_PAUSE ((uint16_t)0x0800U)
//#define LAN8720_ANLPAR_PO_ADVERTISE_SUPPORT ((uint16_t)0x0C00U)
#define LAN8720_ANLPAR_100BASE_T4 ((uint16_t)0x0200U)
#define LAN8720_ANLPAR_100BASE_TX_FD ((uint16_t)0x0100U)
#define LAN8720_ANLPAR_100BASE_TX ((uint16_t)0x0080U)
#define LAN8720_ANLPAR_10BASE_T_FD ((uint16_t)0x0040U)
#define LAN8720_ANLPAR_10BASE_T ((uint16_t)0x0020U)
#define LAN8720_ANLPAR_SELECTOR_FIELD ((uint16_t)0x001FU)
/**
* @}
*/
/** @defgroup LAN8720_ANER_Bit_Definition LAN8720 ANER Bit Definition
* @{
*/
//#define LAN8720_ANER_RX_NP_LOCATION_ABLE ((uint16_t)0x0040U)
//#define LAN8720_ANER_RX_NP_STORAGE_LOCATION ((uint16_t)0x0020U)
#define LAN8720_ANER_PARALLEL_DETECT_FAULT ((uint16_t)0x0010U)
#define LAN8720_ANER_LP_NP_ABLE ((uint16_t)0x0008U)
#define LAN8720_ANER_NP_ABLE ((uint16_t)0x0004U)
#define LAN8720_ANER_PAGE_RECEIVED ((uint16_t)0x0002U)
#define LAN8720_ANER_LP_AUTONEG_ABLE ((uint16_t)0x0001U)
/**
* @}
*/
/** @defgroup LAN8720_ANNPTR_Bit_Definition LAN8720 ANNPTR Bit Definition
* @{
*/
//#define LAN8720_ANNPTR_NEXT_PAGE ((uint16_t)0x8000U)
//#define LAN8720_ANNPTR_MESSAGE_PAGE ((uint16_t)0x2000U)
//#define LAN8720_ANNPTR_ACK2 ((uint16_t)0x1000U)
//#define LAN8720_ANNPTR_TOGGLE ((uint16_t)0x0800U)
//#define LAN8720_ANNPTR_MESSAGGE_CODE ((uint16_t)0x07FFU)
/**
* @}
*/
/** @defgroup LAN8720_ANNPRR_Bit_Definition LAN8720 ANNPRR Bit Definition
* @{
*/
//#define LAN8720_ANNPTR_NEXT_PAGE ((uint16_t)0x8000U)
//#define LAN8720_ANNPRR_ACK ((uint16_t)0x4000U)
//#define LAN8720_ANNPRR_MESSAGE_PAGE ((uint16_t)0x2000U)
//#define LAN8720_ANNPRR_ACK2 ((uint16_t)0x1000U)
//#define LAN8720_ANNPRR_TOGGLE ((uint16_t)0x0800U)
//#define LAN8720_ANNPRR_MESSAGGE_CODE ((uint16_t)0x07FFU)
/**
* @}
*/
/** @defgroup LAN8720_MMDACR_Bit_Definition LAN8720 MMDACR Bit Definition
* @{
*/
//#define LAN8720_MMDACR_MMD_FUNCTION ((uint16_t)0xC000U)
//#define LAN8720_MMDACR_MMD_FUNCTION_ADDR ((uint16_t)0x0000U)
//#define LAN8720_MMDACR_MMD_FUNCTION_DATA ((uint16_t)0x4000U)
//#define LAN8720_MMDACR_MMD_DEV_ADDR ((uint16_t)0x001FU)
/**
* @}
*/
/** @defgroup LAN8720_ENCTR_Bit_Definition LAN8720 ENCTR Bit Definition
* @{
*/
//#define LAN8720_ENCTR_TX_ENABLE ((uint16_t)0x8000U)
//#define LAN8720_ENCTR_TX_TIMER ((uint16_t)0x6000U)
//#define LAN8720_ENCTR_TX_TIMER_1S ((uint16_t)0x0000U)
//#define LAN8720_ENCTR_TX_TIMER_768MS ((uint16_t)0x2000U)
//#define LAN8720_ENCTR_TX_TIMER_512MS ((uint16_t)0x4000U)
//#define LAN8720_ENCTR_TX_TIMER_265MS ((uint16_t)0x6000U)
//#define LAN8720_ENCTR_RX_ENABLE ((uint16_t)0x1000U)
//#define LAN8720_ENCTR_RX_MAX_INTERVAL ((uint16_t)0x0C00U)
//#define LAN8720_ENCTR_RX_MAX_INTERVAL_64MS ((uint16_t)0x0000U)
//#define LAN8720_ENCTR_RX_MAX_INTERVAL_256MS ((uint16_t)0x0400U)
//#define LAN8720_ENCTR_RX_MAX_INTERVAL_512MS ((uint16_t)0x0800U)
//#define LAN8720_ENCTR_RX_MAX_INTERVAL_1S ((uint16_t)0x0C00U)
//#define LAN8720_ENCTR_EX_CROSS_OVER ((uint16_t)0x0002U)
//#define LAN8720_ENCTR_EX_MANUAL_CROSS_OVER ((uint16_t)0x0001U)
/**
* @}
*/
/** @defgroup LAN8720_MCSR_Bit_Definition LAN8720 MCSR Bit Definition
* @{
*/
#define LAN8720_MCSR_EDPWRDOWN ((uint16_t)0x2000U)
#define LAN8720_MCSR_FARLOOPBACK ((uint16_t)0x0200U)
#define LAN8720_MCSR_ALTINT ((uint16_t)0x0040U)
#define LAN8720_MCSR_ENERGYON ((uint16_t)0x0002U)
/**
* @}
*/
/** @defgroup LAN8720_SMR_Bit_Definition LAN8720 SMR Bit Definition
* @{
*/
#define LAN8720_SMR_MODE ((uint16_t)0x00E0U)
#define LAN8720_SMR_PHY_ADDR ((uint16_t)0x001FU)
/**
* @}
*/
/** @defgroup LAN8720_TPDCR_Bit_Definition LAN8720 TPDCR Bit Definition
* @{
*/
//#define LAN8720_TPDCR_DELAY_IN ((uint16_t)0x8000U)
//#define LAN8720_TPDCR_LINE_BREAK_COUNTER ((uint16_t)0x7000U)
//#define LAN8720_TPDCR_PATTERN_HIGH ((uint16_t)0x0FC0U)
//#define LAN8720_TPDCR_PATTERN_LOW ((uint16_t)0x003FU)
/**
* @}
*/
/** @defgroup LAN8720_TCSR_Bit_Definition LAN8720 TCSR Bit Definition
* @{
*/
//#define LAN8720_TCSR_TDR_ENABLE ((uint16_t)0x8000U)
//#define LAN8720_TCSR_TDR_AD_FILTER_ENABLE ((uint16_t)0x4000U)
//#define LAN8720_TCSR_TDR_CH_CABLE_TYPE ((uint16_t)0x0600U)
//#define LAN8720_TCSR_TDR_CH_CABLE_DEFAULT ((uint16_t)0x0000U)
//#define LAN8720_TCSR_TDR_CH_CABLE_SHORTED ((uint16_t)0x0200U)
//#define LAN8720_TCSR_TDR_CH_CABLE_OPEN ((uint16_t)0x0400U)
//#define LAN8720_TCSR_TDR_CH_CABLE_MATCH ((uint16_t)0x0600U)
//#define LAN8720_TCSR_TDR_CH_STATUS ((uint16_t)0x0100U)
//#define LAN8720_TCSR_TDR_CH_LENGTH ((uint16_t)0x00FFU)
/**
* @}
*/
/** @defgroup LAN8720_SCSIR_Bit_Definition LAN8720 SCSIR Bit Definition
* @{
*/
#define LAN8720_SCSIR_AUTO_MDIX_ENABLE ((uint16_t)0x8000U)
#define LAN8720_SCSIR_CHANNEL_SELECT ((uint16_t)0x2000U)
#define LAN8720_SCSIR_SQE_DISABLE ((uint16_t)0x0800U)
#define LAN8720_SCSIR_XPOLALITY ((uint16_t)0x0010U)
/**
* @}
*/
/** @defgroup LAN8720_CLR_Bit_Definition LAN8720 CLR Bit Definition
* @{
*/
//#define LAN8720_CLR_CABLE_LENGTH ((uint16_t)0xF000U)
/**
* @}
*/
/** @defgroup LAN8720_IMR_ISFR_Bit_Definition LAN8720 IMR ISFR Bit Definition
* @{
*/
//#define LAN8720_INT_8 ((uint16_t)0x0100U)
#define LAN8720_INT_7 ((uint16_t)0x0080U)
#define LAN8720_INT_6 ((uint16_t)0x0040U)
#define LAN8720_INT_5 ((uint16_t)0x0020U)
#define LAN8720_INT_4 ((uint16_t)0x0010U)
#define LAN8720_INT_3 ((uint16_t)0x0008U)
#define LAN8720_INT_2 ((uint16_t)0x0004U)
#define LAN8720_INT_1 ((uint16_t)0x0002U)
/**
* @}
*/
/** @defgroup LAN8720_PHYSCSR_Bit_Definition LAN8720 PHYSCSR Bit Definition
* @{
*/
#define LAN8720_PHYSCSR_AUTONEGO_DONE ((uint16_t)0x1000U) // 12 Auto-negotiation done indication, 0 = Auto-negotiation is not done or disabled (or not active), 1 = Auto-negotiation is done
#define LAN8720_PHYSCSR_HCDSPEEDMASK ((uint16_t)0x001CU) // [4:2]
#define LAN8720_PHYSCSR_10BT_HD ((uint16_t)0x0004U)
#define LAN8720_PHYSCSR_10BT_FD ((uint16_t)0x0014U)
#define LAN8720_PHYSCSR_100BTX_HD ((uint16_t)0x0008U)
#define LAN8720_PHYSCSR_100BTX_FD ((uint16_t)0x0018U)
/**
* @}
*/
/** @defgroup LAN8720_Status LAN8720 Status
* @{
*/
#define LAN8720_STATUS_READ_ERROR ((int32_t)-5)
#define LAN8720_STATUS_WRITE_ERROR ((int32_t)-4)
#define LAN8720_STATUS_ADDRESS_ERROR ((int32_t)-3)
#define LAN8720_STATUS_RESET_TIMEOUT ((int32_t)-2)
#define LAN8720_STATUS_ERROR ((int32_t)-1)
#define LAN8720_STATUS_OK ((int32_t) 0)
#define LAN8720_STATUS_LINK_DOWN ((int32_t) 1)
#define LAN8720_STATUS_100MBITS_FULLDUPLEX ((int32_t) 2)
#define LAN8720_STATUS_100MBITS_HALFDUPLEX ((int32_t) 3)
#define LAN8720_STATUS_10MBITS_FULLDUPLEX ((int32_t) 4)
#define LAN8720_STATUS_10MBITS_HALFDUPLEX ((int32_t) 5)
#define LAN8720_STATUS_AUTONEGO_NOTDONE ((int32_t) 6)
/**
* @}
*/
/** @defgroup LAN8720_IT_Flags LAN8720 IT Flags
* @{
*/
//#define LAN8720_WOL_IT LAN8720_INT_8
#define LAN8720_ENERGYON_IT LAN8720_INT_7
#define LAN8720_AUTONEGO_COMPLETE_IT LAN8720_INT_6
#define LAN8720_REMOTE_FAULT_IT LAN8720_INT_5
#define LAN8720_LINK_DOWN_IT LAN8720_INT_4
#define LAN8720_AUTONEGO_LP_ACK_IT LAN8720_INT_3
#define LAN8720_PARALLEL_DETECTION_FAULT_IT LAN8720_INT_2
#define LAN8720_AUTONEGO_PAGE_RECEIVED_IT LAN8720_INT_1
/**
* @}
*/
/**
* @}
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup LAN8720_Exported_Types LAN8720 Exported Types
* @{
*/
typedef int32_t (*lan8720_Init_Func) (void);
typedef int32_t (*lan8720_DeInit_Func) (void);
typedef int32_t (*lan8720_ReadReg_Func) (uint32_t, uint32_t, uint32_t *);
typedef int32_t (*lan8720_WriteReg_Func) (uint32_t, uint32_t, uint32_t);
typedef int32_t (*lan8720_GetTick_Func) (void);
typedef struct
{
lan8720_Init_Func Init;
lan8720_DeInit_Func DeInit;
lan8720_WriteReg_Func WriteReg;
lan8720_ReadReg_Func ReadReg;
lan8720_GetTick_Func GetTick;
} lan8720_IOCtx_t;
typedef struct
{
uint32_t DevAddr;
uint32_t Is_Initialized;
lan8720_IOCtx_t IO;
void *pData;
}lan8720_Object_t;
/**
* @}
*/
/* Exported macro ------------------------------------------------------------*/
/* Exported functions --------------------------------------------------------*/
/** @defgroup LAN8720_Exported_Functions LAN8720 Exported Functions
* @{
*/
int32_t LAN8720_RegisterBusIO(lan8720_Object_t *pObj, lan8720_IOCtx_t *ioctx);
int32_t LAN8720_Init(lan8720_Object_t *pObj);
int32_t LAN8720_DeInit(lan8720_Object_t *pObj);
int32_t LAN8720_DisablePowerDownMode(lan8720_Object_t *pObj);
int32_t LAN8720_EnablePowerDownMode(lan8720_Object_t *pObj);
int32_t LAN8720_StartAutoNego(lan8720_Object_t *pObj);
int32_t LAN8720_GetLinkState(lan8720_Object_t *pObj);
int32_t LAN8720_SetLinkState(lan8720_Object_t *pObj, uint32_t LinkState);
int32_t LAN8720_EnableLoopbackMode(lan8720_Object_t *pObj);
int32_t LAN8720_DisableLoopbackMode(lan8720_Object_t *pObj);
int32_t LAN8720_EnableIT(lan8720_Object_t *pObj, uint32_t Interrupt);
int32_t LAN8720_DisableIT(lan8720_Object_t *pObj, uint32_t Interrupt);
int32_t LAN8720_ClearIT(lan8720_Object_t *pObj, uint32_t Interrupt);
int32_t LAN8720_GetITStatus(lan8720_Object_t *pObj, uint32_t Interrupt);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* LAN8720_H */
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/