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