5.9.3 Tables objects

Describes the following objects:

TableCellError

TableCellError members:

errorCode

Type: NumberS64

Numeric E_* error code.

index

Type: NumberU64

Index in table (row number).

name

Type: String

Column name (field name) as in TableColumnInfo.

TableColumnInfo

TableColumnInfo members:

description

Type: String

Description of the record field, describing the semantics of the record fields in free form. Can contain linefeeds.

format

Type: String

Optional. Iris-text-format. The value of a cell is referred to by the value variable in the Iris-text-format string. The values of other cells are referred to by their column title, and the values of resources in the same instance are referred to by their resource name optionally prefixed by a resource group name and a dot.

formatLong

Type: String

Optional. Iris-text-format specification when displaying the value in textual form. Can contain multiple lines and must be self-descriptive. This is intended to be displayed for example in bubble help when hovering over a table cell. Must be present iff formatShort is present.

formatShort

Type: String

Optional. Iris-text-format specification when displaying the value in textual form. Ignored for type String. Must only be a single line and must be short. This is intended to be displayed in a table cell. Values are referred to by their column name. The index can be referred to by the index variable in the Iris-text-format string.

name

Type: String

Column title and record field name. This must be a short capitalized string uniquely identifying the column in the table.

rwMode

Type: String

Optional. Either "r" or "rw" for read-only or read-write (default). Clients must not try to write to read-only locations. Components must silently ignore writes to read-only locations.

bitWidth

Type: NumberU64

The interpretation of bitWidth depends on the value of type:

NumberU64, NumberS64
Size of the value in bits. The actual value is always zero-extended or sign-extended to 64 bits. This is the number of bits that are relevant to the user.
NumberU64[]
Size of the value in bits. The encoding is the same as for resources. The least significant bit is in bit[0] of the first NumberU64, the following NumberU64 values contain the more significant bits (little-endian encoding with 64-bit quantities).
Boolean
bitWidth must be 1.
String
bitWidth must be 0 and must be ignored by clients.
type

Type: String

Value type of this record field (of the table cells in this column). Must be one of the following:

  • NumberU64.
  • NumberS64.
  • NumberU64[].
  • Boolean.
  • String.

TableInfo

TableInfo members:

columns

Type: TableColumnInfo[]

List of meta information for the columns in the table. This describes the fields in each record. The order in this list must be preserved by clients when displaying information.

description

Type: String

Description of the table, describing the semantics of the table in free form. Can contain linefeeds.

formatLong

Type: String

Optional. Global Iris-text-format. Long version of formatShort intended to be displayed in a bubble help when hovering over a table row. This must be specified iff formatShort is specified.

formatShort

Type: String

Optional. Global Iris-text-format. If present, clients must format the data of each row according to this format and must not (by default) show the individual columns. This short variant must be single line and is intended to be displayed in the table cells. Values are referred to by their column name. The index can be referred to by index.

If missing, the table is shown as specified in columns.

indexFormatHint

Type: String

Optional. Hint for clients on how to display the index of a record. If present this must be one of the following:

hide
Hide the numeric index of records. Display the first column as row index.
dec
Display the row index preferably in decimal (but allow the user to override this).
hex
Display the row index preferably in hexadecimal (but allow the user to override this). This is useful if the index represents an address-like entity. Default is "hex".
maxIndex

Type: NumberU64

Optional. Maximum row index (inclusive). If the number of records is not known statically this must be set to 264-1. It is valid to set this to very high numbers such as 264-1. Clients must not blindly try to retrieve all rows of a table. Default is 264-1.

minIndex

Type: NumberU64

Optional. Minimum row index (inclusive). This is usually 0. Default is 0.

name

Type: String

Name of the table. This must be a short string uniquely identifying the table in the instance.

tableId

Type: NumberU64

Opaque table id used to read and write table contents.

TableReadResult

TableReadResult members:

data

Type: TableRecord[]

The actual data read from the table.

error

Type: TableCellError[]

Optional. List of errors that occurred while reading one or more table cells. This only returns errors that happen because the callee is unable to read the table cell value of an existing table cell, for example architectural errors. This does not return errors caused by the caller doing something wrong, for example E_index_out_of_range. These errors are returned by table_read() instead. This array is either missing, in case of no such error, or non-empty, in case of errors.

TableRecord

TableRecord members:

index

Type: NumberU64

Index of this record.

row

Type: Map[String]Value

Object with key-value pairs as described in the corresponding TableColumnInfo objects.

TableWriteResult

TableWriteResult members:

error

Type: TableCellError[]

Optional. List of errors that occurred while writing one or more table cells. This only returns errors that happen because the callee is unable to write the table cell value of an existing table cell, for example architectural errors. This does not return errors caused by the caller doing something wrong, for example E_index_out_of_range. These errors are returned by resource_write() instead. This array is either missing, in case of no such error, or non-empty, in case of errors.

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