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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
|
#ifndef __CB_BDK_HAL_MDIO_H__
#define __CB_BDK_HAL_MDIO_H__
/***********************license start***********************************
* Copyright (c) 2003-2017 Cavium Inc. (support@cavium.com). All rights
* reserved.
*
*
* 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 Cavium 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, including technical data, may be subject to U.S. export
* control laws, including the U.S. Export Administration Act and its
* associated regulations, and may be subject to export or import
* regulations in other countries.
*
* TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
* AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
* WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT
* TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
* REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
* DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
* OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
* PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT,
* QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK
* ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
***********************license end**************************************/
/**
* @file
*
* Interface to the SMI/MDIO hardware, including support for both IEEE 802.3
* clause 22 and clause 45 operations.
*
* <hr>$Revision: 51350 $<hr>
*
* @addtogroup hal
* @{
*/
/**
* PHY register 0 from the 802.3 spec
*/
#define BDK_MDIO_PHY_REG_CONTROL 0
typedef union
{
uint16_t u16;
struct
{
#if __BYTE_ORDER == __BIG_ENDIAN
uint16_t reset : 1;
uint16_t loopback : 1;
uint16_t speed_lsb : 1;
uint16_t autoneg_enable : 1;
uint16_t power_down : 1;
uint16_t isolate : 1;
uint16_t restart_autoneg : 1;
uint16_t duplex : 1;
uint16_t collision_test : 1;
uint16_t speed_msb : 1;
uint16_t unidirectional_enable : 1;
uint16_t reserved_0_4 : 5;
#else
uint16_t reserved_0_4 : 5;
uint16_t unidirectional_enable : 1;
uint16_t speed_msb : 1;
uint16_t collision_test : 1;
uint16_t duplex : 1;
uint16_t restart_autoneg : 1;
uint16_t isolate : 1;
uint16_t power_down : 1;
uint16_t autoneg_enable : 1;
uint16_t speed_lsb : 1;
uint16_t loopback : 1;
uint16_t reset : 1;
#endif
} s;
} bdk_mdio_phy_reg_control_t;
/**
* PHY register 1 from the 802.3 spec
*/
#define BDK_MDIO_PHY_REG_STATUS 1
typedef union
{
uint16_t u16;
struct
{
#if __BYTE_ORDER == __BIG_ENDIAN
uint16_t capable_100base_t4 : 1;
uint16_t capable_100base_x_full : 1;
uint16_t capable_100base_x_half : 1;
uint16_t capable_10_full : 1;
uint16_t capable_10_half : 1;
uint16_t capable_100base_t2_full : 1;
uint16_t capable_100base_t2_half : 1;
uint16_t capable_extended_status : 1;
uint16_t capable_unidirectional : 1;
uint16_t capable_mf_preamble_suppression : 1;
uint16_t autoneg_complete : 1;
uint16_t remote_fault : 1;
uint16_t capable_autoneg : 1;
uint16_t link_status : 1;
uint16_t jabber_detect : 1;
uint16_t capable_extended_registers : 1;
#else
uint16_t capable_extended_registers : 1;
uint16_t jabber_detect : 1;
uint16_t link_status : 1;
uint16_t capable_autoneg : 1;
uint16_t remote_fault : 1;
uint16_t autoneg_complete : 1;
uint16_t capable_mf_preamble_suppression : 1;
uint16_t capable_unidirectional : 1;
uint16_t capable_extended_status : 1;
uint16_t capable_100base_t2_half : 1;
uint16_t capable_100base_t2_full : 1;
uint16_t capable_10_half : 1;
uint16_t capable_10_full : 1;
uint16_t capable_100base_x_half : 1;
uint16_t capable_100base_x_full : 1;
uint16_t capable_100base_t4 : 1;
#endif
} s;
} bdk_mdio_phy_reg_status_t;
/**
* PHY register 2 from the 802.3 spec
*/
#define BDK_MDIO_PHY_REG_ID1 2
typedef union
{
uint16_t u16;
struct
{
uint16_t oui_bits_3_18;
} s;
} bdk_mdio_phy_reg_id1_t;
/**
* PHY register 3 from the 802.3 spec
*/
#define BDK_MDIO_PHY_REG_ID2 3
typedef union
{
uint16_t u16;
struct
{
#if __BYTE_ORDER == __BIG_ENDIAN
uint16_t oui_bits_19_24 : 6;
uint16_t model : 6;
uint16_t revision : 4;
#else
uint16_t revision : 4;
uint16_t model : 6;
uint16_t oui_bits_19_24 : 6;
#endif
} s;
} bdk_mdio_phy_reg_id2_t;
/**
* PHY register 4 from the 802.3 spec
*/
#define BDK_MDIO_PHY_REG_AUTONEG_ADVER 4
typedef union
{
uint16_t u16;
struct
{
#if __BYTE_ORDER == __BIG_ENDIAN
uint16_t next_page : 1;
uint16_t reserved_14 : 1;
uint16_t remote_fault : 1;
uint16_t reserved_12 : 1;
uint16_t asymmetric_pause : 1;
uint16_t pause : 1;
uint16_t advert_100base_t4 : 1;
uint16_t advert_100base_tx_full : 1;
uint16_t advert_100base_tx_half : 1;
uint16_t advert_10base_tx_full : 1;
uint16_t advert_10base_tx_half : 1;
uint16_t selector : 5;
#else
uint16_t selector : 5;
uint16_t advert_10base_tx_half : 1;
uint16_t advert_10base_tx_full : 1;
uint16_t advert_100base_tx_half : 1;
uint16_t advert_100base_tx_full : 1;
uint16_t advert_100base_t4 : 1;
uint16_t pause : 1;
uint16_t asymmetric_pause : 1;
uint16_t reserved_12 : 1;
uint16_t remote_fault : 1;
uint16_t reserved_14 : 1;
uint16_t next_page : 1;
#endif
} s;
} bdk_mdio_phy_reg_autoneg_adver_t;
/**
* PHY register 5 from the 802.3 spec
*/
#define BDK_MDIO_PHY_REG_LINK_PARTNER_ABILITY 5
typedef union
{
uint16_t u16;
struct
{
#if __BYTE_ORDER == __BIG_ENDIAN
uint16_t next_page : 1;
uint16_t ack : 1;
uint16_t remote_fault : 1;
uint16_t reserved_12 : 1;
uint16_t asymmetric_pause : 1;
uint16_t pause : 1;
uint16_t advert_100base_t4 : 1;
uint16_t advert_100base_tx_full : 1;
uint16_t advert_100base_tx_half : 1;
uint16_t advert_10base_tx_full : 1;
uint16_t advert_10base_tx_half : 1;
uint16_t selector : 5;
#else
uint16_t selector : 5;
uint16_t advert_10base_tx_half : 1;
uint16_t advert_10base_tx_full : 1;
uint16_t advert_100base_tx_half : 1;
uint16_t advert_100base_tx_full : 1;
uint16_t advert_100base_t4 : 1;
uint16_t pause : 1;
uint16_t asymmetric_pause : 1;
uint16_t reserved_12 : 1;
uint16_t remote_fault : 1;
uint16_t ack : 1;
uint16_t next_page : 1;
#endif
} s;
} bdk_mdio_phy_reg_link_partner_ability_t;
/**
* PHY register 6 from the 802.3 spec
*/
#define BDK_MDIO_PHY_REG_AUTONEG_EXPANSION 6
typedef union
{
uint16_t u16;
struct
{
#if __BYTE_ORDER == __BIG_ENDIAN
uint16_t reserved_5_15 : 11;
uint16_t parallel_detection_fault : 1;
uint16_t link_partner_next_page_capable : 1;
uint16_t local_next_page_capable : 1;
uint16_t page_received : 1;
uint16_t link_partner_autoneg_capable : 1;
#else
uint16_t link_partner_autoneg_capable : 1;
uint16_t page_received : 1;
uint16_t local_next_page_capable : 1;
uint16_t link_partner_next_page_capable : 1;
uint16_t parallel_detection_fault : 1;
uint16_t reserved_5_15 : 11;
#endif
} s;
} bdk_mdio_phy_reg_autoneg_expansion_t;
/**
* PHY register 9 from the 802.3 spec
*/
#define BDK_MDIO_PHY_REG_CONTROL_1000 9
typedef union
{
uint16_t u16;
struct
{
#if __BYTE_ORDER == __BIG_ENDIAN
uint16_t test_mode : 3;
uint16_t manual_master_slave : 1;
uint16_t master : 1;
uint16_t port_type : 1;
uint16_t advert_1000base_t_full : 1;
uint16_t advert_1000base_t_half : 1;
uint16_t reserved_0_7 : 8;
#else
uint16_t reserved_0_7 : 8;
uint16_t advert_1000base_t_half : 1;
uint16_t advert_1000base_t_full : 1;
uint16_t port_type : 1;
uint16_t master : 1;
uint16_t manual_master_slave : 1;
uint16_t test_mode : 3;
#endif
} s;
} bdk_mdio_phy_reg_control_1000_t;
/**
* PHY register 10 from the 802.3 spec
*/
#define BDK_MDIO_PHY_REG_STATUS_1000 10
typedef union
{
uint16_t u16;
struct
{
#if __BYTE_ORDER == __BIG_ENDIAN
uint16_t master_slave_fault : 1;
uint16_t is_master : 1;
uint16_t local_receiver_ok : 1;
uint16_t remote_receiver_ok : 1;
uint16_t remote_capable_1000base_t_full : 1;
uint16_t remote_capable_1000base_t_half : 1;
uint16_t reserved_8_9 : 2;
uint16_t idle_error_count : 8;
#else
uint16_t idle_error_count : 8;
uint16_t reserved_8_9 : 2;
uint16_t remote_capable_1000base_t_half : 1;
uint16_t remote_capable_1000base_t_full : 1;
uint16_t remote_receiver_ok : 1;
uint16_t local_receiver_ok : 1;
uint16_t is_master : 1;
uint16_t master_slave_fault : 1;
#endif
} s;
} bdk_mdio_phy_reg_status_1000_t;
/**
* PHY register 15 from the 802.3 spec
*/
#define BDK_MDIO_PHY_REG_EXTENDED_STATUS 15
typedef union
{
uint16_t u16;
struct
{
#if __BYTE_ORDER == __BIG_ENDIAN
uint16_t capable_1000base_x_full : 1;
uint16_t capable_1000base_x_half : 1;
uint16_t capable_1000base_t_full : 1;
uint16_t capable_1000base_t_half : 1;
uint16_t reserved_0_11 : 12;
#else
uint16_t reserved_0_11 : 12;
uint16_t capable_1000base_t_half : 1;
uint16_t capable_1000base_t_full : 1;
uint16_t capable_1000base_x_half : 1;
uint16_t capable_1000base_x_full : 1;
#endif
} s;
} bdk_mdio_phy_reg_extended_status_t;
/**
* PHY register 13 from the 802.3 spec
*/
#define BDK_MDIO_PHY_REG_MMD_CONTROL 13
typedef union
{
uint16_t u16;
struct
{
#if __BYTE_ORDER == __BIG_ENDIAN
uint16_t function : 2;
uint16_t reserved_5_13 : 9;
uint16_t devad : 5;
#else
uint16_t devad : 5;
uint16_t reserved_5_13 : 9;
uint16_t function : 2;
#endif
} s;
} bdk_mdio_phy_reg_mmd_control_t;
/**
* PHY register 14 from the 802.3 spec
*/
#define BDK_MDIO_PHY_REG_MMD_ADDRESS_DATA 14
typedef union
{
uint16_t u16;
struct
{
uint16_t address_data : 16;
} s;
} bdk_mdio_phy_reg_mmd_address_data_t;
/* MMD identifiers, mostly for accessing devices within XENPAK modules. */
#define BDK_MMD_DEVICE_PMA_PMD 1
#define BDK_MMD_DEVICE_WIS 2
#define BDK_MMD_DEVICE_PCS 3
#define BDK_MMD_DEVICE_PHY_XS 4
#define BDK_MMD_DEVICE_DTS_XS 5
#define BDK_MMD_DEVICE_TC 6
#define BDK_MMD_DEVICE_CL22_EXT 29
#define BDK_MMD_DEVICE_VENDOR_1 30
#define BDK_MMD_DEVICE_VENDOR_2 31
/**
* Perform an MII read. This function is used to read PHY
* registers controlling auto negotiation.
*
* @param node Node to use in a Numa setup. Can be an exact ID or a special
* value.
* @param bus_id MDIO bus number. Zero on most chips, but some chips (ex CN56XX)
* support multiple busses.
* @param phy_id The MII phy id
* @param location Register location to read
*
* @return Result from the read or -1 on failure
*/
extern int bdk_mdio_read(bdk_node_t node, int bus_id, int phy_id, int location);
/**
* Perform an MII write. This function is used to write PHY
* registers controlling auto negotiation.
*
* @param node Node to use in a Numa setup. Can be an exact ID or a special
* value.
* @param bus_id MDIO bus number. Zero on most chips, but some chips (ex CN56XX)
* support multiple busses.
* @param phy_id The MII phy id
* @param location Register location to write
* @param val Value to write
*
* @return -1 on error
* 0 on success
*/
extern int bdk_mdio_write(bdk_node_t node, int bus_id, int phy_id, int location, int val);
/**
* Perform an IEEE 802.3 clause 45 MII read. This function is used to read PHY
* registers controlling auto negotiation.
*
* @param node Node to use in a Numa setup. Can be an exact ID or a special
* value.
* @param bus_id MDIO bus number. Zero on most chips, but some chips (ex CN56XX)
* support multiple busses.
* @param phy_id The MII phy id
* @param device MDIO Manageable Device (MMD) id
* @param location Register location to read
*
* @return Result from the read or -1 on failure
*/
extern int bdk_mdio_45_read(bdk_node_t node, int bus_id, int phy_id, int device, int location);
/**
* Perform an IEEE 802.3 clause 45 MII write. This function is used to write PHY
* registers controlling auto negotiation.
*
* @param node Node to use in a Numa setup. Can be an exact ID or a special
* value.
* @param bus_id MDIO bus number. Zero on most chips, but some chips (ex CN56XX)
* support multiple busses.
* @param phy_id The MII phy id
* @param device MDIO Manageable Device (MMD) id
* @param location Register location to write
* @param val Value to write
*
* @return -1 on error
* 0 on success
*/
extern int bdk_mdio_45_write(bdk_node_t node, int bus_id, int phy_id, int device, int location,
int val);
int bdk_mdio_init(bdk_node_t node);
/** @} */
#endif
|
