1 /* 2 * Copyright (C) 2005 Freescale Semiconductor, Inc. 3 * 4 * Author: Shlomi Gridish <gridish@freescale.com> 5 * 6 * Description: UCC ethernet driver -- PHY handling 7 * Driver for UEC on QE 8 * Based on 8260_io/fcc_enet.c 9 * 10 * This program is free software; you can redistribute it and/or modify it 11 * under the terms of the GNU General Public License as published by the 12 * Free Software Foundation; either version 2 of the License, or (at your 13 * option) any later version. 14 * 15 */ 16 #ifndef __UEC_PHY_H__ 17 #define __UEC_PHY_H__ 18 19 #define MII_end ((u32)-2) 20 #define MII_read ((u32)-1) 21 22 #define MIIMIND_BUSY 0x00000001 23 #define MIIMIND_NOTVALID 0x00000004 24 25 #define UGETH_AN_TIMEOUT 2000 26 27 /* 1000BT control (Marvell & BCM54xx at least) */ 28 #define MII_1000BASETCONTROL 0x09 29 #define MII_1000BASETCONTROL_FULLDUPLEXCAP 0x0200 30 #define MII_1000BASETCONTROL_HALFDUPLEXCAP 0x0100 31 32 /* 1000BT status */ 33 #define MII_1000BASETSTATUS 0x0a 34 #define LPA_1000FULL 0x0400 35 #define LPA_1000HALF 0x0200 36 37 /* Cicada Extended Control Register 1 */ 38 #define MII_CIS8201_EXT_CON1 0x17 39 #define MII_CIS8201_EXTCON1_INIT 0x0000 40 41 /* Cicada Interrupt Mask Register */ 42 #define MII_CIS8201_IMASK 0x19 43 #define MII_CIS8201_IMASK_IEN 0x8000 44 #define MII_CIS8201_IMASK_SPEED 0x4000 45 #define MII_CIS8201_IMASK_LINK 0x2000 46 #define MII_CIS8201_IMASK_DUPLEX 0x1000 47 #define MII_CIS8201_IMASK_MASK 0xf000 48 49 /* Cicada Interrupt Status Register */ 50 #define MII_CIS8201_ISTAT 0x1a 51 #define MII_CIS8201_ISTAT_STATUS 0x8000 52 #define MII_CIS8201_ISTAT_SPEED 0x4000 53 #define MII_CIS8201_ISTAT_LINK 0x2000 54 #define MII_CIS8201_ISTAT_DUPLEX 0x1000 55 56 /* Cicada Auxiliary Control/Status Register */ 57 #define MII_CIS8201_AUX_CONSTAT 0x1c 58 #define MII_CIS8201_AUXCONSTAT_INIT 0x0004 59 #define MII_CIS8201_AUXCONSTAT_DUPLEX 0x0020 60 #define MII_CIS8201_AUXCONSTAT_SPEED 0x0018 61 #define MII_CIS8201_AUXCONSTAT_GBIT 0x0010 62 #define MII_CIS8201_AUXCONSTAT_100 0x0008 63 64 /* 88E1011 PHY Status Register */ 65 #define MII_M1011_PHY_SPEC_STATUS 0x11 66 #define MII_M1011_PHY_SPEC_STATUS_1000 0x8000 67 #define MII_M1011_PHY_SPEC_STATUS_100 0x4000 68 #define MII_M1011_PHY_SPEC_STATUS_SPD_MASK 0xc000 69 #define MII_M1011_PHY_SPEC_STATUS_FULLDUPLEX 0x2000 70 #define MII_M1011_PHY_SPEC_STATUS_RESOLVED 0x0800 71 #define MII_M1011_PHY_SPEC_STATUS_LINK 0x0400 72 73 #define MII_M1011_IEVENT 0x13 74 #define MII_M1011_IEVENT_CLEAR 0x0000 75 76 #define MII_M1011_IMASK 0x12 77 #define MII_M1011_IMASK_INIT 0x6400 78 #define MII_M1011_IMASK_CLEAR 0x0000 79 80 #define MII_DM9161_SCR 0x10 81 #define MII_DM9161_SCR_INIT 0x0610 82 #define MII_DM9161_SCR_RMII_INIT 0x0710 83 84 /* DM9161 Specified Configuration and Status Register */ 85 #define MII_DM9161_SCSR 0x11 86 #define MII_DM9161_SCSR_100F 0x8000 87 #define MII_DM9161_SCSR_100H 0x4000 88 #define MII_DM9161_SCSR_10F 0x2000 89 #define MII_DM9161_SCSR_10H 0x1000 90 91 /* DM9161 Interrupt Register */ 92 #define MII_DM9161_INTR 0x15 93 #define MII_DM9161_INTR_PEND 0x8000 94 #define MII_DM9161_INTR_DPLX_MASK 0x0800 95 #define MII_DM9161_INTR_SPD_MASK 0x0400 96 #define MII_DM9161_INTR_LINK_MASK 0x0200 97 #define MII_DM9161_INTR_MASK 0x0100 98 #define MII_DM9161_INTR_DPLX_CHANGE 0x0010 99 #define MII_DM9161_INTR_SPD_CHANGE 0x0008 100 #define MII_DM9161_INTR_LINK_CHANGE 0x0004 101 #define MII_DM9161_INTR_INIT 0x0000 102 #define MII_DM9161_INTR_STOP \ 103 (MII_DM9161_INTR_DPLX_MASK | MII_DM9161_INTR_SPD_MASK \ 104 | MII_DM9161_INTR_LINK_MASK | MII_DM9161_INTR_MASK) 105 106 /* DM9161 10BT Configuration/Status */ 107 #define MII_DM9161_10BTCSR 0x12 108 #define MII_DM9161_10BTCSR_INIT 0x7800 109 110 #define MII_BASIC_FEATURES (SUPPORTED_10baseT_Half | \ 111 SUPPORTED_10baseT_Full | \ 112 SUPPORTED_100baseT_Half | \ 113 SUPPORTED_100baseT_Full | \ 114 SUPPORTED_Autoneg | \ 115 SUPPORTED_TP | \ 116 SUPPORTED_MII) 117 118 #define MII_GBIT_FEATURES (MII_BASIC_FEATURES | \ 119 SUPPORTED_1000baseT_Half | \ 120 SUPPORTED_1000baseT_Full) 121 122 #define MII_READ_COMMAND 0x00000001 123 124 #define MII_INTERRUPT_DISABLED 0x0 125 #define MII_INTERRUPT_ENABLED 0x1 126 127 #define SPEED_10 10 128 #define SPEED_100 100 129 #define SPEED_1000 1000 130 131 /* Duplex, half or full. */ 132 #define DUPLEX_HALF 0x00 133 #define DUPLEX_FULL 0x01 134 135 /* Indicates what features are supported by the interface. */ 136 #define SUPPORTED_10baseT_Half (1 << 0) 137 #define SUPPORTED_10baseT_Full (1 << 1) 138 #define SUPPORTED_100baseT_Half (1 << 2) 139 #define SUPPORTED_100baseT_Full (1 << 3) 140 #define SUPPORTED_1000baseT_Half (1 << 4) 141 #define SUPPORTED_1000baseT_Full (1 << 5) 142 #define SUPPORTED_Autoneg (1 << 6) 143 #define SUPPORTED_TP (1 << 7) 144 #define SUPPORTED_AUI (1 << 8) 145 #define SUPPORTED_MII (1 << 9) 146 #define SUPPORTED_FIBRE (1 << 10) 147 #define SUPPORTED_BNC (1 << 11) 148 #define SUPPORTED_10000baseT_Full (1 << 12) 149 150 #define ADVERTISED_10baseT_Half (1 << 0) 151 #define ADVERTISED_10baseT_Full (1 << 1) 152 #define ADVERTISED_100baseT_Half (1 << 2) 153 #define ADVERTISED_100baseT_Full (1 << 3) 154 #define ADVERTISED_1000baseT_Half (1 << 4) 155 #define ADVERTISED_1000baseT_Full (1 << 5) 156 #define ADVERTISED_Autoneg (1 << 6) 157 #define ADVERTISED_TP (1 << 7) 158 #define ADVERTISED_AUI (1 << 8) 159 #define ADVERTISED_MII (1 << 9) 160 #define ADVERTISED_FIBRE (1 << 10) 161 #define ADVERTISED_BNC (1 << 11) 162 #define ADVERTISED_10000baseT_Full (1 << 12) 163 164 /* Advertisement control register. */ 165 #define ADVERTISE_SLCT 0x001f /* Selector bits */ 166 #define ADVERTISE_CSMA 0x0001 /* Only selector supported */ 167 #define ADVERTISE_10HALF 0x0020 /* Try for 10mbps half-duplex */ 168 #define ADVERTISE_10FULL 0x0040 /* Try for 10mbps full-duplex */ 169 #define ADVERTISE_100HALF 0x0080 /* Try for 100mbps half-duplex */ 170 #define ADVERTISE_100FULL 0x0100 /* Try for 100mbps full-duplex */ 171 #define ADVERTISE_100BASE4 0x0200 /* Try for 100mbps 4k packets */ 172 #define ADVERTISE_RESV 0x1c00 /* Unused... */ 173 #define ADVERTISE_RFAULT 0x2000 /* Say we can detect faults */ 174 #define ADVERTISE_LPACK 0x4000 /* Ack link partners response */ 175 #define ADVERTISE_NPAGE 0x8000 /* Next page bit */ 176 177 #define ADVERTISE_FULL (ADVERTISE_100FULL | ADVERTISE_10FULL | \ 178 ADVERTISE_CSMA) 179 #define ADVERTISE_ALL (ADVERTISE_10HALF | ADVERTISE_10FULL | \ 180 ADVERTISE_100HALF | ADVERTISE_100FULL) 181 182 /* Taken from mii_if_info and sungem_phy.h */ 183 struct uec_mii_info { 184 /* Information about the PHY type */ 185 /* And management functions */ 186 struct phy_info *phyinfo; 187 188 struct eth_device *dev; 189 190 /* forced speed & duplex (no autoneg) 191 * partner speed & duplex & pause (autoneg) 192 */ 193 int speed; 194 int duplex; 195 int pause; 196 197 /* The most recently read link state */ 198 int link; 199 200 /* Enabled Interrupts */ 201 u32 interrupts; 202 203 u32 advertising; 204 int autoneg; 205 int mii_id; 206 207 /* private data pointer */ 208 /* For use by PHYs to maintain extra state */ 209 void *priv; 210 211 /* Provided by ethernet driver */ 212 int (*mdio_read) (struct eth_device * dev, int mii_id, int reg); 213 void (*mdio_write) (struct eth_device * dev, int mii_id, int reg, 214 int val); 215 }; 216 217 /* struct phy_info: a structure which defines attributes for a PHY 218 * 219 * id will contain a number which represents the PHY. During 220 * startup, the driver will poll the PHY to find out what its 221 * UID--as defined by registers 2 and 3--is. The 32-bit result 222 * gotten from the PHY will be ANDed with phy_id_mask to 223 * discard any bits which may change based on revision numbers 224 * unimportant to functionality 225 * 226 * There are 6 commands which take a ugeth_mii_info structure. 227 * Each PHY must declare config_aneg, and read_status. 228 */ 229 struct phy_info { 230 u32 phy_id; 231 char *name; 232 unsigned int phy_id_mask; 233 u32 features; 234 235 /* Called to initialize the PHY */ 236 int (*init) (struct uec_mii_info * mii_info); 237 238 /* Called to suspend the PHY for power */ 239 int (*suspend) (struct uec_mii_info * mii_info); 240 241 /* Reconfigures autonegotiation (or disables it) */ 242 int (*config_aneg) (struct uec_mii_info * mii_info); 243 244 /* Determines the negotiated speed and duplex */ 245 int (*read_status) (struct uec_mii_info * mii_info); 246 247 /* Clears any pending interrupts */ 248 int (*ack_interrupt) (struct uec_mii_info * mii_info); 249 250 /* Enables or disables interrupts */ 251 int (*config_intr) (struct uec_mii_info * mii_info); 252 253 /* Clears up any memory if needed */ 254 void (*close) (struct uec_mii_info * mii_info); 255 }; 256 257 struct phy_info *uec_get_phy_info (struct uec_mii_info *mii_info); 258 void uec_write_phy_reg (struct eth_device *dev, int mii_id, int regnum, 259 int value); 260 int uec_read_phy_reg (struct eth_device *dev, int mii_id, int regnum); 261 void mii_clear_phy_interrupt (struct uec_mii_info *mii_info); 262 void mii_configure_phy_interrupt (struct uec_mii_info *mii_info, 263 u32 interrupts); 264 #endif /* __UEC_PHY_H__ */ 265