std_tlv.h

Common message types, result codes and payload data types for the Task-based TLV/INM (TTLV) communication module (task_tlv.h). Also declares a standard set of logical registers for TLV/INM nodes, as well as helper macros that simplify implementation of the logical register interface. Finally, there are some convenience functions for transmission of INM response messages.

CAUTION: The current logical register specification has bothersome and unnecessary limitations (e.g. all registers being one byte large) and is therefore being considered for compatibility-breaking replacement in a future release of libavr.

Summary

std_tlv.h	Common message types, result codes and payload data types for the Task-based TLV/INM (TTLV) communication module (task_tlv.h).
Message Types
Enumerations
TTLV Message Type Identifiers	NOTE: Application-specific message type identifiers SHOULD be greater than or equal to TTLV_MSG_T_APPLICATION.
Result Codes
Enumerations
TTLV Operation Result Codes	NOTE: Application-specific result codes SHOULD be greater than or equal to TTLV_RES_APPLICATION and not equal to TTLV_RES_NONE.
Variables
ttlv_result	The type of TTLV result codes.
ttlv_msg_inm_result	Specifies the format of a generic INM response message.
Variables
result_code	Identifies the result of the requested operation.
request_id	Identifies the request message.
Logical Registers
Variables
ttlv_reg_index	The type of TTLV logical register identifiers.
ttlv_reg_value	The type of TTLV logical register values.
ttlv_regpair_value	The type of TTLV logical register pair values.
ttlv_msg_reg	Specifies the format of an identifier-value pair for a logical register.
Variables
index	Register identifier.
value	Register value.
ttlv_msg_inm_reg	Specifies the format of an identifier-value pair for a logical register, with an INM message ID appended.
Variables
index	Register identifier.
value	Register value.
request_id	Identifies the request message.
ttlv_msg_regpair	Specifies the format of an identifier-value pair for a logical register pair.
Variables
index	Register identifier.
value	Register pair value.
ttlv_msg_inm_regpair	Specifies the format of an identifier-value pair for a logical register pair, with an INM message ID appended.
Variables
index	Register identifier.
value	Register pair value.
request_id	Identifies the request message.
Message Lengths and Type Checking
Enumerations
Standard TTLV Message Lengths
Macros
TTLV_CHECK_RESULT	True if and only if the current ttlv_recv_header matches a RESULT message with a ttlv_result payload.
TTLV_CHECK_INM_RESULT	True if and only if the current ttlv_recv_header matches an INM_RESULT message with a ttlv_msg_inm_result payload.
TTLV_CHECK_REG_READ	True if and only if the current ttlv_recv_header matches a REG_READ message with a ttlv_reg_index payload.
TTLV_CHECK_REG_WRITE	True if and only if the current ttlv_recv_header matches a REG_WRITE message with a ttlv_msg_reg payload.
TTLV_CHECK_REG_TOGGLE	True if and only if the current ttlv_recv_header matches a REG_TOGGLE message with a ttlv_msg_reg payload.
TTLV_CHECK_REG_RW_EXCH	True if and only if the current ttlv_recv_header matches a REG_RW_EXCH message with a ttlv_msg_reg payload.
TTLV_CHECK_REG_WR_EXCH	True if and only if the current ttlv_recv_header matches a REG_WR_EXCH message with a ttlv_msg_reg payload.
TTLV_CHECK_REGPAIR_READ	True if and only if the current ttlv_recv_header matches a REGPAIR_READ message with a ttlv_reg_index payload.
TTLV_CHECK_REGPAIR_WRITE	True if and only if the current ttlv_recv_header matches a REGPAIR_WRITE message with a ttlv_msg_regpair payload.
TTLV_CHECK_REGPAIR_TOGGLE	True if and only if the current ttlv_recv_header matches a REGPAIR_TOGGLE message with a ttlv_msg_regpair payload.
TTLV_CHECK_REGPAIR_RW_EXCH	True if and only if the current ttlv_recv_header matches a REGPAIR_RW_EXCH message with a ttlv_msg_regpair payload.
TTLV_CHECK_REGPAIR_WR_EXCH	True if and only if the current ttlv_recv_header matches a REGPAIR_WR_EXCH message with a ttlv_msg_regpair payload.
Function Definition Macros
Functions
ttlv_reg_setter	The type of pointers to functions that set the value of a specified logical register.
ttlv_reg_manipulator	The type of pointers to functions that perform some update operation on a specified logical register.
ttlv_regpair_setter	The type of pointers to functions that set the value of a specified logical register pair.
ttlv_regpair_manipulator	The type of pointers to functions that perform some update operation on a specified logical register pair.
Macros
TTLV_STD_REG_TOGGLE	Defines a static function that uses specified logical register read and write functions to implement the register toggle operation (R ^= V; ret R).
TTLV_STD_REG_RW_EXCH	Defines a static function that uses specified logical register read and write functions to implement the register read-write operation (X = R; R = V; ret X).
TTLV_STD_REG_WR_EXCH	Defines a static function that uses specified logical register read and write functions to implement the register write-read operation (R = V; ret R).
TTLV_STD_REGPAIR_READ	Defines a static function that uses a specified logical register read function to implement the register pair read operation (ret R).
TTLV_STD_REGPAIR_WRITE	Defines a static function that uses a specified logical register write function to implement the register pair write operation (R = V).
TTLV_STD_REGPAIR_TOGGLE	Defines a static function that uses specified logical register pair read and write functions to implement the register pair toggle operation (R ^= V; ret R).
TTLV_STD_REGPAIR_RW_EXCH	Defines a static function that uses specified logical register pair read and write functions to implement the register pair read-write operation (X = R; R = V; ret X).
TTLV_STD_REGPAIR_WR_EXCH	Defines a static function that uses specified logical register pair read and write functions to implement the register pair write-read operation (R = V; ret R).
API Functions
Functions
ttlv_xmit_response	Convenience function that uses ttlv_xmit to transmit a message.
ttlv_xmit_result	Convenience function that uses ttlv_xmit to transmit a TTLV_MSG_T_RESULT message.
ttlv_xmit_inm_result	Convenience function that uses ttlv_xmit to transmit a TTLV_MSG_T_INM_RESULT message.

