xref: /freebsd/sys/contrib/ncsw/inc/Peripherals/mii_acc_ext.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /*
2  * Copyright 2008-2012 Freescale Semiconductor Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *     * Redistributions of source code must retain the above copyright
7  *       notice, this list of conditions and the following disclaimer.
8  *     * Redistributions in binary form must reproduce the above copyright
9  *       notice, this list of conditions and the following disclaimer in the
10  *       documentation and/or other materials provided with the distribution.
11  *     * Neither the name of Freescale Semiconductor nor the
12  *       names of its contributors may be used to endorse or promote products
13  *       derived from this software without specific prior written permission.
14  *
15  *
16  * ALTERNATIVELY, this software may be distributed under the terms of the
17  * GNU General Public License ("GPL") as published by the Free Software
18  * Foundation, either version 2 of that License or (at your option) any
19  * later version.
20  *
21  * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
22  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24  * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
25  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
28  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 
34 
35 #ifndef __MII_ACC_EXT_H
36 #define __MII_ACC_EXT_H
37 
38 
39 /**************************************************************************//**
40  @Function      MII_ReadPhyReg
41 
42  @Description   This routine is called to read a specified PHY
43                 register value.
44 
45  @Param[in]     h_MiiAccess - Handle to MII configuration access registers
46  @Param[in]     phyAddr     - PHY address (0-31).
47  @Param[in]     reg         - PHY register to read
48  @Param[out]    p_Data      - Gets the register value.
49 
50  @Return        Always zero (success).
51 *//***************************************************************************/
52 int MII_ReadPhyReg(t_Handle h_MiiAccess,
53                    uint8_t  phyAddr,
54                    uint8_t  reg,
55                    uint16_t *p_Data);
56 
57 /**************************************************************************//**
58  @Function      MII_WritePhyReg
59 
60  @Description   This routine is called to write data to a specified PHY
61                    register.
62 
63  @Param[in]     h_MiiAccess - Handle to MII configuration access registers
64  @Param[in]     phyAddr     - PHY address (0-31).
65  @Param[in]     reg         - PHY register to write
66  @Param[in]     data        - Data to write in register.
67 
68  @Return        Always zero (success).
69 *//***************************************************************************/
70 int MII_WritePhyReg(t_Handle    h_MiiAccess,
71                     uint8_t     phyAddr,
72                     uint8_t     reg,
73                     uint16_t    data);
74 
75 
76 #endif /* __MII_ACC_EXT_H */
77