Functions by API

Total functions: 61

Application Callbacks

Function Description
CDX_app_can_rx_handle(CDX_CAN_FRAME const *frame) Process one received CAN/FD frame before the next model step.
CDX_app_model_init(void) Initialize the model before the runtime publishes READY.
CDX_app_model_period_us_get(void) Return the fixed execution period after application system setup.
CDX_app_model_step(void) Execute one due model step after queued RX callbacks.
CDX_app_system_init(void) Initialize application resources once during CM4 startup.

cdx_cal.h

Function Description
CDX_calibration_data_get(uint32_t *size) Obtain the active shared calibration data without copying defaults.

CDX Model CAN API

Function Description
CDX_can_frame_flags_is_ext(CDX_CAN_FRAME_FLAGS flags) Test for a classic extended-ID frame.
CDX_can_frame_flags_is_fd_ext(CDX_CAN_FRAME_FLAGS flags) Test for a CAN-FD extended-ID frame.
CDX_can_frame_flags_is_fd_std(CDX_CAN_FRAME_FLAGS flags) Test for a CAN-FD standard-ID frame.
CDX_can_frame_flags_is_std(CDX_CAN_FRAME_FLAGS flags) Test for a classic standard-ID frame.
CDX_can_is_timed_out_ms(CDX_MILLISEC_32 received_ms, CDX_MILLISEC_32 timeout_ms) Test elapsed local milliseconds using unsigned wrap-safe subtraction.
CDX_can_read_signal_u32_be(void const *buffer, uint32_t size, uint16_t offset, uint8_t bits) Read an unsigned, big-endian signal of up to 32 bits.
CDX_can_read_signal_u32_le(void const *buffer, uint32_t size, uint16_t offset, uint8_t bits) Read an unsigned, little-endian signal of up to 32 bits.
CDX_can_read_signal_u64_be(void const *buffer, uint32_t size, uint16_t offset, uint8_t bits) Read an unsigned, big-endian signal of up to 64 bits.
CDX_can_read_signal_u64_le(void const *buffer, uint32_t size, uint16_t offset, uint8_t bits) Read an unsigned, little-endian signal of up to 64 bits.
CDX_can_tx_enqueue_copy(CDX_CAN_BUS_ID bus, CDX_CAN_TX_PARAMS const *params, CDX_DATA_64 const *data) Copy a TX request and payload into the nonblocking Model IPC queue.

CDX DBC Signal Copying

Function Description
CDX_dbc_copy_u32_be(void *dst, uint32_t dst_size, void const *src, uint32_t src_size, uint16_t offset, uint8_t bits) Copy a big-endian signal of up to 32 bits.
CDX_dbc_copy_u32_le(void *dst, uint32_t dst_size, void const *src, uint32_t src_size, uint16_t offset, uint8_t bits) Copy a little-endian signal of up to 32 bits.
CDX_dbc_copy_u64_be(void *dst, uint32_t dst_size, void const *src, uint32_t src_size, uint16_t offset, uint8_t bits) Copy a big-endian signal of up to 64 bits.
CDX_dbc_copy_u64_le(void *dst, uint32_t dst_size, void const *src, uint32_t src_size, uint16_t offset, uint8_t bits) Copy a little-endian signal of up to 64 bits.

CDX DBC Signal Packing

Function Description
CDX_dbc_pack_u32_be(void *buffer, uint32_t size, uint16_t offset, uint8_t bits, uint32_t value) Pack an unsigned, big-endian signal of up to 32 bits.
CDX_dbc_pack_u32_le(void *buffer, uint32_t size, uint16_t offset, uint8_t bits, uint32_t value) Pack an unsigned, little-endian signal of up to 32 bits.
CDX_dbc_pack_u64_be(void *buffer, uint32_t size, uint16_t offset, uint8_t bits, uint64_t value) Pack an unsigned, big-endian signal of up to 64 bits.
CDX_dbc_pack_u64_le(void *buffer, uint32_t size, uint16_t offset, uint8_t bits, uint64_t value) Pack an unsigned, little-endian signal of up to 64 bits.

CDX DBC Signal Unpacking

