sys/dev/mii/mii_fdt.h

   1 /*-
   2  * Copyright (c) 2017 Ian Lepore <ian@freebsd.org>
   3  * All rights reserved.
   4  *
   5  * Development sponsored by Microsemi, Inc.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  18  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  * POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _DEV_MII_FDT_H_
  32 #define _DEV_MII_FDT_H_
  33
  34 /*
  35  * Common FDT config for a PHY, as documented in the devicetree bindings
  36  * documents ethernet.txt and phy.txt.  Boolean properties are represented as
  37  * bits in the flags member.
  38  */
  39 struct mii_fdt_phy_config {
  40         phandle_t       macnode;        /* Node (not xref) of parent MAC */
  41         phandle_t       phynode;        /* Node (not xref) of PHY */
  42         mii_contype_t   con_type;       /* MAC<->PHY connection type */
  43         u_int           max_speed;      /* Mbits/sec, 0 = not specified */
  44         uint32_t        flags;          /* MIIF_FDT_xxx boolean properties */
  45 };
  46 typedef struct mii_fdt_phy_config mii_fdt_phy_config_t;
  47
  48 /* PHY config flags. */
  49 #define MIIF_FDT_COMPAT_CLAUSE45        0x0001
  50 #define MIIF_FDT_BROKEN_TURNAROUND      0x0002
  51 #define MIIF_FDT_LANE_SWAP              0x0004
  52 #define MIIF_FDT_NO_LANE_SWAP           0x0008
  53 #define MIIF_FDT_EEE_BROKEN_100TX       0x0010
  54 #define MIIF_FDT_EEE_BROKEN_1000T       0x0020
  55 #define MIIF_FDT_EEE_BROKEN_10GT        0x0040
  56 #define MIIF_FDT_EEE_BROKEN_1000KX      0x0080
  57 #define MIIF_FDT_EEE_BROKEN_10GKX4      0x0100
  58 #define MIIF_FDT_EEE_BROKEN_10GKR       0x0200
  59
  60 /*
  61  * Convert between mii_contype enums and devicetree property strings.
  62  */
  63 const char *mii_fdt_contype_to_name(mii_contype_t contype);
  64 mii_contype_t mii_fdt_contype_from_name(const char *name);
  65
  66 /* Get the connection type from the given MAC node. */
  67 mii_contype_t mii_fdt_get_contype(phandle_t macnode);
  68
  69 /*
  70  * Get/free the config for the given PHY device.
  71  */
  72 void mii_fdt_free_config(struct mii_fdt_phy_config *cfg);
  73 mii_fdt_phy_config_t *mii_fdt_get_config(device_t phydev);
  74
  75 #endif