ISO 22900-2:2017
Road vehicles — Modular vehicle communication interface (MVCI) — Part 2: Diagnostic protocol data unit (D-PDU API)
ISO 22900-2:2017 specifies the diagnostic protocol data unit application programming interface (D-PDU API) as a modular vehicle communication interface (MVCI) protocol module software interface and common basis for diagnostic and reprogramming software applications.
ISO 22900-2:2017 covers the descriptions of the application programming interface (API) functions and the abstraction of diagnostic protocols, as well as the handling and description of MVCI protocol module features. Sample MVCI module description files accompany this document.
The purpose of ISO 22900-2:2017 is to ensure that diagnostic and reprogramming applications from any vehicle or tool manufacturer can operate on a common software interface and can easily exchange MVCI protocol module implementations.
| Get this standard | Prices exclude GST | |
|---|---|---|
| PDF ( Single user document) |
$118.26 NZD
|
|
| HardCopy |
$152.17 NZD
|
|
| Networkable PDF |
Price varies
|
1 Scope
2 Normative references
3 Terms, definitions and abbreviated terms
3.1 Terms and definitions
3.2 Abbreviated terms
4 Specification release version information
4.1 Specification release version location
4.2 Specification release version
5 Modular VCI use cases
5.1 OEM merger
5.2 OEM cross vehicle platform ECU(s)
5.3 Central source diagnostic data and exchange during ECU development
5.4 OEM franchised dealer and aftermarket service outlet diagnostic tool support
6 Modular VCI software architecture
6.1 Overview
6.2 Modular VCI D-Server software
6.3 Runtime format based on ODX
6.4 MVCI protocol module software
6.5 MVCI protocol module configurations
7 D-PDU API use cases
7.1 Overview
7.2 Use case 1: Single MVCI protocol module
7.3 Use case 2: Multiple MVCI protocol modules supported by same D-PDU API implementation
7.4 Use case 3: Multiple MVCI protocol modules supported by different D-PDU API implementations
8 Diagnostic protocol data unit (D-PDU) API
8.1 Software requirements
8.1.1 General requirements
8.1.2 Vehicle protocol requirements
8.1.3 Timing requirements for protocol handler messages
8.1.4 Serialization requirements for protocol handler messages
8.1.5 Compatibility requirements
8.1.6 Timestamp requirements
8.1.6.1 General
8.1.6.2 Timestamp for transmitted messages
8.1.6.3 Timestamp for received messages
8.1.6.4 Timestamp for events, errors and indications
8.1.6.5 Timestamp for start of message indication
8.2 API function overview and communication principles
8.2.1 Terms used within the D-PDU API
8.2.1.1 Resource
8.2.1.2 ComLogicalLink
8.2.1.3 ComPrimitive
8.2.1.4 ComParam
8.2.2 Function overview
8.2.3 General usage
8.2.4 Asynchronous and synchronous communication
8.2.4.1 General
8.2.4.2 Event callback (asynchronous mode)
8.2.4.3 Polling (synchronous mode)
8.2.5 Usage of resource locking and resource unlocking
8.2.6 Usage of ComPrimitives
8.2.6.1 ComPrimitive overview
8.2.6.2 ComPrimitive send/receive cycle overview
8.2.6.2.1 General
8.2.6.2.2 NumReceiveCycles description
8.2.6.2.3 NumSendCycles description
8.2.6.3 ComPrimitive principles
8.2.6.3.1 General
8.2.6.3.2 Starting communication
8.2.6.3.3 Stopping communication
8.2.6.3.4 Send and receive handling
8.2.6.3.5 ComPrimitives in non-raw mode
8.2.6.3.6 ComPrimitives in raw mode (PassThru)
8.2.6.4 ComPrimitive sequence diagrams
8.2.6.4.1 Single request/single response (master/slave communication) — Event notification
8.2.6.4.2 Single request/single response (master/slave communication) — Polling mode
8.2.6.4.3 Single request/multiple responses
8.2.6.4.4 Single request/multiple responses — Functional addressing
8.2.6.4.5 Single or multiple requests/no responses
8.2.6.4.6 No request/single or multiple responses
8.2.6.5 Parallel execution of ComPrimitives
8.2.6.6 Cancelling a running ComPrimitive
8.2.6.7 Destruction of ComPrimitives
8.3 Tool integration
8.3.1 Requirement for generic configuration
8.3.2 Tool integrator — Use case
8.4 API functions — Interface description
8.4.1 Overview
8.4.2 PDUConstruct
8.4.2.1 Purpose
8.4.2.2 Behaviour
8.4.2.3 C/C++ prototype
8.4.2.4 Parameters
8.4.2.5 Example
8.4.2.6 Return values
8.4.3 PDUDestruct
8.4.3.1 Purpose
8.4.3.2 Behaviour
8.4.3.3 C/C++ prototype
8.4.3.4 Parameters
8.4.3.5 Return values
8.4.4 PDUIoCtl
8.4.4.1 Purpose
8.4.4.2 Behaviour
8.4.4.3 C/C++ prototype
8.4.4.4 Parameters
8.4.4.5 Examples
8.4.4.6 Return values
8.4.5 PDUGetVersion
8.4.5.1 Purpose
8.4.5.2 Behaviour
8.4.5.3 C/C++ prototype
8.4.5.4 Parameters
8.4.5.5 Return values
8.4.6 PDUGetStatus
8.4.6.1 Purpose
8.4.6.2 Behaviour
8.4.6.3 C/C++ prototype
8.4.6.4 Parameters
8.4.6.5 Return values
8.4.7 PDUGetLastError
8.4.7.1 Purpose
8.4.7.2 Behaviour
8.4.7.3 C/C++ prototype
8.4.7.4 Parameters
8.4.7.5 Return values
8.4.8 PDUGetResourceStatus
8.4.8.1 Purpose
8.4.8.2 Behaviour
8.4.8.3 C/C++ prototype
8.4.8.4 Parameters
8.4.8.5 Return values
8.4.9 PDUCreateComLogicalLink
8.4.9.1 Purpose
8.4.9.1.1 General
8.4.9.1.2 Unknown resource id scheme
8.4.9.1.3 Specific resource id scheme
8.4.9.2 Behaviour
8.4.9.2.1 Behaviour — Use cases
8.4.9.3 C/C++ prototype
8.4.9.4 Parameters
8.4.9.5 Return values
8.4.10 PDUDestroyComLogicalLink
8.4.10.1 Purpose
8.4.10.2 Behaviour
8.4.10.3 C/C++ prototype
8.4.10.4 Parameters
8.4.10.5 Return values
8.4.11 PDUConnect
8.4.11.1 Purpose
8.4.11.2 Behaviour
8.4.11.3 C/C++ prototype
8.4.11.4 Parameters
8.4.11.5 Return values
8.4.12 PDUDisconnect
8.4.12.1 Purpose
8.4.12.2 Behaviour
8.4.12.3 C/C++ prototype
8.4.12.4 Parameters
8.4.12.5 Return values
8.4.13 PDULockResource
8.4.13.1 Purpose
8.4.13.2 Behaviour
8.4.13.3 Behaviour — Use cases
8.4.13.4 C/C++ prototype
8.4.13.5 Parameters
8.4.13.6 Return values
8.4.14 PDUUnlockResource
8.4.14.1 Purpose
8.4.14.2 Behaviour
8.4.14.3 C/C++ prototype
8.4.14.4 Parameters
8.4.14.5 Return values
8.4.15 PDUGetComParam
8.4.15.1 Purpose
8.4.15.2 Behaviour
8.4.15.3 C/C++ prototype
8.4.15.4 Parameters
8.4.15.5 Return values
8.4.15.6 Example for ComParam Buffer Operation
8.4.15.7 Example for ComParam buffer operation for PDUConnect
8.4.15.9 Example for ComParam buffer operation using PDU_COPT_UPDATEPARAM
8.4.15.10 Example for ComParam buffer attachment to a ComPrimitive
8.4.15.11 Additional example for ComPrimitive queuing
8.4.16 PDUSetComParam
8.4.16.1 Purpose
8.4.16.2 Behaviour
8.4.16.2.1 Behaviour — Use cases
8.4.16.3 C/C++ prototype
8.4.16.4 Parameters
8.4.16.5 Return values
8.4.17 PDUStartComPrimitive
8.4.17.1 Purpose
8.4.17.2 Behaviour
8.4.17.2.1 Behaviour — Use cases
8.4.17.2.2 Behaviour — ComPrimitive status events
8.4.17.3 C/C++ prototype
8.4.17.4 Parameters
8.4.17.5 Return values
8.4.18 PDUCancelComPrimitive
8.4.18.1 Purpose
8.4.18.2 Behaviour
8.4.18.3 C/C++ prototype
8.4.18.4 Parameters
8.4.18.5 Return values
8.4.19 PDUGetEventItem
8.4.19.1 Purpose
8.4.19.2 Behaviour
8.4.19.3 C/C++ prototype
8.4.19.4 Parameters
8.4.19.5 Return values
8.4.20 PDUDestroyItem
8.4.20.1 Purpose
8.4.20.2 Behaviour
8.4.20.3 C/C++ prototype
8.4.20.4 Parameters
8.4.20.5 Return values
8.4.21 PDURegisterEventCallback
8.4.21.1 Purpose
8.4.21.2 Behaviour
8.4.21.3 C/C++ Prototype
8.4.21.4 Parameters
8.4.21.5 Return values
8.4.22 EventCallback prototype
8.4.22.1 Purpose
8.4.22.2 C/C++ prototype
8.4.22.3 Parameters
8.4.22.4 Return values
8.4.23 PDUGetObjectId
8.4.23.1 Purpose
8.4.23.2 Behaviour
8.4.23.3 C/C++ prototype
8.4.23.4 Parameters
8.4.23.5 Return values
8.4.24 PDUGetModuleIds
8.4.24.1 Purpose
8.4.24.2 Behaviour
8.4.24.2.1 Behaviour — Use cases
8.4.24.3 C/C++ prototype
8.4.24.4 Parameters
8.4.24.5 Return values
8.4.25 PDUGetResourceIds
8.4.25.1 Purpose
8.4.25.2 Behaviour
8.4.25.3 C/C++ prototype
8.4.25.4 Parameters
8.4.25.5 Return values
8.4.26 PDUGetConflictingResources
8.4.26.1 Purpose
8.4.26.2 Behaviour
8.4.26.3 C/C++ prototype
8.4.26.4 Parameters
8.4.26.5 Return values
8.4.27 PDUGetUniqueRespIdTable
8.4.27.1 Purpose
8.4.27.2 Behaviour
8.4.27.3 C/C++ prototype
8.4.27.4 Parameters
8.4.27.5 Return values
8.4.28 PDUSetUniqueRespIdTable
8.4.28.1 Purpose
8.4.28.2 Behaviour
8.4.28.2.1 Behaviour — Use cases
8.4.28.3 C/C++ prototype
8.4.28.4 Parameters
8.4.28.5 Return values
8.4.28.6 Using the Unique Response ID Table (URID table) for physical and functional addressing
8.4.28.7 Handling of known and unknown responses from an ECU
8.4.28.7.1 Use cases
8.4.28.7.2 Handling of known ECU response ids
8.4.28.7.3 Handling of unknown ECU response ids
8.4.28.7.4 ECU response handling flow chart
8.4.29 PDUModuleConnect
8.4.29.1 Purpose
8.4.29.2 Behaviour
8.4.29.2.1 Behaviour — Use cases
8.4.29.3 C/C++ prototype
8.4.29.4 Parameters
8.4.29.5 Return values
8.4.30 PDUModuleDisconnect
8.4.30.1 Purpose
8.4.30.2 Behaviour
8.4.30.3 C/C++ prototype
8.4.30.4 Parameters
8.4.30.5 Return values
8.4.31 PDUGetTimestamp
8.4.31.1 Purpose
8.4.31.2 Behaviour
8.4.31.3 C/C++ prototype
8.4.31.4 Parameters
8.4.31.5 Return values
8.5 I/O control section
8.5.1 IOCTL API command overview
8.5.2 PDU_IOCTL_RESET
8.5.3 PDU_IOCTL_CLEAR_TX_QUEUE
8.5.4 PDU_IOCTL_SUSPEND_TX_QUEUE
8.5.5 PDU_IOCTL_RESUME_TX_QUEUE
8.5.6 PDU_IOCTL_CLEAR_RX_QUEUE
8.5.7 PDU_IOCTL_CLEAR_TX_QUEUE_PENDING
8.5.8 PDU_IOCTL_READ_VBATT
8.5.9 PDU_IOCTL_SET_PROG_VOLTAGE
8.5.10 PDU_IOCTL_READ_PROG_VOLTAGE
8.5.11 PDU_IOCTL_GENERIC
8.5.12 PDU_IOCTL_SET_BUFFER_SIZE
8.5.13 PDU_IOCTL_GET_CABLE_ID
8.5.14 PDU_IOCTL_START_MSG_FILTER
8.5.14.1 MSG_FILTER block diagram
8.5.15 PDU_IOCTL_STOP_MSG_FILTER
8.5.16 PDU_IOCTL_CLEAR_MSG_FILTER
8.5.17 PDU_IOCTL_SET_EVENT_QUEUE_PROPERTIES
8.5.18 PDU_IOCTL_SEND_BREAK
8.5.19 PDU_IOCTL_READ_IGNITION_SENSE_STATE
8.5.20 PDU_IOCTL_VEHICLE_ID_REQUEST
8.5.20.1 General
8.5.20.2 PDU_IOCTL_VEHICLE_ID_REQUEST return values
8.5.21 PDU_IOCTL_SET_ETH_SWITCH_STATE
8.5.21.1 General
8.5.21.2 PDU_IOCTL_SET_ETH_SWITCH_STATE return values
8.5.22 PDU_IOCTL_GET_ENTITY_STATUS
8.5.22.1 General
8.5.22.2 PDU_IOCTL_GET_ENTITY_STATUS return values
8.5.23 PDU_IOCTL_GET_DIAGNOSTIC_POWER_MODE
8.5.23.1 General
8.5.23.2 PDU_IOCTL_GET_DIAGNOSTIC_POWER_MODE return values
8.5.24 PDU_IOCTL_GET_ETH_PIN_OPTION
8.5.24.1 General
8.5.24.2 PDU_IOCTL_GET_ETH_PIN_OPTION return values
8.6 API functions — Error handling
8.6.1 Synchronous error handling
8.6.2 Asynchronous error handling
8.7 Installation
8.7.1 Generic description
8.7.2 Windows installation process
8.7.2.1 Locating the Windows D-PDU API DLL
8.7.2.2 Loading the Windows D-PDU API DLL
8.7.3 Linux installation process
8.7.3.1 Locating the Linux D-PDU API shared library
8.7.3.2 Loading the Linux D-PDU API shared library
8.7.4 Selecting MVCI protocol modules
8.8 Application notes
8.8.1 Interaction with the MDF
8.8.2 Accessing additional hardware features for MVCI protocol modules
8.8.3 Documentation and information provided by MVCI protocol module vendors
9 Using the D-PDU API with existing applications
9.1 SAE J2534-1 and RP1210a existing standards
10 Data structures
10.1 API functions — Data structure definitions
10.1.1 Abstract basic data types
10.1.2 Definitions
10.1.3 Bit encoding for UNUM32
10.1.4 API data structures
10.1.4.1 General
10.1.4.2 Generic item for type evaluation and casting
10.1.4.3 Items for IOCTL data transfer (PDUIoctl)
10.1.4.3.1 Item for Generic IOCTL data item
10.1.4.3.2 IOCTL programming voltage structure (PDU_IT_IO_PROG_VOLTAGE)
10.1.4.3.3 IOCTL byte array structure (PDU_IT_IO_BYTEARRAY)
10.1.4.3.4 IOCTL filter list structure (PDU_IT_IO_FILTER)
10.1.4.3.5 IOCTL filter data structure
10.1.4.3.6 IOCTL event queue property structure (PDU_IT_IO_EVENT_QUEUE_PROPERTY)
10.1.4.3.7 IOCTL vehicle ID request structure (PDU_IOCTL_VEHICLE_ID_REQUEST)
10.1.4.3.8 IOCTL set Ethernet switch state structure (PDU_IOCTL_SET_ETH_SWITCH_STATE)
10.1.4.4 Item for resource status information (used by PDUGetResourceStatus)
10.1.4.5 Item for ComParam data (used by PDUGetComParam, PDUSetComParam)
10.1.4.6 Item for module identification (used by PDUGetModuleIds)
10.1.4.7 Items for resource identification (used by PDUGetResourceIds)
10.1.4.8 Structure for resource data (used by PDUGetResourceIds and PDUCreateComLogicalLink)
10.1.4.9 Item for conflicting resources (used by PDUGetConflictingResources)
10.1.4.10 Item for unique response identification (used by PDUGetUniqueRespIdTable and PDUSetUniqueRespIdTable)
10.1.4.11 Item for event notification
10.1.4.11.1 Structure for status data
10.1.4.11.2 Asynchronous event information notification for PDU_IT_INFO Item
10.1.4.11.3 Asynchronous error notification structure for the PDU_IT_ERROR Item
10.1.4.11.4 Structure for result data
10.1.4.12 Structure for extra result data information
10.1.4.13 Structure for flag data
10.1.4.14 Structure for version information (used by PDUGetVersion)
10.1.4.15 Coding of version numbers
10.1.4.16 Coding of dates
10.1.4.17 Structure to control a ComPrimitive’s operation (used by PDUStartComPrimitive)
10.1.4.18 Data Items for IOCTL PDU_IOCTL_GET_ENTITY_STATUS
10.1.4.19 Structure for expected response
10.1.4.19.1 Expected response type
10.1.4.19.2 Array of unique response ids (pUniqueRespIds)
10.1.4.19.3 Expected response matching rules
10.1.4.19.4 Expected response example
10.1.4.19.5 Expected response structure (RawMode/NonRawMode)
Blank Page
Blank Page
Previous versions
Keep me up-to-date
Sign up to receive updates when there are changes to this standard
1 Scope
2 Normative references
3 Terms, definitions and abbreviated terms
3.1 Terms and definitions
3.2 Abbreviated terms
4 Specification release version information
4.1 Specification release version location
4.2 Specification release version
5 Modular VCI use cases
5.1 OEM merger
5.2 OEM cross vehicle platform ECU(s)
5.3 Central source diagnostic data and exchange during ECU development
5.4 OEM franchised dealer and aftermarket service outlet diagnostic tool support
6 Modular VCI software architecture
6.1 Overview
6.2 Modular VCI D-Server software
6.3 Runtime format based on ODX
6.4 MVCI protocol module software
6.5 MVCI protocol module configurations
7 D-PDU API use cases
7.1 Overview
7.2 Use case 1: Single MVCI protocol module
7.3 Use case 2: Multiple MVCI protocol modules supported by same D-PDU API implementation
7.4 Use case 3: Multiple MVCI protocol modules supported by different D-PDU API implementations
8 Diagnostic protocol data unit (D-PDU) API
8.1 Software requirements
8.1.1 General requirements
8.1.2 Vehicle protocol requirements
8.1.3 Timing requirements for protocol handler messages
8.1.4 Serialization requirements for protocol handler messages
8.1.5 Compatibility requirements
8.1.6 Timestamp requirements
8.1.6.1 General
8.1.6.2 Timestamp for transmitted messages
8.1.6.3 Timestamp for received messages
8.1.6.4 Timestamp for events, errors and indications
8.1.6.5 Timestamp for start of message indication
8.2 API function overview and communication principles
8.2.1 Terms used within the D-PDU API
8.2.1.1 Resource
8.2.1.2 ComLogicalLink
8.2.1.3 ComPrimitive
8.2.1.4 ComParam
8.2.2 Function overview
8.2.3 General usage
8.2.4 Asynchronous and synchronous communication
8.2.4.1 General
8.2.4.2 Event callback (asynchronous mode)
8.2.4.3 Polling (synchronous mode)
8.2.5 Usage of resource locking and resource unlocking
8.2.6 Usage of ComPrimitives
8.2.6.1 ComPrimitive overview
8.2.6.2 ComPrimitive send/receive cycle overview
8.2.6.2.1 General
8.2.6.2.2 NumReceiveCycles description
8.2.6.2.3 NumSendCycles description
8.2.6.3 ComPrimitive principles
8.2.6.3.1 General
8.2.6.3.2 Starting communication
8.2.6.3.3 Stopping communication
8.2.6.3.4 Send and receive handling
8.2.6.3.5 ComPrimitives in non-raw mode
8.2.6.3.6 ComPrimitives in raw mode (PassThru)
8.2.6.4 ComPrimitive sequence diagrams
8.2.6.4.1 Single request/single response (master/slave communication) — Event notification
8.2.6.4.2 Single request/single response (master/slave communication) — Polling mode
8.2.6.4.3 Single request/multiple responses
8.2.6.4.4 Single request/multiple responses — Functional addressing
8.2.6.4.5 Single or multiple requests/no responses
8.2.6.4.6 No request/single or multiple responses
8.2.6.5 Parallel execution of ComPrimitives
8.2.6.6 Cancelling a running ComPrimitive
8.2.6.7 Destruction of ComPrimitives
8.3 Tool integration
8.3.1 Requirement for generic configuration
8.3.2 Tool integrator — Use case
8.4 API functions — Interface description
8.4.1 Overview
8.4.2 PDUConstruct
8.4.2.1 Purpose
8.4.2.2 Behaviour
8.4.2.3 C/C++ prototype
8.4.2.4 Parameters
8.4.2.5 Example
8.4.2.6 Return values
8.4.3 PDUDestruct
8.4.3.1 Purpose
8.4.3.2 Behaviour
8.4.3.3 C/C++ prototype
8.4.3.4 Parameters
8.4.3.5 Return values
8.4.4 PDUIoCtl
8.4.4.1 Purpose
8.4.4.2 Behaviour
8.4.4.3 C/C++ prototype
8.4.4.4 Parameters
8.4.4.5 Examples
8.4.4.6 Return values
8.4.5 PDUGetVersion
8.4.5.1 Purpose
8.4.5.2 Behaviour
8.4.5.3 C/C++ prototype
8.4.5.4 Parameters
8.4.5.5 Return values
8.4.6 PDUGetStatus
8.4.6.1 Purpose
8.4.6.2 Behaviour
8.4.6.3 C/C++ prototype
8.4.6.4 Parameters
8.4.6.5 Return values
8.4.7 PDUGetLastError
8.4.7.1 Purpose
8.4.7.2 Behaviour
8.4.7.3 C/C++ prototype
8.4.7.4 Parameters
8.4.7.5 Return values
8.4.8 PDUGetResourceStatus
8.4.8.1 Purpose
8.4.8.2 Behaviour
8.4.8.3 C/C++ prototype
8.4.8.4 Parameters
8.4.8.5 Return values
8.4.9 PDUCreateComLogicalLink
8.4.9.1 Purpose
8.4.9.1.1 General
8.4.9.1.2 Unknown resource id scheme
8.4.9.1.3 Specific resource id scheme
8.4.9.2 Behaviour
8.4.9.2.1 Behaviour — Use cases
8.4.9.3 C/C++ prototype
8.4.9.4 Parameters
8.4.9.5 Return values
8.4.10 PDUDestroyComLogicalLink
8.4.10.1 Purpose
8.4.10.2 Behaviour
8.4.10.3 C/C++ prototype
8.4.10.4 Parameters
8.4.10.5 Return values
8.4.11 PDUConnect
8.4.11.1 Purpose
8.4.11.2 Behaviour
8.4.11.3 C/C++ prototype
8.4.11.4 Parameters
8.4.11.5 Return values
8.4.12 PDUDisconnect
8.4.12.1 Purpose
8.4.12.2 Behaviour
8.4.12.3 C/C++ prototype
8.4.12.4 Parameters
8.4.12.5 Return values
8.4.13 PDULockResource
8.4.13.1 Purpose
8.4.13.2 Behaviour
8.4.13.3 Behaviour — Use cases
8.4.13.4 C/C++ prototype
8.4.13.5 Parameters
8.4.13.6 Return values
8.4.14 PDUUnlockResource
8.4.14.1 Purpose
8.4.14.2 Behaviour
8.4.14.3 C/C++ prototype
8.4.14.4 Parameters
8.4.14.5 Return values
8.4.15 PDUGetComParam
8.4.15.1 Purpose
8.4.15.2 Behaviour
8.4.15.3 C/C++ prototype
8.4.15.4 Parameters
8.4.15.5 Return values
8.4.15.6 Example for ComParam Buffer Operation
8.4.15.7 Example for ComParam buffer operation for PDUConnect
8.4.15.9 Example for ComParam buffer operation using PDU_COPT_UPDATEPARAM
8.4.15.10 Example for ComParam buffer attachment to a ComPrimitive
8.4.15.11 Additional example for ComPrimitive queuing
8.4.16 PDUSetComParam
8.4.16.1 Purpose
8.4.16.2 Behaviour
8.4.16.2.1 Behaviour — Use cases
8.4.16.3 C/C++ prototype
8.4.16.4 Parameters
8.4.16.5 Return values
8.4.17 PDUStartComPrimitive
8.4.17.1 Purpose
8.4.17.2 Behaviour
8.4.17.2.1 Behaviour — Use cases
8.4.17.2.2 Behaviour — ComPrimitive status events
8.4.17.3 C/C++ prototype
8.4.17.4 Parameters
8.4.17.5 Return values
8.4.18 PDUCancelComPrimitive
8.4.18.1 Purpose
8.4.18.2 Behaviour
8.4.18.3 C/C++ prototype
8.4.18.4 Parameters
8.4.18.5 Return values
8.4.19 PDUGetEventItem
8.4.19.1 Purpose
8.4.19.2 Behaviour
8.4.19.3 C/C++ prototype
8.4.19.4 Parameters
8.4.19.5 Return values
8.4.20 PDUDestroyItem
8.4.20.1 Purpose
8.4.20.2 Behaviour
8.4.20.3 C/C++ prototype
8.4.20.4 Parameters
8.4.20.5 Return values
8.4.21 PDURegisterEventCallback
8.4.21.1 Purpose
8.4.21.2 Behaviour
8.4.21.3 C/C++ Prototype
8.4.21.4 Parameters
8.4.21.5 Return values
8.4.22 EventCallback prototype
8.4.22.1 Purpose
8.4.22.2 C/C++ prototype
8.4.22.3 Parameters
8.4.22.4 Return values
8.4.23 PDUGetObjectId
8.4.23.1 Purpose
8.4.23.2 Behaviour
8.4.23.3 C/C++ prototype
8.4.23.4 Parameters
8.4.23.5 Return values
8.4.24 PDUGetModuleIds
8.4.24.1 Purpose
8.4.24.2 Behaviour
8.4.24.2.1 Behaviour — Use cases
8.4.24.3 C/C++ prototype
8.4.24.4 Parameters
8.4.24.5 Return values
8.4.25 PDUGetResourceIds
8.4.25.1 Purpose
8.4.25.2 Behaviour
8.4.25.3 C/C++ prototype
8.4.25.4 Parameters
8.4.25.5 Return values
8.4.26 PDUGetConflictingResources
8.4.26.1 Purpose
8.4.26.2 Behaviour
8.4.26.3 C/C++ prototype
8.4.26.4 Parameters
8.4.26.5 Return values
8.4.27 PDUGetUniqueRespIdTable
8.4.27.1 Purpose
8.4.27.2 Behaviour
8.4.27.3 C/C++ prototype
8.4.27.4 Parameters
8.4.27.5 Return values
8.4.28 PDUSetUniqueRespIdTable
8.4.28.1 Purpose
8.4.28.2 Behaviour
8.4.28.2.1 Behaviour — Use cases
8.4.28.3 C/C++ prototype
8.4.28.4 Parameters
8.4.28.5 Return values
8.4.28.6 Using the Unique Response ID Table (URID table) for physical and functional addressing
8.4.28.7 Handling of known and unknown responses from an ECU
8.4.28.7.1 Use cases
8.4.28.7.2 Handling of known ECU response ids
8.4.28.7.3 Handling of unknown ECU response ids
8.4.28.7.4 ECU response handling flow chart
8.4.29 PDUModuleConnect
8.4.29.1 Purpose
8.4.29.2 Behaviour
8.4.29.2.1 Behaviour — Use cases
8.4.29.3 C/C++ prototype
8.4.29.4 Parameters
8.4.29.5 Return values
8.4.30 PDUModuleDisconnect
8.4.30.1 Purpose
8.4.30.2 Behaviour
8.4.30.3 C/C++ prototype
8.4.30.4 Parameters
8.4.30.5 Return values
8.4.31 PDUGetTimestamp
8.4.31.1 Purpose
8.4.31.2 Behaviour
8.4.31.3 C/C++ prototype
8.4.31.4 Parameters
8.4.31.5 Return values
8.5 I/O control section
8.5.1 IOCTL API command overview
8.5.2 PDU_IOCTL_RESET
8.5.3 PDU_IOCTL_CLEAR_TX_QUEUE
8.5.4 PDU_IOCTL_SUSPEND_TX_QUEUE
8.5.5 PDU_IOCTL_RESUME_TX_QUEUE
8.5.6 PDU_IOCTL_CLEAR_RX_QUEUE
8.5.7 PDU_IOCTL_CLEAR_TX_QUEUE_PENDING
8.5.8 PDU_IOCTL_READ_VBATT
8.5.9 PDU_IOCTL_SET_PROG_VOLTAGE
8.5.10 PDU_IOCTL_READ_PROG_VOLTAGE
8.5.11 PDU_IOCTL_GENERIC
8.5.12 PDU_IOCTL_SET_BUFFER_SIZE
8.5.13 PDU_IOCTL_GET_CABLE_ID
8.5.14 PDU_IOCTL_START_MSG_FILTER
8.5.14.1 MSG_FILTER block diagram
8.5.15 PDU_IOCTL_STOP_MSG_FILTER
8.5.16 PDU_IOCTL_CLEAR_MSG_FILTER
8.5.17 PDU_IOCTL_SET_EVENT_QUEUE_PROPERTIES
8.5.18 PDU_IOCTL_SEND_BREAK
8.5.19 PDU_IOCTL_READ_IGNITION_SENSE_STATE
8.5.20 PDU_IOCTL_VEHICLE_ID_REQUEST
8.5.20.1 General
8.5.20.2 PDU_IOCTL_VEHICLE_ID_REQUEST return values
8.5.21 PDU_IOCTL_SET_ETH_SWITCH_STATE
8.5.21.1 General
8.5.21.2 PDU_IOCTL_SET_ETH_SWITCH_STATE return values
8.5.22 PDU_IOCTL_GET_ENTITY_STATUS
8.5.22.1 General
8.5.22.2 PDU_IOCTL_GET_ENTITY_STATUS return values
8.5.23 PDU_IOCTL_GET_DIAGNOSTIC_POWER_MODE
8.5.23.1 General
8.5.23.2 PDU_IOCTL_GET_DIAGNOSTIC_POWER_MODE return values
8.5.24 PDU_IOCTL_GET_ETH_PIN_OPTION
8.5.24.1 General
8.5.24.2 PDU_IOCTL_GET_ETH_PIN_OPTION return values
8.6 API functions — Error handling
8.6.1 Synchronous error handling
8.6.2 Asynchronous error handling
8.7 Installation
8.7.1 Generic description
8.7.2 Windows installation process
8.7.2.1 Locating the Windows D-PDU API DLL
8.7.2.2 Loading the Windows D-PDU API DLL
8.7.3 Linux installation process
8.7.3.1 Locating the Linux D-PDU API shared library
8.7.3.2 Loading the Linux D-PDU API shared library
8.7.4 Selecting MVCI protocol modules
8.8 Application notes
8.8.1 Interaction with the MDF
8.8.2 Accessing additional hardware features for MVCI protocol modules
8.8.3 Documentation and information provided by MVCI protocol module vendors
9 Using the D-PDU API with existing applications
9.1 SAE J2534-1 and RP1210a existing standards
10 Data structures
10.1 API functions — Data structure definitions
10.1.1 Abstract basic data types
10.1.2 Definitions
10.1.3 Bit encoding for UNUM32
10.1.4 API data structures
10.1.4.1 General
10.1.4.2 Generic item for type evaluation and casting
10.1.4.3 Items for IOCTL data transfer (PDUIoctl)
10.1.4.3.1 Item for Generic IOCTL data item
10.1.4.3.2 IOCTL programming voltage structure (PDU_IT_IO_PROG_VOLTAGE)
10.1.4.3.3 IOCTL byte array structure (PDU_IT_IO_BYTEARRAY)
10.1.4.3.4 IOCTL filter list structure (PDU_IT_IO_FILTER)
10.1.4.3.5 IOCTL filter data structure
10.1.4.3.6 IOCTL event queue property structure (PDU_IT_IO_EVENT_QUEUE_PROPERTY)
10.1.4.3.7 IOCTL vehicle ID request structure (PDU_IOCTL_VEHICLE_ID_REQUEST)
10.1.4.3.8 IOCTL set Ethernet switch state structure (PDU_IOCTL_SET_ETH_SWITCH_STATE)
10.1.4.4 Item for resource status information (used by PDUGetResourceStatus)
10.1.4.5 Item for ComParam data (used by PDUGetComParam, PDUSetComParam)
10.1.4.6 Item for module identification (used by PDUGetModuleIds)
10.1.4.7 Items for resource identification (used by PDUGetResourceIds)
10.1.4.8 Structure for resource data (used by PDUGetResourceIds and PDUCreateComLogicalLink)
10.1.4.9 Item for conflicting resources (used by PDUGetConflictingResources)
10.1.4.10 Item for unique response identification (used by PDUGetUniqueRespIdTable and PDUSetUniqueRespIdTable)
10.1.4.11 Item for event notification
10.1.4.11.1 Structure for status data
10.1.4.11.2 Asynchronous event information notification for PDU_IT_INFO Item
10.1.4.11.3 Asynchronous error notification structure for the PDU_IT_ERROR Item
10.1.4.11.4 Structure for result data
10.1.4.12 Structure for extra result data information
10.1.4.13 Structure for flag data
10.1.4.14 Structure for version information (used by PDUGetVersion)
10.1.4.15 Coding of version numbers
10.1.4.16 Coding of dates
10.1.4.17 Structure to control a ComPrimitive’s operation (used by PDUStartComPrimitive)
10.1.4.18 Data Items for IOCTL PDU_IOCTL_GET_ENTITY_STATUS
10.1.4.19 Structure for expected response
10.1.4.19.1 Expected response type
10.1.4.19.2 Array of unique response ids (pUniqueRespIds)
10.1.4.19.3 Expected response matching rules
10.1.4.19.4 Expected response example
10.1.4.19.5 Expected response structure (RawMode/NonRawMode)
Blank Page
Blank Page