cctalk-driver.h File Reference

---

Detailed Description

cctalk driver header file

Author:

Rod Boyce

This is the cctalk driver header file it contains the structure defined to contain all the tty information required to perform cctalk communications on a Linux serial port.

Date:

18/10/04

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	tsCCT_COMM_HANDLER
	This structure holds the parameters for the raw serial port and the operation chains. More...
Defines
#define	TRUE   (1)
#define	FALSE   (0)
Enumerations
enum	eCCTALK_DRIVER_CONSTANTS { eCCT_DRV_DEV_SIZE = 20 }
	Global external constants for the cctalk driver code. More...
Functions
unsigned char	cct_DrvInitialise (tsCCT_COMM_HANDLER *psCctComms, teCCTALK_SPEED eCctSpd)
	Initialise.
void	cct_DrvClose (tsCCT_COMM_HANDLER *psCctComms)
	Close port.
int	cct_PerformCctalkOperation (tsCCT_COMM_HANDLER *psCctComms, tsCCTALK_OPERATION *psCctalkOp)
	Perform a cctalk operation on the cctalk bus.

---

Enumeration Type Documentation

enum eCCTALK_DRIVER_CONSTANTS

Global external constants for the cctalk driver code. Enumeration values: eCCT_DRV_DEV_SIZE  The maximum size of the device string

---

Function Documentation

void cct_DrvClose (  tsCCT_COMM_HANDLER *  psCctComms  )

Close port. Must be called when closing the cctalk comms channel. This closes the file handle and restores the terminal settings Date: 12/10/04 Author: Rod Boyce Parameters: psCctComms  - Pointer to the comm handler struct that stores the parameters for this tty Returns: Nothing

unsigned char cct_DrvInitialise (  tsCCT_COMM_HANDLER *  psCctComms, teCCTALK_SPEED  eCctSpd )

Initialise. Initialise the cctalk serial port. Date: 12/10/04 Author: Rod Boyce Parameters: psCctComms  - Pointer to the comm handler struct that stores the parameters for this tty eCctSpd  - the speed to set the com port to. Returns: TRUE on sucess and FALSE if an error occured History

int cct_PerformCctalkOperation (  tsCCT_COMM_HANDLER *  psCctComms, tsCCTALK_OPERATION *  psCctalkOp )

Perform a cctalk operation on the cctalk bus. This function is called to perform a cctalk operation over a tty that has been configured for cctalk communication. Date: 12/10/04 Author: Rod Boyce Parameters: psCctComms  - Pointer to the comm handler struct that stores the parameters for this tty psCctalkOp  - A pointer to a cctalk operation structure Returns: > 0 on success and 0 or < 0 on failure FIXME: this needs work History

---