AM64x MCU+ SDK  10.00.00
sciclient_rm.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018-2020 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  */
53 #ifndef SCICLIENT_RM_H_
54 #define SCICLIENT_RM_H_
55 
56 /* ========================================================================== */
57 /* Include Files */
58 /* ========================================================================== */
59 
60 #include <stdint.h>
61 
62 #ifdef __cplusplus
63 extern "C" {
64 #endif
65 
66 /* ========================================================================== */
67 /* Macros & Typedefs */
68 /* ========================================================================== */
69 
70 /* None */
71 
72 /* ========================================================================== */
73 /* Structure Declarations */
74 /* ========================================================================== */
75 
76 /* None */
77 
78 /* ========================================================================== */
79 /* Function Declarations */
80 /* ========================================================================== */
81 
107  const struct tisci_msg_rm_get_resource_range_req *req,
109  uint32_t timeout);
110 
198  const struct tisci_msg_rm_irq_set_resp *resp,
199  uint32_t timeout);
200 
291  uint32_t timeout);
292 
310 int32_t Sciclient_rmIrqTranslateIrOutput(uint16_t ir_dev_id,
311  uint16_t ir_output,
312  uint16_t dst_dev_id,
313  uint16_t *dst_input);
314 
333 int32_t Sciclient_rmIrqTranslateIaOutput(uint16_t ia_dev_id,
334  uint16_t ia_output,
335  uint16_t dst_dev_id,
336  uint16_t *dst_input);
337 
357 int32_t Sciclient_rmIrqTranslateIrqInput(uint16_t dst_dev_id,
358  uint16_t dst_input,
359  uint16_t src_dev_id,
360  uint16_t *src_output);
361 
384  const struct tisci_msg_rm_irq_set_resp *resp,
385  uint32_t timeout);
386 
407  uint32_t timeout);
408 
431  const struct tisci_msg_rm_ring_cfg_resp *resp,
432  uint32_t timeout);
433 
459  const struct tisci_msg_rm_ring_mon_cfg_resp *resp,
460  uint32_t timeout);
461 
486  const struct tisci_msg_rm_udmap_gcfg_cfg_req *req,
487  const struct tisci_msg_rm_udmap_gcfg_cfg_resp *resp,
488  uint32_t timeout);
489 
513  const struct tisci_msg_rm_udmap_tx_ch_cfg_req *req,
514  const struct tisci_msg_rm_udmap_tx_ch_cfg_resp *resp,
515  uint32_t timeout);
516 
540  const struct tisci_msg_rm_udmap_rx_ch_cfg_req *req,
541  const struct tisci_msg_rm_udmap_rx_ch_cfg_resp *resp,
542  uint32_t timeout);
543 
575  const struct tisci_msg_rm_udmap_flow_cfg_req *req,
576  const struct tisci_msg_rm_udmap_flow_cfg_resp *resp,
577  uint32_t timeout);
578 
610  uint32_t timeout);
611 
635  uint32_t timeout);
636 
656  uint32_t timeout);
657 
677  struct tisci_msg_rm_psil_read_resp *resp,
678  uint32_t timeout);
679 
697  uint32_t timeout);
698 
721  uint32_t timeout);
722 
740 int32_t Sciclient_rmIrOutpIsFree(uint16_t id, uint16_t outp);
741 
742 #ifdef __cplusplus
743 }
744 #endif
745 
746 #endif /* #ifndef SCICLIENT_RM_H_ */
747 
tisci_msg_rm_udmap_tx_ch_cfg_req
Configures a Navigator Subsystem UDMAP transmit channel.
Definition: tisci_rm_udmap.h:1012
Sciclient_rmIrqTranslateIaOutput
int32_t Sciclient_rmIrqTranslateIaOutput(uint16_t ia_dev_id, uint16_t ia_output, uint16_t dst_dev_id, uint16_t *dst_input)
Translates an interrupt aggregator output to the peripheral input it's connected to....
Sciclient_rmPsilUnpair
int32_t Sciclient_rmPsilUnpair(const struct tisci_msg_rm_psil_unpair_req *req, uint32_t timeout)
Unpairs a PSI-L source thread and destination thread.
Sciclient_rmIrqTranslateIrOutput
int32_t Sciclient_rmIrqTranslateIrOutput(uint16_t ir_dev_id, uint16_t ir_output, uint16_t dst_dev_id, uint16_t *dst_input)
Translates an interrupt router output to the peripheral input it's connected to. The primary use of t...
tisci_msg_rm_udmap_tx_ch_cfg_resp
Response to configuring a UDMAP transmit channel.
Definition: tisci_rm_udmap.h:1042
tisci_msg_rm_ring_mon_cfg_resp
Response to configuring a ring monitor.
Definition: tisci_rm_ra.h:421
tisci_msg_rm_irq_set_req
Configures peripherals within the interrupt subsystem according to the valid configuration provided....
Definition: tisci_rm_irq.h:202
Sciclient_rmIrqReleaseRaw
int32_t Sciclient_rmIrqReleaseRaw(const struct tisci_msg_rm_irq_release_req *req, uint32_t timeout)
Releases configurations within individual peripherals within the interrupt subsystem (interrupt route...
Sciclient_rmIrqRelease
int32_t Sciclient_rmIrqRelease(const struct tisci_msg_rm_irq_release_req *req, uint32_t timeout)
Releases a peripheral to processor IRQ.
Sciclient_rmSetProxyCfg
int32_t Sciclient_rmSetProxyCfg(const struct tisci_msg_rm_proxy_cfg_req *req, uint32_t timeout)
Proxy Configuration Request.
tisci_msg_rm_proxy_cfg_req
This file contains:
Definition: tisci_rm_proxy.h:87
Sciclient_rmUdmapTxChCfg
int32_t Sciclient_rmUdmapTxChCfg(const struct tisci_msg_rm_udmap_tx_ch_cfg_req *req, const struct tisci_msg_rm_udmap_tx_ch_cfg_resp *resp, uint32_t timeout)
Configures a Navigator Subsystem UDMAP transmit channel.
Sciclient_rmUdmapFlowSizeThreshCfg
int32_t Sciclient_rmUdmapFlowSizeThreshCfg(const struct tisci_msg_rm_udmap_flow_size_thresh_cfg_req *req, const struct tisci_msg_rm_udmap_flow_size_thresh_cfg_resp *resp, uint32_t timeout)
Configures a Navigator Subsystem UDMAP receive flow's size threshold fields.
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_udmap_rx_ch_cfg_resp
Response to configuring a UDMAP receive channel.
Definition: tisci_rm_udmap.h:1271
tisci_msg_rm_psil_read_req
Reads the specified thread real-time configuration register from a specified PSI-L thread using the P...
Definition: tisci_rm_psil.h:209
Sciclient_rmIrqTranslateIrqInput
int32_t Sciclient_rmIrqTranslateIrqInput(uint16_t dst_dev_id, uint16_t dst_input, uint16_t src_dev_id, uint16_t *src_output)
Translates a peripheral input to the connected interrupt router or aggregator output....
Sciclient_rmIrqSet
int32_t Sciclient_rmIrqSet(const struct tisci_msg_rm_irq_set_req *req, const struct tisci_msg_rm_irq_set_resp *resp, uint32_t timeout)
Configures a peripheral to processor IRQ.
tisci_msg_rm_get_resource_range_resp
Get resource range response message.
Definition: tisci_rm_core.h:130
Sciclient_rmGetResourceRange
int32_t Sciclient_rmGetResourceRange(const struct tisci_msg_rm_get_resource_range_req *req, struct tisci_msg_rm_get_resource_range_resp *resp, uint32_t timeout)
Retrieves a host's assigned range for a resource.
Sciclient_rmUdmapGcfgCfg
int32_t Sciclient_rmUdmapGcfgCfg(const struct tisci_msg_rm_udmap_gcfg_cfg_req *req, const struct tisci_msg_rm_udmap_gcfg_cfg_resp *resp, uint32_t timeout)
Configures Navigator Subsystem UDMAP GCFG region.
Sciclient_rmRingCfg
int32_t Sciclient_rmRingCfg(const struct tisci_msg_rm_ring_cfg_req *req, const struct tisci_msg_rm_ring_cfg_resp *resp, uint32_t timeout)
Configures a Navigator Subsystem ring.
tisci_msg_rm_irq_set_resp
Response to setting a peripheral to processor interrupt.
Definition: tisci_rm_irq.h:222
Sciclient_rmIrOutpIsFree
int32_t Sciclient_rmIrOutpIsFree(uint16_t id, uint16_t outp)
Checks the output's control register to see if the output line has an input line mapped to it.
tisci_msg_rm_psil_unpair_req
Unpairs a PSI-L source thread from a destination thread.
Definition: tisci_rm_psil.h:163
Sciclient_rmPsilPair
int32_t Sciclient_rmPsilPair(const struct tisci_msg_rm_psil_pair_req *req, uint32_t timeout)
Pairs a PSI-L source thread and destination threads.
tisci_msg_rm_udmap_flow_cfg_req
Configures a Navigator Subsystem UDMAP receive flow.
Definition: tisci_rm_udmap.h:1559
Sciclient_rmIrqSetRaw
int32_t Sciclient_rmIrqSetRaw(const struct tisci_msg_rm_irq_set_req *req, const struct tisci_msg_rm_irq_set_resp *resp, uint32_t timeout)
Configures individual peripherals within the interrupt subsystem (interrupt routers,...
tisci_msg_rm_psil_pair_req
This file contains:
Definition: tisci_rm_psil.h:107
tisci_msg_rm_get_resource_range_req
This file contains:
Definition: tisci_rm_core.h:96
tisci_msg_rm_udmap_flow_size_thresh_cfg_resp
Response to configuring a Navigator Subsystem UDMAP receive flow's size threshold fields.
Definition: tisci_rm_udmap.h:1741
tisci_msg_rm_udmap_flow_size_thresh_cfg_req
Configures a Navigator Subsystem UDMAP receive flow's size threshold fields.
Definition: tisci_rm_udmap.h:1720
tisci_msg_rm_irq_release_req
Releases interrupt peripheral resources according to the valid configuration provided....
Definition: tisci_rm_irq.h:332
Sciclient_rmPsilWrite
int32_t Sciclient_rmPsilWrite(const struct tisci_msg_rm_psil_write_req *req, uint32_t timeout)
Writes a PSI-L thread real-time register.
tisci_msg_rm_psil_read_resp
Response to reading a PSI-L thread real-time register.
Definition: tisci_rm_psil.h:226
Sciclient_rmPsilRead
int32_t Sciclient_rmPsilRead(const struct tisci_msg_rm_psil_read_req *req, struct tisci_msg_rm_psil_read_resp *resp, uint32_t timeout)
Reads a PSI-L thread real-time register.
Sciclient_rmRingMonCfg
int32_t Sciclient_rmRingMonCfg(const struct tisci_msg_rm_ring_mon_cfg_req *req, const struct tisci_msg_rm_ring_mon_cfg_resp *resp, uint32_t timeout)
Configures a Navigator Subsystem ring monitor.
Sciclient_rmUdmapFlowCfg
int32_t Sciclient_rmUdmapFlowCfg(const struct tisci_msg_rm_udmap_flow_cfg_req *req, const struct tisci_msg_rm_udmap_flow_cfg_resp *resp, uint32_t timeout)
Configures a Navigator Subsystem UDMAP receive flow.
tisci_msg_rm_udmap_flow_cfg_resp
Response to configuring a Navigator Subsystem UDMAP receive flow.
Definition: tisci_rm_udmap.h:1591
tisci_msg_rm_udmap_gcfg_cfg_req
Configures a Navigator Subsystem UDMAP global configuration region. Configures the non-real-time regi...
Definition: tisci_rm_udmap.h:768
tisci_msg_rm_psil_write_req
Write to the specified thread real-time configuration register in a specified PSI-L thread using the ...
Definition: tisci_rm_psil.h:267
tisci_msg_rm_ring_cfg_resp
Response to configuring a ring.
Definition: tisci_rm_ra.h:326
Sciclient_rmUdmapRxChCfg
int32_t Sciclient_rmUdmapRxChCfg(const struct tisci_msg_rm_udmap_rx_ch_cfg_req *req, const struct tisci_msg_rm_udmap_rx_ch_cfg_resp *resp, uint32_t timeout)
Configures a Navigator Subsystem UDMAP receive channel.
tisci_msg_rm_udmap_rx_ch_cfg_req
Configures a Navigator Subsystem UDMAP receive channel.
Definition: tisci_rm_udmap.h:1244
tisci_msg_rm_ring_cfg_req
Configures a Navigator Subsystem ring.
Definition: tisci_rm_ra.h:305
tisci_msg_rm_udmap_gcfg_cfg_resp
Response to configuring UDMAP global configuration.
Definition: tisci_rm_udmap.h:784