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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
#ifndef _IPXE_DMA_H
#define _IPXE_DMA_H
/** @file
*
* DMA mappings
*
*/
FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
#include <stdint.h>
#include <ipxe/api.h>
#include <ipxe/io.h>
#include <ipxe/iobuf.h>
#include <ipxe/malloc.h>
#include <config/ioapi.h>
#ifdef DMAAPI_OP
#define DMAAPI_PREFIX_op
#else
#define DMAAPI_PREFIX_op __op_
#endif
#ifdef DMAAPI_FLAT
#define DMAAPI_PREFIX_flat
#else
#define DMAAPI_PREFIX_flat __flat_
#endif
/** A DMA mapping */
struct dma_mapping {
/** Device-side address */
physaddr_t addr;
/** Platform mapping token */
void *token;
};
/** A DMA-capable device */
struct dma_device {
/** DMA operations */
struct dma_operations *op;
/** Addressable space mask */
physaddr_t mask;
/** Total number of mappings (for debugging) */
unsigned int mapped;
/** Total number of allocations (for debugging) */
unsigned int allocated;
};
/** DMA operations */
struct dma_operations {
/**
* Map buffer for DMA
*
* @v dma DMA device
* @v addr Buffer address
* @v len Length of buffer
* @v flags Mapping flags
* @v map DMA mapping to fill in
* @ret rc Return status code
*/
int ( * map ) ( struct dma_device *dma, physaddr_t addr, size_t len,
int flags, struct dma_mapping *map );
/**
* Unmap buffer
*
* @v dma DMA device
* @v map DMA mapping
*/
void ( * unmap ) ( struct dma_device *dma, struct dma_mapping *map );
/**
* Allocate and map DMA-coherent buffer
*
* @v dma DMA device
* @v len Length of buffer
* @v align Physical alignment
* @v map DMA mapping to fill in
* @ret addr Buffer address, or NULL on error
*/
void * ( * alloc ) ( struct dma_device *dma, size_t len, size_t align,
struct dma_mapping *map );
/**
* Unmap and free DMA-coherent buffer
*
* @v dma DMA device
* @v addr Buffer address
* @v len Length of buffer
* @v map DMA mapping
*/
void ( * free ) ( struct dma_device *dma, void *addr, size_t len,
struct dma_mapping *map );
/**
* Set addressable space mask
*
* @v dma DMA device
* @v mask Addressable space mask
*/
void ( * set_mask ) ( struct dma_device *dma, physaddr_t mask );
};
/** Device will read data from host memory */
#define DMA_TX 0x01
/** Device will write data to host memory */
#define DMA_RX 0x02
/** Device will both read data from and write data to host memory */
#define DMA_BI ( DMA_TX | DMA_RX )
/**
* Calculate static inline DMA I/O API function name
*
* @v _prefix Subsystem prefix
* @v _api_func API function
* @ret _subsys_func Subsystem API function
*/
#define DMAAPI_INLINE( _subsys, _api_func ) \
SINGLE_API_INLINE ( DMAAPI_PREFIX_ ## _subsys, _api_func )
/**
* Provide a DMA I/O API implementation
*
* @v _prefix Subsystem prefix
* @v _api_func API function
* @v _func Implementing function
*/
#define PROVIDE_DMAAPI( _subsys, _api_func, _func ) \
PROVIDE_SINGLE_API ( DMAAPI_PREFIX_ ## _subsys, _api_func, _func )
/**
* Provide a static inline DMA I/O API implementation
*
* @v _prefix Subsystem prefix
* @v _api_func API function
*/
#define PROVIDE_DMAAPI_INLINE( _subsys, _api_func ) \
PROVIDE_SINGLE_API_INLINE ( DMAAPI_PREFIX_ ## _subsys, _api_func )
/**
* Map buffer for DMA
*
* @v dma DMA device
* @v addr Buffer address
* @v len Length of buffer
* @v flags Mapping flags
* @v map DMA mapping to fill in
* @ret rc Return status code
*/
static inline __always_inline int
DMAAPI_INLINE ( flat, dma_map ) ( struct dma_device *dma, physaddr_t addr,
size_t len __unused, int flags __unused,
struct dma_mapping *map ) {
/* Use physical address as device address */
map->addr = addr;
/* Increment mapping count (for debugging) */
if ( DBG_LOG )
dma->mapped++;
return 0;
}
/**
* Unmap buffer
*
* @v dma DMA device
* @v map DMA mapping
*/
static inline __always_inline void
DMAAPI_INLINE ( flat, dma_unmap ) ( struct dma_device *dma,
struct dma_mapping *map __unused ) {
/* Decrement mapping count (for debugging) */
if ( DBG_LOG )
dma->mapped--;
}
/**
* Allocate and map DMA-coherent buffer
*
* @v dma DMA device
* @v len Length of buffer
* @v align Physical alignment
* @v map DMA mapping to fill in
* @ret addr Buffer address, or NULL on error
*/
static inline __always_inline void *
DMAAPI_INLINE ( flat, dma_alloc ) ( struct dma_device *dma, size_t len,
size_t align, struct dma_mapping *map ) {
void *addr;
/* Allocate buffer */
addr = malloc_phys ( len, align );
map->addr = virt_to_phys ( addr );
/* Increment allocation count (for debugging) */
if ( DBG_LOG && addr )
dma->allocated++;
return addr;
}
/**
* Unmap and free DMA-coherent buffer
*
* @v dma DMA device
* @v addr Buffer address
* @v len Length of buffer
* @v map DMA mapping
*/
static inline __always_inline void
DMAAPI_INLINE ( flat, dma_free ) ( struct dma_device *dma,
void *addr, size_t len,
struct dma_mapping *map __unused ) {
/* Free buffer */
free_phys ( addr, len );
/* Decrement allocation count (for debugging) */
if ( DBG_LOG )
dma->allocated--;
}
/**
* Set addressable space mask
*
* @v dma DMA device
* @v mask Addressable space mask
*/
static inline __always_inline void
DMAAPI_INLINE ( flat, dma_set_mask ) ( struct dma_device *dma __unused,
physaddr_t mask __unused ) {
/* Nothing to do */
}
/**
* Map buffer for DMA
*
* @v dma DMA device
* @v addr Buffer address
* @v len Length of buffer
* @v flags Mapping flags
* @v map DMA mapping to fill in
* @ret rc Return status code
*/
int dma_map ( struct dma_device *dma, physaddr_t addr, size_t len,
int flags, struct dma_mapping *map );
/**
* Unmap buffer
*
* @v dma DMA device
* @v map DMA mapping
*/
void dma_unmap ( struct dma_device *dma, struct dma_mapping *map );
/**
* Allocate and map DMA-coherent buffer
*
* @v dma DMA device
* @v len Length of buffer
* @v align Physical alignment
* @v map DMA mapping to fill in
* @ret addr Buffer address, or NULL on error
*/
void * dma_alloc ( struct dma_device *dma, size_t len, size_t align,
struct dma_mapping *map );
/**
* Unmap and free DMA-coherent buffer
*
* @v dma DMA device
* @v addr Buffer address
* @v len Length of buffer
* @v map DMA mapping
*/
void dma_free ( struct dma_device *dma, void *addr, size_t len,
struct dma_mapping *map );
/**
* Set addressable space mask
*
* @v dma DMA device
* @v mask Addressable space mask
*/
void dma_set_mask ( struct dma_device *dma, physaddr_t mask );
/**
* Initialise DMA device
*
* @v dma DMA device
* @v op DMA operations
*/
static inline __always_inline void dma_init ( struct dma_device *dma,
struct dma_operations *op ) {
/* Set operations table */
dma->op = op;
}
/**
* Set 64-bit addressable space mask
*
* @v dma DMA device
*/
static inline __always_inline void
dma_set_mask_64bit ( struct dma_device *dma ) {
/* Set mask to maximum physical address */
dma_set_mask ( dma, ~( ( physaddr_t ) 0 ) );
}
/**
* Map I/O buffer for transmitting data to device
*
* @v dma DMA device
* @v iobuf I/O buffer
* @v map DMA mapping to fill in
* @ret rc Return status code
*/
static inline __always_inline int
dma_map_tx_iob ( struct dma_device *dma, struct io_buffer *iobuf,
struct dma_mapping *map ) {
/* Map I/O buffer */
return dma_map ( dma, virt_to_phys ( iobuf->data ), iob_len ( iobuf ),
DMA_TX, map );
}
extern struct io_buffer * dma_alloc_rx_iob ( struct dma_device *dma, size_t len,
struct dma_mapping *map );
#endif /* _IPXE_DMA_H */
|
