aboutsummaryrefslogtreecommitdiffstats
path: root/com32/lib/pci/scan.c
blob: cfd9e6546c2bd78d5f89fe935242a1d7e1463609 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
/* ----------------------------------------------------------------------- *
 *
 *   Copyright 2006-2007 Erwan Velu - All Rights Reserved
 *
 *   Permission is hereby granted, free of charge, to any person
 *   obtaining a copy of this software and associated documentation
 *   files (the "Software"), to deal in the Software without
 *   restriction, including without limitation the rights to use,
 *   copy, modify, merge, publish, distribute, sublicense, and/or
 *   sell copies of the Software, and to permit persons to whom
 *   the Software is furnished to do so, subject to the following
 *   conditions:
 *
 *   The above copyright notice and this permission notice shall
 *   be included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 *   OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 *   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 *   HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 *   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 *   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 *
 * ----------------------------------------------------------------------- */

/*
 * pci.c
 *
 * A module to extract pci informations
 */

#include <inttypes.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <console.h>
#include <sys/pci.h>
#include <com32.h>
#include <stdbool.h>

#ifdef DEBUG
# define dprintf printf
#else
# define dprintf(...) ((void)0)
#endif

#define MAX_LINE 512

/* searching the next char that is not a space */
static char *skipspace(char *p)
{
  while (*p && *p <= ' ')
    p++;

  return p;
}

/* removing any \n found in a string */
static void remove_eol(char *string)
{
 int j = strlen(string);
 int i = 0;
 for(i = 0; i < j; i++) if(string[i] == '\n') string[i] = 0;
}

/* converting a hexa string into its numerical value */
static int hex_to_int(char *hexa)
{
  return strtoul(hexa, NULL, 16);
}

/* Try to match any pci device to the appropriate kernel module */
/* it uses the modules.pcimap from the boot device */
int get_module_name_from_pci_ids(struct pci_domain *domain, char *modules_pcimap_path)
{
  char line[MAX_LINE];
  char module_name[21]; // the module name field is 21 char long
  char delims[]=" ";    // colums are separated by spaces
  char vendor_id[16];
  char product_id[16];
  char sub_vendor_id[16];
  char sub_product_id[16];
  FILE *f;
  struct pci_device *dev;

  /* Intializing the linux_kernel_module for each pci device to "unknown" */
  /* adding a dev_info member if needed */
  for_each_pci_func(dev, domain) {
    /* initialize the dev_info structure if it doesn't exist yet. */
    if (! dev->dev_info) {
      dev->dev_info = zalloc(sizeof *dev->dev_info);
      if (!dev->dev_info)
	return -1;
    }
    for (int i=0;i<MAX_KERNEL_MODULES_PER_PCI_DEVICE;i++) {
     strlcpy(dev->dev_info->linux_kernel_module[i], "unknown",7);
    }
  }

  /* Opening the modules.pcimap (of a linux kernel) from the boot device */
  f=fopen(modules_pcimap_path, "r");
  if (!f)
    return -ENOMODULESPCIMAP;

  strcpy(vendor_id,"0000");
  strcpy(product_id,"0000");
  strcpy(sub_product_id,"0000");
  strcpy(sub_vendor_id,"0000");
  dev->dev_info->linux_kernel_module_count=0;

  /* for each line we found in the modules.pcimap */
  while ( fgets(line, sizeof line, f) ) {
    /* skipping unecessary lines */
    if ((line[0] == '#') || (line[0] == ' ') || (line[0] == 10))
        continue;

    char *result = NULL;
    int field=0;

    /* looking for the next field */
    result = strtok(line, delims);
    while( result != NULL ) {
       /* if the column is larger than 1 char */
       /* multiple spaces generates some empty fields */
       if (strlen(result)>1) {
	 switch (field) {
	 case 0:strcpy(module_name,result); break;
	 case 1:strcpy(vendor_id,result); break;
	 case 2:strcpy(product_id,result); break;
	 case 3:strcpy(sub_vendor_id,result); break;
	 case 4:strcpy(sub_product_id,result); break;
	 }
	 field++;
       }
       /* Searching the next field */
       result = strtok( NULL, delims );
   }
    int int_vendor_id=hex_to_int(vendor_id);
    int int_sub_vendor_id=hex_to_int(sub_vendor_id);
    int int_product_id=hex_to_int(product_id);
    int int_sub_product_id=hex_to_int(sub_product_id);
    /* if a pci_device matches an entry, fill the linux_kernel_module with
       the appropriate kernel module */
    for_each_pci_func(dev, domain) {
      if (int_vendor_id == dev->vendor &&
	  int_product_id == dev->product &&
	  (int_sub_product_id & dev->sub_product)
	  == dev->sub_product &&
	  (int_sub_vendor_id & dev->sub_vendor)
	  == dev->sub_vendor) {
	strcpy(dev->dev_info->linux_kernel_module[dev->dev_info->linux_kernel_module_count], module_name);
	dev->dev_info->linux_kernel_module_count++;
      }
    }
  }
  fclose(f);
  return 0;
}

