serial.h File Reference

Go to the source code of this file.

Typedefs

typedef void * xComPortHandle

Enumerations

enum eBaud {
  ser50, ser75, ser110, ser134,
  ser150, ser200, ser300, ser600,
  ser1200, ser1800, ser2400, ser4800,
  ser9600, ser19200, ser38400, ser57600,
  ser115200
}

enum eCOMPort {
  serCOM1, serCOM2, serCOM3, serCOM4,
  serCOM5, serCOM6, serCOM7, serCOM8
}

enum eDataBits { serBITS_5, serBITS_6, serBITS_7, serBITS_8 }

enum eParity {
  serNO_PARITY, serODD_PARITY, serEVEN_PARITY, serMARK_PARITY,
  serSPACE_PARITY
}

enum eStopBits { serSTOP_1, serSTOP_2 }

Functions

void vSerialClose (xComPortHandle xPort)

void vSerialPutString (xComPortHandle pxPort, const signed char *const pcString, unsigned short usStringLength)

signed portBASE_TYPE xSerialGetChar (xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime)

xComPortHandle xSerialPortInit (eCOMPort ePort, eBaud eWantedBaud, eParity eWantedParity, eDataBits eWantedDataBits, eStopBits eWantedStopBits, unsigned portBASE_TYPE uxBufferLength)

xComPortHandle xSerialPortInitMinimal (unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength)

signed portBASE_TYPE xSerialPutChar (xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime)

portBASE_TYPE xSerialWaitForSemaphore (xComPortHandle xPort)

Typedef Documentation

typedef void* xComPortHandle

Definition at line 57 of file serial.h.

Enumeration Type Documentation

enum eBaud

Enumerator:

ser50
ser75
ser110
ser134
ser150
ser200
ser300
ser600
ser1200
ser1800
ser2400
ser4800
ser9600
ser19200
ser38400
ser57600
ser115200

Definition at line 94 of file serial.h.

00095 { 
00096     ser50,      
00097     ser75,      
00098     ser110,     
00099     ser134,     
00100     ser150,    
00101     ser200,
00102     ser300,     
00103     ser600,     
00104     ser1200,    
00105     ser1800,    
00106     ser2400,   
00107     ser4800,
00108     ser9600,        
00109     ser19200,   
00110     ser38400,   
00111     ser57600,   
00112     ser115200
00113 } eBaud;

enum eCOMPort

Enumerator:

serCOM1
serCOM2
serCOM3
serCOM4
serCOM5
serCOM6
serCOM7
serCOM8

Definition at line 59 of file serial.h.

00060 { 
00061     serCOM1, 
00062     serCOM2, 
00063     serCOM3, 
00064     serCOM4, 
00065     serCOM5, 
00066     serCOM6, 
00067     serCOM7, 
00068     serCOM8 
00069 } eCOMPort;

enum eDataBits

Enumerator:

serBITS_5
serBITS_6
serBITS_7
serBITS_8

Definition at line 86 of file serial.h.

00087 { 
00088     serBITS_5, 
00089     serBITS_6, 
00090     serBITS_7, 
00091     serBITS_8 
00092 } eDataBits;

enum eParity

Enumerator:

serNO_PARITY
serODD_PARITY
serEVEN_PARITY
serMARK_PARITY
serSPACE_PARITY

Definition at line 71 of file serial.h.

00072 { 
00073     serNO_PARITY, 
00074     serODD_PARITY, 
00075     serEVEN_PARITY, 
00076     serMARK_PARITY, 
00077     serSPACE_PARITY 
00078 } eParity;

enum eStopBits

Enumerator:

serSTOP_1
serSTOP_2

Definition at line 80 of file serial.h.

00081 { 
00082     serSTOP_1, 
00083     serSTOP_2 
00084 } eStopBits;

Function Documentation

void vSerialClose ( xComPortHandle xPort )

Definition at line 298 of file serial.c.

00299 {
00300   /* Not supported as not required by the demo application. */
00301 }

void vSerialPutString	(	xComPortHandle	pxPort,
		const signed char *const	pcString,
		unsigned short	usStringLength
	)

signed portBASE_TYPE xSerialGetChar	(	xComPortHandle	pxPort,
		signed char *	pcRxedChar,
		portTickType	xBlockTime
	)

xComPortHandle xSerialPortInit	(	eCOMPort	ePort,
		eBaud	eWantedBaud,
		eParity	eWantedParity,
		eDataBits	eWantedDataBits,
		eStopBits	eWantedStopBits,
		unsigned portBASE_TYPE	uxBufferLength
	)

xComPortHandle xSerialPortInitMinimal	(	unsigned long	ulWantedBaud,
		unsigned portBASE_TYPE	uxQueueLength
	)

signed portBASE_TYPE xSerialPutChar	(	xComPortHandle	pxPort,
		signed char	cOutChar,
		portTickType	xBlockTime
	)

portBASE_TYPE xSerialWaitForSemaphore ( xComPortHandle xPort )


Typedefs
typedef void *	xComPortHandle
Enumerations
enum	eBaud { ser50, ser75, ser110, ser134, ser150, ser200, ser300, ser600, ser1200, ser1800, ser2400, ser4800, ser9600, ser19200, ser38400, ser57600, ser115200 }
enum	eCOMPort { serCOM1, serCOM2, serCOM3, serCOM4, serCOM5, serCOM6, serCOM7, serCOM8 }
enum	eDataBits { serBITS_5, serBITS_6, serBITS_7, serBITS_8 }
enum	eParity { serNO_PARITY, serODD_PARITY, serEVEN_PARITY, serMARK_PARITY, serSPACE_PARITY }
enum	eStopBits { serSTOP_1, serSTOP_2 }
Functions
void	vSerialClose (xComPortHandle xPort)
void	vSerialPutString (xComPortHandle pxPort, const signed char *const pcString, unsigned short usStringLength)
signed portBASE_TYPE	xSerialGetChar (xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime)
xComPortHandle	xSerialPortInit (eCOMPort ePort, eBaud eWantedBaud, eParity eWantedParity, eDataBits eWantedDataBits, eStopBits eWantedStopBits, unsigned portBASE_TYPE uxBufferLength)
xComPortHandle	xSerialPortInitMinimal (unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength)
signed portBASE_TYPE	xSerialPutChar (xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime)
portBASE_TYPE	xSerialWaitForSemaphore (xComPortHandle xPort)