Platform Developer s Kit. CORDIC Library

Transcription

1 Platform Developer s Kit CORDIC Library

2 Celoxica, the Celoxica logo and Handel-C are trademarks of Celoxica Limited. All other products or services mentioned herein may be trademarks of their respective owners. Neither the whole nor any part of the information contained in, or the product described in, this document may be adapted or reproduced in any material form except with the prior written permission of the copyright holder. The product described in this document is subject to continuous development and improvement. All particulars of the product and its use contained in this document are given by Celoxica Limited in good faith. However, all warranties implied or express, including but not limited to implied warranties of merchantability, or fitness for purpose, are excluded. This document is intended only to assist the reader in the use of the product. Celoxica Limited shall not be liable for any loss or damage arising from the use of any information in this document, or any incorrect use of the product. The information contained herein is subject to change without notice and is for general guidance only. Copyright 2005 Celoxica Limited. All rights reserved. Authors: RG Document number: 1 Customer Support at Celoxica in Europe Celoxica in Japan Celoxica in the Americas T: +44 (0) T: +81 (0) T: E: sales.emea@celoxica.com E: sales.japan@celoxica.com E: sales.america@celoxica.com

3 Contents 1 CORDIC LIBRARY CORDIC CORES PIPELINED CORDIC MACROS NON-PIPELINED CORDIC MACROS NON-PIPELINED TRIGONOMETRIC MACROS INDEX Page 1

4 Conventions A number of conventions are used in this document. These conventions are detailed below. Warning Message. These messages warn you that actions may damage your hardware. Handy Note. These messages draw your attention to crucial pieces of information. Hexadecimal numbers will appear throughout this document. The convention used is that of prefixing the number with '0x' in common with standard C syntax. Sections of code or commands that you must type are given in typewriter font like this: void main(); Information about a type of object you must specify is given in italics like this: copy SourceFileName DestinationFileName Optional elements are enclosed in square brackets like this: struct [type_name] Curly brackets around an element show that it is optional but it may be repeated any number of times. string ::= "{character}"

5 Assumptions & Omissions This manual assumes that you: have used Handel-C or have the Handel-C Language Reference Manual are familiar with common programming terms (e.g. functions) are familiar with MS Windows This manual does not include: instruction in VHDL or Verilog instruction in the use of place and route tools tutorial example programs. These are provided in the Handel-C User Manual

6 1 CORDIC library The CORDIC algorithm is an iterative algorithm used to evaluate many mathematical functions, such as trigonometric functions, hyperbolic functions and planar rotations. CORDIC uses a sequence successive approximations to reach its results. The library contains: Non-pipelined macro procedures to perform linear, hyperbolic and circular CORDIC. Non-pipelined macro procedures to perform trigonometric operations Pipelined macros procedures to perform linear, hyperbolic and circular CORDIC. CORDIC pipelined "cores" to create linear, hyperbolic and circular CORDIC cores. To use the library, you need to include cordic.hch in your code and link cordic.hcl. The libraries are in InstallDir/PDK/Hardware/Lib. CORDIC cores Pipelined CORDIC macros Non-pipelined CORDIC macros Non-pipelined trigonometric macros Page 4

7 2 CORDIC Cores The following macros are provided in the CORDIC library to create a "core". extern macro expr CORDICPipeLinRotateCore; extern macro expr CORDICPipeLinVectorCore; extern macro expr CORDICPipeCircRotateCore; extern macro expr CORDICPipeCircVectorCore; extern macro expr CORDICPipeHypRotateCore; extern macro expr CORDICPipeHypVectorCore; #define PipeCORDICCoreCreateHandle(Name) extern macro proc CORDICPipeCoreRun (CORDICHandle, Type); extern macro proc CORDICPipeCoreEnable (CORDICHandle); extern macro proc CORDICPipeCoreSet (CORDICHandle, Xin, YIn, ZIn, d_w); extern macro proc CORDICPipeCoreGet (CORDICHandle, XOut, YOut, ZOut, d_w); 2.1 CORDIC Cores types The following pipelined CORDIC macros are provided in the Celoxica CORDIC Library: Pipelined Linear rotation Pipelined Linear vectoring Pipelined Circular rotation Pipelined Circular vectoring Pipelined Hyperbolic rotation Pipelined Hyperbolic vectoring extern macro expr CORDICPipeLinRotateCore; extern macro expr CORDICPipeLinVectorCore; extern macro expr CORDICPipeCircRotateCore; extern macro expr CORDICPipeCircVectorCore; extern macro expr CORDICPipeHypRotateCore; extern macro expr CORDICPipeHypVectorCore; Page 5

