5.9.2 Tables functions

Describes the following functions:

table_getList()

Gets the static meta information of all tables exposed by an instance. This information can be used to retrieve the actual volatile data and render this data in a client in a suitable form.

Arguments

instId

Type: NumberU64

Opaque number uniquely identifying the target instance.

Return value

TableInfo[]

List of tables that are exposed by this instance. The client must honor the order of this list when displaying a list of tables. See TableInfo.

Errors

  • E_unknown_instance_id.

table_read()

Reads data from a table in order to display it to the user. The semantics are peek rather than bus read. This must be as free of side effects as possible.

Arguments

count

Type: NumberU64

Optional. Number of records to read, starting at index. Default is 1. The index index+count-1 must be in the range minIndex to maxIndex, else E_index_out_of_range is returned.

index

Type: NumberU64

The row number from which to start reading. This must be in the range minIndex to maxIndex, else E_index_out_of_range is returned.

instId

Type: NumberU64

Opaque number uniquely identifying the target instance.

tableId

Type: NumberU64

Opaque table id of the table to read from.

Return value

TableReadResult

List of table records that were read from the table. This is an array even if only one record was read. The size of the array is always the same as count. See TableReadResult.

Errors

  • E_unknown_instance_id.
  • E_unknown_table_id.
  • E_index_out_of_range.

table_write()

Writes individual fields in individual table records. The semantics are poke rather than bus write. This must be as free of side effects as possible while keeping all simulation state consistent.

Arguments

instId

Type: NumberU64

Opaque number uniquely identifying the target instance.

records

Type: TableRecord[]

List of table records to be written. This is an array even if only one record is written. The size of the array determines how many records are written. It is valid to specify a subset of the values of a record to write a subset of table cells, potentially only one.

tableId

Type: NumberU64

Opaque table id of the table to write to.

Return value

TableWriteResult

An object that contains errors, if any occurred when writing cells. See TableWriteResult.

Errors

  • E_unknown_instance_id.
  • E_unknown_table_id.
  • E_index_out_of_range.
Non-ConfidentialPDF file icon PDF version101196_0100_03_en
Copyright © 2018, 2019 Arm Limited or its affiliates. All rights reserved.