Crate dpdu_rust

Source
Expand description

A core implementation of the D-PDU API (ISO 22900-2).

This crate just provides the type definitions in order to use the API with Rust code.

For a crate that actually uses this API, you can check the ecu_diagnostics crate

NOTE: To match the rust naming convention, enums and structure names have been slightly renamed.

Structs§

CopCtrlData
Com primitive control data
EcuUniqueRespData
ECU Unique response data
ErrorData
Async error notification data
EthSwitchState
IOCTL ethernet switch state
EventItem
Event notification item
ExpRespData
Expected response structure
ExtraInfo
Extra information data
FlagData
Flag data
InfoData
Async event information data
IoByteArrayData
IOCTL Byte array structure
IoEntityAddressData
DoIP IO Entity address data
IoEntityStatusData
DoIP IO Entity status data
IoEventQueuePropertyData
IOCTL Event queue property data
IoFilterData
IOCTL Filter data structure
IoProgVoltageData
IOCTL programming voltage structure
IpAddrInfo
Address info
ModuleData
Module identification data
ModuleItem
Module identification information
ParamByteFieldData
ComParam byte field data
ParamItem
ComParam data information
ParamLongFieldData
Long field data
ParamStructAccessTiming
Access timing for ParamStructFieldData when ParamStructFieldData::com_param_struct_type is PduCpst::AccessTiming
ParamStructFieldData
ComParam struct field data
ParamStructSessionTiming
Session timing for ParamStructFieldData when ParamStructFieldData::com_param_struct_type is PduCpst::SessionTiming
PduDataItem
Generic IOCTL type structure
PduItem
Generic structure containing item type
PinData
Pin Data
ResultData
Async result notification
RscConflictData
Resource conflict data
RscConflictItem
Resource conflict item
RscData
Resource data
RscIdItem
Item resource identification item
RscIdItemData
Item resource identification data
RscStatusData
Resource status data
RscStatusItem
Resource status item
UniqueRespIdTableItem
Unique response identification data
VehicleIdRequest
IOCTL Vehicle ID request
VersionData
Version information

Enums§

CombinationMode
DoIP Combination mode
PduCopt
Communication primitive (ComParam) type
PduCpst
ComParam struct type
PduError
Function return values
PduErrorEvt
Function error events (Used in asynchronous situations)
PduEvtData
Event callback
PduFilter
Filter type
PduInfo
Information events
PduIt
Item type values
PduObjt
Object type
PduPc
ComParam data class
PduPt
ComParam data type
PduQueueMode
IOCTL queue mode
PduStatus
Status codes
TimingSet
Timing set types used by [ParamStructAccessTiming]
VidPreselectMode
Vehicle preselection mode

Constants§

PDU_HANDLE_UNDEF
Undefined handle value
PDU_ID_UNDEF
Undefined ID value

Type Aliases§

EventCallbackFn
PDU Event callback function type
PduCancelComPrimitiveFn
Cancels and stops a ComPrimitive
PduConnectFn
Connects a ComLogicalLink to a vehicle interface
PduConstructFn
Constructs and initializes the PDU API library
PduCreateComLogicalLinkFn
Creates a ComLogicalLink for a given resource ID
PduDestroyComLogicalLinkFn
Destroys a given ComLogicalLink
PduDestroyItemFn
Destroys a given item
PduDestructFn
Closes all open communication channels and destructs the PDU API library
PduDisconnectFn
Disconnects a ComLogicalLink from a vehicle interface
PduGetComParamFn
Obtains a communication or bus ComParam out of the MVCIs working buffer of a ComLogicalLink
PduGetConflictingResourcesFn
Gets a list of conflicting resources
PduGetEventItemFn
Retrieves event data for a given event source
PduGetListErrorFn
Gets the last runtime error from the MVCI module or ComLogicalLink Used for SAE J2534-2 support
PduGetModuleIdsFn
Object module information
PduGetObjectIdFn
Gets the Item ID of a given item
PduGetResourceIdsFn
Get a list of resource IDs
PduGetResourceStatusFn
Obtains resource status information from the PDU API
PduGetStatusFn
Gets runtime information from either a MVCI module, ComLogicalLink or ComPrimitive
PduGetTimestampFn
Obtains the current hardware clock of the MVCI module
PduGetUniqueRespIdTableFn
Gets a list of unique response IDs from a ComLogicalLink
PduGetVersionFn
Gets version information from MVCI module
PduIoctlFn
Performs generic IOCTL calls on a MVCI or ComLogicalLink
PduLockResourceFn
Locks a physical resource so that a ComLogicalLink has exclusive access to it
PduModuleConnectFn
Determines if a MVCI module is available to connect
PduModuleDisconnectFn
Tries to close all communication channels of a MVCI module
PduRegisterCallbackFn
Registers a callback function
PduSetComParamFn
Sets a com param on a ComLogicalLink
PduSetUniqueRespIdTableFn
Sets a unique response ID table for the ComLogicalLink
PduStartComPrimitiveFn
Creates and starts a ComPrimitive
PduUnlockResourceFn
Unlocks a physical resource from a ComLogicalLink that has exclusive access to it