COE File Syntax - 2024.1 English

Vivado Design Suite User Guide: Designing with IP (UG896)

Document ID
UG896
Release Date
2024-05-30
Version
2024.1 English

The following syntax displays the general form for a COE file:

Keyword =Value ; Optional Comment
Keyword =Value ; Optional Comment
<Radix_Keyword> =Value ; Optional Comment
<Data_Keyword> =Data_Value1, Data_Value2, Data_Value3;

The following table describes COE file keywords for specifying radix values for data. Keywords are not case-sensitive. For information on the specific keywords required for a IP, see the Product Guide for that IP.

Table 1. COE File Keywords for Radix Values
Keyword Description
RADIX Used for non-memory cores to indicate the radix being used to specify the coefficients of the filter.
MEMORY_INITIALIZATION_RADIX Used for memory initialization values to specify the radix used.

The following table describes COE file keywords for data values. Keywords are not case sensitive.

Table 2. COE File Keywords for Data Values
Keyword Description
COEFDATA Used for filters to indicate that the data that follows comprises the coefficients of the filter.
MEMORY_INITIALIZATION_VECTOR Used for block and distributed memories.
PATTERN Used for Bit Correlator COE files.
BRANCH_LENGTH_VECTOR Used in Interleaver COE files.
Note: Any text after a semicolon is treated as a comment and ignored.

One of the following keywords must be the last keyword specified in the COE file:

  • COEFDATA
  • MEMORY_INITIALIZATION_VECTOR

Any other keywords that follow are ignored.