[processor-sdk/performance-audio-sr.git] / psdk_cust / pdk_k2g_1_0_1_2_eng / packages / ti / csl / csl_mdio_def.h
1 /**
2 * @file csl_mdio.h
3 *
4 * @brief
5 * Header file for functional layer of CSL MDIO.
6 *
7 * It contains the various enumerations, structure definitions and function
8 * declarations
9 *
10 * \par
11 * ============================================================================
12 * @n (C) Copyright 2009-2013, Texas Instruments, Inc.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
16 * are met:
17 *
18 * Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 *
21 * Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the
24 * distribution.
25 *
26 * Neither the name of Texas Instruments Incorporated nor the names of
27 * its contributors may be used to endorse or promote products derived
28 * from this software without specific prior written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
31 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
32 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
33 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
34 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
36 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
37 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
38 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
39 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
40 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 *
42 */
44 /** ============================================================================
45 *
46 * @defgroup CSL_MDIO_API MDIO
47 *
48 * @section Introduction
49 *
50 * @subsection xxx Overview
51 *
52 * @subsection References
53 * -# Ethernet Media Access Controller User Guide
54 * ============================================================================
55 */
57 #ifndef CSL_MDIO_DEF_H
58 #define CSL_MDIO_DEF_H
60 #ifdef __cplusplus
61 extern "C" {
62 #endif
64 #include <ti/csl/soc.h>
65 #include <ti/csl/csl.h>
66 #include <ti/csl/cslr_mdio.h>
68 /**
69 @defgroup CSL_MDIO_SYMBOL MDIO Symbols Defined
70 @ingroup CSL_MDIO_API
71 */
72 /**
73 @defgroup CSL_MDIO_DATASTRUCT MDIO Data Structures
74 @ingroup CSL_MDIO_API
75 */
76 /**
77 @defgroup CSL_MDIO_FUNCTION MDIO Functions
78 @ingroup CSL_MDIO_API
79 */
80 /**
81 @defgroup CSL_MDIO_ENUM MDIO Enumerated Data Types
82 @ingroup CSL_MDIO_API
83 */
85 /**
86 @addtogroup CSL_MDIO_SYMBOL
87 @{
88 */
90 /**
91 @}
92 */
94 /** @addtogroup CSL_MDIO_DATASTRUCT
95 @{ */
97 /** @brief
98 *
99 * Holds the MDIO peripheral's version info.
100 */
101 typedef struct {
102 /** Minor revision value */
103 Uint32 revMin;
105 /** Major revision value */
106 Uint32 revMaj;
108 /** Identifies the type of peripheral */
109 Uint32 modId;
110 }CSL_MDIO_VERSION;
112 /** @brief
113 *
114 * Holds the MDIO User Access Register
115 * contents.
116 */
117 typedef struct {
118 /** Data bits */
119 Uint16 data;
121 /** Phy Device Address */
122 Uint32 phyAddr;
124 /** Register Address */
125 Uint32 regAddr;
127 /** Write bit */
128 Uint32 write;
130 /** Acknowledgment bit */
131 Uint32 ack;
133 /** GO bit */
134 Uint32 go;
135 }CSL_MDIO_USERACCESS;
137 /** @brief
138 *
139 * Holds the MDIO User Phy Select Register
140 * contents.
141 */
142 typedef struct {
143 /** Link Status determination select bit. Always reads '0' */
144 Uint16 linkSel;
146 /** Link Status Change Interrupt Enable bit */
147 Uint32 bLinkIntEnable;
149 /** Phy Device Address */
150 Uint32 phyAddr;
152 }CSL_MDIO_USERPHYSEL;
156 #ifdef __cplusplus
157 }
158 #endif
160 #endif /* _CSL_MDIO_DEF_H */