spi_master.doc

SPI主机模式进行串行通信

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

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

Module "slave_select" (bean BitIO)
   - slave_select_GetDir -Returns the selected direction.
   - slave_select_GetVal -Returns the value of the Input/Output bean. 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).
   - slave_select_PutVal -Specified value is passed to the Input/Output bean. If the direction is [input] saves the value to a 
                memory or a register, 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]_).
   - slave_select_ClrVal -Clears (set to zero) the Input/Output bean. It is the same as [PutVal(FALSE)]. (Method is available 
                only if the direction = _[output]_ or _[input/output]_).
   - slave_select_SetVal -Sets (to one) the Input/Output bean. It is the same as [PutVal(TRUE)]. (Method is available only if 
                the direction = _[output]_ or _[input/output]_).

Module "PC_M1"     (bean PC_Master)
   - PC_M1_pcmasterdrvGetAppCmdSts -Get Application Command Status. This function is used to check if an application command 
                has been received from PC.
   - PC_M1_pcmasterdrvWriteAppCmdSts -Write Application Command Status. This function clears the flags in application command 
                status word.
   - PC_M1_pcmasterdrvRecorder -Recorder Routine. It performs sampling of data into buffer which is located on the address 
                p_recBuff item is pointing and its length is determined by recSize item in the initialization structure of 
                sPCMasterComm type.
   - PC_M1_getPCMasterComm -This method returns the pointer to the sPCMasterComm structure.

Module "SM1"       (bean SynchroMaster)
   - SM1_Enable -Enable the bean - it starts send and receive functions. Events may be generated ("DisableEvent"/"EnableEvent").
   - SM1_Disable -Disable the bean - it stops the send and receive functions. No events will be generated.
   - SM1_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.
   - SM1_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.
   - SM1_CharsInRxBuf -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.  (deprecated method)  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.
   - SM1_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.
   - SM1_CharsInTxBuf -Returns the number of characters in the output buffer.  (deprecated method)  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.
   - SM1_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.
   - SM1_SetShiftClockPolarity -Sets the shift clock polarity at runtime. Output data will be shifted on the selected edge 
                polarity.
   - SM1_SetIdleClockPolarity -Sets the idle clock polarity at runtime. If the communication does not run, the clock signal 
                will have required level.

Module "Delay_timer" (bean TimerInt)
   - Delay_timer_Enable -Enables the bean - it starts the timer. Events may be generated ("DisableEvent"/"EnableEvent").
   - Delay_timer_Disable -Disables the bean - it stops the timer. No events will be generated.
   - Delay_timer_EnableEvent -Enables the events.
   - Delay_timer_DisableEvent -Disables the events.

Module "Cpu"       (bean 56F8346)
   - 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.
   - Cpu_SetDataMode -Sets the Data memory map to use either internal & external resources or external resources only.

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