setpci.c

   1 /*
   2  *      The PCI Utilities -- Manipulate PCI Configuration Registers
   3  *
   4  *      Copyright (c) 1998--2008 Martin Mares <mj@ucw.cz>
   5  *
   6  *      Can be freely distributed and used under the terms of the GNU GPL.
   7  */
   8
   9 #include <stdio.h>
  10 #include <string.h>
  11 #include <stdlib.h>
  12 #include <stdarg.h>
  13 #include <unistd.h>
  14 #include <errno.h>
  15
  16 #define PCIUTILS_SETPCI
  17 #include "pciutils.h"
  18
  19 static int force;                       /* Don't complain if no devices match */
  20 static int verbose;                     /* Verbosity level */
  21 static int demo_mode;                   /* Only show */
  22
  23 const char program_name[] = "setpci";
  24
  25 static struct pci_access *pacc;
  26
  27 struct value {
  28   unsigned int value;
  29   unsigned int mask;
  30 };
  31
  32 struct op {
  33   struct op *next;
  34   struct pci_dev **dev_vector;
  35   unsigned int cap;                     /* Capability: 0=none, 10000-100ff=normal, 20000-2ffff=extended */
  36   unsigned int addr;
  37   unsigned int width;                   /* Byte width of the access */
  38   unsigned int num_values;              /* Number of values to write; 0=read */
  39   struct value values[0];
  40 };
  41
  42 static struct op *first_op, **last_op = &first_op;
  43 static unsigned int max_values[] = { 0, 0xff, 0xffff, 0, 0xffffffff };
  44
  45 static struct pci_dev **
  46 select_devices(struct pci_filter *filt)
  47 {
  48   struct pci_dev *z, **a, **b;
  49   int cnt = 1;
  50
  51   for (z=pacc->devices; z; z=z->next)
  52     if (pci_filter_match(filt, z))
  53       cnt++;
  54   a = b = xmalloc(sizeof(struct device *) * cnt);
  55   for (z=pacc->devices; z; z=z->next)
  56     if (pci_filter_match(filt, z))
  57       *a++ = z;
  58   *a = NULL;
  59   return b;
  60 }
  61
  62 static void
  63 exec_op(struct op *op, struct pci_dev *dev)
  64 {
  65   char *formats[] = { NULL, "%02x", "%04x", NULL, "%08x" };
  66   char *mask_formats[] = { NULL, "%02x->(%02x:%02x)->%02x", "%04x->(%04x:%04x)->%04x", NULL, "%08x->(%08x:%08x)->%08x" };
  67   unsigned int i, x, y;
  68   int addr = 0;
  69   int width = op->width;
  70
  71   if (verbose)
  72     printf("%02x:%02x.%x", dev->bus, dev->dev, dev->func);
  73   if (op->cap)
  74     {
  75       struct pci_cap *cap;
  76       if (op->cap < 0x20000)
  77         {
  78           if (verbose)
  79             printf("(cap %02x)", op->cap - 0x10000);
  80           cap = pci_find_cap(dev, op->cap - 0x10000, PCI_CAP_NORMAL);
  81         }
  82       else
  83         {
  84           if (verbose)
  85             printf("(ecap %04x)", op->cap - 0x20000);
  86           cap = pci_find_cap(dev, op->cap - 0x20000, PCI_CAP_EXTENDED);
  87         }
  88       if (cap)
  89         addr = cap->addr;
  90       else
  91         {
  92           /* FIXME: Report the error properly */
  93           die("Capability %08x not found", op->cap);
  94         }
  95     }
  96   addr += op->addr;
  97   if (verbose)
  98     printf(":%02x", addr);
  99   if (op->num_values)
 100     {
 101       for (i=0; i<op->num_values; i++)
 102         {
 103           if (addr + width > 0x1000)
 104             die("Out of range");        /* FIXME */
 105           if ((op->values[i].mask & max_values[width]) == max_values[width])
 106             {
 107               x = op->values[i].value;
 108               if (verbose)
 109                 {
 110                   putchar(' ');
 111                   printf(formats[width], op->values[i].value);
 112                 }
 113             }
 114           else
 115             {
 116               switch (width)
 117                 {
 118                 case 1:
 119                   y = pci_read_byte(dev, addr);
 120                   break;
 121                 case 2:
 122                   y = pci_read_word(dev, addr);
 123                   break;
 124                 default:
 125                   y = pci_read_long(dev, addr);
 126                   break;
 127                 }
 128               x = (y & ~op->values[i].mask) | op->values[i].value;
 129               if (verbose)
 130                 {
 131                   putchar(' ');
 132                   printf(mask_formats[width], y, op->values[i].value, op->values[i].mask, x);
 133                 }
 134             }
 135           if (!demo_mode)
 136             {
 137               switch (width)
 138                 {
 139                 case 1:
 140                   pci_write_byte(dev, addr, x);
 141                   break;
 142                 case 2:
 143                   pci_write_word(dev, addr, x);
 144                   break;
 145                 default:
 146                   pci_write_long(dev, addr, x);
 147                   break;
 148                 }
 149             }
 150           addr += width;
 151         }
 152       if (verbose)
 153         putchar('\n');
 154     }
 155   else
 156     {
 157       if (verbose)
 158         printf(" = ");
 159       if (addr + width > 0x1000)
 160         die("Out of range");    /* FIXME */
 161       switch (width)
 162         {
 163         case 1:
 164           x = pci_read_byte(dev, addr);
 165           break;
 166         case 2:
 167           x = pci_read_word(dev, addr);
 168           break;
 169         default:
 170           x = pci_read_long(dev, addr);
 171           break;
 172         }
 173       printf(formats[width], x);
 174       putchar('\n');
 175     }
 176 }
 177
 178 static void
 179 execute(struct op *op)
 180 {
 181   struct pci_dev **vec = NULL;
 182   struct pci_dev **pdev, *dev;
 183   struct op *oops;
 184
 185   while (op)
 186     {
 187       pdev = vec = op->dev_vector;
 188       while (dev = *pdev++)
 189         for (oops=op; oops && oops->dev_vector == vec; oops=oops->next)
 190           exec_op(oops, dev);
 191       while (op && op->dev_vector == vec)
 192         op = op->next;
 193     }
 194 }
 195
 196 static void
 197 scan_ops(struct op *op)
 198 {
 199   while (op)
 200     {
 201       if (op->num_values)
 202         pacc->writeable = 1;
 203       op = op->next;
 204     }
 205 }
 206
 207 struct reg_name {
 208   unsigned int cap;
 209   unsigned int offset;
 210   unsigned int width;
 211   const char *name;
 212 };
 213
 214 static const struct reg_name pci_reg_names[] = {
 215   {       0, 0x00, 2, "VENDOR_ID" },
 216   {       0, 0x02, 2, "DEVICE_ID" },
 217   {       0, 0x04, 2, "COMMAND" },
 218   {       0, 0x06, 2, "STATUS" },
 219   {       0, 0x08, 1, "REVISION" },
 220   {       0, 0x09, 1, "CLASS_PROG" },
 221   {       0, 0x0a, 2, "CLASS_DEVICE" },
 222   {       0, 0x0c, 1, "CACHE_LINE_SIZE" },
 223   {       0, 0x0d, 1, "LATENCY_TIMER" },
 224   {       0, 0x0e, 1, "HEADER_TYPE" },
 225   {       0, 0x0f, 1, "BIST" },
 226   {       0, 0x10, 4, "BASE_ADDRESS_0" },
 227   {       0, 0x14, 4, "BASE_ADDRESS_1" },
 228   {       0, 0x18, 4, "BASE_ADDRESS_2" },
 229   {       0, 0x1c, 4, "BASE_ADDRESS_3" },
 230   {       0, 0x20, 4, "BASE_ADDRESS_4" },
 231   {       0, 0x24, 4, "BASE_ADDRESS_5" },
 232   {       0, 0x28, 4, "CARDBUS_CIS" },
 233   {       0, 0x2c, 4, "SUBSYSTEM_VENDOR_ID" },
 234   {       0, 0x2e, 2, "SUBSYSTEM_ID" },
 235   {       0, 0x30, 4, "ROM_ADDRESS" },
 236   {       0, 0x3c, 1, "INTERRUPT_LINE" },
 237   {       0, 0x3d, 1, "INTERRUPT_PIN" },
 238   {       0, 0x3e, 1, "MIN_GNT" },
 239   {       0, 0x3f, 1, "MAX_LAT" },
 240   {       0, 0x18, 1, "PRIMARY_BUS" },
 241   {       0, 0x19, 1, "SECONDARY_BUS" },
 242   {       0, 0x1a, 1, "SUBORDINATE_BUS" },
 243   {       0, 0x1b, 1, "SEC_LATENCY_TIMER" },
 244   {       0, 0x1c, 1, "IO_BASE" },
 245   {       0, 0x1d, 1, "IO_LIMIT" },
 246   {       0, 0x1e, 2, "SEC_STATUS" },
 247   {       0, 0x20, 2, "MEMORY_BASE" },
 248   {       0, 0x22, 2, "MEMORY_LIMIT" },
 249   {       0, 0x24, 2, "PREF_MEMORY_BASE" },
 250   {       0, 0x26, 2, "PREF_MEMORY_LIMIT" },
 251   {       0, 0x28, 4, "PREF_BASE_UPPER32" },
 252   {       0, 0x2c, 4, "PREF_LIMIT_UPPER32" },
 253   {       0, 0x30, 2, "IO_BASE_UPPER16" },
 254   {       0, 0x32, 2, "IO_LIMIT_UPPER16" },
 255   {       0, 0x38, 4, "BRIDGE_ROM_ADDRESS" },
 256   {       0, 0x3e, 2, "BRIDGE_CONTROL" },
 257   {       0, 0x10, 4, "CB_CARDBUS_BASE" },
 258   {       0, 0x14, 2, "CB_CAPABILITIES" },
 259   {       0, 0x16, 2, "CB_SEC_STATUS" },
 260   {       0, 0x18, 1, "CB_BUS_NUMBER" },
 261   {       0, 0x19, 1, "CB_CARDBUS_NUMBER" },
 262   {       0, 0x1a, 1, "CB_SUBORDINATE_BUS" },
 263   {       0, 0x1b, 1, "CB_CARDBUS_LATENCY" },
 264   {       0, 0x1c, 4, "CB_MEMORY_BASE_0" },
 265   {       0, 0x20, 4, "CB_MEMORY_LIMIT_0" },
 266   {       0, 0x24, 4, "CB_MEMORY_BASE_1" },
 267   {       0, 0x28, 4, "CB_MEMORY_LIMIT_1" },
 268   {       0, 0x2c, 2, "CB_IO_BASE_0" },
 269   {       0, 0x2e, 2, "CB_IO_BASE_0_HI" },
 270   {       0, 0x30, 2, "CB_IO_LIMIT_0" },
 271   {       0, 0x32, 2, "CB_IO_LIMIT_0_HI" },
 272   {       0, 0x34, 2, "CB_IO_BASE_1" },
 273   {       0, 0x36, 2, "CB_IO_BASE_1_HI" },
 274   {       0, 0x38, 2, "CB_IO_LIMIT_1" },
 275   {       0, 0x3a, 2, "CB_IO_LIMIT_1_HI" },
 276   {       0, 0x40, 2, "CB_SUBSYSTEM_VENDOR_ID" },
 277   {       0, 0x42, 2, "CB_SUBSYSTEM_ID" },
 278   {       0, 0x44, 4, "CB_LEGACY_MODE_BASE" },
 279   { 0x10001,    0, 0, "CAP_PM" },
 280   { 0x10002,    0, 0, "CAP_AGP" },
 281   { 0x10003,    0, 0, "CAP_VPD" },
 282   { 0x10004,    0, 0, "CAP_SLOTID" },
 283   { 0x10005,    0, 0, "CAP_MSI" },
 284   { 0x10006,    0, 0, "CAP_CHSWP" },
 285   { 0x10007,    0, 0, "CAP_PCIX" },
 286   { 0x10008,    0, 0, "CAP_HT" },
 287   { 0x10009,    0, 0, "CAP_VNDR" },
 288   { 0x1000a,    0, 0, "CAP_DBG" },
 289   { 0x1000b,    0, 0, "CAP_CCRC" },
 290   { 0x1000c,    0, 0, "CAP_HOTPLUG" },
 291   { 0x1000d,    0, 0, "CAP_SSVID" },
 292   { 0x1000e,    0, 0, "CAP_AGP3" },
 293   { 0x1000f,    0, 0, "CAP_SECURE" },
 294   { 0x10010,    0, 0, "CAP_EXP" },
 295   { 0x10011,    0, 0, "CAP_MSIX" },
 296   { 0x10012,    0, 0, "CAP_SATA" },
 297   { 0x10013,    0, 0, "CAP_AF" },
 298   { 0x20001,    0, 0, "ECAP_AER" },
 299   { 0x20002,    0, 0, "ECAP_VC" },
 300   { 0x20003,    0, 0, "ECAP_DSN" },
 301   { 0x20004,    0, 0, "ECAP_PB" },
 302   { 0x20005,    0, 0, "ECAP_RCLINK" },
 303   { 0x20006,    0, 0, "ECAP_RCILINK" },
 304   { 0x20007,    0, 0, "ECAP_RCECOLL" },
 305   { 0x20008,    0, 0, "ECAP_MFVC" },
 306   { 0x2000a,    0, 0, "ECAP_RBCB" },
 307   { 0x2000b,    0, 0, "ECAP_VNDR" },
 308   { 0x2000d,    0, 0, "ECAP_ACS" },
 309   { 0x2000e,    0, 0, "ECAP_ARI" },
 310   { 0x2000f,    0, 0, "ECAP_ATS" },
 311   { 0x20010,    0, 0, "ECAP_SRIOV" },
 312   {       0,    0, 0, NULL }
 313 };
 314
 315 static void NONRET PCI_PRINTF(1,2)
 316 usage(char *msg, ...)
 317 {
 318   va_list args;
 319   va_start(args, msg);
 320   if (msg)
 321     {
 322       fprintf(stderr, "setpci: ");
 323       vfprintf(stderr, msg, args);
 324       fprintf(stderr, "\n\n");
 325     }
 326   fprintf(stderr,
 327 "Usage: setpci [<options>] (<device>+ <reg>[=<values>]*)*\n"
 328 "\n"
 329 "General options:\n"
 330 "-f\t\tDon't complain if there's nothing to do\n"
 331 "-v\t\tBe verbose\n"
 332 "-D\t\tList changes, don't commit them\n"
 333 "\n"
 334 "PCI access options:\n"
 335 GENERIC_HELP
 336 "\n"
 337 "Setting commands:\n"
 338 "<device>:\t-s [[[<domain>]:][<bus>]:][<slot>][.[<func>]]\n"
 339 "\t\t-d [<vendor>]:[<device>]\n"
 340 "<reg>:\t\t<base>[+<offset>][.(B|W|L)]\n"
 341 "<base>:\t\t<address>\n"
 342 "\t\t<named-register>\n"
 343 "\t\t[E]CAP_<capability-name>\n"
 344 "\t\t[E]CAP<capability-number>\n"
 345 "<values>:\t<value>[,<value>...]\n"
 346 "<value>:\t<hex>\n"
 347 "\t\t<hex>:<mask>\n");
 348   exit(1);
 349 }
 350
 351 static int
 352 parse_options(int argc, char **argv)
 353 {
 354   char *opts = GENERIC_OPTIONS;
 355   int i=1;
 356
 357   if (argc == 2 && !strcmp(argv[1], "--version"))
 358     {
 359       puts("setpci version " PCIUTILS_VERSION);
 360       return 0;
 361     }
 362
 363   while (i < argc && argv[i][0] == '-')
 364     {
 365       char *c = argv[i++] + 1;
 366       char *d = c;
 367       char *e;
 368       while (*c)
 369         switch (*c)
 370           {
 371           case 0:
 372             break;
 373           case 'v':
 374             verbose++;
 375             c++;
 376             break;
 377           case 'f':
 378             force++;
 379             c++;
 380             break;
 381           case 'D':
 382             demo_mode++;
 383             c++;
 384             break;
 385           default:
 386             if (e = strchr(opts, *c))
 387               {
 388                 char *arg;
 389                 c++;
 390                 if (e[1] == ':')
 391                   {
 392                     if (*c)
 393                       arg = c;
 394                     else if (i < argc)
 395                       arg = argv[i++];
 396                     else
 397                       usage(NULL);
 398                     c = "";
 399                   }
 400                 else
 401                   arg = NULL;
 402                 if (!parse_generic_option(*e, pacc, arg))
 403                   usage(NULL);
 404               }
 405             else
 406               {
 407                 if (c != d)
 408                   usage(NULL);
 409                 return i-1;
 410               }
 411           }
 412     }
 413
 414   return i;
 415 }
 416
 417 static int parse_filter(int argc, char **argv, int i, struct pci_filter *filter)
 418 {
 419   char *c = argv[i++];
 420   char *d;
 421
 422   if (!c[1] || !strchr("sd", c[1]))
 423     usage(NULL);
 424   if (c[2])
 425     d = (c[2] == '=') ? c+3 : c+2;
 426   else if (i < argc)
 427     d = argv[i++];
 428   else
 429     usage(NULL);
 430   switch (c[1])
 431     {
 432     case 's':
 433       if (d = pci_filter_parse_slot(filter, d))
 434         die("-s: %s", d);
 435       break;
 436     case 'd':
 437       if (d = pci_filter_parse_id(filter, d))
 438         die("-d: %s", d);
 439       break;
 440     default:
 441       usage(NULL);
 442     }
 443
 444   return i;
 445 }
 446
 447 static const struct reg_name *parse_reg_name(char *name)
 448 {
 449   const struct reg_name *r;
 450
 451   for (r = pci_reg_names; r->name; r++)
 452     if (!strcasecmp(r->name, name))
 453       return r;
 454   return NULL;
 455 }
 456
 457 static int parse_x32(char *c, char **stopp, unsigned int *resp)
 458 {
 459   char *stop;
 460
 461   if (!*c)
 462     return -1;
 463   errno = 0;
 464   unsigned long int l = strtoul(c, &stop, 16);
 465   if (errno)
 466     return -1;
 467   if ((l & ~0U) != l)
 468     return -1;
 469   *resp = l;
 470   if (*stop)
 471     {
 472       if (stopp)
 473         *stopp = stop;
 474       return 0;
 475     }
 476   else
 477     return 1;
 478 }
 479
 480 static void parse_register(struct op *op, char *base)
 481 {
 482   const struct reg_name *r;
 483
 484   if (parse_x32(base, NULL, &op->addr) > 0)
 485     {
 486       op->cap = 0;
 487       return;
 488     }
 489   else if (r = parse_reg_name(base))
 490     {
 491       op->cap = r->cap;
 492       op->addr = r->offset;
 493       if (r->width && !op->width)
 494         op->width = r->width;
 495       return;
 496     }
 497   else if (!strncasecmp(base, "CAP", 3))
 498     {
 499       if (parse_x32(base+3, NULL, &op->cap) > 0 && op->cap < 0x100)
 500         {
 501           op->cap += 0x10000;
 502           op->addr = 0;
 503           return;
 504         }
 505     }
 506   else if (!strncasecmp(base, "ECAP", 4))
 507     {
 508       if (parse_x32(base+4, NULL, &op->cap) > 0 && op->cap < 0x1000)
 509         {
 510           op->cap += 0x20000;
 511           op->addr = 0;
 512           return;
 513         }
 514     }
 515   usage("Unknown register \"%s\"", base);
 516 }
 517
 518 static void parse_op(char *c, struct pci_dev **selected_devices)
 519 {
 520   char *base, *offset, *width, *value;
 521   char *e, *f;
 522   int n, j;
 523   struct op *op;
 524
 525   /* Split the argument */
 526   base = xstrdup(c);
 527   if (value = strchr(base, '='))
 528     *value++ = 0;
 529   if (width = strchr(base, '.'))
 530     *width++ = 0;
 531   if (offset = strchr(base, '+'))
 532     *offset++ = 0;
 533
 534   /* Look for setting of values and count how many */
 535   n = 0;
 536   if (value)
 537     {
 538       if (!*value)
 539         usage("Missing value");
 540       n++;
 541       for (e=value; *e; e++)
 542         if (*e == ',')
 543           n++;
 544     }
 545
 546   /* Allocate the operation */
 547   op = xmalloc(sizeof(struct op) + n*sizeof(struct value));
 548   op->dev_vector = selected_devices;
 549   op->num_values = n;
 550
 551   /* What is the width suffix? */
 552   if (width)
 553     {
 554       if (width[1])
 555         usage("Invalid width \"%s\"", width);
 556       switch (*width & 0xdf)
 557         {
 558         case 'B':
 559           op->width = 1; break;
 560         case 'W':
 561           op->width = 2; break;
 562         case 'L':
 563           op->width = 4; break;
 564         default:
 565           usage("Invalid width \"%c\"", *width);
 566         }
 567     }
 568   else
 569     op->width = 0;
 570
 571   /* Find the register */
 572   parse_register(op, base);
 573   if (!op->width)
 574     usage("Missing width");
 575
 576   /* Add offset */
 577   if (offset)
 578     {
 579       unsigned int off;
 580       if (parse_x32(offset, NULL, &off) <= 0 || off >= 0x1000)
 581         die("Invalid offset \"%s\"", offset);
 582       op->addr += off;
 583     }
 584
 585   /* Check range */
 586   if (op->addr >= 0x1000 || op->addr + op->width*(n ? n : 1) > 0x1000)
 587     die("Register number out of range!");
 588   if (op->addr & (op->width - 1))
 589     die("Unaligned register address!");
 590
 591   /* Parse the values */
 592   for (j=0; j<n; j++)
 593     {
 594       unsigned int ll, lim;
 595       e = strchr(value, ',');
 596       if (e)
 597         *e++ = 0;
 598       if (parse_x32(value, &f, &ll) < 0 || *f && *f != ':')
 599         usage("Invalid value \"%s\"", value);
 600       lim = max_values[op->width];
 601       if (ll > lim && ll < ~0UL - lim)
 602         usage("Value \"%s\" is out of range", value);
 603       op->values[j].value = ll;
 604       if (*f == ':')
 605         {
 606           if (parse_x32(f+1, NULL, &ll) <= 0)
 607             usage("Invalid mask \"%s\"", f+1);
 608           if (ll > lim && ll < ~0UL - lim)
 609             usage("Mask \"%s\" is out of range", f+1);
 610           op->values[j].mask = ll;
 611           op->values[j].value &= ll;
 612         }
 613       else
 614         op->values[j].mask = ~0U;
 615       value = e;
 616     }
 617
 618   *last_op = op;
 619   last_op = &op->next;
 620   op->next = NULL;
 621 }
 622
 623 static void parse_ops(int argc, char **argv, int i)
 624 {
 625   enum { STATE_INIT, STATE_GOT_FILTER, STATE_GOT_OP } state = STATE_INIT;
 626   struct pci_filter filter;
 627   struct pci_dev **selected_devices = NULL;
 628
 629   while (i < argc)
 630     {
 631       char *c = argv[i++];
 632
 633       if (*c == '-')
 634         {
 635           if (state != STATE_GOT_FILTER)
 636             pci_filter_init(pacc, &filter);
 637           i = parse_filter(argc, argv, i-1, &filter);
 638           state = STATE_GOT_FILTER;
 639         }
 640       else
 641         {
 642           if (state == STATE_INIT)
 643             usage(NULL);
 644           if (state == STATE_GOT_FILTER)
 645             selected_devices = select_devices(&filter);
 646           if (!selected_devices[0] && !force)
 647             fprintf(stderr, "setpci: Warning: No devices selected for `%s'.\n", c);
 648           parse_op(c, selected_devices);
 649           state = STATE_GOT_OP;
 650         }
 651     }
 652   if (state == STATE_INIT)
 653     usage("No operation specified");
 654 }
 655
 656 int
 657 main(int argc, char **argv)
 658 {
 659   int i;
 660
 661   pacc = pci_alloc();
 662   pacc->error = die;
 663   i = parse_options(argc, argv);
 664
 665   pci_init(pacc);
 666   pci_scan_bus(pacc);
 667
 668   parse_ops(argc, argv, i);
 669   scan_ops(first_op);
 670   execute(first_op);
 671
 672   return 0;
 673 }