pciif.h revision 181624
1/*
2 * PCI Backend/Frontend Common Data Structures & Macros
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to
6 * deal in the Software without restriction, including without limitation the
7 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8 * sell copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20 * DEALINGS IN THE SOFTWARE.
21 *
22 *   Author: Ryan Wilson <hap9@epoch.ncsc.mil>
23 */
24#ifndef __XEN_PCI_COMMON_H__
25#define __XEN_PCI_COMMON_H__
26
27/* Be sure to bump this number if you change this file */
28#define XEN_PCI_MAGIC "7"
29
30/* xen_pci_sharedinfo flags */
31#define _XEN_PCIF_active     (0)
32#define XEN_PCIF_active      (1<<_XEN_PCI_active)
33
34/* xen_pci_op commands */
35#define XEN_PCI_OP_conf_read    (0)
36#define XEN_PCI_OP_conf_write   (1)
37
38/* xen_pci_op error numbers */
39#define XEN_PCI_ERR_success          (0)
40#define XEN_PCI_ERR_dev_not_found   (-1)
41#define XEN_PCI_ERR_invalid_offset  (-2)
42#define XEN_PCI_ERR_access_denied   (-3)
43#define XEN_PCI_ERR_not_implemented (-4)
44/* XEN_PCI_ERR_op_failed - backend failed to complete the operation */
45#define XEN_PCI_ERR_op_failed       (-5)
46
47struct xen_pci_op {
48    /* IN: what action to perform: XEN_PCI_OP_* */
49    uint32_t cmd;
50
51    /* OUT: will contain an error number (if any) from errno.h */
52    int32_t err;
53
54    /* IN: which device to touch */
55    uint32_t domain; /* PCI Domain/Segment */
56    uint32_t bus;
57    uint32_t devfn;
58
59    /* IN: which configuration registers to touch */
60    int32_t offset;
61    int32_t size;
62
63    /* IN/OUT: Contains the result after a READ or the value to WRITE */
64    uint32_t value;
65};
66
67struct xen_pci_sharedinfo {
68    /* flags - XEN_PCIF_* */
69    uint32_t flags;
70    struct xen_pci_op op;
71};
72
73#endif /* __XEN_PCI_COMMON_H__ */
74
75/*
76 * Local variables:
77 * mode: C
78 * c-set-style: "BSD"
79 * c-basic-offset: 4
80 * tab-width: 4
81 * indent-tabs-mode: nil
82 * End:
83 */
84