isys::SAccessBatchItem Struct Reference

Description

This class holds Access Batch Item results (including data).

#include <CSessionCtrl.h>

Public Attributes
std::vector< uint8_t >	access_info
	Buffer containing access info, where each byte indicates single MAU access success.
std::vector< uint8_t >	data
	Data buffer containing read data.
uint32_t	poll_duration_us = 0
	Duration of poll operation in microseconds.
uint64_t	time_us = 0
	Timestamp of item in microseconds from start of access batch.

Member Data Documentation

access_info

std::vector<uint8_t> isys::SAccessBatchItem::access_info

Buffer containing access info, where each byte indicates single MAU access success.

Applicable for read, write and poll type operations.

Python example (test_soc_ctrl_bus_access_batch.py):

    item = access_batch.item(handle_read)                               # Retrieve item by handle
    for access_info_index in range(len(item.access_info)):              # Print for each MAU if access failed or not
        if item.access_info[access_info_index] == ic.ACCESS_FAIL:
            print(f'Access to MAU at index {access_info_index} failed')
        else:
            print(f'Access to MAU at index {access_info_index} OK')

data

std::vector<uint8_t> isys::SAccessBatchItem::data

Data buffer containing read data.

Applicable only for read type operations.

Python example (test_soc_ctrl_bus_access_batch.py):

    item = access_batch.item(handle_read) # Retrieve item by handle
    data_str = '0x'                       # Construct string containing all data bytes
    for data_byte in item.data:
        data_str += f'{data_byte:02X}'
    print('Data: ' + data_str)            # Print data in human-readable format

poll_duration_us

uint32_t isys::SAccessBatchItem::poll_duration_us = 0

Duration of poll operation in microseconds.

Applicable only for poll operation.

Python example (test_soc_ctrl_bus_access_batch.py):

    item = access_batch.item(handle_poll)                   # Retrieve item by handle
    print('Poll duration: ' + str(item.poll_duration_us))   # Print out poll item duration in us

time_us

uint64_t isys::SAccessBatchItem::time_us = 0

Timestamp of item in microseconds from start of access batch.

Applicable for all item types.

Python example (test_soc_ctrl_bus_access_batch.py):

    item = access_batch.item(handle_write) # Retrieve item by handle
    print('Time: ' + str(item.time_us))    # Print out item timestamp in us