Message Types

Summary

Enumerations
TTLV Message Type Identifiers	NOTE: Application-specific message type identifiers SHOULD be greater than or equal to TTLV_MSG_T_APPLICATION.

Enumerations

TTLV Message Type Identifiers

NOTE: Application-specific message type identifiers SHOULD be greater than or equal to TTLV_MSG_T_APPLICATION.

TTLV_MSG_T_DEFAULT	Default message type.
TTLV_MSG_T_RESULT	Generic TLV operation response (result code).
TTLV_MSG_T_INM_RESULT	Generic INM operation response (result code and request ID).
TTLV_MSG_T_REG_READ	Logical register read request.
TTLV_MSG_T_REG_READ_RES	Logical TLV register read response.
TTLV_MSG_T_INM_REG_READ_RES	Logical INM register read response (with request ID).
TTLV_MSG_T_REG_WRITE	Logical register write (R = V) request.
TTLV_MSG_T_REG_TOGGLE	Logical register toggle (R ^= V; ret R) request.
TTLV_MSG_T_REG_RW_EXCH	Logical register read-write (X = R; R = V; ret X) request.
TTLV_MSG_T_REG_WR_EXCH	Logical register write-read (R = V; ret R) request.
TTLV_MSG_T_REGPAIR_READ	Logical register pair read (ret R) request.
TTLV_MSG_T_REGPAIR_READ_RES	Logical TLV register pair read response.
TTLV_MSG_T_INM_REGPAIR_READ_RES	Logical INM register pair read response (with request ID).
TTLV_MSG_T_REGPAIR_WRITE	Logical register pair write request.
TTLV_MSG_T_REGPAIR_TOGGLE	Logical register pair toggle request.
TTLV_MSG_T_REGPAIR_RW_EXCH	Logical register pair read-write request.
TTLV_MSG_T_REGPAIR_WR_EXCH	Logical register pair write-read request.
TTLV_MSG_T_MEMMON_DATA	Memory monitor notification. Variable-length message.
TTLV_MSG_T_MEMMON_CTRL	Memory monitor control request. Not implemented.
TTLV_MSG_T_APPLICATION	Start of application-specific identifier range.