8 Timing: None Compile time Identifier for the type of operation selected as a core. Used as a parameter to CORDICPipeCoreRun. CORDICPipeCoreRun (MyCircRotate, CORDICPipeLinRotateCore); 2.2 PipeCORDICCoreCreateHandle() #define PipeCORDICCoreCreateHandle(Name) Name: Creates a handle for a core operation to be created. The name should be intuitive of the type of operation to be created. Note that no space must exist between the name and the bracket encapsulating the name. #define PipeCORDICCoreCreateHandle(MyCordicRotate) Page 6

9 2.3 CORDICPipeCoreRun () extern macro proc CORDICPipeCoreRun (CORDICHandle, Type); Timing: CORDICHandle: Handle created Type: Identifier of type of operation selected from the available core types. Does not terminate Runs the selected operation. This is a never ending process and interacting code should be run in parallel.... PipeCORDICCoreCreateHandle(MyCircRotate); par { CordicPipeCoreRun (MyCircRotate, CORDICPipeLinRotateCore); } seq { }... Page 7

10 2.4 CORDICPipeCoreEnable() extern macro proc CORDICPipeCoreEnable (CORDICHandlePtr); Timing: CORDICHandlePtr: Pointer to handle created one clock cycle Enables the core... PipeCORDICCoreCreateHandle(MyCircRotate); par { CordicPipeCoreRun (MyCircRotate, PipeCORDICCircRotateCore); seq { CORDICPipeCoreEnable(&MyCircRotate);... } } Page 8

11 2.5 CORDICPipeCoreSet () extern macro proc CORDICPipeCoreSet (CORDICHandle, Xin, YIn, ZIn, d_w); CORDICHandle: Handle created XIn: Cordic input YIn: Cordic input ZIn: Cordic input d_w: data-width Sets the input parameters for the operation. This must be done in parallel with the CordicPipeCoreRun macro.... PipeCORDICCoreCreateHandle(MyRotator); par { } CordicPipeCoreRun (MyRotator, CORDICPipeLinRotateCore); seq { } CORDICPipeCoreEnable(&MyRotator); CORDICPipeCoreSet(&MyRotator, x, y, z, width(x));... Page 9

12 2.6 CORDICPipeCoreGet() extern macro proc CORDICPipeCoreGet (CORDICHandle, XOut, YOut, ZOut, d_w); CORDICHandle: Handle created XOut: Cordic output YOut: Cordic output ZOut: Cordic output d_w: data_width Gets the results from the pipeline, once the date is valid.... PipeCORDICCoreCreateHandle(MyRotator); par { CordicPipeCoreRun (MyRotator, CORDICPipeLinRotateCore); seq { CORDICPipeCoreEnable(&MyRotator); CORDICPipeCoreSet(&MyRotator, x, y, z, width(x)); } while (!CORDICPipeCoreResult (&MyRotator)) { delay; } CORDICPipeCoreGet(&MyRotator,xout, yout, zout, width(x)); } Page 10

13 3 Pipelined CORDIC macros The following pipelined CORDIC macros are provided in the Celoxica CORDIC Library: Inputs most be fixed point numbers, with a even number of bits. The integer and fractional parts must be equally sized and less than 64-bits. Linear rotation Linear vectoring Circular rotation Circular vectoring Hyperbolic rotation Hyperbolic vectoring extern macro proc PipeLinRotate (pipe_cordic_data, d_w); extern macro proc PipeLinVector (pipe_cordic_data, d_w); extern macro proc PipeCircRotate (pipe_cordic_data, d_w); extern macro proc PipeCircVector (pipe_cordic_data, d_w); extern macro proc PipeHypRotate (pipe_cordic_data, d_w); extern macro proc PipeHypVector (pipe_cordic_data, d_w); Page 11

14 pipe_cordic_data: Structure containing cordic data: pipe_cordic_data.xin; pipe_cordic_data.yin; pipe_cordic_data.zin; pipe_cordic_data.xout; pipe_cordic_data.yout; pipe_cordic_data.zout; pipe_cordic_data.xptr; pipe_cordic_data.yptr; pipe_cordic_data.zptr; d_w: data-width Vectoring and Rotational mode Linear, Hyperbolic and Circular pipelined CORDIC. pipe_cordic_data MyData; signed 16 x; signed 16 y; signed 16 z;... MyData.XIn = x; MyData.YIn = y; MyData.ZIn = z;... while(1) { PipeCircRotate (MyData, width(x)); }... Macro: PipeCircRotate() Pipelined circular rotation Page 12