/* Try to match any pci device to the appropriate class name */
/* it uses the pci.ids from the boot device */
int get_class_name_from_pci_ids(struct pci_domain *domain, char *pciids_path)
{
  char line[MAX_LINE];
  char class_name[PCI_CLASS_NAME_SIZE];
  char sub_class_name[PCI_CLASS_NAME_SIZE];
  char class_id_str[5];
  char sub_class_id_str[5];
  FILE *f;
  struct pci_device *dev;
  bool class_mode=false;

  /* Intializing the vendor/product name for each pci device to "unknown" */
  /* adding a dev_info member if needed */
  for_each_pci_func(dev, domain) {
    /* initialize the dev_info structure if it doesn't exist yet. */
    if (! dev->dev_info) {
      dev->dev_info = zalloc(sizeof *dev->dev_info);
      if (!dev->dev_info)
	return -1;
    }
    strlcpy(dev->dev_info->class_name,"unknown",7);
  }

  /* Opening the pci.ids from the boot device */
  f = fopen(pciids_path,"r");
  if (!f)
    return -ENOPCIIDS;

  /* for each line we found in the pci.ids */
  while ( fgets(line, sizeof line, f) ) {
    /* Skipping uncessary lines */
    if ((line[0] == '#') || (line[0] == ' ') ||
	(line[0] == 10))
      continue;

    /* Until we found a line starting with a 'C', we are not parsing classes */
    if (line[0] == 'C')
	    class_mode=true;
    if (class_mode == false)
		continue;
    strlcpy(class_name,"unknown",7);
    /* If the line doesn't start with a tab, it means that's a class name */
    if (line[0] != '\t') {

      /* ignore the two first char and then copy 2 chars (class id)*/
      strlcpy(class_id_str,&line[2],2);
      class_id_str[2]=0;

      /* the class name is the next field */
      strlcpy(class_name,skipspace(strstr(line," ")),PCI_CLASS_NAME_SIZE-1);
      remove_eol(class_name);

      int int_class_id_str=hex_to_int(class_id_str);
      /* assign the class_name to any matching pci device */
      for_each_pci_func(dev, domain) {
	if (int_class_id_str == dev->class[2]) {
	  strlcpy(dev->dev_info->class_name,class_name,PCI_CLASS_NAME_SIZE-1);
	  /* This value is usually the main category*/
	  strlcpy(dev->dev_info->category_name,class_name+4,PCI_CLASS_NAME_SIZE-1);
	}
      }
      /* if we have a tab + a char, it means this is a sub class name */
    } else if ((line[0] == '\t') && (line[1] != '\t')) {

      /* the sub class name the second field */
      strlcpy(sub_class_name,skipspace(strstr(line," ")),PCI_CLASS_NAME_SIZE-1);
      remove_eol(sub_class_name);

      /* the sub class id is first field */
      strlcpy(sub_class_id_str,&line[1],2);
      sub_class_id_str[2]=0;

      int int_class_id_str=hex_to_int(class_id_str);
      int int_sub_class_id_str=hex_to_int(sub_class_id_str);
      /* assign the product_name to any matching pci device */
      for_each_pci_func(dev, domain) {
	if (int_class_id_str == dev->class[2] &&
	    int_sub_class_id_str == dev->class[1])
	  strlcpy(dev->dev_info->class_name,sub_class_name,PCI_CLASS_NAME_SIZE-1);
      }

    }
  }
  fclose(f);
  return 0;
}


