IOSerialDeviceDesc Struct Reference

Detailed Description

IOSerialDevice descriptor type definition. An IOSerialDevice object is actually a pointer to this structure.

#include <hali_ioserial.h>

Data Fields
struct IODeviceDesc	iodevice
HALRESULT(*	SetBaudrate )(IOSerialDevice serial, uint32_t baudrate)
uint32_t(*	GetBaudrate )(IOSerialDevice serial)
IOSerialDevice	serial
IOSerialDevice IOSERIAL_NumberOfDataBits	data_bits
IOSerialDevice IOSERIAL_NumberOfDataBits IOSERIAL_Parity	parity
IOSerialDevice IOSERIAL_NumberOfDataBits IOSERIAL_Parity IOSERIAL_NumberOfStopBits	stop
IOSerialDevice IOSERIAL_NumberOfDataBits *	data_bits
IOSerialDevice IOSERIAL_NumberOfDataBits IOSERIAL_Parity *	parity
IOSerialDevice IOSERIAL_NumberOfDataBits IOSERIAL_Parity IOSERIAL_NumberOfStopBits *	stop
IOSerialDevice IOSERIAL_Handshaking	handshaking
IOSERIAL_Handshaking(*	GetHandshaking )(IOSerialDevice serial)
HALRESULT(*	EnableRTS )(IOSerialDevice serial)
HALRESULT(*	DisableRTS )(IOSerialDevice serial)
HALRESULT(*	SetRTS )(IOSerialDevice serial, bool rts)
bool(*	GetRTS )(IOSerialDevice serial)
HALRESULT(*	EnableCTS )(IOSerialDevice serial)
HALRESULT(*	DisableCTS )(IOSerialDevice serial)
HALRESULT(*	SetCTS )(IOSerialDevice serial, bool cts)
bool(*	GetCTS )(IOSerialDevice serial)

Field Documentation

struct IODeviceDesc IOSerialDeviceDesc::iodevice

The IODeviceDesc structure describing the IODevice core functionality.

HALRESULT(* IOSerialDeviceDesc::SetBaudrate)(IOSerialDevice serial, uint32_t baudrate)

Sets baudrate of an IOSerialDevice This function is directly called by IOSERIAL_SetBaudrate

Parameters

serial	IOSerialDevice
baudrate	baudrate

Returns

HALRESULT_OK on success. Other values indicate error (see HALRESULT).

uint32_t(* IOSerialDeviceDesc::GetBaudrate)(IOSerialDevice serial)

Gets the baudrate currently set for the given IOSerialDevice This function is directly called by IOSERIAL_GetBaudrate

Parameters

serial

IOSerialDevice

Returns

currently set baudrate or 0 if the baudrate could not be determined.

IOSerialDevice IOSerialDeviceDesc::serial

Sets the frame format for the given IOSerialDevice This function is directly called by IOSERIAL_SetFrameFormat

Parameters

serial	IOSerialDevice
data_bits	number of data bits in a frame (see IOSERIAL_NumberOfDataBits)
parity	parity bit mode (see IOSERIAL_Parity)
stop	number of stop bits (see IOSERIAL_NumberOfStopBits)

Returns

HALRESULT_OK on success. Other values indicate error (see HALRESULT).

Gets the frame format currently set for a given IOSerialDevice. This function is directly called by IOSERIAL_GetFrameFormat

Parameters

serial	IOSerialDevice
data_bits	pointer to a variable where number of data bits in a frame will be stored (see IOSERIAL_NumberOfDataBits)
parity	pointer to a variable where parity bit mode will be stored (see IOSERIAL_Parity)
stop	pointer to a variable where number of stop bits will be stored (see IOSERIAL_NumberOfStopBits)

Returns

HALRESULT_OK on success. Other values indicate error (see HALRESULT).

Sets handshaking mode for a given IOSerialDevice This function is directly called by IOSERIAL_SetHandshaking

Parameters

serial	IOSerialDevice
handshaking	handshaking mode (see IOSERIAL_Handshaking)

Returns

HALRESULT_OK on success. Other values indicate error (see HALRESULT).

IOSERIAL_Handshaking(* IOSerialDeviceDesc::GetHandshaking)(IOSerialDevice serial)

Gets handshaking mode currently set for a given IOSerialDevice This function is directly called by IOSERIAL_GetHandshaking

Parameters

serial

IOSerialDevice

Returns

handshaking mode (see IOSERIAL_Handshaking). In case the handshaking mode can not be retireved returns IOSERIAL_HANDSHAKING_NONE.

HALRESULT(* IOSerialDeviceDesc::EnableRTS)(IOSerialDevice serial)

Enables the RTS (request to send) signal in a given IOSerialDevice. This function is directly called by IOSERIAL_EnableRTS

Parameters

serial

IOSerialDevice

Returns

HALRESULT_OK on success. Other values indicate error (see HALRESULT).

HALRESULT(* IOSerialDeviceDesc::DisableRTS)(IOSerialDevice serial)

Disables the RTS (request to send) signal in a given IOSerialDevice. This function is directly called by IOSERIAL_DisableRTS

Parameters

serial

IOSerialDevice

Returns

HALRESULT_OK on success. Other values indicate error (see HALRESULT).

HALRESULT(* IOSerialDeviceDesc::SetRTS)(IOSerialDevice serial, bool rts)

Sets the RTS (request to send) signal in a given IOSerialDevice. This function is directly called by IOSERIAL_SetRTS

Parameters

serial	IOSerialDevice
rts	RTS signal value (true means RTS is active, false means the RTS is inactive)

Returns

HALRESULT_OK on success. Other values indicate error (see HALRESULT).

bool(* IOSerialDeviceDesc::GetRTS)(IOSerialDevice serial)

Gets the RTS (request to send) signal value in a given IOSerialDevice. This function is directly called by IOSERIAL_GetRTS

Parameters

serial

IOSerialDevice

Returns

rts RTS signal value (true means RTS is active, false means the RTS is inactive). If the RTS signal value could not be read this function returns false.

HALRESULT(* IOSerialDeviceDesc::EnableCTS)(IOSerialDevice serial)

Enables the CTS (clear to send) signal in a given IOSerialDevice. This function is directly called by IOSERIAL_EnableCTS

Parameters

serial

IOSerialDevice

Returns

HALRESULT_OK on success. Other values indicate error (see HALRESULT).

HALRESULT(* IOSerialDeviceDesc::DisableCTS)(IOSerialDevice serial)

Disables the CTS (clear to send) signal in a given IOSerialDevice. This function is directly called by IOSERIAL_DisableCTS

Parameters

serial

IOSerialDevice

Returns

HALRESULT_OK on success. Other values indicate error (see HALRESULT).

HALRESULT(* IOSerialDeviceDesc::SetCTS)(IOSerialDevice serial, bool cts)

Sets the CTS (clear to send) signal in a given IOSerialDevice. This function is directly called by IOSERIAL_SetCTS

Parameters

serial	IOSerialDevice
rts	CTS signal value (true means CTS is active, false means the CTS is inactive)

Returns

HALRESULT_OK on success. Other values indicate error (see HALRESULT).

bool(* IOSerialDeviceDesc::GetCTS)(IOSerialDevice serial)

Gets the CTS (clear to send) signal value in a given IOSerialDevice. This function is directly called by IOSERIAL_GetCTS

Parameters

serial

IOSerialDevice

Returns

rts CTS signal value (true means CTS is active, false means the CTS is inactive). If the CTS signal value could not be read this function returns false.

---

The documentation for this struct was generated from the following file:

• trunk/src/hal/inc/internal/hali_ioserial.h