MotorWare f2806x Module API Documentation

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

Data Structures | Macros | Typedefs | Functions
fw.h File Reference

Contains public interface to various functions related to the FW object. More...

`#include "sw/modules/iqmath/src/32b/IQmathLib.h"`
`#include "sw/modules/types/src/types.h"`

Go to the source code of this file.

## Data Structures
struct | _FW_Obj_
| Defines the field weakening (FW) data. More...

## Macros
#define | FW_INC_DELTA (1000)
| Defines the Field Weakening (FW) increment delta correction. More...
#define | FW_DEC_DELTA (1000)
| Defines the Field Weakening (FW) decrement delta correction. More...
#define | FW_NUM_ISR_TICKS_PER_CTRL_TICK (10)
| Defines the number of isr ticks per field weakening clock tick. More...

## Typedefs
typedef struct _FW_Obj_ | FW_Obj
| Defines the field weakening (FW) data. More...
typedef struct _FW_Obj_ * | FW_Handle
| Defines the FW handle. More...

## Functions
FW_Handle | FW_init (void *pMemory, const size_t numBytes)
| Initializes the field weakening (FW) object. More...
static void | FW_getMinMax (FW_Handle fwHandle, _iq *pOutMin, _iq *pOutMax)
| Gets the minimum and maximum output value allowed in the FW controller. More...
static void | FW_setMinMax (FW_Handle fwHandle, const _iq outMin, const _iq outMax)
| Sets the minimum and maximum output value allowed in the FW controller. More...
static void | FW_setDeltas (FW_Handle fwHandle, const _iq delta_inc, const _iq delta_dec)
| Configures the deltas of the field weakening (FW) object. More...
static void | FW_setNumIsrTicksPerFwTick (FW_Handle fwHandle, const uint32_t numIsrTicksPerFwTick)
| Configures the number of ISR ticks per field weakening tick of the field weakening (FW) object. More...
static uint32_t | FW_getNumIsrTicksPerFwTick (FW_Handle fwHandle)
| Gets the number of ISR ticks per field weakening tick of the field weakening (FW) object. More...
static void | FW_clearCounter (FW_Handle fwHandle)
| Clears the counter of the field weakening (FW) object. More...
static void | FW_incCounter (FW_Handle fwHandle)
| Increments the counter of the field weakening (FW) object. More...
static uint32_t | FW_getCounter (FW_Handle fwHandle)
| Returns the counter of the field weakening (FW) object. More...
static void | FW_setFlag_enableFw (FW_Handle fwHandle, const bool state)
| Sets the enable flag of the field weakening (FW) object. More...
static bool | FW_getFlag_enableFw (FW_Handle fwHandle)
| Gets the enable flag of the field weakening (FW) object. More...
static void | FW_setOutput (FW_Handle fwHandle, const _iq output)
| Sets the start value in the FW controller. More...
static _iq | FW_getOutput (FW_Handle fwHandle)
| Gets the output value in the FW controller. More...
static void | FW_run (FW_Handle fwHandle, const _iq refValue, const _iq fbackValue, _iq *pOutValue)
| Runs the FW controller. More...

## Detailed Description

Contains public interface to various functions related to the FW object.

(C) Copyright 2011, Texas Instruments, Inc.

Definition in file fw.h.