1 /*
2 * Copyright (c) 2023 Aleksandr Senin
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7 #define DT_DRV_COMPAT zephyr_mdio_gpio
8
9 #include <zephyr/device.h>
10 #include <zephyr/init.h>
11 #include <zephyr/kernel.h>
12 #include <zephyr/drivers/gpio.h>
13 #include <zephyr/drivers/mdio.h>
14
15 #include <zephyr/logging/log.h>
16 LOG_MODULE_REGISTER(mdio_gpio, CONFIG_MDIO_LOG_LEVEL);
17
18 #define MDIO_GPIO_READ_OP 0
19 #define MDIO_GPIO_WRITE_OP 1
20 #define MDIO_GPIO_MSB 0x80000000
21
22 struct mdio_gpio_data {
23 struct k_sem sem;
24 };
25
26 struct mdio_gpio_config {
27 struct gpio_dt_spec mdc_gpio;
28 struct gpio_dt_spec mdio_gpio;
29 };
30
mdio_gpio_clock_the_bit(const struct mdio_gpio_config * dev_cfg)31 static ALWAYS_INLINE void mdio_gpio_clock_the_bit(const struct mdio_gpio_config *dev_cfg)
32 {
33 k_busy_wait(1);
34 gpio_pin_set_dt(&dev_cfg->mdc_gpio, 1);
35 k_busy_wait(1);
36 gpio_pin_set_dt(&dev_cfg->mdc_gpio, 0);
37 }
38
mdio_gpio_dir(const struct mdio_gpio_config * dev_cfg,uint8_t dir)39 static ALWAYS_INLINE void mdio_gpio_dir(const struct mdio_gpio_config *dev_cfg, uint8_t dir)
40 {
41 gpio_pin_configure_dt(&dev_cfg->mdio_gpio, dir ? GPIO_OUTPUT_ACTIVE : GPIO_INPUT);
42 if (dir == 0) {
43 mdio_gpio_clock_the_bit(dev_cfg);
44 }
45 }
46
mdio_gpio_read(const struct mdio_gpio_config * dev_cfg,uint16_t * pdata)47 static ALWAYS_INLINE void mdio_gpio_read(const struct mdio_gpio_config *dev_cfg, uint16_t *pdata)
48 {
49 uint16_t data = 0;
50
51 for (uint16_t i = 0; i < 16; i++) {
52 data <<= 1;
53 mdio_gpio_clock_the_bit(dev_cfg);
54 if (gpio_pin_get_dt(&dev_cfg->mdio_gpio) == 1) {
55 data |= 1;
56 }
57 }
58
59 *pdata = data;
60 }
61
mdio_gpio_write(const struct mdio_gpio_config * dev_cfg,uint32_t data,uint8_t len)62 static ALWAYS_INLINE void mdio_gpio_write(const struct mdio_gpio_config *dev_cfg,
63 uint32_t data, uint8_t len)
64 {
65 uint32_t v_data = data;
66 uint32_t v_len = len;
67
68 v_data <<= 32 - v_len;
69 for (; v_len > 0; v_len--) {
70 gpio_pin_set_dt(&dev_cfg->mdio_gpio, (v_data & MDIO_GPIO_MSB) ? 1 : 0);
71 mdio_gpio_clock_the_bit(dev_cfg);
72 v_data <<= 1;
73 }
74 }
75
mdio_gpio_transfer(const struct device * dev,uint8_t prtad,uint8_t devad,uint8_t rw,uint16_t data_in,uint16_t * data_out)76 static int mdio_gpio_transfer(const struct device *dev, uint8_t prtad, uint8_t devad, uint8_t rw,
77 uint16_t data_in, uint16_t *data_out)
78 {
79 const struct mdio_gpio_config *const dev_cfg = dev->config;
80 struct mdio_gpio_data *const dev_data = dev->data;
81
82 k_sem_take(&dev_data->sem, K_FOREVER);
83
84 /* DIR: output */
85 mdio_gpio_dir(dev_cfg, MDIO_GPIO_WRITE_OP);
86 /* PRE32: 32 bits '1' for sync*/
87 mdio_gpio_write(dev_cfg, 0xFFFFFFFF, 32);
88 /* ST: 2 bits start of frame */
89 mdio_gpio_write(dev_cfg, 0x1, 2);
90 /* OP: 2 bits opcode, read '10' or write '01' */
91 mdio_gpio_write(dev_cfg, rw ? 0x1 : 0x2, 2);
92 /* PA5: 5 bits PHY address */
93 mdio_gpio_write(dev_cfg, prtad, 5);
94 /* RA5: 5 bits register address */
95 mdio_gpio_write(dev_cfg, devad, 5);
96
97 if (rw) { /* Write data */
98 /* TA: 2 bits turn-around */
99 mdio_gpio_write(dev_cfg, 0x2, 2);
100 mdio_gpio_write(dev_cfg, data_in, 16);
101 } else { /* Read data */
102 /* Release the MDIO line */
103 mdio_gpio_dir(dev_cfg, MDIO_GPIO_READ_OP);
104 mdio_gpio_read(dev_cfg, data_out);
105 }
106
107 /* DIR: input. Tristate MDIO line */
108 mdio_gpio_dir(dev_cfg, MDIO_GPIO_READ_OP);
109
110 k_sem_give(&dev_data->sem);
111
112 return 0;
113 }
114
mdio_gpio_read_mmi(const struct device * dev,uint8_t prtad,uint8_t devad,uint16_t * data)115 static int mdio_gpio_read_mmi(const struct device *dev, uint8_t prtad, uint8_t devad,
116 uint16_t *data)
117 {
118 return mdio_gpio_transfer(dev, prtad, devad, MDIO_GPIO_READ_OP, 0, data);
119 }
120
mdio_gpio_write_mmi(const struct device * dev,uint8_t prtad,uint8_t devad,uint16_t data)121 static int mdio_gpio_write_mmi(const struct device *dev, uint8_t prtad, uint8_t devad,
122 uint16_t data)
123 {
124 return mdio_gpio_transfer(dev, prtad, devad, MDIO_GPIO_WRITE_OP, data, NULL);
125 }
126
mdio_gpio_initialize(const struct device * dev)127 static int mdio_gpio_initialize(const struct device *dev)
128 {
129 const struct mdio_gpio_config *const dev_cfg = dev->config;
130 struct mdio_gpio_data *const dev_data = dev->data;
131 int rc;
132
133 k_sem_init(&dev_data->sem, 1, 1);
134
135 if (!device_is_ready(dev_cfg->mdc_gpio.port)) {
136 LOG_ERR("GPIO port for MDC pin is not ready");
137 return -ENODEV;
138 }
139
140 if (!device_is_ready(dev_cfg->mdio_gpio.port)) {
141 LOG_ERR("GPIO port for MDIO pin is not ready");
142 return -ENODEV;
143 }
144
145 rc = gpio_pin_configure_dt(&dev_cfg->mdc_gpio, GPIO_OUTPUT_INACTIVE);
146 if (rc < 0) {
147 LOG_ERR("Couldn't configure MDC pin; (%d)", rc);
148 return rc;
149 }
150
151 rc = gpio_pin_configure_dt(&dev_cfg->mdio_gpio, GPIO_INPUT);
152 if (rc < 0) {
153 LOG_ERR("Couldn't configure MDIO pin; (%d)", rc);
154 return rc;
155 }
156
157 return 0;
158 }
159
mdio_gpio_bus_enable(const struct device * dev)160 static void mdio_gpio_bus_enable(const struct device *dev)
161 {
162 ARG_UNUSED(dev);
163 }
164
mdio_gpio_bus_disable(const struct device * dev)165 static void mdio_gpio_bus_disable(const struct device *dev)
166 {
167 ARG_UNUSED(dev);
168 }
169
170 static const struct mdio_driver_api mdio_gpio_driver_api = {
171 .read = mdio_gpio_read_mmi,
172 .write = mdio_gpio_write_mmi,
173 .bus_enable = mdio_gpio_bus_enable,
174 .bus_disable = mdio_gpio_bus_disable,
175 };
176
177 #define MDIO_GPIO_CONFIG(inst) \
178 static struct mdio_gpio_config mdio_gpio_dev_config_##inst = { \
179 .mdc_gpio = GPIO_DT_SPEC_INST_GET(inst, mdc_gpios), \
180 .mdio_gpio = GPIO_DT_SPEC_INST_GET(inst, mdio_gpios), \
181 };
182
183 #define MDIO_GPIO_DEVICE(inst) \
184 MDIO_GPIO_CONFIG(inst); \
185 static struct mdio_gpio_data mdio_gpio_dev_data_##inst; \
186 DEVICE_DT_INST_DEFINE(inst, &mdio_gpio_initialize, NULL, &mdio_gpio_dev_data_##inst, \
187 &mdio_gpio_dev_config_##inst, POST_KERNEL, \
188 CONFIG_MDIO_INIT_PRIORITY, &mdio_gpio_driver_api);
189
190 DT_INST_FOREACH_STATUS_OKAY(MDIO_GPIO_DEVICE)
191
