moniere/CORDIC_Rotate_APFX
1
0
Fork 0
mirror of https://github.com/DrasLorus/CORDIC_Rotate_APFX.git synced 2024-11-21 20:23:16 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update CMakeLists and add GCC 6.2 and 6.5 to the supported compiler lists

Browse source
This commit is contained in:
Camille Monière 2022-02-21 11:39:33 +01:00
parent 5bc9c3eeb1
commit 1a7a1be5c7
Signed by: moniere
GPG key ID: 188DD5B072181C0F
4 changed files with 57 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -5,6 +5,7 @@ lib
bin bin
compile_commands.json compile_commands.json
*octave-workspace *octave-workspace
.vscode
sources/CCordicRotateRom/CCordicRotateRom_*.?pp sources/CCordicRotateRom/CCordicRotateRom_*.?pp
sources/CordicRoms/cordic_rom_*.?pp sources/CordicRoms/cordic_rom_*.?pp

48
CMakeLists.txt
View file

@ -78,6 +78,7 @@ else ()
/usr/include /usr/include
CACHE PATH "location of ap_types include directory." CACHE PATH "location of ap_types include directory."
) )
find_file ( find_file (
AP_FIXED ap_fixed.h AP_FIXED ap_fixed.h
HINTS ${AP_TYPES_HINT} HINTS ${AP_TYPES_HINT}
@ -96,8 +97,10 @@ endif ()
set ( set (
ROM_TYPE ROM_TYPE
"mc" "mc"
CACHE STRING "RomGenerator to use, either 'mc' or 'cst'." CACHE STRING "RomGenerator to use, either 'mc' or 'cst'."
) )
set_property(CACHE ROM_TYPE PROPERTY STRINGS "mc" "cst")
set ( set (
CORDIC_W CORDIC_W
"16" "16"
@ -117,8 +120,9 @@ set (
add_subdirectory (RomGenerators) add_subdirectory (RomGenerators)
set (ROM_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/sources/CordicRoms) set (ROM_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/sources/CordicRoms)
string (CONFIGURE ${ROM_DIRECTORY}/cordic_rom_${ROM_TYPE}_${CORDIC_W}_${CORDIC_STAGES}_${CORDIC_Q}.hpp ROM_HEADER string (
CONFIGURE ${ROM_DIRECTORY}/cordic_rom_${ROM_TYPE}_${CORDIC_W}_${CORDIC_STAGES}_${CORDIC_Q}.hpp
ROM_HEADER
) )
add_custom_command ( add_custom_command (
OUTPUT ${ROM_HEADER} OUTPUT ${ROM_HEADER}
@ -145,39 +149,53 @@ target_include_directories (cordic_rom_gen PUBLIC sources)
target_include_directories (cordic_rom_gen SYSTEM PUBLIC ${AP_INCLUDE_DIR}) target_include_directories (cordic_rom_gen SYSTEM PUBLIC ${AP_INCLUDE_DIR})
target_link_libraries (cordic_rom_gen PUBLIC romgen) target_link_libraries (cordic_rom_gen PUBLIC romgen)
file (GLOB ALL_CORDIC_ROM_HEADERS sources/CCordicRotateRom/*.hpp)
file (GLOB ALL_CORDIC_ROM_SOURCES sources/CCordicRotateRom/*.cpp) file (GLOB ALL_CORDIC_ROM_SOURCES sources/CCordicRotateRom/*.cpp)
file (GLOB ALL_ROM_HEADERS sources/CordicRoms/*.hpp) list (REMOVE_ITEM ALL_CORDIC_ROM_SOURCES sources/CCordicRotateRom/${CORDIC_ROM_SOURCE})
add_library ( add_library (
cordic STATIC sources/CCordicRotateSmart/CCordicRotateSmart.cpp cordic STATIC sources/CCordicRotateSmart/CCordicRotateSmart.cpp
sources/CCordicRotateConstexpr/CCordicRotateConstexpr.cpp sources/CCordicRotateConstexpr/CCordicRotateConstexpr.cpp ${ALL_CORDIC_ROM_SOURCES}
${ALL_CORDIC_ROM_SOURCES}
) )
target_include_directories (cordic PUBLIC sources) target_include_directories (cordic PUBLIC sources)
target_include_directories (cordic SYSTEM PUBLIC ${AP_INCLUDE_DIR}) target_include_directories (cordic SYSTEM PUBLIC ${AP_INCLUDE_DIR})
target_link_libraries (cordic PUBLIC romgen) target_link_libraries (cordic PUBLIC romgen cordic_rom_gen)
# ################################################################################################## # ##################################################################################################
if (ENABLE_TESTING) if (ENABLE_TESTING)
find_package (Catch2 REQUIRED) find_package (Catch2 REQUIRED)
string (CONFIGURE string (
${CMAKE_CURRENT_SOURCE_DIR}/sources/tb/cordic_rom_tb_${ROM_TYPE}_${CORDIC_W}_${CORDIC_STAGES}_${CORDIC_Q}.cpp CONFIGURE
TB_SOURCE) ${CMAKE_CURRENT_SOURCE_DIR}/sources/tb/cordic_rom_tb_${ROM_TYPE}_${CORDIC_W}_${CORDIC_STAGES}_${CORDIC_Q}.cpp
configure_file ( TB_SOURCE
sources/tb/cordic_rom_tb.cpp.in
${TB_SOURCE} @ONLY
) )
configure_file (sources/tb/cordic_rom_tb.cpp.in ${TB_SOURCE} @ONLY)
add_library (catch_common OBJECT sources/tb/main_catch2.cpp) add_library (catch_common OBJECT sources/tb/main_catch2.cpp)
target_link_libraries (catch_common PUBLIC Catch2::Catch2) target_link_libraries (catch_common PUBLIC Catch2::Catch2)
add_executable (cordic_tb sources/tb/cordic_tb.cpp ${TB_SOURCE}) file (GLOB ALL_ROM_TB_SOURCES sources/tb/cordic_rom_*.cpp)
list (REMOVE_ITEM ALL_ROM_TB_SOURCES ${TB_SOURCE})
add_executable (cordic_tb sources/tb/cordic_tb.cpp ${TB_SOURCE} ${ALL_ROM_TB_SOURCES})
target_link_libraries (cordic_tb PUBLIC cordic catch_common) target_link_libraries (cordic_tb PUBLIC cordic catch_common)
include (CTest) include (CTest)
include (Catch) include (Catch)
catch_discover_tests (cordic_tb) catch_discover_tests (cordic_tb)
endif () endif ()
file (GLOB ALL_ROM_HEADERS sources/CordicRoms/cordic_rom_*.hpp)
file (GLOB ALL_CORDIC_ROM_HEADERS sources/CCordicRotateRom/CCordicRotateRom_*.hpp)
add_custom_target (
remove_byproducts
COMMAND ${CMAKE_COMMAND} -E echo "-- Deleting generated sources files and headers"
COMMAND ${CMAKE_COMMAND} -E remove ${TB_SOURCE} ${ALL_ROM_TB_SOURCES}
COMMAND ${CMAKE_COMMAND} -E remove ${CORDIC_ROM_SOURCE} ${ALL_CORDIC_ROM_SOURCES}
COMMAND ${CMAKE_COMMAND} -E remove ${ALL_ROM_HEADERS}
COMMAND ${CMAKE_COMMAND} -E remove ${ALL_CORDIC_ROM_HEADERS}
COMMAND ${CMAKE_COMMAND} -E echo "-- Files deleted."
COMMAND ${CMAKE_COMMAND} -E echo
"-- WARNING: You must re-run the cmake-configure step for the next build to succeed."
)

25
README.md
View file

@ -6,18 +6,25 @@ A free way to implement a CORDIC-based rotation using HLS, with bit-accurate pre
[CORDIC](https://en.wikipedia.org/wiki/CORDIC) (COordinate Rotation DIgital Computer) is an efficient way to implement hardware complex rotations (e.g. `z * exp(jw)`, with `z = x + jy` a complex and `w` a real angle). It is also useful for microcontrollers or microprocessors lacking floating-point units, as such multiplications can consume a noticeable amount of CPU cycles. [CORDIC](https://en.wikipedia.org/wiki/CORDIC) (COordinate Rotation DIgital Computer) is an efficient way to implement hardware complex rotations (e.g. `z * exp(jw)`, with `z = x + jy` a complex and `w` a real angle). It is also useful for microcontrollers or microprocessors lacking floating-point units, as such multiplications can consume a noticeable amount of CPU cycles.
This implementation in C++14 (`-std=c++14`) is suitable for hardware simulation and (with the right lib's and a few tweaks) for synthesis. This implementation in C++14 (`-std=c++14`) is suitable for hardware simulation and (with the right headers and maybe a few tweaks) for synthesis.
This repository mainly hosts `CCordicRotateHalfPiRom`, CORDIC-based rotation units which rely on a ROM. This repository defines two working CORDIC-based rotation units classes, `CCordicRotateRom` and `CCordicRotateConstexpr`, which both rely on a ROM.
Currently, It ranges from 2 to 7 stages, and the word length is a template. They differ by the way the ROM is generated:
It depends on ROM generators, each one producing a ROM table which contains control signals for each CORDIC stage, depending on the input angle. There are generators:
- A true `constexpr` one, that is entirely processed by the compiler. - `CCordicRotateRom` depends on ROM headers generated by the build system (i.e. CMake) using configure files and build-time dependencies,
- A Monte-Carlo one, that is evaluated at runtime and can be used to produced ROM-headers, suitable for Autoconf/CMake header generations. - `CCordicRotateConstexpr` ROM is completely compiled using C++14 *constexpr* mechanism, which constraint the ROM type but allow cleaner build dependencies.
Only rotations of pi and pi/2 are currently supported, but support for any pi/2^k can be easily added. Currently, They can have from 2 to 7 stages, and the word length is a template.
ROM tables contain control signals for each CORDIC stage, the input angle being the address. There are two kinds of generators:
`CCordicRotate` is an unfinished template that would implement a *smart* CORDIC, which can work without a ROM. - A true *constexpr* one, that is entirely processed by the compiler.
- A Monte-Carlo one, that is evaluated at runtime.
Both can be used to produced ROM headers but only the first one can be used for `CCordicRotateConstexpr`.
Only rotations of pi and pi/2 are currently supported, but support for any pi/2^k might be added later.
`CCordicRotateSmart` is an unfinished template that would implement a *"smart"* CORDIC, which would not need a ROM.
## Test suite and dependencies ## Test suite and dependencies
@ -25,7 +32,7 @@ The [Catch2](https://github.com/catchorg/Catch) test framework has been used in
The [GitHub mirror of the repository](https://github.com/DrasLorus/CORDIC_Rotate_APFX) also make use of GitHub Actions and Docker as a CI/CD solution. The [GitHub mirror of the repository](https://github.com/DrasLorus/CORDIC_Rotate_APFX) also make use of GitHub Actions and Docker as a CI/CD solution.
- Has been tested successfully compiled with: - Has been tested successfully compiled with:
- GNU GCC 9.4, 10.1, 10.2 and 11.2, - GNU GCC 6.2 (*Xilinx bundled version*), 6.5, 9.4, 10.1, 10.2 and 11.2,
- LLVM Clang 12.0 and 13.0, - LLVM Clang 12.0 and 13.0,
- Uses Catch v2.13.7, - Uses Catch v2.13.7,
- Depends on Xilinx HLS arbitrary precision types, available as FOSS [here provided by Xilinx](https://github.com/Xilinx/HLS_arbitrary_Precision_Types) or [here patched by myself](https://github.com/DrasLorus/HLS_arbitrary_Precision_Types). Note: Xilinx also provides proprietary versions of those headers, suitable for synthesis and implementation, bundled with their products. - Depends on Xilinx HLS arbitrary precision types, available as FOSS [here provided by Xilinx](https://github.com/Xilinx/HLS_arbitrary_Precision_Types) or [here patched by myself](https://github.com/DrasLorus/HLS_arbitrary_Precision_Types). Note: Xilinx also provides proprietary versions of those headers, suitable for synthesis and implementation, bundled with their products.

7
sources/CordicRoms/README.md Normal file
View file

@ -0,0 +1,7 @@
# CORDIC ROM Headers
This directory contains build-time generated CORDIC ROM headers.
They are in the form `cordic_rom_${ROM_TYPE}_${CORDIC_W}_${CORDIC_STAGES}_${CORDIC_Q}.hpp` and contain (besides the usual double-inclusion protection) a table `constexpr uint8_t ${ROM_TYPE}_${CORDIC_W}_${CORDIC_STAGES}_${CORDIC_Q}` under the namespace `cordic_roms`. It is filled with corresponding CORDIC control signals.
This table is generated using its corresponding `rom_generator`, itself built and called by the build system.
*Note: This directory is usually empty, but will be filled automatically when needed.*