Result Codes

Summary

Enumerations
TTLV Operation Result Codes	NOTE: Application-specific result codes SHOULD be greater than or equal to TTLV_RES_APPLICATION and not equal to TTLV_RES_NONE.
Variables
ttlv_result	The type of TTLV result codes.

Enumerations

TTLV Operation Result Codes

NOTE: Application-specific result codes SHOULD be greater than or equal to TTLV_RES_APPLICATION and not equal to TTLV_RES_NONE.

TTLV_RES_OK	Request successfully handled.
TTLV_RES_TYPE	Error: Unrecognized message type.
TTLV_RES_LENGTH	Error: Invalid message length.
TTLV_RES_VALUE	Error: Invalid message value.
TTLV_RES_REGISTER	Error: Message specified unrecognized logical register.
TTLV_RES_INTERNAL	Error: Internal error encountered while handling message.
TTLV_RES_NOT_IMPLEMENTED	Error: Message recognized but cannot be handled.
TTLV_RES_APPLICATION	Start of application-specific result code range.
TTLV_RES_NONE	Invalid result code.

Variables

ttlv_result

typedef uint8_t ttlv_result

The type of TTLV result codes.

ttlv_msg_inm_result

typedef struct __attribute__ ( (__packed__) ) ttlv_msg_inm_result

Specifies the format of a generic INM response message.

Summary

Variables
result_code	Identifies the result of the requested operation.
request_id	Identifies the request message.

Variables

result_code

ttlv_result result_code

Identifies the result of the requested operation.

request_id

uint16_t request_id

Identifies the request message.

Logical Registers

Summary

Variables
ttlv_reg_index	The type of TTLV logical register identifiers.
ttlv_reg_value	The type of TTLV logical register values.
ttlv_regpair_value	The type of TTLV logical register pair values.

Variables

ttlv_reg_index

typedef uint8_t ttlv_reg_index

The type of TTLV logical register identifiers.

NOTE: These identifiers do NOT necessarily correspond to ATmega RAM or I/O addresses. Their meaning is application-specific.

ttlv_reg_value

typedef uint8_t ttlv_reg_value

The type of TTLV logical register values.

ttlv_regpair_value

typedef uint16_t ttlv_regpair_value

The type of TTLV logical register pair values.

ttlv_msg_reg

typedef struct __attribute__ ( (__packed__) ) ttlv_msg_reg

Specifies the format of an identifier-value pair for a logical register. Such pairs are the payloads of register write requests and register read responses.

Summary

Variables
index	Register identifier.
value	Register value.

Variables

index

ttlv_reg_index index

value

ttlv_reg_value value

ttlv_msg_inm_reg

typedef struct __attribute__ ( (__packed__) ) ttlv_msg_inm_reg

Specifies the format of an identifier-value pair for a logical register, with an INM message ID appended. Such triples are the payloads of register read responses in INM applications.

Summary

Variables
index	Register identifier.
value	Register value.
request_id	Identifies the request message.

Variables

index

ttlv_reg_index index

value

ttlv_reg_value value

request_id

uint16_t request_id

Identifies the request message.

ttlv_msg_regpair

typedef struct __attribute__ ( (__packed__) ) ttlv_msg_regpair

Specifies the format of an identifier-value pair for a logical register pair. Such pairs are the payloads of register pair write requests and register pair read responses.

Summary

Variables
index	Register identifier.
value	Register pair value.

Variables

index

ttlv_reg_index index

value

ttlv_regpair_value value

