2 * QEMU model of Xilinx AXI-DMA block.
4 * Copyright (c) 2011 Edgar E. Iglesias.
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
26 #include "hw/sysbus.h"
27 #include "qapi/error.h"
28 #include "qemu/timer.h"
31 #include "hw/ptimer.h"
32 #include "hw/qdev-properties.h"
34 #include "qemu/module.h"
36 #include "sysemu/dma.h"
37 #include "hw/stream.h"
38 #include "qom/object.h"
42 #define TYPE_XILINX_AXI_DMA "xlnx.axi-dma"
43 #define TYPE_XILINX_AXI_DMA_DATA_STREAM "xilinx-axi-dma-data-stream"
44 #define TYPE_XILINX_AXI_DMA_CONTROL_STREAM "xilinx-axi-dma-control-stream"
46 OBJECT_DECLARE_SIMPLE_TYPE(XilinxAXIDMA
, XILINX_AXI_DMA
)
48 typedef struct XilinxAXIDMAStreamSink XilinxAXIDMAStreamSink
;
49 DECLARE_INSTANCE_CHECKER(XilinxAXIDMAStreamSink
, XILINX_AXI_DMA_DATA_STREAM
,
50 TYPE_XILINX_AXI_DMA_DATA_STREAM
)
52 DECLARE_INSTANCE_CHECKER(XilinxAXIDMAStreamSink
, XILINX_AXI_DMA_CONTROL_STREAM
,
53 TYPE_XILINX_AXI_DMA_CONTROL_STREAM
)
55 #define R_DMACR (0x00 / 4)
56 #define R_DMASR (0x04 / 4)
57 #define R_CURDESC (0x08 / 4)
58 #define R_TAILDESC (0x10 / 4)
59 #define R_MAX (0x30 / 4)
61 #define CONTROL_PAYLOAD_WORDS 5
62 #define CONTROL_PAYLOAD_SIZE (CONTROL_PAYLOAD_WORDS * (sizeof(uint32_t)))
67 DMACR_TAILPTR_MODE
= 2,
74 DMASR_IOC_IRQ
= 1 << 12,
75 DMASR_DLY_IRQ
= 1 << 13,
77 DMASR_IRQ_MASK
= 7 << 12
82 uint64_t buffer_address
;
86 uint8_t app
[CONTROL_PAYLOAD_SIZE
];
90 SDESC_CTRL_EOF
= (1 << 26),
91 SDESC_CTRL_SOF
= (1 << 27),
93 SDESC_CTRL_LEN_MASK
= (1 << 23) - 1
97 SDESC_STATUS_EOF
= (1 << 26),
98 SDESC_STATUS_SOF_BIT
= 27,
99 SDESC_STATUS_SOF
= (1 << SDESC_STATUS_SOF_BIT
),
100 SDESC_STATUS_COMPLETE
= (1 << 31)
104 struct XilinxAXIDMA
*dma
;
105 ptimer_state
*ptimer
;
112 unsigned int complete_cnt
;
113 uint32_t regs
[R_MAX
];
115 unsigned char txbuf
[16 * 1024];
118 struct XilinxAXIDMAStreamSink
{
121 struct XilinxAXIDMA
*dma
;
124 struct XilinxAXIDMA
{
127 MemoryRegion
*dma_mr
;
131 StreamSink
*tx_data_dev
;
132 StreamSink
*tx_control_dev
;
133 XilinxAXIDMAStreamSink rx_data_dev
;
134 XilinxAXIDMAStreamSink rx_control_dev
;
136 struct Stream streams
[2];
138 StreamCanPushNotifyFn notify
;
143 * Helper calls to extract info from descriptors and other trivial
146 static inline int stream_desc_sof(struct SDesc
*d
)
148 return d
->control
& SDESC_CTRL_SOF
;
151 static inline int stream_desc_eof(struct SDesc
*d
)
153 return d
->control
& SDESC_CTRL_EOF
;
156 static inline int stream_resetting(struct Stream
*s
)
158 return !!(s
->regs
[R_DMACR
] & DMACR_RESET
);
161 static inline int stream_running(struct Stream
*s
)
163 return s
->regs
[R_DMACR
] & DMACR_RUNSTOP
;
166 static inline int stream_idle(struct Stream
*s
)
168 return !!(s
->regs
[R_DMASR
] & DMASR_IDLE
);
171 static inline int stream_halted(struct Stream
*s
)
173 return !!(s
->regs
[R_DMASR
] & DMASR_HALTED
);
176 static void stream_reset(struct Stream
*s
)
178 s
->regs
[R_DMASR
] = DMASR_HALTED
; /* starts up halted. */
179 s
->regs
[R_DMACR
] = 1 << 16; /* Starts with one in compl threshold. */
183 /* Map an offset addr into a channel index. */
184 static inline int streamid_from_addr(hwaddr addr
)
193 static void stream_desc_load(struct Stream
*s
, hwaddr addr
)
195 struct SDesc
*d
= &s
->desc
;
197 address_space_read(&s
->dma
->as
, addr
, MEMTXATTRS_UNSPECIFIED
, d
, sizeof *d
);
199 /* Convert from LE into host endianness. */
200 d
->buffer_address
= le64_to_cpu(d
->buffer_address
);
201 d
->nxtdesc
= le64_to_cpu(d
->nxtdesc
);
202 d
->control
= le32_to_cpu(d
->control
);
203 d
->status
= le32_to_cpu(d
->status
);
206 static void stream_desc_store(struct Stream
*s
, hwaddr addr
)
208 struct SDesc
*d
= &s
->desc
;
210 /* Convert from host endianness into LE. */
211 d
->buffer_address
= cpu_to_le64(d
->buffer_address
);
212 d
->nxtdesc
= cpu_to_le64(d
->nxtdesc
);
213 d
->control
= cpu_to_le32(d
->control
);
214 d
->status
= cpu_to_le32(d
->status
);
215 address_space_write(&s
->dma
->as
, addr
, MEMTXATTRS_UNSPECIFIED
,
219 static void stream_update_irq(struct Stream
*s
)
221 unsigned int pending
, mask
, irq
;
223 pending
= s
->regs
[R_DMASR
] & DMASR_IRQ_MASK
;
224 mask
= s
->regs
[R_DMACR
] & DMASR_IRQ_MASK
;
226 irq
= pending
& mask
;
228 qemu_set_irq(s
->irq
, !!irq
);
231 static void stream_reload_complete_cnt(struct Stream
*s
)
233 unsigned int comp_th
;
234 comp_th
= (s
->regs
[R_DMACR
] >> 16) & 0xff;
235 s
->complete_cnt
= comp_th
;
238 static void timer_hit(void *opaque
)
240 struct Stream
*s
= opaque
;
242 stream_reload_complete_cnt(s
);
243 s
->regs
[R_DMASR
] |= DMASR_DLY_IRQ
;
244 stream_update_irq(s
);
247 static void stream_complete(struct Stream
*s
)
249 unsigned int comp_delay
;
251 /* Start the delayed timer. */
252 ptimer_transaction_begin(s
->ptimer
);
253 comp_delay
= s
->regs
[R_DMACR
] >> 24;
255 ptimer_stop(s
->ptimer
);
256 ptimer_set_count(s
->ptimer
, comp_delay
);
257 ptimer_run(s
->ptimer
, 1);
261 if (s
->complete_cnt
== 0) {
262 /* Raise the IOC irq. */
263 s
->regs
[R_DMASR
] |= DMASR_IOC_IRQ
;
264 stream_reload_complete_cnt(s
);
266 ptimer_transaction_commit(s
->ptimer
);
269 static void stream_process_mem2s(struct Stream
*s
, StreamSink
*tx_data_dev
,
270 StreamSink
*tx_control_dev
)
277 if (!stream_running(s
) || stream_idle(s
) || stream_halted(s
)) {
282 stream_desc_load(s
, s
->regs
[R_CURDESC
]);
284 if (s
->desc
.status
& SDESC_STATUS_COMPLETE
) {
285 s
->regs
[R_DMASR
] |= DMASR_HALTED
;
289 if (stream_desc_sof(&s
->desc
)) {
290 stream_push(tx_control_dev
, s
->desc
.app
, sizeof(s
->desc
.app
), true);
293 txlen
= s
->desc
.control
& SDESC_CTRL_LEN_MASK
;
295 eop
= stream_desc_eof(&s
->desc
);
296 addr
= s
->desc
.buffer_address
;
300 len
= txlen
> sizeof s
->txbuf
? sizeof s
->txbuf
: txlen
;
301 address_space_read(&s
->dma
->as
, addr
,
302 MEMTXATTRS_UNSPECIFIED
,
304 stream_push(tx_data_dev
, s
->txbuf
, len
, eop
&& len
== txlen
);
313 /* Update the descriptor. */
314 s
->desc
.status
= txlen
| SDESC_STATUS_COMPLETE
;
315 stream_desc_store(s
, s
->regs
[R_CURDESC
]);
318 prev_d
= s
->regs
[R_CURDESC
];
319 s
->regs
[R_CURDESC
] = s
->desc
.nxtdesc
;
320 if (prev_d
== s
->regs
[R_TAILDESC
]) {
321 s
->regs
[R_DMASR
] |= DMASR_IDLE
;
327 static size_t stream_process_s2mem(struct Stream
*s
, unsigned char *buf
,
328 size_t len
, bool eop
)
334 if (!stream_running(s
) || stream_idle(s
) || stream_halted(s
)) {
339 stream_desc_load(s
, s
->regs
[R_CURDESC
]);
341 if (s
->desc
.status
& SDESC_STATUS_COMPLETE
) {
342 s
->regs
[R_DMASR
] |= DMASR_HALTED
;
346 rxlen
= s
->desc
.control
& SDESC_CTRL_LEN_MASK
;
352 address_space_write(&s
->dma
->as
, s
->desc
.buffer_address
,
353 MEMTXATTRS_UNSPECIFIED
, buf
+ pos
, rxlen
);
357 /* Update the descriptor. */
360 memcpy(s
->desc
.app
, s
->app
, sizeof(s
->desc
.app
));
361 s
->desc
.status
|= SDESC_STATUS_EOF
;
364 s
->desc
.status
|= s
->sof
<< SDESC_STATUS_SOF_BIT
;
365 s
->desc
.status
|= SDESC_STATUS_COMPLETE
;
366 stream_desc_store(s
, s
->regs
[R_CURDESC
]);
370 prev_d
= s
->regs
[R_CURDESC
];
371 s
->regs
[R_CURDESC
] = s
->desc
.nxtdesc
;
372 if (prev_d
== s
->regs
[R_TAILDESC
]) {
373 s
->regs
[R_DMASR
] |= DMASR_IDLE
;
381 static void xilinx_axidma_reset(DeviceState
*dev
)
384 XilinxAXIDMA
*s
= XILINX_AXI_DMA(dev
);
386 for (i
= 0; i
< 2; i
++) {
387 stream_reset(&s
->streams
[i
]);
392 xilinx_axidma_control_stream_push(StreamSink
*obj
, unsigned char *buf
,
393 size_t len
, bool eop
)
395 XilinxAXIDMAStreamSink
*cs
= XILINX_AXI_DMA_CONTROL_STREAM(obj
);
396 struct Stream
*s
= &cs
->dma
->streams
[1];
398 if (len
!= CONTROL_PAYLOAD_SIZE
) {
399 hw_error("AXI DMA requires %d byte control stream payload\n",
400 (int)CONTROL_PAYLOAD_SIZE
);
403 memcpy(s
->app
, buf
, len
);
408 xilinx_axidma_data_stream_can_push(StreamSink
*obj
,
409 StreamCanPushNotifyFn notify
,
412 XilinxAXIDMAStreamSink
*ds
= XILINX_AXI_DMA_DATA_STREAM(obj
);
413 struct Stream
*s
= &ds
->dma
->streams
[1];
415 if (!stream_running(s
) || stream_idle(s
) || stream_halted(s
)) {
416 ds
->dma
->notify
= notify
;
417 ds
->dma
->notify_opaque
= notify_opaque
;
425 xilinx_axidma_data_stream_push(StreamSink
*obj
, unsigned char *buf
, size_t len
,
428 XilinxAXIDMAStreamSink
*ds
= XILINX_AXI_DMA_DATA_STREAM(obj
);
429 struct Stream
*s
= &ds
->dma
->streams
[1];
432 ret
= stream_process_s2mem(s
, buf
, len
, eop
);
433 stream_update_irq(s
);
437 static uint64_t axidma_read(void *opaque
, hwaddr addr
,
440 XilinxAXIDMA
*d
= opaque
;
445 sid
= streamid_from_addr(addr
);
446 s
= &d
->streams
[sid
];
452 /* Simulate one cycles reset delay. */
453 s
->regs
[addr
] &= ~DMACR_RESET
;
457 s
->regs
[addr
] &= 0xffff;
458 s
->regs
[addr
] |= (s
->complete_cnt
& 0xff) << 16;
459 s
->regs
[addr
] |= (ptimer_get_count(s
->ptimer
) & 0xff) << 24;
464 D(qemu_log("%s ch=%d addr=" HWADDR_FMT_plx
" v=%x\n",
465 __func__
, sid
, addr
* 4, r
));
472 static void axidma_write(void *opaque
, hwaddr addr
,
473 uint64_t value
, unsigned size
)
475 XilinxAXIDMA
*d
= opaque
;
479 sid
= streamid_from_addr(addr
);
480 s
= &d
->streams
[sid
];
486 /* Tailptr mode is always on. */
487 value
|= DMACR_TAILPTR_MODE
;
488 /* Remember our previous reset state. */
489 value
|= (s
->regs
[addr
] & DMACR_RESET
);
490 s
->regs
[addr
] = value
;
492 if (value
& DMACR_RESET
) {
496 if ((value
& 1) && !stream_resetting(s
)) {
497 /* Start processing. */
498 s
->regs
[R_DMASR
] &= ~(DMASR_HALTED
| DMASR_IDLE
);
500 stream_reload_complete_cnt(s
);
504 /* Mask away write to clear irq lines. */
505 value
&= ~(value
& DMASR_IRQ_MASK
);
506 s
->regs
[addr
] = value
;
510 s
->regs
[addr
] = value
;
511 s
->regs
[R_DMASR
] &= ~DMASR_IDLE
; /* Not idle. */
513 stream_process_mem2s(s
, d
->tx_data_dev
, d
->tx_control_dev
);
517 D(qemu_log("%s: ch=%d addr=" HWADDR_FMT_plx
" v=%x\n",
518 __func__
, sid
, addr
* 4, (unsigned)value
));
519 s
->regs
[addr
] = value
;
522 if (sid
== 1 && d
->notify
) {
523 StreamCanPushNotifyFn notifytmp
= d
->notify
;
525 notifytmp(d
->notify_opaque
);
527 stream_update_irq(s
);
530 static const MemoryRegionOps axidma_ops
= {
532 .write
= axidma_write
,
533 .endianness
= DEVICE_NATIVE_ENDIAN
,
536 static void xilinx_axidma_realize(DeviceState
*dev
, Error
**errp
)
538 XilinxAXIDMA
*s
= XILINX_AXI_DMA(dev
);
539 XilinxAXIDMAStreamSink
*ds
= XILINX_AXI_DMA_DATA_STREAM(&s
->rx_data_dev
);
540 XilinxAXIDMAStreamSink
*cs
= XILINX_AXI_DMA_CONTROL_STREAM(
544 object_property_add_link(OBJECT(ds
), "dma", TYPE_XILINX_AXI_DMA
,
546 object_property_allow_set_link
,
547 OBJ_PROP_LINK_STRONG
);
548 object_property_add_link(OBJECT(cs
), "dma", TYPE_XILINX_AXI_DMA
,
550 object_property_allow_set_link
,
551 OBJ_PROP_LINK_STRONG
);
552 object_property_set_link(OBJECT(ds
), "dma", OBJECT(s
), &error_abort
);
553 object_property_set_link(OBJECT(cs
), "dma", OBJECT(s
), &error_abort
);
555 for (i
= 0; i
< 2; i
++) {
556 struct Stream
*st
= &s
->streams
[i
];
560 st
->ptimer
= ptimer_init(timer_hit
, st
, PTIMER_POLICY_LEGACY
);
561 ptimer_transaction_begin(st
->ptimer
);
562 ptimer_set_freq(st
->ptimer
, s
->freqhz
);
563 ptimer_transaction_commit(st
->ptimer
);
566 address_space_init(&s
->as
,
567 s
->dma_mr
? s
->dma_mr
: get_system_memory(), "dma");
570 static void xilinx_axidma_init(Object
*obj
)
572 XilinxAXIDMA
*s
= XILINX_AXI_DMA(obj
);
573 SysBusDevice
*sbd
= SYS_BUS_DEVICE(obj
);
575 object_initialize_child(OBJECT(s
), "axistream-connected-target",
576 &s
->rx_data_dev
, TYPE_XILINX_AXI_DMA_DATA_STREAM
);
577 object_initialize_child(OBJECT(s
), "axistream-control-connected-target",
579 TYPE_XILINX_AXI_DMA_CONTROL_STREAM
);
580 object_property_add_link(obj
, "dma", TYPE_MEMORY_REGION
,
581 (Object
**)&s
->dma_mr
,
582 qdev_prop_allow_set_link_before_realize
,
583 OBJ_PROP_LINK_STRONG
);
585 sysbus_init_irq(sbd
, &s
->streams
[0].irq
);
586 sysbus_init_irq(sbd
, &s
->streams
[1].irq
);
588 memory_region_init_io(&s
->iomem
, obj
, &axidma_ops
, s
,
589 "xlnx.axi-dma", R_MAX
* 4 * 2);
590 sysbus_init_mmio(sbd
, &s
->iomem
);
593 static Property axidma_properties
[] = {
594 DEFINE_PROP_UINT32("freqhz", XilinxAXIDMA
, freqhz
, 50000000),
595 DEFINE_PROP_LINK("axistream-connected", XilinxAXIDMA
,
596 tx_data_dev
, TYPE_STREAM_SINK
, StreamSink
*),
597 DEFINE_PROP_LINK("axistream-control-connected", XilinxAXIDMA
,
598 tx_control_dev
, TYPE_STREAM_SINK
, StreamSink
*),
599 DEFINE_PROP_END_OF_LIST(),
602 static void axidma_class_init(ObjectClass
*klass
, void *data
)
604 DeviceClass
*dc
= DEVICE_CLASS(klass
);
606 dc
->realize
= xilinx_axidma_realize
,
607 dc
->reset
= xilinx_axidma_reset
;
608 device_class_set_props(dc
, axidma_properties
);
611 static StreamSinkClass xilinx_axidma_data_stream_class
= {
612 .push
= xilinx_axidma_data_stream_push
,
613 .can_push
= xilinx_axidma_data_stream_can_push
,
616 static StreamSinkClass xilinx_axidma_control_stream_class
= {
617 .push
= xilinx_axidma_control_stream_push
,
620 static void xilinx_axidma_stream_class_init(ObjectClass
*klass
, void *data
)
622 StreamSinkClass
*ssc
= STREAM_SINK_CLASS(klass
);
624 ssc
->push
= ((StreamSinkClass
*)data
)->push
;
625 ssc
->can_push
= ((StreamSinkClass
*)data
)->can_push
;
628 static const TypeInfo axidma_info
= {
629 .name
= TYPE_XILINX_AXI_DMA
,
630 .parent
= TYPE_SYS_BUS_DEVICE
,
631 .instance_size
= sizeof(XilinxAXIDMA
),
632 .class_init
= axidma_class_init
,
633 .instance_init
= xilinx_axidma_init
,
636 static const TypeInfo xilinx_axidma_data_stream_info
= {
637 .name
= TYPE_XILINX_AXI_DMA_DATA_STREAM
,
638 .parent
= TYPE_OBJECT
,
639 .instance_size
= sizeof(XilinxAXIDMAStreamSink
),
640 .class_init
= xilinx_axidma_stream_class_init
,
641 .class_data
= &xilinx_axidma_data_stream_class
,
642 .interfaces
= (InterfaceInfo
[]) {
643 { TYPE_STREAM_SINK
},
648 static const TypeInfo xilinx_axidma_control_stream_info
= {
649 .name
= TYPE_XILINX_AXI_DMA_CONTROL_STREAM
,
650 .parent
= TYPE_OBJECT
,
651 .instance_size
= sizeof(XilinxAXIDMAStreamSink
),
652 .class_init
= xilinx_axidma_stream_class_init
,
653 .class_data
= &xilinx_axidma_control_stream_class
,
654 .interfaces
= (InterfaceInfo
[]) {
655 { TYPE_STREAM_SINK
},
660 static void xilinx_axidma_register_types(void)
662 type_register_static(&axidma_info
);
663 type_register_static(&xilinx_axidma_data_stream_info
);
664 type_register_static(&xilinx_axidma_control_stream_info
);
667 type_init(xilinx_axidma_register_types
)