]> mj.ucw.cz Git - pciutils.git/blob - setpci.c
a0daddb6f32792e31b4bcc37f16895698e4ad109
[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
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       trace(((op->cap_type == PCI_CAP_NORMAL) ? "(cap %02x)" : "(ecap %04x)"), op->cap_id);
89       cap = pci_find_cap(dev, op->cap_id, op->cap_type);
90       if (cap)
91         addr = cap->addr;
92       else
93         die("%s: %s %04x not found", slot, ((op->cap_type == PCI_CAP_NORMAL) ? "Capability" : "Extended capability"), op->cap_id);
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 PCI_PRINTF(1,2)
327 usage(char *msg, ...)
328 {
329   va_list args;
330   va_start(args, msg);
331   if (msg)
332     {
333       fprintf(stderr, "setpci: ");
334       vfprintf(stderr, msg, args);
335       fprintf(stderr, "\n\n");
336     }
337   fprintf(stderr,
338 "Usage: setpci [<options>] (<device>+ <reg>[=<values>]*)*\n"
339 "\n"
340 "General options:\n"
341 "-f\t\tDon't complain if there's nothing to do\n"
342 "-v\t\tBe verbose\n"
343 "-D\t\tList changes, don't commit them\n"
344 "--dumpregs\tDump all known register names and exit\n"
345 "\n"
346 "PCI access options:\n"
347 GENERIC_HELP
348 "\n"
349 "Setting commands:\n"
350 "<device>:\t-s [[[<domain>]:][<bus>]:][<slot>][.[<func>]]\n"
351 "\t\t-d [<vendor>]:[<device>]\n"
352 "<reg>:\t\t<base>[+<offset>][.(B|W|L)]\n"
353 "<base>:\t\t<address>\n"
354 "\t\t<named-register>\n"
355 "\t\t[E]CAP_<capability-name>\n"
356 "\t\t[E]CAP<capability-number>\n"
357 "<values>:\t<value>[,<value>...]\n"
358 "<value>:\t<hex>\n"
359 "\t\t<hex>:<mask>\n");
360   exit(1);
361 }
362
363 static int
364 parse_options(int argc, char **argv)
365 {
366   char *opts = GENERIC_OPTIONS;
367   int i=1;
368
369   if (argc == 2 && !strcmp(argv[1], "--version"))
370     {
371       puts("setpci version " PCIUTILS_VERSION);
372       exit(0);
373     }
374   if (argc == 2 && !strcmp(argv[1], "--dumpregs"))
375     {
376       dump_registers();
377       exit(0);
378     }
379
380   while (i < argc && argv[i][0] == '-')
381     {
382       char *c = argv[i++] + 1;
383       char *d = c;
384       char *e;
385       while (*c)
386         switch (*c)
387           {
388           case 0:
389             break;
390           case 'v':
391             verbose++;
392             c++;
393             break;
394           case 'f':
395             force++;
396             c++;
397             break;
398           case 'D':
399             demo_mode++;
400             c++;
401             break;
402           default:
403             if (e = strchr(opts, *c))
404               {
405                 char *arg;
406                 c++;
407                 if (e[1] == ':')
408                   {
409                     if (*c)
410                       arg = c;
411                     else if (i < argc)
412                       arg = argv[i++];
413                     else
414                       usage(NULL);
415                     c = "";
416                   }
417                 else
418                   arg = NULL;
419                 if (!parse_generic_option(*e, pacc, arg))
420                   usage(NULL);
421               }
422             else
423               {
424                 if (c != d)
425                   usage(NULL);
426                 return i-1;
427               }
428           }
429     }
430
431   return i;
432 }
433
434 static int parse_filter(int argc, char **argv, int i, struct pci_filter *filter)
435 {
436   char *c = argv[i++];
437   char *d;
438
439   if (!c[1] || !strchr("sd", c[1]))
440     usage(NULL);
441   if (c[2])
442     d = (c[2] == '=') ? c+3 : c+2;
443   else if (i < argc)
444     d = argv[i++];
445   else
446     usage(NULL);
447   switch (c[1])
448     {
449     case 's':
450       if (d = pci_filter_parse_slot(filter, d))
451         die("-s: %s", d);
452       break;
453     case 'd':
454       if (d = pci_filter_parse_id(filter, d))
455         die("-d: %s", d);
456       break;
457     default:
458       usage(NULL);
459     }
460
461   return i;
462 }
463
464 static const struct reg_name *parse_reg_name(char *name)
465 {
466   const struct reg_name *r;
467
468   for (r = pci_reg_names; r->name; r++)
469     if (!strcasecmp(r->name, name))
470       return r;
471   return NULL;
472 }
473
474 static int parse_x32(char *c, char **stopp, unsigned int *resp)
475 {
476   char *stop;
477
478   if (!*c)
479     return -1;
480   errno = 0;
481   unsigned long int l = strtoul(c, &stop, 16);
482   if (errno)
483     return -1;
484   if ((l & ~0U) != l)
485     return -1;
486   *resp = l;
487   if (*stop)
488     {
489       if (stopp)
490         *stopp = stop;
491       return 0;
492     }
493   else
494     return 1;
495 }
496
497 static void parse_register(struct op *op, char *base)
498 {
499   const struct reg_name *r;
500   unsigned int cap;
501
502   op->cap_type = op->cap_id = 0;
503   if (parse_x32(base, NULL, &op->addr) > 0)
504     return;
505   else if (r = parse_reg_name(base))
506     {
507       switch (r->cap & 0xff0000)
508         {
509         case 0x10000:
510           op->cap_type = PCI_CAP_NORMAL;
511           break;
512         case 0x20000:
513           op->cap_type = PCI_CAP_EXTENDED;
514           break;
515         }
516       op->cap_id = r->cap & 0xffff;
517       op->addr = r->offset;
518       if (r->width && !op->width)
519         op->width = r->width;
520       return;
521     }
522   else if (!strncasecmp(base, "CAP", 3))
523     {
524       if (parse_x32(base+3, NULL, &cap) > 0 && cap < 0x100)
525         {
526           op->cap_type = PCI_CAP_NORMAL;
527           op->cap_id = cap;
528           op->addr = 0;
529           return;
530         }
531     }
532   else if (!strncasecmp(base, "ECAP", 4))
533     {
534       if (parse_x32(base+4, NULL, &cap) > 0 && cap < 0x1000)
535         {
536           op->cap_type = PCI_CAP_EXTENDED;
537           op->cap_id = cap;
538           op->addr = 0;
539           return;
540         }
541     }
542   usage("Unknown register \"%s\"", base);
543 }
544
545 static void parse_op(char *c, struct pci_dev **selected_devices)
546 {
547   char *base, *offset, *width, *value;
548   char *e, *f;
549   int n, j;
550   struct op *op;
551
552   /* Split the argument */
553   base = xstrdup(c);
554   if (value = strchr(base, '='))
555     *value++ = 0;
556   if (width = strchr(base, '.'))
557     *width++ = 0;
558   if (offset = strchr(base, '+'))
559     *offset++ = 0;
560
561   /* Look for setting of values and count how many */
562   n = 0;
563   if (value)
564     {
565       if (!*value)
566         usage("Missing value");
567       n++;
568       for (e=value; *e; e++)
569         if (*e == ',')
570           n++;
571     }
572
573   /* Allocate the operation */
574   op = xmalloc(sizeof(struct op) + n*sizeof(struct value));
575   op->dev_vector = selected_devices;
576   op->num_values = n;
577
578   /* What is the width suffix? */
579   if (width)
580     {
581       if (width[1])
582         usage("Invalid width \"%s\"", width);
583       switch (*width & 0xdf)
584         {
585         case 'B':
586           op->width = 1; break;
587         case 'W':
588           op->width = 2; break;
589         case 'L':
590           op->width = 4; break;
591         default:
592           usage("Invalid width \"%c\"", *width);
593         }
594     }
595   else
596     op->width = 0;
597
598   /* Find the register */
599   parse_register(op, base);
600   if (!op->width)
601     usage("Missing width");
602
603   /* Add offset */
604   if (offset)
605     {
606       unsigned int off;
607       if (parse_x32(offset, NULL, &off) <= 0 || off >= 0x1000)
608         die("Invalid offset \"%s\"", offset);
609       op->addr += off;
610     }
611
612   /* Check range */
613   if (op->addr >= 0x1000 || op->addr + op->width*(n ? n : 1) > 0x1000)
614     die("Register number out of range!");
615   if (op->addr & (op->width - 1))
616     die("Unaligned register address!");
617
618   /* Parse the values */
619   for (j=0; j<n; j++)
620     {
621       unsigned int ll, lim;
622       e = strchr(value, ',');
623       if (e)
624         *e++ = 0;
625       if (parse_x32(value, &f, &ll) < 0 || *f && *f != ':')
626         usage("Invalid value \"%s\"", value);
627       lim = max_values[op->width];
628       if (ll > lim && ll < ~0UL - lim)
629         usage("Value \"%s\" is out of range", value);
630       op->values[j].value = ll;
631       if (*f == ':')
632         {
633           if (parse_x32(f+1, NULL, &ll) <= 0)
634             usage("Invalid mask \"%s\"", f+1);
635           if (ll > lim && ll < ~0UL - lim)
636             usage("Mask \"%s\" is out of range", f+1);
637           op->values[j].mask = ll;
638           op->values[j].value &= ll;
639         }
640       else
641         op->values[j].mask = ~0U;
642       value = e;
643     }
644
645   *last_op = op;
646   last_op = &op->next;
647   op->next = NULL;
648 }
649
650 static void parse_ops(int argc, char **argv, int i)
651 {
652   enum { STATE_INIT, STATE_GOT_FILTER, STATE_GOT_OP } state = STATE_INIT;
653   struct pci_filter filter;
654   struct pci_dev **selected_devices = NULL;
655
656   while (i < argc)
657     {
658       char *c = argv[i++];
659
660       if (*c == '-')
661         {
662           if (state != STATE_GOT_FILTER)
663             pci_filter_init(pacc, &filter);
664           i = parse_filter(argc, argv, i-1, &filter);
665           state = STATE_GOT_FILTER;
666         }
667       else
668         {
669           if (state == STATE_INIT)
670             usage(NULL);
671           if (state == STATE_GOT_FILTER)
672             selected_devices = select_devices(&filter);
673           if (!selected_devices[0] && !force)
674             fprintf(stderr, "setpci: Warning: No devices selected for `%s'.\n", c);
675           parse_op(c, selected_devices);
676           state = STATE_GOT_OP;
677         }
678     }
679   if (state == STATE_INIT)
680     usage("No operation specified");
681 }
682
683 int
684 main(int argc, char **argv)
685 {
686   int i;
687
688   pacc = pci_alloc();
689   pacc->error = die;
690   i = parse_options(argc, argv);
691
692   pci_init(pacc);
693   pci_scan_bus(pacc);
694
695   parse_ops(argc, argv, i);
696   scan_ops(first_op);
697   execute(first_op);
698
699   return 0;
700 }