xref: /freebsd/sys/dev/usb/usb_fdt_support.h (revision 734e82fe33aa764367791a7d603b383996c6b40b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2019 Ian Lepore <ian@FreeBSD.org>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef _USB_FDT_SUPPORT_H_
29 #define	_USB_FDT_SUPPORT_H_
30 
31 struct usb_device;
32 struct usb_ether;
33 
34 /*
35  * Get the device's MAC address from the FDT data.  Fills in ue->ue_eaddr and
36  * returns 0 on success, otherwise leaves ue_eaddr untouched and returns
37  * non-zero.  This first attempts to get the address from the "mac-address"
38  * property, and if that's not valid it tries the "local-mac-address" property;
39  * this matches the linux interpretation of the precedence of those properties.
40  */
41 int usb_fdt_get_mac_addr(device_t dev, struct usb_ether* ue);
42 
43 /* Get the FDT node for dev.  Returns -1 if dev is not in the FDT data. */
44 phandle_t usb_fdt_get_node(device_t dev, struct usb_device* udev);
45 
46 #endif
47