Crate opencsd_sys

Expand description

Auto-generated Rust bindings to the C API of the OpenCSD library. OpenCSD is an open-source decoder for ARM CoreSight trace streams.

Re-exports§

pub use self::_ocsd_err_t as ocsd_err_t;
pub use self::_ocsd_err_severity_t as ocsd_err_severity_t;
pub use self::_ocsd_datapath_op_t as ocsd_datapath_op_t;
pub use self::_ocsd_datapath_resp_t as ocsd_datapath_resp_t;
pub use self::_rcdtl_rawframe_elem_t as ocsd_rawframe_elem_t;
pub use self::_ocsd_dcd_tree_src_t as ocsd_dcd_tree_src_t;
pub use self::_ocsd_arch_version as ocsd_arch_version_t;
pub use self::_ocsd_core_profile as ocsd_core_profile_t;
pub use self::_ocsd_isa as ocsd_isa;
pub use self::_ocsd_sec_level as ocsd_sec_level;
pub use self::_ocsd_ex_level as ocsd_ex_level;
pub use self::_ocsd_instr_type as ocsd_instr_type;
pub use self::_ocsd_instr_subtype as ocsd_instr_subtype;
pub use self::_ocsd_mem_space_acc_t as ocsd_mem_space_acc_t;
pub use self::_ocsd_trace_protocol_t as ocsd_trace_protocol_t;
pub use self::_ocsd_gen_trc_elem_t as ocsd_gen_trc_elem_t;
pub use self::_trace_on_reason_t as trace_on_reason_t;
pub use self::_unsync_info_t as unsync_info_t;
pub use self::_trace_sync_marker_t as trace_sync_marker_t;
pub use self::_memtrans_t as trace_memtrans_t;
pub use self::_event_t as event_t;
pub use self::_ocsd_pkt_va_size as ocsd_pkt_va_size;
pub use self::_ocsd_pkt_atm_type as ocsd_pkt_atm_type;
pub use self::_ocsd_atm_val as ocsd_atm_val;
pub use self::_ocsd_iSync_reason as ocsd_iSync_reason;
pub use self::_ocsd_armv7_exception as ocsd_armv7_exception;
pub use self::_ocsd_etmv3_pkt_type as ocsd_etmv3_pkt_type;
pub use self::_ocsd_etmv4_i_pkt_type as ocsd_etmv4_i_pkt_type;
pub use self::_ocsd_etmv4_d_pkt_type as ocsd_etmv4_d_pkt_type;
pub use self::_ocsd_ptm_pkt_type as ocsd_ptm_pkt_type;
pub use self::_ocsd_stm_pkt_type as ocsd_stm_pkt_type;
pub use self::_ocsd_stm_ts_type as ocsd_stm_ts_type;
pub use self::_hw_event_feat as hw_event_feat_t;
pub use self::_ocsd_c_api_cb_types as ocsd_c_api_cb_types;

Structs§

Constants§

Functions§

imaxabs^⚠
imaxdiv^⚠
ocsd_create_dcd_tree^⚠: Create a decode tree.
ocsd_cust_protocol_to_str^⚠: Get a string representation of a custom protocol packet.
ocsd_def_errlog_config_output^⚠: Configure the output logger. Choose STDOUT, STDERR and/or log to file. Optionally provide a log file name.
ocsd_def_errlog_init^⚠: Initialise the library error logger.
ocsd_def_errlog_msgout^⚠: Print a message via the library output printer - if enabled.
ocsd_def_errlog_set_strprint_cb^⚠: Configure the library default error logger to send all strings it is outputting back to the client to allow printing within the client application. This is in additional to any other log destinations set in ocsd_def_errlog_init().
ocsd_deregister_decoders^⚠: Clear all registered decoders - library cleanup
ocsd_destroy_dcd_tree^⚠: Destroy a decode tree.
ocsd_dt_add_binfile_mem_acc^⚠: Add a binary file based memory range accessor to the decode tree.
ocsd_dt_add_binfile_region_mem_acc^⚠: Add a binary file based memory range accessor to the decode tree.
ocsd_dt_add_buffer_mem_acc^⚠: Add a memory buffer based memory range accessor to the decode tree.
ocsd_dt_add_callback_mem_acc^⚠: Add a memory access callback function. The decoder will call the function for opcode addresses in the address range supplied for the memory spaces covered.
ocsd_dt_add_callback_trcid_mem_acc^⚠: Add a memory access callback function. The decoder will call the function for opcode addresses in the address range supplied for the memory spaces covered.
ocsd_dt_attach_packet_callback^⚠: Attach a callback function to the packet processor.
ocsd_dt_create_decoder^⚠: Creates a decoder that is registered with the library under the supplied name. Flags determine if a full packet processor / packet decoder pair or packet processor only is created. Uses the supplied configuration structure.
ocsd_dt_get_decode_stats^⚠: Get the stats block for the channel indicated. Caller must check p_stats_block->version to esure that the block is filled in a compatible manner.
ocsd_dt_process_data^⚠: Input trace data into the decoder.
ocsd_dt_remove_decoder^⚠: Remove a decoder from the tree and destroy it.
ocsd_dt_remove_mem_acc^⚠: Remove a memory accessor by address and memory space.
ocsd_dt_reset_decode_stats^⚠: Reset the stats block for the chosens decode channel. stats block is reset independently of the decoder reset to allow counts across multiple decode runs.
ocsd_dt_set_gen_elem_outfn^⚠: Set the trace element output callback function.
ocsd_dt_set_gen_elem_printer^⚠: Set a library printer on the generic element output of a full decoder.
ocsd_dt_set_mem_acc_cacheing^⚠
ocsd_dt_set_pkt_protocol_printer^⚠: Attach a library printer to the packet processor. May be attached to the main packet output, or the monitor output if the main packet output is to be attached to a packet decoder in the datapath.
ocsd_dt_set_raw_frame_printer^⚠: Set a raw frame printer on the trace frame demuxer. Allows inspection of raw trace data frames for debug. Prints via the library default error logging mechanisms.
ocsd_err_str^⚠: Convert an error code into a string.
ocsd_gen_elem_init^⚠: Init a generic element with type, clearing any flags etc.
ocsd_gen_elem_str^⚠: Get a string representation of the generic trace element.
ocsd_get_last_err^⚠: returns the last error logged by the system, with the related trace byte index, trace channel id, and any error message related string. If index or channel ID are not valid these will return OCSD_BAD_TRC_INDEX and OCSD_BAD_CS_SRC_ID.
ocsd_get_version^⚠: @name Library Version API
ocsd_get_version_str^⚠: Get library version string
ocsd_pkt_str^⚠: Take a packet structure and render a string representation of the packet data.
ocsd_register_custom_decoder^⚠: Register a custom decoder with the library
ocsd_tl_log_mapped_mem_ranges^⚠
strtoimax^⚠
strtoumax^⚠
wcstoimax^⚠
wcstoumax^⚠

