Group isotp_config¶

Build-time configuration for ISOTP-C. More...

Macros¶

Type	Name
define	ISOTP_DEFAULT_BLOCK_SIZE `8U` Block size (BS) this receiver requests; 0 means no further Flow Control.
define	ISOTP_DEFAULT_N_BS_TIMEOUT_US `1000000U` Sender timeout N_Bs: longest wait for a Flow Control frame, in microseconds.
define	ISOTP_DEFAULT_N_CR_TIMEOUT_US `1000000U` Receiver timeout N_Cr: longest wait for the next Consecutive Frame, in microseconds.
define	ISOTP_DEFAULT_ST_MIN_US `0U` Minimum separation time (STmin) this receiver requests, in microseconds.
define	ISOTP_DEFAULT_WFT_MAX `10U` N_WFTmax: Flow Control frames with the status Wait accepted in a row.
define	ISOTP_RX_BUFFER_SIZE `4095U` Largest message one link can receive, in bytes.
define	ISOTP_TX_BUFFER_SIZE `4095U` Largest message one link can transmit, in bytes.

Detailed Description¶

Every parameter can be overridden by the integrator with a compiler definition (for example -DISOTP_RX_BUFFER_SIZE=64U) without editing this file. The buffer sizes are compiled into Link, so they set the RAM footprint of one link. The protocol defaults are only the values written by isotp_link_config_default; every link can use its own values at run time.

** **

ISOTP_TX_BUFFER_SIZE, ISOTP_RX_BUFFER_SIZE : largest message in each direction.
ISOTP_DEFAULT_BLOCK_SIZE, ISOTP_DEFAULT_ST_MIN_US : flow control we request.
ISOTP_DEFAULT_N_BS_TIMEOUT_US, ISOTP_DEFAULT_N_CR_TIMEOUT_US : timeouts.
ISOTP_DEFAULT_WFT_MAX : flow-control wait frames we accept.

Macro Definition Documentation¶

define ISOTP_DEFAULT_BLOCK_SIZE¶

Block size (BS) this receiver requests; 0 means no further Flow Control.

#define ISOTP_DEFAULT_BLOCK_SIZE `8U`

define ISOTP_DEFAULT_N_BS_TIMEOUT_US¶

Sender timeout N_Bs: longest wait for a Flow Control frame, in microseconds.

#define ISOTP_DEFAULT_N_BS_TIMEOUT_US `1000000U`

ISO 15765-2 specifies 1000 ms.

define ISOTP_DEFAULT_N_CR_TIMEOUT_US¶

Receiver timeout N_Cr: longest wait for the next Consecutive Frame, in microseconds.

#define ISOTP_DEFAULT_N_CR_TIMEOUT_US `1000000U`

ISO 15765-2 specifies 1000 ms.

define ISOTP_DEFAULT_ST_MIN_US¶

Minimum separation time (STmin) this receiver requests, in microseconds.

#define ISOTP_DEFAULT_ST_MIN_US `0U`

define ISOTP_DEFAULT_WFT_MAX¶

N_WFTmax: Flow Control frames with the status Wait accepted in a row.

#define ISOTP_DEFAULT_WFT_MAX `10U`

define ISOTP_RX_BUFFER_SIZE¶

Largest message one link can receive, in bytes.

#define ISOTP_RX_BUFFER_SIZE `4095U`

A First Frame announcing a longer message is answered with a Flow Control frame with the status Overflow.

define ISOTP_TX_BUFFER_SIZE¶

Largest message one link can transmit, in bytes.

#define ISOTP_TX_BUFFER_SIZE `4095U`

The link copies the message into a buffer of this size, so the caller may reuse its own buffer as soon as isotp_link_send returns.