The ReadWriteAccess is used to represent the Read and Write behavior of an access at the Field level.
It also has optional getter/setter parameters which can hold string representations of the explicit ASL for these behaviours.
Note that currently there is no way to validate that the provided getter/setter are logically aligned with the read/write.
It is considered architecturally invalid for them not to align so please ensure they do.
| Properties | Type | Description |
|---|---|---|
| _meta | Meta |
See
Meta
for more information.
|
| _type |
|
|
| getter |
|
Defines the explicit ASL logic to be executed when this field is read.
Default
|
| read | Enums.ReadAccess |
Defines the high-level read behavior of this access.
See
Enums.ReadAccess
for more information.
Default
|
| setter |
|
Defines the explicit ASL logic to be executed when this field is written.
Default
|
| write | Enums.WriteAccess |
Defines the high-level write behavior of this access.
See
Enums.WriteAccess
for more information.
Default
|
|
||
|
||
{
"title": "Field.ReadWriteAccess",
"info": [
"The ReadWriteAccess is used to represent the Read and Write behavior of an access at the Field level.",
"It also has optional getter/setter parameters which can hold string representations of the explicit ASL for these behaviours.",
"Note that currently there is no way to validate that the provided getter/setter are logically aligned with the read/write. ",
"It is considered architecturally invalid for them not to align so please ensure they do."
],
"oneOf": [
{
"enum": [
"RW",
"RO",
"WO/RAZ",
"RAZ/WI",
"WO/RAO",
"RAO/WI",
"WO/RES0",
"RES0/WI",
"RES0",
"WO/RES1",
"RES1/WI",
"RES1",
"WO/UNKNOWN",
"UNKNOWN/WI",
"IGNORE",
"W1S",
"W1C",
"W1T",
"W0S",
"W0C",
"W0T",
"WS",
"WC",
"RAZ/W1S",
"RAZ/W1C",
"RAZ/W1T",
"RAZ/SBZ",
"RAZ/SBZP",
"RAO/W1S",
"RAO/W1C",
"RAO/W1T",
"RAO/SBO",
"RAO/SBOP",
"UNKNOWN/SBZ",
"UNKNOWN/SBO",
"UNKNOWN/SBZP",
"UNKNOWN/SBOP",
"SBZ",
"SBO",
"RC/W",
"RC/WI",
"RS/W",
"RS/WI",
"RC/WS",
"RS/WC",
"RC/W1S",
"RS/W1C",
"RC/W0S",
"RS/W0C",
"ERROR/W",
"ERROR/W0C",
"ERROR/W0S"
]
},
{
"additionalProperties": false,
"properties": {
"_meta": {
"$ref": "../../../../Meta.json"
},
"_type": {
"enum": [
"Accessors.Permission.AccessTypes.Field.ReadWriteAccess"
]
},
"read": {
"info": [
"Defines the high-level read behavior of this access."
],
"default": "UNKNOWN",
"$ref": "../../../../Enums/ReadAccess.json"
},
"write": {
"info": [
"Defines the high-level write behavior of this access."
],
"default": "WI",
"$ref": "../../../../Enums/WriteAccess.json"
},
"getter": {
"info": [
"Defines the explicit ASL logic to be executed when this field is read."
],
"default": null,
"type": [
"string",
"null"
]
},
"setter": {
"info": [
"Defines the explicit ASL logic to be executed when this field is written."
],
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"$schema": "http://json-schema.org/draft-04/schema#"
}