Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
phy.h
Go to the documentation of this file.
1
7/*
8 * Copyright (c) 2021 IP-Logix Inc.
9 * Copyright 2022 NXP
10 *
11 * SPDX-License-Identifier: Apache-2.0
12 */
13#ifndef ZEPHYR_INCLUDE_DRIVERS_PHY_H_
14#define ZEPHYR_INCLUDE_DRIVERS_PHY_H_
15
24#include <zephyr/types.h>
25#include <zephyr/device.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
46
54#define PHY_LINK_IS_FULL_DUPLEX(x) (x & (BIT(1) | BIT(3) | BIT(5)))
55
63#define PHY_LINK_IS_SPEED_1000M(x) (x & (BIT(4) | BIT(5)))
64
72#define PHY_LINK_IS_SPEED_100M(x) (x & (BIT(2) | BIT(3)))
73
81
91typedef void (*phy_callback_t)(const struct device *dev,
92 struct phy_link_state *state,
93 void *user_data);
94
101__subsystem struct ethphy_driver_api {
103 int (*get_link)(const struct device *dev,
104 struct phy_link_state *state);
105
107 int (*cfg_link)(const struct device *dev,
108 enum phy_link_speed adv_speeds);
109
111 int (*link_cb_set)(const struct device *dev, phy_callback_t cb,
112 void *user_data);
113
115 int (*read)(const struct device *dev, uint16_t reg_addr,
116 uint32_t *data);
117
119 int (*write)(const struct device *dev, uint16_t reg_addr,
120 uint32_t data);
121};
138static inline int phy_configure_link(const struct device *dev,
139 enum phy_link_speed speeds)
140{
141 const struct ethphy_driver_api *api =
142 (const struct ethphy_driver_api *)dev->api;
143
144 return api->cfg_link(dev, speeds);
145}
146
160static inline int phy_get_link_state(const struct device *dev,
161 struct phy_link_state *state)
162{
163 const struct ethphy_driver_api *api =
164 (const struct ethphy_driver_api *)dev->api;
165
166 return api->get_link(dev, state);
167}
168
183static inline int phy_link_callback_set(const struct device *dev,
184 phy_callback_t callback,
185 void *user_data)
186{
187 const struct ethphy_driver_api *api =
188 (const struct ethphy_driver_api *)dev->api;
189
190 return api->link_cb_set(dev, callback, user_data);
191}
192
205static inline int phy_read(const struct device *dev, uint16_t reg_addr,
206 uint32_t *value)
207{
208 const struct ethphy_driver_api *api =
209 (const struct ethphy_driver_api *)dev->api;
210
211 return api->read(dev, reg_addr, value);
212}
213
226static inline int phy_write(const struct device *dev, uint16_t reg_addr,
227 uint32_t value)
228{
229 const struct ethphy_driver_api *api =
230 (const struct ethphy_driver_api *)dev->api;
231
232 return api->write(dev, reg_addr, value);
233}
234
235
236#ifdef __cplusplus
237}
238#endif
239
244#endif /* ZEPHYR_INCLUDE_DRIVERS_PHY_H_ */
static int phy_link_callback_set(const struct device *dev, phy_callback_t callback, void *user_data)
Set link state change callback.
Definition phy.h:183
void(* phy_callback_t)(const struct device *dev, struct phy_link_state *state, void *user_data)
Define the callback function signature for phy_link_callback_set() function.
Definition phy.h:91
static int phy_read(const struct device *dev, uint16_t reg_addr, uint32_t *value)
Read PHY registers.
Definition phy.h:205
static int phy_get_link_state(const struct device *dev, struct phy_link_state *state)
Get PHY link state.
Definition phy.h:160
static int phy_write(const struct device *dev, uint16_t reg_addr, uint32_t value)
Write PHY register.
Definition phy.h:226
phy_link_speed
Ethernet link speeds.
Definition phy.h:32
static int phy_configure_link(const struct device *dev, enum phy_link_speed speeds)
Configure PHY link.
Definition phy.h:138
@ LINK_HALF_100BASE_T
100Base-T Half-Duplex
Definition phy.h:38
@ LINK_HALF_10BASE_T
10Base-T Half-Duplex
Definition phy.h:34
@ LINK_FULL_1000BASE_T
1000Base-T Full-Duplex
Definition phy.h:44
@ LINK_FULL_10BASE_T
10Base-T Full-Duplex
Definition phy.h:36
@ LINK_FULL_100BASE_T
100Base-T Full-Duplex
Definition phy.h:40
@ LINK_HALF_1000BASE_T
1000Base-T Half-Duplex
Definition phy.h:42
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
state
Definition parser_state.h:29
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition device.h:412
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:418