Standard interface: Data Pipe. More...

#include "IfxStdIf.h"

Data Structures
struct	IfxStdIf_DPipe_
	Standard interface object. More...

Macros
#define	ENDL "\r\n"

#define	STDIF_DPIPE_MAX_PRINT_SIZE (255)
	Size of the buffer allocated on the stack for the print function. More...

Typedefs
typedef struct IfxStdIf_DPipe_	IfxStdIf_DPipe
	Forward declaration. More...

typedef volatile boolean *	IfxStdIf_DPipe_WriteEvent

typedef volatile boolean *	IfxStdIf_DPipe_ReadEvent

typedef boolean(*	IfxStdIf_DPipe_Write )(IfxStdIf_InterfaceDriver driver, void data, Ifx_SizeT count, Ifx_TickTime timeout)
	Write binary data into the IfxStdIf_DPipe. More...

typedef boolean(*	IfxStdIf_DPipe_Read )(IfxStdIf_InterfaceDriver driver, void data, Ifx_SizeT count, Ifx_TickTime timeout)
	Read data from the IfxStdIf_DPipe object. More...

typedef sint32(*	IfxStdIf_DPipe_GetReadCount )(IfxStdIf_InterfaceDriver driver)
	Returns the number of bytes in the rx buffer. More...

typedef IfxStdIf_DPipe_ReadEvent(*	IfxStdIf_DPipe_GetReadEvent )(IfxStdIf_InterfaceDriver driver)
	Returns read event object. More...

typedef uint32(*	IfxStdIf_DPipe_GetSendCount )(IfxStdIf_InterfaceDriver driver)
	Returns number of bytes send. More...

typedef Ifx_TickTime(*	IfxStdIf_DPipe_GetTxTimeStamp )(IfxStdIf_InterfaceDriver driver)
	Returns the time stamp of the last transmit data. More...

typedef sint32(*	IfxStdIf_DPipe_GetWriteCount )(IfxStdIf_InterfaceDriver driver)
	Returns the number of free bytes (free space) in the tx buffer. More...

typedef IfxStdIf_DPipe_WriteEvent(*	IfxStdIf_DPipe_GetWriteEvent )(IfxStdIf_InterfaceDriver driver)
	Returns write event object. More...

typedef boolean(*	IfxStdIf_DPipe_CanReadCount )(IfxStdIf_InterfaceDriver driver, Ifx_SizeT count, Ifx_TickTime timeout)
	Indicates if the required number of bytes are available for read in the buffer. More...

typedef boolean(*	IfxStdIf_DPipe_CanWriteCount )(IfxStdIf_InterfaceDriver driver, Ifx_SizeT count, Ifx_TickTime timeout)
	Indicates if there is enough free space to write the data in the buffer. More...

typedef boolean(*	IfxStdIf_DPipe_FlushTx )(IfxStdIf_InterfaceDriver driver, Ifx_TickTime timeout)
	Flush the transmit buffer by transmitting all data. More...

typedef void(*	IfxStdIf_DPipe_ClearRx )(IfxStdIf_InterfaceDriver driver)
	Clears the RX buffer by removing all data. More...

typedef void(*	IfxStdIf_DPipe_ClearTx )(IfxStdIf_InterfaceDriver driver)
	Clears the TX buffer by removing all data. More...

typedef void(*	IfxStdIf_DPipe_OnReceive )(IfxStdIf_InterfaceDriver driver)
	handler called on reveive event More...

typedef void(*	IfxStdIf_DPipe_OnTransmit )(IfxStdIf_InterfaceDriver driver)
	handler called on transmit event More...

typedef void(*	IfxStdIf_DPipe_OnError )(IfxStdIf_InterfaceDriver driver)
	handler called on error event More...

typedef void(*	IfxStdIf_DPipe_ResetSendCount )(IfxStdIf_InterfaceDriver driver)
	Reset the sendCount counter. More...

Functions
IFX_INLINE boolean	IfxStdIf_DPipe_write (IfxStdIf_DPipe stdif, void data, Ifx_SizeT *count, Ifx_TickTime timeout)
	Write binary data into the IfxStdIf_DPipe. More...

IFX_INLINE boolean	IfxStdIf_DPipe_read (IfxStdIf_DPipe stdif, void data, Ifx_SizeT *count, Ifx_TickTime timeout)
	Read data from the IfxStdIf_DPipe object. More...

