libhd  5.0
hd_int.h
Go to the documentation of this file.
1 #define PROC_CMDLINE "/proc/cmdline"
2 #define PROC_PCI_DEVICES "/proc/bus/pci/devices"
3 #define PROC_PCI_BUS "/proc/bus/pci"
4 #define PROC_CPUINFO "/proc/cpuinfo"
5 #define PROC_IOPORTS "/proc/ioports"
6 #define PROC_DMA "/proc/dma"
7 #define PROC_INTERRUPTS "/proc/interrupts"
8 #define PROC_NVRAM_22 "/proc/driver/nvram"
9 #define PROC_NVRAM_24 "/proc/nvram"
10 #define PROC_IDE "/proc/ide"
11 #define PROC_SCSI "/proc/scsi"
12 #define PROC_CDROM_INFO "/proc/sys/dev/cdrom/info"
13 #define PROC_NET_IF_INFO "/proc/net/dev"
14 #define PROC_MODULES "/proc/modules"
15 #define PROC_DRIVER_SERIAL "/proc/tty/driver/serial"
16 #define PROC_DRIVER_MACSERIAL "/proc/tty/driver/macserial"
17 #define PROC_PARPORT_22 "/proc/parport/" /* Final '/' is essential! */
18 #define PROC_PARPORT_24 "/proc/sys/dev/parport/parport"
19 #define PROC_KCORE "/proc/kcore"
20 // #define PROC_USB_DEVICES "/proc/bus/usb/devices"
21 #define PROC_USB_DEVICES "/proc/bus/usb/devices_please-use-sysfs-instead"
22 #define PROC_PROM "/proc/device-tree"
23 #define PROC_MEMINFO "/proc/meminfo"
24 #define PROC_VERSION "/proc/version"
25 #define PROC_ISAPNP "/proc/isapnp"
26 #define PROC_PARTITIONS "/proc/partitions"
27 #define PROC_APM "/proc/apm"
28 #define PROC_XEN_BALLOON "/proc/xen/balloon"
29 
30 #define DEV_NVRAM "/dev/nvram"
31 #define DEV_PSAUX "/dev/psaux"
32 #define DEV_ADBMOUSE "/dev/adbmouse"
33 #define DEV_MEM "/dev/mem"
34 #define DEV_KBD "/dev/kbd"
35 #define DEV_CONSOLE "/dev/console"
36 #define DEV_OPENPROM "/dev/openprom"
37 #define DEV_SUNMOUSE "/dev/sunmouse"
38 #define DEV_MICE "/dev/input/mice"
39 #define DEV_FB "/dev/fb"
40 #define DEV_FB0 "/dev/fb0"
41 
42 #define PROG_MODPROBE "/sbin/modprobe"
43 #define PROG_RMMOD "/sbin/rmmod"
44 #define PROG_CARDCTL "/sbin/cardctl"
45 #define PROG_UDEVINFO "/usr/bin/udevinfo"
46 #define PROG_UDEVADM "/usr/bin/udevadm"
47 
48 #define KLOG_BOOT "/var/log/boot.msg"
49 #define ISAPNP_CONF "/etc/isapnp.conf"
50 
51 #define KERNEL_22 0x020200
52 #define KERNEL_24 0x020400
53 #define KERNEL_26 0x020600
54 
55 #if defined(__s390__) || defined(__s390x__) || defined(__alpha__) || defined(LIBHD_TINY)
56 #define WITH_ISDN 0
57 #else
58 #define WITH_ISDN 1
59 #endif
60 
61 // maximum attribute size in sysfs we expect
62 // (this is to avoid accidentally reading unlimited data)
63 #define MAX_ATTR_SIZE 0x10000
64 
65 #define PROGRESS(a, b, c) progress(hd_data, a, b, c)
66 #define ADD2LOG(a...) hd_log_printf(hd_data, a)
67 
68 /*
69  * define to make (hd_t).unique_id a hex string, otherwise it is a
70  * base64-like string
71  */
72 #undef NUMERIC_UNIQUE_ID
73 
74 /*
75  * exported symbol - all others are not exported by the library
76  */
77 #define API_SYM __attribute__((visibility("default")))
78 
79 /*
80  * All API symbols start with 'hd_' or 'hddb_'.
81  *
82  * Add aliases for some symbols that are widespread throughout libhd sources
83  * to avoid massive code adjustments.
84  */
85 #define read_dir hd_read_dir
86 #define read_file hd_read_file
87 #define name2eisa_id hd_name2eisa_id
88 #define search_str_list hd_search_str_list
89 #define add_str_list hd_add_str_list
90 #define free_str_list hd_free_str_list
91 #define reverse_str_list hd_reverse_str_list
92 #define add_hd_entry hd_add_hd_entry
93 
94 /*
95  * Internal probing module numbers. Use mod_name_by_idx() outside of libhd.
96  */
97 enum mod_idx {
104 };
105 
106 void *new_mem(size_t size);
107 void *resize_mem(void *, size_t);
108 void *add_mem(void *, size_t, size_t);
109 char *new_str(const char *);
110 void *free_mem(void *);
111 int have_common_res(hd_res_t *res1, hd_res_t *res2);
112 void join_res_io(hd_res_t **res1, hd_res_t *res2);
113 void join_res_irq(hd_res_t **res1, hd_res_t *res2);
114 void join_res_dma(hd_res_t **res1, hd_res_t *res2);
116 hd_res_t *add_res_entry(hd_res_t **res, hd_res_t *new_res);
117 hd_t *add_hd_entry(hd_data_t *hd_data, unsigned line, unsigned count);
118 misc_t *free_misc(misc_t *m);
119 scsi_t *free_scsi(scsi_t *scsi, int free_all);
122 void hd_add_id(hd_data_t *hd_data, hd_t *hd);
123 
124 char *isa_id2str(unsigned);
125 char *eisa_vendor_str(unsigned);
126 char *canon_str(char *, int);
127 
128 int hex(char *string, int digits);
129 
130 void hd_log(hd_data_t *hd_data, char *buf, ssize_t len);
131 void hd_log_printf(hd_data_t *hd_data, char *format, ...) __attribute__ ((format (printf, 2, 3)));
132 void hd_log_hex(hd_data_t *hd_data, int with_ascii, unsigned data_len, unsigned char *data);
133 
134 void str_printf(char **buf, int offset, char *format, ...) __attribute__ ((format (printf, 3, 4)));
135 void hexdump(char **buf, int with_ascii, unsigned data_len, unsigned char *data);
136 str_list_t *read_dir_canonical(char *dir_name, int type);
137 str_list_t *subcomponent_list(str_list_t *list, char *comp, int max);
138 int has_subcomponent(str_list_t *list, char *comp);
139 void progress(hd_data_t *hd_data, unsigned pos, unsigned count, char *msg);
140 
143 
145 
146 int str2float(char *s, int n);
147 char *float2str(int i, int n);
148 
149 /* return the file name of a module */
150 char *mod_name_by_idx(unsigned idx);
151 
152 int hd_timeout(void(*func)(void *), void *arg, int timeout);
153 
155 char *get_cmd_param(hd_data_t *hd_data, int field);
156 
157 #ifdef __i386__
158 /* smp/smp.c */
159 int detectSMP(void);
160 #endif
161 
163 int run_cmd(hd_data_t *hd_data, char *cmd);
164 int load_module_with_params(hd_data_t *hd_data, char *module, char *params);
165 int load_module(hd_data_t *hd_data, char *module);
167 int probe_module(hd_data_t *hd_data, char *module);
168 
169 int cmp_hd(hd_t *hd1, hd_t *hd2);
171 
173 
176 
177 unsigned char *read_block0(hd_data_t *hd_data, char *dev, int *timeout);
178 
179 void hd_copy(hd_t *dst, hd_t *src);
180 
181 /* parameter for gather_resources(,,, which) */
182 #define W_IO (1 << 0)
183 #define W_DMA (1 << 1)
184 #define W_IRQ (1 << 2)
185 
186 void gather_resources(misc_t *m, hd_res_t **r, char *name, unsigned which);
187 
188 char *vend_id2str(unsigned vend);
189 
190 int hd_getdisksize(hd_data_t *hd_data, char *dev, int fd, hd_res_t **geo, hd_res_t **size);
191 
192 int is_pnpinfo(ser_device_t *mi, int ofs);
193 
195 
196 void hd_fork(hd_data_t *hd_data, int timeout, int total_timeout);
201 void *hd_shm_add(hd_data_t *hd_data, void *ptr, unsigned len);
202 int hd_is_shm_ptr(hd_data_t *hd_data, void *ptr);
204 
206 
208 hd_t *hd_find_sysfs_id_devname(hd_data_t *hd_data, char *id, char *devname);
209 int hd_attr_uint(char* attr, uint64_t* u, int base);
210 str_list_t *hd_attr_list(char *str);
211 char *hd_sysfs_id(char *path);
212 char *hd_sysfs_name2_dev(char *str);
213 char *hd_sysfs_dev2_name(char *str);
215 char *hd_sysfs_find_driver(hd_data_t *hd_data, char *sysfs_id, int exact);
218 
219 char* get_sysfs_attr(const char* bus, const char* device, const char* attr);
220 char *get_sysfs_attr_by_path(const char *path, const char *attr);
221 char *get_sysfs_attr_by_path2(const char *path, const char *attr, unsigned *len);
222 
223 void hd_pci_complete_data(hd_t *hd);
225 
227 char *hd_hal_print_prop(hal_prop_t *prop);
228 
229 void hal_invalidate(hal_prop_t *prop);
230 void hal_invalidate_all(hal_prop_t *prop, const char *key);
231 hal_prop_t *hal_get_any(hal_prop_t *prop, const char *key);
232 hal_prop_t *hal_get_bool(hal_prop_t *prop, const char *key);
233 hal_prop_t *hal_get_int32(hal_prop_t *prop, const char *key);
234 hal_prop_t *hal_get_str(hal_prop_t *prop, const char *key);
235 hal_prop_t *hal_get_list(hal_prop_t *prop, const char *key);
236 char *hal_get_useful_str(hal_prop_t *prop, const char *key);
237 
240 
241 char *hd_get_hddb_dir(void);
242 char *hd_get_hddb_path(char *sub);
243 
244 int hd_mod_cmp(char *str1, char *str2);
245 
249 
250 str_list_t *sort_str_list(str_list_t *sl0, int (*cmp_func)(const void *, const void *));
251 
252 
253 #ifdef __cplusplus
254 }
255 #endif
256 
hal_prop_t * hal_get_bool(hal_prop_t *prop, const char *key)
Definition: hal.c:289
devtree_t * free_devtree(hd_data_t *hd_data)
Definition: hd.c:4374
char * eisa_vendor_str(unsigned)
Definition: hd.c:2178
Definition: hd_int.h:98
void * free_mem(void *)
Definition: hd.c:1611
Definition: hd_int.h:102
mod_idx
Definition: hd_int.h:97
Definition: hd_int.h:99
str_list_t * get_cmdline(hd_data_t *hd_data, char *key)
Definition: hd.c:3662
void remove_hd_entries(hd_data_t *hd_data)
Definition: hd.c:2804
int hd_getdisksize(hd_data_t *hd_data, char *dev, int fd, hd_res_t **geo, hd_res_t **size)
Definition: hd.c:5090
char * get_cmd_param(hd_data_t *hd_data, int field)
Definition: hd.c:3717
Definition: hd_int.h:100
scsi_t * free_scsi(scsi_t *scsi, int free_all)
Definition: hd.c:1489
char * hd_sysfs_find_driver(hd_data_t *hd_data, char *sysfs_id, int exact)
Definition: block.c:426
Definition: hd_int.h:100
char * new_str(const char *)
Definition: hd.c:1594
int run_cmd(hd_data_t *hd_data, char *cmd)
Definition: hd.c:3886
Definition: hd_int.h:98
Definition: hd_int.h:100
str_list_t * read_kmods(hd_data_t *hd_data)
Definition: hd.c:3637
Definition: hd_int.h:101
Definition: hd_int.h:101
Definition: hd_int.h:100
hal_prop_t * hal_get_list(hal_prop_t *prop, const char *key)
Definition: hal.c:338
void * resize_mem(void *, size_t)
Definition: hd.c:1568
Definition: hd_int.h:99
misc_t * free_misc(misc_t *m)
Definition: hd.c:1456
char * canon_str(char *, int)
Definition: hd.c:2215
int detect_smp_bios(hd_data_t *hd_data)
Definition: hd_int.h:103
int hex(char *string, int digits)
Definition: hd.c:2243
int type
Definition: hd.h:1160
Definition: hd_int.h:100
void join_res_irq(hd_res_t **res1, hd_res_t *res2)
Definition: hd.c:1666
hd_t * hd_find_sysfs_id(hd_data_t *hd_data, char *id)
Definition: hd.c:5811
libhd resource union
Definition: hd.h:1864
Definition: hd_int.h:102
HAL device.
Definition: hd.h:1654
Definition: hd.h:2184
void hal_invalidate(hal_prop_t *prop)
Definition: hal.c:262
hal_device_t * hal_find_device(hd_data_t *hd_data, char *udi)
Definition: hal.c:248
char * hd_sysfs_id(char *path)
Definition: hd.c:6171
int str2float(char *s, int n)
Definition: hd.c:2257
str_list_t * hd_module_list(hd_data_t *hd_data, unsigned id)
Definition: hd.c:6020
hal_prop_t * hal_add_new(hal_prop_t **prop)
Definition: hal.c:348
Individual hardware item.
Definition: hd.h:2239
void join_res_dma(hd_res_t **res1, hd_res_t *res2)
Definition: hd.c:1686
Definition: hd_int.h:98
str_list_t * read_dir_canonical(char *dir_name, int type)
Definition: hd.c:2661
hd_detail_t * free_hd_detail(hd_detail_t *d)
Definition: hd.c:1225
char * get_sysfs_attr_by_path2(const char *path, const char *attr, unsigned *len)
Definition: hd.c:6247
Definition: isdn_cdb_def.h:22
void hd_fork_done(hd_data_t *hd_data)
Definition: hd.c:5459
char * hal_get_useful_str(hal_prop_t *prop, const char *key)
Definition: hal.c:319
str_list_t * sort_str_list(str_list_t *sl0, int(*cmp_func)(const void *, const void *))
Definition: hd.c:6308
unsigned has_something_attached(hd_data_t *hd_data, hd_t *hd)
Definition: hd.c:4193
String list type.
Definition: hd.h:411
Definition: hd_int.h:102
int unload_module(hd_data_t *hd_data, char *module)
Definition: hd.c:3950
void hd_copy(hd_t *dst, hd_t *src)
Definition: hd.c:3280
int load_module(hd_data_t *hd_data, char *module)
Definition: hd.c:3945
Definition: hd_int.h:103
int hd_report_this(hd_data_t *hd_data, hd_t *hd)
Definition: hd.c:6010
char * float2str(int i, int n)
Definition: hd.c:2288
char * hd_get_hddb_dir(void)
Definition: hd.c:6116
Definition: hd_int.h:102
void join_res_io(hd_res_t **res1, hd_res_t *res2)
Definition: hd.c:1618
Definition: hd_int.h:102
int get_probe_val_int(hd_data_t *hd_data, enum probe_feature feature)
Definition: hd.c:396
Definition: hd_int.h:103
str_list_t * subcomponent_list(str_list_t *list, char *comp, int max)
Definition: hd.c:2704
hal_prop_t * hal_get_int32(hal_prop_t *prop, const char *key)
Definition: hal.c:299
Definition: hd_int.h:102
probe_feature
flags to control the probing.
Definition: hd.h:112
char * get_probe_val_str(hd_data_t *hd_data, enum probe_feature feature)
Definition: hd.c:411
void hd_add_id(hd_data_t *hd_data, hd_t *hd)
Definition: hd.c:4305
hal_prop_t * hal_get_any(hal_prop_t *prop, const char *key)
Definition: hal.c:279
Serial device configuration information.
Definition: hd.h:1937
raw SCSI data
Definition: hd.h:1148
int hd_attr_uint(char *attr, uint64_t *u, int base)
Definition: hd.c:6140
Definition: hd_int.h:101
void hd_move_to_shm(hd_data_t *hd_data)
Definition: hd.c:5648
Definition: hd.h:2084
int hd_is_shm_ptr(hd_data_t *hd_data, void *ptr)
Definition: hd.c:5614
char * hd_sysfs_dev2_name(char *str)
Definition: hd.c:6204
char * hd_sysfs_name2_dev(char *str)
Definition: hd.c:6183
hal_prop_t * hal_get_str(hal_prop_t *prop, const char *key)
Definition: hal.c:309
int hd_mod_cmp(char *str1, char *str2)
Definition: hd.c:6288
hal_device_t * hd_free_hal_devices(hal_device_t *dev)
Definition: hd.c:1100
void void hexdump(char **buf, int with_ascii, unsigned data_len, unsigned char *data)
Definition: hd.c:2464
Definition: hd_int.h:103
int load_module_with_params(hd_data_t *hd_data, char *module, char *params)
Definition: hd.c:3926
str_list_t * get_probe_val_list(hd_data_t *hd_data, enum probe_feature feature)
Definition: hd.c:426
void hd_shm_init(hd_data_t *hd_data)
Definition: hd.c:5515
driver_info_t * free_driver_info(driver_info_t *di)
Definition: hd.c:1119
int probe_module(hd_data_t *hd_data, char *module)
Definition: hd.c:3907
Definition: isdn_cdb_def.h:6
static char line[1024]
Definition: cdbisdn.c:29
void hd_fork(hd_data_t *hd_data, int timeout, int total_timeout)
Definition: hd.c:5362
void gather_resources(misc_t *m, hd_res_t **r, char *name, unsigned which)
Definition: misc.c:603
Definition: hd_int.h:99
void * hd_shm_add(hd_data_t *hd_data, void *ptr, unsigned len)
Definition: hd.c:5590
Definition: hd_int.h:103
void hd_pci_read_data(hd_data_t *hd_data)
Definition: pci.c:153
Definition: hd_int.h:99
Definition: hd_int.h:101
str_list_t * hd_attr_list(char *str)
Definition: hd.c:6158
Definition: hd_int.h:103
char * hd_get_hddb_path(char *sub)
Definition: hd.c:6127
static hd_data_t * hd_data
Definition: pppoe.c:30
void remove_tagged_hd_entries(hd_data_t *hd_data)
Definition: hd.c:2822
Definition: hd_int.h:100
void update_irq_usage(hd_data_t *hd_data)
Definition: hd.c:3859
Definition: hd_int.h:100
int detect_smp_prom(hd_data_t *hd_data)
PROM tree on PPC.
Definition: hd.h:1185
HAL device properties.
Definition: hd.h:1636
Definition: hd.h:1914
hd_res_t * free_res_list(hd_res_t *res)
Definition: hd.c:1743
Definition: hd_int.h:101
void hd_shm_clean(hd_data_t *hd_data)
Definition: hd.c:5555
#define add_hd_entry
Definition: hd_int.h:92
void read_udevinfo(hd_data_t *hd_data)
Definition: hd.c:5714
int cmp_hd(hd_t *hd1, hd_t *hd2)
Definition: hd.c:3969
int hd_timeout(void(*func)(void *), void *arg, int timeout)
Definition: hd.c:3584
void hal_invalidate_all(hal_prop_t *prop, const char *key)
Definition: hal.c:271
void str_printf(char **buf, int offset, char *format,...) __attribute__((format(printf
void progress(hd_data_t *hd_data, unsigned pos, unsigned count, char *msg)
Definition: hd.c:2745
hd_t * hd_find_sysfs_id_devname(hd_data_t *hd_data, char *id, char *devname)
Definition: hd.c:5825
void hd_log(hd_data_t *hd_data, char *buf, ssize_t len)
Definition: hd.c:2359
char * vend_id2str(unsigned vend)
Definition: hd.c:4499
void hd_pci_complete_data(hd_t *hd)
Definition: pci.c:488
Definition: hd_int.h:98
char * mod_name_by_idx(unsigned idx)
Definition: hd.c:2348
Definition: hd_int.h:98
Definition: hd_int.h:99
hd_res_t * add_res_entry(hd_res_t **res, hd_res_t *new_res)
Definition: hd.c:1793
void * add_mem(void *, size_t, size_t)
Definition: hd.c:1580
Definition: hd_int.h:99
char * hd_hal_print_prop(hal_prop_t *prop)
Definition: hal.c:439
unsigned char * read_block0(hd_data_t *hd_data, char *dev, int *timeout)
Definition: hd.c:4418
Definition: hd_int.h:101
void hd_log_printf(hd_data_t *hd_data, char *format,...) __attribute__((format(printf
void hd_sysfs_driver_list(hd_data_t *hd_data)
Definition: hd.c:5864
void hd_shm_done(hd_data_t *hd_data)
Definition: hd.c:5577
Definition: isdn_cdb_def.h:25
char * isa_id2str(unsigned)
Definition: hd.c:2163
char * get_sysfs_attr(const char *bus, const char *device, const char *attr)
Definition: hd.c:6222
Definition: hd_int.h:103
uint64_t size
Definition: hd.h:1167
char * get_sysfs_attr_by_path(const char *path, const char *attr)
Definition: hd.c:6238
Definition: hd_int.h:99
int is_pnpinfo(ser_device_t *mi, int ofs)
Definition: modem.c:852
int have_common_res(hd_res_t *res1, hd_res_t *res2)
Definition: hd.c:1709
int has_subcomponent(str_list_t *list, char *comp)
Definition: hd.c:2731
void * new_mem(size_t size)
Definition: hd.c:1552
void void hd_log_hex(hd_data_t *hd_data, int with_ascii, unsigned data_len, unsigned char *data)
Definition: hd.c:2401
Holds all data accumulated during hardware probing.
Definition: hd.h:2647
int is_pcmcia_ctrl(hd_data_t *hd_data, hd_t *hd)
Definition: hd.c:5260
Definition: hd_int.h:101
Definition: hd_int.h:98