/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2019 Ian Lepore <ian@FreeBSD.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD: releng/12.4/sys/dev/usb/usb_fdt_support.h 348420 2019-05-30 14:40:23Z ian $
 */

#ifndef _USB_FDT_SUPPORT_H_
#define	_USB_FDT_SUPPORT_H_

struct usb_device;
struct usb_ether;

/*
 * Get the device's MAC address from the FDT data.  Fills in ue->ue_eaddr and
 * returns 0 on success, otherwise leaves ue_eaddr untouched and returns
 * non-zero.  This first attempts to get the address from the "mac-address"
 * property, and if that's not valid it tries the "local-mac-address" property;
 * this matches the linux interpretation of the precedence of those properties.
 */
int usb_fdt_get_mac_addr(device_t dev, struct usb_ether* ue);

/* Get the FDT node for dev.  Returns -1 if dev is not in the FDT data. */
phandle_t usb_fdt_get_node(device_t dev, struct usb_device* udev);

#endif
