stm32: cordic: add new peripheral
Review-URL: https://github.com/libopencm3/libopencm3/pull/1418 Reviewed-by: Karl Palsson <karlp@tweak.net.au> Edits: removed non-existant u5 code, squished to a single commit, whitespace cleanup.
This commit is contained in:
Oskar
169
include/libopencm3/stm32/common/cordic_common_v1.h
Normal file
169
include/libopencm3/stm32/common/cordic_common_v1.h
Normal file
@@ -0,0 +1,169 @@
|
||||
/** @addtogroup cordic_defines
|
||||
|
||||
@author @htmlonly © @endhtmlonly 2022 Oskar H. Maier <ohma@posteo.de>
|
||||
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
* Copyright (C) 2022 Oskar H. Maier <ohma@posteo.de>
|
||||
*
|
||||
* This library is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/**@{*/
|
||||
|
||||
/* THIS FILE SHOULD NOT BE INCLUDED DIRECTLY, BUT ONLY VIA CORDIC.H
|
||||
The order of header inclusion is important. cordic.h includes the device
|
||||
specific memorymap.h header before including this header file.*/
|
||||
|
||||
/** @cond */
|
||||
#ifdef LIBOPENCM3_CORDIC_H
|
||||
/** @endcond */
|
||||
#ifndef LIBOPENCM3_CORDIC_COMMON_V1_H
|
||||
#define LIBOPENCM3_CORDIC_COMMON_V1_H
|
||||
|
||||
/** @defgroup cordic_registers CORDIC registers
|
||||
@{*/
|
||||
/* ----- CORDIC registers ----- */
|
||||
/** CORDIC control/status register */
|
||||
#define CORDIC_CSR MMIO32(CORDIC_BASE + 0x00)
|
||||
/** CORDIC argument register */
|
||||
#define CORDIC_WDATA MMIO32(CORDIC_BASE + 0x04)
|
||||
/** CORDIC result register */
|
||||
#define CORDIC_RDATA MMIO32(CORDIC_BASE + 0x08)
|
||||
/**@}*/
|
||||
|
||||
/* ----- Register values ----- */
|
||||
|
||||
/* ----- CORDIC_CSR Values ----- */
|
||||
/** @defgroup cordic_csr CSR CORDIC control/status register
|
||||
@{*/
|
||||
/** RRDY: result ready flag */
|
||||
#define CORDIC_CSR_RRDY (0x1 << 31)
|
||||
/** ARGSIZE: Width of input data */
|
||||
#define CORDIC_CSR_ARGSIZE (0x1 << 22)
|
||||
/** RESSIZE: Width of result data */
|
||||
#define CORDIC_CSR_RESSIZE (0x1 << 21)
|
||||
/** NARGS: Number of input data writes */
|
||||
#define CORDIC_CSR_NARGS (0x1 << 20)
|
||||
/** NRES: Number of result data reads */
|
||||
#define CORDIC_CSR_NRES (0x1 << 19)
|
||||
/** DMAWEN: DMA write enable */
|
||||
#define CORDIC_CSR_DMAWEN (0x1 << 18)
|
||||
/** DMAREN: DMA write enable */
|
||||
#define CORDIC_CSR_DMAREN (0x1 << 17)
|
||||
/** DMAREN: Interrupt enable */
|
||||
#define CORDIC_CSR_IEN (0x1 << 16)
|
||||
|
||||
/** @defgroup cordic_csr_scale SCALE: Scaling factor
|
||||
@{*/
|
||||
#define CORDIC_CSR_SCALE_1 (0x0)
|
||||
#define CORDIC_CSR_SCALE_2 (0x1)
|
||||
#define CORDIC_CSR_SCALE_4 (0x2)
|
||||
#define CORDIC_CSR_SCALE_8 (0x3)
|
||||
#define CORDIC_CSR_SCALE_16 (0x4)
|
||||
#define CORDIC_CSR_SCALE_32 (0x5)
|
||||
#define CORDIC_CSR_SCALE_64 (0x6)
|
||||
#define CORDIC_CSR_SCALE_128 (0x7)
|
||||
/**@}*/
|
||||
#define CORDIC_CSR_SCALE_SHIFT (8)
|
||||
#define CORDIC_CSR_SCALE_MASK (0x7 << CORDIC_CSR_SCALE_SHIFT)
|
||||
|
||||
/** @defgroup cordic_csr_precision PRECISION: Precision of CORDIC operation (number of iterations)
|
||||
@{*/
|
||||
#define CORDIC_CSR_PRECISION_ITER_04 (0x1)
|
||||
#define CORDIC_CSR_PRECISION_ITER_08 (0x2)
|
||||
#define CORDIC_CSR_PRECISION_ITER_12 (0x3)
|
||||
#define CORDIC_CSR_PRECISION_ITER_16 (0x4)
|
||||
#define CORDIC_CSR_PRECISION_ITER_20 (0x5)
|
||||
#define CORDIC_CSR_PRECISION_ITER_24 (0x6)
|
||||
#define CORDIC_CSR_PRECISION_ITER_28 (0x7)
|
||||
#define CORDIC_CSR_PRECISION_ITER_32 (0x8)
|
||||
#define CORDIC_CSR_PRECISION_ITER_36 (0x9)
|
||||
#define CORDIC_CSR_PRECISION_ITER_40 (0xA)
|
||||
#define CORDIC_CSR_PRECISION_ITER_44 (0xB)
|
||||
#define CORDIC_CSR_PRECISION_ITER_48 (0xC)
|
||||
#define CORDIC_CSR_PRECISION_ITER_52 (0xD)
|
||||
#define CORDIC_CSR_PRECISION_ITER_56 (0xE)
|
||||
#define CORDIC_CSR_PRECISION_ITER_60 (0xF)
|
||||
/**@}*/
|
||||
#define CORDIC_CSR_PRECISION_SHIFT (4)
|
||||
#define CORDIC_CSR_PRECISION_MASK (0xF << CORDIC_CSR_PRECISION_SHIFT)
|
||||
|
||||
/** @defgroup cordic_csr_function FUNCTION: CORDIC operation to be performed
|
||||
@{*/
|
||||
#define CORDIC_CSR_FUNC_COS (0x0)
|
||||
#define CORDIC_CSR_FUNC_SIN (0x1)
|
||||
#define CORDIC_CSR_FUNC_PHASE (0x2)
|
||||
#define CORDIC_CSR_FUNC_MODULUS (0x3)
|
||||
#define CORDIC_CSR_FUNC_ATAN (0x4)
|
||||
#define CORDIC_CSR_FUNC_COSH (0x5)
|
||||
#define CORDIC_CSR_FUNC_SINH (0x6)
|
||||
#define CORDIC_CSR_FUNC_ATANH (0x7)
|
||||
#define CORDIC_CSR_FUNC_COSINE (0x8)
|
||||
#define CORDIC_CSR_FUNC_SQRT (0x9)
|
||||
/**@}*/
|
||||
#define CORDIC_CSR_FUNC_SHIFT (0)
|
||||
#define CORDIC_CSR_FUNC_MASK (0xF << CORDIC_CSR_FUNC_SHIFT)
|
||||
|
||||
/**@}*/
|
||||
|
||||
/* --- Function prototypes ------------------------------------------------- */
|
||||
|
||||
BEGIN_DECLS
|
||||
|
||||
bool cordic_is_result_ready(void);
|
||||
void cordic_set_argument_width_32bit(void);
|
||||
void cordic_set_argument_width_16bit(void);
|
||||
void cordic_set_result_width_32bit(void);
|
||||
void cordic_set_result_width_16bit(void);
|
||||
void cordic_set_number_of_arguments_1(void);
|
||||
void cordic_set_number_of_arguments_2(void);
|
||||
void cordic_set_number_of_results_1(void);
|
||||
void cordic_set_number_of_results_2(void);
|
||||
void cordic_enable_dma_write(void);
|
||||
void cordic_disable_dma_write(void);
|
||||
void cordic_enable_dma_read(void);
|
||||
void cordic_disable_dma_read(void);
|
||||
void cordic_enable_interrupt(void);
|
||||
void cordic_set_scaling_factor(uint8_t n);
|
||||
void cordic_set_precision(uint8_t precision);
|
||||
void cordic_set_function(uint8_t function);
|
||||
void cordic_write_16bit_argument(uint16_t argument);
|
||||
void cordic_write_16bit_arguments(uint16_t argument1, uint16_t argument2);
|
||||
void cordic_write_32bit_argument(uint32_t argument);
|
||||
uint16_t cordic_read_16bit_result(void);
|
||||
void cordic_read_16bit_results(uint16_t *result1, uint16_t *result2);
|
||||
uint32_t cordic_read_32bit_result(void);
|
||||
void cordic_configure_for_cos_16bit(void);
|
||||
void cordic_configure_for_cos_32bit(void);
|
||||
void cordic_configure_for_sin_16bit(void);
|
||||
void cordic_configure_for_sin_32bit(void);
|
||||
int16_t cordic_cos_16bit(int16_t x);
|
||||
int32_t cordic_cos_32bit(int32_t x);
|
||||
int16_t cordic_sin_16bit(int16_t x);
|
||||
int32_t cordic_sin_32bit(int32_t x);
|
||||
void cordic_cos_16bit_async(int16_t x);
|
||||
void cordic_cos_32bit_async(int32_t x);
|
||||
void cordic_sin_16bit_async(int16_t x);
|
||||
void cordic_sin_32bit_async(int32_t x);
|
||||
END_DECLS
|
||||
|
||||
#endif
|
||||
/** @cond */
|
||||
#endif
|
||||
/** @endcond */
|
||||
/**@}*/
|
||||
29
include/libopencm3/stm32/cordic.h
Normal file
29
include/libopencm3/stm32/cordic.h
Normal file
@@ -0,0 +1,29 @@
|
||||
/* This provides unification of code over STM32 subfamilies */
|
||||
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
* This library is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <libopencm3/cm3/common.h>
|
||||
#include <libopencm3/stm32/memorymap.h>
|
||||
|
||||
#if defined(STM32G4)
|
||||
# include <libopencm3/stm32/g4/cordic.h>
|
||||
#elif defined(STM32U5)
|
||||
# include <libopencm3/stm32/u5/cordic.h>
|
||||
#else
|
||||
# error "stm32 family not defined."
|
||||
#endif
|
||||
34
include/libopencm3/stm32/g4/cordic.h
Normal file
34
include/libopencm3/stm32/g4/cordic.h
Normal file
@@ -0,0 +1,34 @@
|
||||
/** @defgroup cordic_defines CORDIC Defines
|
||||
*
|
||||
* @brief <b>Defined Constants and Types for the STM32G4xx CORDIC</b>
|
||||
*
|
||||
* @ingroup STM32G4xx_defines
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
* This library is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#ifndef LIBOPENCM3_CORDIC_H
|
||||
#define LIBOPENCM3_CORDIC_H
|
||||
|
||||
#include <libopencm3/stm32/common/cordic_common_v1.h>
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user