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