[processor-sdk/pdk.git] / packages / ti / drv / sciclient / soc / sysfw / binaries / system-firmware-public-documentation / _sources / 2_tisci_msgs / rm / rm_proxy.rst.txt
1 ===================================================
2 Resource Management Proxy TISCI Message Description
3 ===================================================
5 Introduction
6 ============
8 This chapter provides information on usage of the RM Proxy management
9 TISCI message API parameters.
11 +------------------+-------------------------------------------------------------------------------+
12 | TISCI Message ID | Message Name |
13 +==================+===============================================================================+
14 | 0x1300 | :ref:`TISCI_MSG_RM_PROXY_CFG <pub_rm_public_proxy_cfg>` |
15 +------------------+-------------------------------------------------------------------------------+
16 | N/A | :ref:`TISCI_MSG_RM_PROXY_CFG Response <pub_rm_public_proxy_cfg_response>` |
17 +------------------+-------------------------------------------------------------------------------+
19 .. _pub_rm_public_proxy_valid_params:
21 Proxy Valid Parameters Field Usage
22 ----------------------------------
24 Some proxy TISCI message APIs make use of a valid_params bit field. Bits within
25 the valid_params field define whether or not individual TISCI message
26 parameters are valid. When a bit corresponding to a parameter is set (to 1)
27 the parameter is considered valid and will be programmed into its
28 corresponding register field, assuming validation of the parameter passes.
29 When a valid_params bit is not set, i.e. a value of 0, the corresponding
30 register field is read and used within the validation process of the request.
31 The register field for a parameter is not programmed if the corresponding
32 valid_params bit is not set.
34 TISCI_MSG_RM_PROXY_CFG - Proxy Configuration
35 ============================================
37 .. _pub_rm_public_proxy_cfg:
39 Proxy Configuration Request
40 ---------------------------
42 The **proxy_cfg** TISCI message API is used to configure the channelized
43 firewalls of a Navigator Subsystem proxy. The proxy index must be assigned to
44 the host defined in the TISCI header via the RM board configuration resource
45 assignment range list. The channelized firewalls covering the proxy error
46 events are configured to only give DMSC write access. The proxy target data
47 control region channelized firewalls are configured to give the assigned host
48 read and write access.
50 Usage
51 ^^^^^
53 +------------------------+--------+
54 | **Message Type** | Normal |
55 +------------------------+--------+
56 | **Secure Queue Only?** | No |
57 +------------------------+--------+
59 TISCI Message ID
60 ^^^^^^^^^^^^^^^^
62 .. sysfwapimacro:: TISCI_MSG_RM_PROXY_CFG
64 Proxy Configuration Message Parameters
65 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67 .. sysfwapistruct:: tisci_msg_rm_proxy_cfg_req
69 .. _pub_rm_public_proxy_cfg_response:
71 Proxy Configuration Response
72 ----------------------------
74 The **proxy_cfg_response** message returns the result status of the
75 processed **proxy_cfg** message.
77 Proxy Configuration Response Message Parameters
78 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
80 .. sysfwapistruct:: tisci_msg_rm_proxy_cfg_resp