2 * Copyright 2016 Michal Meloun <mmel@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include "opt_platform.h"
31 #include <sys/param.h>
32 #include <sys/kernel.h>
35 #include <sys/malloc.h>
36 #include <sys/queue.h>
37 #include <sys/systm.h>
41 #include <dev/ofw/ofw_bus.h>
42 #include <dev/ofw/ofw_bus_subr.h>
45 #include <dev/extres/phy/phy.h>
46 #include <dev/extres/phy/phy_internal.h>
48 #include "phydev_if.h"
50 MALLOC_DEFINE(M_PHY, "phy", "Phy framework");
52 /* Default phy methods. */
53 static int phynode_method_init(struct phynode *phynode);
54 static int phynode_method_enable(struct phynode *phynode, bool disable);
55 static int phynode_method_status(struct phynode *phynode, int *status);
59 * Phy controller methods.
61 static phynode_method_t phynode_methods[] = {
62 PHYNODEMETHOD(phynode_init, phynode_method_init),
63 PHYNODEMETHOD(phynode_enable, phynode_method_enable),
64 PHYNODEMETHOD(phynode_status, phynode_method_status),
68 DEFINE_CLASS_0(phynode, phynode_class, phynode_methods, 0);
70 static phynode_list_t phynode_list = TAILQ_HEAD_INITIALIZER(phynode_list);
72 SX_SYSINIT(phy_topology, &phynode_topo_lock, "Phy topology lock");
74 /* ----------------------------------------------------------------------------
76 * Default phy methods for base class.
81 phynode_method_init(struct phynode *phynode)
88 phynode_method_enable(struct phynode *phynode, bool enable)
98 phynode_method_status(struct phynode *phynode, int *status)
100 *status = PHY_STATUS_ENABLED;
104 /* ----------------------------------------------------------------------------
106 * Internal functions.
110 * Create and initialize phy object, but do not register it.
113 phynode_create(device_t pdev, phynode_class_t phynode_class,
114 struct phynode_init_def *def)
116 struct phynode *phynode;
119 /* Create object and initialize it. */
120 phynode = malloc(sizeof(struct phynode), M_PHY, M_WAITOK | M_ZERO);
121 kobj_init((kobj_t)phynode, (kobj_class_t)phynode_class);
122 sx_init(&phynode->lock, "Phy node lock");
124 /* Allocate softc if required. */
125 if (phynode_class->size > 0) {
126 phynode->softc = malloc(phynode_class->size, M_PHY,
131 TAILQ_INIT(&phynode->consumers_list);
132 phynode->id = def->id;
133 phynode->pdev = pdev;
135 phynode->ofw_node = def->ofw_node;
141 /* Register phy object. */
143 phynode_register(struct phynode *phynode)
148 if (phynode->ofw_node <= 0)
149 phynode->ofw_node = ofw_bus_get_node(phynode->pdev);
150 if (phynode->ofw_node <= 0)
154 rv = PHYNODE_INIT(phynode);
156 printf("PHYNODE_INIT failed: %d\n", rv);
161 TAILQ_INSERT_TAIL(&phynode_list, phynode, phylist_link);
164 OF_device_register_xref(OF_xref_from_node(phynode->ofw_node),
170 static struct phynode *
171 phynode_find_by_id(device_t dev, intptr_t id)
173 struct phynode *entry;
177 TAILQ_FOREACH(entry, &phynode_list, phylist_link) {
178 if ((entry->pdev == dev) && (entry->id == id))
185 /* --------------------------------------------------------------------------
187 * Phy providers interface
192 phynode_get_softc(struct phynode *phynode)
195 return (phynode->softc);
199 phynode_get_device(struct phynode *phynode)
202 return (phynode->pdev);
205 intptr_t phynode_get_id(struct phynode *phynode)
208 return (phynode->id);
213 phynode_get_ofw_node(struct phynode *phynode)
216 return (phynode->ofw_node);
220 /* --------------------------------------------------------------------------
222 * Real consumers executive
230 phynode_enable(struct phynode *phynode)
236 PHYNODE_XLOCK(phynode);
237 if (phynode->enable_cnt == 0) {
238 rv = PHYNODE_ENABLE(phynode, true);
240 PHYNODE_UNLOCK(phynode);
244 phynode->enable_cnt++;
245 PHYNODE_UNLOCK(phynode);
253 phynode_disable(struct phynode *phynode)
259 PHYNODE_XLOCK(phynode);
260 if (phynode->enable_cnt == 1) {
261 rv = PHYNODE_ENABLE(phynode, false);
263 PHYNODE_UNLOCK(phynode);
267 phynode->enable_cnt--;
268 PHYNODE_UNLOCK(phynode);
274 * Get phy status. (PHY_STATUS_*)
277 phynode_status(struct phynode *phynode, int *status)
283 PHYNODE_XLOCK(phynode);
284 rv = PHYNODE_STATUS(phynode, status);
285 PHYNODE_UNLOCK(phynode);
289 /* --------------------------------------------------------------------------
291 * Phy consumers interface.
295 /* Helper function for phy_get*() */
297 phy_create(struct phynode *phynode, device_t cdev)
303 phy = malloc(sizeof(struct phy), M_PHY, M_WAITOK | M_ZERO);
305 phy->phynode = phynode;
308 PHYNODE_XLOCK(phynode);
310 TAILQ_INSERT_TAIL(&phynode->consumers_list, phy, link);
311 PHYNODE_UNLOCK(phynode);
317 phy_enable(phy_t phy)
320 struct phynode *phynode;
322 phynode = phy->phynode;
323 KASSERT(phynode->ref_cnt > 0,
324 ("Attempt to access unreferenced phy.\n"));
327 rv = phynode_enable(phynode);
335 phy_disable(phy_t phy)
338 struct phynode *phynode;
340 phynode = phy->phynode;
341 KASSERT(phynode->ref_cnt > 0,
342 ("Attempt to access unreferenced phy.\n"));
343 KASSERT(phy->enable_cnt > 0,
344 ("Attempt to disable already disabled phy.\n"));
347 rv = phynode_disable(phynode);
355 phy_status(phy_t phy, int *status)
358 struct phynode *phynode;
360 phynode = phy->phynode;
361 KASSERT(phynode->ref_cnt > 0,
362 ("Attempt to access unreferenced phy.\n"));
365 rv = phynode_status(phynode, status);
371 phy_get_by_id(device_t consumer_dev, device_t provider_dev, intptr_t id,
374 struct phynode *phynode;
378 phynode = phynode_find_by_id(provider_dev, id);
379 if (phynode == NULL) {
383 *phy = phy_create(phynode, consumer_dev);
390 phy_release(phy_t phy)
392 struct phynode *phynode;
394 phynode = phy->phynode;
395 KASSERT(phynode->ref_cnt > 0,
396 ("Attempt to access unreferenced phy.\n"));
399 while (phy->enable_cnt > 0) {
400 phynode_disable(phynode);
403 PHYNODE_XLOCK(phynode);
404 TAILQ_REMOVE(&phynode->consumers_list, phy, link);
406 PHYNODE_UNLOCK(phynode);
413 int phydev_default_ofw_map(device_t provider, phandle_t xref, int ncells,
414 pcell_t *cells, intptr_t *id)
416 struct phynode *entry;
419 /* Single device can register multiple subnodes. */
422 node = OF_node_from_xref(xref);
424 TAILQ_FOREACH(entry, &phynode_list, phylist_link) {
425 if ((entry->pdev == provider) &&
426 (entry->ofw_node == node)) {
436 /* First cell is ID. */
442 /* No default way how to get ID, custom mapper is required. */
447 phy_get_by_ofw_idx(device_t consumer_dev, phandle_t cnode, int idx, phy_t *phy)
456 cnode = ofw_bus_get_node(consumer_dev);
458 device_printf(consumer_dev,
459 "%s called on not ofw based device\n", __func__);
462 rv = ofw_bus_parse_xref_list_alloc(cnode, "phys", "#phy-cells", idx,
463 &xnode, &ncells, &cells);
467 /* Tranlate provider to device. */
468 phydev = OF_device_from_xref(xnode);
469 if (phydev == NULL) {
473 /* Map phy to number. */
474 rv = PHYDEV_MAP(phydev, xnode, ncells, cells, &id);
479 return (phy_get_by_id(consumer_dev, phydev, id, phy));
483 phy_get_by_ofw_name(device_t consumer_dev, phandle_t cnode, char *name,
489 cnode = ofw_bus_get_node(consumer_dev);
491 device_printf(consumer_dev,
492 "%s called on not ofw based device\n", __func__);
495 rv = ofw_bus_find_string_index(cnode, "phy-names", name, &idx);
498 return (phy_get_by_ofw_idx(consumer_dev, cnode, idx, phy));
502 phy_get_by_ofw_property(device_t consumer_dev, phandle_t cnode, char *name,
511 cnode = ofw_bus_get_node(consumer_dev);
513 device_printf(consumer_dev,
514 "%s called on not ofw based device\n", __func__);
517 ncells = OF_getencprop_alloc_multi(cnode, name, sizeof(pcell_t),
522 /* Tranlate provider to device. */
523 phydev = OF_device_from_xref(cells[0]);
524 if (phydev == NULL) {
528 /* Map phy to number. */
529 rv = PHYDEV_MAP(phydev, cells[0], ncells - 1 , cells + 1, &id);
534 return (phy_get_by_id(consumer_dev, phydev, id, phy));