Vision Apps User Guide
app_sciclient_wrapper_api.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2018 Texas Instruments Incorporated
4  *
5  * All rights reserved not granted herein.
6  *
7  * Limited License.
8  *
9  * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
10  * license under copyrights and patents it now or hereafter owns or controls to make,
11  * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
12  * terms herein. With respect to the foregoing patent license, such license is granted
13  * solely to the extent that any such patent is necessary to Utilize the software alone.
14  * The patent license shall not apply to any combinations which include this software,
15  * other than combinations with devices manufactured by or for TI ("TI Devices").
16  * No hardware patent is licensed hereunder.
17  *
18  * Redistributions must preserve existing copyright notices and reproduce this license
19  * (including the above copyright notice and the disclaimer and (if applicable) source
20  * code license limitations below) in the documentation and/or other materials provided
21  * with the distribution
22  *
23  * Redistribution and use in binary form, without modification, are permitted provided
24  * that the following conditions are met:
25  *
26  * * No reverse engineering, decompilation, or disassembly of this software is
27  * permitted with respect to any software provided in binary form.
28  *
29  * * any redistribution and use are licensed by TI for use only with TI Devices.
30  *
31  * * Nothing shall obligate TI to provide you with source code for the software
32  * licensed and provided to you in object code.
33  *
34  * If software source code is provided to you, modification and redistribution of the
35  * source code are permitted provided that the following conditions are met:
36  *
37  * * any redistribution and use of the source code, including any resulting derivative
38  * works, are licensed by TI for use only with TI Devices.
39  *
40  * * any redistribution and use of any object code compiled from the source code
41  * and any resulting derivative works, are licensed by TI for use only with TI Devices.
42  *
43  * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
44  *
45  * may be used to endorse or promote products derived from this software without
46  * specific prior written permission.
47  *
48  * DISCLAIMER.
49  *
50  * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
51  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
55  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
57  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
58  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
59  * OF THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  */
62 
63 #ifndef APP_SCICLIENT_WRAPPER_API_H_
64 #define APP_SCICLIENT_WRAPPER_API_H_
65 
66 #if !defined(MCU_PLUS_SDK)
67 #include <sciclient/sciclient.h>
68 #else
69 #include <SystemP.h>
70 #define SCICLIENT_SERVICE_WAIT_FOREVER SystemP_WAIT_FOREVER
71 #endif
72 
74 
75 /* make below 0 to disable debug print's for these macro APIs */
76 #define APP_DEBUG_SCICLIENT 1
77 
78 #define SET_CLOCK_PARENT(MOD, CLK, PARENT) do { \
79  int32_t status = 0; \
80  if(status == 0) { \
81  if(APP_DEBUG_SCICLIENT) \
82  appLogPrintf("SCICLIENT: Sciclient_pmSetModuleClkParent module=%u clk=%u parent=%u\n", MOD, CLK, PARENT); \
83  status = Sciclient_pmSetModuleClkParent(MOD, CLK, PARENT, SCICLIENT_SERVICE_WAIT_FOREVER); \
84  if(status != 0) appLogPrintf("SCICLIENT: ERROR: Sciclient_pmSetModuleClkParent failed\n"); \
85  else \
86  { \
87  if(APP_DEBUG_SCICLIENT) \
88  appLogPrintf("SCICLIENT: Sciclient_pmSetModuleClkParent success\n"); \
89  } \
90  } \
91 } while(0)
92 
93 #define SET_DEVICE_STATE(MOD, STATE) do { \
94  int32_t status = 0; \
95  if(status == 0) { \
96  if(APP_DEBUG_SCICLIENT) \
97  appLogPrintf("SCICLIENT: Sciclient_pmSetModuleState module=%u state=%u\n", MOD, STATE); \
98  status = Sciclient_pmSetModuleState(MOD, STATE, TISCI_MSG_FLAG_AOP, SCICLIENT_SERVICE_WAIT_FOREVER); \
99  if(status != 0) appLogPrintf("SCICLIENT: ERROR: Sciclient_pmSetModuleState failed\n"); \
100  else \
101  { \
102  if(APP_DEBUG_SCICLIENT) \
103  appLogPrintf("SCICLIENT: Sciclient_pmSetModuleState success\n"); \
104  } \
105  } \
106 } while(0)
107 
108 #define SET_DEVICE_STATE_ON(MOD) SET_DEVICE_STATE(MOD,TISCI_MSG_VALUE_DEVICE_SW_STATE_ON)
109 
110 #define SET_DEVICE_STATE_OFF(MOD) SET_DEVICE_STATE(MOD,TISCI_MSG_VALUE_DEVICE_SW_STATE_AUTO_OFF)
111 
112 #define SET_CLOCK_STATE(MOD, CLK, FLAG, STATE) do { \
113  int32_t status = 0; \
114  if(status == 0) { \
115  if(APP_DEBUG_SCICLIENT) \
116  appLogPrintf("SCICLIENT: Sciclient_pmModuleClkRequest module=%u clk=%u state=%u flag=%u\n", MOD, CLK, STATE, FLAG); \
117  status = Sciclient_pmModuleClkRequest(MOD, CLK, STATE, FLAG, SCICLIENT_SERVICE_WAIT_FOREVER); \
118  if(status != 0) appLogPrintf("SCICLIENT: ERROR: Sciclient_pmModuleClkRequest failed\n"); \
119  else \
120  { \
121  if(APP_DEBUG_SCICLIENT) \
122  appLogPrintf("SCICLIENT: Sciclient_pmModuleClkRequest success\n"); \
123  } \
124  } \
125 } while(0)
126 
127 #define QUERY_CLOCK_FREQ(MOD, CLK, FREQ) do { \
128  int32_t status = 0; \
129  uint64_t freq; \
130  if(status == 0) { \
131  if(APP_DEBUG_SCICLIENT) \
132  appLogPrintf("SCICLIENT: Sciclient_pmQueryModuleClkFreq module=%u clk=%u freq=%u%06u\n", MOD, CLK, (uint32_t)(FREQ / 1000000), (uint32_t)(FREQ % 1000000)); \
133  status = Sciclient_pmQueryModuleClkFreq(MOD, CLK, FREQ, &freq, SCICLIENT_SERVICE_WAIT_FOREVER); \
134  if(status != 0) appLogPrintf("SCICLIENT: ERROR: Sciclient_pmQueryModuleClkFreq failed\n"); \
135  else \
136  { \
137  if(APP_DEBUG_SCICLIENT) \
138  appLogPrintf("SCICLIENT: Sciclient_pmQueryModuleClkFreq freq=%u%06u\n", (uint32_t)(freq / 1000000), (uint32_t)(freq % 1000000)); \
139  } \
140  } \
141 } while(0)
142 
143 #define SET_CLOCK_FREQ(MOD, CLK, FREQ) do { \
144  int32_t status = 0; \
145  if(status == 0) { \
146  if(APP_DEBUG_SCICLIENT) \
147  appLogPrintf("SCICLIENT: Sciclient_pmSetModuleClkFreq module=%u clk=%u freq=%u%06u\n", MOD, CLK, (uint32_t)(FREQ / 1000000), (uint32_t)(FREQ % 1000000)); \
148  status = Sciclient_pmSetModuleClkFreq(MOD, CLK, FREQ, 0, SCICLIENT_SERVICE_WAIT_FOREVER); \
149  if(status != 0) appLogPrintf("SCICLIENT: ERROR: Sciclient_pmSetModuleClkFreq failed\n"); \
150  else \
151  { \
152  if(APP_DEBUG_SCICLIENT) \
153  appLogPrintf("SCICLIENT: Sciclient_pmSetModuleClkFreq success\n"); \
154  } \
155  } \
156 } while(0)
157 
158 #define SET_CLOCK_FREQ_ALLOW_CHANGE(MOD, CLK, FREQ) do { \
159  int32_t status = 0; \
160  if(status == 0) { \
161  if(APP_DEBUG_SCICLIENT) \
162  appLogPrintf("SCICLIENT: Sciclient_pmSetModuleClkFreq module=%u clk=%u freq=%u%06u\n", MOD, CLK, (uint32_t)(FREQ / 1000000), (uint32_t)(FREQ % 1000000)); \
163  status = Sciclient_pmSetModuleClkFreq(MOD, CLK, FREQ, TISCI_MSG_FLAG_CLOCK_ALLOW_FREQ_CHANGE, SCICLIENT_SERVICE_WAIT_FOREVER); \
164  if(status != 0) appLogPrintf("SCICLIENT: ERROR: Sciclient_pmSetModuleClkFreq failed\n"); \
165  else \
166  { \
167  if(APP_DEBUG_SCICLIENT) \
168  appLogPrintf("SCICLIENT: Sciclient_pmSetModuleClkFreq success\n"); \
169  } \
170  } \
171 } while(0)
172 
173 #endif