Inc/tx_user.h (Tx_Thread_Sync)

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

/**************************************************************************/ /* */ /* Copyright (c) Microsoft Corporation. All rights reserved. */ /* */ /* This software is licensed under the Microsoft Software License */ /* Terms for Microsoft Azure RTOS. Full text of the license can be */ /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ /* and in the root directory of this software. */ /* */ /**************************************************************************/ /**************************************************************************/ /**************************************************************************/ /** */ /** ThreadX Component */ /** */ /** User Specific */ /** */ /**************************************************************************/ /**************************************************************************/ /**************************************************************************/ /* */ /* PORT SPECIFIC C INFORMATION RELEASE */ /* */ /* tx_user.h PORTABLE C */ /* 6.0 */ /* */ /* AUTHOR */ /* */ /* William E. Lamie, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This file contains user defines for configuring ThreadX in specific */ /* ways. This file will have an effect only if the application and */ /* ThreadX library are built with TX_INCLUDE_USER_DEFINE_FILE defined. */ /* Note that all the defines in this file may also be made on the */ /* command line when building ThreadX library and application objects. */ /* */ /* RELEASE HISTORY */ /* */ /* DATE NAME DESCRIPTION */ /* */ /* 05-19-2020 William E. Lamie Initial Version 6.0 */ /* */ /**************************************************************************/ #ifndef TX_USER_H #define TX_USER_H /* Define various build options for the ThreadX port. The application should either make changes here by commenting or un-commenting the conditional compilation defined OR supply the defines though the compiler's equivalent of the -D option. For maximum speed, the following should be defined: TX_MAX_PRIORITIES 32 TX_DISABLE_PREEMPTION_THRESHOLD TX_DISABLE_REDUNDANT_CLEARING TX_DISABLE_NOTIFY_CALLBACKS TX_NOT_INTERRUPTABLE TX_TIMER_PROCESS_IN_ISR TX_REACTIVATE_INLINE TX_DISABLE_STACK_FILLING TX_INLINE_THREAD_RESUME_SUSPEND For minimum size, the following should be defined: TX_MAX_PRIORITIES 32 TX_DISABLE_PREEMPTION_THRESHOLD TX_DISABLE_REDUNDANT_CLEARING TX_DISABLE_NOTIFY_CALLBACKS TX_NOT_INTERRUPTABLE TX_TIMER_PROCESS_IN_ISR Of course, many of these defines reduce functionality and/or change the behavior of the system in ways that may not be worth the trade-off. For example, the TX_TIMER_PROCESS_IN_ISR results in faster and smaller code, however, it increases the amount of processing in the ISR. In addition, some services that are available in timers are not available from ISRs and will therefore return an error if this option is used. This may or may not be desirable for a given application. */ /* Override various options with default values already assigned in tx_port.h. Please also refer to tx_port.h for descriptions on each of these options. */ /*#define TX_MAX_PRIORITIES 32*/ /*#define TX_THREAD_USER_EXTENSION ????*/ /*#define TX_TIMER_THREAD_STACK_SIZE 1024*/ /*#define TX_TIMER_THREAD_PRIORITY 0*/ /*#define TX_MINIMUM_STACK 200*/ /* Determine if timer expirations (application timers, timeouts, and tx_thread_sleep calls should be processed within the a system timer thread or directly in the timer ISR. By default, the timer thread is used. When the following is defined, the timer expiration processing is done directly from the timer ISR, thereby eliminating the timer thread control block, stack, and context switching to activate it. */ /*#define TX_TIMER_PROCESS_IN_ISR*/ /* Determine if in-line timer reactivation should be used within the timer expiration processing. By default, this is disabled and a function call is used. When the following is defined, reactivating is performed in-line resulting in faster timer processing but slightly larger code size. */ /*#define TX_REACTIVATE_INLINE*/ /* Determine is stack filling is enabled. By default, ThreadX stack filling is enabled, which places an 0xEF pattern in each byte of each thread's stack. This is used by debuggers with ThreadX-awareness and by the ThreadX run-time stack checking feature. */ /*#define TX_DISABLE_STACK_FILLING*/ /* Determine whether or not stack checking is enabled. By default, ThreadX stack checking is disabled. When the following is defined, ThreadX thread stack checking is enabled. If stack checking is enabled (TX_ENABLE_STACK_CHECKING is defined), the TX_DISABLE_STACK_FILLING define is negated, thereby forcing the stack fill which is necessary for the stack checking logic. */ /*#define TX_ENABLE_STACK_CHECKING*/ /* Determine if preemption-threshold should be disabled. By default, preemption-threshold is enabled. If the application does not use preemption-threshold, it may be disabled to reduce code size and improve performance. */ #define TX_DISABLE_PREEMPTION_THRESHOLD /* Determine if global ThreadX variables should be cleared. If the compiler startup code clears the .bss section prior to ThreadX running, the define can be used to eliminate unnecessary clearing of ThreadX global variables. */ /*#define TX_DISABLE_REDUNDANT_CLEARING*/ /* Determine if no timer processing is required. This option will help eliminate the timer processing when not needed. The user will also have to comment out the call to tx_timer_interrupt, which is typically made from assembly language in tx_initialize_low_level. Note: if TX_NO_TIMER is used, the define TX_TIMER_PROCESS_IN_ISR must also be used. */ /* #define TX_NO_TIMER #ifndef TX_TIMER_PROCESS_IN_ISR #define TX_TIMER_PROCESS_IN_ISR #endif */ /* Determine if the notify callback option should be disabled. By default, notify callbacks are enabled. If the application does not use notify callbacks, they may be disabled to reduce code size and improve performance. */ #define TX_DISABLE_NOTIFY_CALLBACKS /* Determine if the tx_thread_resume and tx_thread_suspend services should have their internal code in-line. This results in a larger image, but improves the performance of the thread resume and suspend services. */ /*#define TX_INLINE_THREAD_RESUME_SUSPEND*/ /* Determine if the internal ThreadX code is non-interruptable. This results in smaller code size and less processing overhead, but increases the interrupt lockout time. */ /*#define TX_NOT_INTERRUPTABLE*/ /* Determine if the trace event logging code should be enabled. This causes slight increases in code size and overhead, but provides the ability to generate system trace information which is available for viewing in TraceX. */ /*#define TX_ENABLE_EVENT_TRACE*/ /* Determine if block pool performance gathering is required by the application. When the following is defined, ThreadX gathers various block pool performance information. */ /*#define TX_BLOCK_POOL_ENABLE_PERFORMANCE_INFO*/ /* Determine if byte pool performance gathering is required by the application. When the following is defined, ThreadX gathers various byte pool performance information. */ /*#define TX_BYTE_POOL_ENABLE_PERFORMANCE_INFO*/ /* Determine if event flags performance gathering is required by the application. When the following is defined, ThreadX gathers various event flags performance information. */ /*#define TX_EVENT_FLAGS_ENABLE_PERFORMANCE_INFO*/ /* Determine if mutex performance gathering is required by the application. When the following is defined, ThreadX gathers various mutex performance information. */ /*#define TX_MUTEX_ENABLE_PERFORMANCE_INFO*/ /* Determine if queue performance gathering is required by the application. When the following is defined, ThreadX gathers various queue performance information. */ /*#define TX_QUEUE_ENABLE_PERFORMANCE_INFO*/ /* Determine if semaphore performance gathering is required by the application. When the following is defined, ThreadX gathers various semaphore performance information. */ /*#define TX_SEMAPHORE_ENABLE_PERFORMANCE_INFO*/ /* Determine if thread performance gathering is required by the application. When the following is defined, ThreadX gathers various thread performance information. */ /*#define TX_THREAD_ENABLE_PERFORMANCE_INFO*/ /* Determine if timer performance gathering is required by the application. When the following is defined, ThreadX gathers various timer performance information. */ /*#define TX_TIMER_ENABLE_PERFORMANCE_INFO*/ /* Define if the execution change notify is enabled. */ /*#define TX_ENABLE_EXECUTION_CHANGE_NOTIFY*/ /* Define the get system state macro. */ /*#define TX_THREAD_GET_SYSTEM_STATE() _tx_thread_system_state */ /* Define the check for whether or not to call the _tx_thread_system_return function (TX_THREAD_SYSTEM_RETURN_CHECK(c)). */ /*#define #define TX_THREAD_SYSTEM_RETURN_CHECK (c) ((ULONG) _tx_thread_preempt_disable)*/ /* Define the common timer tick reference for use by other middleware components. */ /*#define TX_TIMER_TICKS_PER_SECOND 100*/ /* Determinate if the basic alignment type is defined. */ /*#define ALIGN_TYPE_DEFINED*/ /* Define basic alignment type used in block and byte pool operations. */ /*#define ALIGN_TYPE ULONG*/ /* Define the TX_MEMSET macro to the standard library function. */ /*#define TX_MEMSET memset((a),(b),(c))*/ #ifdef __IAR_SYSTEMS_ASM__ /* Define if the IAR library is supported. */ /*#define TX_ENABLE_IAR_LIBRARY_SUPPORT*/ #endif /* Define if the safety critical configuration is enabled. */ /*#define TX_SAFETY_CRITICAL*/ #endif