IFX_INLINE sint32	IfxStdIf_DPipe_getReadCount (IfxStdIf_DPipe *stdif)
	Returns the number of bytes in the rx buffer. More...

IFX_INLINE sint32	IfxStdIf_DPipe_getWriteCount (IfxStdIf_DPipe *stdif)
	Returns the number of free bytes (free space) in the tx buffer. More...

IFX_INLINE boolean	IfxStdIf_DPipe_canReadCount (IfxStdIf_DPipe *stdif, Ifx_SizeT count, Ifx_TickTime timeout)
	Indicates if the required number of bytes are available for read in the buffer. More...

IFX_INLINE boolean	IfxStdIf_DPipe_canWriteCount (IfxStdIf_DPipe *stdif, Ifx_SizeT count, Ifx_TickTime timeout)
	Indicates if there is enough free space to write the data in the buffer. More...

IFX_INLINE IfxStdIf_DPipe_ReadEvent	IfxStdIf_DPipe_getReadEvent (IfxStdIf_DPipe *stdif)
	Returns read event object. More...

IFX_INLINE IfxStdIf_DPipe_WriteEvent	IfxStdIf_DPipe_getWriteEvent (IfxStdIf_DPipe *stdif)
	Returns write event object. More...

IFX_INLINE boolean	IfxStdIf_DPipe_flushTx (IfxStdIf_DPipe *stdif, Ifx_TickTime timeout)
	Flush the transmit buffer by transmitting all data. More...

IFX_INLINE void	IfxStdIf_DPipe_clearTx (IfxStdIf_DPipe *stdif)
	Clears the TX buffer by removing all data. More...

IFX_INLINE void	IfxStdIf_DPipe_clearRx (IfxStdIf_DPipe *stdif)
	Clears the RX buffer by removing all data. More...

IFX_INLINE void	IfxStdIf_DPipe_onReceive (IfxStdIf_DPipe *stdif)
	handler called on reveive event More...

IFX_INLINE void	IfxStdIf_DPipe_onTransmit (IfxStdIf_DPipe *stdif)
	handler called on transmit event More...

IFX_INLINE void	IfxStdIf_DPipe_onError (IfxStdIf_DPipe *stdif)
	handler called on error event More...

IFX_INLINE uint32	IfxStdIf_DPipe_getSendCount (IfxStdIf_DPipe *stdif)
	Returns number of bytes send. More...

IFX_INLINE Ifx_TickTime	IfxStdIf_DPipe_getTxTimeStamp (IfxStdIf_DPipe *stdif)
	Returns the time stamp of the last transmit data. More...

IFX_INLINE void	IfxStdIf_DPipe_resetSendCount (IfxStdIf_DPipe *stdif)
	Reset the sendCount counter. More...

IFX_EXTERN void	IfxStdIf_DPipe_print (IfxStdIf_DPipe *stdif, pchar format,...)

Detailed Description

Standard interface: Data Pipe.

Version: iLLD_1_0_0_11_0

Copyright: Copyright (c) 2013 Infineon Technologies AG. All rights reserved.

                            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 IfxStdIf_DPipe.h.

Data Structure Documentation

struct IfxStdIf_DPipe_

Standard interface object.

Definition at line 213 of file IfxStdIf_DPipe.h.

Data Fields
IfxStdIf_DPipe_CanReadCount	canReadCount	See Also IfxStdIf_DPipe_CanReadCount
IfxStdIf_DPipe_CanWriteCount	canWriteCount	See Also IfxStdIf_DPipe_CanWriteCount
IfxStdIf_DPipe_ClearRx	clearRx	See Also IfxStdIf_DPipe_ClearRx
IfxStdIf_DPipe_ClearTx	clearTx	See Also IfxStdIf_DPipe_ClearTx
IfxStdIf_InterfaceDriver	driver	Pointer to the specific driver object.
IfxStdIf_DPipe_FlushTx	flushTx	See Also IfxStdIf_DPipe_FlushTx
IfxStdIf_DPipe_GetReadCount	getReadCount	See Also IfxStdIf_DPipe_GetReadCount
IfxStdIf_DPipe_GetReadEvent	getReadEvent	See Also IfxStdIf_DPipe_GetReadEvent
IfxStdIf_DPipe_GetSendCount	getSendCount	See Also IfxStdIf_DPipe_GetSendCount
IfxStdIf_DPipe_GetTxTimeStamp	getTxTimeStamp	See Also IfxStdIf_DPipe_GetTxTimeStamp
IfxStdIf_DPipe_GetWriteCount	getWriteCount	See Also IfxStdIf_DPipe_GetWriteCount
IfxStdIf_DPipe_GetWriteEvent	getWriteEvent	See Also IfxStdIf_DPipe_GetWriteEvent
IfxStdIf_DPipe_OnError	onError	See Also IfxStdIf_DPipe_OnError
IfxStdIf_DPipe_OnReceive	onReceive	See Also IfxStdIf_DPipe_OnReceive
IfxStdIf_DPipe_OnTransmit	onTransmit	See Also IfxStdIf_DPipe_OnTransmit
IfxStdIf_DPipe_Read	read	See Also IfxStdIf_DPipe_Read
IfxStdIf_DPipe_ResetSendCount	resetSendCount	See Also IfxStdIf_DPipe_ResetSendCount
boolean	txDisabled	If disabled is set to TRUE, the output is disabled, else enabled.
IfxStdIf_DPipe_Write	write	See Also IfxStdIf_DPipe_Write

