ar8031_driver.c File Reference

AR8031 Gigabit Ethernet PHY driver. More...

#include "core/net.h"
#include "drivers/phy/ar8031_driver.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t ar8031Init (NetInterface *interface)
 AR8031 PHY transceiver initialization. More...
 
__weak_func void ar8031InitHook (NetInterface *interface)
 AR8031 custom configuration. More...
 
void ar8031Tick (NetInterface *interface)
 AR8031 timer handler. More...
 
void ar8031EnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void ar8031DisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void ar8031EventHandler (NetInterface *interface)
 AR8031 event handler. More...
 
void ar8031WritePhyReg (NetInterface *interface, uint8_t address, uint16_t data)
 Write PHY register. More...
 
uint16_t ar8031ReadPhyReg (NetInterface *interface, uint8_t address)
 Read PHY register. More...
 
void ar8031DumpPhyReg (NetInterface *interface)
 Dump PHY registers for debugging purpose. More...
 
void ar8031WriteMmdReg (NetInterface *interface, uint8_t devAddr, uint16_t regAddr, uint16_t data)
 Write MMD register. More...
 
uint16_t ar8031ReadMmdReg (NetInterface *interface, uint8_t devAddr, uint16_t regAddr)
 Read MMD register. More...
 

Variables

const PhyDriver ar8031PhyDriver
 AR8031 Ethernet PHY driver. More...
 

Detailed Description

AR8031 Gigabit Ethernet PHY driver.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.4.4

Definition in file ar8031_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file ar8031_driver.c.

Function Documentation

◆ ar8031DisableIrq()

void ar8031DisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 202 of file ar8031_driver.c.

◆ ar8031DumpPhyReg()

void ar8031DumpPhyReg ( NetInterface interface)

Dump PHY registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface

Definition at line 340 of file ar8031_driver.c.

◆ ar8031EnableIrq()

void ar8031EnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 187 of file ar8031_driver.c.

◆ ar8031EventHandler()

void ar8031EventHandler ( NetInterface interface)

AR8031 event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 217 of file ar8031_driver.c.

◆ ar8031Init()

error_t ar8031Init ( NetInterface interface)

AR8031 PHY transceiver initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 60 of file ar8031_driver.c.

◆ ar8031InitHook()

__weak_func void ar8031InitHook ( NetInterface interface)

AR8031 custom configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 139 of file ar8031_driver.c.

◆ ar8031ReadMmdReg()

uint16_t ar8031ReadMmdReg ( NetInterface interface,
uint8_t  devAddr,
uint16_t  regAddr 
)

Read MMD register.

Parameters
[in]interfaceUnderlying network interface
[in]devAddrDevice address
[in]regAddrRegister address
Returns
MMD register value

Definition at line 392 of file ar8031_driver.c.

◆ ar8031ReadPhyReg()

uint16_t ar8031ReadPhyReg ( NetInterface interface,
uint8_t  address 
)

Read PHY register.

Parameters
[in]interfaceUnderlying network interface
[in]addressPHY register address
Returns
Register value

Definition at line 314 of file ar8031_driver.c.

◆ ar8031Tick()

void ar8031Tick ( NetInterface interface)

AR8031 timer handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 149 of file ar8031_driver.c.

◆ ar8031WriteMmdReg()

void ar8031WriteMmdReg ( NetInterface interface,
uint8_t  devAddr,
uint16_t  regAddr,
uint16_t  data 
)

Write MMD register.

Parameters
[in]interfaceUnderlying network interface
[in]devAddrDevice address
[in]regAddrRegister address
[in]dataMMD register value

Definition at line 365 of file ar8031_driver.c.

◆ ar8031WritePhyReg()

void ar8031WritePhyReg ( NetInterface interface,
uint8_t  address,
uint16_t  data 
)

Write PHY register.

Parameters
[in]interfaceUnderlying network interface
[in]addressPHY register address
[in]dataRegister value

Definition at line 290 of file ar8031_driver.c.

Variable Documentation

◆ ar8031PhyDriver

const PhyDriver ar8031PhyDriver
Initial value:

AR8031 Ethernet PHY driver.

Definition at line 44 of file ar8031_driver.c.

void ar8031EventHandler(NetInterface *interface)
AR8031 event handler.
error_t ar8031Init(NetInterface *interface)
AR8031 PHY transceiver initialization.
Definition: ar8031_driver.c:60
void ar8031EnableIrq(NetInterface *interface)
Enable interrupts.
void ar8031Tick(NetInterface *interface)
AR8031 timer handler.
void ar8031DisableIrq(NetInterface *interface)
Disable interrupts.