cmd/mii.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2001
   4  * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
   5  */
   6
   7 /*
   8  * MII Utilities
   9  */
  10
  11 #include <common.h>
  12 #include <command.h>
  13 #include <miiphy.h>
  14
  15 typedef struct _MII_field_desc_t {
  16         ushort hi;
  17         ushort lo;
  18         ushort mask;
  19         const char *name;
  20 } MII_field_desc_t;
  21
  22 static const MII_field_desc_t reg_0_desc_tbl[] = {
  23         { 15, 15, 0x01, "reset"                        },
  24         { 14, 14, 0x01, "loopback"                     },
  25         { 13,  6, 0x81, "speed selection"              }, /* special */
  26         { 12, 12, 0x01, "A/N enable"                   },
  27         { 11, 11, 0x01, "power-down"                   },
  28         { 10, 10, 0x01, "isolate"                      },
  29         {  9,  9, 0x01, "restart A/N"                  },
  30         {  8,  8, 0x01, "duplex"                       }, /* special */
  31         {  7,  7, 0x01, "collision test enable"        },
  32         {  5,  0, 0x3f, "(reserved)"                   }
  33 };
  34
  35 static const MII_field_desc_t reg_1_desc_tbl[] = {
  36         { 15, 15, 0x01, "100BASE-T4 able"              },
  37         { 14, 14, 0x01, "100BASE-X  full duplex able"  },
  38         { 13, 13, 0x01, "100BASE-X  half duplex able"  },
  39         { 12, 12, 0x01, "10 Mbps    full duplex able"  },
  40         { 11, 11, 0x01, "10 Mbps    half duplex able"  },
  41         { 10, 10, 0x01, "100BASE-T2 full duplex able"  },
  42         {  9,  9, 0x01, "100BASE-T2 half duplex able"  },
  43         {  8,  8, 0x01, "extended status"              },
  44         {  7,  7, 0x01, "(reserved)"                   },
  45         {  6,  6, 0x01, "MF preamble suppression"      },
  46         {  5,  5, 0x01, "A/N complete"                 },
  47         {  4,  4, 0x01, "remote fault"                 },
  48         {  3,  3, 0x01, "A/N able"                     },
  49         {  2,  2, 0x01, "link status"                  },
  50         {  1,  1, 0x01, "jabber detect"                },
  51         {  0,  0, 0x01, "extended capabilities"        },
  52 };
  53
  54 static const MII_field_desc_t reg_2_desc_tbl[] = {
  55         { 15,  0, 0xffff, "OUI portion"                },
  56 };
  57
  58 static const MII_field_desc_t reg_3_desc_tbl[] = {
  59         { 15, 10, 0x3f, "OUI portion"                },
  60         {  9,  4, 0x3f, "manufacturer part number"   },
  61         {  3,  0, 0x0f, "manufacturer rev. number"   },
  62 };
  63
  64 static const MII_field_desc_t reg_4_desc_tbl[] = {
  65         { 15, 15, 0x01, "next page able"               },
  66         { 14, 14, 0x01, "(reserved)"                   },
  67         { 13, 13, 0x01, "remote fault"                 },
  68         { 12, 12, 0x01, "(reserved)"                   },
  69         { 11, 11, 0x01, "asymmetric pause"             },
  70         { 10, 10, 0x01, "pause enable"                 },
  71         {  9,  9, 0x01, "100BASE-T4 able"              },
  72         {  8,  8, 0x01, "100BASE-TX full duplex able"  },
  73         {  7,  7, 0x01, "100BASE-TX able"              },
  74         {  6,  6, 0x01, "10BASE-T   full duplex able"  },
  75         {  5,  5, 0x01, "10BASE-T   able"              },
  76         {  4,  0, 0x1f, "selector"                     },
  77 };
  78
  79 static const MII_field_desc_t reg_5_desc_tbl[] = {
  80         { 15, 15, 0x01, "next page able"               },
  81         { 14, 14, 0x01, "acknowledge"                  },
  82         { 13, 13, 0x01, "remote fault"                 },
  83         { 12, 12, 0x01, "(reserved)"                   },
  84         { 11, 11, 0x01, "asymmetric pause able"        },
  85         { 10, 10, 0x01, "pause able"                   },
  86         {  9,  9, 0x01, "100BASE-T4 able"              },
  87         {  8,  8, 0x01, "100BASE-X full duplex able"   },
  88         {  7,  7, 0x01, "100BASE-TX able"              },
  89         {  6,  6, 0x01, "10BASE-T full duplex able"    },
  90         {  5,  5, 0x01, "10BASE-T able"                },
  91         {  4,  0, 0x1f, "partner selector"             },
  92 };
  93
  94 typedef struct _MII_reg_desc_t {
  95         ushort regno;
  96         const MII_field_desc_t *pdesc;
  97         ushort len;
  98         const char *name;
  99 } MII_reg_desc_t;
 100
 101 static const MII_reg_desc_t mii_reg_desc_tbl[] = {
 102         { MII_BMCR,      reg_0_desc_tbl, ARRAY_SIZE(reg_0_desc_tbl),
 103                 "PHY control register" },
 104         { MII_BMSR,      reg_1_desc_tbl, ARRAY_SIZE(reg_1_desc_tbl),
 105                 "PHY status register" },
 106         { MII_PHYSID1,   reg_2_desc_tbl, ARRAY_SIZE(reg_2_desc_tbl),
 107                 "PHY ID 1 register" },
 108         { MII_PHYSID2,   reg_3_desc_tbl, ARRAY_SIZE(reg_3_desc_tbl),
 109                 "PHY ID 2 register" },
 110         { MII_ADVERTISE, reg_4_desc_tbl, ARRAY_SIZE(reg_4_desc_tbl),
 111                 "Autonegotiation advertisement register" },
 112         { MII_LPA,       reg_5_desc_tbl, ARRAY_SIZE(reg_5_desc_tbl),
 113                 "Autonegotiation partner abilities register" },
 114 };
 115
 116 static void dump_reg(
 117         ushort             regval,
 118         const MII_reg_desc_t *prd);
 119
 120 static bool special_field(ushort regno, const MII_field_desc_t *pdesc,
 121                           ushort regval);
 122
 123 static void MII_dump(const ushort *regvals, uchar reglo, uchar reghi)
 124 {
 125         ulong i;
 126
 127         for (i = 0; i < ARRAY_SIZE(mii_reg_desc_tbl); i++) {
 128                 const uchar reg = mii_reg_desc_tbl[i].regno;
 129
 130                 if (reg >= reglo && reg <= reghi)
 131                         dump_reg(regvals[reg - reglo], &mii_reg_desc_tbl[i]);
 132         }
 133 }
 134
 135 /* Print out field position, value, name */
 136 static void dump_field(const MII_field_desc_t *pdesc, ushort regval)
 137 {
 138         if (pdesc->hi == pdesc->lo)
 139                 printf("%2u   ", pdesc->lo);
 140         else
 141                 printf("%2u-%2u", pdesc->hi, pdesc->lo);
 142
 143         printf(" = %5u    %s", (regval >> pdesc->lo) & pdesc->mask,
 144                pdesc->name);
 145 }
 146
 147 static void dump_reg(
 148         ushort             regval,
 149         const MII_reg_desc_t *prd)
 150 {
 151         ulong i;
 152         ushort mask_in_place;
 153         const MII_field_desc_t *pdesc;
 154
 155         printf("%u.     (%04hx)                 -- %s --\n",
 156                 prd->regno, regval, prd->name);
 157
 158         for (i = 0; i < prd->len; i++) {
 159                 pdesc = &prd->pdesc[i];
 160
 161                 mask_in_place = pdesc->mask << pdesc->lo;
 162
 163                 printf("  (%04hx:%04x) %u.",
 164                        mask_in_place,
 165                        regval & mask_in_place,
 166                        prd->regno);
 167
 168                 if (!special_field(prd->regno, pdesc, regval))
 169                         dump_field(pdesc, regval);
 170                 printf("\n");
 171
 172         }
 173         printf("\n");
 174 }
 175
 176 /* Special fields:
 177 ** 0.6,13
 178 ** 0.8
 179 ** 2.15-0
 180 ** 3.15-0
 181 ** 4.4-0
 182 ** 5.4-0
 183 */
 184
 185 static bool special_field(ushort regno, const MII_field_desc_t *pdesc,
 186                           ushort regval)
 187 {
 188         const ushort sel_bits = (regval >> pdesc->lo) & pdesc->mask;
 189
 190         if ((regno == MII_BMCR) && (pdesc->lo == 6)) {
 191                 ushort speed_bits = regval & (BMCR_SPEED1000 | BMCR_SPEED100);
 192                 printf("%2u,%2u =   b%u%u    speed selection = %s Mbps",
 193                         6, 13,
 194                         (regval >>  6) & 1,
 195                         (regval >> 13) & 1,
 196                         speed_bits == BMCR_SPEED1000 ? "1000" :
 197                         speed_bits == BMCR_SPEED100  ? "100" :
 198                         "10");
 199                 return 1;
 200         }
 201
 202         else if ((regno == MII_BMCR) && (pdesc->lo == 8)) {
 203                 dump_field(pdesc, regval);
 204                 printf(" = %s", ((regval >> pdesc->lo) & 1) ? "full" : "half");
 205                 return 1;
 206         }
 207
 208         else if ((regno == MII_ADVERTISE) && (pdesc->lo == 0)) {
 209                 dump_field(pdesc, regval);
 210                 printf(" = %s",
 211                        sel_bits == PHY_ANLPAR_PSB_802_3 ? "IEEE 802.3 CSMA/CD" :
 212                        sel_bits == PHY_ANLPAR_PSB_802_9 ?
 213                        "IEEE 802.9 ISLAN-16T" : "???");
 214                 return 1;
 215         }
 216
 217         else if ((regno == MII_LPA) && (pdesc->lo == 0)) {
 218                 dump_field(pdesc, regval);
 219                 printf(" = %s",
 220                        sel_bits == PHY_ANLPAR_PSB_802_3 ? "IEEE 802.3 CSMA/CD" :
 221                        sel_bits == PHY_ANLPAR_PSB_802_9 ?
 222                        "IEEE 802.9 ISLAN-16T" : "???");
 223                 return 1;
 224         }
 225
 226         return 0;
 227 }
 228
 229 static char last_op[2];
 230 static uint last_data;
 231 static uint last_addr_lo;
 232 static uint last_addr_hi;
 233 static uint last_reg_lo;
 234 static uint last_reg_hi;
 235 static uint last_mask;
 236
 237 static void extract_range(
 238         char * input,
 239         unsigned char * plo,
 240         unsigned char * phi)
 241 {
 242         char * end;
 243         *plo = simple_strtoul(input, &end, 16);
 244         if (*end == '-') {
 245                 end++;
 246                 *phi = simple_strtoul(end, NULL, 16);
 247         }
 248         else {
 249                 *phi = *plo;
 250         }
 251 }
 252
 253 /* ---------------------------------------------------------------- */
 254 static int do_mii(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 255 {
 256         char            op[2];
 257         unsigned char   addrlo, addrhi, reglo, reghi;
 258         unsigned char   addr, reg;
 259         unsigned short  data, mask;
 260         int             rcode = 0;
 261         const char      *devname;
 262
 263         if (argc < 2)
 264                 return CMD_RET_USAGE;
 265
 266 #if defined(CONFIG_MII_INIT)
 267         mii_init ();
 268 #endif
 269
 270         /*
 271          * We use the last specified parameters, unless new ones are
 272          * entered.
 273          */
 274         op[0] = last_op[0];
 275         op[1] = last_op[1];
 276         addrlo = last_addr_lo;
 277         addrhi = last_addr_hi;
 278         reglo  = last_reg_lo;
 279         reghi  = last_reg_hi;
 280         data   = last_data;
 281         mask   = last_mask;
 282
 283         if ((flag & CMD_FLAG_REPEAT) == 0) {
 284                 op[0] = argv[1][0];
 285                 if (strlen(argv[1]) > 1)
 286                         op[1] = argv[1][1];
 287                 else
 288                         op[1] = '\0';
 289
 290                 if (argc >= 3)
 291                         extract_range(argv[2], &addrlo, &addrhi);
 292                 if (argc >= 4)
 293                         extract_range(argv[3], &reglo, &reghi);
 294                 if (argc >= 5)
 295                         data = simple_strtoul(argv[4], NULL, 16);
 296                 if (argc >= 6)
 297                         mask = simple_strtoul(argv[5], NULL, 16);
 298         }
 299
 300         if (addrhi > 31 && strncmp(op, "de", 2)) {
 301                 printf("Incorrect PHY address. Range should be 0-31\n");
 302                 return CMD_RET_USAGE;
 303         }
 304
 305         /* use current device */
 306         devname = miiphy_get_current_dev();
 307
 308         /*
 309          * check info/read/write.
 310          */
 311         if (op[0] == 'i') {
 312                 unsigned char j, start, end;
 313                 unsigned int oui;
 314                 unsigned char model;
 315                 unsigned char rev;
 316
 317                 /*
 318                  * Look for any and all PHYs.  Valid addresses are 0..31.
 319                  */
 320                 if (argc >= 3) {
 321                         start = addrlo; end = addrhi;
 322                 } else {
 323                         start = 0; end = 31;
 324                 }
 325
 326                 for (j = start; j <= end; j++) {
 327                         if (miiphy_info (devname, j, &oui, &model, &rev) == 0) {
 328                                 printf("PHY 0x%02X: "
 329                                         "OUI = 0x%04X, "
 330                                         "Model = 0x%02X, "
 331                                         "Rev = 0x%02X, "
 332                                         "%3dbase%s, %s\n",
 333                                         j, oui, model, rev,
 334                                         miiphy_speed (devname, j),
 335                                         miiphy_is_1000base_x (devname, j)
 336                                                 ? "X" : "T",
 337                                         (miiphy_duplex (devname, j) == FULL)
 338                                                 ? "FDX" : "HDX");
 339                         }
 340                 }
 341         } else if (op[0] == 'r') {
 342                 for (addr = addrlo; addr <= addrhi; addr++) {
 343                         for (reg = reglo; reg <= reghi; reg++) {
 344                                 data = 0xffff;
 345                                 if (miiphy_read (devname, addr, reg, &data) != 0) {
 346                                         printf(
 347                                         "Error reading from the PHY addr=%02x reg=%02x\n",
 348                                                 addr, reg);
 349                                         rcode = 1;
 350                                 } else {
 351                                         if ((addrlo != addrhi) || (reglo != reghi))
 352                                                 printf("addr=%02x reg=%02x data=",
 353                                                         (uint)addr, (uint)reg);
 354                                         printf("%04X\n", data & 0x0000FFFF);
 355                                 }
 356                         }
 357                         if ((addrlo != addrhi) && (reglo != reghi))
 358                                 printf("\n");
 359                 }
 360         } else if (op[0] == 'w') {
 361                 for (addr = addrlo; addr <= addrhi; addr++) {
 362                         for (reg = reglo; reg <= reghi; reg++) {
 363                                 if (miiphy_write (devname, addr, reg, data) != 0) {
 364                                         printf("Error writing to the PHY addr=%02x reg=%02x\n",
 365                                                 addr, reg);
 366                                         rcode = 1;
 367                                 }
 368                         }
 369                 }
 370         } else if (op[0] == 'm') {
 371                 for (addr = addrlo; addr <= addrhi; addr++) {
 372                         for (reg = reglo; reg <= reghi; reg++) {
 373                                 unsigned short val = 0;
 374                                 if (miiphy_read(devname, addr,
 375                                                 reg, &val)) {
 376                                         printf("Error reading from the PHY");
 377                                         printf(" addr=%02x", addr);
 378                                         printf(" reg=%02x\n", reg);
 379                                         rcode = 1;
 380                                 } else {
 381                                         val = (val & ~mask) | (data & mask);
 382                                         if (miiphy_write(devname, addr,
 383                                                          reg, val)) {
 384                                                 printf("Error writing to the PHY");
 385                                                 printf(" addr=%02x", addr);
 386                                                 printf(" reg=%02x\n", reg);
 387                                                 rcode = 1;
 388                                         }
 389                                 }
 390                         }
 391                 }
 392         } else if (strncmp(op, "du", 2) == 0) {
 393                 ushort regs[6];
 394                 int ok = 1;
 395                 if ((reglo > 5) || (reghi > 5)) {
 396                         printf(
 397                                 "The MII dump command only formats the "
 398                                 "standard MII registers, 0-5.\n");
 399                         return 1;
 400                 }
 401                 for (addr = addrlo; addr <= addrhi; addr++) {
 402                         for (reg = reglo; reg <= reghi; reg++) {
 403                                 if (miiphy_read(devname, addr, reg,
 404                                                 &regs[reg - reglo]) != 0) {
 405                                         ok = 0;
 406                                         printf(
 407                                         "Error reading from the PHY addr=%02x reg=%02x\n",
 408                                                 addr, reg);
 409                                         rcode = 1;
 410                                 }
 411                         }
 412                         if (ok)
 413                                 MII_dump(regs, reglo, reghi);
 414                         printf("\n");
 415                 }
 416         } else if (strncmp(op, "de", 2) == 0) {
 417                 if (argc == 2)
 418                         miiphy_listdev ();
 419                 else
 420                         miiphy_set_current_dev (argv[2]);
 421         } else {
 422                 return CMD_RET_USAGE;
 423         }
 424
 425         /*
 426          * Save the parameters for repeats.
 427          */
 428         last_op[0] = op[0];
 429         last_op[1] = op[1];
 430         last_addr_lo = addrlo;
 431         last_addr_hi = addrhi;
 432         last_reg_lo  = reglo;
 433         last_reg_hi  = reghi;
 434         last_data    = data;
 435         last_mask    = mask;
 436
 437         return rcode;
 438 }
 439
 440 /***************************************************/
 441
 442 U_BOOT_CMD(
 443         mii, 6, 1, do_mii,
 444         "MII utility commands",
 445         "device                            - list available devices\n"
 446         "mii device <devname>                  - set current device\n"
 447         "mii info   <addr>                     - display MII PHY info\n"
 448         "mii read   <addr> <reg>               - read  MII PHY <addr> register <reg>\n"
 449         "mii write  <addr> <reg> <data>        - write MII PHY <addr> register <reg>\n"
 450         "mii modify <addr> <reg> <data> <mask> - modify MII PHY <addr> register <reg>\n"
 451         "                                        updating bits identified in <mask>\n"
 452         "mii dump   <addr> <reg>               - pretty-print <addr> <reg> (0-5 only)\n"
 453         "Addr and/or reg may be ranges, e.g. 2-7."
 454 );