AM243x MCU+ SDK  09.02.01
tisci_rm_ra.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017-2024 Texas Instruments Incorporated
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  */
54 #ifndef RM_TISCI_RA_H
55 #define RM_TISCI_RA_H
56 
57 #ifdef __cplusplus
58 extern "C"
59 {
60 #endif
61 
62 
63 
67 #define TISCI_MSG_VALUE_RM_RING_ADDR_LO_VALID (1u << 0u)
68 
71 #define TISCI_MSG_VALUE_RM_RING_ADDR_HI_VALID (1u << 1u)
72 
75 #define TISCI_MSG_VALUE_RM_RING_COUNT_VALID (1u << 2u)
76 
79 #define TISCI_MSG_VALUE_RM_RING_MODE_VALID (1u << 3u)
80 
83 #define TISCI_MSG_VALUE_RM_RING_SIZE_VALID (1u << 4u)
84 
87 #define TISCI_MSG_VALUE_RM_RING_ORDER_ID_VALID (1u << 5u)
88 
91 #define TISCI_MSG_VALUE_RM_RING_VIRTID_VALID (1u << 6u)
92 
96 #define TISCI_MSG_VALUE_RM_RING_ASEL_VALID (1U << 7U)
97 
101 #define TISCI_MSG_VALUE_RM_RING_MODE_RING (0x0u)
102 
105 #define TISCI_MSG_VALUE_RM_RING_MODE_MESSAGE (0x1u)
106 
109 #define TISCI_MSG_VALUE_RM_RING_MODE_CREDENTIALS (0x2u)
110 
113 #define TISCI_MSG_VALUE_RM_RING_MODE_QM (0x3u)
114 
118 #define TISCI_MSG_VALUE_RM_RING_SIZE_4B (0x0u)
119 
122 #define TISCI_MSG_VALUE_RM_RING_SIZE_8B (0x1u)
123 
126 #define TISCI_MSG_VALUE_RM_RING_SIZE_16B (0x2u)
127 
130 #define TISCI_MSG_VALUE_RM_RING_SIZE_32B (0x3u)
131 
134 #define TISCI_MSG_VALUE_RM_RING_SIZE_64B (0x4u)
135 
138 #define TISCI_MSG_VALUE_RM_RING_SIZE_128B (0x5u)
139 
142 #define TISCI_MSG_VALUE_RM_RING_SIZE_256B (0x6u)
143 
147 #define TISCI_MSG_VALUE_RM_MON_SOURCE_VALID (1u << 0U)
148 
151 #define TISCI_MSG_VALUE_RM_MON_MODE_VALID (1u << 1U)
152 
155 #define TISCI_MSG_VALUE_RM_MON_QUEUE_VALID (1u << 2U)
156 
159 #define TISCI_MSG_VALUE_RM_MON_DATA0_VAL_VALID (1u << 3U)
160 
163 #define TISCI_MSG_VALUE_RM_MON_DATA1_VAL_VALID (1u << 4U)
164 
168 #define TISCI_MSG_VALUE_RM_MON_SRC_ELEM_CNT (0U)
169 
172 #define TISCI_MSG_VALUE_RM_MON_SRC_HEAD_PKT_SIZE (1U)
173 
176 #define TISCI_MSG_VALUE_RM_MON_SRC_ACCUM_Q_SIZE (2U)
177 
181 #define TISCI_MSG_VALUE_RM_MON_MODE_DISABLED (0U)
182 
185 #define TISCI_MSG_VALUE_RM_MON_MODE_PUSH_POP (1U)
186 
189 #define TISCI_MSG_VALUE_RM_MON_MODE_THRESHOLD (2U)
190 
193 #define TISCI_MSG_VALUE_RM_MON_MODE_WATERMARK (3U)
194 
197 #define TISCI_MSG_VALUE_RM_MON_MODE_STARVATION (4U)
198 
306  struct tisci_header hdr;
307  uint32_t valid_params;
308  uint16_t nav_id;
309  uint16_t index;
310  uint32_t addr_lo;
311  uint32_t addr_hi;
312  uint32_t count;
313  uint8_t mode;
314  uint8_t size;
315  uint8_t order_id;
316  uint16_t virtid;
317  uint8_t asel;
318 } __attribute__((__packed__));
319 
327  struct tisci_header hdr;
328 } __attribute__((__packed__));
329 
404  struct tisci_header hdr;
405  uint32_t valid_params;
406  uint16_t nav_id;
407  uint16_t index;
408  uint8_t source;
409  uint8_t mode;
410  uint16_t queue;
411  uint32_t data0_val;
412  uint32_t data1_val;
413 } __attribute__((__packed__));
414 
422  struct tisci_header hdr;
423 } __attribute__((__packed__));
424 
425 
426 #ifdef __cplusplus
427 }
428 #endif
429 
430 #endif /* RM_TISCI_RA_H */
431 
tisci_msg_rm_ring_mon_cfg_req::index
uint16_t index
Definition: tisci_rm_ra.h:407
tisci_msg_rm_ring_cfg_req::addr_lo
uint32_t addr_lo
Definition: tisci_rm_ra.h:310
tisci_msg_rm_ring_mon_cfg_resp
Response to configuring a ring monitor.
Definition: tisci_rm_ra.h:421
tisci_msg_rm_ring_cfg_req::count
uint32_t count
Definition: tisci_rm_ra.h:312
tisci_msg_rm_ring_mon_cfg_req::hdr
struct tisci_header hdr
Definition: tisci_rm_ra.h:404
__attribute__
struct tisci_msg_rm_ring_cfg_req __attribute__((__packed__))
tisci_msg_rm_ring_mon_cfg_req
Configures a Navigator Subsystem ring monitor. Configures the real-time registers of a Navigator Subs...
Definition: tisci_rm_ra.h:403
tisci_msg_rm_ring_mon_cfg_req::queue
uint16_t queue
Definition: tisci_rm_ra.h:410
tisci_msg_rm_ring_cfg_req::valid_params
uint32_t valid_params
Definition: tisci_rm_ra.h:307
tisci_msg_rm_ring_mon_cfg_resp::hdr
struct tisci_header hdr
Definition: tisci_rm_ra.h:422
tisci_msg_rm_ring_cfg_req::mode
uint8_t mode
Definition: tisci_rm_ra.h:313
tisci_msg_rm_ring_cfg_req::index
uint16_t index
Definition: tisci_rm_ra.h:309
tisci_header
Header that prefixes all TISCI messages.
Definition: tisci_protocol.h:94
tisci_msg_rm_ring_mon_cfg_req::data1_val
uint32_t data1_val
Definition: tisci_rm_ra.h:412
tisci_msg_rm_ring_mon_cfg_req::data0_val
uint32_t data0_val
Definition: tisci_rm_ra.h:411
tisci_msg_rm_ring_cfg_req::asel
uint8_t asel
Definition: tisci_rm_ra.h:317
tisci_msg_rm_ring_cfg_req::addr_hi
uint32_t addr_hi
Definition: tisci_rm_ra.h:311
tisci_msg_rm_ring_cfg_resp::hdr
struct tisci_header hdr
Definition: tisci_rm_ra.h:327
tisci_msg_rm_ring_cfg_req::size
uint8_t size
Definition: tisci_rm_ra.h:314
tisci_msg_rm_ring_mon_cfg_req::source
uint8_t source
Definition: tisci_rm_ra.h:408
tisci_msg_rm_ring_mon_cfg_req::mode
uint8_t mode
Definition: tisci_rm_ra.h:409
tisci_msg_rm_ring_mon_cfg_req::valid_params
uint32_t valid_params
Definition: tisci_rm_ra.h:405
tisci_msg_rm_ring_cfg_req::order_id
uint8_t order_id
Definition: tisci_rm_ra.h:315
tisci_msg_rm_ring_mon_cfg_req::nav_id
uint16_t nav_id
Definition: tisci_rm_ra.h:406
tisci_msg_rm_ring_cfg_req::virtid
uint16_t virtid
Definition: tisci_rm_ra.h:316
tisci_msg_rm_ring_cfg_req::hdr
struct tisci_header hdr
Definition: tisci_rm_ra.h:306
tisci_msg_rm_ring_cfg_resp
Response to configuring a ring.
Definition: tisci_rm_ra.h:326
tisci_msg_rm_ring_cfg_req::nav_id
uint16_t nav_id
Definition: tisci_rm_ra.h:308
tisci_msg_rm_ring_cfg_req
Configures a Navigator Subsystem ring.
Definition: tisci_rm_ra.h:305