@@ -1473,7 +1473,7 @@ Further reading for other annotations:
14731473 }];
14741474}
14751475
1476- def CHERIOTMMIODeviceDocs : Documentation {
1476+ def CHERIoTMMIODeviceDocs : Documentation {
14771477 let Category = DocCatVariable;
14781478 let Content = [{
14791479Indicates that the global it refers to must be treated as a cross-compartment
@@ -1486,7 +1486,7 @@ qualifiers.
14861486of the MMIO-bound device. An example of this is ``"uart"``. The
14871487``"<permissions_encoding>"`` indicates the permissions of the capability
14881488resulting from the import. The permissions encoding is a string of variable
1489- length. The symbols allowed in the string are ``R``, ``W``, ``c`` and ``m ``,
1489+ length. The symbols allowed in the string are ``R``, ``W``, ``c``, ``m`` and ``g ``,
14901490whose meaning is explained in the table below.
14911491
14921492
@@ -1496,18 +1496,19 @@ whose meaning is explained in the table below.
14961496 "``R``","Load (Read)", "May be used to read.",""
14971497 "``W``","Store (Write)", "May be used to write.",""
14981498 "``c``","Load / Store Capability", "May be used to load or store capabilities as well as non-capability data.","``R`` or ``W``"
1499- "``m``","Load Mutable", "May be used to load capabilities with write permission.","``R``"
1499+ "``m``","Load Mutable", "May be used to load capabilities with write permission.","``R`` and ``c``"
1500+ "``g``","Load Global", " May be used to load capabilities with the global permission.","``R`` and ``c``"
15001501
15011502Examples of valid encodings are: ``"RWcm"`` (all permissions), ``"R"`` (read
15021503only), etc. Note that the order in which symbols appear is not relevant: for
15031504example, `"RWcm"` and `"mcWR"` are both valid and entail the same permissions.
15041505
1505- **Warning**: The ``<permissions_encoding>`` parameter is optional, and if no encoding is given ``"RWcm "`` is assumed.
1506+ **Warning**: The ``<permissions_encoding>`` parameter is optional, and if no encoding is given ``"RWcmg "`` is assumed.
15061507 }];
15071508}
15081509
15091510
1510- def CHERIOTSharedObjectDocs : Documentation {
1511+ def CHERIoTSharedObjectDocs : Documentation {
15111512 let Category = DocCatVariable;
15121513 let Content = [{
15131514Indicates that the global it refers to must be treated as a cross-compartment
@@ -1521,7 +1522,7 @@ cross-compartment shared object. The target global must have the `extern` and
15211522of the shared object. The ``"<permissions_encoding>"`` indicates the permissions
15221523of the capability resulting from the import. The permissions encoding is a
15231524string of variable length. The symbols allowed in the string are ``R``, ``W``,
1524- ``c`` and ``m ``, whose meaning is explained in the table below.
1525+ ``c``, ``m`` and ``g ``, whose meaning is explained in the table below.
15251526
15261527
15271528.. csv-table:: Supported Syntaxes
@@ -1530,13 +1531,14 @@ string of variable length. The symbols allowed in the string are ``R``, ``W``,
15301531 "``R``","Load (Read)", "May be used to read.",""
15311532 "``W``","Store (Write)", "May be used to write.",""
15321533 "``c``","Load / Store Capability", "May be used to load or store capabilities as well as non-capability data.","``R`` or ``W``"
1533- "``m``","Load Mutable", "May be used to load capabilities with write permission.","``R``"
1534+ "``m``","Load Mutable", "May be used to load capabilities with write permission.","``R`` and ``c``"
1535+ "``g``","Load Global", " May be used to load capabilities with the global permission.","``R`` and ``c``"
15341536
15351537Examples of valid encodings are: ``"RWcm"`` (all permissions), ``"R"`` (read
15361538only), etc. Note that the order in which symbols appear is not relevant: for
15371539example, `"RWcm"` and `"mcWR"` are both valid and entail the same permissions.
15381540
1539- **Warning**: The ``<permissions_encoding>`` parameter is optional, and if no encoding is given ``"RWcm "`` is assumed.
1541+ **Warning**: The ``<permissions_encoding>`` parameter is optional, and if no encoding is given ``"RWcmg "`` is assumed.
15401542 }];
15411543}
15421544
0 commit comments