Macro Definition Documentation

#define ENDL "\r\n"

Definition at line 47 of file IfxStdIf_DPipe.h.

Referenced by Ifx_Assert_doLevel(), Ifx_Assert_doValidate(), Ifx_Shell_bbProtocolStart(), Ifx_Shell_execute(), Ifx_Shell_init(), Ifx_Shell_printSyntax(), Ifx_Shell_process(), Ifx_Shell_protocolStart(), and Ifx_Shell_showHelpSingle().

#define STDIF_DPIPE_MAX_PRINT_SIZE (255)

Size of the buffer allocated on the stack for the print function.

Definition at line 57 of file IfxStdIf_DPipe.h.

Referenced by Ifx_Console_print(), Ifx_Console_printAlign(), and IfxStdIf_DPipe_print().

Typedef Documentation

typedef struct IfxStdIf_DPipe_ IfxStdIf_DPipe

Forward declaration.

Definition at line 51 of file IfxStdIf_DPipe.h.

typedef boolean(* IfxStdIf_DPipe_CanReadCount)(IfxStdIf_InterfaceDriver driver, Ifx_SizeT count, Ifx_TickTime timeout)

Indicates if the required number of bytes are available for read in the buffer.

Parameters

driver	Pointer to the interface driver object
count	Pointer to the count of data (in bytes).
timeout	in system timer ticks

Returns: Returns TRUE if at least count bytes are available for read in the rx buffer, if not the Event is armed to be set when the buffer count is bigger or equal to the requested count

Definition at line 146 of file IfxStdIf_DPipe.h.

typedef boolean(* IfxStdIf_DPipe_CanWriteCount)(IfxStdIf_InterfaceDriver driver, Ifx_SizeT count, Ifx_TickTime timeout)

Indicates if there is enough free space to write the data in the buffer.

Parameters

driver	Pointer to the interface driver object
count	Pointer to the count of data (in bytes).
timeout	in system timer ticks

Returns: Returns TRUE if at least count bytes can be written to the tx buffer, if not the Event is armed to be set when the buffer free count is bigger or equal to the requested count

Definition at line 157 of file IfxStdIf_DPipe.h.

typedef void(* IfxStdIf_DPipe_ClearRx)(IfxStdIf_InterfaceDriver driver)

Clears the RX buffer by removing all data.

Parameters

driver Pointer to the interface driver object

Returns: void

Definition at line 173 of file IfxStdIf_DPipe.h.

typedef void(* IfxStdIf_DPipe_ClearTx)(IfxStdIf_InterfaceDriver driver)

Clears the TX buffer by removing all data.

Parameters

driver Pointer to the interface driver object

Returns: void

Definition at line 180 of file IfxStdIf_DPipe.h.

typedef boolean(* IfxStdIf_DPipe_FlushTx)(IfxStdIf_InterfaceDriver driver, Ifx_TickTime timeout)

Flush the transmit buffer by transmitting all data.

Parameters

driver	Pointer to the interface driver object
timeout	timeout for the flush operation

Returns: Returns TRUE if the FIFO is empty

Definition at line 166 of file IfxStdIf_DPipe.h.

typedef sint32(* IfxStdIf_DPipe_GetReadCount)(IfxStdIf_InterfaceDriver driver)

Returns the number of bytes in the rx buffer.

Parameters

driver Pointer to the interface driver object

Returns: Returns the number of bytes in the rx buffer

Definition at line 95 of file IfxStdIf_DPipe.h.

