[processor-sdk/pdk.git] / packages / ti / drv / sciclient / soc / sysfw / binaries / system-firmware-public-documentation / _sources / 2_tisci_msgs / rm / rm_udmap.rst.txt
1 ===================================================
2 Resource Management UDMAP TISCI Message Description
3 ===================================================
5 Introduction
6 ============
8 This chapter provides information on usage of the RM UDMAP management TISCI
9 message API parameters.
11 +------------------+---------------------------------------------------------------------------------------------------------------------+
12 | TISCI Message ID | Message Name |
13 +==================+=====================================================================================================================+
14 | 0x1200 | RESERVED, DO NOT (RE)USE |
15 +------------------+---------------------------------------------------------------------------------------------------------------------+
16 | 0x1201 | RESERVED, DO NOT (RE)USE |
17 +------------------+---------------------------------------------------------------------------------------------------------------------+
18 | 0x1210 | RESERVED, DO NOT (RE)USE |
19 +------------------+---------------------------------------------------------------------------------------------------------------------+
20 | 0x1211 | RESERVED, DO NOT (RE)USE |
21 +------------------+---------------------------------------------------------------------------------------------------------------------+
22 | 0x1220 | RESERVED, DO NOT (RE)USE |
23 +------------------+---------------------------------------------------------------------------------------------------------------------+
24 | 0x1221 | RESERVED, DO NOT (RE)USE |
25 +------------------+---------------------------------------------------------------------------------------------------------------------+
26 | 0x1205 | :ref:`TISCI_MSG_RM_UDMAP_TX_CH_CFG <pub_rm_public_udmap_tx_ch_cfg>` |
27 +------------------+---------------------------------------------------------------------------------------------------------------------+
28 | N/A | :ref:`TISCI_MSG_RM_UDMAP_TX_CH_CFG Response <pub_rm_public_udmap_tx_ch_cfg_response>` |
29 +------------------+---------------------------------------------------------------------------------------------------------------------+
30 | 0x1206 | RESERVED, DO NOT (RE)USE |
31 +------------------+---------------------------------------------------------------------------------------------------------------------+
32 | 0x1215 | :ref:`TISCI_MSG_RM_UDMAP_RX_CH_CFG <pub_rm_public_udmap_rx_ch_cfg>` |
33 +------------------+---------------------------------------------------------------------------------------------------------------------+
34 | N/A | :ref:`TISCI_MSG_RM_UDMAP_RX_CH_CFG Response <pub_rm_public_udmap_rx_ch_cfg_response>` |
35 +------------------+---------------------------------------------------------------------------------------------------------------------+
36 | 0x1216 | RESERVED, DO NOT (RE)USE |
37 +------------------+---------------------------------------------------------------------------------------------------------------------+
38 | 0x1230 | :ref:`TISCI_MSG_RM_UDMAP_FLOW_CFG <pub_rm_public_udmap_flow_cfg>` |
39 +------------------+---------------------------------------------------------------------------------------------------------------------+
40 | N/A | :ref:`TISCI_MSG_RM_UDMAP_FLOW_CFG Response <pub_rm_public_udmap_flow_cfg_response>` |
41 +------------------+---------------------------------------------------------------------------------------------------------------------+
42 | 0x1231 | :ref:`TISCI_MSG_RM_UDMAP_FLOW_SIZE_THRESH_CFG <pub_rm_public_udmap_flow_size_thresh_cfg>` |
43 +------------------+---------------------------------------------------------------------------------------------------------------------+
44 | N/A | :ref:`TISCI_MSG_RM_UDMAP_FLOW_SIZE_THRESH_CFG Response <pub_rm_public_udmap_flow_size_thresh_cfg_response>` |
45 +------------------+---------------------------------------------------------------------------------------------------------------------+
46 | 0x1232 | RESERVED, DO NOT (RE)USE |
47 +------------------+---------------------------------------------------------------------------------------------------------------------+
48 | 0x1233 | RESERVED, DO NOT (RE)USE |
49 +------------------+---------------------------------------------------------------------------------------------------------------------+
50 | 0x1234 | :ref:`TISCI_MSG_RM_UDMAP_FLOW_DELEGATE <pub_rm_public_udmap_flow_delegate>` |
51 +------------------+---------------------------------------------------------------------------------------------------------------------+
52 | N/A | :ref:`TISCI_MSG_RM_UDMAP_FLOW_DELEGATE Response <pub_rm_public_udmap_flow_delegate_response>` |
53 +------------------+---------------------------------------------------------------------------------------------------------------------+
54 | 0x1240 | :ref:`TISCI_MSG_RM_UDMAP_GCFG_CFG <pub_rm_public_udmap_gcfg_cfg>` |
55 +------------------+---------------------------------------------------------------------------------------------------------------------+
56 | N/A | :ref:`TISCI_MSG_RM_UDMAP_GCFG_CFG Response <pub_rm_public_udmap_gcfg_cfg_response>` |
57 +------------------+---------------------------------------------------------------------------------------------------------------------+
58 | 0x1241 | RESERVED, DO NOT (RE)USE |
59 +------------------+---------------------------------------------------------------------------------------------------------------------+
61 .. _pub_rm_public_udmap_valid_params:
63 UDMAP Valid Parameters Field Usage
64 ----------------------------------
66 Some UDMAP TISCI message APIs make use of a valid_params bit field. Bits within
67 the valid_params field define whether or not individual TISCI message
68 parameters are valid. When a bit corresponding to a parameter is set (to 1)
69 the parameter is considered valid and will be programmed into its
70 corresponding register field, assuming validation of the parameter passes.
71 When a valid_params bit is not set, i.e. a value of 0, the corresponding
72 register field is read and used within the validation process of the request.
73 The register field for a parameter is not programmed if the corresponding
74 valid_params bit is not set.
76 TISCI_MSG_RM_UDMAP_TX_CH_CFG - UDMAP Transmit Channel Configure
77 ===============================================================
79 .. _pub_rm_public_udmap_tx_ch_cfg:
81 UDMAP Transmit Channel Configure Request
82 ----------------------------------------
84 The **UDMAP tx channel cfg** TISCI message API is used to configure SoC
85 Navigator Subsystem UDMAP transmit channels. The API only allows
86 configuration of a transmit channel by passing the tx channel index and the
87 Navigator SoC device ID in which the channel is located. Only the non-real-time
88 transmit channel registers are programmed as part of the channel configuration.
89 The host is granted access to the transmit channel real-time registers via the
90 SoC channelized firewalls based on the RM board configuration. The OS can
91 access the channel real-time registers directly after transmit channel
92 configuration is complete.
94 The UDMAP global invalid receive flow event and per transmit channel output
95 event (OES) and error output event (EOES) registers are not programmed as part
96 of the **UDMAP tx channel cfg** API. They're programmed internally via the
97 :ref:`RM IRQ Set <pub_rm_irq_route_set>` message.
99 The **UDMAP tx channel cfg** API can be used to configure transmit channels
100 within any Navigator Subsystem UDMAP on the device.
102 Usage
103 ^^^^^
105 +------------------------+--------+
106 | **Message Type** | Normal |
107 +------------------------+--------+
108 | **Secure Queue Only?** | No |
109 +------------------------+--------+
111 TISCI Message ID
112 ^^^^^^^^^^^^^^^^
114 .. sysfwapimacro:: TISCI_MSG_RM_UDMAP_TX_CH_CFG
116 UDMAP Transmit Channel Configure Message Parameters
117 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
119 .. sysfwapistruct:: tisci_msg_rm_udmap_tx_ch_cfg_req
121 .. _pub_rm_public_udmap_tx_ch_cfg_valid_params:
123 UDMAP Transmit Channel Configuration Valid Parameters
124 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
126 The following table describes the valid bit mappings for the UDMAP transmit
127 channel configure message optional parameters:
129 +------------------+-------------------------------------------------------------------+
130 | valid_params Bit | Corresponding tisci_msg_rm_udmap_tx_ch_cfg_req Optional Parameter |
131 +==================+===================================================================+
132 | 0 | tx_pause_on_err |
133 +------------------+-------------------------------------------------------------------+
134 | 1 | tx_atype |
135 +------------------+-------------------------------------------------------------------+
136 | 2 | tx_chan_type |
137 +------------------+-------------------------------------------------------------------+
138 | 3 | tx_fetch_size |
139 +------------------+-------------------------------------------------------------------+
140 | 4 | txcq_qnum |
141 +------------------+-------------------------------------------------------------------+
142 | 5 | tx_priority |
143 +------------------+-------------------------------------------------------------------+
144 | 6 | tx_qos |
145 +------------------+-------------------------------------------------------------------+
146 | 7 | tx_orderid |
147 +------------------+-------------------------------------------------------------------+
148 | 8 | tx_sched_priority |
149 +------------------+-------------------------------------------------------------------+
150 | 9 | tx_filt_einfo |
151 +------------------+-------------------------------------------------------------------+
152 | 10 | tx_filt_pswords |
153 +------------------+-------------------------------------------------------------------+
154 | 11 | tx_supr_tdpkt |
155 +------------------+-------------------------------------------------------------------+
156 | 12 | tx_credit_count |
157 +------------------+-------------------------------------------------------------------+
158 | 13 | fdepth |
159 +------------------+-------------------------------------------------------------------+
160 | 14 | tx_burst_size |
161 +------------------+-------------------------------------------------------------------+
162 | 15 | tx_tdtype |
163 +------------------+-------------------------------------------------------------------+
164 | 16 | extended_ch_type |
165 +------------------+-------------------------------------------------------------------+
167 .. _pub_rm_public_udmap_tx_ch_cfg_response:
169 UDMAP Transmit Channel Configure Response
170 -----------------------------------------
172 The **udmap tx channel cfg response** message returns the result status of the
173 processed **udmap tx channel cfg** message.
175 UDMAP Transmit Channel Configure Response Message Parameters
176 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
178 .. sysfwapistruct:: tisci_msg_rm_udmap_tx_ch_cfg_resp
180 TISCI_MSG_RM_UDMAP_RX_CH_CFG - UDMAP Receive Channel Configure
181 ==============================================================
183 .. _pub_rm_public_udmap_rx_ch_cfg:
185 UDMAP Receive Channel Configure
186 -------------------------------
188 The **UDMAP rx channel cfg** TISCI message API is used to configure SoC
189 Navigator Subsystem UDMAP receive channels. The API only allows
190 configuration of a receive channel by passing the rx channel index and the
191 Navigator SoC device ID in which the channel is located. Only the non-real-time
192 receive channel registers are programmed as part of the channel configuration.
193 The host is granted access to the receive channel real-time registers via the
194 SoC channelized firewalls based on the RM board configuration. The OS can
195 access the channel real-time registers directly after receive channel
196 configuration is complete.
198 The UDMAP global invalid receive flow event and per receive channel output
199 event (OES) and error output event (EOES) registers are not programmed as part
200 of the **UDMAP rx channel cfg** API. They're programmed internally via the
201 :ref:`RM IRQ Set <pub_rm_irq_route_set>` message.
203 The **UDMAP rx channel cfg** API can be used to configure receive channels
204 within any Navigator Subsystem UDMAP on the device.
206 Usage
207 ^^^^^
209 +------------------------+--------+
210 | **Message Type** | Normal |
211 +------------------------+--------+
212 | **Secure Queue Only?** | No |
213 +------------------------+--------+
215 TISCI Message ID
216 ^^^^^^^^^^^^^^^^
218 .. sysfwapimacro:: TISCI_MSG_RM_UDMAP_RX_CH_CFG
220 UDMAP Receive Channel Configure Message Parameters
221 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
223 .. sysfwapistruct:: tisci_msg_rm_udmap_rx_ch_cfg_req
225 .. _pub_rm_public_udmap_rx_ch_cfg_valid_params:
227 UDMAP Receive Channel Configuration Valid Parameters
228 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
230 The following table describes the valid bit mappings for the UDMAP receive
231 channel configure message optional parameters:
233 +------------------+-------------------------------------------------------------------+
234 | valid_params Bit | Corresponding tisci_msg_rm_udmap_rx_ch_cfg_req Optional Parameter |
235 +==================+===================================================================+
236 | 0 | rx_pause_on_err |
237 +------------------+-------------------------------------------------------------------+
238 | 1 | rx_atype |
239 +------------------+-------------------------------------------------------------------+
240 | 2 | rx_chan_type |
241 +------------------+-------------------------------------------------------------------+
242 | 3 | rx_fetch_size |
243 +------------------+-------------------------------------------------------------------+
244 | 4 | rxcq_qnum |
245 +------------------+-------------------------------------------------------------------+
246 | 5 | rx_priority |
247 +------------------+-------------------------------------------------------------------+
248 | 6 | rx_qos |
249 +------------------+-------------------------------------------------------------------+
250 | 7 | rx_orderid |
251 +------------------+-------------------------------------------------------------------+
252 | 8 | rx_sched_priority |
253 +------------------+-------------------------------------------------------------------+
254 | 9 | flowid_start |
255 +------------------+-------------------------------------------------------------------+
256 | 10 | flowid_cnt |
257 +------------------+-------------------------------------------------------------------+
258 | 11 | rx_ignore_short |
259 +------------------+-------------------------------------------------------------------+
260 | 12 | rx_ignore_long |
261 +------------------+-------------------------------------------------------------------+
262 | 14 | rx_burst_size |
263 +------------------+-------------------------------------------------------------------+
265 .. _pub_rm_public_udmap_rx_ch_cfg_response:
267 UDMAP Receive Channel Configure Response
268 ----------------------------------------
270 The **udmap rx channel cfg response** message returns the result status of the
271 processed **udmap rx channel cfg** message.
273 UDMAP Receive Channel Configure Response Message Parameters
274 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
276 .. sysfwapistruct:: tisci_msg_rm_udmap_rx_ch_cfg_resp
278 TISCI_MSG_RM_UDMAP_FLOW_CFG - UDMAP Receive Flow Configure
279 ==========================================================
281 .. _pub_rm_public_udmap_flow_cfg:
283 UDMAP Receive Flow Configure Request
284 ------------------------------------
286 The **UDMAP flow cfg** TISCI message API is used to configure a SoC Navigator
287 Subsystem UDMAP receive flow's standard, non-size threshold registers. The flow
288 index must be assigned to the host defined in the TISCI header via the RM board
289 configuration resource assignment range list.
291 It's the user's responsibility to make sure any receive channels using the
292 flow are disabled when changing the receive flow configuration. Otherwise,
293 unknown operation may occur.
295 The UDMAP global invalid receive flow event register is not programmed as part
296 of the **UDMAP flow cfg** API. It is programmed internally via the :ref:`RM IRQ
297 Set <pub_rm_irq_route_set>` message.
299 The **UDMAP flow cfg** API can be used to configure receive flows within any
300 Navigator Subsystem UDMAP on the device.
302 Usage
303 ^^^^^
305 +------------------------+--------+
306 | **Message Type** | Normal |
307 +------------------------+--------+
308 | **Secure Queue Only?** | No |
309 +------------------------+--------+
311 TISCI Message ID
312 ^^^^^^^^^^^^^^^^
314 .. sysfwapimacro:: TISCI_MSG_RM_UDMAP_FLOW_CFG
317 UDMAP Receive Flow Configure Message Parameters
318 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
320 .. sysfwapistruct:: tisci_msg_rm_udmap_flow_cfg_req
322 .. _pub_rm_public_udmap_flow_cfg_valid_params:
324 UDMAP Receive Flow Configure Valid Parameters
325 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
327 The following table describes the valid bit mappings for the UDMAP receive
328 flow configure message parameters:
330 +------------------+---------------------------------------------------------+
331 | valid_params Bit | Corresponding tisci_msg_rm_udmap_flow_cfg_req Parameter |
332 +==================+=========================================================+
333 | 0 | rx_einfo_present |
334 +------------------+---------------------------------------------------------+
335 | 1 | rx_psinfo_present |
336 +------------------+---------------------------------------------------------+
337 | 2 | rx_error_handling |
338 +------------------+---------------------------------------------------------+
339 | 3 | rx_desc_type |
340 +------------------+---------------------------------------------------------+
341 | 4 | rx_sop_offset |
342 +------------------+---------------------------------------------------------+
343 | 5 | rx_dest_qnum |
344 +------------------+---------------------------------------------------------+
345 | 6 | rx_src_tag_hi |
346 +------------------+---------------------------------------------------------+
347 | 7 | rx_src_tag_lo |
348 +------------------+---------------------------------------------------------+
349 | 8 | rx_dest_tag_hi |
350 +------------------+---------------------------------------------------------+
351 | 9 | rx_dest_tag_lo |
352 +------------------+---------------------------------------------------------+
353 | 10 | rx_src_tag_hi_sel |
354 +------------------+---------------------------------------------------------+
355 | 11 | rx_src_tag_lo_sel |
356 +------------------+---------------------------------------------------------+
357 | 12 | rx_dest_tag_hi_sel |
358 +------------------+---------------------------------------------------------+
359 | 13 | rx_dest_tag_lo_sel |
360 +------------------+---------------------------------------------------------+
361 | 14 | rx_fdq0_sz0_qnum |
362 +------------------+---------------------------------------------------------+
363 | 15 | rx_fdq1_sz0_qnum |
364 +------------------+---------------------------------------------------------+
365 | 16 | rx_fdq2_sz0_qnum |
366 +------------------+---------------------------------------------------------+
367 | 17 | rx_fdq3_sz0_qnum |
368 +------------------+---------------------------------------------------------+
369 | 18 | rx_ps_location |
370 +------------------+---------------------------------------------------------+
372 .. _pub_rm_public_udmap_flow_cfg_response:
374 UDMAP Receive Flow Configure Response
375 -------------------------------------
377 The **udmap flow cfg response** message returns the result status of the
378 processed **udmap flow cfg** message.
380 UDMAP Receive Flow Configure Response Message Parameters
381 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
383 .. sysfwapistruct:: tisci_msg_rm_udmap_flow_cfg_resp
385 TISCI_MSG_RM_UDMAP_FLOW_SIZE_THRESH_CFG - UDMAP Receive Flow Size Threshold Configure
386 =====================================================================================
388 .. _pub_rm_public_udmap_flow_size_thresh_cfg:
390 UDMAP Receive Flow Size Threshold Configure Request
391 ---------------------------------------------------
393 The **UDMAP flow size threshold cfg** TISCI message API is used to configure
394 the size-based free descriptor queue routing registers for flow. The flow
395 index must be assigned to the host defined in the TISCI header via the RM
396 board configuration resource assignment range list.
398 It's the user's responsibility to make sure any receive channels using the
399 flow are disabled when changing the receive flow configuration. Otherwise,
400 unknown operation may occur.
402 The **UDMAP flow size threshold cfg** API can be used to configure receive
403 flows within any Navigator Subsystem UDMAP on the device.
405 Usage
406 ^^^^^
408 +------------------------+--------+
409 | **Message Type** | Normal |
410 +------------------------+--------+
411 | **Secure Queue Only?** | No |
412 +------------------------+--------+
414 TISCI Message ID
415 ^^^^^^^^^^^^^^^^
417 .. sysfwapimacro:: TISCI_MSG_RM_UDMAP_FLOW_SIZE_THRESH_CFG
419 UDMAP Receive Flow Size Threshold Configure Message Parameters
420 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
422 .. sysfwapistruct:: tisci_msg_rm_udmap_flow_size_thresh_cfg_req
424 .. _pub_rm_public_udmap_flow_size_thresh_cfg_valid_params:
426 UDMAP Receive Flow Size Threshold Configure Valid Parameters
427 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
429 The following table describes the valid bit mappings for the UDMAP receive
430 flow size threshold configure message parameters:
432 +------------------+---------------------------------------------------------------------+
433 | valid_params Bit | Corresponding tisci_msg_rm_udmap_flow_size_thresh_cfg_req Parameter |
434 +==================+=====================================================================+
435 | 0 | rx_size_thresh0 |
436 +------------------+---------------------------------------------------------------------+
437 | 1 | rx_size_thresh1 |
438 +------------------+---------------------------------------------------------------------+
439 | 2 | rx_size_thresh2 |
440 +------------------+---------------------------------------------------------------------+
441 | 3 | rx_fdq0_sz1_qnum |
442 +------------------+---------------------------------------------------------------------+
443 | 4 | rx_fdq0_sz2_qnum |
444 +------------------+---------------------------------------------------------------------+
445 | 5 | rx_fdq0_sz3_qnum |
446 +------------------+---------------------------------------------------------------------+
447 | 6 | rx_size_thresh_en |
448 +------------------+---------------------------------------------------------------------+
450 .. _pub_rm_public_udmap_flow_size_thresh_cfg_response:
452 UDMAP Receive Flow Size Threshold Configure Response
453 ----------------------------------------------------
455 The **udmap flow size threshold cfg response** message returns the result
456 status of the processed **udmap flow size threshold cfg** message.
458 UDMAP Receive Flow Size Threshold Configure Response Message Parameters
459 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
461 .. sysfwapistruct:: tisci_msg_rm_udmap_flow_size_thresh_cfg_resp
463 TISCI_MSG_RM_UDMAP_FLOW_DELEGATE - UDMAP Flow Delegate
464 ======================================================
466 .. _pub_rm_public_udmap_flow_delegate:
468 UDMAP Flow Delegate Request
469 ---------------------------
471 The **UDMAP flow delegate** TISCI message API is used by a host to delegate
472 configuration of an owned, according to the RM board configuration, common DMA
473 flow to another host. After delegation the host owning the flow and the
474 delegated host are allowed to configure the flow via the flow configuration
475 TISCI messages. The delegation can be cleared by the host who owns the flow
476 by setting the clear parameter of the flow delegate message.
478 The flow index set for delegation must be assigned to the host defined in the
479 TISCI header via the RM board configuration resource assignment range list.
481 Usage
482 ^^^^^
484 +------------------------+--------+
485 | **Message Type** | Normal |
486 +------------------------+--------+
487 | **Secure Queue Only?** | No |
488 +------------------------+--------+
490 TISCI Message ID
491 ^^^^^^^^^^^^^^^^
493 .. sysfwapimacro:: TISCI_MSG_RM_UDMAP_FLOW_DELEGATE
496 UDMAP Flow Delegate Message Parameters
497 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
499 .. sysfwapistruct:: tisci_msg_rm_udmap_flow_delegate_req
501 .. _pub_rm_public_udmap_flow_delegate_valid_params:
503 UDMAP Flow Delegate Valid Parameters
504 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
506 The following table describes the valid bit mappings for the UDMAP flow
507 delegate message parameters:
509 +------------------+--------------------------------------------------------------+
510 | valid_params Bit | Corresponding tisci_msg_rm_udmap_flow_delegate_req Parameter |
511 +==================+==============================================================+
512 | 0 | delegated_host |
513 +------------------+--------------------------------------------------------------+
514 | 1 | clear |
515 +------------------+--------------------------------------------------------------+
517 .. _pub_rm_public_udmap_flow_delegate_response:
519 UDMAP Flow Delegate Response
520 ----------------------------
522 The **udmap flow delegate response** message returns the result status of the
523 processed **udmap flow delegate** message.
525 UDMAP Flow Delegate Response Message Parameters
526 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
528 .. sysfwapistruct:: tisci_msg_rm_udmap_flow_delegate_resp
531 TISCI_MSG_RM_UDMAP_GCFG_CFG - UDMAP Global Configuration Configure
532 ==================================================================
534 .. _pub_rm_public_udmap_gcfg_cfg:
536 UDMAP Global Configuration Configure Request
537 --------------------------------------------
539 The **udmap_gcfg_cfg** TISCI message API is used to configure non-real-time
540 registers in the UDMAP subsystem's global configuration region. The host, or a
541 supervisor of the host, who owns the global configuration region must be the
542 requesting host. The API allows configuration of the global configuration
543 region by passing the Navigator SoC device ID of the UDMAP subsystem in which
544 the region is located.
546 Usage
547 ^^^^^
549 +------------------------+--------+
550 | **Message Type** | Normal |
551 +------------------------+--------+
552 | **Secure Queue Only?** | No |
553 +------------------------+--------+
555 TISCI Message ID
556 ^^^^^^^^^^^^^^^^
558 .. sysfwapimacro:: TISCI_MSG_RM_UDMAP_GCFG_CFG
560 UDMAP Global Configuration Configure Message Parameters
561 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
563 .. sysfwapistruct:: tisci_msg_rm_udmap_gcfg_cfg_req
565 .. _pub_rm_public_udmap_gcfg_cfg_valid_params:
567 UDMAP Global Configuration Configure Valid Parameters
568 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
570 The following table describes the valid bit mappings for the UDMAP global
571 configuration configure parameters:
573 +------------------+---------------------------------------------------------+
574 | valid_params Bit | Corresponding tisci_msg_rm_udmap_gcfg_cfg_req Parameter |
575 +==================+=========================================================+
576 | 0 | perf_ctrl_timeout_cnt |
577 +------------------+---------------------------------------------------------+
578 | 1 | emu_ctrl_soft |
579 +------------------+---------------------------------------------------------+
580 | 2 | emu_ctrl_free |
581 +------------------+---------------------------------------------------------+
582 | 3 | psil_to_tout |
583 +------------------+---------------------------------------------------------+
584 | 4 | psil_to_tout_cnt |
585 +------------------+---------------------------------------------------------+
586 | 5 | utc_chan_start |
587 +------------------+---------------------------------------------------------+
588 | 6 | rflowfwstat_pend |
589 +------------------+---------------------------------------------------------+
591 .. _pub_rm_public_udmap_gcfg_cfg_response:
593 UDMAP Global Configuration Configure Response
594 ---------------------------------------------
596 The **udmap_gcfg_cfg_response** message returns the result status of the
597 processed **udmap_gcfg_cfg** message.
599 UDMAP Global Configuration Configure Response Message Parameters
600 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
602 .. sysfwapistruct:: tisci_msg_rm_udmap_gcfg_cfg_resp