Structure Definitions
This section explains the Callout DLL specification.
Structures
The following structures are defined.
| Structure Type | Description |
|---|---|
| StElementCfg | Element configuration information |
| StFrameCfg | TX/RX frame configuration information |
| StPrePostData | Prefix/Postfix information |
| StMsgConfig | Channel message configuration information |
| StFrameInfo | TX/RX frame information |
| StCustomParamCfg | Callout custom parameter information |
StElementCfg
Members of StElementCfg (element configuration information):
| Variable | Type | Description |
|---|---|---|
| StartPos | DWORD | Start bit position of element |
| EndPos | DWORD | End bit position of element |
| Value | LPBYTE | Initial value of element |
| ValueLength | DWORD | Element length (bit unit) (*1) |
| Align | DWORD | Bit alignment (*2) |
| Endianness | DWORD | Byte endian (*2) |
1: Element length is automatically determined by StartPos and EndPos.
2: For value meanings, refer to constant definitions.
StFrameCfg
Members of StFrameCfg (TX/RX frame configuration information):
| Variable | Type | Description |
|---|---|---|
| SecMsgIdx | DWORD | Message index |
| PrePostLen | DWORD | Prefix/Postfix data length (bit unit) |
| ElCfgs | StElementCfg * | Array of prefix/postfix element configuration structures |
| ElementNum | DWORD | Number of elements in element configuration array |
| IsSyncMsg | BOOL | Sync message enable/disable (True = enabled, False = disabled) |
| IsUseFv | BOOL | FV usage (*1) |
| IsFvMaster | BOOL | FV master/slave (True = master, False = slave) |
| Reserve | BOOL | Reserved |
StPrePostData
Members of StPrePostData (prefix/postfix information):
| Variable | Type | Description |
|---|---|---|
| Value | LPBYTE | Prefix/Postfix value |
| Length | DWORD | Prefix/Postfix length (bit unit) |
StMsgConfig
Members of StMsgConfig (channel message configuration information):
| Variable | Type | Description |
|---|---|---|
| MsgCfg | StFrameCfg * | Array of message information structures held by channel |
| MsgNum | DWORD | Number of elements in message information array held by channel |
StFrameInfo
Members of StFrameInfo (TX/RX frame information):
| Variable | Type | Description |
|---|---|---|
| AllPayLoad | LPBYTE | CAN/CAN FD message data value |
| AllLength | DWORD | CAN/CAN FD message data length (bit unit) |
| TruncPayLoad | LPBYTE | Truncated payload data value |
| TruncPayLoadLength | DWORD | Truncated payload data length (bit unit) |
| TruncFV | LPBYTE | Truncated FV data value |
| TruncFVLength | DWORD | Truncated FV data length (bit unit) |
| TruncMac | LPBYTE | Truncated MAC data value |
| TruncMacLength | DWORD | Truncated MAC data length (bit unit) |
| ID | - | CAN ID information |
| State | - | TX/RX frame monitor information |
ID structure
ID is a union of StdID (standard ID info), ExtID (extended ID info), and Type (error info), each represented as a DWORD bit-field structure.
Members are as follows.
| Structure | Variable | Bits | Description |
|---|---|---|---|
| StdID | - | 18 | Unused |
| CANID | 11 | Standard CAN ID | |
| - | 3 | Unused | |
| ExtID | CANID | 29 | Extended CAN ID |
| - | 3 | Unused | |
| Type | - | 30 | Unused |
| RTR | 1 | Remote Transmission Request (RTR) (*) | |
| IDE | 1 | CAN ID type (IDE) (*) |
*: For value meanings, refer to constant definitions.
State structure
State is a DWORD bit-field structure with members below.
| Variable | Bits | Description |
|---|---|---|
| LogType | 6 | TX/RX frame protocol (*1) |
| Dir | 1 | TX/RX direction (*1) |
| Error | 1 | Error status (*2) |
1: For value meanings, refer to constant definitions.
2: In error code constants, MPX_COUT_OK means no error and MPX_COUT_ERROR means error.
StCustomParamCfg
Members of StCustomParamCfg (callout custom parameter information):
| Variable | Type | Description |
|---|---|---|
| UserType | DWORD | Data type of callout custom parameter (*1) |
| Data | LPVOID | Value of callout custom parameter |
| ByteLength | DWORD | Data length of callout custom parameter (byte unit, max 256 bytes) (*2) |
| ItemName | DWORD | Name of callout custom parameter |
1: For value meanings, refer to constant definitions.
2: Valid only when data type is string.