pmsm.doc

用freescale公司的DSP56F8013芯片实现的PMSM的SVPWM 驱动

=============================================================================
List of generated methods in project: PMSM

THIS TEXT DESCRIPTION IS GENERATED BY THE TOOL. DO NOT MODIFY IT.
=============================================================================

Module "PWM"       (bean PWMMC)
   - PWM_Enable -Enable the bean - it starts the signal generation. Events can be disabled/enabled by DisableEvent/EnableEvent.
   - PWM_Disable -Disable the bean - it stops signal generation and events calling. When the timer is disabled, it is possible 
                to call method "SetOutput" to control the output value on corresponding pin.
   - PWM_EnableEvent -Enable the events. Method is available only if interrupt service/event is enabled.
   - PWM_DisableEvent -Disable the events. Method is available only if interrupt service/event is enabled.
   - PWM_SetPeriod -Setting PWM modulo register. The value is loaded after calling Load() method.
   - PWM_SetDuty -Setting duty(value) register of selected channel.  The value is loaded after calling Load() method.
   - PWM_SetDutyPercent -Setting duty(value) in percent of selected channel.  The value is loaded after calling Load() method.
   - PWM_Load -Apply last setting of the methods SetDuty, SetDutyPercent, SetPeriod and SetPrescaler.
   - PWM_OutputPadEnable -Method enables output pads.
   - PWM_OutputPadDisable -Method disables output pads.

Module "MFR"       (bean DSP_Func_MFR)
   - MFR_abs_s -The abs_s function calculates the 16-bit absolute value of the input value.
   - MFR_add -The add function adds two 16-bit fractional numbers (x + y).
   - MFR_div_s -The div_s function divides two fractional numbers (x / y); x and y must be positive and y must be greater than 
                or equal to x.
   - MFR_mac_r -The mac function multiplies two 16-bit fractional input values (x * y) and adds the 32-bit result to w.
   - MFR_msu_r -The msu function multiplies x by y and subtracts the 32-bit result from w.
   - MFR_mult -This multiplication function multiply two fractional input values and return the result.
   - MFR_mult_r -This multiplication function multiply two fractional input values and return the result. The function differs 
                from mult in that function rounds the result, whereas mult truncates the result to 16bits.
   - MFR_negate -The negate function negates the fractional input value.
   - MFR_round -The round function rounds the 32-bit fractional input value to 16 bits.
   - MFR_shl -The shl function arithmetically shifts the input variable x left n positions, zero filling the least significant 
                bits of the result. If n is negative, the shl function arithmetically shifts x right by -n bits with sign 
                extension.
   - MFR_shr -The shr function arithmetically shifts the input variable x right n positions, sign extending the result. If n is 
                negative, the shr function arithmetically shifts x left by -n bits, zero filling the least significant bits.
   - MFR_shr_r -The shr_r function arithmetically shifts the input variable x right n positions, sign extending the result. If 
                n is negative, the shr_r function arithmetically shifts x left by -n bits, zero filling the least significant 
                bits. shr_r differs from shr in that shr_r rounds the 32-bit fractional result.
   - MFR_sub -The sub function calculates (x - y).
   - MFR_L_abs -The L_abs function calculates the 32-bit absolute value of the input value.
   - MFR_L_add -The add function adds two 32-bit fractional numbers (x + y).
   - MFR_div_ls -The div_ls function divides two fractional numbers (x / y); x and y must be positive and y must be greater 
                than or equal to x.
   - MFR_L_mac -The mac function multiplies two 16-bit fractional input values (x * y) and adds the 32-bit result to w.
   - MFR_L_msu -The msu function multiplies x by y and subtracts the 32-bit result from w.
   - MFR_L_mult -This multiplication function multiply two fractional input values and return the result.
   - MFR_L_mult_ls -This multiplication function multiply two fractional input values and return the result. The function 
                differs from mult in that function rounds the result, whereas mult truncates the result to 16bits.
   - MFR_L_negate -The negate function negates the fractional input value.
   - MFR_L_shl -The L_shl function arithmetically shifts the input variable x left n positions, zero filling the least 
                significant bits of the result. If n is negative, the shl function arithmetically shifts x right by -n bits 
                with sign extension.
   - MFR_L_shr -The L_shr function arithmetically shifts the input variable x right n positions, sign extending the result. If 
                n is negative, the L_shr function arithmetically shifts x left by -n bits, zero filling the least significant 
                bits.
   - MFR_L_shr_r -The L_shr_r function arithmetically shifts the input variable x right n positions, sign extending the result. 
                If n is negative, the L_shr_r function arithmetically shifts x left by -n bits, zero filling the least 
                significant bits. L_shr_r differs from L_shr in that L_shr_r rounds the 32-bit fractional result.
   - MFR_L_deposit_h -The L_deposit_h function places a 16-bit fractional value into the most significant 16-bits of the 32-bit 
                fractional output value and zeroes the least significant 16 bits.
   - MFR_L_deposit_l -The L_deposit_l function places a 16-bit fractional value into the least significant 16 bits of the 
                32-bit fractional output value and sign extends the most significant 16 bits.
   - MFR_L_sub -The L_sub function calculates (x - y).
   - MFR_extract_h -The extract_h function extracts the most significant 16 bits from the 32-bit fractional value.
   - MFR_extract_l -The extract_l function extracts the least significant 16 bits from the 32-bit fractional value.
   - MFR_norm_s -The norm function calculates the number of left shifts needed to normalize a fractional value.
   - MFR_norm_l -The norm function calculates the number of left shifts needed to normalize a fractional value.
   - MFR_mfr16Rand -The function calculates a pseudo-random number.
   - MFR_mfr16SetRandSeed -The function sets the random number seed used by the pseudo-random number generation algorithm.
   - MFR_mfr16Sqrt -The function calculates the square root of the fractional input data value.
   - MFR_mfr32Sqrt -The function calculates the square root of the fractional input data value.

