ksz9031_driver.c File Reference

KSZ9031 Gigabit Ethernet PHY driver. More...

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

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   NIC_TRACE_LEVEL

Functions
error_t	ksz9031Init (NetInterface *interface)
	KSZ9031 PHY transceiver initialization. More...
__weak_func void	ksz9031InitHook (NetInterface *interface)
	KSZ9031 custom configuration. More...
void	ksz9031Tick (NetInterface *interface)
	KSZ9031 timer handler. More...
void	ksz9031EnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	ksz9031DisableIrq (NetInterface *interface)
	Disable interrupts. More...
void	ksz9031EventHandler (NetInterface *interface)
	KSZ9031 event handler. More...
void	ksz9031WritePhyReg (NetInterface *interface, uint8_t address, uint16_t data)
	Write PHY register. More...
uint16_t	ksz9031ReadPhyReg (NetInterface *interface, uint8_t address)
	Read PHY register. More...
void	ksz9031DumpPhyReg (NetInterface *interface)
	Dump PHY registers for debugging purpose. More...
void	ksz9031WriteMmdReg (NetInterface *interface, uint8_t devAddr, uint16_t regAddr, uint16_t data)
	Write MMD register. More...
uint16_t	ksz9031ReadMmdReg (NetInterface *interface, uint8_t devAddr, uint16_t regAddr)
	Read MMD register. More...

Variables
const PhyDriver	ksz9031PhyDriver
	KSZ9031 Ethernet PHY driver. More...

Detailed Description

KSZ9031 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 ksz9031_driver.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file ksz9031_driver.c.

Function Documentation

ksz9031DisableIrq()

void ksz9031DisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 195 of file ksz9031_driver.c.

ksz9031DumpPhyReg()

void ksz9031DumpPhyReg

(

NetInterface *

interface

)

Dump PHY registers for debugging purpose.

Parameters

[in]

interface

Underlying network interface

Definition at line 338 of file ksz9031_driver.c.

ksz9031EnableIrq()

void ksz9031EnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 180 of file ksz9031_driver.c.

ksz9031EventHandler()

void ksz9031EventHandler

(

NetInterface *

interface

)

KSZ9031 event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 210 of file ksz9031_driver.c.

ksz9031Init()

error_t ksz9031Init

(

NetInterface *

interface

)

KSZ9031 PHY transceiver initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 60 of file ksz9031_driver.c.

ksz9031InitHook()

__weak_func void ksz9031InitHook

(

NetInterface *

interface

)

KSZ9031 custom configuration.

Parameters

[in]

interface

Underlying network interface

Definition at line 132 of file ksz9031_driver.c.

ksz9031ReadMmdReg()

uint16_t ksz9031ReadMmdReg	(	NetInterface *	interface,
		uint8_t	devAddr,
		uint16_t	regAddr
	)

Read MMD register.

Parameters

[in]	interface	Underlying network interface
[in]	devAddr	Device address
[in]	regAddr	Register address

Returns

MMD register value

Definition at line 390 of file ksz9031_driver.c.

ksz9031ReadPhyReg()

uint16_t ksz9031ReadPhyReg	(	NetInterface *	interface,
		uint8_t	address
	)

Read PHY register.

Parameters

[in]	interface	Underlying network interface
[in]	address	PHY register address

Returns

Register value

Definition at line 312 of file ksz9031_driver.c.

ksz9031Tick()

void ksz9031Tick

(

NetInterface *

interface

)

KSZ9031 timer handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 142 of file ksz9031_driver.c.

ksz9031WriteMmdReg()

void ksz9031WriteMmdReg	(	NetInterface *	interface,
		uint8_t	devAddr,
		uint16_t	regAddr,
		uint16_t	data
	)

Write MMD register.

Parameters

[in]	interface	Underlying network interface
[in]	devAddr	Device address
[in]	regAddr	Register address
[in]	data	MMD register value

Definition at line 363 of file ksz9031_driver.c.

ksz9031WritePhyReg()

void ksz9031WritePhyReg	(	NetInterface *	interface,
		uint8_t	address,
		uint16_t	data
	)

Write PHY register.

Parameters

[in]	interface	Underlying network interface
[in]	address	PHY register address
[in]	data	Register value

Definition at line 288 of file ksz9031_driver.c.

Variable Documentation

ksz9031PhyDriver

const PhyDriver ksz9031PhyDriver

Initial value:

=
{
   ksz9031Init,
   ksz9031Tick,
   ksz9031EnableIrq,
   ksz9031DisableIrq,
   ksz9031EventHandler
}

KSZ9031 Ethernet PHY driver.

Definition at line 44 of file ksz9031_driver.c.