xref: /freebsd-13.1/sys/dev/extres/phy/phy.h (revision 87d5d10d)
1 /*-
2  * Copyright 2016 Michal Meloun <[email protected]>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * $FreeBSD$
26  */
27 
28 #ifndef DEV_EXTRES_PHY_H
29 #define DEV_EXTRES_PHY_H
30 
31 #include "opt_platform.h"
32 #include <sys/types.h>
33 #ifdef FDT
34 #include <dev/ofw/ofw_bus.h>
35 #endif
36 
37 typedef struct phy *phy_t;
38 
39 /*
40  * Provider interface
41  */
42 #ifdef FDT
43 void phy_register_provider(device_t provider);
44 void phy_unregister_provider(device_t provider);
45 #endif
46 
47 /*
48  * Consumer interface
49  */
50 int phy_get_by_id(device_t consumer_dev, device_t provider_dev, intptr_t id,
51     phy_t *phy);
52 void phy_release(phy_t phy);
53 
54 #ifdef FDT
55 int phy_get_by_ofw_name(device_t consumer, phandle_t node, char *name,
56     phy_t *phy);
57 int phy_get_by_ofw_idx(device_t consumer, phandle_t node, int idx, phy_t *phy);
58 int phy_get_by_ofw_property(device_t consumer, phandle_t node, char *name,
59     phy_t *phy);
60 #endif
61 
62 int phy_init(device_t consumer, phy_t phy);
63 int phy_deinit(device_t consumer, phy_t phy);
64 int phy_enable(device_t consumer, phy_t phy);
65 int phy_disable(device_t consumer, phy_t phy);
66 int phy_status(device_t consumer, phy_t phy, int *value);
67 
68 #endif /* DEV_EXTRES_PHY_H */
69