Function Description
CDX_dbc_unpack_u32_be(void const *buffer, uint32_t size, uint16_t offset, uint8_t bits) Read an unsigned, big-endian signal of up to 32 bits.
CDX_dbc_unpack_u32_le(void const *buffer, uint32_t size, uint16_t offset, uint8_t bits) Read an unsigned, little-endian signal of up to 32 bits.
CDX_dbc_unpack_u64_be(void const *buffer, uint32_t size, uint16_t offset, uint8_t bits) Read an unsigned, big-endian signal of up to 64 bits.
CDX_dbc_unpack_u64_le(void const *buffer, uint32_t size, uint16_t offset, uint8_t bits) Read an unsigned, little-endian signal of up to 64 bits.

cdx_fast_io.h

Function Description
CDX_adc_snapshot_read(CDX_ADC_SNAPSHOT *snapshot) Copy a consistent external ADC scan without waiting for the Dash loop.
CDX_can_tx_urgent_enqueue(uint32_t port, CDX_CAN_TX_PARAMS const *params, CDX_DATA_64 const *data, uint32_t lifetime_us) Copy an urgent physical CAN frame, bypassing Dash Output processing.
CDX_model_inputs_refresh(uint32_t now_us, uint32_t max_stale_us) Refresh the input cache with one bounded snapshot read.

CDX Model Memory Access

Function Description
CDX_memory_read(uint32_t address, uint8_t extension, uint32_t size, void *data) Copy bytes from one registered region to caller-owned storage.
CDX_memory_read_u16(uint32_t address) Read a 16-bit scalar through address extension zero.
CDX_memory_read_u32(uint32_t address) Read a 32-bit scalar through address extension zero.
CDX_memory_read_u64(uint32_t address) Read a 64-bit scalar through address extension zero.
CDX_memory_read_u8(uint32_t address) Read an 8-bit scalar through address extension zero.
CDX_memory_region_register(uint32_t address, void *data, uint32_t size, int writable) Register a non-overlapping model memory region during initialization.
CDX_memory_write(uint32_t address, uint8_t extension, uint32_t size, void const *data) Copy bytes into one registered, writable model region.
CDX_memory_write_u16(uint32_t address, uint16_t value) Write a 16-bit scalar through address extension zero.
CDX_memory_write_u32(uint32_t address, uint32_t value) Write a 32-bit scalar through address extension zero.
CDX_memory_write_u64(uint32_t address, uint64_t value) Write a 64-bit scalar through address extension zero.
CDX_memory_write_u8(uint32_t address, uint8_t value) Write an 8-bit scalar through address extension zero.

CDX Runtime Time

Function Description
CDX_microsec_32_now(void) Read the local microsecond counter modulo 2^32.
CDX_microsec_64_now(void) Read local microseconds with foreground-maintained wrap extension.
CDX_microsec_deadline_remain(CDX_MICROSEC_32 deadline) Calculate microseconds remaining to a local absolute deadline.
CDX_millisec_32_from_ticks(CDX_TICKS_32 ticks) Convert a recent past microsecond timestamp to local milliseconds.
CDX_millisec_32_now(void) Read local milliseconds modulo 2^32.
CDX_ticks_deadline_from_millisec(CDX_MILLISEC_32 interval_ms) Form a nonzero CAN deadline relative to the current local ticks.
CDX_ticks_now(void) Read the current wrapping microsecond tick counter.

CDX Numeric Utilities

Function Description
CDX_byteswap16(uint16_t value) Reverse the byte order of a 16-bit integer.
CDX_byteswap32(uint32_t value) Reverse the byte order of a 32-bit integer.
CDX_byteswap64(uint64_t value) Reverse the byte order of a 64-bit integer.
CDX_f32_rounds_to_zero(float value) Test whether rounding to the nearest integer gives zero.
CDX_reinterpret_cast_f32(uint32_t value) Interpret an unsigned 32-bit integer as IEEE-754 binary32 bits.
CDX_reinterpret_cast_f64(uint64_t value) Interpret an unsigned 64-bit integer as IEEE-754 binary64 bits.
CDX_reinterpret_cast_u32(float value) Return the IEEE-754 binary32 representation of a float.
CDX_reinterpret_cast_u64(double value) Return the IEEE-754 binary64 representation of a double.
CDX_sign_extend_u16(uint8_t bits, uint16_t value) Sign-extend a raw signal to a 16-bit signed integer.
CDX_sign_extend_u32(uint8_t bits, uint32_t value) Sign-extend a raw signal to a 32-bit signed integer.
CDX_sign_extend_u64(uint8_t bits, uint64_t value) Sign-extend a raw signal to a 64-bit signed integer.
CDX_sign_extend_u8(uint8_t bits, uint8_t value) Sign-extend a raw signal to an 8-bit signed integer.