typedef IfxStdIf_DPipe_ReadEvent(* IfxStdIf_DPipe_GetReadEvent)(IfxStdIf_InterfaceDriver driver)

Returns read event object.

Parameters

driver Pointer to the interface driver object

Returns: Returns read event object

Definition at line 103 of file IfxStdIf_DPipe.h.

typedef uint32(* IfxStdIf_DPipe_GetSendCount)(IfxStdIf_InterfaceDriver driver)

Returns number of bytes send.

Parameters

driver Pointer to the interface driver object

Returns: Returns number of bytes send

Definition at line 111 of file IfxStdIf_DPipe.h.

typedef Ifx_TickTime(* IfxStdIf_DPipe_GetTxTimeStamp)(IfxStdIf_InterfaceDriver driver)

Returns the time stamp of the last transmit data.

Parameters

driver Pointer to the interface driver object

Returns: Returns the time stamp of the last transmit data

Definition at line 119 of file IfxStdIf_DPipe.h.

typedef sint32(* IfxStdIf_DPipe_GetWriteCount)(IfxStdIf_InterfaceDriver driver)

Returns the number of free bytes (free space) in the tx buffer.

Parameters

driver Pointer to the interface driver object

Returns: Returns the number of free bytes in the tx buffer

Definition at line 127 of file IfxStdIf_DPipe.h.

typedef IfxStdIf_DPipe_WriteEvent(* IfxStdIf_DPipe_GetWriteEvent)(IfxStdIf_InterfaceDriver driver)

Returns write event object.

Parameters

driver Pointer to the interface driver object

Returns: Returns write event object

Definition at line 135 of file IfxStdIf_DPipe.h.

typedef void(* IfxStdIf_DPipe_OnError)(IfxStdIf_InterfaceDriver driver)

handler called on error event

Parameters

driver Pointer to the interface driver object

Returns: none

Definition at line 202 of file IfxStdIf_DPipe.h.

typedef void(* IfxStdIf_DPipe_OnReceive)(IfxStdIf_InterfaceDriver driver)

handler called on reveive event

Parameters

driver Pointer to the interface driver object

Returns: none

Definition at line 188 of file IfxStdIf_DPipe.h.

typedef void(* IfxStdIf_DPipe_OnTransmit)(IfxStdIf_InterfaceDriver driver)

handler called on transmit event

Parameters

driver Pointer to the interface driver object

Returns: none

Definition at line 195 of file IfxStdIf_DPipe.h.

typedef boolean(* IfxStdIf_DPipe_Read)(IfxStdIf_InterfaceDriver driver, void *data, Ifx_SizeT *count, Ifx_TickTime timeout)

Read data from the IfxStdIf_DPipe object.

Initially the parameter 'count' specifies count of data to read. After execution the data pointed by 'count' specifies the data actually read.

Parameters

driver	Pointer to the interface driver object
data	Pointer to the start of data
count	Pointer to the count of data (in bytes).
timeout	in system timer ticks

Return values

TRUE	Returns TRUE if all items could be read
FALSE	Returns FALSE if not all the items could be read

Definition at line 87 of file IfxStdIf_DPipe.h.

typedef volatile boolean* IfxStdIf_DPipe_ReadEvent

Definition at line 54 of file IfxStdIf_DPipe.h.

typedef void(* IfxStdIf_DPipe_ResetSendCount)(IfxStdIf_InterfaceDriver driver)

Reset the sendCount counter.

Parameters

driver Pointer to the interface driver object

Returns: none

Definition at line 209 of file IfxStdIf_DPipe.h.

typedef boolean(* IfxStdIf_DPipe_Write)(IfxStdIf_InterfaceDriver driver, void *data, Ifx_SizeT *count, Ifx_TickTime timeout)

Write binary data into the IfxStdIf_DPipe.

Initially the parameter 'count' specifies count of data to write. After execution the data pointed by 'count' specifies the data actually written

Parameters

driver	Pointer to the interface driver object
data	Pointer to the start of data
count	Pointer to the count of data (in bytes).
timeout	in system timer ticks

Return values

TRUE	Returns TRUE if all items could be written
FALSE	Returns FALSE if not all the items could be written

Definition at line 72 of file IfxStdIf_DPipe.h.

typedef volatile boolean* IfxStdIf_DPipe_WriteEvent

Definition at line 53 of file IfxStdIf_DPipe.h.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

Macro Definition Documentation

Typedef Documentation