no_os_mdio.h File Reference

Header file for MDIO interface driver. More...

#include <stdbool.h>
#include <stdint.h>
#include "no_os_util.h"

Include dependency graph for no_os_mdio.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	no_os_mdio_init_param
	Parameters for an MDIO slave. More...
struct	no_os_mdio_desc
	MDIO device descriptor created with no_os_mdio_init(). More...
struct	no_os_mdio_ops
	Collection of MDIO ops that point to specific implementations. More...

Macros
#define	NO_OS_MDIO_C22_REGS   32
#define	NO_OS_MDIO_C45_START   0
#define	NO_OS_MDIO_C22_START   1
#define	NO_OS_MDIO_START_MASK   NO_OS_GENMASK(31, 30)
#define	NO_OS_MDIO_OP_ADDRESS   0
#define	NO_OS_MDIO_OP_WRITE   1
#define	NO_OS_MDIO_OP_READ   2
#define	NO_OS_MDIO_OP_MASK   NO_OS_GENMASK(29, 28)
#define	NO_OS_MDIO_PHYADDR_MASK   NO_OS_GENMASK(27, 23)
#define	NO_OS_MDIO_REGADDR_MASK   NO_OS_GENMASK(22, 18)
#define	NO_OS_MDIO_TURNAROUND   2
#define	NO_OS_MDIO_TURNAROUND_MASK   NO_OS_GENMASK(17, 16)
#define	NO_OS_MDIO_DATA_MASK   NO_OS_GENMASK(15, 0)
#define	NO_OS_MDIO_C45_DEVADDR_MASK   NO_OS_GENMASK(20, 16)
#define	NO_OS_MDIO_C45_ADDR(dev, reg)   (NO_OS_BIT(31) | no_os_field_prep(NO_OS_MDIO_C45_DEVADDR_MASK, dev) | (uint16_t)reg)

Functions
int	no_os_mdio_init (struct no_os_mdio_desc **desc, struct no_os_mdio_init_param *param)
	Initialize the MDIO interface. More...
int	no_os_mdio_remove (struct no_os_mdio_desc *desc)
	Free the resources allocated by no_os_mdio_init(). More...
int	no_os_mdio_write (struct no_os_mdio_desc *desc, uint32_t reg, uint16_t val)
	Write a register using MDIO. More...
int	no_os_mdio_read (struct no_os_mdio_desc *desc, uint32_t reg, uint16_t *val)
	Read a register using MDIO. More...

Detailed Description

Header file for MDIO interface driver.

Author

Darius Berghe (dariu.nosp@m.s.be.nosp@m.rghe@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2023(c) Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
• The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
• Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

NO_OS_MDIO_C22_REGS

#define NO_OS_MDIO_C22_REGS   32

NO_OS_MDIO_C22_START

#define NO_OS_MDIO_C22_START   1

NO_OS_MDIO_C45_ADDR

#define NO_OS_MDIO_C45_ADDR	(		dev,
			reg
	)		(NO_OS_BIT(31) | no_os_field_prep(NO_OS_MDIO_C45_DEVADDR_MASK, dev) | (uint16_t)reg)

NO_OS_MDIO_C45_DEVADDR_MASK

#define NO_OS_MDIO_C45_DEVADDR_MASK   NO_OS_GENMASK(20, 16)

NO_OS_MDIO_C45_START

#define NO_OS_MDIO_C45_START   0

NO_OS_MDIO_DATA_MASK

#define NO_OS_MDIO_DATA_MASK   NO_OS_GENMASK(15, 0)

NO_OS_MDIO_OP_ADDRESS

#define NO_OS_MDIO_OP_ADDRESS   0

NO_OS_MDIO_OP_MASK

#define NO_OS_MDIO_OP_MASK   NO_OS_GENMASK(29, 28)

NO_OS_MDIO_OP_READ

#define NO_OS_MDIO_OP_READ   2

NO_OS_MDIO_OP_WRITE

#define NO_OS_MDIO_OP_WRITE   1

NO_OS_MDIO_PHYADDR_MASK

#define NO_OS_MDIO_PHYADDR_MASK   NO_OS_GENMASK(27, 23)

NO_OS_MDIO_REGADDR_MASK

#define NO_OS_MDIO_REGADDR_MASK   NO_OS_GENMASK(22, 18)

NO_OS_MDIO_START_MASK

#define NO_OS_MDIO_START_MASK   NO_OS_GENMASK(31, 30)

NO_OS_MDIO_TURNAROUND

#define NO_OS_MDIO_TURNAROUND   2

NO_OS_MDIO_TURNAROUND_MASK

#define NO_OS_MDIO_TURNAROUND_MASK   NO_OS_GENMASK(17, 16)

Function Documentation

no_os_mdio_init()

int no_os_mdio_init	(	struct no_os_mdio_desc **	desc,
		struct no_os_mdio_init_param *	param
	)

Initialize the MDIO interface.

Parameters

desc	- The MDIO descriptor.
param	- MDIO parameters.

Returns

0 in case of success, error code otherwise.

Here is the caller graph for this function:

no_os_mdio_read()

int no_os_mdio_read	(	struct no_os_mdio_desc *	desc,
		uint32_t	reg,
		uint16_t *	val
	)

Read a register using MDIO.

Parameters

desc	- The MDIO descriptor.
reg	- Register address. For clause 45 reg is constructed using NO_OS_MDIO_C45_ADDR macro. It is otherwise the plain clause 22 address (0...31).
val	- Value read from register.

Returns

0 in case of success, error code otherwise.

Here is the caller graph for this function:

no_os_mdio_remove()

int no_os_mdio_remove

(

struct no_os_mdio_desc *

desc

)

Free the resources allocated by no_os_mdio_init().

Parameters

desc	- The MDIO descriptor.

Returns

0 in case of success, error code otherwise.

Here is the caller graph for this function:

no_os_mdio_write()

int no_os_mdio_write	(	struct no_os_mdio_desc *	desc,
		uint32_t	reg,
		uint16_t	val
	)

Write a register using MDIO.

Parameters

desc	- The MDIO descriptor.
reg	- Register address. For clause 45 reg is constructed using NO_OS_MDIO_C45_ADDR macro. It is otherwise the plain clause 22 address (0...31).
val	- Value to write into register.

Returns

0 in case of success, error code otherwise.

Here is the caller graph for this function: