Zephyr API Documentation 4.0.0-rc2
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
50
58#define PHY_LINK_IS_FULL_DUPLEX(x) (x & (BIT(1) | BIT(3) | BIT(5) | BIT(6) | BIT(7)))
59
67#define PHY_LINK_IS_SPEED_1000M(x) (x & (BIT(4) | BIT(5)))
68
76#define PHY_LINK_IS_SPEED_100M(x) (x & (BIT(2) | BIT(3)))
77
85
95typedef void (*phy_callback_t)(const struct device *dev,
96 struct phy_link_state *state,
97 void *user_data);
98
105__subsystem struct ethphy_driver_api {
107 int (*get_link)(const struct device *dev,
108 struct phy_link_state *state);
109
111 int (*cfg_link)(const struct device *dev,
112 enum phy_link_speed adv_speeds);
113
115 int (*link_cb_set)(const struct device *dev, phy_callback_t cb,
116 void *user_data);
117
119 int (*read)(const struct device *dev, uint16_t reg_addr,
120 uint32_t *data);
121
123 int (*write)(const struct device *dev, uint16_t reg_addr,
124 uint32_t data);
125};
142static inline int phy_configure_link(const struct device *dev,
143 enum phy_link_speed speeds)
144{
145 const struct ethphy_driver_api *api =
146 (const struct ethphy_driver_api *)dev->api;
147
148 return api->cfg_link(dev, speeds);
149}
150
164static inline int phy_get_link_state(const struct device *dev,
165 struct phy_link_state *state)
166{
167 const struct ethphy_driver_api *api =
168 (const struct ethphy_driver_api *)dev->api;
169
170 return api->get_link(dev, state);
171}
172
187static inline int phy_link_callback_set(const struct device *dev,
188 phy_callback_t callback,
189 void *user_data)
190{
191 const struct ethphy_driver_api *api =
192 (const struct ethphy_driver_api *)dev->api;
193
194 return api->link_cb_set(dev, callback, user_data);
195}
196
209static inline int phy_read(const struct device *dev, uint16_t reg_addr,
210 uint32_t *value)
211{
212 const struct ethphy_driver_api *api =
213 (const struct ethphy_driver_api *)dev->api;
214
215 return api->read(dev, reg_addr, value);
216}
217
230static inline int phy_write(const struct device *dev, uint16_t reg_addr,
231 uint32_t value)
232{
233 const struct ethphy_driver_api *api =
234 (const struct ethphy_driver_api *)dev->api;
235
236 return api->write(dev, reg_addr, value);
237}
238
239
240#ifdef __cplusplus
241}
242#endif
243
248#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:187
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:95
static int phy_read(const struct device *dev, uint16_t reg_addr, uint32_t *value)
Read PHY registers.
Definition phy.h:209
static int phy_get_link_state(const struct device *dev, struct phy_link_state *state)
Get PHY link state.
Definition phy.h:164
static int phy_write(const struct device *dev, uint16_t reg_addr, uint32_t value)
Write PHY register.
Definition phy.h:230
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:142
@ LINK_HALF_100BASE_T
100Base-T Half-Duplex
Definition phy.h:38
@ LINK_FULL_2500BASE_T
2.5GBase-T Full-Duplex
Definition phy.h:46
@ LINK_HALF_10BASE_T
10Base-T Half-Duplex
Definition phy.h:34
@ LINK_FULL_5000BASE_T
5GBase-T Full-Duplex
Definition phy.h:48
@ 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