]> mj.ucw.cz Git - pciutils.git/blob - lib/internal.h
libpci: Add constants for Lane Margining at the Receiver Extended Capability
[pciutils.git] / lib / internal.h
1 /*
2  *      The PCI Library -- Internal Stuff
3  *
4  *      Copyright (c) 1997--2022 Martin Mares <mj@ucw.cz>
5  *
6  *      Can be freely distributed and used under the terms of the GNU GPL v2+
7  *
8  *      SPDX-License-Identifier: GPL-2.0-or-later
9  */
10
11 #include "config.h"
12
13 #ifdef PCI_SHARED_LIB
14 #define PCI_ABI __attribute__((visibility("default")))
15 // Functions, which are bound to externally visible symbols by the versioning
16 // mechanism, have to be declared as VERSIONED. Otherwise, GCC with global
17 // optimizations is happy to optimize them away, leading to linker failures.
18 #define VERSIONED_ABI __attribute__((used)) PCI_ABI
19 #ifdef __APPLE__
20 #define STATIC_ALIAS(_decl, _for) VERSIONED_ABI _decl { return _for; }
21 #define DEFINE_ALIAS(_decl, _for)
22 #define SYMBOL_VERSION(_int, _ext)
23 #else
24 #define STATIC_ALIAS(_decl, _for)
25 #define DEFINE_ALIAS(_decl, _for) extern _decl __attribute__((alias(#_for))) VERSIONED_ABI
26 #ifdef _WIN32
27 /* GCC does not support asm .symver directive for Windows targets, so define new external global function symbol as alias to internal symbol */
28 #define SYMBOL_VERSION(_int, _ext) asm(".globl\t" PCI_STRINGIFY(__MINGW_USYMBOL(_ext)) "\n\t" \
29                                        ".def\t"   PCI_STRINGIFY(__MINGW_USYMBOL(_ext)) ";\t.scl\t2;\t.type\t32;\t.endef\n\t" \
30                                        ".set\t"   PCI_STRINGIFY(__MINGW_USYMBOL(_ext)) "," PCI_STRINGIFY(__MINGW_USYMBOL(_int)))
31 #else
32 #define SYMBOL_VERSION(_int, _ext) asm(".symver " #_int "," #_ext)
33 #endif
34 #endif
35 #else
36 #define VERSIONED_ABI
37 #define STATIC_ALIAS(_decl, _for) _decl { return _for; }
38 #define DEFINE_ALIAS(_decl, _for)
39 #define SYMBOL_VERSION(_int, _ext)
40 #endif
41
42 #include "pci.h"
43 #include "sysdep.h"
44
45 /* Old 32-bit-only versions of MinGW32 do not define __MINGW_USYMBOL macro */
46 #ifdef __MINGW32__
47 #ifndef __MINGW_USYMBOL
48 #define __MINGW_USYMBOL(sym) _##sym
49 #endif
50 #endif
51
52 #define _PCI_STRINGIFY(x) #x
53 #define PCI_STRINGIFY(x) _PCI_STRINGIFY(x)
54
55 struct pci_methods {
56   char *name;
57   char *help;
58   void (*config)(struct pci_access *);
59   int (*detect)(struct pci_access *);
60   void (*init)(struct pci_access *);
61   void (*cleanup)(struct pci_access *);
62   void (*scan)(struct pci_access *);
63   void (*fill_info)(struct pci_dev *, unsigned int flags);
64   int (*read)(struct pci_dev *, int pos, byte *buf, int len);
65   int (*write)(struct pci_dev *, int pos, byte *buf, int len);
66   int (*read_vpd)(struct pci_dev *, int pos, byte *buf, int len);
67   void (*init_dev)(struct pci_dev *);
68   void (*cleanup_dev)(struct pci_dev *);
69 };
70
71 /* generic.c */
72 void pci_generic_scan_bus(struct pci_access *, byte *busmap, int domain, int bus);
73 void pci_generic_scan_domain(struct pci_access *, int domain);
74 void pci_generic_scan(struct pci_access *);
75 void pci_generic_fill_info(struct pci_dev *, unsigned int flags);
76 int pci_generic_block_read(struct pci_dev *, int pos, byte *buf, int len);
77 int pci_generic_block_write(struct pci_dev *, int pos, byte *buf, int len);
78
79 /* emulated.c */
80 int pci_emulated_read(struct pci_dev *d, int pos, byte *buf, int len);
81
82 /* init.c */
83 void *pci_malloc(struct pci_access *, int);
84 void pci_mfree(void *);
85 char *pci_strdup(struct pci_access *a, const char *s);
86 struct pci_access *pci_clone_access(struct pci_access *a);
87 int pci_init_internal(struct pci_access *a, int skip_method);
88
89 void pci_init_v30(struct pci_access *a) VERSIONED_ABI;
90 void pci_init_v35(struct pci_access *a) VERSIONED_ABI;
91
92 /* access.c */
93 struct pci_dev *pci_alloc_dev(struct pci_access *);
94 int pci_link_dev(struct pci_access *, struct pci_dev *);
95
96 int pci_fill_info_v30(struct pci_dev *, int flags) VERSIONED_ABI;
97 int pci_fill_info_v31(struct pci_dev *, int flags) VERSIONED_ABI;
98 int pci_fill_info_v32(struct pci_dev *, int flags) VERSIONED_ABI;
99 int pci_fill_info_v33(struct pci_dev *, int flags) VERSIONED_ABI;
100 int pci_fill_info_v34(struct pci_dev *, int flags) VERSIONED_ABI;
101 int pci_fill_info_v35(struct pci_dev *, int flags) VERSIONED_ABI;
102 int pci_fill_info_v38(struct pci_dev *, int flags) VERSIONED_ABI;
103
104 static inline int want_fill(struct pci_dev *d, unsigned want_fields, unsigned int try_fields)
105 {
106   want_fields &= try_fields;
107   if ((d->known_fields & want_fields) == want_fields)
108     return 0;
109   else
110     {
111       d->known_fields |= try_fields;
112       return 1;
113     }
114 }
115
116 static inline void clear_fill(struct pci_dev *d, unsigned clear_fields)
117 {
118   d->known_fields &= ~clear_fields;
119 }
120
121 struct pci_property {
122   struct pci_property *next;
123   u32 key;
124   char value[1];
125 };
126
127 char *pci_set_property(struct pci_dev *d, u32 key, char *value);
128
129 /* params.c */
130 void pci_define_param(struct pci_access *acc, char *param, char *val, char *help);
131 int pci_set_param_internal(struct pci_access *acc, char *param, char *val, int copy);
132 void pci_free_params(struct pci_access *acc);
133
134 /* caps.c */
135 void pci_scan_caps(struct pci_dev *, unsigned int want_fields);
136 void pci_free_caps(struct pci_dev *);
137
138 extern struct pci_methods pm_intel_conf1, pm_intel_conf2, pm_linux_proc,
139         pm_fbsd_device, pm_aix_device, pm_nbsd_libpci, pm_obsd_device,
140         pm_dump, pm_linux_sysfs, pm_darwin, pm_sylixos_device, pm_hurd,
141         pm_mmio_conf1, pm_mmio_conf1_ext, pm_ecam,
142         pm_win32_cfgmgr32, pm_win32_kldbg, pm_win32_sysdbg;