15 PipeCircVector() PipeLinRotate() PipeLinVector() PipeHypRotate() PipeHypVector() Pipelined circular vectoring Pipelined linear rotation Pipelined linear vectoring Pipelined hyperbolic rotation Pipelined hyperbolic vectoring Page 13

16 4 Non-pipelined CORDIC macros The following non-pipelined CORDIC macros are provided in the Celoxica CORDIC Library. Inputs must be fixed point numbers, with a even number of bits. The integer and fractional parts must be equally sized and less than 64-bits. Linear rotation Linear vectoring Circular rotation Circular vectoring Hyperbolic rotation Hyperbolic vectoring extern macro proc LinRotate (cordic_data, d_w); extern macro proc LinVector (cordic_data, d_w); extern macro proc CircRotate (cordic_data, d_w); extern macro proc CircVector (cordic_data, d_w); extern macro proc HypRotate (cordic_data, d_w); extern macro proc HypVector (cordic_data, d_w); Page 14

17 cordic_data: Structure containing cordic data: cordic_data.xin; cordic_data.yin; cordic_data.zin; cordic_data.xout; cordic_data.yout; cordic_data.zout; d_w The data-width Vectoring and Rotational mode Linear, Hyperbolic and Circular CORDIC. #include "cordic.hch" #include "stdlib.hch" cordic_data MyData; static signed 16 x = 0x200; static signed 16 y =0x0; static signed 16 z = 0x80;... MyData.XIn = x; MyData.YIn = y; MyData.ZIn = z; LinRotate(MyData, width(x));... Macro: CircRotate() CircVector() LinRotate() Circular rotation Circular vectoring Linear rotation Page 15

18 LinVector() HypRotate() HypVector() Linear vectoring Hyperbolic rotation Hyperbolic vecotring Page 16

19 5 Non-pipelined trigonometric macros The following non-pipelined trigonometric macros are provided in the Celoxica CORDIC Library: The trigonometric library inputs most be fixed point numbers, with a even number of bits. The integer and fractional parts must be equally sized. Sine Cosine Sine and Cosine simultaneously Tangent Inverse Sine Inverse Cosine Inverse Tangent Multiply Divide Hyperbolic Sine Hyperbolic Cosine Hyperbolic Sine and Hyperbolic Cosine simultaneously Hyperbolic Tangent Hyperbolic Inverse Sine Hyperbolic Inverse Cosine Hyperbolic Inverse Tangent Natural Log Exponent Magnitude Cartesian to polar form Page 17

20 5.1 Non-pipelined Natural Log extern macro proc NaturalLog(Input, Ln, d_w); Input: Fixed-point input Ln: Fixed-point output d_w: data-width Computes the natural log of the input signed int 64 Input; signed int 64 Ln;... NaturalLog(Input, Ln, width(input)); 5.2 Non-pipelined Exponent extern macro proc Exponent (Input, Exp, d_w); Input: Fixed-point input Exp: Fixed-point input d_w: data-width Computes the exponent of the input. signed int 64 Input; signed int 64 Exp;... Exponent (Input, Exp, width(input)); 5.3 Non-pipelined Magnitude extern macro proc Magnitude (X, Y, Result, d_w); X: Fixed-point input Y: Fixed-point input Page 18

21 Result: Fixed-point output d_w: data_width Computes magnitude of x and y- sqrt (x^2 + y^2). signed int 64 X; signed int 64 Y; signed int 64 Result;... Magnitude (X, Y, Result, width(x)); 5.4 Non-pipelined Cartesian to polar conversion extern macro proc CartesianToPolar (X, Y, Magnitude, Phase, d_w); X: Fixed-point input Y: Fixed-point input Magnitude: Fixed-point output Phase: Fixed-point output d_w: data_width Converts Cartesian co-ordinates (X, Y) to polar form (Magnitude,Phase) signed int 16 X; signed int 16 Y; signed int 16 Magnitude; signed int 16 Phase;... CartesianToPolar (X, Y, Magnitude, Phase, width(x) ); Page 19

