summaryrefslogtreecommitdiffstats
path: root/src/include/ipxe/ecam_io.h
blob: 4fb24db33639c702ae614a8a22a3a241c5a4065e (plain) (blame)
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
#ifndef _IPXE_ECAM_IO_H
#define _IPXE_ECAM_IO_H

/** @file
 *
 * PCI I/O API for Enhanced Configuration Access Mechanism (ECAM)
 *
 */

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );

#include <stdint.h>

#ifdef PCIAPI_ECAM
#define PCIAPI_PREFIX_ecam
#else
#define PCIAPI_PREFIX_ecam __ecam_
#endif

struct pci_device;

/** Construct ECAM location */
#define ECAM_LOC( where, len ) ( ( (len) << 16 ) | where )

/** Extract offset from ECAM location */
#define ECAM_WHERE( location ) ( (location) & 0xffff )

/** Extract length from ECAM location */
#define ECAM_LEN( location ) ( (location) >> 16 )

extern int ecam_read ( struct pci_device *pci, unsigned int location,
		       void *value );
extern int ecam_write ( struct pci_device *pci, unsigned int location,
			unsigned long value );

/**
 * Read byte from PCI configuration space via ECAM
 *
 * @v pci	PCI device
 * @v where	Location within PCI configuration space
 * @v value	Value read
 * @ret rc	Return status code
 */
static inline __always_inline int
PCIAPI_INLINE ( ecam, pci_read_config_byte ) ( struct pci_device *pci,
					       unsigned int where,
					       uint8_t *value ) {
	return ecam_read ( pci, ECAM_LOC ( where, sizeof ( *value ) ), value );
}

/**
 * Read word from PCI configuration space via ECAM
 *
 * @v pci	PCI device
 * @v where	Location within PCI configuration space
 * @v value	Value read
 * @ret rc	Return status code
 */
static inline __always_inline int
PCIAPI_INLINE ( ecam, pci_read_config_word ) ( struct pci_device *pci,
					       unsigned int where,
					       uint16_t *value ) {
	return ecam_read ( pci, ECAM_LOC ( where, sizeof ( *value ) ), value );
}

/**
 * Read dword from PCI configuration space via ECAM
 *
 * @v pci	PCI device
 * @v where	Location within PCI configuration space
 * @v value	Value read
 * @ret rc	Return status code
 */
static inline __always_inline int
PCIAPI_INLINE ( ecam, pci_read_config_dword ) ( struct pci_device *pci,
						unsigned int where,
						uint32_t *value ) {
	return ecam_read ( pci, ECAM_LOC ( where, sizeof ( *value ) ), value );
}

/**
 * Write byte to PCI configuration space via ECAM
 *
 * @v pci	PCI device
 * @v where	Location within PCI configuration space
 * @v value	Value to be written
 * @ret rc	Return status code
 */
static inline __always_inline int
PCIAPI_INLINE ( ecam, pci_write_config_byte ) ( struct pci_device *pci,
						unsigned int where,
						uint8_t value ) {
	return ecam_write ( pci, ECAM_LOC ( where, sizeof ( value ) ), value );
}

/**
 * Write word to PCI configuration space via ECAM
 *
 * @v pci	PCI device
 * @v where	Location within PCI configuration space
 * @v value	Value to be written
 * @ret rc	Return status code
 */
static inline __always_inline int
PCIAPI_INLINE ( ecam, pci_write_config_word ) ( struct pci_device *pci,
						unsigned int where,
						uint16_t value ) {
	return ecam_write ( pci, ECAM_LOC ( where, sizeof ( value ) ), value );
}

/**
 * Write dword to PCI configuration space via ECAM
 *
 * @v pci	PCI device
 * @v where	Location within PCI configuration space
 * @v value	Value to be written
 * @ret rc	Return status code
 */
static inline __always_inline int
PCIAPI_INLINE ( ecam, pci_write_config_dword ) ( struct pci_device *pci,
						 unsigned int where,
						 uint32_t value ) {
	return ecam_write ( pci, ECAM_LOC ( where, sizeof ( value ) ), value );
}

/**
 * Map PCI bus address as an I/O address
 *
 * @v bus_addr		PCI bus address
 * @v len		Length of region
 * @ret io_addr		I/O address, or NULL on error
 */
static inline __always_inline void *
PCIAPI_INLINE ( ecam, pci_ioremap ) ( struct pci_device *pci __unused,
				      unsigned long bus_addr, size_t len ) {
	return ioremap ( bus_addr, len );
}

#endif /* _IPXE_ECAM_IO_H */