bsp/ti_herc/reg_mdio.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsARMTMS570
0007  *
0008  * @brief This header file provides MDIO interfaces.
0009  */
0010
0011 /* The header file is generated by make_header.py from MDIO.json */
0012 /* Current script's version can be found at: */
0013 /* https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
0014
0015 /*
0016  * Copyright (c) 2014-2015, Premysl Houdek <kom541000@gmail.com>
0017  *
0018  * Czech Technical University in Prague
0019  * Zikova 1903/4
0020  * 166 36 Praha 6
0021  * Czech Republic
0022  *
0023  * All rights reserved.
0024  *
0025  * Redistribution and use in source and binary forms, with or without
0026  * modification, are permitted provided that the following conditions are met:
0027  *
0028  * 1. Redistributions of source code must retain the above copyright notice, this
0029  *    list of conditions and the following disclaimer.
0030  * 2. Redistributions in binary form must reproduce the above copyright notice,
0031  *    this list of conditions and the following disclaimer in the documentation
0032  *    and/or other materials provided with the distribution.
0033  *
0034  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
0035  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
0036  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
0037  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
0038  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
0039  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
0040  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
0041  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0042  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
0043  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0044  *
0045  * The views and conclusions contained in the software and documentation are those
0046  * of the authors and should not be interpreted as representing official policies,
0047  * either expressed or implied, of the FreeBSD Project.
0048 */
0049 #ifndef LIBBSP_ARM_TMS570_MDIO
0050 #define LIBBSP_ARM_TMS570_MDIO
0051
0052 #include <bsp/utility.h>
0053
0054 typedef struct{
0055   uint32_t REVID;             /*MDIO Revision ID Register*/
0056   uint32_t CONTROL;           /*MDIO Control Register*/
0057   uint32_t ALIVE;             /*PHY Alive Status register*/
0058   uint32_t LINK;              /*PHY Link Status Register*/
0059   uint32_t LINKINTRAW;        /*MDIO Link Status Change Interrupt (Unmasked) Register*/
0060   uint32_t LINKINTMASKED;     /*MDIO Link Status Change Interrupt (Masked) Register*/
0061   uint8_t reserved1 [8];
0062   uint32_t USERINTRAW;        /*MDIO User Command Complete Interrupt (Unmasked) Register*/
0063   uint32_t USERINTMASKED;     /*MDIO User Command Complete Interrupt (Masked) Register*/
0064   uint32_t USERINTMASKSET;    /*MDIO User Command Complete Interrupt Mask Set Register*/
0065   uint32_t USERINTMASKCLEAR;  /*MDIO User Command Complete Interrupt Mask Clear Register*/
0066   uint8_t reserved2 [80];
0067   uint32_t USERACCESS0;       /*MDIO User Access Register 0*/
0068   uint32_t USERPHYSEL0;       /*MDIO User PHY Select Register 0*/
0069   uint32_t USERACCESS1;       /*MDIO User Access Register 1*/
0070   uint32_t USERPHYSEL1;       /*MDIO User PHY Select Register 1*/
0071 } tms570_mdio_t;
0072
0073
0074 /*---------------------TMS570_MDIO_REVID---------------------*/
0075 /* field: REV - Identifies the MDIO Module revision. */
0076 /* Whole 32 bits */
0077
0078 /*--------------------TMS570_MDIO_CONTROL--------------------*/
0079 /* field: IDLE - State machine IDLE status bit. */
0080 #define TMS570_MDIO_CONTROL_IDLE BSP_BIT32(31)
0081
0082 /* field: ENABLE - State machine enable control bit. */
0083 #define TMS570_MDIO_CONTROL_ENABLE BSP_BIT32(30)
0084
0085 /* field: HIGHEST_USER_CHANNEL - Highest user channel that is available in the module. It is currently set to 1. */
0086 #define TMS570_MDIO_CONTROL_HIGHEST_USER_CHANNEL(val) BSP_FLD32(val,24, 28)
0087 #define TMS570_MDIO_CONTROL_HIGHEST_USER_CHANNEL_GET(reg) BSP_FLD32GET(reg,24, 28)
0088 #define TMS570_MDIO_CONTROL_HIGHEST_USER_CHANNEL_SET(reg,val) BSP_FLD32SET(reg, val,24, 28)
0089
0090 /* field: PREAMBLE - Preamble disable */
0091 #define TMS570_MDIO_CONTROL_PREAMBLE BSP_BIT32(20)
0092
0093 /* field: FAULT - Fault indicator. */
0094 #define TMS570_MDIO_CONTROL_FAULT BSP_BIT32(19)
0095
0096 /* field: FAULTENB - Fault detect enable. */
0097 #define TMS570_MDIO_CONTROL_FAULTENB BSP_BIT32(18)
0098
0099 /* field: CLKDIV - Clock Divider bits. */
0100 #define TMS570_MDIO_CONTROL_CLKDIV(val) BSP_FLD32(val,0, 15)
0101 #define TMS570_MDIO_CONTROL_CLKDIV_GET(reg) BSP_FLD32GET(reg,0, 15)
0102 #define TMS570_MDIO_CONTROL_CLKDIV_SET(reg,val) BSP_FLD32SET(reg, val,0, 15)
0103
0104
0105 /*---------------------TMS570_MDIO_ALIVE---------------------*/
0106 /* field: ALIVE - MDIO Alive bits. */
0107 /* Whole 32 bits */
0108
0109 /*----------------------TMS570_MDIO_LINK----------------------*/
0110 /* field: LINK - MDIO Link state bits. This register is updated after a read of the generic status register of a PHY. */
0111 /* Whole 32 bits */
0112
0113 /*-------------------TMS570_MDIO_LINKINTRAW-------------------*/
0114 /* field: USERPHY1 - MDIO Link change event, raw value. */
0115 #define TMS570_MDIO_LINKINTRAW_USERPHY1 BSP_BIT32(1)
0116
0117 /* field: USERPHY0 - MDIO Link change event, raw value. */
0118 #define TMS570_MDIO_LINKINTRAW_USERPHY0 BSP_BIT32(0)
0119
0120
0121 /*-----------------TMS570_MDIO_LINKINTMASKED-----------------*/
0122 /* field: USERPHY1 - MDIO Link change interrupt, masked value. */
0123 #define TMS570_MDIO_LINKINTMASKED_USERPHY1 BSP_BIT32(1)
0124
0125 /* field: USERPHY0 - MDIO Link change interrupt, masked value. */
0126 #define TMS570_MDIO_LINKINTMASKED_USERPHY0 BSP_BIT32(0)
0127
0128
0129 /*-------------------TMS570_MDIO_USERINTRAW-------------------*/
0130 /* field: USERACCESS1 - MDIO User command complete event bit. */
0131 #define TMS570_MDIO_USERINTRAW_USERACCESS1 BSP_BIT32(1)
0132
0133 /* field: USERACCESS0 - MDIO User command complete event bit. */
0134 #define TMS570_MDIO_USERINTRAW_USERACCESS0 BSP_BIT32(0)
0135
0136
0137 /*-----------------TMS570_MDIO_USERINTMASKED-----------------*/
0138 /* field: USERACCESS1 - Masked value of MDIO User command complete interrupt. */
0139 #define TMS570_MDIO_USERINTMASKED_USERACCESS1 BSP_BIT32(1)
0140
0141 /* field: USERACCESS0 - Masked value of MDIO User command complete interrupt. */
0142 #define TMS570_MDIO_USERINTMASKED_USERACCESS0 BSP_BIT32(0)
0143
0144
0145 /*-----------------TMS570_MDIO_USERINTMASKSET-----------------*/
0146 /* field: USERACCESS1 - MDIO user interrupt mask set for USERINTMASKED[1]. */
0147 #define TMS570_MDIO_USERINTMASKSET_USERACCESS1 BSP_BIT32(1)
0148
0149 /* field: USERACCESS0 - MDIO user interrupt mask set for USERINTMASKED[0]. */
0150 #define TMS570_MDIO_USERINTMASKSET_USERACCESS0 BSP_BIT32(0)
0151
0152
0153 /*----------------TMS570_MDIO_USERINTMASKCLEAR----------------*/
0154 /* field: USERACCESS1 - MDIO user command complete interrupt mask clear for USERINTMASKED[1]. */
0155 #define TMS570_MDIO_USERINTMASKCLEAR_USERACCESS1 BSP_BIT32(1)
0156
0157 /* field: USERACCESS0 - MDIO user command complete interrupt mask clear for USERINTMASKED[0]. */
0158 #define TMS570_MDIO_USERINTMASKCLEAR_USERACCESS0 BSP_BIT32(0)
0159
0160
0161 /*------------------TMS570_MDIO_USERACCESS0------------------*/
0162 /* field: GO - Go bit. */
0163 #define TMS570_MDIO_USERACCESS0_GO BSP_BIT32(31)
0164
0165 /* field: WRITE - Write enable bit. */
0166 #define TMS570_MDIO_USERACCESS0_WRITE BSP_BIT32(30)
0167
0168 /* field: ACK - Acknowledge bit. This bit is set if the PHY acknowledged the read transaction. */
0169 #define TMS570_MDIO_USERACCESS0_ACK BSP_BIT32(29)
0170
0171 /* field: REGADR - Register address bits. */
0172 #define TMS570_MDIO_USERACCESS0_REGADR(val) BSP_FLD32(val,21, 25)
0173 #define TMS570_MDIO_USERACCESS0_REGADR_GET(reg) BSP_FLD32GET(reg,21, 25)
0174 #define TMS570_MDIO_USERACCESS0_REGADR_SET(reg,val) BSP_FLD32SET(reg, val,21, 25)
0175
0176 /* field: PHYADR - PHY address bits. This field specifies the PHY to be accessed for this transaction. */
0177 #define TMS570_MDIO_USERACCESS0_PHYADR(val) BSP_FLD32(val,16, 20)
0178 #define TMS570_MDIO_USERACCESS0_PHYADR_GET(reg) BSP_FLD32GET(reg,16, 20)
0179 #define TMS570_MDIO_USERACCESS0_PHYADR_SET(reg,val) BSP_FLD32SET(reg, val,16, 20)
0180
0181 /* field: DATA - User data bits. */
0182 #define TMS570_MDIO_USERACCESS0_DATA(val) BSP_FLD32(val,0, 15)
0183 #define TMS570_MDIO_USERACCESS0_DATA_GET(reg) BSP_FLD32GET(reg,0, 15)
0184 #define TMS570_MDIO_USERACCESS0_DATA_SET(reg,val) BSP_FLD32SET(reg, val,0, 15)
0185
0186
0187 /*------------------TMS570_MDIO_USERPHYSEL0------------------*/
0188 /* field: LINKSEL - Link status determination select bit. */
0189 #define TMS570_MDIO_USERPHYSEL0_LINKSEL BSP_BIT32(7)
0190
0191 /* field: LINKINTENB - Link change interrupt enable. */
0192 #define TMS570_MDIO_USERPHYSEL0_LINKINTENB BSP_BIT32(6)
0193
0194 /* field: PHYADRMON - PHY address whose link status is to be monitored. */
0195 #define TMS570_MDIO_USERPHYSEL0_PHYADRMON(val) BSP_FLD32(val,0, 4)
0196 #define TMS570_MDIO_USERPHYSEL0_PHYADRMON_GET(reg) BSP_FLD32GET(reg,0, 4)
0197 #define TMS570_MDIO_USERPHYSEL0_PHYADRMON_SET(reg,val) BSP_FLD32SET(reg, val,0, 4)
0198
0199
0200 /*------------------TMS570_MDIO_USERACCESS1------------------*/
0201 /* field: GO - Go bit. */
0202 #define TMS570_MDIO_USERACCESS1_GO BSP_BIT32(31)
0203
0204 /* field: WRITE - Write enable bit. */
0205 #define TMS570_MDIO_USERACCESS1_WRITE BSP_BIT32(30)
0206
0207 /* field: ACK - Acknowledge bit. This bit is set if the PHY acknowledged the read transaction. */
0208 #define TMS570_MDIO_USERACCESS1_ACK BSP_BIT32(29)
0209
0210 /* field: REGADR - Register address bits. */
0211 #define TMS570_MDIO_USERACCESS1_REGADR(val) BSP_FLD32(val,21, 25)
0212 #define TMS570_MDIO_USERACCESS1_REGADR_GET(reg) BSP_FLD32GET(reg,21, 25)
0213 #define TMS570_MDIO_USERACCESS1_REGADR_SET(reg,val) BSP_FLD32SET(reg, val,21, 25)
0214
0215 /* field: PHYADR - PHY address bits. This field specifies the PHY to be accessed for this transaction. */
0216 #define TMS570_MDIO_USERACCESS1_PHYADR(val) BSP_FLD32(val,16, 20)
0217 #define TMS570_MDIO_USERACCESS1_PHYADR_GET(reg) BSP_FLD32GET(reg,16, 20)
0218 #define TMS570_MDIO_USERACCESS1_PHYADR_SET(reg,val) BSP_FLD32SET(reg, val,16, 20)
0219
0220 /* field: DATA - User data bits. */
0221 #define TMS570_MDIO_USERACCESS1_DATA(val) BSP_FLD32(val,0, 15)
0222 #define TMS570_MDIO_USERACCESS1_DATA_GET(reg) BSP_FLD32GET(reg,0, 15)
0223 #define TMS570_MDIO_USERACCESS1_DATA_SET(reg,val) BSP_FLD32SET(reg, val,0, 15)
0224
0225
0226 /*------------------TMS570_MDIO_USERPHYSEL1------------------*/
0227 /* field: LINKSEL - Link status determination select bit. */
0228 #define TMS570_MDIO_USERPHYSEL1_LINKSEL BSP_BIT32(7)
0229
0230 /* field: LINKINTENB - Link change interrupt enable. */
0231 #define TMS570_MDIO_USERPHYSEL1_LINKINTENB BSP_BIT32(6)
0232
0233 /* field: PHYADRMON - PHY address whose link status is to be monitored. */
0234 #define TMS570_MDIO_USERPHYSEL1_PHYADRMON(val) BSP_FLD32(val,0, 4)
0235 #define TMS570_MDIO_USERPHYSEL1_PHYADRMON_GET(reg) BSP_FLD32GET(reg,0, 4)
0236 #define TMS570_MDIO_USERPHYSEL1_PHYADRMON_SET(reg,val) BSP_FLD32SET(reg, val,0, 4)
0237
0238
0239
0240 #endif /* LIBBSP_ARM_TMS570_MDIO */