Blame view

RIOT/cpu/x86/include/x86_pci_strings.h 2.02 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
  /*
   * Copyright (C) 2014  René Kijewski  <rene.kijewski@fu-berlin.de>
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   * Lesser General Public License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
   */
  
  /**
   * The string representation of PCI constants. For humans.
   *
   * @ingroup x86-irq
   * @{
   * @file
   * @author  René Kijewski <rene.kijewski@fu-berlin.de>
   */
  
  #ifndef X86_PCI_STRINGS_H
  #define X86_PCI_STRINGS_H
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief        Get a string representation of the device class.
   * @param[out]   baseclass_name   Name of the base class. Supply NULL if you do not care.
   * @return       A string (lengthy text) that describes the device class.
   *
   * If the device class is unknown, then the hexadecimal value is returned.
   * This function is not thread safe.
   */
  const char *x86_pci_subclass_to_string(unsigned baseclass, unsigned subclass, unsigned interface, const char **baseclass_name);
  
  /**
   * @brief        Get a string representation of the device name.
   * @param[out]   vendor_name   Name of the device vendor. Supply NULL if you do not care.
   * @return       A string that tells the device name.
   *
   * If the device ID is unknown, then the hexadecimal value is returned.
   * This function is not thread safe.
   */
  const char *x86_pci_device_id_to_string(unsigned vendor_id, unsigned device_id, const char **vendor_name);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* X86_PCI_STRINGS_H */
  
  /** @} */