Register pair value. The value of the lower register (i.e. the one with the lesser register identifier) is in the least significant byte and the value of the higher register is in the most significant byte.

ttlv_msg_inm_regpair

typedef struct __attribute__ ( (__packed__) ) ttlv_msg_inm_regpair

Specifies the format of an identifier-value pair for a logical register pair, with an INM message ID appended. Such triples are the payloads of register pair read responses in INM applications.

Summary

Variables
index	Register identifier.
value	Register pair value.
request_id	Identifies the request message.

Variables

index

ttlv_reg_index index

value

ttlv_regpair_value value

request_id

uint16_t request_id

Identifies the request message.

Message Lengths and Type Checking

Summary

Enumerations
Standard TTLV Message Lengths
Macros
TTLV_CHECK_RESULT	True if and only if the current ttlv_recv_header matches a RESULT message with a ttlv_result payload.
TTLV_CHECK_INM_RESULT	True if and only if the current ttlv_recv_header matches an INM_RESULT message with a ttlv_msg_inm_result payload.
TTLV_CHECK_REG_READ	True if and only if the current ttlv_recv_header matches a REG_READ message with a ttlv_reg_index payload.
TTLV_CHECK_REG_WRITE	True if and only if the current ttlv_recv_header matches a REG_WRITE message with a ttlv_msg_reg payload.
TTLV_CHECK_REG_TOGGLE	True if and only if the current ttlv_recv_header matches a REG_TOGGLE message with a ttlv_msg_reg payload.
TTLV_CHECK_REG_RW_EXCH	True if and only if the current ttlv_recv_header matches a REG_RW_EXCH message with a ttlv_msg_reg payload.
TTLV_CHECK_REG_WR_EXCH	True if and only if the current ttlv_recv_header matches a REG_WR_EXCH message with a ttlv_msg_reg payload.
TTLV_CHECK_REGPAIR_READ	True if and only if the current ttlv_recv_header matches a REGPAIR_READ message with a ttlv_reg_index payload.
TTLV_CHECK_REGPAIR_WRITE	True if and only if the current ttlv_recv_header matches a REGPAIR_WRITE message with a ttlv_msg_regpair payload.
TTLV_CHECK_REGPAIR_TOGGLE	True if and only if the current ttlv_recv_header matches a REGPAIR_TOGGLE message with a ttlv_msg_regpair payload.
TTLV_CHECK_REGPAIR_RW_EXCH	True if and only if the current ttlv_recv_header matches a REGPAIR_RW_EXCH message with a ttlv_msg_regpair payload.
TTLV_CHECK_REGPAIR_WR_EXCH	True if and only if the current ttlv_recv_header matches a REGPAIR_WR_EXCH message with a ttlv_msg_regpair payload.

Enumerations

Standard TTLV Message Lengths

TTLV_MSG_L_RESULT	TLV length of a TTLV_MSG_T_RESULT message.
TTLV_MSG_L_INM_RESULT	TLV length of a TTLV_MSG_T_INM_RESULT message.
TTLV_MSG_L_REG_READ	TLV length of a TTLV_MSG_T_REG_READ message.
TTLV_MSG_L_REG_READ_RES	TLV length of a TTLV_MSG_T_REG_READ_RES message.
TTLV_MSG_L_INM_REG_READ_RES	TLV length of a TTLV_MSG_T_INM_REG_READ_RES message.
TTLV_MSG_L_REG_WRITE	TLV length of a TTLV_MSG_T_REG_WRITE message.
TTLV_MSG_L_REG_TOGGLE	TLV length of a TTLV_MSG_T_REG_TOGGLE message.
TTLV_MSG_L_REG_RW_EXCH	TLV length of a TTLV_MSG_T_REG_RW_EXCH message.
TTLV_MSG_L_REG_WR_EXCH	TLV length of a TTLV_MSG_T_REG_WR_EXCH message.
TTLV_MSG_L_REGPAIR_READ	TLV length of a TTLV_MSG_T_REGPAIR_READ message.
TTLV_MSG_L_REGPAIR_READ_RES	TLV length of a TTLV_MSG_T_REGPAIR_READ_RES message.
TTLV_MSG_L_INM_REGPAIR_READ_RES	TLV length of a TTLV_MSG_T_INM_REGPAIR_READ_RES message.
TTLV_MSG_L_REGPAIR_WRITE	TLV length of a TTLV_MSG_T_REGPAIR_WRITE message.
TTLV_MSG_L_REGPAIR_TOGGLE	TLV length of a TTLV_MSG_T_REGPAIR_TOGGLE message.
TTLV_MSG_L_REGPAIR_RW_EXCH	TLV length of a TTLV_MSG_T_REGPAIR_RW_EXCH message.
TTLV_MSG_L_REGPAIR_WR_EXCH	TLV length of a TTLV_MSG_T_REGPAIR_WR_EXCH message.