/* Try to match any pci device to the appropriate vendor and product name */
/* it uses the pci.ids from the boot device */
int get_name_from_pci_ids(struct pci_domain *domain, char *pciids_path)
{
  char line[MAX_LINE];
  char vendor[PCI_VENDOR_NAME_SIZE];
  char vendor_id[5];
  char product[PCI_PRODUCT_NAME_SIZE];
  char product_id[5];
  char sub_product_id[5];
  char sub_vendor_id[5];
  FILE *f;
  struct pci_device *dev;
  bool skip_to_next_vendor=false;
  uint16_t int_vendor_id;
  uint16_t int_product_id;
  uint16_t int_sub_product_id;
  uint16_t int_sub_vendor_id;

  /* Intializing the vendor/product name for each pci device to "unknown" */
  /* adding a dev_info member if needed */
  for_each_pci_func(dev, domain) {
    /* initialize the dev_info structure if it doesn't exist yet. */
    if (! dev->dev_info) {
      dev->dev_info = zalloc(sizeof *dev->dev_info);
      if (!dev->dev_info)
	return -1;
    }
    strlcpy(dev->dev_info->vendor_name,"unknown",7);
    strlcpy(dev->dev_info->product_name,"unknown",7);
  }

  /* Opening the pci.ids from the boot device */
  f = fopen(pciids_path,"r");
  if (!f)
    return -ENOPCIIDS;

  strlcpy(vendor_id,"0000",4);
  strlcpy(product_id,"0000",4);
  strlcpy(sub_product_id,"0000",4);
  strlcpy(sub_vendor_id,"0000",4);

  /* for each line we found in the pci.ids */
  while ( fgets(line, sizeof line, f) ) {
    /* Skipping uncessary lines */
    if ((line[0] == '#') || (line[0] == ' ') || (line[0] == 'C') ||
	(line[0] == 10))
      continue;

    /* If the line doesn't start with a tab, it means that's a vendor id */
    if (line[0] != '\t') {

      /* the 4 first chars are the vendor_id */
      strlcpy(vendor_id,line,4);

      /* the vendor name is the next field */
      vendor_id[4]=0;
      strlcpy(vendor,skipspace(strstr(line," ")),PCI_VENDOR_NAME_SIZE-1);

      remove_eol(vendor);
      /* init product_id, sub_product and sub_vendor */
      strlcpy(product_id,"0000",4);
      strlcpy(sub_product_id,"0000",4);
      strlcpy(sub_vendor_id,"0000",4);

      /* Unless we found a matching device, we have to skip to the next vendor */
      skip_to_next_vendor=true;

      int_vendor_id=hex_to_int(vendor_id);
      /* Iterate in all pci devices to find a matching vendor */
      for_each_pci_func(dev, domain) {
	/* if one device that match this vendor */
	if (int_vendor_id == dev->vendor) {
	  /* copy the vendor name for this device */
	  strlcpy(dev->dev_info->vendor_name,vendor,PCI_VENDOR_NAME_SIZE-1);
	  /* Some pci devices match this vendor, so we have to found them */
	  skip_to_next_vendor=false;
	  /* Let's loop on the other devices as some may have the same vendor */
	}
      }
      /* if we have a tab + a char, it means this is a product id
       * but we only look at it if we own some pci devices of the current vendor*/
    } else if ((line[0] == '\t') && (line[1] != '\t') && (skip_to_next_vendor == false)) {

      /* the product name the second field */
      strlcpy(product,skipspace(strstr(line," ")),PCI_PRODUCT_NAME_SIZE-1);
      remove_eol(product);

      /* the product id is first field */
      strlcpy(product_id,&line[1],4);
      product_id[4]=0;

      /* init sub_product and sub_vendor */
      strlcpy(sub_product_id,"0000",4);
      strlcpy(sub_vendor_id,"0000",4);

      int_vendor_id=hex_to_int(vendor_id);
      int_product_id=hex_to_int(product_id);
      /* assign the product_name to any matching pci device */
      for_each_pci_func(dev, domain) {
	if (int_vendor_id == dev->vendor &&
	    int_product_id == dev->product) {
	  strlcpy(dev->dev_info->vendor_name,vendor,PCI_VENDOR_NAME_SIZE-1);
	  strlcpy(dev->dev_info->product_name,product,PCI_PRODUCT_NAME_SIZE-1);
	}
      }

      /* if we have two tabs, it means this is a sub product
       * but we only look at it if we own some pci devices of the current vendor*/
    } else if ((line[0] == '\t') && (line[1] == '\t') && (skip_to_next_vendor == false)) {

      /* the product name is last field */
      strlcpy(product,skipspace(strstr(line," ")),PCI_PRODUCT_NAME_SIZE-1);
      strlcpy(product,skipspace(strstr(product," ")),PCI_PRODUCT_NAME_SIZE-1);
      remove_eol(product);

      /* the sub_vendor id is first field */
      strlcpy(sub_vendor_id,&line[2],4);
      sub_vendor_id[4]=0;

      /* the sub_vendor id is second field */
      strlcpy(sub_product_id,&line[7],4);
      sub_product_id[4]=0;

      int_vendor_id=hex_to_int(vendor_id);
      int_sub_vendor_id=hex_to_int(sub_vendor_id);
      int_product_id=hex_to_int(product_id);
      int_sub_product_id=hex_to_int(sub_product_id);
      /* assign the product_name to any matching pci device */
      for_each_pci_func(dev, domain) {
	if (int_vendor_id == dev->vendor &&
	    int_product_id == dev->product &&
	    int_sub_product_id == dev->sub_product &&
	    int_sub_vendor_id == dev->sub_vendor) {
	  strlcpy(dev->dev_info->vendor_name,vendor,PCI_VENDOR_NAME_SIZE-1);
	  strlcpy(dev->dev_info->product_name,product,PCI_PRODUCT_NAME_SIZE-1);
	}
      }
    }
  }
  fclose(f);
  return 0;
}

