AM64x MCU+ SDK  08.02.00
sciclient_procboot.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018 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  */
60 #ifndef SCICLIENT_PROCBOOT_H_
61 #define SCICLIENT_PROCBOOT_H_
62 
63 /* ========================================================================== */
64 /* Include Files */
65 /* ========================================================================== */
66 
67 #include <stdint.h>
68 
69 #ifdef __cplusplus
70 extern "C" {
71 #endif
72 
73 /* ========================================================================== */
74 /* Macros & Typedefs */
75 /* ========================================================================== */
76 
77 /* None */
78 
79 /* ========================================================================== */
80 /* Structure Declarations */
81 /* ========================================================================== */
82 
83 /* None */
84 
85 /* ========================================================================== */
86 /* Function Declarations */
87 /* ========================================================================== */
88 
104 int32_t Sciclient_procBootRequestProcessor(uint8_t processorId,
105  uint32_t timeout);
122 int32_t Sciclient_procBootReleaseProcessor(uint8_t processorId,
123  uint32_t reqFlag,
124  uint32_t timeout);
125 
142 int32_t Sciclient_procBootHandoverProcessor(uint8_t processorId,
143  uint8_t hostId,
144  uint32_t timeout);
161  const struct tisci_msg_proc_set_config_req * configReq,
162  uint32_t timeout);
163 
188 int32_t Sciclient_procBootSetSequenceCtrl(uint8_t processorId,
189  uint32_t control_flags_1_set,
190  uint32_t control_flags_1_clear,
191  uint32_t reqFlag,
192  uint32_t timeout);
193 
210  const struct tisci_msg_proc_auth_boot_req * authBootCfg,
211  uint32_t timeout);
212 
232  uint8_t processorId,
233  struct tisci_msg_proc_get_status_resp * procStatus,
234  uint32_t timeout);
235 
284  uint8_t processorId,
285  uint8_t num_match_iterations,
286  uint8_t delay_per_iteration_us,
291  uint32_t reqFlag,
292  uint32_t timeout);
293 
294 #ifdef __cplusplus
295 }
296 #endif
297 
298 #endif /* #ifndef SCICLIENT_PROCBOOT_H_ */
299 
Sciclient_procBootGetProcessorState
int32_t Sciclient_procBootGetProcessorState(uint8_t processorId, struct tisci_msg_proc_get_status_resp *procStatus, uint32_t timeout)
Message to Get Processor Status Provides a means for hosts in the permitted list to get the status of...
Sciclient_procBootSetSequenceCtrl
int32_t Sciclient_procBootSetSequenceCtrl(uint8_t processorId, uint32_t control_flags_1_set, uint32_t control_flags_1_clear, uint32_t reqFlag, uint32_t timeout)
Message to setup the processor sequence control. Provides a means for the host with current control t...
Sciclient_procBootAuthAndStart
int32_t Sciclient_procBootAuthAndStart(const struct tisci_msg_proc_auth_boot_req *authBootCfg, uint32_t timeout)
Message to Authorize and Start Processor Boot: Provides a means for the host with current control to ...
delay_per_iteration_us
uint8_t delay_per_iteration_us
Definition: tisci_procboot.h:4
Sciclient_procBootWaitProcessorState
int32_t Sciclient_procBootWaitProcessorState(uint8_t processorId, uint8_t num_match_iterations, uint8_t delay_per_iteration_us, uint32_t status_flags_1_set_all_wait, uint32_t status_flags_1_set_any_wait, uint32_t status_flags_1_clr_all_wait, uint32_t status_flags_1_clr_any_wait, uint32_t reqFlag, uint32_t timeout)
Message to Wait for Processor Status Provides a means for hosts to request the SYSFW to wait till a a...
status_flags_1_clr_all_wait
uint32_t status_flags_1_clr_all_wait
Definition: tisci_procboot.h:8
status_flags_1_set_any_wait
uint32_t status_flags_1_set_any_wait
Definition: tisci_procboot.h:7
control_flags_1_set
uint32_t control_flags_1_set
Definition: tisci_procboot.h:2
status_flags_1_clr_any_wait
uint32_t status_flags_1_clr_any_wait
Definition: tisci_procboot.h:9
tisci_msg_proc_get_status_resp
Processor Status Response.
Definition: tisci_procboot.h:441
status_flags_1_set_all_wait
uint32_t status_flags_1_set_all_wait
Definition: tisci_procboot.h:6
control_flags_1_clear
uint32_t control_flags_1_clear
Definition: tisci_procboot.h:3
tisci_msg_proc_set_config_req
Processor Boot Configuration.
Definition: tisci_procboot.h:262
Sciclient_procBootReleaseProcessor
int32_t Sciclient_procBootReleaseProcessor(uint8_t processorId, uint32_t reqFlag, uint32_t timeout)
Message to release a processor Provides a means for the host with current control to relinquish a phy...
tisci_msg_proc_auth_boot_req
Authenticate and start image.
Definition: tisci_procboot.h:345
Sciclient_procBootHandoverProcessor
int32_t Sciclient_procBootHandoverProcessor(uint8_t processorId, uint8_t hostId, uint32_t timeout)
Message to handover a processor Provides a means for the host with current control to relinquish a ph...
num_match_iterations
uint8_t num_match_iterations
Definition: tisci_procboot.h:3
Sciclient_procBootSetProcessorCfg
int32_t Sciclient_procBootSetProcessorCfg(const struct tisci_msg_proc_set_config_req *configReq, uint32_t timeout)
Message to set the processor configuration Provides a means for the host with current control to do t...
Sciclient_procBootRequestProcessor
int32_t Sciclient_procBootRequestProcessor(uint8_t processorId, uint32_t timeout)
Message to request a processor Provides a means for either the “recovery master” host or another host...