Macros

TTLV_CHECK_RESULT

True if and only if the current ttlv_recv_header matches a RESULT message with a ttlv_result payload. Expression macro.

TTLV_CHECK_INM_RESULT

True if and only if the current ttlv_recv_header matches an INM_RESULT message with a ttlv_msg_inm_result payload. Expression macro.

TTLV_CHECK_REG_READ

True if and only if the current ttlv_recv_header matches a REG_READ message with a ttlv_reg_index payload. Expression macro.

TTLV_CHECK_REG_WRITE

True if and only if the current ttlv_recv_header matches a REG_WRITE message with a ttlv_msg_reg payload. Expression macro.

TTLV_CHECK_REG_TOGGLE

True if and only if the current ttlv_recv_header matches a REG_TOGGLE message with a ttlv_msg_reg payload. Expression macro.

TTLV_CHECK_REG_RW_EXCH

True if and only if the current ttlv_recv_header matches a REG_RW_EXCH message with a ttlv_msg_reg payload. Expression macro.

TTLV_CHECK_REG_WR_EXCH

True if and only if the current ttlv_recv_header matches a REG_WR_EXCH message with a ttlv_msg_reg payload. Expression macro.

TTLV_CHECK_REGPAIR_READ

True if and only if the current ttlv_recv_header matches a REGPAIR_READ message with a ttlv_reg_index payload. Expression macro.

TTLV_CHECK_REGPAIR_WRITE

True if and only if the current ttlv_recv_header matches a REGPAIR_WRITE message with a ttlv_msg_regpair payload. Expression macro.

TTLV_CHECK_REGPAIR_TOGGLE

True if and only if the current ttlv_recv_header matches a REGPAIR_TOGGLE message with a ttlv_msg_regpair payload. Expression macro.

TTLV_CHECK_REGPAIR_RW_EXCH

True if and only if the current ttlv_recv_header matches a REGPAIR_RW_EXCH message with a ttlv_msg_regpair payload. Expression macro.

TTLV_CHECK_REGPAIR_WR_EXCH

True if and only if the current ttlv_recv_header matches a REGPAIR_WR_EXCH message with a ttlv_msg_regpair payload. Expression macro.

Function Definition Macros

Summary

Functions
ttlv_reg_setter	The type of pointers to functions that set the value of a specified logical register.
ttlv_reg_manipulator	The type of pointers to functions that perform some update operation on a specified logical register.
ttlv_regpair_setter	The type of pointers to functions that set the value of a specified logical register pair.
ttlv_regpair_manipulator	The type of pointers to functions that perform some update operation on a specified logical register pair.
Macros
TTLV_STD_REG_TOGGLE	Defines a static function that uses specified logical register read and write functions to implement the register toggle operation (R ^= V; ret R).
TTLV_STD_REG_RW_EXCH	Defines a static function that uses specified logical register read and write functions to implement the register read-write operation (X = R; R = V; ret X).
TTLV_STD_REG_WR_EXCH	Defines a static function that uses specified logical register read and write functions to implement the register write-read operation (R = V; ret R).
TTLV_STD_REGPAIR_READ	Defines a static function that uses a specified logical register read function to implement the register pair read operation (ret R).
TTLV_STD_REGPAIR_WRITE	Defines a static function that uses a specified logical register write function to implement the register pair write operation (R = V).
TTLV_STD_REGPAIR_TOGGLE	Defines a static function that uses specified logical register pair read and write functions to implement the register pair toggle operation (R ^= V; ret R).
TTLV_STD_REGPAIR_RW_EXCH	Defines a static function that uses specified logical register pair read and write functions to implement the register pair read-write operation (X = R; R = V; ret X).
TTLV_STD_REGPAIR_WR_EXCH	Defines a static function that uses specified logical register pair read and write functions to implement the register pair write-read operation (R = V; ret R).

