- add hw detection for some DSL devices
[opensuse:hwinfo.git] / src / hd / hd.h
1 #ifndef _HD_H
2 #define _HD_H
3
4 #ifdef __cplusplus
5 extern "C" {
6 #endif
7
8
9 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
10  *
11  *                      libhd data structures
12  *
13  * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
14  */
15
16 #define HD_VERSION      8
17
18 /*
19  * debug flags
20  */
21 #define HD_DEB_SHOW_LOG         (1 <<  0)
22 #define HD_DEB_PROGRESS         (1 <<  1)
23 #define HD_DEB_CREATION         (1 <<  2)
24 #define HD_DEB_DRIVER_INFO      (1 <<  3)
25 #define HD_DEB_PCI              (1 <<  4)
26 #define HD_DEB_ISAPNP           (1 <<  5)
27 #define HD_DEB_CDROM            (1 <<  6)
28 #define HD_DEB_NET              (1 <<  7)
29 #define HD_DEB_FLOPPY           (1 <<  8)
30 #define HD_DEB_MISC             (1 <<  9)
31 #define HD_DEB_SERIAL           (1 << 10)
32 #define HD_DEB_MONITOR          (1 << 11)
33 #define HD_DEB_CPU              (1 << 12)
34 #define HD_DEB_BIOS             (1 << 13)
35 #define HD_DEB_MOUSE            (1 << 14)
36 #define HD_DEB_IDE              (1 << 15)
37 #define HD_DEB_SCSI             (1 << 16)
38 #define HD_DEB_USB              (1 << 17)
39 #define HD_DEB_ADB              (1 << 18)
40 #define HD_DEB_MODEM            (1 << 19)
41 #define HD_DEB_PARALLEL         (1 << 20)
42 #define HD_DEB_ISA              (1 << 21)
43 #define HD_DEB_BOOT             (1 << 22)
44 #define HD_DEB_HDDB             (1 << 23)
45
46 #include <stdio.h>
47 #include <inttypes.h>
48 #include <termios.h>
49
50 /*
51  * libhd's directory
52  */
53 #define HARDWARE_DIR            "/var/lib/hardware"
54 #define HARDWARE_UNIQUE_KEYS    HARDWARE_DIR "/unique-keys"
55
56 /**
57  * \defgroup idmacros Id macros
58  * Macros to handle device and vendor ids.
59  *
60  * Example: to check if an id is a pci id and get its value,
61  * do something like this:
62  * \code
63  * if(ID_TAG(hd->dev) == TAG_PCI) {
64  *   pci_id = ID_VALUE(hd->dev)
65  * }
66  * \endcode
67  *@{
68  */
69
70 #define TAG_PCI         1       /**< PCI ids. */
71 #define TAG_EISA        2       /**< EISA ids (monitors, ISA-PnP, modems, mice etc). */
72 #define TAG_USB         3       /**< USB ids. */
73 #define TAG_SPECIAL     4       /**< Internally used ids. */
74 #define TAG_PCMCIA      5       /**< PCMCIA ids. */
75
76 /**
77  * Get the real id value.
78  */
79 #define ID_VALUE(id)            ((id) & 0xffff)
80
81 /**
82  * Get the tag value.
83  */
84 #define ID_TAG(id)              (((id) >> 16) & 0xf)
85
86 /**
87  * Combine tag and id value.
88  */
89 #define MAKE_ID(tag, id_val)    ((tag << 16) | (id_val))
90
91 /*@}*/
92
93 /*
94  * flags to control the probing.
95  */
96 typedef enum probe_feature {
97   pr_memory = 1, pr_pci, pr_pci_range, pr_pci_ext, pr_isapnp, pr_cdrom,
98   pr_cdrom_info, pr_net, pr_floppy, pr_misc, pr_misc_serial, pr_misc_par,
99   pr_misc_floppy, pr_serial, pr_cpu, pr_bios, pr_monitor, pr_mouse, pr_ide,
100   pr_scsi, pr_scsi_geo, pr_scsi_cache, pr_usb, pr_usb_mods, pr_adb,
101   pr_modem, pr_modem_usb, pr_parallel, pr_parallel_lp, pr_parallel_zip,
102   pr_isa, pr_isa_isdn, pr_dac960, pr_smart, pr_isdn, pr_kbd, pr_prom,
103   pr_sbus, pr_int, pr_braille, pr_braille_alva, pr_braille_fhp,
104   pr_braille_ht, pr_ignx11, pr_sys, pr_dasd, pr_i2o, pr_cciss, pr_bios_vbe,
105   pr_isapnp_old, pr_isapnp_new, pr_isapnp_mod, pr_braille_baum, pr_manual,
106   pr_fb, pr_bios_vbe2, pr_veth, pr_partition, pr_disk, pr_ataraid, pr_pppoe,
107   pr_scan, pr_partition_add, pr_pcmcia, pr_fork, pr_parallel_imm, pr_s390,
108   /* pr_bios_32, */ pr_cpuemu, pr_sysfs, pr_s390disks,
109   pr_max, pr_lxrc, pr_dsl, pr_default, pr_all           /* pr_all must be last */
110 } hd_probe_feature_t;
111
112 /*
113  * list types for hd_list()
114  *
115  * if you want to modify this: cf. manual.c::hw_items[]
116  *
117  * Note: hw_tv _must_ be < hw_display!
118  */
119 typedef enum hw_item {
120   hw_sys = 1, hw_cpu, hw_keyboard, hw_braille, hw_mouse, hw_joystick,
121   hw_printer, hw_scanner, hw_chipcard, hw_monitor, hw_tv, hw_display,
122   hw_framebuffer, hw_camera, hw_sound, hw_storage_ctrl, hw_network_ctrl,
123   hw_isdn, hw_modem, hw_network, hw_disk, hw_partition, hw_cdrom, hw_floppy,
124   hw_manual, hw_usb_ctrl, hw_usb, hw_bios, hw_pci, hw_isapnp, hw_bridge,
125   hw_hub, hw_scsi, hw_ide, hw_memory, hw_dvb, hw_pcmcia, hw_pcmcia_ctrl,
126   hw_ieee1394, hw_ieee1394_ctrl, hw_hotplug, hw_hotplug_ctrl, hw_zip, hw_pppoe,
127   hw_wlan, hw_redasd, hw_dsl,   /* append new entries here */
128   hw_unknown, hw_all                                    /* hw_all must be last */
129 } hd_hw_item_t;
130
131 /*
132  * device base classes and bus types
133  *
134  */
135
136 /* base class values (superset of PCI classes) */
137 typedef enum base_classes {
138   /* these *must* match standard PCI class numbers */
139   bc_none, bc_storage, bc_network, bc_display, bc_multimedia,
140   bc_memory, bc_bridge, bc_comm, bc_system, bc_input, bc_docking,
141   bc_processor, bc_serial, bc_wireless, bc_i2o, bc_other = 0xff,
142
143   // add our own classes here (starting at 0x100 as PCI values are 8 bit)
144   bc_monitor = 0x100, bc_internal, bc_modem, bc_isdn, bc_ps2, bc_mouse,
145   bc_storage_device, bc_network_interface, bc_keyboard, bc_printer,
146   bc_hub, bc_braille, bc_scanner, bc_joystick, bc_chipcard, bc_camera,
147   bc_framebuffer, bc_dvb, bc_tv, bc_partition, bc_dsl
148 } hd_base_classes_t;
149
150 /* subclass values of bc_monitor */
151 typedef enum sc_monitor {
152   sc_mon_other, sc_mon_crt, sc_mon_lcd
153 } hd_sc_monitor_t;
154
155 /* subclass values of bc_storage */
156 typedef enum sc_storage {
157   sc_sto_scsi, sc_sto_ide, sc_sto_floppy, sc_sto_ipi, sc_sto_raid,
158   sc_sto_other = 0x80
159 } hd_sc_storage_t;
160
161 /* subclass values of bc_display */
162 typedef enum sc_display {
163   sc_dis_vga, sc_dis_xga, sc_dis_other = 0x80
164 } hd_sc_display_t;
165
166 /* subclass values of bc_framebuffer */
167 typedef enum sc_framebuffer {
168   sc_fb_vesa = 1
169 } hd_sc_framebuffer_t;
170
171 /* subclass values of bc_bridge */
172 typedef enum sc_bridge { 
173   sc_bridge_host, sc_bridge_isa, sc_bridge_eisa, sc_bridge_mc,
174   sc_bridge_pci, sc_bridge_pcmcia, sc_bridge_nubus, sc_bridge_cardbus,
175   sc_bridge_other = 0x80
176 } hd_sc_bridge_t;
177
178 /* subclass values of bc_comm */
179 typedef enum sc_comm { 
180   sc_com_ser, sc_com_par, sc_com_multi, sc_com_modem, sc_com_other = 0x80
181 } hd_sc_comm_t;
182
183 /* subclass values of bc_system */
184 typedef enum sc_system {
185   sc_sys_pic, sc_sys_dma, sc_sys_timer, sc_sys_rtc, sc_sys_other = 0x80
186 } hd_sc_system_t;
187
188 /* subclass values of bc_input */
189 typedef enum sc_input {
190   sc_inp_keyb, sc_inp_digit, sc_inp_mouse, sc_inp_other = 0x80
191 } hd_sc_input_t;
192
193 /* subclass values of bc_serial */
194 typedef enum sc_serial {
195   sc_ser_fire, sc_ser_access, sc_ser_ssa, sc_ser_usb, sc_ser_fiber,
196   sc_ser_smbus, sc_ser_other = 0x80
197 } hd_sc_serial_t;
198
199 /* internal sub class values (bc_internal) */
200 typedef enum sc_internal {
201   sc_int_none, sc_int_isapnp_if, sc_int_main_mem, sc_int_cpu, sc_int_fpu,
202   sc_int_bios, sc_int_prom, sc_int_sys
203 } hd_sc_internal_t;
204
205 /* subclass values of bc_mouse */
206 typedef enum sc_mouse {
207   sc_mou_ps2, sc_mou_ser, sc_mou_bus, sc_mou_usb, sc_mou_sun,
208   sc_mou_other = 0x80
209 } hd_sc_mouse_t;
210
211 /* subclass values of bc_storage_device */
212 typedef enum sc_std {
213   sc_sdev_disk, sc_sdev_tape, sc_sdev_cdrom, sc_sdev_floppy, sc_sdev_scanner,
214   sc_sdev_other = 0x80
215 } hd_sc_std_t;
216
217 /* subclass values of bc_network_interface */
218 typedef enum sc_net_if {
219   sc_nif_loopback, sc_nif_ethernet, sc_nif_tokenring, sc_nif_fddi,
220   sc_nif_ctc, sc_nif_iucv, sc_nif_hsi, sc_nif_qeth,
221   sc_nif_escon, sc_nif_myrinet, sc_nif_wlan, sc_nif_other = 0x80, sc_nif_sit
222 } hd_sc_net_if_t;
223
224 /* subclass values of bc_multimedia */
225 typedef enum sc_multimedia {
226   sc_multi_video, sc_multi_audio, sc_multi_other
227 } hd_sc_multimedia_t;
228
229 /* subclass values of bc_keyboard */
230 typedef enum sc_keyboard {
231   sc_keyboard_kbd, sc_keyboard_console
232 } hd_sc_keyboard_t;
233
234 /* subclass values of bc_hub */
235 typedef enum sc_hub {
236   sc_hub_other, sc_hub_usb
237 } hd_sc_hub_t;
238
239 /* subclass values of bc_camera */
240 typedef enum sc_camera {
241   sc_camera_webcam, sc_camera_digital
242 } hd_sc_camera_t;
243
244 /* subclass values of bc_modem */
245 typedef enum sc_modem {
246   sc_mod_at, sc_mod_win1, sc_mod_win2, sc_mod_win3
247 } hd_sc_modem_t;
248
249 /* subclass values of bc_dsl */
250 typedef enum sc_dsl {
251   sc_dsl_unknown, sc_dsl_pppoe, sc_dsl_capi, sc_dsl_capiisdn
252 } hd_sc_dsl_t;
253
254 /* prog_if's of sc_ser_usb */
255 typedef enum pif_usb_e {
256   pif_usb_uhci = 0, pif_usb_ohci = 0x10, pif_usb_ehci = 0x20,
257   pif_usb_other = 0x80, pif_usb_device = 0xfe
258 } hd_pif_usb_t;
259
260 /* CD-ROM  prog_if values */
261 typedef enum pif_cdrom {
262   pif_cdrom, pif_cdr, pif_cdrw, pif_dvd, pif_dvdr, pif_dvdram
263 } hd_pif_cdrom_t ;
264
265 /* S/390 disk prog_if values */
266 typedef enum pif_s390disk {
267   pif_scsi, pif_dasd
268 } hd_pif_s390disk_t;
269
270 /* bus type values similar to PCI bridge subclasses */
271 typedef enum bus_types {
272   bus_none, bus_isa, bus_eisa, bus_mc, bus_pci, bus_pcmcia, bus_nubus,
273   bus_cardbus, bus_other,
274
275   /* outside the range of the PCI values */
276   bus_ps2 = 0x80, bus_serial, bus_parallel, bus_floppy, bus_scsi, bus_ide, bus_usb,
277   bus_adb, bus_raid, bus_sbus, bus_i2o, bus_vio
278 } hd_bus_types_t;
279
280 /**
281  * Hardware status.
282  * The status is stored in /var/lib/hardware/unique-keys/ and used
283  * to detect if the hardware is new and has to be configured by some
284  * hardware %config tool.
285  */
286 typedef struct {
287   /**
288    * Status fields are invalid.
289    */
290   unsigned invalid:1;
291   /**
292    * Hardware should be reconfigured.
293    * Either \ref hd_status_t::status_yes or \ref hd_status_t::status_no.
294    * A hardware must be reconfigured if it is in state
295    * \ref hd_status_t::available == \ref hd_status_t::status_no and
296    * \ref hd_status_t::needed == \ref hd_status_t::status_yes.
297    * In other words, if a hardware that was
298    * needed to run the system is gone.
299    */
300   unsigned reconfig:3;
301
302   /**
303    * Hardware %config status.
304    * Set to \ref hd_status_t::status_yes if the hardware has been configured, otherwise
305    * \ref hd_status_t::status_no.
306    */
307   unsigned configured:3;
308
309   /**
310    * Hardware availability.
311    * Set to \ref hd_status_t::status_yes if the hardware has been detected or
312    * \ref hd_status_t::status_no if the hardware has not been found. You can set
313    * it to \ref hd_status_t::status_unknown to indicate that this hardware cannot
314    * be automatically detected (say, ISA cards).
315    * \note You can simulate all kinds of hardware on your system by
316    * creating entries in /var/lib/hardware/unique-keys/ that have
317    * \ref hd_status_t::available set to \ref hd_status_t::status_unknown.
318    */
319   unsigned available:3;
320
321   /**
322    * Hardware is needed.
323    * Set to \ref hd_status_t::status_yes if this hardware is really necessary to run
324    * your computer. The effect will be that some hardware %config dialog
325    * is run if the hardware item is not found.
326    * Typical examples are graphics cards and mice.
327    */
328   unsigned needed:3;
329
330   /**
331    * (Internal) original value of \ref available;
332    * This is used to keep track of the original value of the \ref hd_status_t::available
333    * state as it was stored in /var/lib/hardware/unique-keys/. (\ref hd_status_t::available
334    * is automatically updated during the detection process.)
335    */
336   unsigned available_orig:3;
337
338   /**
339    * Hardware is active.
340    */
341   unsigned active:3;
342 } hd_status_t;
343
344 /* hardware config status values */
345 typedef enum {
346   status_no = 1, status_yes, status_unknown, status_new
347 } hd_status_value_t;
348
349 /**
350  * Various types of hotplug devices.
351  */
352 typedef enum {
353   hp_none,      /**< Not a hotpluggable %device. */
354   hp_pcmcia,    /**< PCMCIA %device. */
355   hp_cardbus,   /**< Cardbus %device. */
356   hp_pci,       /**< PCI hotplug %device. */
357   hp_usb,       /**< USB %device. */
358   hp_ieee1394   /**< IEEE 1394 (FireWire) %device */
359 } hd_hotplug_t;
360
361
362 /**
363  * Holds id/name pairs.
364  * Used for bus, class, vendor, %device and such.
365  */
366 typedef struct {
367   unsigned id;          /**< Numeric id. */
368   char *name;           /**< Name (if any) that corresponds to \ref hd_id_t::id. */
369 } hd_id_t;
370
371 /**
372  * String list type.
373  * Used whenever we create a list of strings (e.g. file read).
374  */
375 typedef struct s_str_list_t {
376   struct s_str_list_t *next;    /**< Link to next member. */
377   char *str;                    /**< Some string data. */
378 } str_list_t;
379
380
381 typedef struct {
382   unsigned char bitmap[16];     /* large enough for all uses */
383   unsigned bits;                /* real bitmap length in bits */
384   unsigned not_empty:1;         /* at least 1 bit is set */
385   str_list_t *str;              /* interpreted bitmask */
386 } hd_bitmap_t;
387
388
389 /*
390  * for memory areas
391  */
392 typedef struct {
393   unsigned start, size;         /* base address & size */
394   unsigned char *data;          /* actual data */
395 } memory_range_t;
396
397
398 /*
399  * smp info according to Intel smp spec (ia32)
400  */
401 typedef struct {
402   unsigned ok:1;                /* data are valid */
403   unsigned rev;                 /* MP spec revision */
404   unsigned mpfp;                /* MP Floating Pointer struct */
405   unsigned mpconfig_ok:1;       /* MP config table valid */
406   unsigned mpconfig;            /* MP config table */
407   unsigned mpconfig_size;       /* dto, size */
408   unsigned char feature[5];     /* MP feature info */
409   char oem_id[9];               /* oem id */
410   char prod_id[13];             /* product id */
411   unsigned cpus, cpus_en;       /* number of cpus & ennabled cpus */
412 } smp_info_t;
413
414
415 /*
416  * vesa bios extensions info
417  */
418 typedef struct vbe_mode_info_s {
419   unsigned number;              /* mode number */
420   unsigned attributes;          /* mode attributes */
421   unsigned width, height;       /* mode size */
422   unsigned bytes_p_line;        /* line length */
423   unsigned pixel_size;          /* bits per pixel */
424   unsigned fb_start;            /* frame buffer start address (if any) */
425   unsigned win_A_start;         /* window A start address */
426   unsigned win_A_attr;          /* window A attributes */
427   unsigned win_B_start;         /* window B start address */
428   unsigned win_B_attr;          /* window B attributes */
429   unsigned win_size;            /* window size in bytes */
430   unsigned win_gran;            /* window granularity in bytes */
431   unsigned pixel_clock;         /* maximum pixel clock */
432 } vbe_mode_info_t;
433
434
435 typedef struct {
436   unsigned ok:1;                /* data are valid */
437   unsigned version;             /* vbe version */
438   unsigned oem_version;         /* oem version info */
439   unsigned memory;              /* in bytes */
440   unsigned fb_start;            /* != 0 if framebuffer is supported */
441   char *oem_name;               /* oem name */
442   char *vendor_name;            /* vendor name */
443   char *product_name;           /* product name */
444   char *product_revision;       /* product revision */
445   unsigned modes;               /* number of supported video modes */
446   vbe_mode_info_t *mode;        /* video mode list */
447   unsigned current_mode;        /* current video mode */
448   unsigned char ddc[0x80];      /* ddc monitor info */
449 } vbe_info_t;
450
451
452 /*
453  * Compaq Controller Order EV (CQHORD) definition
454  */
455 typedef struct {
456     unsigned id;
457     unsigned char slot;
458     unsigned char bus;
459     unsigned char devfn;
460     unsigned char misc;
461 } cpq_ctlorder_t; 
462
463
464 typedef struct {
465   unsigned ok:1;                /* data are valid */
466   unsigned entry;               /* entry point */
467   unsigned compaq:1;            /* is compaq system */
468   cpq_ctlorder_t cpq_ctrl[32];  /* 32 == MAX_CONTROLLERS */
469 } bios32_info_t;
470
471
472 /*
473  * smbios entries
474  */
475 typedef enum {
476   sm_biosinfo, sm_sysinfo, sm_boardinfo, sm_chassis,
477   sm_processor, sm_memctrl, sm_memmodule, sm_cache,
478   sm_connect, sm_slot, sm_onboard, sm_oem,
479   sm_config, sm_lang, sm_group, sm_eventlog,
480   sm_memarray, sm_memdevice, sm_memerror, sm_memarraymap,
481   sm_memdevicemap, sm_mouse, sm_battery, sm_reset,
482   sm_secure, sm_power, sm_voltage, sm_cool,
483   sm_temperature, sm_current, sm_outofband, sm_bis,
484   sm_boot, sm_mem64error, sm_mandev, sm_mandevcomp,
485   sm_mdtd, sm_inactive = 126, sm_end = 127
486 } hd_smbios_type_t;
487
488
489 /* common part of all smbios_* types */
490 typedef struct {
491   union u_hd_smbios_t *next;    /* link to next entry */
492   hd_smbios_type_t type;        /* BIOS info type */
493   int data_len;                 /* formatted section length */
494   unsigned char *data;          /* formatted section */
495   str_list_t *strings;          /* strings taken from the unformed section */
496   int handle;                   /* handle, unique 16 bit number */
497 } smbios_any_t;
498
499
500 /* BIOS related information */
501 typedef struct {
502   union u_hd_smbios_t *next;
503   hd_smbios_type_t type;
504   int data_len;
505   unsigned char *data;
506   str_list_t *strings;
507   int handle;
508   char *vendor;                 /* vendor name */
509   char *version;                /* version (free form) */
510   char *date;                   /* date mm/dd/yyyy (old: yy) */
511   hd_bitmap_t feature;          /* BIOS characteristics */
512   unsigned start;               /* start address */
513   unsigned rom_size;            /* ROM size (in bytes) */
514 } smbios_biosinfo_t;
515
516
517 /* overall system related information */
518 typedef struct {
519   union u_hd_smbios_t *next;
520   hd_smbios_type_t type;
521   int data_len;
522   unsigned char *data;
523   str_list_t *strings;
524   int handle;
525   char *manuf;                  /* manufacturer */
526   char *product;                /* product name */
527   char *version;                /* version */
528   char *serial;                 /* serial number */
529   unsigned char uuid[16];       /* universal unique id; all 0x00: undef, all 0xff: undef but settable */
530   hd_id_t wake_up;              /* wake-up type */
531 } smbios_sysinfo_t;
532
533
534 /* motherboard related information */
535 typedef struct {
536   union u_hd_smbios_t *next;
537   hd_smbios_type_t type;
538   int data_len;
539   unsigned char *data;
540   str_list_t *strings;
541   int handle;
542   char *manuf;                  /* manufacturer */
543   char *product;                /* product name */
544   char *version;                /* version */
545   char *serial;                 /* serial number */
546   char *asset;                  /* asset tag */
547   hd_id_t board_type;           /* board type */
548   hd_bitmap_t feature;          /* board features */
549   char *location;               /* location in chassis */
550   int chassis;                  /* handle of chassis */
551   int objects_len;              /* number of contained objects */
552   int *objects;                 /* array of object handles */
553 } smbios_boardinfo_t;
554
555
556 /* chassis information */
557 typedef struct {
558   union u_hd_smbios_t *next;
559   hd_smbios_type_t type;
560   int data_len;
561   unsigned char *data;
562   str_list_t *strings;
563   int handle;
564   char *manuf;                  /* manufacturer */
565   char *version;                /* version */
566   char *serial;                 /* serial number */
567   char *asset;                  /* asset tag */
568   hd_id_t ch_type;              /* chassis type */
569   unsigned lock;                /* 1: lock present, 0: not present or unknown */
570   hd_id_t bootup;               /* bootup state */
571   hd_id_t power;                /* power supply state (at last boot) */
572   hd_id_t thermal;              /* thermal state (at last boot) */
573   hd_id_t security;             /* security state (at last boot) */
574   unsigned oem;                 /* OEM-specific information */
575 } smbios_chassis_t;
576
577
578 /* processor information */
579 typedef struct {
580   union u_hd_smbios_t *next;
581   hd_smbios_type_t type;
582   int data_len;
583   unsigned char *data;
584   str_list_t *strings;
585   int handle;
586   char *socket;                 /* socket */
587   hd_id_t upgrade;              /* socket type */
588   char *manuf;                  /* manufacturer */
589   char *version;                /* version */
590   char *serial;                 /* serial number */
591   char *asset;                  /* asset tag */
592   char *part;                   /* part number */
593   hd_id_t pr_type;              /* processor type */
594   hd_id_t family;               /* processor family */
595   uint64_t cpu_id;              /* processor id */
596   unsigned voltage;             /* in 0.1 V */
597   unsigned ext_clock;           /* MHz */
598   unsigned max_speed;           /* MHz */
599   unsigned current_speed;       /* MHz */
600   unsigned sock_status;         /* socket status (1: populated, 0: empty */
601   hd_id_t cpu_status;           /* cpu status */
602   int l1_cache;                 /* handle of L1 cache */
603   int l2_cache;                 /* handle of L2 cache */
604   int l3_cache;                 /* handle of L3 cache */
605 } smbios_processor_t;
606
607
608 /* cache information */
609 typedef struct {
610   union u_hd_smbios_t *next;
611   hd_smbios_type_t type;
612   int data_len;
613   unsigned char *data;
614   str_list_t *strings;
615   int handle;
616   char *socket;                 /* socket designation */
617   unsigned max_size;            /* max cache size in kbytes */
618   unsigned current_size;        /* current size in kbytes */
619   unsigned speed;               /* cache speed in nanoseconds */
620   hd_id_t mode;                 /* operational mode */
621   unsigned state;               /* 0/1: disabled/enabled */
622   hd_id_t location;             /* cache location */
623   unsigned socketed;            /* 0/1: not socketed/socketed */
624   unsigned level;               /* cache level (0 = L1, 1 = L2, ...) */
625   hd_id_t ecc;                  /* error correction type */
626   hd_id_t cache_type;           /* logical cache type */
627   hd_id_t assoc;                /* cache associativity */
628   hd_bitmap_t supp_sram;        /* supported SRAM types */
629   hd_bitmap_t sram;             /* current SRAM type */
630 } smbios_cache_t;
631
632
633 /* port connector information */
634 typedef struct {
635   union u_hd_smbios_t *next;
636   hd_smbios_type_t type;
637   int data_len;
638   unsigned char *data;
639   str_list_t *strings;
640   int handle;
641   hd_id_t port_type;            /* port type */
642   char *i_des;                  /* internal reference designator */
643   hd_id_t i_type;               /* internal connector type */
644   char *x_des;                  /* external reference designator */
645   hd_id_t x_type;               /* external connector type */
646 } smbios_connect_t;
647
648
649 /* system slot information */
650 typedef struct {
651   union u_hd_smbios_t *next;
652   hd_smbios_type_t type;
653   int data_len;
654   unsigned char *data;
655   str_list_t *strings;
656   int handle;
657   char *desig;                  /* slot designation */
658   hd_id_t slot_type;            /* slot type */
659   hd_id_t bus_width;            /* data bus width */
660   hd_id_t usage;                /* current usage */
661   hd_id_t length;               /* slot length */
662   unsigned id;                  /* slot id */
663   hd_bitmap_t feature;          /* slot characteristics */
664 } smbios_slot_t;
665
666
667 /* on board devices information */
668 typedef struct {
669   union u_hd_smbios_t *next;
670   hd_smbios_type_t type;
671   int data_len;
672   unsigned char *data;
673   str_list_t *strings;
674   int handle;
675   unsigned dev_len;             /* device list length */
676   struct {
677     char *name;                 /* device name */
678     hd_id_t type;               /* device type */
679     unsigned status;            /* 0: disabled, 1: enabled */
680   } *dev;                       /* device list  */
681 } smbios_onboard_t;
682
683
684 /* OEM information */
685 typedef struct {
686   union u_hd_smbios_t *next;
687   hd_smbios_type_t type;
688   int data_len;
689   unsigned char *data;
690   str_list_t *strings;
691   int handle;
692   str_list_t *oem_strings;      /* OEM strings */
693 } smbios_oem_t;
694
695
696 /* system config options */
697 typedef struct {
698   union u_hd_smbios_t *next;
699   hd_smbios_type_t type;
700   int data_len;
701   unsigned char *data;
702   str_list_t *strings;
703   int handle;
704   str_list_t *options;          /* system config options */
705 } smbios_config_t;
706
707
708 /* language information */
709 typedef struct {
710   union u_hd_smbios_t *next;
711   hd_smbios_type_t type;
712   int data_len;
713   unsigned char *data;
714   str_list_t *strings;          /* list of languages */
715   int handle;
716   char *current;                /* current language */
717 } smbios_lang_t;
718
719
720 /* group associations */
721 typedef struct {
722   union u_hd_smbios_t *next;
723   hd_smbios_type_t type;
724   int data_len;
725   unsigned char *data;
726   str_list_t *strings;
727   int handle;
728   char *name;                   /* group name */
729   int items_len;                /* number of items in this group */
730   int *item_handles;            /* array of item handles */
731 } smbios_group_t;
732
733
734 /* physical memory array (consists of several memory devices) */
735 typedef struct {
736   union u_hd_smbios_t *next;
737   hd_smbios_type_t type;
738   int data_len;
739   unsigned char *data;
740   str_list_t *strings;
741   int handle;
742   hd_id_t location;             /* memory device location */
743   hd_id_t use;                  /* memory usage */
744   hd_id_t ecc;                  /* ECC types */
745   unsigned max_size;            /* maximum memory size in kB */
746   int error_handle;             /* points to error info record; 0xfffe: not supported, 0xffff: no error */
747   unsigned slots;               /* slots or sockets for this device */
748 } smbios_memarray_t;
749
750
751 /* memory device */
752 typedef struct {
753   union u_hd_smbios_t *next;
754   hd_smbios_type_t type;
755   int data_len;
756   unsigned char *data;
757   str_list_t *strings;
758   int handle;
759   char *location;               /* device location */
760   char *bank;                   /* bank location */
761   char *manuf;                  /* manufacturer */
762   char *serial;                 /* serial number */
763   char *asset;                  /* asset tag */
764   char *part;                   /* part number */
765   int array_handle;             /* memory array this device belongs to */
766   int error_handle;             /* points to error info record; 0xfffe: not supported, 0xffff: no error */
767   unsigned width;               /* data width in bits */
768   unsigned eccbits;             /* ecc bits */
769   unsigned size;                /* kB */
770   hd_id_t form;                 /* form factor */
771   unsigned set;                 /* 0: does not belong to a set; 1-0xfe: set number; 0xff: unknown */
772   hd_id_t mem_type;             /* memory type */
773   hd_bitmap_t type_detail;      /* memory type details */
774   unsigned speed;               /* in MHz */
775 } smbios_memdevice_t;
776
777
778 /* 32-bit memory error information  */
779 typedef struct {
780   union u_hd_smbios_t *next;
781   hd_smbios_type_t type;
782   int data_len;
783   unsigned char *data;
784   str_list_t *strings;
785   int handle;
786   hd_id_t err_type;             /* error type memory */
787   hd_id_t granularity;          /* memory array or memory partition */
788   hd_id_t operation;            /* mem operation causing the error */
789   unsigned syndrome;            /* vendor-specific ECC syndrome; 0: unknown */
790   unsigned array_addr;          /* fault address rel. to mem array; 0x80000000: unknown */
791   unsigned device_addr;         /* fault address rel to mem device; 0x80000000: unknown */
792   unsigned range;               /* range, within which the error can be determined; 0x80000000: unknown */
793 } smbios_memerror_t;
794
795
796 /* memory array mapped address */
797 typedef struct {
798   union u_hd_smbios_t *next;
799   hd_smbios_type_t type;
800   int data_len;
801   unsigned char *data;
802   str_list_t *strings;
803   int handle;
804   int array_handle;             /* memory array this mapping belongs to */
805   uint64_t start_addr;          /* memory range start address */
806   uint64_t end_addr;            /* end address */
807   unsigned part_width;          /* number of memory devices */
808 } smbios_memarraymap_t;
809
810
811 /* memory device mapped address */
812 typedef struct {
813   union u_hd_smbios_t *next;
814   hd_smbios_type_t type;
815   int data_len;
816   unsigned char *data;
817   str_list_t *strings;
818   int handle;
819   int memdevice_handle;         /* memory device handle */
820   int arraymap_handle;          /* memory array mapping handle */
821   uint64_t start_addr;          /* memory range start address */
822   uint64_t end_addr;            /* end address */
823   unsigned row_pos;             /* position of the referenced memory device in a row of the address partition */
824   unsigned interleave_pos;      /* dto, in an interleave */
825   unsigned interleave_depth;    /* number of consecutive rows */
826 } smbios_memdevicemap_t;
827
828
829 /* pointing device (aka 'mouse') information */
830 typedef struct {
831   union u_hd_smbios_t *next;
832   hd_smbios_type_t type;
833   int data_len;
834   unsigned char *data;
835   str_list_t *strings;
836   int handle;
837   hd_id_t mtype;                /* mouse type */
838   hd_id_t interface;            /* interface type */
839   unsigned buttons;             /* number of buttons */
840 } smbios_mouse_t;
841
842
843 /* hardware security */
844 typedef struct {
845   union u_hd_smbios_t *next;
846   hd_smbios_type_t type;
847   int data_len;
848   unsigned char *data;
849   str_list_t *strings;
850   int handle;
851   hd_id_t power;                /* power-on password status */
852   hd_id_t keyboard;             /* keyboard password status */
853   hd_id_t admin;                /* admin password status */
854   hd_id_t reset;                /* front panel reset status */
855 } smbios_secure_t;
856
857
858 /* system power controls */
859 typedef struct {
860   union u_hd_smbios_t *next;
861   hd_smbios_type_t type;
862   int data_len;
863   unsigned char *data;
864   str_list_t *strings;
865   int handle;
866   unsigned month;               /* next scheduled power-on month */
867   unsigned day;                 /* dto, day */
868   unsigned hour;                /* dto, hour */
869   unsigned minute;              /* dto, minute */
870   unsigned second;              /* dto, second */
871 } smbios_power_t;
872
873
874 /* 64-bit memory error information  */
875 typedef struct {
876   union u_hd_smbios_t *next;
877   hd_smbios_type_t type;
878   int data_len;
879   unsigned char *data;
880   str_list_t *strings;
881   int handle;
882   hd_id_t err_type;             /* error type memory */
883   hd_id_t granularity;          /* memory array or memory partition */
884   hd_id_t operation;            /* mem operation causing the error */
885   unsigned syndrome;            /* vendor-specific ECC syndrome; 0: unknown */
886   uint64_t array_addr;          /* fault address rel. to mem array; 0x80000000: unknown */
887   uint64_t device_addr;         /* fault address rel to mem device; 0x80000000: unknown */
888   unsigned range;               /* range, within which the error can be determined; 0x80000000: unknown */
889 } smbios_mem64error_t;
890
891
892 typedef union u_hd_smbios_t {
893   union u_hd_smbios_t *next;  
894   smbios_any_t any;
895   smbios_biosinfo_t biosinfo;
896   smbios_sysinfo_t sysinfo;
897   smbios_boardinfo_t boardinfo;
898   smbios_chassis_t chassis;
899   smbios_processor_t processor;
900   smbios_cache_t cache;
901   smbios_connect_t connect;
902   smbios_slot_t slot;
903   smbios_onboard_t onboard;
904   smbios_oem_t oem;
905   smbios_config_t config;
906   smbios_lang_t lang;
907   smbios_group_t group;
908   smbios_memarray_t memarray;
909   smbios_memdevice_t memdevice;
910   smbios_memerror_t memerror;
911   smbios_memarraymap_t memarraymap;
912   smbios_memdevicemap_t memdevicemap;
913   smbios_mouse_t mouse;
914   smbios_secure_t secure;
915   smbios_power_t power;
916   smbios_mem64error_t mem64error;
917 } hd_smbios_t;
918
919
920 /*
921  * udev database info
922  */
923 typedef struct s_udevinfo_t {
924   struct s_udevinfo_t *next;
925   char *sysfs;
926   char *name;
927   str_list_t *links;
928 } hd_udevinfo_t;
929
930
931 /*
932  * device number; type is either 0 or 'b' or 'c'.
933  *
934  * range: number of nodes
935  */
936 typedef struct {
937   int type;
938   unsigned major, minor, range;
939 } hd_dev_num_t;
940
941
942 /*
943  * structure holding the (raw) PCI data
944  */
945 typedef struct s_pci_t {
946   struct s_pci_t *next;                         /* linked list */
947   unsigned data_len;                            /* the actual length of the data field */
948   unsigned data_ext_len;                        /* max. accessed config byte; see code */
949   unsigned char data[256];                      /* the PCI data */
950   char *log;                                    /* log messages */
951   unsigned flags,                               /* various info, see enum pci_flags */
952            cmd,                                 /* PCI_COMMAND */
953            hdr_type,                            /* PCI_HEADER_TYPE */
954            secondary_bus;                       /* > 0 for PCI & CB bridges */
955   unsigned bus,                                 /* PCI bus #, *nothing* to do with hw_t.bus */
956            slot, func;                          /* slot & function */
957   unsigned base_class, sub_class, prog_if;      /* PCI device classes */
958   unsigned dev, vend, sub_dev, sub_vend, rev;   /* vendor & device ids */
959   unsigned irq;                                 /* used irq, if any */
960   uint64_t base_addr[7];                        /* I/O or memory base */
961   uint64_t base_len[7];                         /* I/O or memory ranges */
962   unsigned addr_flags[7];                       /* I/O or memory address flags */
963   uint64_t rom_base_addr;                       /* memory base for card ROM */
964   uint64_t rom_base_len;                        /* memory range for card ROM */
965   char *sysfs_id;                               /* sysfs path */
966   char *sysfs_bus_id;                           /* sysfs bus id */
967 } pci_t;
968
969 /*
970  * pci related flags cf. (pci_t).flags
971  */
972 typedef enum pci_flags {
973   pci_flag_ok, pci_flag_pm, pci_flag_agp
974 } hd_pci_flags_t;
975
976
977 /*
978  * raw USB data
979  */
980 typedef struct usb_s {
981   struct usb_s *next;
982   unsigned hd_idx;
983   unsigned hd_base_idx;
984   /* see Linux USB docs */
985   str_list_t *c, *d, *e, *i, *p, *s, *t;
986   struct usb_s *cloned;
987   int bus, dev_nr, lev, parent, port, count, conns, used_conns, ifdescr;
988   unsigned speed;
989   unsigned vendor, device, rev;
990   char *manufact, *product, *serial;
991   char *driver;
992   memory_range_t raw_descr;
993   int d_cls, d_sub, d_prot;
994   int i_alt, i_cls, i_sub, i_prot;
995   unsigned country;
996 } usb_t;
997
998 /*
999  *structures to hold the (raw) ISA-PnP data
1000  */
1001 typedef struct {
1002   int len;
1003   int type;
1004   unsigned char *data;
1005 } isapnp_res_t;
1006
1007 typedef struct {
1008   int csn;
1009   int log_devs;
1010   unsigned char *serial;
1011   unsigned char *card_regs;
1012   unsigned char (*ldev_regs)[0xd0];
1013   int res_len;
1014   unsigned broken:1;            /* mark a broken card */
1015   isapnp_res_t *res;
1016 } isapnp_card_t;
1017
1018 typedef struct {
1019   int read_port;
1020   int cards;
1021   isapnp_card_t *card;
1022 } isapnp_t;
1023
1024 typedef struct {
1025   isapnp_card_t *card;
1026   int dev;
1027   unsigned flags;                               /* cf. enum isapnp_flags */
1028   unsigned ref:1;                               /* internally used flag */
1029 } isapnp_dev_t;
1030
1031 /*
1032  * ISA-PnP related flags; cf. (isapnp_dev_t).flags
1033  */
1034 typedef enum isapnp_flags {
1035   isapnp_flag_act
1036 } hd_isapnp_flags_t;
1037
1038
1039 /*
1040  * raw SCSI data
1041  */
1042 typedef struct scsi_s {
1043   struct scsi_s *next;
1044   unsigned deleted:1;
1045   unsigned generic:1;
1046   unsigned fake:1;
1047   char *dev_name;
1048   char *guessed_dev_name;
1049   int generic_dev;
1050   unsigned host, channel, id, lun;
1051   char *vendor, *model, *rev, *type_str, *serial;
1052   int type;
1053   unsigned inode_low;
1054   char *proc_dir, *driver;
1055   unsigned unique;
1056   char *info;
1057   unsigned lgeo_c, lgeo_h, lgeo_s;
1058   unsigned pgeo_c, pgeo_h, pgeo_s;
1059   uint64_t size;
1060   unsigned sec_size;
1061   unsigned cache;
1062   str_list_t *host_info;
1063   char *usb_guid;
1064   unsigned pci_info;
1065   unsigned pci_bus;
1066   unsigned pci_slot;
1067   unsigned pci_func;
1068 #if defined(__s390__) || defined(__s390x__)
1069   uint64_t wwpn;
1070   uint64_t fcp_lun;
1071   char *controller_id;
1072 #endif
1073 } scsi_t;
1074
1075
1076 /*
1077  * PROM tree on PPC
1078  */
1079 typedef struct devtree_s {
1080   struct devtree_s *next;
1081   struct devtree_s *parent;
1082   unsigned idx;
1083   char *path, *filename;
1084   unsigned pci:1;
1085   char *name, *model, *device_type, *compatible;
1086   int class_code;                       /* class : sub_class : prog-if */
1087   int vendor_id, device_id, subvendor_id, subdevice_id;
1088   int revision_id, interrupt;
1089   unsigned char *edid;                  /* 128 bytes */
1090 } devtree_t;
1091
1092 /*
1093  * Device/CU model numbers for S/390
1094  */
1095 typedef struct ccw_s {
1096   unsigned char lcss;
1097   unsigned char cu_model;
1098   unsigned char dev_model;
1099 } ccw_t;
1100
1101 /*
1102  * special CDROM entry
1103  */
1104 typedef struct cdrom_info_s {
1105   struct cdrom_info_s *next;
1106   char *name;
1107   unsigned speed;
1108   unsigned cdr:1, cdrw:1, dvd:1, dvdr:1, dvdram:1;
1109   unsigned cdrom:1;             /* cdrom in drive */
1110   struct {
1111     unsigned ok:1;
1112     char *volume, *publisher, *preparer, *application, *creation_date;
1113   } iso9660;
1114   struct {
1115     unsigned ok:1;
1116     unsigned platform;
1117     char *id_string;
1118     unsigned bootable:1;
1119     unsigned media_type;        /* boot emulation type */
1120     unsigned load_address;
1121     unsigned load_count;        /* sectors to load */
1122     unsigned start;             /* start sector */
1123     unsigned catalog;           /* boot catalog start */
1124     struct {
1125       unsigned c, h, s;
1126       unsigned size;
1127     } geo;
1128     char *label;
1129   } el_torito;
1130
1131 } cdrom_info_t;
1132
1133 // note: obsolete, will be removed
1134 typedef struct {
1135   unsigned char block0[512];
1136 } floppy_info_t;
1137
1138 /*
1139  * bios data (ix86)
1140  */
1141 typedef struct {
1142   unsigned apm_supported:1;
1143   unsigned apm_enabled:1;
1144   unsigned apm_ver, apm_subver;
1145   unsigned apm_bios_flags;
1146
1147   unsigned vbe_ver;
1148   unsigned vbe_video_mem;
1149
1150   unsigned ser_port0, ser_port1, ser_port2, ser_port3;
1151   unsigned par_port0, par_port1, par_port2;
1152
1153   /* The id is still in big endian format! */
1154   unsigned is_pnp_bios:1;
1155   unsigned pnp_id;
1156   unsigned lba_support:1;
1157
1158   unsigned low_mem_size;
1159   smp_info_t smp;
1160   vbe_info_t vbe;
1161
1162   unsigned smbios_ver;
1163
1164   struct {
1165     unsigned width;
1166     unsigned height;
1167     char *vendor;
1168     char *name;
1169   } lcd;
1170
1171   struct {
1172     char *vendor;
1173     char *type;
1174     unsigned bus;
1175     unsigned compat_vend;
1176     unsigned compat_dev;
1177   } mouse;
1178
1179   struct {
1180     unsigned ok:1;
1181     unsigned scroll_lock:1;
1182     unsigned num_lock:1;
1183     unsigned caps_lock:1;
1184   } led;
1185
1186   bios32_info_t bios32;
1187
1188 } bios_info_t;
1189
1190
1191 /*
1192  * prom data (ppc, sparc)
1193  */
1194 typedef struct {
1195   unsigned has_color:1;
1196   unsigned color;
1197 } prom_info_t;
1198
1199
1200 /*
1201  * general system data
1202  */
1203 typedef struct {
1204   char *system_type;
1205   char *generation;
1206   char *vendor;
1207   char *model;
1208   char *serial;
1209   char *lang;
1210 } sys_info_t;
1211
1212
1213 /*
1214  * monitor (DDC) data
1215  */
1216 typedef struct {
1217   unsigned manu_year;
1218   unsigned min_vsync, max_vsync;        /* vsync range */
1219   unsigned min_hsync, max_hsync;        /* hsync range */
1220   char *vendor;
1221   char *name;
1222   char *serial;
1223 } monitor_info_t;
1224
1225
1226 typedef enum cpu_arch {
1227   arch_unknown = 0,
1228   arch_intel,
1229   arch_alpha,
1230   arch_sparc, arch_sparc64,
1231   arch_ppc, arch_ppc64,
1232   arch_68k,
1233   arch_ia64,
1234   arch_s390, arch_s390x,
1235   arch_arm,
1236   arch_mips,
1237   arch_x86_64
1238 } hd_cpu_arch_t;
1239
1240 // ###### drop boot_arch at all?
1241 typedef enum boot_arch {
1242   boot_unknown = 0,
1243   boot_lilo, boot_milo, boot_aboot, boot_silo, boot_ppc, boot_elilo, boot_s390,
1244   boot_mips, boot_grub
1245 } hd_boot_arch_t;
1246
1247 /* special cpu entry */
1248 typedef struct {
1249   enum cpu_arch architecture;
1250   unsigned family;              /* axp: cpu variation */
1251   unsigned model;               /* axp: cpu revision */
1252   unsigned stepping;
1253   unsigned cache;
1254   unsigned clock;
1255   unsigned units;               /* >1 "hyperthreading" */
1256   char *vend_name;              /* axp: system type */
1257   char *model_name;             /* axp: cpu model */
1258   char *platform;               /* x86: NULL */
1259   str_list_t *features;         /* x86: flags */
1260 } cpu_info_t;
1261
1262
1263 /*
1264  * database info
1265  */
1266 typedef struct {
1267   unsigned data_len, data_max;
1268   unsigned *data;
1269   unsigned names_len, names_max;
1270   char *names;
1271 } hddb_data_t;
1272
1273 typedef uint32_t hddb_entry_mask_t;
1274
1275 typedef struct hddb_list_s {   
1276   hddb_entry_mask_t key_mask;
1277   hddb_entry_mask_t value_mask;
1278   unsigned key;
1279   unsigned value;
1280 } hddb_list_t;
1281
1282 typedef struct {
1283   unsigned list_len, list_max;
1284   hddb_list_t *list;
1285   unsigned ids_len, ids_max;
1286   unsigned *ids;
1287   unsigned strings_len, strings_max;
1288   char *strings;
1289 } hddb2_data_t;
1290
1291 /*
1292  * pci module info
1293  */
1294 typedef struct {
1295   char *module;
1296   unsigned vendor;
1297   unsigned device;
1298   unsigned subvendor;
1299   unsigned subdevice;
1300   unsigned pciclass;
1301   unsigned classmask;
1302 } hddb_pci_t;
1303
1304
1305 /*
1306  * resource types
1307  */
1308 typedef enum resource_types {
1309   res_any, res_phys_mem, res_mem, res_io, res_irq, res_dma, res_monitor,
1310   res_size, res_disk_geo, res_cache, res_baud, res_init_strings, res_pppd_option,
1311   res_framebuffer, res_hwaddr
1312 } hd_resource_types_t;
1313
1314
1315 /*
1316  * size units (cf. (res_size_t).unit)
1317  */
1318 typedef enum size_units {
1319   size_unit_cm, size_unit_cinch, size_unit_byte, size_unit_sectors,
1320   size_unit_kbyte, size_unit_mbyte, size_unit_gbyte
1321 } hd_size_units_t;
1322
1323 /*
1324  * access types for I/O and memory resources
1325  */
1326 typedef enum access_flags {
1327   acc_unknown, acc_ro, acc_wo, acc_rw           /* unknown, read only, write only, read/write */
1328 } hd_access_flags_t;
1329
1330 typedef enum yes_no_flag {
1331   flag_unknown, flag_no, flag_yes               /* unknown, no, yes */
1332 } hd_yes_no_flag_t;
1333
1334
1335 /*
1336  * definitions for the various resource types
1337  */
1338 typedef struct {
1339   union u_hd_res_t *next;
1340   enum resource_types type;
1341 } res_any_t;
1342
1343 typedef struct {
1344   union u_hd_res_t *next;
1345   enum resource_types type;
1346   uint64_t base, range;
1347   unsigned
1348     enabled:1,                          /* 0: disabled, 1 enabled */
1349     access:2,                           /* enum access_flags */
1350     prefetch:2;                         /* enum yes_no_flag */
1351 } res_mem_t;
1352
1353 typedef struct {
1354   union u_hd_res_t *next;
1355   enum resource_types type;
1356   uint64_t range;
1357 } res_phys_mem_t;
1358
1359 typedef struct {
1360   union u_hd_res_t *next;
1361   enum resource_types type;
1362   uint64_t base, range;
1363   unsigned
1364     enabled:1,                          /* 0: disabled, 1 enabled */
1365     access:2;                           /* enum access_flags */
1366 } res_io_t;
1367
1368 typedef struct {
1369   union u_hd_res_t *next;
1370   enum resource_types type;
1371   unsigned base;
1372   unsigned triggered;                   /* # of interrupts */
1373   unsigned enabled:1;                   /* 0: disabled, 1 enabled */
1374 } res_irq_t;
1375
1376 typedef struct {
1377   union u_hd_res_t *next;
1378   enum resource_types type;
1379   unsigned base;
1380   unsigned enabled:1;                   /* 0: disabled, 1 enabled */
1381 } res_dma_t;
1382
1383 typedef struct {
1384   union u_hd_res_t *next;
1385   enum resource_types type;
1386   enum size_units unit;
1387   uint64_t val1, val2;                  /* to allow for 2D values */
1388 } res_size_t;
1389
1390 typedef struct {
1391   union u_hd_res_t *next;
1392   enum resource_types type;
1393   unsigned speed;
1394   unsigned bits, stopbits;
1395   char parity;                          /* n, e, o, s, m */
1396   char handshake;                       /* -, h, s */
1397 } res_baud_t;
1398
1399 typedef struct {
1400   union u_hd_res_t *next;
1401   enum resource_types type;
1402   unsigned size;                        /* in kbyte */
1403 } res_cache_t;
1404
1405 typedef struct {
1406   union u_hd_res_t *next;
1407   enum resource_types type;
1408   unsigned cyls, heads, sectors;
1409   unsigned logical:1;                   /* logical/physical geometry */
1410 } res_disk_geo_t;
1411
1412 typedef struct {
1413   union u_hd_res_t *next;
1414   enum resource_types type;
1415   unsigned width, height;               /* in pixel */
1416   unsigned vfreq;                       /* in Hz */
1417   unsigned interlaced:1;                /* 0/1 */
1418 } res_monitor_t;
1419
1420 typedef struct {
1421   union u_hd_res_t *next;
1422   enum resource_types type;
1423   char *init1;
1424   char *init2;
1425 } res_init_strings_t;
1426
1427 typedef struct {
1428   union u_hd_res_t *next;
1429   enum resource_types type;
1430   char *option;
1431 } res_pppd_option_t;
1432
1433 typedef struct {
1434   union u_hd_res_t *next;
1435   enum resource_types type;
1436   unsigned width, height;               /* in pixel */
1437   unsigned bytes_p_line;                /* line length in bytes (do not confuse with 'width') */
1438   unsigned colorbits;                   /* 4, 8, 15, 16, 24, 32 */
1439   unsigned mode;                        /* mode number for kernel */
1440 } res_framebuffer_t;
1441
1442 typedef struct {
1443   union u_hd_res_t *next;
1444   enum resource_types type;
1445   char *addr;
1446 } res_hwaddr_t;
1447
1448 typedef union u_hd_res_t {
1449   union u_hd_res_t *next;  
1450   res_any_t any;
1451   res_io_t io;
1452   res_mem_t mem;
1453   res_phys_mem_t phys_mem;
1454   res_irq_t irq;
1455   res_dma_t dma;
1456   res_size_t size;
1457   res_cache_t cache;
1458   res_baud_t baud;
1459   res_disk_geo_t disk_geo;
1460   res_monitor_t monitor;
1461   res_init_strings_t init_strings;
1462   res_pppd_option_t pppd_option;
1463   res_framebuffer_t framebuffer;
1464   res_hwaddr_t hwaddr;
1465 } hd_res_t;
1466
1467
1468 /*
1469  * data gathered by the misc module; basically resources from /proc
1470  */
1471 typedef struct {
1472   uint64_t addr, size;
1473   char *dev;
1474   unsigned tag;
1475 } misc_io_t;
1476
1477 typedef struct {
1478   unsigned channel;
1479   char *dev;
1480   unsigned tag;
1481 } misc_dma_t;
1482
1483 typedef struct {
1484   unsigned irq, events;
1485   int devs;
1486   char **dev;
1487   unsigned tag;
1488 } misc_irq_t;
1489
1490 typedef struct {
1491   unsigned io_len, dma_len, irq_len;
1492   misc_io_t *io;
1493   misc_dma_t *dma;
1494   misc_irq_t *irq;
1495   str_list_t *proc_io, *proc_dma, *proc_irq;
1496 } misc_t;
1497
1498 typedef struct s_serial_t {
1499   struct s_serial_t *next;
1500   char *name;
1501   char *device;
1502   unsigned line, port, irq, baud;
1503 } serial_t;
1504
1505 typedef struct s_ser_device_t {
1506   struct s_ser_device_t *next;
1507   unsigned hd_idx;
1508   char *dev_name;
1509   str_list_t *at_resp;
1510   int fd;
1511   struct termios tio;
1512   unsigned max_baud, cur_baud;
1513   unsigned is_mouse:1;
1514   unsigned is_modem:1;
1515   unsigned do_io:1;
1516   unsigned char buf[0x1000];
1517   int buf_len;
1518   int garbage, non_pnp, pnp;
1519   unsigned char pnp_id[8];
1520   char *serial, *class_name, *dev_id, *user_name, *vend, *init_string1, *init_string2, *pppd_option;
1521   unsigned pnp_rev;
1522   unsigned bits;
1523 } ser_device_t;
1524
1525 /*
1526  * Notes on isdn_parm_t:
1527  *   - def_value is only relevant of alt_values != 0
1528  *   - def_value should be a value out of alt_value[]
1529  *   - see libihw docu for the meaning of name,type,flags,def_value
1530  */
1531 typedef struct isdn_parm_s {
1532   struct isdn_parm_s *next;
1533   char *name;                           /* parameter name */
1534   unsigned valid:1;                     /* 1: entry is valid, 0: some inconsistencies */
1535   unsigned conflict:1;                  /* 1: ressource conflict (eg. no free irq) */
1536   uint64_t value;                       /* value of the parameter */
1537   unsigned type;                        /* CDBISDN type (P_...) */
1538   unsigned flags;                       /* CDBISDN flags (P_...) */
1539   unsigned def_value;                   /* default value */
1540   int alt_values;                       /* length of alt_value[] */
1541   unsigned *alt_value;                  /* possible values */
1542 } isdn_parm_t;
1543
1544 /* device driver info types */
1545 typedef enum driver_info_type {
1546   di_any, di_display, di_module, di_mouse, di_x11, di_isdn, di_kbd, di_dsl
1547 } hd_driver_info_t;
1548
1549 /* unspecific info */
1550 typedef struct {
1551   union driver_info_u *next;
1552   enum driver_info_type type;           /* driver info type */
1553   str_list_t *hddb0, *hddb1;            /* the actual driver database entries */
1554 } driver_info_any_t;
1555
1556 /* display (monitor) info */
1557 typedef struct {
1558   union driver_info_u *next;
1559   enum driver_info_type type;           /* driver info type */
1560   str_list_t *hddb0, *hddb1;            /* the actual driver database entries */
1561   unsigned width, height;               /* max. useful display geometry */
1562   unsigned min_vsync, max_vsync;        /* vsync range */
1563   unsigned min_hsync, max_hsync;        /* hsync range */
1564   unsigned bandwidth;                   /* max. pixel clock */
1565 } driver_info_display_t;
1566
1567 /* module info */
1568 typedef struct {
1569   union driver_info_u *next;
1570   enum driver_info_type type;           /* driver info type */
1571   str_list_t *hddb0, *hddb1;            /* the actual driver database entries */
1572   unsigned active:1;                    /* if module is currently active */
1573   unsigned modprobe:1;                  /* modprobe or insmod  */
1574   str_list_t *names;                    /* (ordered) list of module names */
1575   str_list_t *mod_args;                 /* list of module args (corresponds to the module name list) */
1576   char *conf;                           /* conf.modules entry, if any (e.g. for sb.o) */
1577 } driver_info_module_t;
1578
1579 /* mouse protocol info */
1580 typedef struct {
1581   union driver_info_u *next;
1582   enum driver_info_type type;           /* driver info type */
1583   str_list_t *hddb0, *hddb1;            /* the actual driver database entries */
1584   char *xf86;                           /* the XF86 protocol name */
1585   char *gpm;                            /* dto, gpm */
1586   int buttons;                          /* number of buttons, -1 --> unknown */
1587   int wheels;                           /* dto, wheels */
1588 } driver_info_mouse_t;
1589
1590 /* X11 server info */
1591 typedef struct {
1592   union driver_info_u *next;
1593   enum driver_info_type type;           /* driver info type */
1594   str_list_t *hddb0, *hddb1;            /* the actual driver database entries */
1595   char *server;                         /* the server/module name */
1596   char *xf86_ver;                       /* XFree86 version (3 or 4) */
1597   unsigned x3d:1;                       /* has 3D support */
1598   struct {
1599     unsigned all:5;                     /* the next 5 entries combined */
1600     unsigned c8:1, c15:1, c16:1, c24:1, c32:1;
1601   } colors;                             /* supported color depths */
1602   unsigned dacspeed;                    /* max. ramdac clock */
1603   str_list_t *extensions;               /* additional X extensions to load ('Module' section) */
1604   str_list_t *options;                  /* special server options */
1605   str_list_t *raw;                      /* extra info to add to XF86Config */
1606   char *script;                         /* 3d script to run */
1607 } driver_info_x11_t;
1608
1609 /* isdn info */
1610 typedef struct {
1611   union driver_info_u *next;
1612   enum driver_info_type type;           /* driver info type */
1613   str_list_t *hddb0, *hddb1;            /* the actual driver database entries */
1614   int i4l_type, i4l_subtype;            /* I4L types */
1615   char *i4l_name;                       /* I4L card name */
1616   isdn_parm_t *params;                  /* isdn parameters */
1617 } driver_info_isdn_t;
1618
1619 /* dsl info */
1620 typedef struct {
1621   union driver_info_u *next;
1622   enum driver_info_type type;           /* driver info type */
1623   str_list_t *hddb0, *hddb1;            /* the actual driver database entries */
1624   char *mode;                           /* DSL driver types */
1625   char *name;                           /* DSL driver name */
1626 } driver_info_dsl_t;
1627
1628 /* keyboard info */
1629 typedef struct {
1630   union driver_info_u *next;
1631   enum driver_info_type type;           /* driver info type */
1632   str_list_t *hddb0, *hddb1;            /* the actual driver database entries */
1633   char *XkbRules;                       /* XF86Config entries */
1634   char *XkbModel;
1635   char *XkbLayout;
1636   char *keymap;                         /* console keymap */
1637 } driver_info_kbd_t;
1638
1639 /*
1640  * holds device driver info
1641  */
1642 typedef union driver_info_u {
1643   union driver_info_u *next;
1644   driver_info_any_t any;
1645   driver_info_module_t module;
1646   driver_info_mouse_t mouse;
1647   driver_info_x11_t x11;
1648   driver_info_display_t display;
1649   driver_info_isdn_t isdn;
1650   driver_info_dsl_t dsl;
1651   driver_info_kbd_t kbd;
1652 } driver_info_t;
1653
1654
1655 /*
1656  * Some hardware doesn't fit into the hd_t scheme or there is info we
1657  * gathered during the scan process but that no-one really cares about. Such
1658  * stuff is stored in hd_detail_t.
1659  */
1660 typedef enum hd_detail_type {
1661   hd_detail_pci, hd_detail_usb, hd_detail_isapnp, hd_detail_cdrom,
1662   hd_detail_floppy, hd_detail_bios, hd_detail_cpu, hd_detail_prom,
1663   hd_detail_monitor, hd_detail_sys, hd_detail_scsi, hd_detail_devtree,
1664   hd_detail_ccw
1665 } hd_detail_type_t;
1666
1667 typedef struct {
1668   enum hd_detail_type type;
1669   pci_t *data;
1670 } hd_detail_pci_t;
1671
1672 typedef struct {
1673   enum hd_detail_type type;
1674   usb_t *data;
1675 } hd_detail_usb_t;
1676
1677 typedef struct {
1678   enum hd_detail_type type;
1679   isapnp_dev_t *data;
1680 } hd_detail_isapnp_t;
1681
1682 typedef struct {
1683   enum hd_detail_type type;
1684   cdrom_info_t *data;
1685 } hd_detail_cdrom_t;
1686
1687 typedef struct {
1688   enum hd_detail_type type;
1689   floppy_info_t *data;
1690 } hd_detail_floppy_t;
1691
1692 typedef struct {
1693   enum hd_detail_type type;
1694   bios_info_t *data;
1695 } hd_detail_bios_t;
1696
1697 typedef struct {
1698   enum hd_detail_type type;
1699   cpu_info_t *data;
1700 } hd_detail_cpu_t;
1701
1702 typedef struct {
1703   enum hd_detail_type type;
1704   prom_info_t *data;
1705 } hd_detail_prom_t;
1706
1707 typedef struct {
1708   enum hd_detail_type type;
1709   monitor_info_t *data;
1710 } hd_detail_monitor_t;
1711
1712 typedef struct {
1713   enum hd_detail_type type;
1714   sys_info_t *data;
1715 } hd_detail_sys_t;
1716
1717 typedef struct {
1718   enum hd_detail_type type;
1719   scsi_t *data;
1720 } hd_detail_scsi_t;
1721
1722 typedef struct {
1723   enum hd_detail_type type;
1724   devtree_t *data;
1725 } hd_detail_devtree_t;
1726
1727 typedef struct {
1728   enum hd_detail_type type;
1729   ccw_t *data;
1730 } hd_detail_ccw_t;
1731
1732 typedef union {
1733   enum hd_detail_type type;
1734   hd_detail_pci_t pci;
1735   hd_detail_usb_t usb;
1736   hd_detail_isapnp_t isapnp;
1737   hd_detail_cdrom_t cdrom;
1738   hd_detail_floppy_t floppy;
1739   hd_detail_bios_t bios;
1740   hd_detail_cpu_t cpu;
1741   hd_detail_prom_t prom;
1742   hd_detail_monitor_t monitor;
1743   hd_detail_sys_t sys;
1744   hd_detail_scsi_t scsi;
1745   hd_detail_devtree_t devtree;
1746   hd_detail_ccw_t ccw;
1747 } hd_detail_t;
1748
1749
1750 /* info about manually configured hardware (in /var/lib/hardware/) */
1751 typedef struct hd_manual_s {
1752   struct hd_manual_s *next;
1753
1754   char *unique_id;
1755   char *parent_id;
1756   char *child_ids;
1757   unsigned hw_class;
1758   char *model;
1759
1760   hd_status_t status;
1761   char *config_string;
1762
1763   /* More or less free-form key, value pairs.
1764    * key should not contain '=', however.
1765    */
1766   str_list_t *key;
1767   str_list_t *value;
1768 } hd_manual_t;
1769
1770
1771 /**
1772  * Individual hardware item.
1773  * Every hardware component gets an \ref hd_t entry. A list of all hardware
1774  * items is in \ref hd_data_t::hd.
1775  */
1776 typedef struct s_hd_t {
1777   struct s_hd_t *next;          /**< Link to next hardware item. */
1778   /**
1779    * Unique index, starting at 1.
1780    * Use \ref hd_get_device_by_idx() to look up an hardware entry by index. And don't
1781    * free the result!
1782    */
1783   unsigned idx;
1784
1785   /**
1786    * Hardware appears to be broken in some way.
1787    * This was used to indicate broken framebuffer support of some graphics cards.
1788    * Currently unused.
1789    */
1790   unsigned broken:1;
1791
1792   /**
1793    * Bus type (id and name).
1794    */ 
1795   hd_id_t bus;
1796
1797   /**
1798    * Slot and bus number.
1799    * Bits 0-7: slot number, 8-31 bus number.
1800    */
1801   unsigned slot;
1802
1803   /**
1804    * (PCI) function.
1805    */
1806   unsigned func;
1807
1808   /**
1809    * Base class (id and name).
1810    */
1811   hd_id_t base_class;
1812
1813   /**
1814    * Sub class (id and name).
1815    */
1816   hd_id_t sub_class;
1817
1818   /**
1819    * (PCI) programming interface (id and name).
1820    */
1821   hd_id_t prog_if;
1822
1823   /**
1824    * Vendor id and name.
1825    * Id is actually a combination of some tag to differentiate the
1826    * various id types and the real id. Use the \ref ID_VALUE macro to
1827    * get e.g. the real PCI id value for a PCI %device.
1828    */
1829   hd_id_t vendor;
1830
1831   /**
1832    * Device id and name.
1833    * Id is actually a combination of some tag to differentiate the
1834    * various id types and the real id. Use the \ref ID_VALUE macro to
1835    * get e.g. the real PCI id value for a PCI %device.
1836    * \note If you're looking or something printable, you might want to use \ref hd_t::model
1837    * instead.
1838    */
1839   hd_id_t device;
1840
1841   /**
1842    * Subvendor id and name.
1843    * Id is actually a combination of some tag to differentiate the
1844    * various id types and the real id. Use the \ref ID_VALUE macro to
1845    * get e.g. the real PCI id value for a PCI %device.
1846    */
1847   hd_id_t sub_vendor;
1848
1849   /**
1850    * Subdevice id and name.
1851    * Id is actually a combination of some tag to differentiate the
1852    * various id types and the real id. Use the \ref ID_VALUE macro to
1853    * get e.g. the real PCI id value for a PCI %device.
1854    */
1855   hd_id_t sub_device;
1856
1857   /**
1858    * Revision id or string.
1859    * If revision is numerical (e.g. PCI) \ref hd_id_t::id is used.
1860    * If revision is some char data (e.g. disk drives) it is stored in \ref hd_id_t::name.
1861    */
1862   hd_id_t revision;
1863
1864   /**
1865    * Serial id.
1866    */
1867   char *serial;
1868
1869   /**
1870    * Vendor id and name of some compatible hardware.
1871    * Used mainly for ISA-PnP devices.
1872    */
1873   hd_id_t compat_vendor;
1874
1875   /**
1876    * Device id and name of some compatible hardware.
1877    * Used mainly for ISA-PnP devices.
1878    */
1879   hd_id_t compat_device;
1880
1881   /**
1882    * Hardware class.
1883    * Not to confuse with \ref base_class!
1884    */
1885   hd_hw_item_t hw_class;
1886
1887   /**
1888    * Hardware class list.
1889    * A device may belong to more than one hardware class.
1890    */
1891   unsigned char hw_class_list[(hw_all + 7) / 8];        /**< (Internal) bitmask of hw classes. */
1892
1893   /**
1894    * Model name.
1895    * This is a combination of vendor and %device names. Some heuristics is used
1896    * to make it more presentable. Use this instead of \ref hd_t::vendor and
1897    * \ref hd_t::device.
1898    */
1899   char *model;
1900
1901   /**
1902    * Device this hardware is attached to.
1903    * Link to some 'parent' %device. Use \ref hd_get_device_by_idx() to get
1904    * the corresponding hardware entry.
1905    */
1906   unsigned attached_to;
1907
1908   /**
1909    * sysfs entry for this hardware, if any.
1910    */
1911   char *sysfs_id;
1912
1913   /**
1914    * sysfs bus id for this hardware, if any.
1915    */
1916   char *sysfs_bus_id;
1917
1918   /**
1919    * Special %device file.
1920    * Device file name to access this hardware. Normally something below /dev.
1921    * For network interfaces this is the interface name.
1922    */
1923   char *unix_dev_name;
1924
1925   /**
1926    * List of %device names.
1927    * Device file names to access this hardware. Normally something below /dev.
1928    * They should be all equivalent. The preferred name however is
1929    * \ref hd_t::unix_dev_name.
1930    */
1931   str_list_t *unix_dev_names;
1932
1933   /**
1934    * Special %device file.
1935    * Device file name to access this hardware. Most hardware only has one
1936    * %device name stored in \ref hd_t::unix_dev_name. But in some cases
1937    * there's an alternative name.
1938    */
1939   char *unix_dev_name2;
1940
1941   /**
1942    * Device type & number according to sysfs.
1943    */
1944   hd_dev_num_t unix_dev_num;
1945
1946   /**
1947    * BIOS/PROM id.
1948    * Where appropriate, this is a special BIOS/PROM id (e.g. "0x80" for
1949    * the first harddisk on Intel-PCs).
1950    * CHPID for s390.
1951    */
1952   char *rom_id;
1953
1954   /**
1955    * Unique id for this hardware.
1956    * A unique string identifying this hardware. The string consists
1957    * of two parts separated by a dot ("."). The part before the dot
1958    * describes the location (where the hardware is attached in the system).
1959    * The part after the dot identifies the hardware itself. The string
1960    * must not contain slashes ("/") because we're going to create files
1961    * with this id as name. Apart from this there are no restrictions on
1962    * the form of this string.
1963    */
1964   char *unique_id;
1965
1966   /**
1967    * (Internal) Probing module that created this entry.
1968    */
1969   unsigned module;
1970
1971   /**
1972    * (Internal) Source code line where this entry was created.
1973    */
1974   unsigned line;
1975
1976   /**
1977    * (Internal) Counter, used in combination with \ref hd_t::module and \ref hd_t::line.
1978    */
1979   unsigned count;
1980
1981   /**
1982    * Device resources.
1983    */
1984   hd_res_t *res;
1985
1986   /**
1987    * Special info associated with this hardware.
1988    * \note This is going to change!
1989    */
1990   hd_detail_t *detail;
1991
1992   /**
1993    * (Internal) Unspecific text info.
1994    * It is used to track IDE interfaces and assign them to the correct
1995    * IDE controllers.
1996    */
1997   str_list_t *extra_info;
1998
1999   /**
2000    * Hardware status (if available).
2001    * The status is stored in files below /var/lib/hardware/unique-keys/. Every
2002    * hardware item gets a file there with its unique id as file name.
2003    */
2004   hd_status_t status;
2005
2006   /**
2007    * Some %config info.
2008    * Every hardware item may get some string assigned. This string is stored
2009    * in files below /var/lib/hardware/unique-keys/. There is no meaning
2010    * associated with this string.
2011    */
2012   char *config_string;
2013
2014   /**
2015    * Hotplug controller for this %device.
2016    * It indicates what kind of hotplug %device (if any) this is.
2017    */
2018   hd_hotplug_t hotplug;
2019
2020    /**
2021     * Slot the hotplug device is connected to (e.g. PCMCIA socket).
2022     * \note \ref hotplug_slot counts 1-based (0: no information available).
2023     */
2024   unsigned hotplug_slot;
2025
2026   struct is_s {
2027     unsigned agp:1;             /* AGP device */
2028     unsigned isapnp:1;          /* ISA-PnP device */
2029     unsigned notready:1;        /* block devices: no medium, other: device not configured */
2030     unsigned manual:1;          /* undetectable, manually configured hardware */
2031     unsigned softraiddisk:1;    /* disk belongs to some soft raid array */
2032     unsigned zip:1;             /* zip floppy */
2033     unsigned cdr:1;             /* CD-R */
2034     unsigned cdrw:1;            /* CD-RW */
2035     unsigned dvd:1;             /* DVD */
2036     unsigned dvdr:1;            /* DVD-R */
2037     unsigned dvdram:1;          /* DVD-RAM */
2038     unsigned pppoe:1;           /* PPPOE modem connected */
2039     unsigned wlan:1;            /* WLAN card */
2040   } is;
2041
2042   struct tag_s {                /* this struct is for internal purposes only */
2043     unsigned remove:1;          /* schedule for removal */
2044     unsigned freeit:1;          /* for internal memory management */
2045     unsigned fixed:1;           /* fixed, do no longer modify this entry */
2046     unsigned ser_skip:1;        /* if serial line, don't scan for devices */
2047     unsigned ser_device:2;      /* if != 0: info about attached serial device; see serial.c */
2048   } tag;
2049
2050   /**
2051    * (Internal) First 512 bytes of block devices.
2052    * To check accessibility of block devices we read the first block. The data
2053    * is used to identify the boot %device.
2054    */
2055   unsigned char *block0;
2056
2057   /**
2058    * Currently active driver.
2059    */
2060   char *driver;
2061
2062   /**
2063    * Old \ref unique_id for compatibility.
2064    * The calculation of unique ids has changed in libhd v3.17. Basically
2065    * we no longer use the vendor/%device names if there are vendor/%device
2066    * ids. (Otherwise a simple %device name database update would change the id,
2067    * which is really not what you want.)
2068    */
2069   char *old_unique_id;
2070
2071   /**
2072    * \ref unique_id of parent (\ref attached_to).
2073    * \note Please do not use it for now.
2074    * 
2075    */
2076   char *parent_id;
2077
2078   /**
2079    * \ref unique_ids of children (\ref parent_id).
2080    * \note Please do not use it for now.
2081    * 
2082    */
2083   str_list_t *child_ids;
2084
2085   /**
2086    * (Internal) location independent \ref unique_id part.
2087    * The speed up some internal searches, we store it here separately.
2088    */
2089   char *unique_id1;
2090
2091   /**
2092    * USB Global Unique Identifier.
2093    * Available for USB devices. This may even be set if \ref hd_t::bus is not
2094    * \ref bus_usb (e.g. USB storage devices will have \ref hd_t::bus set to
2095    * \ref bus_scsi due to SCSI emulation).
2096    */
2097   char *usb_guid;
2098
2099   driver_info_t *driver_info;   /* device driver info */
2100
2101   str_list_t *requires;         /* packages/programs required for this hardware */
2102
2103   /*
2104    * These are used internally for memory management.
2105    * Do not even _think_ of modifying these!
2106    */
2107   unsigned ref_cnt;             /**< (Internal) memory reference count. */
2108   struct s_hd_t *ref;           /**< (Internal) if set, this is only a reference. */
2109 } hd_t;
2110
2111
2112 /**
2113  * Holds all data accumulated during hardware probing.
2114  */
2115 typedef struct {
2116   /**
2117    * Current hardware list.
2118    * The list of all currently probed hardware. This is not identical with
2119    * the result of \ref hd_list(). (But a superset of it.)
2120    */
2121   hd_t *hd;
2122
2123   /**
2124    * A progress indicator.
2125    * If this callback function is not NULL, it is called at various points and can
2126    * be used to give some user feedback what we are actually doing.
2127    * If the debug flag HD_DEB_PROGRESS is set, progress messages are logged.
2128    * \param pos Indicates where we are.
2129    * \param msg Indicates what we are going to do.
2130    */
2131   void (*progress)(char *pos, char *msg);
2132   
2133   /** Log messages.
2134    * All messages logged during hardware probing accumulate here.
2135    */
2136   char *log;
2137
2138   /** Debug flags.
2139    * Although there exist some debug flag defines this scheme is currently
2140    * not followed consistently. It is guaranteed however that -1 will give
2141    * the most log messages and 0 the least.
2142    */
2143   unsigned debug;
2144
2145   /**
2146    * Special flags.
2147    * Influence hardware probing in some strange ways with these. You normally
2148    * do not want to use them.
2149    */
2150   struct flag_struct {
2151     unsigned internal:1;        /**< \ref hd_scan() has been called internally. */
2152     unsigned dformat:2;         /**< Alternative output format. */
2153     unsigned no_parport:1;      /**< Don't do parport probing: parport modules (used to) crash pmacs. */
2154     unsigned iseries:1;         /**< Set if we are on an iSeries machine. */
2155     unsigned list_all:1;        /**< Return even devices with status 'not available'. */
2156     unsigned fast:1;            /**< Don't check tricky hardware. */
2157     unsigned list_md:1;         /**< Report md & lvm devices from /proc/partitions */
2158     unsigned nofork:1;          /**< don't run potentially hanging code in a subprocess */
2159     unsigned nosysfs:1;         /**< don't ask sysfs */
2160     unsigned forked:1;          /**< we're running in a subprocess */
2161     unsigned cpuemu:1;          /**< use CPU emulation to run BIOS code (i386 only) */
2162   } flags;
2163
2164
2165   /*
2166    * The following entries should *not* be accessed outside of libhd!
2167    */
2168
2169   unsigned char probe[(pr_all + 7) / 8];        /**< (Internal) bitmask of probing features. */
2170   unsigned char probe_set[(pr_all + 7) / 8];    /**< (Iternal) bitmask of probing features that will always be set. */
2171   unsigned char probe_clr[(pr_all + 7) / 8];    /**< (Internal) bitmask of probing features that will always be reset. */
2172   unsigned last_idx;            /**< (Internal) index of the last hd entry generated */
2173   unsigned module;              /**< (Internal) the current probing module we are in */
2174   enum boot_arch boot;          /**< (Internal) boot method */
2175   hd_t *old_hd;                 /**< (Internal) old (outdated) entries (if you scan more than once) */
2176   pci_t *pci;                   /**< (Internal) raw PCI data */
2177   isapnp_t *isapnp;             /**< (Internal) raw ISA-PnP data */
2178   cdrom_info_t *cdrom;          /**< (Internal) CDROM devs from PROC_CDROM_INFO */
2179   str_list_t *net;              /**< (Internal) list of network interfaces */
2180   str_list_t *floppy;           /**< (Internal) contents of PROC_NVRAM, used by the floppy module */
2181   misc_t *misc;                 /**< (Internal) data gathered in the misc module */
2182   serial_t *serial;             /**< (Internal) /proc's serial info */
2183   scsi_t *scsi;                 /**< (Internal) raw SCSI data */
2184   ser_device_t *ser_mouse;      /**< (Internal) info about serial mice */
2185   ser_device_t *ser_modem;      /**< (Internal) info about serial modems */
2186   str_list_t *cpu;              /**< (Internal) /proc/cpuinfo */
2187   str_list_t *klog;             /**< (Internal) kernel log */
2188   str_list_t *proc_usb;         /**< (Internal) /proc/bus/usb info */
2189   usb_t *usb;                   /**< (Internal) usb info */
2190   hddb_pci_t *hddb_pci_hm;      /**< (Internal) pci module info */
2191   hddb_pci_t *hddb_pci;         /**< (Internal) pci module info */
2192   hddb2_data_t *hddb2[2];       /**< (Internal) hardware database */
2193   str_list_t *kmods;            /**< (Internal) list of active kernel modules */
2194   uint64_t used_irqs;           /**< (Internal) irq usage */
2195   uint64_t assigned_irqs;       /**< (Internal) irqs automatically assigned by libhd (for driver info) */
2196   memory_range_t bios_rom;      /**< (Internal) BIOS 0xc0000 - 0xfffff */
2197   memory_range_t bios_ram;      /**< (Internal) BIOS 0x00400 - 0x004ff */
2198   memory_range_t bios_ebda;     /**< (Internal) EBDA */
2199   unsigned display;             /**< (Internal) hd_idx of the active (vga) display */
2200   unsigned color_code;          /**< (Internal) color, if any */
2201   char *cmd_line;               /**< (Internal) kernel command line */
2202   str_list_t *xtra_hd;          /**< (Internal) fake hd entries (for testing) */
2203   devtree_t *devtree;           /**< (Internal) prom device tree on ppc */
2204   unsigned kernel_version;      /**< (Internal) kernel version */
2205   int in_vmware;                /**< (Internal) running in vmware */
2206   hd_manual_t *manual;          /**< (Internal) hardware config info */
2207   str_list_t *disks;            /**< (Internal) disks according to /proc/partitions */
2208   str_list_t *partitions;       /**< (Internal) dto, partitions */
2209   hd_smbios_t *smbios;          /**< (Internal) smbios data */
2210   struct {
2211     unsigned ok:1;
2212     unsigned size;
2213     unsigned used;
2214     void *data;
2215     int id;
2216     int updated;
2217   } shm;                        /**< (Internal) our shm segment */
2218   unsigned pci_config_type;     /**< (Internal) PCI config type (1 or 2), 0: unknown */
2219   hd_udevinfo_t *udevinfo;      /**< (Internal) udev info */
2220 } hd_data_t;
2221
2222
2223 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2224  *
2225  *                      libhd interface functions
2226  *
2227  * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2228  */
2229
2230 /* implemented in hd.c */
2231
2232 /* the actual hardware scan */
2233 void hd_scan(hd_data_t *hd_data);
2234
2235 //! Free all data.
2236 hd_data_t *hd_free_hd_data(hd_data_t *hd_data);
2237
2238 //! Free hardware items returned by e.g. \ref hd_list().
2239 hd_t *hd_free_hd_list(hd_t *hd);
2240
2241 void hd_set_probe_feature(hd_data_t *hd_data, enum probe_feature feature);
2242 void hd_clear_probe_feature(hd_data_t *hd_data, enum probe_feature feature);
2243 int hd_probe_feature(hd_data_t *hd_data, enum probe_feature feature);
2244 void hd_set_probe_feature_hw(hd_data_t *hd_data, hd_hw_item_t item);
2245
2246 enum probe_feature hd_probe_feature_by_name(char *name);
2247 char *hd_probe_feature_by_value(enum probe_feature feature);
2248
2249 int hd_module_is_active(hd_data_t *hd_data, char *mod);
2250
2251 hd_t *hd_base_class_list(hd_data_t *hd_data, unsigned base_class);
2252 hd_t *hd_sub_class_list(hd_data_t *hd_data, unsigned base_class, unsigned sub_class);
2253 hd_t *hd_bus_list(hd_data_t *hd_data, unsigned bus);
2254 hd_t *hd_list(hd_data_t *hd_data, hd_hw_item_t item, int rescan, hd_t *hd_old);
2255 hd_t *hd_list_with_status(hd_data_t *hd_data, hd_hw_item_t item, hd_status_t status);
2256 hd_t *hd_list2(hd_data_t *hd_data, hd_hw_item_t *items, int rescan);
2257 hd_t *hd_list_with_status2(hd_data_t *hd_data, hd_hw_item_t *items, hd_status_t status);
2258
2259 int hd_has_special_eide(hd_data_t *hd_data);
2260 int hd_has_pcmcia(hd_data_t *hd_data);
2261 int hd_apm_enabled(hd_data_t *hd_data);
2262 int hd_usb_support(hd_data_t *hd_data);
2263 int hd_smp_support(hd_data_t *hd_data);
2264 int hd_mac_color(hd_data_t *hd_data);
2265 int hd_color(hd_data_t *hd_data);
2266 unsigned hd_display_adapter(hd_data_t *hd_data);
2267 unsigned hd_boot_disk(hd_data_t *hd_data, int *matches);
2268 enum cpu_arch hd_cpu_arch(hd_data_t *hd_data);
2269 enum boot_arch hd_boot_arch(hd_data_t *hd_data);
2270
2271 hd_t *hd_get_device_by_idx(hd_data_t *hd_data, unsigned idx);
2272
2273 void hd_set_hw_class(hd_t *hd, hd_hw_item_t hw_class);
2274 int hd_is_hw_class(hd_t *hd, hd_hw_item_t hw_class);
2275
2276 char *hd_version(void);
2277
2278 /* implemented in hddb.c */
2279
2280 str_list_t *get_hddb_packages(hd_data_t *hd_data);
2281 void hddb_add_info(hd_data_t *hd_data, hd_t *hd);
2282
2283 void hddb_dump_raw(hddb2_data_t *hddb, FILE *f);
2284 void hddb_dump(hddb2_data_t *hddb, FILE *f);
2285
2286 /* implemented in hdp.c */
2287
2288 void hd_dump_entry(hd_data_t *hd_data, hd_t *hd, FILE *f);
2289
2290
2291 /* implemented in cdrom.c */
2292
2293 cdrom_info_t *hd_read_cdrom_info(hd_data_t *hd_data, hd_t *hd);
2294
2295 /* implemented in manual.c */
2296 hd_manual_t *hd_manual_read_entry(hd_data_t *hd_data, const char *id);
2297 int hd_manual_write_entry(hd_data_t *hd_data, hd_manual_t *entry);
2298 hd_manual_t *hd_free_manual(hd_manual_t *manual);
2299 hd_t *hd_read_config(hd_data_t *hd_data, const char *id);
2300 int hd_write_config(hd_data_t *hd_data, hd_t *hd);
2301 char *hd_hw_item_name(hd_hw_item_t item);
2302 char *hd_status_value_name(hd_status_value_t status);
2303 int hd_change_status(const char *id, hd_status_t status, const char *config_string);
2304
2305
2306 /*
2307  * - - - - - CDB ISDN interface - - - - -
2308  */
2309
2310
2311 /* (C) 2003 kkeil@suse.de */
2312
2313 #define CDBISDN_VERSION 0x0101
2314
2315 #ifndef PCI_ANY_ID
2316 #define PCI_ANY_ID      0xffff
2317 #endif
2318
2319 #define CDBISDN_P_NONE  0x0
2320 #define CDBISDN_P_IRQ   0x1
2321 #define CDBISDN_P_MEM   0x2
2322 #define CDBISDN_P_IO    0x3
2323
2324 /* vendor info */
2325 typedef struct {
2326         char    *name;
2327         char    *shortname;
2328         int     vnr;
2329         int     refcnt;
2330 } cdb_isdn_vendor;
2331
2332 typedef struct  {
2333         int     handle;         /* internal identifier idx in database */
2334         int     vhandle;        /* internal identifier to vendor database */
2335         char    *name;          /* cardname */
2336         char    *lname;         /* vendor short name + cardname */
2337         char    *Class;         /* CLASS of the card */
2338         char    *bus;           /* bus type */
2339         int     revision;       /* revision used with USB */
2340         int     vendor;         /* Vendor ID for ISAPNP and PCI cards */
2341         int     device;         /* Device ID for ISAPNP and PCI cards */
2342         int     subvendor;      /* Subvendor ID for PCI cards */
2343                                 /* A value of 0xffff is ANY_ID */
2344         int     subdevice;      /* Subdevice ID for PCI cards */
2345                                 /* A value of 0xffff is ANY_ID */
2346         unsigned int features;  /* feature flags */
2347         int     line_cnt;       /* count of ISDN ports */
2348         int     vario_cnt;      /* count of driver varios */
2349         int     vario;          /* referenz to driver vario record */
2350 } cdb_isdn_card;
2351
2352 typedef struct  {
2353         int     handle;         /* idx in database */   
2354         int     next_vario;     /* link to alternate vario */
2355         int     drvid;          /* unique id of the driver vario */
2356         int     typ;            /* Type to identify the driver */
2357         int     subtyp;         /* Subtype of the driver type */
2358         int     smp;            /* SMP supported ? */
2359         char    *mod_name;      /* name of the driver module */
2360         char    *para_str;      /* optional parameter string */
2361         char    *mod_preload;   /* optional modules to preload */
2362         char    *cfg_prog;      /* optional cfg prog */
2363         char    *firmware;      /* optional firmware to load */
2364         char    *description;   /* optional description */
2365         char    *need_pkg;      /* list of packages needed for function */
2366         char    *info;          /* optional additional info */
2367         char    *protocol;      /* supported D-channel protocols */
2368         char    *interface;     /* supported API interfaces */
2369         char    *io;            /* possible IO ports with legacy ISA cards */
2370         char    *irq;           /* possible interrupts with legacy ISA cards */
2371         char    *membase;       /* possible membase with legacy ISA cards */
2372         char    *features;      /* optional features*/
2373         int     card_ref;       /* reference to a card */
2374         char    *name;          /* driver name */
2375 } cdb_isdn_vario;
2376
2377
2378 extern cdb_isdn_vendor  *hd_cdbisdn_get_vendor(int);
2379 extern cdb_isdn_card    *hd_cdbisdn_get_card(int);
2380 extern cdb_isdn_vario   *hd_cdbisdn_get_vario_from_type(int, int);
2381 extern cdb_isdn_card    *hd_cdbisdn_get_card_from_type(int, int);
2382 extern cdb_isdn_card    *hd_cdbisdn_get_card_from_id(int, int, int, int);
2383 extern cdb_isdn_vario   *hd_cdbisdn_get_vario(int);
2384 extern int              hd_cdbisdn_get_version(void);
2385 extern int              hd_cdbisdn_get_db_version(void);
2386 extern char             *hd_cdbisdn_get_db_date(void);
2387
2388 /* CDB ISDN interface end */
2389
2390 #ifdef __cplusplus
2391 }
2392 #endif
2393
2394 #endif  /* _HD_H */