dpdu_api_types/
structures.rs

1use crate::{
2    CombinationMode, PduCpst, PduErrorEvt, PduFilter, PduInfo, PduIt, PduPc, PduPt, PduQueueMode,
3    PduStatus, TimingSet, VidPreselectMode,
4};
5use std::ffi::c_void;
6use std::fmt::Debug;
7
8#[repr(C)]
9#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
10/// Generic structure containing item type
11pub struct PduItem {
12    /// Item type
13    pub item_type: PduIt,
14}
15
16#[repr(C)]
17#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
18/// Generic IOCTL type structure
19pub struct PduDataItem {
20    /// IOCTL Item type
21    pub item_type: PduIt,
22    /// IOCTL data structure pointer
23    pub p_data: *mut c_void,
24}
25
26#[repr(C)]
27#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
28/// IOCTL programming voltage structure
29pub struct IoProgVoltageData {
30    /// Programming voltage (mV)
31    pub prog_voltage_mv: u32,
32    /// Pin number on connector
33    pub pin_on_dlc: u32,
34}
35
36#[repr(C)]
37#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
38/// IOCTL Byte array structure
39pub struct IoByteArrayData {
40    /// Data size in bytes
41    pub data_size: u32,
42    /// Pointer to data
43    pub p_data: *mut u8,
44}
45
46impl From<&mut [u8]> for IoByteArrayData {
47    fn from(x: &mut [u8]) -> Self {
48        IoByteArrayData {
49            data_size: x.len() as u32,
50            p_data: x.as_mut_ptr(),
51        }
52    }
53}
54
55/// IOCTL Filter structure
56#[repr(C)]
57#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
58pub struct IoFilter {
59    /// Number of IoFilterData structures
60    /// by p_filter_data pointer.
61    pub num_filter_entries: u32,
62
63    /// Pointer to the first IoFilterData structure
64    pub p_filter_data: *mut IoFilterData,
65}
66
67#[repr(C)]
68#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
69/// IOCTL Filter data structure
70///
71/// MASK & RAW == PATTERN
72pub struct IoFilterData {
73    /// Filter type
74    pub filter_type: PduFilter,
75    /// Filter number
76    pub filter_number: u32,
77    /// Compare size of the mask and pattern message
78    pub filter_compare_size: u32,
79    /// Mask message
80    pub filter_mask_msg: [u8; 12],
81    /// Pattern message
82    pub filter_pattern_msg: [u8; 12],
83}
84
85#[repr(C)]
86#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
87/// IOCTL Event queue property data
88pub struct IoEventQueuePropertyData {
89    /// Max size of the event queue
90    pub queue_size: u32,
91    /// Queue mode
92    pub queue_mode: PduQueueMode,
93}
94
95#[repr(C)]
96#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
97/// IOCTL Vehicle ID request
98pub struct VehicleIdRequest {
99    /// Preselection mode
100    pub preselection_mode: VidPreselectMode,
101    /// Preselection ASCII string
102    pub preselection_value: *mut u8,
103    /// Combination mode
104    pub combination_mode: CombinationMode,
105    /// discovery time in milliseconds
106    pub vehicle_discovery_time: u32,
107    /// Number of broadcast / multicast addresses found in [VehicleIdRequest::destination_addresses] array
108    pub num_destination_addresses: u32,
109    /// Pointer to array of IP addresses
110    pub destination_addresses: *mut IpAddrInfo,
111}
112
113#[repr(C)]
114#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
115/// Address info
116pub struct IpAddrInfo {
117    /// IP version 4 = Ipv4, 6 = Ipv6
118    pub ip_version: u32,
119    /// Pointer to broadcast address (4 bytes for Ipv4, 16 bytes for Ipv6)
120    pub p_address: *mut u8,
121}
122
123#[repr(C)]
124#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
125/// IOCTL ethernet switch state
126pub struct EthSwitchState {
127    /// Sense state - 0 = pin off, 1 = pin on
128    pub eth_sense_state: u32,
129    /// Pin number for ethernet activation
130    pub eth_act_pin_num: u32,
131}
132
133#[repr(C)]
134#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
135/// Resource status data
136pub struct RscStatusData {
137    /// MVCI handle ID
138    pub h_mod: u32,
139    /// Resource ID
140    pub resource_id: u32,
141    /// Resource information status
142    pub resource_status: u32,
143}
144
145#[repr(C)]
146#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
147/// Resource status item
148pub struct RscStatusItem {
149    /// Item type
150    pub item_type: PduIt,
151    /// Number of entries
152    pub num_entries: u32,
153    /// Pointer to array of entries
154    pub p_resource_status_data: *mut RscStatusData,
155}
156
157#[repr(C)]
158#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
159/// ComParam data information
160pub struct ParamItem {
161    /// Item type
162    pub item_type: PduIt,
163    /// Com param ID
164    pub com_param_id: u32,
165    /// Com param data type
166    pub com_param_data_type: PduPt,
167    /// Com param class type
168    pub com_param_class: PduPc,
169    /// Pointer to data of ComParam (of type specified in [ParamItem::com_param_class])
170    pub p_com_param_data: *mut c_void,
171}
172
173#[repr(C)]
174#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
175/// Module identification information
176pub struct ModuleItem {
177    /// Item type
178    pub item_type: PduIt,
179    /// Number of entries in [ModuleItem::p_module_data]
180    pub num_entries: u32,
181    /// Pointer to array of [ModuleData]
182    pub p_module_data: *mut ModuleData,
183}
184
185#[repr(C)]
186#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
187/// Module identification data
188pub struct ModuleData {
189    /// Module protocol type
190    pub module_type_id: u32,
191    /// Module handle ID
192    pub h_mod: u32,
193    /// Null terminated string of module name
194    pub vendor_module_name: *mut u8,
195    /// Null terminated string pointer of any additional info
196    pub vendor_additional_info: *mut u8,
197    /// Module status
198    pub status: PduStatus,
199}
200
201#[repr(C)]
202#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
203/// Item resource identification item
204pub struct RscIdItem {
205    /// Item type
206    pub item_type: PduIt,
207    /// Number of entries in [RscIdItem::p_id_item_data]
208    pub num_modules: u32,
209    /// Pointer to array of [RscIdItemData]
210    pub p_id_item_data: *mut RscIdItemData,
211}
212
213#[repr(C)]
214#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
215/// Item resource identification data
216pub struct RscIdItemData {
217    /// MVCI Handle ID
218    pub h_mod: u32,
219    /// Number of IDs
220    pub num_ids: u32,
221    /// Pointer to list of resource IDs
222    pub p_resource_id_array: *mut u32,
223}
224
225#[repr(C)]
226#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
227/// Resource data
228pub struct RscData {
229    /// Bus type ID
230    pub bus_type_id: u32,
231    /// Protocol ID
232    pub protocol_id: u32,
233    /// Number of items in [RscData::p_dlc_pin_data]
234    pub num_pin_data: u32,
235    /// Pointer to array of [PinData]
236    pub p_dlc_pin_data: *mut PinData,
237}
238
239#[repr(C)]
240#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
241/// Pin Data
242pub struct PinData {
243    /// Pin number on data connector
244    pub dlc_pin_number: u32,
245    /// Pin ID
246    pub dlc_pin_type_id: u32,
247}
248
249#[repr(C)]
250#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
251/// Resource conflict item
252pub struct RscConflictItem {
253    /// Item type
254    pub item_type: PduIt,
255    /// Number of entries in [RscConflictItem::p_rsc_conflict_data]
256    pub num_entries: u32,
257    /// Pointer to array of [RscConflictData]
258    pub p_rsc_conflict_data: *mut RscConflictData,
259}
260
261#[repr(C)]
262#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
263/// Resource conflict data
264pub struct RscConflictData {
265    /// MVCI handle ID with conflict
266    pub h_mod: u32,
267    /// The conflicting resource ID
268    pub resource_id: u32,
269}
270
271#[repr(C)]
272#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
273/// Unique response identification data
274pub struct UniqueRespIdTableItem {
275    /// Item type
276    pub item_type: PduIt,
277    /// Number of entries in [UniqueRespIdTableItem::p_unique_data]
278    pub num_entries: u32,
279    /// Pointer to array of [EcuUniqueRespData]
280    pub p_unique_data: *mut EcuUniqueRespData,
281}
282
283#[repr(C)]
284#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
285/// ECU Unique response data
286pub struct EcuUniqueRespData {
287    /// Unique response identifier
288    pub unique_resp_identifier: u32,
289    /// Number of ComParams for the unique identifier
290    pub num_param_items: u32,
291    /// Pointer to array of ComParams used to uniquely define the ECUs unique response
292    pub p_params: *mut ParamItem,
293}
294
295#[repr(C)]
296#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
297/// Event notification item
298pub struct EventItem {
299    /// Item type
300    pub item_type: PduIt,
301    /// If from ComPrimitive, then this is the ComPrimitive handle, otherwise [PDU_HANDLE_UNDEF]
302    pub h_cop: u32,
303    /// ComPrimitive tag
304    pub p_cop_tag: *mut c_void,
305    /// Timestamp in microseconds
306    pub timestamp: u32,
307    /// Pointer to the data of the event
308    pub p_data: *mut c_void,
309}
310
311#[repr(C)]
312#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
313/// Async event information data
314pub struct InfoData {
315    /// Information code
316    pub info_code: PduInfo,
317    /// optional extra information data
318    pub extra_info_data: u32,
319}
320
321#[repr(C)]
322#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
323/// Async error notification data
324pub struct ErrorData {
325    /// Error code
326    pub error_code_id: PduErrorEvt,
327    /// optional extra error information
328    pub extra_error_info_id: u32,
329}
330
331#[repr(C)]
332#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
333/// Async result notification
334pub struct ResultData {
335    /// Receive message status
336    pub rx_flag: FlagData,
337    /// ECU Response unique ID
338    pub unique_resp_identifier: u32,
339    /// Acceptance ID
340    pub acceptance_id: u32,
341    /// Timestamp indicator flag
342    pub timestamp_flags: FlagData,
343    /// Transmit message done in microseconds
344    pub tx_msg_done_timestamp: u32,
345    /// Start message timestamp in microseconds
346    pub start_msg_timestamp: u32,
347    /// Pointer to extra information
348    pub p_extra_info: *mut ExtraInfo,
349    /// Number of bytes in [ResultData::p_data_bytes]
350    pub num_data_bytes: u32,
351    /// Pointer to payload data structure
352    pub p_data_bytes: *mut u8,
353}
354
355#[repr(C)]
356#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
357/// Extra information data
358pub struct ExtraInfo {
359    /// Number of bytes in [ExtraInfo::p_header_bytes]
360    pub num_header_bytes: u32,
361    /// Number of bytes in [ExtraInfo::p_footer_bytes]
362    pub num_footer_bytes: u32,
363    /// Reference to response header bytes
364    pub p_header_bytes: *mut u8,
365    /// Reference to response footer bytes
366    pub p_footer_bytes: *mut u8,
367}
368
369#[repr(C)]
370#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
371/// Flag data
372pub struct FlagData {
373    /// Number of bytes in [FlagData::p_flag_data]
374    pub num_flag_bytes: u32,
375    /// Pointer to flag bytes
376    pub p_flag_data: *mut u8,
377}
378
379#[repr(C)]
380#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
381/// Version information
382pub struct VersionData {
383    /// Release version of MVCI standard part 1 (Bit encoded)
384    pub mvci_part1_standard_version: u32,
385    /// Release version of MVCI standard part 2 (Bit encoded)
386    pub mvci_part2_standard_version: u32,
387    /// Hardware serial number from vendor
388    pub hw_serial_number: u32,
389    /// Hardware name
390    pub hw_name: [u8; 64],
391    /// Hardware version (Bit encoded)
392    pub hw_version: u32,
393    /// hardware date (Bit encoded)
394    pub hw_date: u32,
395    /// Type of MVCI module
396    pub hw_interface: u32,
397    /// MVCI Firmware name
398    pub fw_name: [u8; 64],
399    /// MVCI firmware version (Bit encoded)
400    pub fw_version: u32,
401    /// MVCI firmware date (Bit encoded)
402    pub fw_date: u32,
403    /// MVCI vendor name
404    pub vendor_name: [u8; 64],
405    /// PDU API software name
406    pub pdu_api_sw_name: [u8; 64],
407    /// PDU API software version (Bit encoded)
408    pub pdu_api_sw_version: u32,
409    /// PDU API software date (Bit encoded)
410    pub pdu_api_sw_date: u32,
411}
412
413impl Default for VersionData {
414    fn default() -> Self {
415        VersionData {
416            mvci_part1_standard_version: 0,
417            mvci_part2_standard_version: 0,
418            hw_serial_number: 0,
419            hw_name: [0u8; 64],
420            hw_version: 0,
421            hw_date: 0,
422            hw_interface: 0,
423            fw_name: [0u8; 64],
424            fw_version: 0,
425            fw_date: 0,
426            vendor_name: [0u8; 64],
427            pdu_api_sw_name: [0u8; 64],
428            pdu_api_sw_version: 0,
429            pdu_api_sw_date: 0,
430        }
431    }
432}
433
434#[repr(C)]
435#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
436/// Com primitive control data
437pub struct CopCtrlData {
438    /// Cycle time in milliseconds or delay time of the ComPrimitive
439    pub time: u32,
440    /// Number of send cycles. -1 for infinite
441    pub num_send_cycles: i32,
442    /// Number of receives. -1 for infinite
443    pub num_receive_cycles: i32,
444    /// Optional temporary setting for the ComPrimitive
445    pub temp_param_update: u32,
446    /// Transmit flag
447    pub tx_flag: FlagData,
448    /// Number of elements in [CopCtrlData::expected_response_array]
449    pub num_possible_expected_responses: u32,
450    /// Pointer to an array of expected responses
451    pub expected_response_array: *mut ExpRespData,
452}
453
454#[repr(C)]
455#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
456/// DoIP IO Entity address data
457pub struct IoEntityAddressData {
458    /// Logical addresses
459    pub logical_address: u32,
460    /// Timeout in milliseconds to wait for responses
461    pub doip_ctrl_timeout: u32,
462}
463
464#[repr(C)]
465#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
466/// DoIP IO Entity status data
467pub struct IoEntityStatusData {
468    /// Type of DoIP entitiy
469    pub entity_type: u32,
470    /// Max number of Sockets allowed
471    pub tcp_clients_max: u32,
472    /// Number of current sockets
473    pub tcp_clients: u32,
474    /// Optional limit in bytes for max size of a single DoIP request
475    pub max_data_size: u32,
476}
477
478#[repr(C)]
479#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
480/// Expected response structure
481pub struct ExpRespData {
482    /// Expected response type (0 = positive, 1 = negative)
483    pub response_type: u32,
484    /// ID assigned by application to be returned
485    pub acceptance_id: u32,
486    /// Number of bytes in [ExpRespData::p_mask_data] and [ExpRespData::p_pattern_data]
487    pub num_mask_pattern_bytes: u32,
488    /// Pointer to mask data
489    pub p_mask_data: *mut u8,
490    /// Pointer to pattern data
491    pub p_pattern_data: *mut u8,
492    /// Number of items in [ExpRespData::p_unique_resp_ids]
493    pub num_unique_resp_ids: u32,
494    /// Array containing unique response IDs
495    pub p_unique_resp_ids: *mut u32,
496}
497
498#[repr(C)]
499#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
500/// ComParam byte field data
501pub struct ParamByteFieldData {
502    /// Maximum number of bytes the [ParamByteFieldData::p_data_array] can contain
503    pub param_max_len: u32,
504    /// Current (actual) number of bytes in [ParamByteFieldData::p_data_array]
505    pub param_act_len: u32,
506    /// Pointer to data array
507    pub p_data_array: *mut u8,
508}
509
510#[repr(C)]
511#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
512/// ComParam struct field data
513pub struct ParamStructFieldData {
514    /// Struct type
515    pub com_param_struct_type: PduCpst,
516    /// Maximum number of structures the [ParamStructFieldData::p_struct_array] can contain
517    pub param_max_entries: u32,
518    /// Current (actual) number of structures in [ParamStructFieldData::p_struct_array]
519    pub param_act_entries: u32,
520    /// Pointer to structure array (See [ParamStructSessionTiming] and [ParamStructAccessTiming])
521    pub p_struct_array: *mut c_void,
522}
523
524#[repr(C)]
525#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
526#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
527/// Session timing for [ParamStructFieldData] when [ParamStructFieldData::com_param_struct_type] is [PduCpst::SessionTiming]
528pub struct ParamStructSessionTiming {
529    /// Session ID
530    #[cfg_attr(feature = "serde", serde(alias = "SessionNumber"))]
531    pub session: u16,
532
533    /// 1ms resolution
534    #[cfg_attr(feature = "serde", serde(alias = "P2Max_High"))]
535    pub p2_max_high: u8,
536
537    /// 1ms resolution
538    #[cfg_attr(feature = "serde", serde(alias = "P2Max_Low"))]
539    pub p2_max_low: u8,
540
541    /// 10ms resolution
542    #[cfg_attr(feature = "serde", serde(alias = "P2Star_High"))]
543    pub p2_star_high: u8,
544
545    /// 10ms resolution
546    #[cfg_attr(feature = "serde", serde(alias = "P2Star_Low"))]
547    pub p2_star_low: u8,
548}
549
550#[repr(C)]
551#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
552#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
553/// Access timing for [ParamStructFieldData] when [ParamStructFieldData::com_param_struct_type] is [PduCpst::AccessTiming]
554pub struct ParamStructAccessTiming {
555    /// 0.5ms resolution - Minimum time between tester request and ECU response
556    #[cfg_attr(feature = "serde", serde(alias = "P2Min"))]
557    pub p2_min: u8,
558
559    /// 0.5ms resolution - Maximum time between tester request and ECU response
560    #[cfg_attr(feature = "serde", serde(alias = "P2Max"))]
561    pub p2_max: u8,
562
563    /// 250ms resolution - Minimum time between ECU response and start of new tester request
564    #[cfg_attr(feature = "serde", serde(alias = "P3Min"))]
565    pub p3_min: u8,
566
567    /// 250ms resolution - Maximum time between ECU response and start of new tester request
568    #[cfg_attr(feature = "serde", serde(alias = "P3Max"))]
569    pub p3_max: u8,
570
571    /// 0.5ms resolution - Minimum inter-byte time for tester request
572    #[cfg_attr(feature = "serde", serde(alias = "P4Min"))]
573    pub p4_min: u8,
574
575    /// Timing set type
576    #[cfg_attr(feature = "serde", serde(alias = "TimingSet"))]
577    pub timing_set: TimingSet,
578}
579
580#[repr(C)]
581#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
582/// Long field data
583pub struct ParamLongFieldData {
584    /// Maximum number of entries the [ParamLongFieldData::p_data_array] can contain
585    pub param_max_len: u32,
586    /// Current (actual) number of entries in [ParamLongFieldData::p_data_array]
587    pub param_act_len: u32,
588    /// Pointer to data array
589    pub p_data_array: *mut u32,
590}
dpdu_api_types/structures.rs

dpdu_api_types/
structures.rs