/* searching if any pcidevice match our query */
struct match *find_pci_device(const struct pci_domain *domain,
			      struct match *list)
{
  uint32_t did, sid;
  struct match *m;
  const struct pci_device *dev;

  /* for all matches we have to search */
  for (m = list; m; m = m->next) {
    /* for each pci device we know */
    for_each_pci_func(dev, domain) {
      /* sid & did are the easiest way to compare devices */
      /* they are made of vendor/product subvendor/subproduct ids */
      sid = dev->svid_sdid;
      did = dev->vid_did;
      /* if the current device match */
      if (((did ^ m->did) & m->did_mask) == 0 &&
	  ((sid ^ m->sid) & m->sid_mask) == 0 &&
	  dev->revision >= m->rid_min
	  && dev->revision <= m->rid_max) {
	dprintf("PCI Match: Vendor=%04x Product=%04x Sub_vendor=%04x Sub_Product=%04x Release=%02x\n",
		dev->vendor, dev->product,
		dev->sub_vendor,
		dev->sub_product,
		dev->revision);
	/* returning the matched pci device */
	return m;
      }
    }
  }
  return NULL;
}

/* scanning the pci bus to find pci devices */
struct pci_domain *pci_scan(void)
{
  struct pci_domain *domain = NULL;
  struct pci_bus    *bus    = NULL;
  struct pci_slot   *slot   = NULL;
  struct pci_device *func   = NULL;
  unsigned int nbus, ndev, nfunc, maxfunc;
  uint32_t did, sid, rcid;
  uint8_t hdrtype;
  pciaddr_t a;
  int cfgtype;

  cfgtype = pci_set_config_type(PCI_CFG_AUTO);
  (void)cfgtype;

  dprintf("PCI configuration type %d\n", cfgtype);
  dprintf("Scanning PCI Buses\n");

  for (nbus = 0; nbus < MAX_PCI_BUSES; nbus++) {
    dprintf("Probing bus 0x%02x... \n", nbus);
    bus = NULL;

    for (ndev = 0; ndev < MAX_PCI_DEVICES; ndev++) {
      maxfunc = 1;		/* Assume a single-function device */
      slot = NULL;

      for (nfunc = 0; nfunc < maxfunc; nfunc++) {
	a = pci_mkaddr(nbus, ndev, nfunc, 0);
	did = pci_readl(a);

	if (did == 0xffffffff || did == 0xffff0000 ||
	    did == 0x0000ffff || did == 0x00000000)
	  continue;

	hdrtype = pci_readb(a + 0x0e);

	if (hdrtype & 0x80)
	  maxfunc = MAX_PCI_FUNC; /* Multifunction device */

	rcid = pci_readl(a + 0x08);
	sid  = pci_readl(a + 0x2c);

	if (!domain) {
	  domain = zalloc(sizeof *domain);
	  if (!domain)
	    goto bail;
	}
	if (!bus) {
	  bus = zalloc(sizeof *bus);
	  if (!bus)
	    goto bail;
	  domain->bus[nbus] = bus;
	}
	if (!slot) {
	  slot = zalloc(sizeof *slot);
	  if (!slot)
	    goto bail;
	  bus->slot[ndev] = slot;
	}
	func = zalloc(sizeof *func);
	if (!func)
	  goto bail;

	slot->func[nfunc] = func;

	func->vid_did   = did;
	func->svid_sdid = sid;
	func->rid_class = rcid;

	dprintf
	  ("Scanning: BUS %02x DID %08x (%04x:%04x) SID %08x RID %02x\n",
	   nbus, did, did >> 16, (did << 16) >> 16,
	   sid, rcid & 0xff);
      }
    }
  }

  return domain;

 bail:
  free_pci_domain(domain);
  return NULL;
}

void free_pci_domain(struct pci_domain *domain)
{
  struct pci_bus    *bus;
  struct pci_slot   *slot;
  struct pci_device *func;
  unsigned int nbus, ndev, nfunc;

  if (domain) {
    for (nbus = 0; nbus < MAX_PCI_BUSES; nbus++) {
      bus = domain->bus[nbus];
      if (bus) {
	for (ndev = 0; ndev < MAX_PCI_DEVICES; ndev++) {
	  slot = bus->slot[ndev];
	  if (slot) {
	    for (nfunc = 0; nfunc < MAX_PCI_FUNC; nfunc++) {
	      func = slot->func[nfunc];
	      if (func) {
		if (func->dev_info)
		  free(func->dev_info);
		free(func);
	      }
	      free(slot);
	    }
	  }
	  free(bus);
	}
      }
      free(domain);
    }
  }
}