iLLD_TC29x  1.0
IfxAsclin_Asc.h File Reference

ASCLIN ASC details. More...

Go to the source code of this file.

Data Structures

struct  IfxAsclin_Asc_ErrorFlags
 Structure for Error Flags. More...
 
struct  IfxAsclin_Asc_BaudRate
 Structure for baudrate. More...
 
struct  IfxAsclin_Asc_BitTimingControl
 Structure for bit timings. More...
 
struct  IfxAsclin_Asc_FifoControl
 Structure for FIFO control. More...
 
struct  IfxAsclin_Asc_FrameControl
 Structure for frame control. More...
 
struct  IfxAsclin_Asc_InterruptConfig
 Structure for interrupt configuration. More...
 
struct  IfxAsclin_Asc_Pins
 Structure for ASC pin configuration. More...
 
union  IfxAsclin_Asc_ErrorFlagsUnion
 This union contains the error flags. In addition it allows to write and read to/from all flags as once via the ALL member. More...
 
struct  IfxAsclin_Asc
 Module Handle. More...
 
struct  IfxAsclin_Asc_Config
 Configuration structure of the module. More...
 

Functions

IFX_EXTERN void IfxAsclin_Asc_isrError (IfxAsclin_Asc *asclin)
 ISR error routine. More...
 
IFX_EXTERN void IfxAsclin_Asc_isrReceive (IfxAsclin_Asc *asclin)
 ISR receive routine. More...
 
IFX_EXTERN void IfxAsclin_Asc_isrTransmit (IfxAsclin_Asc *asclin)
 ISR transmit routine. More...
 
IFX_EXTERN uint8 IfxAsclin_Asc_blockingRead (IfxAsclin_Asc *asclin)
 Reads data from the Rx FIFO. More...
 
IFX_EXTERN boolean IfxAsclin_Asc_blockingWrite (IfxAsclin_Asc *asclin, uint8 data)
 Writes data into the Tx FIFO. More...
 
IFX_EXTERN boolean IfxAsclin_Asc_canReadCount (IfxAsclin_Asc *asclin, Ifx_SizeT count, Ifx_TickTime timeout)
 
IFX_EXTERN boolean IfxAsclin_Asc_canWriteCount (IfxAsclin_Asc *asclin, Ifx_SizeT count, Ifx_TickTime timeout)
 
IFX_EXTERN void IfxAsclin_Asc_clearRx (IfxAsclin_Asc *asclin)
 
IFX_EXTERN void IfxAsclin_Asc_clearTx (IfxAsclin_Asc *asclin)
 
IFX_EXTERN boolean IfxAsclin_Asc_flushTx (IfxAsclin_Asc *asclin, Ifx_TickTime timeout)
 
IFX_EXTERN sint32 IfxAsclin_Asc_getReadCount (IfxAsclin_Asc *asclin)
 
IFX_EXTERN IfxStdIf_DPipe_ReadEvent IfxAsclin_Asc_getReadEvent (IfxAsclin_Asc *asclin)
 
IFX_EXTERN uint32 IfxAsclin_Asc_getSendCount (IfxAsclin_Asc *asclin)
 
IFX_EXTERN Ifx_TickTime IfxAsclin_Asc_getTxTimeStamp (IfxAsclin_Asc *asclin)
 
IFX_EXTERN sint32 IfxAsclin_Asc_getWriteCount (IfxAsclin_Asc *asclin)
 
IFX_EXTERN
IfxStdIf_DPipe_WriteEvent 
IfxAsclin_Asc_getWriteEvent (IfxAsclin_Asc *asclin)
 
IFX_EXTERN boolean IfxAsclin_Asc_read (IfxAsclin_Asc *asclin, void *data, Ifx_SizeT *count, Ifx_TickTime timeout)
 
IFX_EXTERN void IfxAsclin_Asc_resetSendCount (IfxAsclin_Asc *asclin)
 
IFX_EXTERN boolean IfxAsclin_Asc_write (IfxAsclin_Asc *asclin, void *data, Ifx_SizeT *count, Ifx_TickTime timeout)
 
IFX_EXTERN void IfxAsclin_Asc_disableModule (IfxAsclin_Asc *asclin)
 Disables the module. More...
 
IFX_EXTERN IfxAsclin_Status IfxAsclin_Asc_initModule (IfxAsclin_Asc *asclin, const IfxAsclin_Asc_Config *config)
 Initialises the module. More...
 
IFX_EXTERN void IfxAsclin_Asc_initModuleConfig (IfxAsclin_Asc_Config *config, Ifx_ASCLIN *asclin)
 Fills the config structure with default values. More...
 
IFX_EXTERN void IfxAsclin_Asc_initiateTransmission (IfxAsclin_Asc *asclin)
 Initiate the data transmission. More...
 
IFX_EXTERN boolean IfxAsclin_Asc_stdIfDPipeInit (IfxStdIf_DPipe *stdif, IfxAsclin_Asc *asclin)
 Initialize the standard interface to the device driver. More...
 

Detailed Description

ASCLIN ASC details.

Version
iLLD_1_0_0_11_0
                            IMPORTANT NOTICE

Infineon Technologies AG (Infineon) is supplying this file for use exclusively with Infineon's microcontroller products. This file can be freely distributed within development tools that are supporting such microcontroller products.

THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. INFINEON SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.

Definition in file IfxAsclin_Asc.h.


Data Structure Documentation

struct IfxAsclin_Asc_ErrorFlags

Structure for Error Flags.

Definition at line 232 of file IfxAsclin_Asc.h.

Data Fields
uint8 frameError: 1 transmit complete/pending error
uint8 parityError: 1 parity error
uint8 rxFifoOverflow: 1 receive FIFO overflow error
uint8 rxFifoUnderflow: 1 receive FIFO underflow error
uint8 txFifoOverflow: 1 transmit FIFO overflow error
union IfxAsclin_Asc_ErrorFlagsUnion

This union contains the error flags. In addition it allows to write and read to/from all flags as once via the ALL member.

Definition at line 313 of file IfxAsclin_Asc.h.

Collaboration diagram for IfxAsclin_Asc_ErrorFlagsUnion:
Data Fields
uint8 ALL
IfxAsclin_Asc_ErrorFlags flags

Function Documentation

IFX_EXTERN void IfxAsclin_Asc_initiateTransmission ( IfxAsclin_Asc asclin)

Initiate the data transmission.

Parameters
asclinmodule handle
Returns
None

A coding example can be found in How to use the ASCLIN ASC Interface driver?

Definition at line 383 of file IfxAsclin_Asc.c.

Referenced by IfxAsclin_Asc_write().

IFX_EXTERN boolean IfxAsclin_Asc_stdIfDPipeInit ( IfxStdIf_DPipe stdif,
IfxAsclin_Asc asclin 
)

Initialize the standard interface to the device driver.

Parameters
stdifstandard interface object, will be initialized by the function
asclindevice driver object used by the standard interface. must be initialised separately
Returns
TRUE on success, else FALSE

Definition at line 553 of file IfxAsclin_Asc.c.