Module "ADC1"      (bean Init_ADC_56800)
   - ADC1_Init -This method initializes registers of the ADC module according to this Peripheral Initialization Bean settings. 
                Call this method in the user code to initialize the module. By default, the method is called by PE 
                automatically; see "Call Init method" property of the bean for more details.

Module "PB413"     (bean BitIO)
   - PB413_GetVal -Returns the input/output value. If the direction is [input] then the input value of the pin is read and 
                returned. If the direction is [output] then the last written value is returned (see <Safe mode> property for 
                limitations).
   - PB413_PutVal -The specified output value is set. If the direction is [input], the bean saves the value to a memory or a 
                register and this value will be written to the pin after switching to the output mode (using [SetDir(TRUE)]; 
                see <Safe mode> property for limitations). If the direction is [output], it writes the value to the pin. 
                (Method is available only if the direction = _[output]_ or _[input/output]_).
   - PB413_ClrVal -Clears (set to zero) the output value. It is equivalent to the [PutVal(FALSE)]. This method is available 
                only if the direction = _[output]_ or _[input/output]_.
   - PB413_SetVal -Sets (to one) the output value. It is equivalent to the [PutVal(TRUE)]. This method is available only if the 
                direction = _[output]_ or _[input/output]_.
   - PB413_NegVal -Negates (inverts) the output value. It is equivalent to the [PutVal(!GetVal())]. This method is available 
                only if the direction = _[output]_ or _[input/output]_.

Module "TI1"       (bean TimerInt)
   - TI1_Enable -Enables the bean - it starts the timer. Events may be generated ("DisableEvent"/"EnableEvent").
   - TI1_Disable -Disables the bean - it stops the timer. No events will be generated.
   - TI1_EnableEvent -Enables the events.
   - TI1_DisableEvent -Disables the events.

Module "TO1"       (bean TimerOut)
   - TO1_Enable -Enables the bean - starts the signal generation. Events may be generated ("DisableEvent"/"EnableEvent").

Module "ACRELAY"   (bean BitIO)
   - ACRELAY_SetDir -Sets a pin direction (available only if the direction = _[input/output]_).
   - ACRELAY_GetVal -Returns the input/output value. If the direction is [input] then the input value of the pin is read and 
                returned. If the direction is [output] then the last written value is returned (see <Safe mode> property for 
                limitations).
   - ACRELAY_PutVal -The specified output value is set. If the direction is [input], the bean saves the value to a memory or a 
                register and this value will be written to the pin after switching to the output mode (using [SetDir(TRUE)]; 
                see <Safe mode> property for limitations). If the direction is [output], it writes the value to the pin. 
                (Method is available only if the direction = _[output]_ or _[input/output]_).
   - ACRELAY_ClrVal -Clears (set to zero) the output value. It is equivalent to the [PutVal(FALSE)]. This method is available 
                only if the direction = _[output]_ or _[input/output]_.
   - ACRELAY_SetVal -Sets (to one) the output value. It is equivalent to the [PutVal(TRUE)]. This method is available only if 
                the direction = _[output]_ or _[input/output]_.

Module "LEDSPI"    (bean SynchroMaster)
   - LEDSPI_Enable -Enable the bean - it starts send and receive functions. Events may be generated 
                ("DisableEvent"/"EnableEvent").
   - LEDSPI_RecvChar -If any data is received, this method returns one character, otherwise it returns an error code (it does 
                not wait for data).  DMA mode:  If DMA controller is available on selected CPU and receiver is configured to 
                use DMA controller then this method only sets the selected DMA channel. Status of the DMA transfer can then be 
                checked using method GetCharsInRxBuf. See typical usage for details about communication using DMA.
   - LEDSPI_SendChar -Sends one character to the channel.  DMA mode:  If DMA controller is available on the selected CPU and 
                the transmitter is configured to use DMA controller then this method only sets the selected DMA channel. The 
                status of the DMA transfer can then be checked using GetCharsInTxBuf method. See the typical usage for details 
                about communication using DMA.
   - LEDSPI_GetCharsInRxBuf -Returns the number of characters in the input buffer.  Note: If the Interrupt service is disabled, 
                and the Ignore empty character is set to yes, and a character has been received, then this method returns 1 
                although it was an empty character.  DMA mode:  If DMA controller is available on the selected CPU and the 
                receiver is configured to use DMA controller then this method returns the number of characters in the receive 
                buffer.
   - LEDSPI_GetCharsInTxBuf -Returns the number of characters in the output buffer.  DMA mode:  If DMA controller is available 
                on the selected CPU and the transmitter is configured to use DMA controller then this method returns the number 
                of characters in the transmit buffer.

Module "SCIAS"     (bean AsynchroSerial)

Module "Cpu"       (bean 56F8013VFAE)
   - Cpu_EnableInt -Enables all maskable interrupts
   - Cpu_DisableInt -Disables all maskable interrupts
   - Cpu_SetWaitMode -Sets low power mode - Wait mode.  For more information about the wait mode see this CPU documentation.  
                Release from wait mode: Reset or interrupt
   - Cpu_SetStopMode -Sets low power mode - Stop mode.  For more information about the stop mode see this CPU documentation.

===================================================================================