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