22 5.5 Non-pipelined inverse hyperbolic Sine, Cosine and Tangent extern macro proc HypArcsine (Sinh, Angle, d_w); extern macro proc HypArccosine (Cosh, Angle, d_w); extern macro proc HypArctan (Tanh, Angle, d_w); Angle: Fixed-point input Sinh: Fixed-point output Cosh: Fixed-point output Tanh: Fixed-point output d_w: data-width Calculates the inverse hyperbolic Sine, Tangent or Cosine. signed int 64 Angle; signed int 64 Cosh; signed int 64 Sinh; Sinh = 0x ; HypArcsine (Sinh, Angle, width(sinh)); Macro: HypArcsine() HypArccosine() HypArctan() Calculate the hyperbolic Sine of the input angle. Calculate the hyperbolic Cosine of the input angle. Calculate the hyperbolic Tangent of the input angle. 5.6 Non-pipelined hyperbolic Sine, Cosine and Tangent extern macro proc HypSine (Sinh, Angle, d_w); extern macro proc HypCosine (Cosh, Angle, d_w); extern macro proc HypSineCosine (Cosh, Sinh, Angle, d_w); extern macro proc HypTangent (Tanh, Angle, d_w); Page 20

23 Angle: Fixed-point input Sinh: Fixed-point output signed int 64 Angle; signed int 64 Cosh; signed int 64 Sinh; Cosh: Fixed-point output Tanh: Fixed-point output d_w: data-width Calculates the hyperbolic Sine, Tangent or Cosine of the input Angle. HypSineCosine calculates hyperbolic Sine and Cosine simultaneously. Angle = 0x ; HypSineCosine (Cosh, Sinh, Angle, width(angle)); Macro: HypSine() HypCosine() HypTangent() HypSineCosine() Calculate the hyperbolic Sine of the input angle. Calculate the hyperbolic Cosine of the input angle. Calculate the hyperbolic Tangent of the input angle. Calculate the hyperbolic Sine and Cosine of the input angle simultaneously. 5.7 Non-pipelined inverse Sine, Cosine and Tangent extern macro proc Arcsine (Sin, Angle, d_w); extern macro proc Arccosine (Cos, Angle, d_w); extern macro proc Arctan (Tan, Angle, d_w); Angle: Fixed-point output Sin: Fixed-point input Cos: Fixed-point input Page 21

24 Tan: Fixed-point input d_w: data_width Calculates the Inverse Sine, Tangent or Cosine of the fixed-point input. signed int 64 Angle; signed int 64 Sin; Sin = 0x ; ArcSine (Sin, Angle, width(sin)); Macro: Arcsine() Arccosine() Arctan() Calculate the Arcsine of the input. Calculate the Arccosine of the input. Calculate the Arctan of the input. 5.8 Non-pipelined Sine, Cosine and Tangent extern macro proc Sine (Sin, Angle, d_w); extern macro proc Cosine (Cos, Angle, d_w); extern macro proc SineCosine (Cos, Sin, Angle, d_w); extern macro proc Tangent (Tan, Angle, d_w); Angle: Fixed-point input Sin: Fixed-point output Cos: Fixed-point output Tan: Fixed-point output Page 22

25 signed int 64 Angle; signed int 64 Cos; signed int 64 Sin; d_w: data-width Calculates the Sine, Tangent or Cosine of the fixed point input Angle. SineCosine calculates Sine and Cosine simultaneously. Angle = 0x2D ; SineCosine (Cos, Sin, Angle, width(angle)); Macro: Sine() Cosine() Tangent() SineCosine() Calculate the Sine of the input angle. Calculate the Cosine of the input angle. Calculate the Tangent of the input angle. Calculate the Sine and Cosine of the input angle simultaneously. 5.9 Non-pipelined CORDIC multiply and divide extern macro proc Multiply (A, B, Result, d_w); extern macro proc Divide (A, B, Result, d_w); A: Fixed-point input B: Fixed-point input Result: Fixed-point output d_w: data_width Page 23

26 CORDIC fixed-point divide and multiply macro. signed int 64 A; signed int 64 B; signed int 64 Result; par { A = 0x ; B = 0x ; } Multiply (A, B, Result, width(a)); Macro: Multiply() Calculate A * B. Divide() Calculate B / A. Page 24

27 6 Index C CORDIC...4 CORDIC Cores 5 non-pipelined CORDIC macros 14 Non-pipelined trigonometric CORDIC macros 17 Pipelined CORDIC macros 11 Page 25