Functions

ttlv_reg_setter

typedef ttlv_result (
* ttlv_reg_setter
)(ttlv_reg_index index, ttlv_reg_value value)

The type of pointers to functions that set the value of a specified logical register.

Parameters

index	Identifier of the target logical register.
value	The new register value.

Returns

A ttlv_result indicating the outcome of the attempted register operation.

ttlv_reg_manipulator

typedef ttlv_result (
* ttlv_reg_manipulator
)(ttlv_reg_index index, ttlv_reg_value *value_p)

The type of pointers to functions that perform some update operation on a specified logical register.

Parameters

index	Identifier of the target logical register.
value_p	Pointer to a register value. Used both to receive the input value and to return the output value.

Returns

A ttlv_result indicating the outcome of the attempted register operation.

ttlv_regpair_setter

typedef ttlv_result (
* ttlv_regpair_setter
)(ttlv_reg_index index, ttlv_regpair_value value)

The type of pointers to functions that set the value of a specified logical register pair.

Parameters

index	Identifier of the lower half of the target logical register pair.
value	The new register pair value.

Returns

A ttlv_result indicating the outcome of the attempted register operation.

ttlv_regpair_manipulator

typedef ttlv_result (
* ttlv_regpair_manipulator
)(ttlv_reg_index index, ttlv_regpair_value *value_p)

The type of pointers to functions that perform some update operation on a specified logical register pair.

Parameters

index	Identifier of the lower half of the target logical register pair.
value_p	Pointer to a register pair value. Used both to receive the input value and to return the output value.

Returns

A ttlv_result indicating the outcome of the attempted register operation.

Macros

TTLV_STD_REG_TOGGLE

Defines a static function that uses specified logical register read and write functions to implement the register toggle operation (R ^= V; ret R). Function definition macro.

Parameters

RF	Name of a ttlv_reg_manipulator that implements the read operation.
WF	Name of a ttlv_reg_setter that implements the write operation.
DF	Name of the emitted register toggle function.

Returns

Emits a definition of a static ttlv_reg_manipulator function that implements the register toggle operation.

TTLV_STD_REG_RW_EXCH

Defines a static function that uses specified logical register read and write functions to implement the register read-write operation (X = R; R = V; ret X). Function definition macro.

Parameters

RF	Name of a ttlv_reg_manipulator that implements the read operation.
WF	Name of a ttlv_reg_setter that implements the write operation.
DF	Name of the emitted register read-write function.

Returns

Emits a definition of a ttlv_reg_manipulator function that implements the register read-write operation.

TTLV_STD_REG_WR_EXCH

Defines a static function that uses specified logical register read and write functions to implement the register write-read operation (R = V; ret R). Function definition macro.

Parameters

RF	Name of a ttlv_reg_manipulator that implements the read operation.
WF	Name of a ttlv_reg_setter that implements the write operation.
DF	Name of the emitted register write-read function.

Returns

Emits a definition of a static ttlv_reg_manipulator function that implements the register write-read operation.

TTLV_STD_REGPAIR_READ

Defines a static function that uses a specified logical register read function to implement the register pair read operation (ret R). Function definition macro.

Parameters

RF	Name of a ttlv_reg_manipulator that implements the read operation.
DF	Name of the emitted register pair read function.

