Data Types - Data Types - 6.0 English - PG141

DDS Compiler LogiCORE IP Product Guide (PG141)
Document_ID
PG141
Release_Date
2024-12-11
Version
6.0 English

The following table shows the types defined for the DDS Compiler C model.

Table 1. C Model Data Types
Name Type Description
xip_dds_v6_0_data Double Used for phase input/output and for SIN/COS output.
xip_uint Unsigned Int

Used for configuration parameter of integer or Boolean type. For Boolean:

0 = False

1 = True
xip_dds_v6_0_config Struct Structure of configuration parameters.
xip_dds_v6_0_config_pkt Struct Data structure of phase increment (PINC) and/or phase offset (POFF) values input to the core at runtime. Equivalent to data on the S_AXIS_CONFIG channel of the core.
xip_dds_v6_0_status Int Error code return from many C model functions. 0 indicates success. Any other value indicates failure.
xip_status Int Same as xip_dds_v6_0_status, but used for functions which are not core-specific.
xip_real Double
xip_array_real Struct Structure used to hold data for input to DDS (on S_AXIS_PHASE channel) or output from DDS.
xip_dds_v6_0_config Struct The configuration of the core itself. The members of this structure are listed in the dds_compiler_v6_0_bitacc_cmodel file. The names closely match the same names in XCO/XCI files. The dds_compiler_v6_0_bitacc_cmodel file also contains #defined values for all. All member variables beginning with “res” are for internal use and need not be set.
xip_dds_v6_0 Struct Type defined which C (not C++) can use as a handle (pointer) to a C++ object – the C model itself.

xip_dds_v6_0_data is of type double because this has sufficient precision to describe even the largest input and output vectors (48 bits) without the complications of long which can vary from platform to platform or compiler to compiler.

xip_array_real is a structure with the following members:

data
A pointer to the array of data values.
data_size
Of type size_t, which describes the total size of the data array.
data_capacity
Also of type size_t, which describes how much of the array is currently populated.
dim
A pointer to a size_t array of values that indicate the size of each dimension.
dim_size (size_t)
Indicates the number of dimensions of the data array.
dim_capacity
Indicates how much of the dimension array is currently populated.
owner, unsigned int
This is provided as a handle for when the data structure is intended to be passed from one core to another, but is not used by any of the DDS C model functions.