ildependencies.h File Reference

Macros
#define	FIFO_BUFFER_SIZE   64
#define	MAX_OUTSTANDING   DCE_MAX_QUEUE_DEPTH
#define	READ_CREDIT_TIMEOUT   (2L * 1000L)
#define	WRITE_CREDITS_TIMEOUT   (2L * 1000L)
#define	MAX_SET_CREDITS   MAX_CREDITS
#define	MAX_SET_LAYER_0_DATA_SIZE   MAX_LAYER_0_DATA_SIZE
#define	MAX_SET_BAUD_RATE   DEF_BAUD_RATE
#define	TIME_DELAY_PAUSE   10
#define	minMacro(a, b)   (((a)<(b))?(a):(b))
#define	maxMacro(a, b)   (((a)>(b))?(a):(b))

Typedefs
typedef unsigned char	uint8
typedef unsigned short	uint16
typedef unsigned long	uint32
typedef unsigned long long	uint64
typedef signed char	int8
typedef signed short	int16
typedef signed long	int32
typedef signed long long	int64
typedef float	float32
typedef double	float64

Functions
uint8	toLittleEndian (uint8 value)
uint16	toLittleEndian (uint16 value)
uint32	toLittleEndian (uint32 value)
uint64	toLittleEndian (uint64 value)
int8	toLittleEndian (int8 value)
int16	toLittleEndian (int16 value)
int32	toLittleEndian (int32 value)
int64	toLittleEndian (int64 value)
float32	toLittleEndian (float32 value)
float64	toLittleEndian (float64 value)
uint8	fromLittleEndian (uint8 value)
uint16	fromLittleEndian (uint16 value)
uint32	fromLittleEndian (uint32 value)
uint64	fromLittleEndian (uint64 value)
int8	fromLittleEndian (int8 value)
int16	fromLittleEndian (int16 value)
int32	fromLittleEndian (int32 value)
int64	fromLittleEndian (int64 value)
float32	fromLittleEndian (float32 value)
float64	fromLittleEndian (float64 value)
void	serialBegin ()
void	serialEnd ()
int	serialAvailable ()
int	serialRead ()
void	serialWrite (char data)
void	serialWrite (const char *data, uint32 size)
uint32	timeMicroseconds ()
uint32	timeMilliseconds ()
void	timeDelayMicroseconds (uint32 microseconds)
void	timeDelayMilliseconds (uint32 milliseconds)

Detailed Description

Interface Library Dependencies

Version

1.0

Date

3/16/2014

Author

Kwabena W. Agyeman

Copyright

(c) 2014 Kwabena W. Agyeman
All rights reserved - Please see the end of the file for the terms of use

Update History:

v1.0 - Original release - 3/16/2014

MIT License - TERMS OF USE:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Macro Definition Documentation

#define FIFO_BUFFER_SIZE   64

#define MAX_OUTSTANDING   DCE_MAX_QUEUE_DEPTH

#define READ_CREDIT_TIMEOUT   (2L * 1000L)

#define WRITE_CREDITS_TIMEOUT   (2L * 1000L)

#define MAX_SET_CREDITS   MAX_CREDITS

#define MAX_SET_LAYER_0_DATA_SIZE   MAX_LAYER_0_DATA_SIZE

#define MAX_SET_BAUD_RATE   DEF_BAUD_RATE

#define TIME_DELAY_PAUSE   10

#define minMacro	(		a,
			b
	)		(((a)<(b))?(a):(b))

#define maxMacro	(		a,
			b
	)		(((a)>(b))?(a):(b))

Typedef Documentation

typedef unsigned char uint8

typedef unsigned short uint16

typedef unsigned long uint32

typedef unsigned long long uint64

typedef signed char int8

typedef signed short int16

typedef signed long int32

typedef signed long long int64

typedef float float32

typedef double float64

Function Documentation

uint8 toLittleEndian

(

uint8

value

)

uint16 toLittleEndian

(

uint16

value

)

uint32 toLittleEndian

(

uint32

value

)

uint64 toLittleEndian

(

uint64

value

)

int8 toLittleEndian

(

int8

value

)

int16 toLittleEndian

(

int16

value

)

int32 toLittleEndian

(

int32

value

)

int64 toLittleEndian

(

int64

value

)

float32 toLittleEndian

(

float32

value

)

float64 toLittleEndian

(

float64

value

)

uint8 fromLittleEndian

(

uint8

value

)

uint16 fromLittleEndian

(

uint16

value

)

uint32 fromLittleEndian

(

uint32

value

)

uint64 fromLittleEndian

(

uint64

value

)

int8 fromLittleEndian

(

int8

value

)

int16 fromLittleEndian

(

int16

value

)

int32 fromLittleEndian

(

int32

value

)

int64 fromLittleEndian

(

int64

value

)

float32 fromLittleEndian

(

float32

value

)

float64 fromLittleEndian

(

float64

value

)

void serialBegin

(

)

void serialEnd

(

)

int serialAvailable

(

)

int serialRead

(

)

void serialWrite

(

char

data

)

void serialWrite	(	const char *	data,
		uint32	size
	)

uint32 timeMicroseconds

(

)

uint32 timeMilliseconds

(

)

void timeDelayMicroseconds

(

uint32

microseconds

)

void timeDelayMilliseconds

(

uint32

milliseconds

)