xref: /freebsd/sys/dev/phy/phynode_if.m (revision 6580f5c38dd5b01aeeaed16b370f1a12423437f0)
1#-
2# Copyright 2016 Michal Meloun <mmel@FreeBSD.org>
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions
6# are met:
7# 1. Redistributions of source code must retain the above copyright
8#    notice, this list of conditions and the following disclaimer.
9# 2. Redistributions in binary form must reproduce the above copyright
10#    notice, this list of conditions and the following disclaimer in the
11#    documentation and/or other materials provided with the distribution.
12#
13# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23# SUCH DAMAGE.
24#
25
26INTERFACE phynode;
27
28HEADER {
29	#include <dev/phy/phy.h>
30
31	struct phynode;
32}
33
34#
35# Init/deinit phy
36# Returns 0 on success or a standard errno value.
37#
38METHOD int init {
39	struct phynode	*phynode;
40};
41
42#
43# Enable/disable phy
44# Returns 0 on success or a standard errno value.
45#
46METHOD int enable {
47	struct phynode	*phynode;
48	bool		enable;
49};
50
51#
52# Get phy status
53# Returns 0 on success or a standard errno value.
54#
55METHOD int status {
56	struct phynode	*phynode;
57	int		*status;    /* PHY_STATUS_* */
58};
59
60
61#
62# Set mode/submode for multiprotocol phy
63# Returns 0 on success or a standard errno value.
64#
65METHOD int set_mode  {
66	struct phynode	*phynode;
67	phy_mode_t	mode;
68	phy_submode_t	submode;
69};
70