Returns

Emits a definition of a static ttlv_regpair_manipulator function that implements the register pair read operation.

TTLV_STD_REGPAIR_WRITE

Defines a static function that uses a specified logical register write function to implement the register pair write operation (R = V). Function definition macro.

Parameters

WF	Name of a ttlv_reg_setter that implements the write operation.
DF	Name of the emitted register pair write function.

Returns

Emits a definition of a static ttlv_regpair_setter function that implements the register pair write operation.

TTLV_STD_REGPAIR_TOGGLE

Defines a static function that uses specified logical register pair read and write functions to implement the register pair toggle operation (R ^= V; ret R). Function definition macro.

Parameters

RF	Name of a ttlv_regpair_manipulator that implements the read operation.
WF	Name of a ttlv_regpair_setter that implements the write operation.
DF	Name of the emitted register pair toggle function.

Returns

Emits a definition of a static ttlv_regpair_manipulator function that implements the register pair toggle operation.

TTLV_STD_REGPAIR_RW_EXCH

Defines a static function that uses specified logical register pair read and write functions to implement the register pair read-write operation (X = R; R = V; ret X). Function definition macro.

Parameters

RF	Name of a ttlv_regpair_manipulator that implements the read operation.
WF	Name of a ttlv_regpair_setter that implements the write operation.
DF	Name of the emitted register pair read-write function.

Returns

Emits a definition of a static ttlv_regpair_manipulator function that implements the register pair read-write operation.

TTLV_STD_REGPAIR_WR_EXCH

Defines a static function that uses specified logical register pair read and write functions to implement the register pair write-read operation (R = V; ret R). Function definition macro.

Parameters

RF	Name of a ttlv_regpair_manipulator that implements the read operation.
WF	Name of a ttlv_regpair_setter that implements the write operation.
DF	Name of the emitted register pair write-read function.

Returns

Emits a definition of a static ttlv_regpair_manipulator function that implements the register pair write-read operation.

API Functions

Summary

Functions
ttlv_xmit_response	Convenience function that uses ttlv_xmit to transmit a message.
ttlv_xmit_result	Convenience function that uses ttlv_xmit to transmit a TTLV_MSG_T_RESULT message.
ttlv_xmit_inm_result	Convenience function that uses ttlv_xmit to transmit a TTLV_MSG_T_INM_RESULT message.

Functions

ttlv_xmit_response

ttlv_state ttlv_xmit_response( uint8_t type,
uint8_t length,
const uint8_t * data_p )

Convenience function that uses ttlv_xmit to transmit a message. The INM destination address will be copied from the srcadr field of ttlv_recv_inm_header (assumed to contain the address of the source of the most recently received request).

Parameters

type	TLV type identifier of the message to transmit.
length	TLV length of the message to transmit.
data_p	Pointer to the data bytes (TLV value) of the message to transmit.

Returns

An integer result code, which will be an error code if and only if the attempt to initiate transmission failed.

ttlv_xmit_result

ttlv_state ttlv_xmit_result( ttlv_result res )

Convenience function that uses ttlv_xmit to transmit a TTLV_MSG_T_RESULT message. The INM destination address will be copied from the srcadr field of ttlv_recv_inm_header (assumed to contain the address of the source of the most recently received request).

Parameters

res	The result code to send in the TTLV_MSG_T_RESULT message.

Returns

An integer result code, which will be an error code if and only if the attempt to initiate transmission failed.

ttlv_xmit_inm_result

ttlv_state ttlv_xmit_inm_result( ttlv_result res )

Convenience function that uses ttlv_xmit to transmit a TTLV_MSG_T_INM_RESULT message. The INM destination address and request ID in the transmitted message will be copied from the srcadr and msg_id fields of ttlv_recv_inm_header (assumed to contain the source address and message ID of the most recently received request).

Parameters

res	The result code to send in the TTLV_MSG_T_INM_RESULT message.

Returns

An integer result code, which will be an error code if and only if the attempt to initiate transmission failed.