Halide
HalideRuntimeHexagonDma.h
Go to the documentation of this file.
1 #ifndef HALIDE_HALIDERUNTIMEHEXAGONDMA_H
2 #define HALIDE_HALIDERUNTIMEHEXAGONDMA_H
3 
4 /** \file
5  * Routines specific to the Halide Hexagon DMA host-side runtime.
6  */
7 
8 // Don't include HalideRuntime.h if the contents of it were already pasted into a generated header above this one
9 #ifndef HALIDE_HALIDERUNTIME_H
10 
11 #include "HalideRuntime.h"
12 
13 #endif
14 
15 // Don't include HalideRuntimeHexagonHost.h if the contents of it were already pasted into a generated header above this one
16 #ifndef HALIDE_HALIDERUNTIMEHEXAGONHOST_H
17 
19 
20 #endif
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
26 /**
27  * \defgroup rt_hexagon_dma Halide Hexagon DMA runtime
28  * @{
29  */
30 
31 /**
32  * Image Formats to prepare the application for DMA Transfer
33  */
34 typedef enum {
49 
51 
52 /** This API is used to set up the DMA device interface to be used for DMA transfer. This also internally
53  * creates the DMA device handle and populates all the Buffer releated parameters (width, height, stride)
54  * to be used for DMA configuration.
55  */
57  uint64_t mem);
58 
59 /** Detach the Input/Output Buffer from DMA device handle and deallocate the DMA device handle buffer allocation
60  * This API also frees up the DMA device and makes it available for another usage.
61  */
63 
64 /** This API will allocate a DMA Engine needed for DMA read/write. This is the first step Before
65  * a buffer can be used in a copy operation (i.e. a DMA read/write operation).
66  */
67 extern int halide_hexagon_dma_allocate_engine(void *user_context, void **dma_engine);
68 
69 /** This API free up the allocated DMA engine. This need to be called after a user program ends
70  * all the DMA Operations and make it available for subsequent DMA transfers */
71 extern int halide_hexagon_dma_deallocate_engine(void *user_context, void *dma_engine);
72 
73 /** This API Prepares a buffer for DMA Read Operation. This will setup the DMA format, direction (read).
74  * Will also make necessary adjustments to the DMA frame parameters based on Image format provided.
75  */
77  void *dma_engine, bool is_ubwc, halide_hexagon_image_fmt_t fmt);
78 
79 /** This API Prepares a buffer for DMA Write Operation. This will setup the DMA format, direction (write).
80  * Will also make necessary adjustments to the DMA frame parameters based on Image format provided.
81  */
83  void *dma_engine, bool is_ubwc,
85 
86 /** This API is used to frees up the DMA Resources associated with the buffer.
87  * TODO: Currently this API is a dummy as all the necessary freeing is done in an another API.
88  * This will be used in future.
89  */
91 
92 /** This API is used to setup the hexagon Operation modes. We will setup the necessary Operating frequency
93  * based on the power mode choosen. Check the structure halide_hexagon_power_mode_t defined in Halide HalideRuntimeHexagonHost.h
94  * for the supported power modes.
95  */
97 
98 ///@}
99 
100 #ifdef __cplusplus
101 } // End extern "C"
102 #endif
103 
104 #endif // HALIDE_HALIDERUNTIMEHEXAGONDMA_H
halide_hexagon_fmt_RawData
@ halide_hexagon_fmt_RawData
Definition: HalideRuntimeHexagonDma.h:35
halide_hexagon_fmt_P010
@ halide_hexagon_fmt_P010
Definition: HalideRuntimeHexagonDma.h:39
halide_hexagon_power_mode_t
halide_hexagon_power_mode_t
Power modes for Hexagon.
Definition: HalideRuntimeHexagonHost.h:66
halide_hexagon_fmt_NV12
@ halide_hexagon_fmt_NV12
Definition: HalideRuntimeHexagonDma.h:36
halide_hexagon_fmt_P010_Y
@ halide_hexagon_fmt_P010_Y
Definition: HalideRuntimeHexagonDma.h:40
halide_hexagon_dma_deallocate_engine
int halide_hexagon_dma_deallocate_engine(void *user_context, void *dma_engine)
This API free up the allocated DMA engine.
halide_hexagon_dma_device_detach_native
int halide_hexagon_dma_device_detach_native(void *user_context, struct halide_buffer_t *buf)
Detach the Input/Output Buffer from DMA device handle and deallocate the DMA device handle buffer all...
uint64_t
unsigned __INT64_TYPE__ uint64_t
Definition: runtime_internal.h:19
halide_hexagon_fmt_TP10_Y
@ halide_hexagon_fmt_TP10_Y
Definition: HalideRuntimeHexagonDma.h:43
halide_hexagon_fmt_NV124R_UV
@ halide_hexagon_fmt_NV124R_UV
Definition: HalideRuntimeHexagonDma.h:47
halide_hexagon_dma_unprepare
int halide_hexagon_dma_unprepare(void *user_context, struct halide_buffer_t *buf)
This API is used to frees up the DMA Resources associated with the buffer.
HalideRuntimeHexagonHost.h
halide_hexagon_dma_device_interface
const struct halide_device_interface_t * halide_hexagon_dma_device_interface()
halide_hexagon_fmt_TP10
@ halide_hexagon_fmt_TP10
Definition: HalideRuntimeHexagonDma.h:42
halide_hexagon_fmt_NV12_UV
@ halide_hexagon_fmt_NV12_UV
Definition: HalideRuntimeHexagonDma.h:38
HalideRuntime.h
halide_hexagon_fmt_NV124R_Y
@ halide_hexagon_fmt_NV124R_Y
Definition: HalideRuntimeHexagonDma.h:46
halide_hexagon_fmt_NV12_Y
@ halide_hexagon_fmt_NV12_Y
Definition: HalideRuntimeHexagonDma.h:37
halide_hexagon_fmt_TP10_UV
@ halide_hexagon_fmt_TP10_UV
Definition: HalideRuntimeHexagonDma.h:44
halide_hexagon_dma_power_mode_voting
int halide_hexagon_dma_power_mode_voting(void *user_context, halide_hexagon_power_mode_t cornercase)
This API is used to setup the hexagon Operation modes.
halide_hexagon_dma_prepare_for_copy_to_device
int halide_hexagon_dma_prepare_for_copy_to_device(void *user_context, struct halide_buffer_t *buf, void *dma_engine, bool is_ubwc, halide_hexagon_image_fmt_t fmt)
This API Prepares a buffer for DMA Write Operation.
halide_buffer_t
The raw representation of an image passed around by generated Halide code.
Definition: HalideRuntime.h:1404
halide_hexagon_dma_device_wrap_native
int halide_hexagon_dma_device_wrap_native(void *user_context, struct halide_buffer_t *buf, uint64_t mem)
This API is used to set up the DMA device interface to be used for DMA transfer.
halide_hexagon_dma_prepare_for_copy_to_host
int halide_hexagon_dma_prepare_for_copy_to_host(void *user_context, struct halide_buffer_t *buf, void *dma_engine, bool is_ubwc, halide_hexagon_image_fmt_t fmt)
This API Prepares a buffer for DMA Read Operation.
buf
char * buf
Definition: printer.h:32
halide_device_interface_t
Each GPU API provides a halide_device_interface_t struct pointing to the code that manages device all...
Definition: HalideRuntime.h:721
halide_hexagon_fmt_NV124R
@ halide_hexagon_fmt_NV124R
Definition: HalideRuntimeHexagonDma.h:45
halide_hexagon_dma_allocate_engine
int halide_hexagon_dma_allocate_engine(void *user_context, void **dma_engine)
This API will allocate a DMA Engine needed for DMA read/write.
user_context
void * user_context
Definition: printer.h:33
halide_hexagon_image_fmt_t
halide_hexagon_image_fmt_t
Image Formats to prepare the application for DMA Transfer.
Definition: HalideRuntimeHexagonDma.h:34
halide_hexagon_fmt_P010_UV
@ halide_hexagon_fmt_P010_UV
Definition: HalideRuntimeHexagonDma.h:41