Type Aliases§

FnDefLoggerPrintStrCB: function pointer tyee for library default logger output to allow client to print zero terminated output string
FnDefPktDataIn: function pointer type for packet processor packet output sink, packet analyser/decoder input - generic declaration
FnDefPktDataMon: function pointer type for packet processor packet monitor sink, raw packet monitor / display input - generic declaration
FnTraceElemIn: function pointer type for decoder outputs. all protocols, generic data element input
Fn_MemAccID_CB: Callback function definition for callback function memory accessor type.
Fn_MemAcc_CB: Callback function definition for callback function memory accessor type.
__blkcnt64_t
__blkcnt_t
__blksize_t
__caddr_t
__clock_t
__clockid_t
__daddr_t
__dev_t
__fsblkcnt64_t
__fsblkcnt_t
__fsfilcnt64_t
__fsfilcnt_t
__fsword_t
__gid_t
__gwchar_t
__id_t
__ino64_t
__ino_t
__int8_t
__int16_t
__int32_t
__int64_t
__int_least8_t
__int_least16_t
__int_least32_t
__int_least64_t
__intmax_t
__intptr_t
__key_t
__loff_t
__mode_t
__nlink_t
__off64_t
__off_t
__pid_t
__quad_t
__rlim64_t
__rlim_t
__sig_atomic_t
__socklen_t
__ssize_t
__suseconds64_t
__suseconds_t
__syscall_slong_t
__syscall_ulong_t
__time_t
__timer_t
__u_char
__u_int
__u_long
__u_quad_t
__u_short
__uid_t
__uint8_t
__uint16_t
__uint32_t
__uint64_t
__uint_least8_t
__uint_least16_t
__uint_least32_t
__uint_least64_t
__uintmax_t
__useconds_t
_event_t
_hw_event_feat: HW Event trace feature Defines if the STM supports or has enabled the HW event trace feature. This may not always be able to be determined by the registers, or the feature values can override if HW event trace is to be ignored.
_memtrans_t
_ocsd_arch_version: Core Architecture Version
_ocsd_armv7_exception
_ocsd_atm_val
_ocsd_c_api_cb_types: Callback interface type when attaching monitor/sink to packet processor
_ocsd_core_profile: Core Profile
_ocsd_datapath_op_t: Trace Datapath operations.
_ocsd_datapath_resp_t: Trace Datapath responses
_ocsd_dcd_tree_src_t: Indicates if the trace source will be frame formatted or a single protocol source. Used in decode tree creation and configuration code.
_ocsd_err_severity_t: Error Severity Type
_ocsd_err_t: Library Error return type
_ocsd_etmv3_pkt_type: @name ETMv3 Packet Types @{
_ocsd_etmv4_d_pkt_type
_ocsd_etmv4_i_pkt_type: I stream packets.
_ocsd_ex_level: Exception level type
_ocsd_gen_trc_elem_t: Enum for generic element types
_ocsd_iSync_reason: Isync Reason - common to PTM and ETMv3
_ocsd_instr_subtype: instruction sub types - addiitonal information passed to the output packets for trace analysis tools.
_ocsd_instr_type: instruction types - significant for waypoint calculations
_ocsd_isa: Instruction Set Architecture type
_ocsd_mem_space_acc_t: memory space bitfield enum for available security states and exception levels used when accessing memory.
_ocsd_pkt_atm_type
_ocsd_pkt_va_size: @name Common Packet Types @{
_ocsd_ptm_pkt_type: @name PTM Packet Types @{
_ocsd_sec_level: Security level type
_ocsd_stm_pkt_type: STM protocol packet types. Contains both protocol packet types and markers for unsynced processor state and bad packet sequences.
_ocsd_stm_ts_type: STM timestamp encoding type. Extracted from STM version packet. CS-STM supports Natural binary and grey encodings.
_ocsd_trace_protocol_t: Trace Protocol Builtin Types + extern
_rcdtl_rawframe_elem_t: Raw frame element data types Data blocks types output from ITrcRawFrameIn.
_trace_on_reason_t
_trace_sync_marker_t
_unsync_info_t
dcd_tree_handle_t: Handle to decode tree
etmv3_context_t
etmv3_data_t
etmv3_isync_t
etmv4_addr_val_t: a broadcast address value.
etmv4_context_t
etmv4_trace_info_t
fnCreateCustomDecoder: Function to create a decoder instance
fnDecodeArmInstCB: callback function to connect an ARM instruction decoder Implements IInstrDecode::DecodeInstruction with addition of library context pointer.
fnDestroyCustomDecoder: Function to destroy a decoder instance indicated by decoder handle.
fnGenElemOpCB: callback function to connect into the generic element output point Implements ITrcGenElemIn::TraceElemIn with addition of library context pointer.
fnGetCSIDFromConfig: Function to extract the CoreSight Trace ID from the configuration structure.
fnLogErrorCB: callback functions to connect into the library error logging mechanism Implements ITraceErrorLog::LogError with addition of library context pointer.
fnLogMsgCB: callback functions to connect into the library error logging mechanism Implements ITraceErrorLog::LogMessage with addition of library context pointer.
fnMemAccessCB: callback function to connect the memory accessor interface Implements ITargetMemAccess::ReadTargetMemory with addition of library context pointer.
fnPacketToString: Function to convert a protocol specific trace packet to human readable string
fnPktDataSinkCB: callback function to connect to the packet sink interface, on the main decode data path - use if decoder created as packet processor only
fnPktMonCB: callback function to connect to the packet monitor interface of the packet processor Implements IPktRawDataMon::RawPacketDataMon with addition of library context pointer.
fnTraceDataIn: Raw trace data input function - a decoder must have one of these Implements ITrcDataIn with the addition of a decoder handle to provide context in the decoder.
fnUpdatePktMonFlags: Function to update the in-use flags for the packet sinks
int_fast8_t
int_fast16_t
int_fast32_t
int_fast64_t
int_least8_t
int_least16_t
int_least32_t
int_least64_t
intmax_t
ocsd_arch_profile_t: Combined architecture and profile descriptor for a core
ocsd_decode_stats_t: @name Decode statistics
ocsd_demux_stats_t: @name Demux Statistics
ocsd_ete_cfg: @name ETE config Types @{
ocsd_etmv3_cfg
ocsd_etmv3_excep
ocsd_etmv3_pkt
ocsd_etmv4_cfg
ocsd_etmv4_d_pkt
ocsd_etmv4_i_pkt
ocsd_extern_dcd_cb_fns: an instance of this is owned by the decoder, filled in by the library - allows the CB fns in the library decode tree to be called.
ocsd_extern_dcd_fact_t: set of functions and callbacks to create an extern custom decoder in the library via the C API interface. This structure is registered with the library by name and then decoders of the type can be created on the decode tree.
ocsd_extern_dcd_inst_t: Owned by the library instance object, this structure is filled in by the ocsd_extern_dcd_fact_t createDecoder() function.
ocsd_file_mem_region_t: memory region type for adding multi-region binary files to memory access interface
ocsd_generic_trace_elem
ocsd_hndl_err_log_t
ocsd_hndl_rdr_t
ocsd_instr_info: Instruction decode request structure.
ocsd_pe_context: Core(PE) context structure records current security state, exception level, VMID and ContextID for core.
ocsd_pkt_atom
ocsd_pkt_byte_sz_val
ocsd_pkt_vaddr
ocsd_ptm_cfg
ocsd_ptm_excep
ocsd_ptm_pkt
ocsd_stm_cfg: STM hardware configuration. Contains hardware register values at time of trace capture and HW event feature field to enable and control decode of STM trace stream.
ocsd_stm_pkt: STM trace packet
ocsd_swt_info_t: @name Software Trace Packets Info
ocsd_trc_index_t
ocsd_vaddr_t
ptm_context_t
trace_event_t
trace_marker_payload_t
trace_sw_ite_t
uint_fast8_t
uint_fast16_t
uint_fast32_t
uint_fast64_t
uint_least8_t
uint_least16_t
uint_least32_t
uint_least64_t
uintmax_t
wchar_t

Unions§

Crate opencsd_sysCopy item path

Re-exports§

Structs§

Constants§

Functions§

Type Aliases§

Unions§

Crate opencsd_sys